tests: add testing

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Update .github/workflows/ci.yml

Update ci.yml

chore: update to b3

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

.github/workflows/cd.yml

@@ -0,0 +1,47 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  release:
+    types:
+      - published
+
+jobs:
+  dist:
+    name: Distribution build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Build sdist and wheel
+        run: pipx run build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist
+
+      - name: Check products
+        run: pipx run twine check dist/*
+
+  publish:
+    name: Publish
+    needs: [dist]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sp-repo-review
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/ci.yml

@@ -17,14 +17,20 @@ jobs:
 
   cookie:
     needs: change-detection
-    if: fromJSON(needs.change-detection.outputs.run-tests)
+    if: fromJSON(needs.change-detection.outputs.run-cookie)
     uses: ./.github/workflows/reusable-cookie.yml
 
+  rr-tests:
+    needs: change-detection
+    if: fromJSON(needs.change-detection.outputs.run-rr)
+    uses: ./.github/workflows/reusable-rr-tests.yml
+
   pass:
     if: always()
     needs:
       - change-detection
       - cookie
+      - rr-tests
     runs-on: ubuntu-latest
 
     steps:
@@ -33,10 +39,16 @@ jobs:
         with:
           allowed-skips: >-
             ${{
-              fromJSON(needs.change-detection.outputs.run-tests)
+              fromJSON(needs.change-detection.outputs.run-cookie)
               && ''
               || '
               cookie,
               '
+            }} ${{
+              fromJSON(needs.change-detection.outputs.run-rr)
+              && ''
+              || '
+              rr-tests,
+              '
             }}
           jobs: ${{ toJSON(needs) }}

.github/workflows/reusable-change-detection.yml

@@ -2,23 +2,27 @@ name: Change detection
 on:
   workflow_call:
     outputs:
-      run-tests:
+      run-cookie:
         description: Whether or not run the cookiecutter tests
-        value: ${{ jobs.change-detection.outputs.run-tests || false }}
+        value: ${{ jobs.change-detection.outputs.run-cookie || false }}
+      run-rr:
+        description: Whether or not run the repo-review tests
+        value: ${{ jobs.change-detection.outputs.run-cookie || false }}
 
 jobs:
   change-detection:
     name: Identify source changes
     runs-on: ubuntu-latest
     timeout-minutes: 1
     outputs:
-      run-tests: ${{ steps.tests-changes.outputs.run-tests || false }}
+      run-cookie: ${{ steps.cookie-changes.outputs.run-cookie || false }}
+      run-rr: ${{ steps.rr-changes.outputs.run-rr || false }}
     steps:
       - uses: actions/checkout@v3
 
       - name: Get a list of the changed runtime-related files
         if: github.event_name == 'pull_request'
-        id: changed-testable-files
+        id: changed-cookie-files
         uses: Ana06/get-changed-files@v2.2.0
         with:
           filter: |
@@ -31,6 +35,25 @@ jobs:
       - name: Set a flag for running the tests
         if: >-
           github.event_name != 'pull_request' ||
-          steps.changed-testable-files.outputs.added_modified_renamed != ''
-        id: tests-changes
-        run: echo "run-tests=true" >> "${GITHUB_OUTPUT}"
+          steps.changed-cookie-files.outputs.added_modified_renamed != ''
+        id: cookie-changes
+        run: echo "run-cookie=true" >> "${GITHUB_OUTPUT}"
+
+      - name: Get a list of the changed runtime-related files
+        if: github.event_name == 'pull_request'
+        id: changed-rr-files
+        uses: Ana06/get-changed-files@v2.2.0
+        with:
+          filter: |
+            tests/**
+            .github/workflows/ci.yml
+            .github/workflows/reusable-rr-tests.yml
+            noxfile.py
+            src/**
+            pyproject.toml
+      - name: Set a flag for running the tests
+        if: >-
+          github.event_name != 'pull_request' ||
+          steps.changed-rr-files.outputs.added_modified_renamed != ''
+        id: rr-changes
+        run: echo "run-rr=true" >> "${GITHUB_OUTPUT}"

.github/workflows/reusable-rr-tests.yml

@@ -0,0 +1,32 @@
+name: RR
+
+on:
+  workflow_call:
+
+env:
+  FORCE_COLOR: 3
+
+jobs:
+  checks:
+    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12-dev"]
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: python -m pip install .[test,cli]
+
+      - name: Test package
+        run: python -m pytest -ra
+        env:
+          PYTHONUTF8: "1"

.pre-commit-config.yaml

@@ -50,15 +50,15 @@ repos:
     hooks:
       - id: mypy
         files: "(src|web|tests)"
-        args:
+        args: []
+        additional_dependencies:
           - click
           - markdown-it-py
           - pytest
           - repo-review
           - rich
           - tomli
           - types-PyYAML
-        additional_dependencies:
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v2.7.1"

pyproject.toml

@@ -29,13 +29,12 @@ classifiers = [
 dynamic = ["version"]
 dependencies = [
   "pyyaml",
-  "repo-review",
+  "repo-review>=0.7.0b3,<0.8",
 ]
 
 [project.optional-dependencies]
 cli = [
-  "click>=8",
-  "rich>=12.2",
+  "repo-review[cli]",
 ]
 test = [
   "pytest >=7",

src/sp_repo_review/checks/general.py

@@ -26,11 +26,11 @@ class PY002(General):
     "Has a README.(md|rst) file"
 
     @staticmethod
-    def check(package: Traversable) -> bool:
+    def check(root: Traversable) -> bool:
         "Projects must have a readme file"
         return (
-            package.joinpath("README.md").is_file()
-            or package.joinpath("README.rst").is_file()
+            root.joinpath("README.md").is_file()
+            or root.joinpath("README.rst").is_file()
         )
 
 
@@ -65,22 +65,21 @@ class PY006(General):
     "Has pre-commit config"
 
     @staticmethod
-    def check(package: Traversable) -> bool:
+    def check(root: Traversable) -> bool:
         "Projects must have a `.pre-commit-config.yaml` file"
-        return package.joinpath(".pre-commit-config.yaml").is_file()
+        return root.joinpath(".pre-commit-config.yaml").is_file()
 
 
 class PY007(General):
     "Supports an easy task runner (nox or tox)"
 
     @staticmethod
-    def check(package: Traversable) -> bool:
+    def check(root: Traversable) -> bool:
         """
         Projects must have a `noxfile.py` or `tox.ini` to encourage new contributors.
         """
         return (
-            package.joinpath("noxfile.py").is_file()
-            or package.joinpath("tox.ini").is_file()
+            root.joinpath("noxfile.py").is_file() or root.joinpath("tox.ini").is_file()
         )
 
 

src/sp_repo_review/checks/github.py

@@ -11,8 +11,8 @@
 from .._compat.importlib.resources.abc import Traversable
 
 
-def workflows(package: Traversable) -> dict[str, Any]:
-    workflows_base_path = package.joinpath(".github/workflows")
+def workflows(root: Traversable) -> dict[str, Any]:
+    workflows_base_path = root.joinpath(".github/workflows")
     workflows_dict: dict[str, Any] = {}
     if workflows_base_path.is_dir():
         for workflow_path in workflows_base_path.iterdir():
@@ -23,8 +23,8 @@ def workflows(package: Traversable) -> dict[str, Any]:
     return workflows_dict
 
 
-def dependabot(package: Traversable) -> dict[str, Any]:
-    dependabot_path = package.joinpath(".github/dependabot.yml")
+def dependabot(root: Traversable) -> dict[str, Any]:
+    dependabot_path = root.joinpath(".github/dependabot.yml")
     if dependabot_path.is_file():
         with dependabot_path.open("rb") as f:
             result: dict[str, Any] = yaml.safe_load(f)

src/sp_repo_review/checks/precommit.py

@@ -10,8 +10,8 @@
 from .._compat.importlib.resources.abc import Traversable
 
 
-def precommit(package: Traversable) -> dict[str, Any]:
-    precommit_path = package.joinpath(".pre-commit-config.yaml")
+def precommit(root: Traversable) -> dict[str, Any]:
+    precommit_path = root.joinpath(".pre-commit-config.yaml")
     if precommit_path.is_file():
         with precommit_path.open("rb") as f:
             return yaml.safe_load(f)  # type: ignore[no-any-return]
@@ -29,7 +29,7 @@ class PreCommit:
 
     @classmethod
     def check(cls: type[PreCommitMixin], precommit: dict[str, Any]) -> bool | None:
-        "Must have `{cls.repo}` repo in `.pre-commit-config.yaml`"
+        "Must have `{self.repo}` repo in `.pre-commit-config.yaml`"
         for repo in precommit.get("repos", {}):
             if "repo" in repo and repo["repo"].lower() == cls.repo:
                 return True

src/sp_repo_review/families.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import importlib.metadata
 import typing
 
 __all__ = ["Family", "get_familes"]