Introduce a composite action to check a test project and expect errors conditionally

Author: dixonjoel

.github/actions/test_analyze_project/action.yml

@@ -0,0 +1,34 @@
+name: Test Analyze Project
+description: Test the analyze-project action with configurable project directory and failure expectations
+
+inputs:
+  project-directory:
+    description: Path to the directory containing pyproject.toml
+    required: true
+    type: string
+  expect-failure:
+    description: Whether the analyze-project step is expected to fail
+    required: false
+    default: 'false'
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - name: Analyze project
+      uses: ../../analyze-project
+      id: analyze-project
+      continue-on-error: ${{ inputs.expect-failure == 'true' }}
+      with:
+        project-directory: ${{ inputs.project-directory }}
+    - name: Check expected outcome
+      run: |
+        if [[ "${{ inputs.expect-failure }}" == "true" ]]; then
+          if [[ "${{ steps.analyze-project.outcome }}" != "failure" ]]; then
+            echo "::error title=Test Failure::Expected analyze-project to fail, but it succeeded."
+            exit 1
+          else
+            echo "::notice title=Test Success::analyze-project failed as expected."
+          fi
+        fi
+      shell: bash

.github/test_projects/mypy-errors/src/test_project/mypy-errors.py

@@ -1,7 +1,7 @@
 """Required docstring."""
 
 
-def foo(x: int, y: int):
+def foo(x: int, y: int): # mypy error: Function is missing a return type annotation
     """Required docstring."""
     print("Hello, world!")
     return x + y

.github/test_projects/pyright-errors/README.md

@@ -0,0 +1,24 @@
+[project]
+name = "mypy-errors"
+version = "0.1.0"
+description = "Tests actions/analyze-project with a project that has mypy errors"
+authors = [
+    {name = "Joel Dixon",email = "[email protected]"}
+]
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+dynamic = ["dependencies"]
+
+[tool.poetry]
+packages = [{include = "test_project", from = "src"}]
+
+[tool.poetry.group.lint.dependencies]
+ni-python-styleguide = ">=0.4.1"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.pyright]
+include = ["src/", "tests/"]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

.github/test_projects/pyright-errors/poetry.lock

@@ -0,0 +1 @@
+"""Docstring required."""

.github/test_projects/pyright-errors/pyproject.toml

@@ -0,0 +1,20 @@
+"""Required docstring."""
+
+
+def foo(x: int, y: int) -> int:
+    """Required docstring."""
+    print("Hello, world!")
+    return x + y
+
+
+# Definitive Pyright errors:
+def broken_function(x: str) -> int:
+    """This function has type errors."""
+    return x  # Error: returning str when int expected
+
+
+# Type mismatch
+numbers: list[int] = [1, 2, "three"]  # Error: str in int list
+
+# Wrong argument types
+result = foo("not", "numbers")  # Error: str args to int params

.github/test_projects/pyright-errors/src/test_project/__init__.py

@@ -0,0 +1 @@
+"""Module docstring."""

.github/test_projects/pyright-errors/src/test_project/pyright-errors.py

@@ -229,32 +229,19 @@ jobs:
       - name: Set up Poetry
         uses: ./setup-poetry
       - name: Analyze Valid Minimal
-        uses: ./analyze-project
-        id: minimal
+        uses: ./.github/actions/test_analyze_project
         with:
           project-directory: ${{ github.workspace }}/.github/test_projects/minimal
       - name: Analyze ni-python-styleguide Errors Project
-        uses: ./analyze-project
-        id: ni-python-styleguide-errors
-        continue-on-error: true
+        uses: ./.github/actions/test_analyze_project
         with:
           project-directory: ${{ github.workspace }}/.github/test_projects/ni-python-styleguide-errors
-      - name: Error if the previous step didn't fail
-        if: steps.ni-python-styleguide-errors.outcome != 'failure'
-        run: |
-          echo "::error title=Test Failure::The previous step did not fail as expected."
-          exit 1
+          expect-failure: 'true'
       - name: Analyze mypy Errors Project
-        uses: ./analyze-project
-        id: mypy-errors
-        continue-on-error: true
+        uses: ./.github/actions/test_analyze_project
         with:
           project-directory: ${{ github.workspace }}/.github/test_projects/mypy-errors
-      - name: Error if the previous step didn't fail
-        if: steps.mypy-errors.outcome != 'failure'
-        run: |
-          echo "::error title=Test Failure::The previous step did not fail as expected."
-          exit 1
+          expect-failure: 'true'
 
   # This job is intended to combine the test results so we don't have to list
   # each matrix combination in the required status check settings. There are a