Add integration with pre-commit.ci (xmlsec#230)

* add pre-commit.ci badge

Signed-off-by: oleg.hoefling <[email protected]>

* fix pre-commit warnings

Signed-off-by: oleg.hoefling <[email protected]>

Signed-off-by: oleg.hoefling <[email protected]>

Author: hoefling

.pre-commit-config.yaml

@@ -1,6 +1,5 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-exclude: ".*.diff"  # exclude patches
 repos:
 -   repo: https://github.com/psf/black
     rev: 22.6.0
@@ -21,6 +20,7 @@ repos:
     -   id: check-merge-conflict
     -   id: check-json
     -   id: detect-private-key
+        exclude: ^.*/rsakey.pem$
     -   id: mixed-line-ending
     -   id: pretty-format-json
         args: [--autofix]

README.rst

@@ -3,8 +3,9 @@ python-xmlsec
 
 .. image:: https://img.shields.io/pypi/v/xmlsec.svg?logo=python&logoColor=white
    :target: https://pypi.python.org/pypi/xmlsec
-.. image:: https://img.shields.io/travis/com/mehcode/python-xmlsec/master.svg?logo=travis&logoColor=white&label=Travis%20CI
-   :target: https://travis-ci.org/mehcode/python-xmlsec
+.. image:: https://results.pre-commit.ci/badge/github/xmlsec/python-xmlsec/master.svg
+   :target: https://results.pre-commit.ci/latest/github/xmlsec/python-xmlsec/master
+   :alt: pre-commit.ci status
 .. image:: https://img.shields.io/appveyor/ci/hoefling/xmlsec/master.svg?logo=appveyor&logoColor=white&label=AppVeyor
    :target: https://ci.appveyor.com/project/hoefling/xmlsec
 .. image:: https://github.com/mehcode/python-xmlsec/actions/workflows/manylinux.yml/badge.svg

doc/source/conf.py

@@ -1,9 +1,7 @@
-# -*- coding: utf-8 -*-
-
 from __future__ import annotations
 
-import urllib.request
 import importlib.metadata
+import urllib.request
 
 import lxml
 from docutils.nodes import Text, reference
@@ -13,7 +11,6 @@
 from sphinx.environment import BuildEnvironment
 from sphinx.errors import ExtensionError
 
-
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx']
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}

doc/source/examples/sign_binary.py

@@ -1,5 +1,3 @@
-from lxml import etree
-
 import xmlsec
 
 ctx = xmlsec.SignatureContext()

doc/source/examples/verify_binary.py

@@ -1,5 +1,3 @@
-from lxml import etree
-
 import xmlsec
 
 ctx = xmlsec.SignatureContext()

doc/source/sphinx-pr-6916.diff

@@ -18,5 +18,8 @@ upload_dir = doc/build/html
 [flake8]
 per-file-ignores =
   *.pyi: E301, E302, E305, E501, E701, F401, F822
+  doc/source/conf.py: D1
+  doc/source/examples/*.py: D1, E501
+  tests/*.py: D1
 exclude = .venv*,.git,*_pb2.pyi,build,dist,libs,.eggs,.direnv*
 max-line-length = 130

setup.cfg

@@ -1,5 +1,6 @@
 import gc
 import os
+import resource
 import sys
 import unittest
 
@@ -12,20 +13,8 @@
 ns = {'dsig': xmlsec.constants.DSigNs, 'enc': xmlsec.constants.EncNs}
 
 
-try:
-    import resource
-
-    def get_memory_usage():
-        return resource.getrusage(resource.RUSAGE_SELF).ru_maxrss
-
-except ImportError:
-    resource = None
-
-    def get_memory_usage():
-        return 0
-
-
 def get_iterations():
+    """Parse iterations amount."""
     if sys.platform in ('win32',):
         return 0
 
@@ -114,9 +103,9 @@ def assertXmlEqual(self, first, second, msg=None):  # noqa: N802
         for name in second.attrib.keys():
             if name not in first.attrib:
                 self.fail('x2 has an attribute x1 is missing: {}. {}'.format(name, msg))
-        if not xml_text_compare(first.text, second.text):
+        if not _xml_text_compare(first.text, second.text):
             self.fail('text: {!r} != {!r}. {}'.format(first.text, second.text, msg))
-        if not xml_text_compare(first.tail, second.tail):
+        if not _xml_text_compare(first.tail, second.tail):
             self.fail('tail: {!r} != {!r}. {}'.format(first.tail, second.tail, msg))
         cl1 = sorted(first.getchildren(), key=lambda x: x.tag)
         cl2 = sorted(second.getchildren(), key=lambda x: x.tag)
@@ -128,7 +117,7 @@ def assertXmlEqual(self, first, second, msg=None):  # noqa: N802
             self.assertXmlEqual(c1, c2)
 
 
-def xml_text_compare(t1, t2):
+def _xml_text_compare(t1, t2):
     if not t1 and not t2:
         return True
     if t1 == '*' or t2 == '*':

tests/base.py

@@ -1,7 +1,8 @@
 def pytest_collection_modifyitems(items):
     """
-    Put the module init test first to implicitly check whether
-    any subsequent test fails because of module reinitialization.
+    Put the module init test first.
+
+    This way, we implicitly check whether any subsequent test fails because of module reinitialization.
     """
 
     def module_init_tests_first(item):

tests/conftest.py

@@ -132,7 +132,6 @@ def test_sign_case3(self):
 
     def test_sign_case4(self):
         """Should sign a file using a dynamically created template, key from PEM and an X509 cert with custom ns."""
-
         root = self.load_xml("sign4-in.xml")
         xmlsec.tree.add_ids(root, ["ID"])
         elem_id = root.get('ID', None)
@@ -249,7 +248,7 @@ def test_verify_case_5(self):
         self.check_verify(5)
 
     def check_verify(self, i):
-        root = self.load_xml("sign%d-out.xml" % i)
+        root = self.load_xml("sign{}-out.xml".format(i))
         xmlsec.tree.add_ids(root, ["ID"])
         sign = xmlsec.tree.find_node(root, consts.NodeSignature)
         self.assertIsNotNone(sign)

tests/test_ds.py

@@ -1,4 +1,3 @@
-import os
 import tempfile
 
 from lxml import etree
@@ -125,7 +124,7 @@ def test_encrypt_binary(self):
 
         encrypted = ctx.encrypt_binary(enc_data, b'test')
         self.assertIsNotNone(encrypted)
-        self.assertEqual("{%s}%s" % (consts.EncNs, consts.NodeEncryptedData), encrypted.tag)
+        self.assertEqual("{{{}}}{}".format(consts.EncNs, consts.NodeEncryptedData), encrypted.tag)
 
         enc_method = xmlsec.tree.find_child(enc_data, consts.NodeEncryptionMethod, consts.EncNs)
         self.assertIsNotNone(enc_method)
@@ -170,7 +169,7 @@ def test_encrypt_uri(self):
 
         encrypted = ctx.encrypt_binary(enc_data, 'file://' + tmpfile.name)
         self.assertIsNotNone(encrypted)
-        self.assertEqual("{%s}%s" % (consts.EncNs, consts.NodeEncryptedData), encrypted.tag)
+        self.assertEqual("{{{}}}{}".format(consts.EncNs, consts.NodeEncryptedData), encrypted.tag)
 
         enc_method = xmlsec.tree.find_child(enc_data, consts.NodeEncryptionMethod, consts.EncNs)
         self.assertIsNotNone(enc_method)
@@ -219,7 +218,7 @@ def test_decrypt_key(self):
         self.assertEqual(self.load_xml("enc3-in.xml"), decrypted)
 
     def check_decrypt(self, i):
-        root = self.load_xml('enc%d-out.xml' % i)
+        root = self.load_xml('enc{}-out.xml'.format(i))
         enc_data = xmlsec.tree.find_child(root, consts.NodeEncryptedData, consts.EncNs)
         self.assertIsNotNone(enc_data)
 
@@ -228,7 +227,7 @@ def check_decrypt(self, i):
         ctx = xmlsec.EncryptionContext(manager)
         decrypted = ctx.decrypt(enc_data)
         self.assertIsNotNone(decrypted)
-        self.assertEqual(self.load_xml("enc%d-in.xml" % i), root)
+        self.assertEqual(self.load_xml("enc{}-in.xml".format(i)), root)
 
     def test_decrypt_bad_args(self):
         ctx = xmlsec.EncryptionContext()

tests/test_enc.py

@@ -112,7 +112,7 @@ def test_sign_data_not_first_callback(self):
         def match_cb(filename):
             nonlocal bad_match_calls
             bad_match_calls += 1
-            False
+            return False
 
         for _ in range(2):
             self._register_mismatch_callbacks(match_cb)
@@ -132,7 +132,7 @@ def test_failed_sign_because_default_callbacks(self):
         def mismatch_cb(filename):
             nonlocal mismatch_calls
             mismatch_calls += 1
-            False
+            return False
 
         # NB: These first two sets of callbacks should never get called,
         # because the default callbacks always match beforehand:

tests/test_main.py

@@ -5,9 +5,9 @@
 class TestModule(base.TestMemoryLeaks):
     def test_reinitialize_module(self):
         """
-        This doesn't explicitly test anything, but will
-        be invoked first in the suite, so if the subsequent
-        tests don't fail, we know that the ``init()``/``shutdown()``
+        This test doesn't explicitly verify anything, but will be invoked first in the suite.
+
+        So if the subsequent tests don't fail, we know that the ``init()``/``shutdown()``
         function pair doesn't break anything.
         """
         xmlsec.shutdown()