Feature/test refactoring

.github/workflows/python-package.yml

@@ -5,41 +5,48 @@ name: CI
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "master", "develop" ]
   pull_request:
-    branches: [ "master" ]
+    branches: [ "master", "develop" ]
 
 jobs:
-  build:
-
+  ci:
     strategy:
-      fail-fast: false
+      fail-fast: true
       matrix:
-        os: [ubuntu-latest,]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      uses: abatilo/actions-poetry@v2
+    - name: Setup a local virtual environment (if no poetry.toml file)
+      run: |
+        poetry config virtualenvs.create true --local
+        poetry config virtualenvs.in-project true --local
+    - uses: actions/cache@v3
+      name: Define a cache for the virtual environment based on the dependencies lock file
+      with:
+        path: ./.venv
+        key: venv-${{ hashFiles('poetry.lock') }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        python -m pip install -r requirements.txt
-        python -m pip install -e .
+        poetry install
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        poetry run flake8 src/graver tests --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        poetry run flake8 src/graver tests --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest and report coverage
       run: |
-        pytest --cov
+        poetry run pytest --cov=graver --cov-report term-missing
     - name: Publish to coveralls.io
       uses: coverallsapp/[email protected]
       with:
-        github-token: ${{ github.token }}
+        github-token: ${{ github.token }}

.gitignore

@@ -5,6 +5,9 @@ __pycache__/
 *.db
 *.csv
 *.egg-info
+data.json
+*.log
+graver.log.*
 .bandit
 .env
 .idea/
@@ -16,3 +19,4 @@ __pycache__/
 bandit.yaml
 *.txt
 !require*.txt
+dist/

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+    -   id: black
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+    -   id: flake8
+
+-   repo: local
+    hooks:
+      - id: commitizen
+        name: My commitizen check
+        entry: make
+        args: ['commitizen']
+        pass_filenames: false
+        language: system
+        stages: [commit-msg]

Makefile

@@ -1,51 +1,70 @@
-.PHONY: test test-unit test-integration run help fmt install-editable lint git-setup clean all
+.PHONY: test run build help fmt install install-editable lint git-setup clean realclean all commitizen cov coveralls
 
 # same as `export PYTHONPATH="$PWD:$PYTHONPATH"`
 # see also https://stackoverflow.com/a/18137056
 mkfile_path := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
-PYTHONPATH:=$(PYTHONPATH):$(mkfile_path)
+PYTHONPATH:=$(PYTHONPATH)
+PACKAGES:=src/graver
 
 VENV?=.venv
 PIP=$(VENV)/bin/pip
 PY=$(VENV)/bin/python
+POETRY=$(VENV)/bin/poetry
+VCR_CASSETTES=$(mkfile_path)tests/fixtures/vcr_cassettes/
 
 all: ; $(info $$PYTHONPATH is [${PYTHONPATH}])
 
 help: ## list targets with short description
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9._-]+:.*?## / {printf "\033[1m\033[36m%-38s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
 
 cov: ## run pytest coverage report
-	. $(VENV)/bin/activate && pytest --cov tests/ && coveralls
+	$(POETRY) run pytest --cov=graver --cov-report term-missing
 
-run: ## sample run
-	. $(VENV)/bin/activate && $(PY) graver/app.py -i input.txt
+coveralls: ## report coverage data to coveralls.io
+	$(POETRY) run coveralls
 
-test-unit: $(info $$PYTHONPATH is [${PYTHONPATH}])
-	. $(VENV)/bin/activate && pytest -rA -vvs --log-level INFO tests/unit
-
-test-integration: $(info $$PYTHONPATH is [${PYTHONPATH}])
-	. $(VENV)/bin/activate && pytest -rA -vvs --log-level INFO tests/integration
-
-test: test-unit test-integration
+test: ## run pytest
+	$(POETRY) run pytest -rA -vvs --log-level INFO
 
 lint: ## run flake8 to check the code
-	. $(VENV)/bin/activate && flake8 --max-line-length 88 src tests
+	$(POETRY) run flake8 $(PACKAGES) tests --count --select=E9,F63,F7,F82 --show-source --statistics
+	$(POETRY) run flake8 $(PACKAGES) tests --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics
+	$(POETRY) run deadcode $(PACKAGES)
 
-install-editable:
-	. $(VENV)/bin/activate && pip install -e .
+install: ## install project using `which poetry` from pyproject.toml
+	poetry install --with dev,test
 
 fmt: ## run black to format the code
-	. $(VENV)/bin/activate && isort src tests
-	. $(VENV)/bin/activate && black -q --line-length 88 src tests
+	$(POETRY) run isort $(PACKAGES) tests
+	$(POETRY) run black -q --line-length 88 $(PACKAGES) tests
 
-$(VENV)/init: ## init the virtual environment
-	python3 -m venv $(VENV)
+$(VENV)/init: ## init the virtual environment via standard pip
+	python3.12 -m venv $(VENV)
 	touch $@
+	. $(VENV)/bin/activate && pip install -U pip
+	. $(VENV)/bin/activate && pip install -r requirements.txt
 
 $(VENV)/requirements: requirements.txt $(VENV)/init ## install requirements
 	$(PIP) install -r $<
 	touch $@
 
+build: ## export requirements.txt (for standard pip install) and build dist
+	$(POETRY) export -f requirements.txt --output requirements.txt
+	$(POETRY) build
+
+commitizen:
+	@cz check --commit-msg-file .git/COMMIT_EDITMSG
+
 clean: ## clean up test outputs and other temporary files
 	rm -f *.csv
 	rm -f *.db
+	rm -f tests/*.log
+	rm -f tests/*.db
+	rm -f *.log*
+
+realclean: clean ## clean up everything produced by the install and build
+	rm -rf dist/
+	rm -rf $(VENV)
+
+vcrclean:
+	rm -f $(VCR_CASSETTES)/*

bin/export-json.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+sqlite3 $1 <<EOF
+.headers on
+.mode json
+.output data.json
+select * from graves;
+.quit
+EOF