test: add tests to codebase

.coveragerc

@@ -0,0 +1,10 @@
+[run]
+source = pyarr
+
+omit =
+    # omit tests
+    tests/*
+
+[report]
+exclude_lines =
+    if TYPE_CHECKING:

.devcontainer/recommended-Dockerfile

@@ -6,7 +6,7 @@ RUN apt upgrade  -y
 
 RUN apt install zsh python3-sphinx -y
 
-RUN pip install --user poetry
+RUN pip install --user poetry nox
 ENV PATH="${PATH}:/root/.local/bin"
 
 RUN wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O - | zsh || true

.flake8

@@ -1,7 +1,7 @@
 [flake8]
 max-line-length = 88
 max-complexity = 18
-exclude = build/*
+exclude = build/*, tests/*, .nox/*
 extend-ignore =
     # See https://github.com/PyCQA/pycodestyle/issues/373
     E203,

.github/workflows/pr.yml → .github/workflows/check-version.yml

@@ -1,4 +1,4 @@
-name: pr
+name: Check Version has been updated
 
 on:
   pull_request:
@@ -30,27 +30,3 @@ jobs:
         uses: dudo/[email protected]
         with:
           git_tag_prefix: v
-  code-quality:
-    name: 📊 Check code quality
-    runs-on: ubuntu-latest
-    steps:
-      - name: Getting your configuration from GitHub
-        uses: actions/checkout@v1
-      - name: Setup Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: 3.9
-      - name: Run image
-        uses: abatilo/[email protected]
-      - name: Install dependencies with Poetry
-        run: poetry install
-      - name: 📦 Check imports
-        run: poetry run isort --diff pyarr
-      - name: 🏴 Check Black formatting
-        run: poetry run black --check pyarr
-      - name: ❄️ Check flake8 formatting
-        run: poetry run flake8 pyarr
-      - name: Check static type
-        run: poetry run mypy pyarr
-      - name: Check docstrings
-        run: poetry run interrogate pyarr

.github/workflows/release.yml

@@ -10,27 +10,19 @@ jobs:
   code-quality:
     name: 📊 Check code quality
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
     steps:
-      - name: Getting your configuration from GitHub
-        uses: actions/checkout@v1
-      - name: Setup Python
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v3
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.9
-      - name: Run image
-        uses: abatilo/[email protected]
-      - name: Install dependencies with Poetry
-        run: poetry install
-      - name: 📦 Check imports
-        run: poetry run isort --diff pyarr
-      - name: 🏴 Check Black formatting
-        run: poetry run black --check pyarr
-      - name: ❄️ Check flake8 formatting
-        run: poetry run flake8 pyarr
-      - name: Check static type
-        run: poetry run mypy pyarr
-      - name: Check docstrings
-        run: poetry run interrogate pyarr
+          python-version: ${{ matrix.python-version }}
+      - name: 🧪 Check tests are passing
+        run: |
+          pip install poetry nox
+          nox -s test
 
   build-n-publish:
     name: Create release and publish 🐍 distribution 📦 to PyPI

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  source:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+  steps:
+    - uses: actions/checkout@v3
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: 🧪 Check tests are passing
+      run: |
+        pip install poetry nox
+        nox -s test

.gitignore

@@ -19,6 +19,9 @@ build
 *.egg-info
 .mypy_cache
 .pytest_cache
+.coverage
+coverage.xml
+_build
 
 .devcontainer/*
 !.devcontainer/recommended-devcontainer.json

noxfile.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import nox
+from nox.sessions import Session
+
+
+@nox.session(reuse_venv=True)
+def format(session: Session) -> None:
+    """Run automatic code formatters"""
+    session.run("poetry", "install", external=True)
+    session.run("black", ".")
+    session.run("isort", ".")
+    session.run("autoflake", "--in-place", ".")
+
+
+@nox.session(reuse_venv=True)
+def coverage(session: Session) -> None:
+    """Check tests cover all code"""
+    session.run("poetry", "install", external=True)
+    session.run("pytest", "tests", "--cov=pyarr", "--cov-report", "term-missing", "-vv")
+
+
+@nox.session(reuse_venv=True)
+def test(session: Session) -> None:
+    """Run the complete test suite"""
+    session.run("poetry", "install", external=True)
+    session.notify("test_types")
+    session.notify("test_style")
+    session.notify("test_suite")
+
+
+@nox.session(reuse_venv=True)
+def test_suite(session: Session) -> None:
+    """Run the Python-based test suite"""
+    session.run("poetry", "install", external=True)
+    session.run("pytest", "tests")
+
+
+@nox.session(reuse_venv=True)
+def test_types(session: Session) -> None:
+    """Check that typing is working as expected"""
+    session.run("poetry", "install", external=True)
+    session.run("mypy", "--show-error-codes", "pyarr")
+
+
+@nox.session(reuse_venv=True)
+def test_style(session: Session) -> None:
+    """Check that style guidelines are being followed"""
+    session.run("poetry", "install", external=True)
+    session.run("flake8", "pyarr", "tests")
+    session.run(
+        "black",
+        ".",
+        "--check",
+    )
+    session.run("isort", ".", "--check-only")
+    session.run("autoflake", ".")
+    session.run("interrogate", "pyarr")
+
+
+@nox.session(reuse_venv=True)
+def docs(session: Session) -> None:
+    """Create local copy of docs for testing"""
+    session.run("poetry", "install", external=True)
+    session.run("sphinx-build", "sphinx-docs", "build")