pytest-everyfunc 0.1.0__tar.gz

pytest_everyfunc-0.1.0/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: pytest-everyfunc
+Version: 0.1.0
+Summary: A pytest plugin to detect completely untested functions using coverage
+Author-email: Johannes Buchner <johannes.buchner.acad@gmx.com>
+Requires-Dist: pytest
+Requires-Dist: coverage

pytest_everyfunc-0.1.0/README.rst

@@ -0,0 +1,40 @@
+pytest-everyfunc
+================
+
+A pytest plugin to detect completely untested functions using coverage.
+
+Motivation
+----------
+
+If you add pytest-everyfunc to your CI, you can prevent yourself from
+checking in code that adds functions without tests.
+
+Installation
+------------
+::
+    $ pip install pytest-everyfunc pytest-cov coverage
+
+Usage
+-----
+:: 
+    $ pytest --cov=mypackage --fail-on-untested
+    ...
+    tests/test_script.py ........      [100%]
+    mypackage/foo.py:253: untested function: rv_logpdf
+    mypackage/bar.py:717: untested function: norms
+    mypackage/baz.py:86: untested function: prior_predictive_check_plot
+    Exit: Untested functions found.
+
+
+The output shows the functions that were not called.
+
+If --fail-on-untested is set, then the exit code is 32 (regardless whether tests succeed).
+
+::
+    $ echo $?
+    32
+
+git hook
+--------
+
+add to .git/hooks/pre-commit the command above.

pytest_everyfunc-0.1.0/pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-everyfunc"
+version = "0.1.0"
+description = "A pytest plugin to detect completely untested functions using coverage"
+authors = [{name = "Johannes Buchner", email = "johannes.buchner.acad@gmx.com"}]
+dependencies = ["pytest", "coverage"]
+
+[project.entry-points.pytest11]
+pytest_everyfunc = "pytest_everyfunc.plugin"

pytest_everyfunc-0.1.0/pytest_everyfunc/plugin.py

@@ -0,0 +1,191 @@
+import ast
+import os
+import sys
+from io import StringIO
+from pathlib import Path
+from typing import List, Tuple
+
+import coverage
+import pytest
+
+
+def parse_missed_lines(missing_str: str) -> List[int]:
+    """Parse lines missing in coverage.
+
+    Parameters
+    ----------
+    missing_str: str
+        '<num>-<num>' or '<num>'
+
+    Returns
+    -------
+    lines: list
+        integers in the range
+    """
+    lines = []
+    for part in missing_str.split(","):
+        if "-" in part:
+            start, end = map(int, part.split("-"))
+            lines.extend(range(start, end + 1))
+        else:
+            lines.append(int(part))
+    return lines
+
+
+def parse_coverage_report(file) -> dict:
+    """Parse output of "coverage report -m"
+
+    Parameters
+    ----------
+    file: object
+        input stream
+
+    Returns
+    -------
+    missed_by_file: dict
+        list of lines for each file
+    """
+    missed_by_file = {}
+    file.readline()
+    sepline = file.readline()
+    assert sepline.startswith("----")
+    for line in file:
+        if line.startswith("----") or line.strip() == "":
+            break
+        parts = line.strip().split(maxsplit=4)
+        if len(parts) > 4:
+            filename = parts[0]
+            missing = parts[4].strip()
+            missed_by_file[filename] = set(parse_missed_lines(missing))
+    return missed_by_file
+
+
+def get_functions_from_file(filepath: str) -> List[Tuple[str, int, int]]:
+    """Get list of python functions.
+
+    Parameters
+    ----------
+    filepath: str
+        path to python script
+
+    Returns
+    -------
+    functions: list
+        list of functions and their lines.s
+    """
+    with open(filepath, "r") as f:
+        source = f.read()
+
+    tree = ast.parse(source)
+    functions = []
+
+    class FuncVisitor(ast.NodeVisitor):
+        def visit_FunctionDef(self, node):
+            """Visit a function node.
+
+            Parameters
+            ----------
+            node: object
+                ast node.
+            """
+            funcloc = node.lineno
+            code_lines = []
+            for child in node.body:
+                # Skip docstring (which is always the first expr if present)
+                if isinstance(child, ast.Expr) and isinstance(child.value, ast.Constant):
+                    continue
+                start = child.lineno
+                end = getattr(child, 'end_lineno', start)
+                code_lines.extend(range(start, end + 1))
+            functions.append((node.name, funcloc, code_lines))
+            self.generic_visit(node)
+
+        def visit_AsyncFunctionDef(self, node):
+            """Visit a async function.
+
+            Parameters
+            ----------
+            node: object
+                ast node.
+            """
+            self.visit_FunctionDef(node)
+
+    FuncVisitor().visit(tree)
+    return functions
+
+
+def find_never_called_functions(file = sys.stdin, source_root: str = "."):
+    """Find functions not covered by tests.
+
+    Parameters
+    ----------
+    file: object
+        input stream
+    source_root: str
+        path where files are.
+
+    Returns
+    -------
+    never_called: list
+        list of filename, function name and location tuples.
+    """
+    missed_by_file = parse_coverage_report(file)
+    never_called = []
+
+    for rel_path, missed_lines in missed_by_file.items():
+        filepath = os.path.join(source_root, rel_path)
+        if not os.path.exists(filepath):
+            print(f"File not found: {filepath}")
+            continue
+
+        functions = get_functions_from_file(filepath)
+        for func_name, funcloc, func_lines in functions:
+            if all(line in missed_lines for line in func_lines):
+                never_called.append((rel_path, func_name, funcloc))
+
+    return never_called
+
+def pytest_addoption(parser):
+    """Add our option to pytest.
+
+    Parameters
+    ----------
+    parser: object
+        pytest parser
+    """
+    parser.addoption(
+        "--fail-on-untested", action="store_true", default=False,
+        help="Fail tests if completely untested functions are found."
+    )
+
+def pytest_sessionfinish(session, exitstatus):
+    """Run when pytest is done.
+
+    Parameters
+    ----------
+    session: object
+        pytest session
+    exitstatus: int
+        Exit status.
+    """
+    cov_file = Path(".coverage")
+    if not cov_file.exists():
+        session.config.warn("COV001", "No .coverage file found, skipping untested function check.")
+        return
+
+    cov = coverage.Coverage()
+    cov.load()
+
+    report_output = StringIO()
+    cov.report(file=report_output, show_missing=True)
+    report_output.seek(0)
+
+    untested = find_never_called_functions(report_output)
+
+    if untested:
+        for filename, name, lineno in untested:
+            sys.stderr.write(f"{filename}:{lineno}: untested function: {name}\n")
+
+        if session.config.getoption("--fail-on-untested"):
+            pytest.exit("Untested functions found.", 32)
+

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: pytest-everyfunc
+Version: 0.1.0
+Summary: A pytest plugin to detect completely untested functions using coverage
+Author-email: Johannes Buchner <johannes.buchner.acad@gmx.com>
+Requires-Dist: pytest
+Requires-Dist: coverage

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.rst
+pyproject.toml
+pytest_everyfunc/__init__.py
+pytest_everyfunc/plugin.py
+pytest_everyfunc.egg-info/PKG-INFO
+pytest_everyfunc.egg-info/SOURCES.txt
+pytest_everyfunc.egg-info/dependency_links.txt
+pytest_everyfunc.egg-info/entry_points.txt
+pytest_everyfunc.egg-info/requires.txt
+pytest_everyfunc.egg-info/top_level.txt

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+pytest_everyfunc = pytest_everyfunc.plugin

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pytest
+coverage

pytest_everyfunc-0.1.0/pytest_everyfunc.egg-info/top_level.txt

@@ -0,0 +1 @@
+pytest_everyfunc

pytest_everyfunc-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+