Merge branch 'main' into henryiii-patch-2

Author: edgarrmondragon

.github/workflows/deploy.yml

@@ -1,30 +1,31 @@
 name: deploy
 
 on:
+  workflow_dispatch:
+  pull_request:
   push:
+    branches:
+      - main
     tags:
       - v*
 
 jobs:
-  deploy:
+  dist:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+    - uses: actions/checkout@v4
+    - uses: hynek/build-and-inspect-python-package@v2
 
-    - name: Set up Python
-      uses: actions/setup-python@v5
+  deploy:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+    - uses: actions/download-artifact@v4
       with:
-        python-version: '3.11'
-
-    - name: Install dependencies for build
-      run: pip install --upgrade setuptools build
-
-    - name: Build
-      run: python -m build
+        name: Packages
+        path: dist
 
     - name: Publish package
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        user: __token__
         password: ${{ secrets.pypi_password }}

.github/workflows/test.yml

@@ -17,10 +17,10 @@ env:
 jobs:
   test:
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
         python-version:
-          - '3.7'
           - '3.8'
           - '3.9'
           - '3.10'
@@ -38,11 +38,10 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install test dependencies
-      run: pip install tox tox-gh-actions
+    - uses: astral-sh/setup-uv@v3
 
-    - name: Test packaging
-      run: tox -e pkg
+    - name: Install tox
+      run: uv tool install --with tox-gh-actions --with tox-uv tox
 
     - name: Run tests with PyTest 8
       run: tox
@@ -64,7 +63,12 @@ jobs:
 
   post-test:
     name: All tests passed
+    if: always()
+    needs: [test]
     runs-on: ubuntu-latest
-    needs: test
+    timeout-minutes: 2
     steps:
-      - run: echo ok
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Incompatible changes
 
+- Require python 3.8+ #87 (thanks to @edgarrmondragon)
 - Require pytest 6+ #86 (thanks to @edgarrmondragon)
 
 ## 0.2.0 (2023-05-04)

README.md

@@ -19,7 +19,7 @@ jobs:
 
     - uses: actions/setup-python@v4
       with:
-        python-version: 3.7
+        python-version: 3.8
 
     - name: Install dependencies
       run: |
@@ -36,5 +36,9 @@ If your test is running in a Docker container, you have to install this plugin a
 
 If your tests are run from a subdirectory of the git repository, you have to set the `PYTEST_RUN_PATH` environment variable to the path of that directory relative to the repository root in order for GitHub to identify the files with errors correctly.
 
+### Warning annotations
+
+This plugin also supports warning annotations when used with Pytest 6.0+. To disable warning annotations, pass `--exclude-warning-annotations` to pytest.
+
 ## Screenshot
 [![Image from Gyazo](https://i.gyazo.com/b578304465dd1b755ceb0e04692a57d9.png)](https://gyazo.com/b578304465dd1b755ceb0e04692a57d9)

plugin_test.py

@@ -5,19 +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
+# result.stderr.no_fnmatch_line() was 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 + "*",)
-    else:
-        assert pattern not in result.stderr.str()
+def no_fnmatch_line(result: pytest.RunResult, pattern: str):
+    result.stderr.no_fnmatch_line(pattern + "*")
 
 
-def test_annotation_succeed_no_output(testdir):
+def test_annotation_succeed_no_output(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -33,7 +31,7 @@ def test_success():
     no_fnmatch_line(result, "::error file=test_annotation_succeed_no_output.py")
 
 
-def test_annotation_pytest_error(testdir):
+def test_annotation_pytest_error(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -55,7 +53,7 @@ def test_error():
     )
 
 
-def test_annotation_fail(testdir):
+def test_annotation_fail(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -68,11 +66,13 @@ 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*",
+        ]
     )
 
 
-def test_annotation_exception(testdir):
+def test_annotation_exception(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -86,11 +86,51 @@ 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*",
+        ]
+    )
+
+
+def test_annotation_warning(testdir: pytest.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",
+        ]
+    )
+
+
+def test_annotation_exclude_warnings(testdir: pytest.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-warning-annotations")
+    assert not result.stderr.lines
 
 
-def test_annotation_third_party_exception(testdir):
+def test_annotation_third_party_exception(testdir: pytest.Testdir):
     testdir.makepyfile(
         my_module="""
         def fn():
@@ -111,11 +151,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*",
+        ]
+    )
+
+
+def test_annotation_third_party_warning(testdir: pytest.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",
+        ]
     )
 
 
-def test_annotation_fail_disabled_outside_workflow(testdir):
+def test_annotation_fail_disabled_outside_workflow(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -132,7 +204,7 @@ def test_fail():
     )
 
 
-def test_annotation_fail_cwd(testdir):
+def test_annotation_fail_cwd(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -148,11 +220,13 @@ 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*",
+        ]
     )
 
 
-def test_annotation_fail_runpath(testdir):
+def test_annotation_fail_runpath(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -166,11 +240,13 @@ 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*",
+        ]
     )
 
 
-def test_annotation_long(testdir):
+def test_annotation_long(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -202,7 +278,7 @@ def test_fail():
     no_fnmatch_line(result, "::*assert x += 1*")
 
 
-def test_class_method(testdir):
+def test_class_method(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest
@@ -224,7 +300,7 @@ def test_method(self):
     no_fnmatch_line(result, "::*x = 1*")
 
 
-def test_annotation_param(testdir):
+def test_annotation_param(testdir: pytest.Testdir):
     testdir.makepyfile(
         """
         import pytest

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 # https://peps.python.org/pep-0621/#readme
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 version = "0.2.0"
 name = "pytest-github-actions-annotate-failures"
 description = "pytest plugin to annotate failed tests with a workflow command for GitHub Actions"
@@ -25,7 +25,6 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Framework :: Pytest",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
@@ -52,6 +51,9 @@ changelog = "https://github.com/pytest-dev/pytest-github-actions-annotate-failur
 [project.entry-points.pytest11]
 pytest_github_actions_annotate_failures = "pytest_github_actions_annotate_failures.plugin"
 
+[project.optional-dependencies]
+test = ["packaging"]
+
 
 [tool.ruff.lint]
 extend-select = [