Merge pull request #49 from staticdev/test-refactor

Testing workflow and session

Author: Thiago C. D'Ávila

.github/workflows/tests.yml

@@ -1,22 +1,33 @@
 name: Tests
 
-on: [push, pull_request]
+on:
+  - push
+  - pull_request
 
 jobs:
   tests:
-    name: Tests (${{ matrix.python-version }}, ${{ matrix.os }})
+    name: ${{ matrix.session }} ${{ matrix.python-version }} / ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         include:
-          - { python-version: 3.8, os: ubuntu-latest }
-          # - { python-version: 3.8, os: windows-latest }
-          - { python-version: 3.8, os: macos-latest }
-          - { python-version: 3.7, os: ubuntu-latest }
+          - { python-version: 3.8, os: ubuntu-latest, session: "pre-commit" }
+          - { python-version: 3.8, os: ubuntu-latest, session: "safety" }
+          - { python-version: 3.8, os: ubuntu-latest, session: "mypy-3.8" }
+          - { python-version: 3.7, os: ubuntu-latest, session: "mypy-3.7" }
+          - { python-version: 3.8, os: ubuntu-latest, session: "tests-3.8" }
+          - { python-version: 3.7, os: ubuntu-latest, session: "tests-3.7" }
+          # - { python-version: 3.8, os: windows-latest, session: "tests-3.8" }
+          - { python-version: 3.8, os: macos-latest, session: "tests-3.8" }
+          # - { python-version: 3.8, os: ubuntu-latest, session: "docs" }
+
+    env:
+      NOXSESSION: ${{ matrix.session }}
+
     steps:
       - name: Check out the repository
-        uses: actions/[email protected].0
+        uses: actions/[email protected].1
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
@@ -38,6 +49,46 @@ jobs:
           pip install --constraint=.github/workflows/constraints.txt nox
           nox --version
 
+      - name: Compute pre-commit cache key
+        if: matrix.session == 'pre-commit'
+        id: pre-commit-cache
+        shell: python
+        run: |
+          import hashlib
+          import sys
+
+          python = "py{}.{}".format(*sys.version_info[:2])
+          payload = sys.version.encode() + sys.executable.encode()
+          digest = hashlib.sha256(payload).hexdigest()
+          result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8])
+
+          print("::set-output name=result::{}".format(result))
+
+      - name: Restore pre-commit cache
+        uses: actions/[email protected]
+        if: matrix.session == 'pre-commit'
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            ${{ steps.pre-commit-cache.outputs.result }}-
+
       - name: Run Nox
         run: |
           nox --force-color
+
+      # - name: Upload documentation
+      #   if: matrix.session == 'docs'
+      #   uses: actions/upload-artifact@v2
+      #   with:
+      #     name: docs
+      #     path: docs/_build
+
+      - name: Create coverage report
+        if: always() && matrix.session == 'tests'
+        run: |
+          nox --force-color --session=coverage -- xml
+
+      - name: Upload coverage report
+        if: always() && matrix.session == 'tests'
+        uses: codecov/[email protected]

codecov.yml

@@ -0,0 +1,9 @@
+comment: false
+coverage:
+  status:
+    project:
+      default:
+        target: "0"
+    patch:
+      default:
+        target: "0"

noxfile.py

@@ -10,7 +10,7 @@
 
 package = "django_sorting_bootstrap"
 python_versions = ["3.8", "3.7"]
-nox.options.sessions = "pre-commit", "safety", "mypy"  # , "tests"
+nox.options.sessions = "pre-commit", "safety", "mypy", "tests"
 locations = "src", "tests", "noxfile.py"
 
 
@@ -138,9 +138,11 @@ def mypy(session: Session) -> None:
 def tests(session: Session) -> None:
     """Run the test suite."""
     install_package(session)
-    install(session, "coverage[toml]", "pytest")
-    session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
-    session.notify("coverage")
+    install(session, "coverage[toml]", "pytest", "pytest-django")
+    try:
+        session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
+    finally:
+        session.notify("coverage")
 
 
 @nox.session

poetry.lock

@@ -40,6 +40,17 @@ codecov = "^2.1.3"
 reorder-python-imports = "^2.3.1"
 pre-commit = "^2.4.0"
 coverage = {extras = ["toml"], version = "^5.1"}
+pytest-django = "^3.9.0"
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.run]
+branch = true
+source = ["django_sorting_bootstrap"]
+
+[tool.coverage.report]
+show_missing = true
 
 [build-system]
 requires = ["poetry>=0.12"]

pyproject.toml

@@ -0,0 +1,2 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = tests.testapp.settings

pytest.ini

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

tests/manage.py

@@ -0,0 +1,11 @@
+"""Views test module."""
+from django.test import TestCase
+
+import django_sorting_bootstrap.views
+
+
+class SimpleChangeListTests(TestCase):
+    def test_create(self):
+        django_sorting_bootstrap.views.SimpleChangeList(
+            "request", "model", "list_display"
+        )

tests/test_views.py

@@ -0,0 +1 @@
+"""Test app for the django-pagination-bootstrap package."""

tests/testapp/__init__.py

@@ -0,0 +1,42 @@
+"""Django test settings."""
+import os
+
+SECRET_KEY = "$%ffv#zpca%a#bdxtl&)&=5k20egnwcwjdg665r-lsr+s5zdw#"
+
+APP_NAME = "django_sorting_bootstrap"
+
+DEBUG = True
+
+DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}}
+
+USE_TZ = True
+
+SITE_ID = 1
+
+INSTALLED_APPS = (
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.sites",
+    APP_NAME,
+)
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [os.path.join(os.path.dirname(__file__), "templates")],
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.template.context_processors.i18n",
+                "django.template.context_processors.media",
+            ],
+            "loaders": [
+                "django.template.loaders.filesystem.Loader",
+                "django.template.loaders.app_directories.Loader",
+            ],
+        },
+    }
+]