Reworked tests to detect memory leaks

Author: bgaifullin

.travis.yml

@@ -23,7 +23,7 @@ install:
 - travis_retry pip install -r requirements-test.txt
 - travis_retry pip install -e "."
 - pip list
-script: py.test tests
+script: py.test -v tests
 
 before_deploy:
     - travis_retry pip install Sphinx

README.rst

@@ -15,7 +15,7 @@ Python bindings for the XML Security Library.
 Usage
 ******
 
-Check the `examples <https://github.com/mehcode/python-xmlsec/tree/master/tests/examples>`_ to see various examples of signing and verifying using the library.
+Check the `examples <http://pythonhosted.org/xmlsec/examples>`_ to see various examples of signing and verifying using the library.
 
 ************
 Requirements
@@ -146,6 +146,9 @@ Running the test suite
 
     py.test tests
 
+3. Tests configuration
+Env variable **PYXMLSEC_TEST_ITERATIONS** specifies number of test iterations to detect memory leaks.
+
 Reporting a issue
 -----------------
 Please attach the output of following information:

tests/base.py

@@ -0,0 +1,122 @@
+import gc
+import os
+import resource
+import sys
+
+from lxml import etree
+import xmlsec
+
+import unittest
+
+etype = type(etree.Element("test"))
+
+ns = {'dsig': xmlsec.constants.DSigNs, 'enc': xmlsec.constants.EncNs}
+
+
+def safe_int(s):
+    try:
+        return int(s)
+    except ValueError:
+        return 0
+
+
+class TestMemoryLeaks(unittest.TestCase):
+    maxDiff = None
+
+    iterations = safe_int(os.getenv("PYXMLSEC_TEST_ITERATIONS", "10"))
+
+    data_dir = os.path.join(os.path.dirname(__file__), "data")
+
+    def setUp(self):
+        gc.disable()
+        self.addTypeEqualityFunc(etype, "assertXmlEqual")
+        xmlsec.enable_debug_trace(1)
+
+    def run(self, result=None):
+        # run first time
+        super(TestMemoryLeaks, self).run(result=result)
+        if self.iterations == 0:
+            return
+
+        m_usage = resource.getrusage(resource.RUSAGE_SELF).ru_maxrss
+        o_count = gc.get_count()[0]
+        m_hits = 0
+        o_hits = 0
+        for i in range(self.iterations):
+            super(TestMemoryLeaks, self).run(result=result)
+            m_usage_n = resource.getrusage(resource.RUSAGE_SELF).ru_maxrss
+            if m_usage_n > m_usage:
+                m_usage = m_usage_n
+                m_hits += 1
+            o_count_n = gc.get_count()[0]
+            if o_count_n > o_count:
+                o_count = o_count_n
+                o_hits += 1
+            del m_usage_n
+            del o_count_n
+
+        if m_hits > int(self.iterations * 0.8):
+            result.buffer = False
+            try:
+                raise AssertionError("memory leak detected")
+            except AssertionError:
+                result.addError(self, sys.exc_info())
+        if o_hits > int(self.iterations * 0.8):
+            result.buffer = False
+            try:
+                raise AssertionError("unreferenced objects detected")
+            except AssertionError:
+                result.addError(self, sys.exc_info())
+
+    def path(self, name):
+        """returns full path for resource"""
+        return os.path.join(self.data_dir, name)
+
+    def load(self, name):
+        """loads resource by name"""
+        with open(self.path(name), "rb") as stream:
+            return stream.read()
+
+    def load_xml(self, name, xpath=None):
+        """returns xml.etree"""
+        root = etree.parse(self.path(name)).getroot()
+        if xpath is None:
+            return root
+        return root.find(xpath)
+
+    def dump(self, root):
+        print(etree.tostring(root))
+
+    def assertXmlEqual(self, first, second, msg=None):
+        """Checks equality of etree.roots"""
+        msg = msg or ''
+        if first.tag != second.tag:
+            self.fail('Tags do not match: %s and %s. %s' % (first.tag, second.tag, msg))
+        for name, value in first.attrib.items():
+            if second.attrib.get(name) != value:
+                self.fail(
+                    'Attributes do not match: %s=%r, %s=%r. %s' % (name, value, name, second.attrib.get(name), msg)
+                )
+        for name in second.attrib.keys():
+            if name not in first.attrib:
+                self.fail('x2 has an attribute x1 is missing: %s. %s' % (name, msg))
+        if not xml_text_compare(first.text, second.text):
+            self.fail('text: %r != %r. %s' % (first.text, second.text, msg))
+        if not xml_text_compare(first.tail, second.tail):
+            self.fail('tail: %r != %r. %s' % (first.tail, second.tail, msg))
+        cl1 = first.getchildren()
+        cl2 = second.getchildren()
+        if len(cl1) != len(cl2):
+            self.fail('children length differs, %i != %i. %s' % (len(cl1), len(cl2), msg))
+        i = 0
+        for c1, c2 in zip(cl1, cl2):
+            i += 1
+            self.assertXmlEqual(c1, c2)
+
+
+def xml_text_compare(t1, t2):
+    if not t1 and not t2:
+        return True
+    if t1 == '*' or t2 == '*':
+        return True
+    return (t1 or '').strip() == (t2 or '').strip()

tests/conftest.py

@@ -0,0 +1 @@
+012345670123456701234567

tests/data/deskey.bin

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+XML Security Library example: Original XML doc file for enc example.
+-->
+<Envelope>
+<Data>Hello, World!</Data>
+</Envelope>