Merge pull request #27 from pycompression/coverage2

Add some coverage improvements

Author: rhpvorderman

pyproject.toml

@@ -1,3 +1,6 @@
 [build-system]
 requires = ["setuptools>=51", "cython>=0.29", "wheel"]
 build-backend = "setuptools.build_meta"
+
+# [tool.coverage.run]
+# plugins = ["Cython.Coverage"]

setup.py

@@ -62,6 +62,20 @@ def build_extension(self, ext):
             ext.extra_objects = [
                 os.path.join(isa_l_prefix_dir, "lib", "libisal.a")]
 
+        if os.getenv("CYTHON_COVERAGE") is not None:
+            # Import cython here so python setup.py can be used without
+            # installing cython.
+            from Cython.Build import cythonize
+            # Add cython directives and macros for coverage support.
+            cythonized_exts = cythonize(ext, compiler_directives=dict(
+                linetrace=True
+            ))
+            for cython_ext in cythonized_exts:
+                cython_ext.define_macros = [("CYTHON_TRACE_NOGIL", "1")]
+                cython_ext._needs_stub = False
+                super().build_extension(cython_ext)
+            return
+
         super().build_extension(ext)
 
 

src/isal/igzip.py

@@ -313,5 +313,5 @@ def main():
             out_file.close()
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: no cover
     main()

tests/test_gzip_compliance.py

@@ -26,7 +26,6 @@
 import tempfile
 import unittest
 from subprocess import PIPE, Popen
-from test import support
 from test.support import _4G, bigmemtest
 from test.support.script_helper import assert_python_failure, assert_python_ok
 
@@ -408,8 +407,12 @@ def test_compresslevel_metadata(self):
 
         for (name, level, expectedXflByte) in cases:
             major, minor, _, _, _ = sys.version_info
-            if major == 3 and minor < 7 or major < 3:
-                # Specific xfl bytes introduced in 3.7
+            if not ("compresslevel" in
+                    gzip.GzipFile._write_gzip_header.__code__.co_varnames
+                    and hasattr(gzip, "_COMPRESS_LEVEL_FAST")
+                    and hasattr(gzip, "_COMPRESS_LEVEL_TRADEOFF")):
+                # Specific xfl bytes introduced in 3.9 and backported to
+                # earlier versions
                 expectedXflByte = b'\x02'
             with self.subTest(name):
                 fWrite = igzip.IGzipFile(self.filename, 'w',
@@ -804,15 +807,13 @@ def test_decompress_infile_outfile(self):
 
         with igzip.open(igzipname, mode='wb') as fp:
             fp.write(self.data)
-        rc, out, err = assert_python_ok('-m', 'isal.igzip', '-d', igzipname)
+        sys.argv = ['', '-d', igzipname]
+        igzip.main()
 
         with open(os.path.join(TEMPDIR, "testigzip"), "rb") as gunziped:
             self.assertEqual(gunziped.read(), self.data)
 
         self.assertTrue(os.path.exists(igzipname))
-        self.assertEqual(rc, 0)
-        self.assertEqual(out, b'')
-        self.assertEqual(err, b'')
 
     def test_decompress_infile_outfile_error(self):
         rc, out, err = assert_python_ok('-m', 'isal.igzip', '-d',
@@ -882,11 +883,3 @@ def test_decompress_cannot_have_flags_compression(self):
             b'-0/--fast',
             err)
         self.assertEqual(out, b'')
-
-
-def test_main(verbose=None):
-    support.run_unittest(TestGzip, TestOpen, TestCommandLine)
-
-
-if __name__ == "__main__":
-    test_main(verbose=True)

tests/test_zlib_compliance.py

@@ -945,7 +945,3 @@ def choose_lines(source, number, seed=None, generator=random):
 class CustomInt:
     def __index__(self):
         return 100
-
-
-if __name__ == "__main__":
-    unittest.main()

tox.ini

@@ -3,13 +3,28 @@
 # python3 interpreter of the user.
 envlist=py3
 [testenv]
-deps=coverage
+deps=pytest
+     coverage
+passenv=
+    PYTHON_ISAL_LINK_DYNAMIC
+commands =
+    # Create HTML coverage report for humans and xml coverage report for external services.
+    coverage run --source={envsitepackagesdir}/isal -m py.test tests
+    coverage html
+    coverage xml
+
+[testenv:coverage]
+# Separate test environment for cython coverage.
+deps=coverage[toml]
+     cython
      pytest
 passenv=
     PYTHON_ISAL_LINK_DYNAMIC
+setenv=
+    CYTHON_COVERAGE=true
 commands =
     # Create HTML coverage report for humans and xml coverage report for external services.
-    coverage run --source={envsitepackagesdir}/isal -m py.test -v tests
+    coverage run --source={envsitepackagesdir}/isal -m py.test tests
     coverage html
     coverage xml
 
@@ -21,7 +36,7 @@ commands=
 [testenv:compatibility]
 deps=pytest
 commands=
-    pytest -v tests/test_isal.py
+    pytest tests/test_isal.py
 
 [testenv:lint]
 deps=flake8