Annotate warnings

edgarrmondragon · edgarrmondragon · commit 93411ab8db53 · 2024-05-14T12:17:11.000-06:00
- Refactor workflow command generation
- Skip warning annotations in Pytest &lt; 6.0.0
diff --git a/plugin_test.py b/plugin_test.py
@@ -5,14 +5,17 @@
 import pytest
 from packaging import version
 
+PYTEST_VERSION = version.parse(pytest.__version__)
 pytest_plugins = "pytester"
 
 
 # result.stderr.no_fnmatch_line() is added to testdir on pytest 5.3.0
 # https://docs.pytest.org/en/stable/changelog.html#pytest-5-3-0-2019-11-19
 def no_fnmatch_line(result, pattern):
-    if version.parse(pytest.__version__) >= version.parse("5.3.0"):
-        result.stderr.no_fnmatch_line(pattern + "*",)
+    if version.parse("5.3.0") <= PYTEST_VERSION:
+        result.stderr.no_fnmatch_line(
+            pattern + "*",
+        )
     else:
         assert pattern not in result.stderr.str()
 
@@ -68,7 +71,9 @@ def test_fail():
     testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
     result.stderr.fnmatch_lines(
-        ["::error file=test_annotation_fail.py,line=5::test_fail*assert 0*",]
+        [
+            "::error file=test_annotation_fail.py,line=5::test_fail*assert 0*",
+        ]
     )
 
 
@@ -86,8 +91,56 @@ def test_fail():
     testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
     result.stderr.fnmatch_lines(
-        ["::error file=test_annotation_exception.py,line=5::test_fail*oops*",]
+        [
+            "::error file=test_annotation_exception.py,line=5::test_fail*oops*",
+        ]
+    )
+
+
+@pytest.mark.skipif(
+    version.parse("6.0.0") > PYTEST_VERSION,
+    reason="requires pytest 6.0.0",
+)
+def test_annotation_warning(testdir):
+    testdir.makepyfile(
+        """
+        import warnings
+        import pytest
+        pytest_plugins = 'pytest_github_actions_annotate_failures'
+
+        def test_warning():
+            warnings.warn('beware', Warning)
+            assert 1
+        """
     )
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    result = testdir.runpytest_subprocess()
+    result.stderr.fnmatch_lines(
+        [
+            "::warning file=test_annotation_warning.py,line=6::beware",
+        ]
+    )
+
+
+@pytest.mark.skipif(
+    version.parse("6.0.0") > PYTEST_VERSION,
+    reason="requires pytest 6.0.0",
+)
+def test_annotation_exclude_warnings(testdir):
+    testdir.makepyfile(
+        """
+        import warnings
+        import pytest
+        pytest_plugins = 'pytest_github_actions_annotate_failures'
+
+        def test_warning():
+            warnings.warn('beware', Warning)
+            assert 1
+        """
+    )
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    result = testdir.runpytest_subprocess("--exclude-warnings")
+    assert not result.stderr.lines
 
 
 def test_annotation_third_party_exception(testdir):
@@ -111,7 +164,43 @@ def test_fail():
     testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
     result.stderr.fnmatch_lines(
-        ["::error file=test_annotation_third_party_exception.py,line=6::test_fail*oops*",]
+        [
+            "::error file=test_annotation_third_party_exception.py,line=6::test_fail*oops*",
+        ]
+    )
+
+
+@pytest.mark.skipif(
+    version.parse("6.0.0") > PYTEST_VERSION,
+    reason="requires pytest 6.0.0",
+)
+def test_annotation_third_party_warning(testdir):
+    testdir.makepyfile(
+        my_module="""
+        import warnings
+
+        def fn():
+            warnings.warn('beware', Warning)
+        """
+    )
+
+    testdir.makepyfile(
+        """
+        import pytest
+        from my_module import fn
+        pytest_plugins = 'pytest_github_actions_annotate_failures'
+
+        def test_warning():
+            fn()
+        """
+    )
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    result = testdir.runpytest_subprocess()
+    result.stderr.fnmatch_lines(
+        # ["::warning file=test_annotation_third_party_warning.py,line=6::beware",]
+        [
+            "::warning file=my_module.py,line=4::beware",
+        ]
     )
 
 
@@ -148,7 +237,9 @@ def test_fail():
     testdir.makefile(".ini", pytest="[pytest]\ntestpaths=..")
     result = testdir.runpytest_subprocess("--rootdir=foo")
     result.stderr.fnmatch_lines(
-        ["::error file=test_annotation_fail_cwd.py,line=5::test_fail*assert 0*",]
+        [
+            "::error file=test_annotation_fail_cwd.py,line=5::test_fail*assert 0*",
+        ]
     )
 
 
@@ -166,7 +257,9 @@ def test_fail():
     testdir.monkeypatch.setenv("PYTEST_RUN_PATH", "some_path")
     result = testdir.runpytest_subprocess()
     result.stderr.fnmatch_lines(
-        ["::error file=some_path/test_annotation_fail_runpath.py,line=5::test_fail*assert 0*",]
+        [
+            "::error file=some_path/test_annotation_fail_runpath.py,line=5::test_fail*assert 0*",
+        ]
     )
 
 
diff --git a/pytest_github_actions_annotate_failures/plugin.py b/pytest_github_actions_annotate_failures/plugin.py
@@ -3,11 +3,11 @@
 
 import os
 import sys
-from collections import OrderedDict
 from typing import TYPE_CHECKING
 
 import pytest
 from _pytest._code.code import ExceptionRepr
+from packaging import version
 
 if TYPE_CHECKING:
     from _pytest.nodes import Item
@@ -23,6 +23,9 @@
 # https://github.com/pytest-dev/pytest/blob/master/src/_pytest/terminal.py
 
 
+PYTEST_VERSION = version.parse(pytest.__version__)
+
+
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
 def pytest_runtest_makereport(item: Item, call):  # noqa: ARG001
     # execute all other hooks to obtain the report object
@@ -79,25 +82,92 @@ def pytest_runtest_makereport(item: Item, call):  # noqa: ARG001
         elif isinstance(report.longrepr, str):
             longrepr += "\n\n" + report.longrepr
 
-        print(
-            _error_workflow_command(filesystempath, lineno, longrepr), file=sys.stderr
+        workflow_command = _build_workflow_command(
+            "error",
+            filesystempath,
+            lineno,
+            message=longrepr,
         )
+        print(workflow_command, file=sys.stderr)
 
 
-def _error_workflow_command(filesystempath, lineno, longrepr):
-    # Build collection of arguments. Ordering is strict for easy testing
-    details_dict = OrderedDict()
-    details_dict["file"] = filesystempath
-    if lineno is not None:
-        details_dict["line"] = lineno
+class _AnnotateWarnings:
+    def pytest_warning_recorded(self, warning_message, when, nodeid, location):  # noqa: ARG002
+        # enable only in a workflow of GitHub Actions
+        # ref: https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
+        if os.environ.get("GITHUB_ACTIONS") != "true":
+            return
 
-    details = ",".join(f"{k}={v}" for k, v in details_dict.items())
+        filesystempath = warning_message.filename
+        workspace = os.environ.get("GITHUB_WORKFLOW")
 
-    if longrepr is None:
-        return f"\n::error {details}"
+        if workspace:
+            try:
+                rel_path = os.path.relpath(filesystempath, workspace)
+            except ValueError:
+                # os.path.relpath() will raise ValueError on Windows
+                # when full_path and workspace have different mount points.
+                rel_path = filesystempath
+            if not rel_path.startswith(".."):
+                filesystempath = rel_path
+        else:
+            filesystempath = os.path.relpath(filesystempath)
+
+        workflow_command = _build_workflow_command(
+            "warning",
+            filesystempath,
+            warning_message.lineno,
+            message=warning_message.message.args[0],
+        )
+        print(workflow_command, file=sys.stderr)
+
+
+if version.parse("6.0.0") <= PYTEST_VERSION:
+
+    def pytest_addoption(parser):
+        group = parser.getgroup("pytest_github_actions_annotate_failures")
+        group.addoption(
+            "--exclude-warnings",
+            action="store_true",
+            default=False,
+            help="Annotate failures in GitHub Actions.",
+        )
 
-    longrepr = _escape(longrepr)
-    return f"\n::error {details}::{longrepr}"
+    def pytest_configure(config):
+        if not config.option.exclude_warnings:
+            config.pluginmanager.register(_AnnotateWarnings(), "annotate_warnings")
+
+
+def _build_workflow_command(
+    command_name,
+    file,
+    line,
+    end_line=None,
+    column=None,
+    end_column=None,
+    title=None,
+    message=None,
+):
+    """Build a command to annotate a workflow."""
+    result = f"::{command_name} "
+
+    entries = [
+        ("file", file),
+        ("line", line),
+        ("endLine", end_line),
+        ("col", column),
+        ("endColumn", end_column),
+        ("title", title),
+    ]
+
+    result = result + ",".join(
+        f"{k}={v}" for k, v in entries if v is not None
+    )
+
+    if message is not None:
+        result = result + "::" + _escape(message)
+
+    return result
 
 
 def _escape(s):
diff --git a/tox.ini b/tox.ini
@@ -31,7 +31,7 @@ deps =
     pytest6: pytest>=6.0.0,<7.0.0
     pytest7: pytest>=7.0.0,<8.0.0
 
-commands = {envpython} -m pytest
+commands = {envpython} -m pytest {posargs}
 
 [testenv:pkg]
 skip_install = true
