Merge pull request #82 from staticdev/tests-upgrade

Tests upgrade

Author: Thiago C. D'Ávila

.github/dependabot.yml

@@ -1,20 +1,20 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-    time: '09:00'
-  open-pull-requests-limit: 10
-- package-ecosystem: pip
-  directory: "/.github/workflows"
-  schedule:
-    interval: daily
-    time: '09:00'
-  open-pull-requests-limit: 10
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: daily
-    time: '09:00'
-  open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "09:00"
+    open-pull-requests-limit: 10
+  - package-ecosystem: pip
+    directory: "/.github/workflows"
+    schedule:
+      interval: daily
+      time: "09:00"
+    open-pull-requests-limit: 10
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "09:00"
+    open-pull-requests-limit: 10

.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" }
+          - { python-version: 3.7, os: ubuntu-latest, session: "mypy" }
+          - { python-version: 3.8, os: ubuntu-latest, session: "tests" }
+          - { python-version: 3.7, os: ubuntu-latest, session: "tests" }
+          # - { python-version: 3.8, os: windows-latest, session: "tests" }
+          - { python-version: 3.8, os: macos-latest, session: "tests" }
+          # - { python-version: 3.8, os: ubuntu-latest, session: "docs" }
+
+    env:
+      NOXSESSION: ${{ matrix.session }}
+
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.1.0
+        uses: actions/checkout@v2.1.1
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
@@ -38,10 +49,41 @@ 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/cache@v1.2.0
+        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: |

noxfile.py

@@ -1,5 +1,6 @@
 """Nox sessions."""
 import contextlib
+import shutil
 import tempfile
 from pathlib import Path
 from typing import cast
@@ -10,7 +11,7 @@
 
 
 package = "toml_validator"
-python_versions = ["3.8"]
+python_versions = ["3.7", "3.8"]
 nox.options.sessions = "pre-commit", "safety", "mypy", "tests"
 locations = "src", "tests", "noxfile.py"
 
@@ -139,8 +140,10 @@ def tests(session: Session) -> None:
     """Run the test suite."""
     install_package(session)
     install(session, "coverage[toml]", "pytest", "pytest_mock")
-    session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
-    session.notify("coverage")
+    try:
+        session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
+    finally:
+        session.notify("coverage")
 
 
 @nox.session
@@ -159,3 +162,33 @@ def typeguard(session: Session) -> None:
     install_package(session)
     install(session, "pytest", "typeguard", "pytest_mock")
     session.run("pytest", f"--typeguard-packages={package}", *session.posargs)
+
+
+@nox.session(python=python_versions)
+def xdoctest(session: Session) -> None:
+    """Run examples with xdoctest."""
+    args = session.posargs or ["all"]
+    install_package(session)
+    install(session, "xdoctest")
+    session.run("python", "-m", "xdoctest", package, *args)
+
+
+@nox.session(python="3.8")
+def docs(session: Session) -> None:
+    """Build the documentation."""
+    args = session.posargs or ["docs", "docs/_build"]
+
+    if session.interactive and not session.posargs:
+        args.insert(0, "--open-browser")
+
+    builddir = Path("docs", "_build")
+    if builddir.exists():
+        shutil.rmtree(builddir)
+
+    install_package(session)
+    install(session, "sphinx", "sphinx-autobuild")
+
+    if session.interactive:
+        session.run("sphinx-autobuild", *args)
+    else:
+        session.run("sphinx-build", *args)