Add test & coverage CI job (#15)

* move dependencies from pyproject.toml to setup.cfg

* bump min python to 3.7

* fix oversight in lint.yml

* add pytest-cov to [test] deps

* add gh actions test and coverage workflow

* placeholder test

* lint

* fail-fast: false

* pytest and coverage configuration

* test on all three main OSs

* exclude MacOS+py3.10

* fix copy/paste oversight

* coverage tweak

Author: kandersolar

.github/workflows/lint.yml

@@ -2,7 +2,7 @@ name: lint
 
 on:
   push:
-    branches: [ $default-branch ]
+    branches: [ main ]
   pull_request:
 
 jobs:

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+
+    strategy:
+      fail-fast: false  # don't cancel other matrix jobs when one fails
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        exclude:
+          - python-version: "3.10"  # as of 2022-02-24, no wheels for py3.10 MacOS x86_64
+            os: macos-latest
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+    - name: Run tests
+      run: |
+        pytest

.gitignore

@@ -8,4 +8,6 @@ __pycache__/
 *.egg-info/
 
 # generated documentation
-docs/source/generated
+docs/source/generated
+
+.coverage

pyproject.toml

@@ -4,17 +4,3 @@ requires = [
     "wheel"
 ]
 build-backend = "setuptools.build_meta"
-
-[project]
-dependencies = [
-  'pvlib',
-  'numpy',
-  'pandas',
-  'matplotlib',
-  'shapely',
-]
-
-[project.optional-dependencies]
-tests = [
-  'pytest',
-]

setup.cfg

@@ -18,4 +18,20 @@ classifiers =
 
 [options]
 packages = twoaxistracking
-python_requires = >=3.6
+python_requires = >=3.7
+install_requires =
+    pvlib
+    numpy
+    pandas
+    matplotlib
+    shapely
+
+[options.extras_require]
+test = pytest;pytest-cov;
+
+[tool:pytest]
+addopts = --cov=twoaxistracking --cov-fail-under=100 --cov-report=term-missing
+
+[coverage:run]
+# don't count the test files themselves towards coverage
+omit = twoaxistracking/tests/*

twoaxistracking/__init__.py

@@ -4,7 +4,7 @@
 
 try:
     from shapely.geos import lgeos  # noqa: F401
-except OSError as err:
+except OSError as err:  # pragma: no cover
     msg = (
         "An error was encountered when importing the shapely package. "
         "This often happens when a binary dependency is missing because "

twoaxistracking/tests/test_placeholder.py

@@ -0,0 +1,6 @@
+import pytest  # noqa: F401
+import twoaxistracking  # noqa: F401
+
+
+def test_placeholder():
+    pass