Merge pull request #86 from nicoddemus/type-checking

Author: nicoddemus

.pre-commit-config.yaml

@@ -1,5 +1,14 @@
-exclude: '^($|.*\.bin)'
+default_language_version:
+  python: "3.10"
 repos:
+  - repo: https://github.com/myint/autoflake
+    rev: v1.5.3
+    hooks:
+      - id: autoflake
+        name: autoflake
+        args: [ "--in-place", "--remove-unused-variables", "--remove-all-unused-imports" ]
+        language: python
+        files: \.py$
   - repo: https://github.com/asottile/reorder_python_imports
     rev: v3.8.2
     hooks:
@@ -11,7 +20,6 @@ repos:
     hooks:
       - id: black
         args: [--safe, --quiet]
-        language_version: python3.7
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.2.0
     hooks:
@@ -25,3 +33,11 @@ repos:
         files: README.rst
         language: python
         additional_dependencies: [pygments, restructuredtext_lint]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.971
+    hooks:
+    -   id: mypy
+        files: src/
+        args: []
+        additional_dependencies:
+          - pytest>=7

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.2.1 (2022-09-23)
+
+- Fixed a problem while handling errors using``--gtest_filter``. The recommendation is to use pytest's own
+  filtering facilities (like `-k`) instead of passing filtering arguments to the underlying framework
+  ([#84](https://github.com/pytest-dev/pytest-cpp/issues/84)).
+
+
 # 2.2.0 (2022-08-22)
 
 - Dropped support for Python 3.6.

README.rst

@@ -99,6 +99,11 @@ pytest's ``-o`` option:
 
     $ pytest -o cpp_arguments='-v --log-dir=logs'
 
+**Important**: do not pass filtering arguments (for example ``--gtest_filter``), as this will conflict
+with the plugin functionality and behave incorrectly.
+
+To filter tests, use the standard pytest filtering facilities (such as ``-k``).
+
 cpp_ignore_py_files
 ^^^^^^^^^^^^^^^^^^^
 

mypy.ini

@@ -0,0 +1,17 @@
+[mypy]
+files = src
+check_untyped_defs = True
+disallow_any_generics = True
+ignore_missing_imports = True
+no_implicit_optional = True
+show_error_codes = True
+strict_equality = True
+warn_redundant_casts = True
+warn_return_any = True
+warn_unreachable = True
+warn_unused_configs = True
+no_implicit_reexport = True
+local_partial_types = True
+disallow_untyped_defs = True
+; workaround for https://github.com/python/mypy/issues/10709
+ignore_missing_imports_per_module = True

src/pytest_cpp/boost.py

@@ -1,20 +1,24 @@
+from __future__ import annotations
+
 import io
 import os
-import shutil
 import subprocess
 import tempfile
+from typing import Sequence
 from xml.etree import ElementTree
 
 from pytest_cpp.error import CppTestFailure
+from pytest_cpp.error import Markup
+from pytest_cpp.facade_abc import AbstractFacade
 
 
-class BoostTestFacade(object):
+class BoostTestFacade(AbstractFacade):
     """
     Facade for BoostTests.
     """
 
     @classmethod
-    def is_test_suite(cls, executable):
+    def is_test_suite(cls, executable: str) -> bool:
         try:
             output = subprocess.check_output(
                 [executable, "--help"],
@@ -26,37 +30,41 @@ def is_test_suite(cls, executable):
         else:
             return "--output_format" in output and "log_format" in output
 
-    def list_tests(self, executable):
+    def list_tests(self, executable: str) -> list[str]:
         # unfortunately boost doesn't provide us with a way to list the tests
         # inside the executable, so the test_id is a dummy placeholder :(
         return [os.path.basename(os.path.splitext(executable)[0])]
 
-    def run_test(self, executable, test_id, test_args=(), harness=None):
-        harness = harness or []
-
-        def read_file(name):
+    def run_test(
+        self,
+        executable: str,
+        test_id: str,
+        test_args: Sequence[str] = (),
+        harness: Sequence[str] = (),
+    ) -> tuple[Sequence[BoostTestFailure] | None, str]:
+        def read_file(name: str) -> str:
             try:
                 with io.open(name) as f:
                     return f.read()
             except IOError:
-                return None
-
-        temp_dir = tempfile.mkdtemp()
-        log_xml = os.path.join(temp_dir, "log.xml")
-        report_xml = os.path.join(temp_dir, "report.xml")
-        args = harness + [
-            executable,
-            "--output_format=XML",
-            "--log_sink=%s" % log_xml,
-            "--report_sink=%s" % report_xml,
-        ]
-        args.extend(test_args)
-        p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-        raw_stdout, _ = p.communicate()
-        stdout = raw_stdout.decode("utf-8") if raw_stdout else ""
-
-        log = read_file(log_xml)
-        report = read_file(report_xml)
+                return ""
+
+        with tempfile.TemporaryDirectory(prefix="pytest-cpp") as temp_dir:
+            log_xml = os.path.join(temp_dir, "log.xml")
+            report_xml = os.path.join(temp_dir, "report.xml")
+            args = list(harness) + [
+                executable,
+                "--output_format=XML",
+                "--log_sink=%s" % log_xml,
+                "--report_sink=%s" % report_xml,
+            ]
+            args.extend(test_args)
+            p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+            raw_stdout, _ = p.communicate()
+            stdout = raw_stdout.decode("utf-8") if raw_stdout else ""
+
+            log = read_file(log_xml)
+            report = read_file(report_xml)
 
         if p.returncode not in (0, 200, 201):
             msg = (
@@ -81,14 +89,13 @@ def read_file(name):
             return [failure], stdout
 
         results = self._parse_log(log=log)
-        shutil.rmtree(temp_dir)
 
         if results:
             return results, stdout
 
         return None, stdout
 
-    def _parse_log(self, log):
+    def _parse_log(self, log: str) -> list[BoostTestFailure]:
         """
         Parse the "log" section produced by BoostTest.
 
@@ -116,19 +123,19 @@ def _parse_log(self, log):
         for elem in parsed_elements:
             filename = elem.attrib["file"]
             linenum = int(elem.attrib["line"])
-            result.append(BoostTestFailure(filename, linenum, elem.text))
+            result.append(BoostTestFailure(filename, linenum, elem.text or ""))
         return result
 
 
 class BoostTestFailure(CppTestFailure):
-    def __init__(self, filename, linenum, contents):
+    def __init__(self, filename: str, linenum: int, contents: str) -> None:
         self.filename = filename
         self.linenum = linenum
         self.lines = contents.splitlines()
 
-    def get_lines(self):
+    def get_lines(self) -> list[tuple[str, Markup]]:
         m = ("red", "bold")
         return [(x, m) for x in self.lines]
 
-    def get_file_reference(self):
+    def get_file_reference(self) -> tuple[str, int]:
         return self.filename, self.linenum