feat: Add CI for linting, formatting, unit tests, and type checking

This also modifies the scripts used to run the linting and formatting tasks.

Author: delilahw

.github/workflows/test-keyring.yaml

@@ -0,0 +1,59 @@
+name: Artifacts Helper Keyring Tests
+
+on:
+  push:
+    paths:
+      - ".github/workflows/test-keyring.yaml"
+      - "src/artifacts-helper/codespaces_artifacts_helper_keyring/**.py"
+
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/test-keyring.yaml"
+      - "src/artifacts-helper/codespaces_artifacts_helper_keyring/**.py"
+
+defaults:
+  run:
+    working-directory: src/artifacts-helper/codespaces_artifacts_helper_keyring
+
+jobs:
+  generate-jobs:
+    name: Generate jobs
+    runs-on: ubuntu-latest
+    outputs:
+      session: ${{ steps.set-matrix.outputs.session }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: wntrblm/nox@main
+        with:
+          python-versions: "3.12"
+
+      - id: set-matrix
+        shell: bash
+        run: echo session=$(nox --json -l --tags ci | jq -c '[.[].session]') | tee --append $GITHUB_OUTPUT
+
+  checks:
+    name: Session ${{ matrix.session }}
+    needs: [generate-jobs]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        session: ${{ fromJson(needs.generate-jobs.outputs.session) }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: wntrblm/nox@main
+        with:
+          python-versions: "3.8, 3.9, 3.10, 3.11, 3.12, pypy-3.9, pypy-3.10"
+
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          version: "2.15.1"
+          python-version-file: "src/artifacts-helper/codespaces_artifacts_helper_keyring/pyproject.toml"
+
+      - name: Run ${{ matrix.session }}
+        run: pdm run nox --error-on-missing-interpreters --error-on-external-run -s "${{ matrix.session }}"

src/artifacts-helper/codespaces_artifacts_helper_keyring/noxfile.py

@@ -1,29 +1,63 @@
 import os
+from typing import List
 
 import nox
 
 os.environ.update({"PDM_IGNORE_SAVED_PYTHON": "1"})
 
-PYTHON_VERSIONS = ["3.8", "3.9", "3.10", "3.11", "3.12"]
-LOCATIONS = "src", "tests", "noxfile.py"
+DEFAULT_PYTHON_VERSION = "3.11"
+PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
-
-@nox.session(py=PYTHON_VERSIONS)
-@nox.parametrize("keyring", ["20", "25.1"])
-def tests(session, keyring):
-    session.run_always("pdm", "install", "-G", "test", external=True)
-    session.install(f"keyring=={keyring}")
-    session.run("pdm", "test", *session.posargs, external=True)
+DEFAULT_TEST_LOCATION = "tests"
+LOCATIONS = ["src", DEFAULT_TEST_LOCATION, "noxfile.py"]
 
 
-@nox.session
+@nox.session(py=DEFAULT_PYTHON_VERSION, tags=["ci"])
 def lint(session):
-    session.run_always("pdm", "install", "-G", "lint", external=True)
-    session.run("pdm", "check", external=True)
+    """Run the linter.
+
+    Returns a failure if the linter finds any issues.
+    """
+    session.run_always("pdm", "install", "-dG", "lint", external=True)
+    session.run("ruff", "check", *LOCATIONS, *session.posargs)
+
+
+@nox.session(py=DEFAULT_PYTHON_VERSION, tags=["ci"])
+def format_check(session):
+    """Run the formatter and fail if issues are found."""
+    session.notify("format", posargs=["--check", *LOCATIONS])
+
+
+@nox.session(py=DEFAULT_PYTHON_VERSION)
+def format(session):
+    """Run the formatter and fix issues."""
+    session.run_always("pdm", "install", "-dG", "lint", external=True)
+    args = session.posargs or LOCATIONS
+    session.run("ruff", "format", *args)
+
+
+@nox.session(tags=["ci"])
+@nox.parametrize(
+    "python,keyring",
+    [
+        (python, keyring)
+        for python in PYTHON_VERSIONS
+        for keyring in ("20", "25.1")
+        # exclude keyring 20 because it is incompatible with python 3.12
+        if (python, keyring) != ("3.12", "20")
+    ],
+)
+def tests(session, keyring):
+    """Run the test suite."""
+    session.run_always("pdm", "install", "-dG", "test", external=True)
+    session.install(f"keyring=={keyring}")
+    args = session.posargs or [DEFAULT_TEST_LOCATION]
+    session.run("pytest", "-v", *args)
 
 
-@nox.session(py=PYTHON_VERSIONS)
+@nox.session(py=PYTHON_VERSIONS, tags=["ci"])
 def mypy(session):
+    """Run the type checker."""
     session.run_always("pdm", "install", external=True)
     args = session.posargs or LOCATIONS
-    session.run("pdm", "run", "mypy", *args, external=True)
+    session.run("mypy", *args)

src/artifacts-helper/codespaces_artifacts_helper_keyring/pdm.lock

@@ -39,15 +39,25 @@ version = {attr = "codespaces_artifacts_helper_keyring.__version__"}
 distribution = true
 
 [tool.pdm.dev-dependencies]
-lint = ["mypy>=1.9.0", "ruff>=0.4.0", "pre-commit>=3.5.0"]
+lint = [
+    "mypy>=1.9.0",
+    "ruff>=0.4.0",
+]
 dev = ["pip>=24.0", "nox>=2024.4.15"]
 test = ["pytest>=8.1.1", "pytest-cov>=5.0.0"]
 stubs = ["types-requests>=2.31.0.20240406"]
 
 [tool.pdm.scripts]
-check = "ruff check ."
-fmt = "ruff format ."
-test = "pytest -v tests"
+lint-fix = "pdm lint --fix"
+lint = "nox --error-on-external-run -R -s lint -- {args}"
+
+format-check = "pdm format --check"
+format = "nox --error-on-external-run -R -s format -- {args}"
+
+mypy = "nox --error-on-external-run -R -s mypy -- {args}"
+tests = "nox --error-on-external-run -R -s tests -- {args}"
+
+release = "nox --error-on-external-run -R -s release"
 
 [tool.ruff]
 line-length = 88