Add test scenarios for analyze-project

.github/actions/verify_expected_failure/action.yml

@@ -0,0 +1,20 @@
+name: Verify expected failure
+description: Verify the the step-outcome is a 'failure'
+
+inputs:
+  step-outcome:
+    description: The outcome of the step to verify
+    required: true
+    type: string
+runs:
+  using: composite
+  steps:
+    - name: Verify outcome is 'failure'
+      run: |
+        if [[ "${{ inputs.step-outcome }}" != "failure" ]]; then
+          echo "::error title=Test Failure::Expected previous step to fail, but it succeeded."
+          exit 1
+        else
+          echo "::notice title=Test Success::Previous step failed as expected."
+        fi
+      shell: bash

.github/test_projects/minimal/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "test-project"
+name = "minimal"
 version = "0.1.0"
-description = ""
+description = "Tests actions/analyze-project with a minimal project that has no errors"
 authors = [
     {name = "Joel Dixon",email = "[email protected]"}
 ]

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

@@ -0,0 +1,32 @@
+[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"
+mypy = ">=1.0"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.mypy]
+mypy_path = "."
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+
+[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/mypy-errors/src/test_project/__init__.py

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

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

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

.github/test_projects/mypy-errors/tests/__init__.py

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

.github/test_projects/ni-python-styleguide-errors/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "ni-python-styleguide-errors"
+version = "0.1.0"
+description = "Tests actions/analyze-project with a project that has ni-python-styleguide 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"
+mypy = ">=1.0"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.mypy]
+mypy_path = "."
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+
+[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/ni-python-styleguide-errors/src/test_project/__init__.py

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

.github/test_projects/ni-python-styleguide-errors/src/test_project/ni-python-styleguide-errors.py

@@ -0,0 +1,7 @@
+import os, sys  # Multiple imports on one line (E401)
+
+def foo( x: int , y: int ) -> int:  # Spaces around parameters (E211, E251)
+    print( "Hello, world!" )  # Unnecessary spaces inside parentheses (E201, E202)
+    return x+y  # Missing whitespace around operator (E225)
+
+foo(1,2)

.github/test_projects/ni-python-styleguide-errors/tests/__init__.py

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