Merge branch 'main' into 6-add-oidc-auth-to-mail-api

.github/workflows/coverage.yml

@@ -0,0 +1,31 @@
+name: Coverage
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+
+jobs:
+  coverage:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
+    steps:
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
+          verbose: true

.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for pushing data to the
+      # python-coverage-comment-action branch, and for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry config virtualenvs.create false
+          poetry install --no-root
+      - name: Launch tests & generate report
+        run: poetry run pytest
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+          verbose: true
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+          # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+          name: python-coverage-comment-action
+          # If you use a different name, update COMMENT_FILENAME accordingly
+          path: python-coverage-comment-action.txt

pyproject.toml

@@ -23,6 +23,7 @@ regtech-api-commons = {git = "https://github.com/cfpb/regtech-api-commons.git"}
 pytest = "^8.0.0"
 pytest-mock = "^3.12.0"
 pytest-env = "^1.1.3"
+pytest-cov = "^4.1.0"
 
 
 [tool.poetry.group.linters.dependencies]
@@ -49,4 +50,21 @@ env = [
   "EMAIL_MAILER=mock",
   "[email protected]",
   "[email protected]"
-]
+]
+addopts = [
+    "--cov-report=term-missing",
+    "--cov-branch",
+    "--cov-report=xml",
+    "--cov-report=term",
+    "--cov=regtech_mail_api",
+    "-vv",
+    "--strict-markers",
+    "-rfE",
+]
+
+[tool.coverage.run]
+relative_files = true
+source = ["regtech_mail_api"]
+
+[tool.coverage.report]
+skip_empty = true