unit tests with mock i2c (#54)

* feat: adds mock i2c tests.

* fix: make non-file targets phony so they always run. Ignore line too long warnings. (120 chars is the norm in many projects and PEP8 allows a maximum of 79.) See https://stackoverflow.com/questions/17319422/how-do-i-set-the-maximum-line-length-in-pycharm#comment58112267_17319775 for discussion.

* fix: ignore line too long endings in github actions. (Ideally these should use the Makefile so they are consistent.)

* latest ubuntu (v22) doesn't have python < 3.8, so using v20 actions/setup-python#391

* add mocking for periphery.I2C

* chore: separate out the make targets, while preserving existing behavior.  Don't use the virtualenv if it doesn't exist.

* chore: use the makefile as the one point for running flake8, docstyle and tests. Removes duplication of flake8 flags.

* chore: use pytest class declarations, remove the new `unittest` import.

Author: m-mcgowan

.github/workflows/manual-run.yml

@@ -8,10 +8,10 @@ on: workflow_dispatch
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: [3.9]
+        python-version: [3.8, 3.9]
 
     steps:
     - name: Send building notification
@@ -34,10 +34,12 @@ jobs:
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 test/ notecard/ examples/ --count --ignore=E722,F401,F403,W503 --show-source --statistics
+        make flake8
+        # flake8 test/ notecard/ examples/ --count --ignore=E722,F401,F403,W503,E501 --show-source --statistics
     - name: Lint Docs with Pydocstyle
       run: |
-        pydocstyle notecard/ examples/
+        make docstyle
+        # pydocstyle notecard/ examples/
     - name: Send running tests notification
       run: |
         curl --request POST \
@@ -47,7 +49,7 @@ jobs:
         --data '{"req":"note.add","file":"build_results.qi","body":{"result":"running_tests"}}'
     - name: Test with pytest
       run: |
-        pytest
+        make test
     - name: Check if the job has succeeded
       if: ${{ success() }}
       run: |

.github/workflows/python-package.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8, 3.9]
@@ -38,10 +38,10 @@ jobs:
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 test/ notecard/ examples/ --count --ignore=E722,F401,F403,W503 --show-source --statistics
+        make flake8
     - name: Lint Docs with Pydocstyle
       run: |
-        pydocstyle notecard/ examples/
+        make docstyle
     - name: Send running tests notification
       run: |
         curl --request POST \

Makefile

@@ -1,21 +1,40 @@
+# define VENV_NAME to use a specific virtual environment. It defaults to `env`.
 VENV_NAME?=env
 VENV_ACTIVATE=. $(VENV_NAME)/bin/activate
-PYTHON=${VENV_NAME}/bin/python3
+PYTHON=python
+VENV =
 
-default: test
+# check if the VENV file exists
+ifneq ("$(wildcard $(PVENV_ACTIVATE))","")
+    VENV = venv
+    PYTHON = ${VENV_NAME}/bin/python3
+endif
+
+default: docstyle flake8 test
 
 venv: $(VENV_NAME)/bin/activate
 
-test: venv
-	${PYTHON} -m pydocstyle notecard/ examples/
-	${PYTHON} -m flake8 test/ notecard/ examples/ --count --ignore=E722,F401,F403,W503 --show-source --statistics
+test: $(VENV)
 	${PYTHON} -m pytest test --cov=notecard
 
-coverage: venv
+docstyle: $(VENV)
+	${PYTHON} -m pydocstyle notecard/ examples/
+
+flake8: $(VENV)
+    # E722 Do not use bare except, specify exception instead https://www.flake8rules.com/rules/E722.html
+    # F401 Module imported but unused   https://www.flake8rules.com/rules/F401.html
+    # F403 'from module import *' used; unable to detect undefined names  https://www.flake8rules.com/rules/F403.html
+    # W503 Line break occurred before a binary operator https://www.flake8rules.com/rules/W503.html
+    # E501 Line too long (>79 characters) https://www.flake8rules.com/rules/E501.html
+	${PYTHON} -m flake8 test/ notecard/ examples/ --count --ignore=E722,F401,F403,W503,E501 --show-source --statistics
+
+coverage: $(VENV)
 	${PYTHON} -m pytest test --doctest-modules --junitxml=junit/test-results.xml --cov=notecard --cov-report=xml --cov-report=html
 
-run_build:
+run_build: $(VENV)
 	${PYTHON} -m setup sdist bdist_wheel
 
-deploy:
+deploy: $(VENV)
 	${PYTHON} -m twine upload -r "pypi" --config-file .pypirc 'dist/*'
+
+.PHONY: venv test coverage run_build deploy