chore: Ensure code has >= 90% coverage (#4)

* test: Fix pytest-cov collection warning

* chore: Enforce 90% in pre-push hook

* chore: Add linting to hooks and CI

* chore: Ensure hooks and CI meet 90% coverage

Author: TheLandolorien

.github/hooks/pre-commit

@@ -1,15 +1,24 @@
 #!/bin/sh
 
 formatting_results=$(poetry run black --check --line-length 100 . 2>&1 > /dev/null)
+if [[ "$?" == "0" ]]; then
+    echo "✅ Formatting"
+else
+    echo "❌ Formatting"
+    echo "$formatting_results"
+	exit 1
+fi
+
+linting_results=$(poetry run pylint src tests)
 if [[ "$?" == "0" ]]; then
     echo "✅ Linting"
 else
     echo "❌ Linting"
-    echo "$formatting_results"
+    echo "$linting_results"
 	exit 1
 fi
 
-unit_test_results=$(poetry run pytest --no-header --no-summary -qq tests/unit)
+unit_test_results=$(poetry run pytest --no-header --no-summary -qq tests/unit --cov-fail-under=90)
 if [[ "$?" == "0" ]]; then
 	echo "✅ Unit Tests"
 else

.github/hooks/pre-push

@@ -1,10 +1,10 @@
 #!/bin/sh
 
-integration_test_results=$(poetry run pytest --no-header --no-summary -qq tests/integration)
+test_results=$(poetry run pytest --no-header -qq tests --cov-fail-under=90)
 if [[ "$?" == "0" ]]; then
 	echo "✅ Integration Tests"
 else
 	echo "❌ Integration Tests"
-	echo "$integration_test_results"
+	echo "$test_results"
 	exit 1
 fi

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Scan and Test Source Code
+name: Scan, Lint and Test Source Code
 
 on:
   workflow_dispatch:
@@ -29,7 +29,7 @@ jobs:
         with:
           sarif_file: snyk.sarif
 
-  pytest-run:
+  code-check:
     runs-on: ubuntu-latest
 
     steps:
@@ -47,8 +47,11 @@ jobs:
       - name: Install Python Dependencies
         run: poetry install
 
-      - name: Run Unit Tests
-        run: poetry run pytest tests/unit
+      - name: Check Formatting
+        run: poetry run black --check --line-length 100 .
 
-      - name: Run Integration Tests
-        run: poetry run pytest tests/integration
+      - name: Lint Code
+        run: poetry run pylint src tests
+
+      - name: Run Unit and Integration Tests
+        run: poetry run pytest tests --cov-fail-under=90

README.md

@@ -8,6 +8,8 @@
 
 </div>
 
+[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
+
 ## 🎧 Quick Start
 
 Ensure [Python](https://www.python.org/downloads) and [Python Poetry](https://python-poetry.org/docs/#installation) are installed.
@@ -54,7 +56,7 @@ git config --local core.hooksPath .github/hooks/
 git config --local commit.template .github/.gitmessage
 ```
 
-These will ensure commit messages are consistent, code is correctly formatted, and tests before committing or pushing.
+These will ensure commit messages are consistent, code is correctly formatted and linted, and tests before committing or pushing.
 
 Style decisions are based on the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html).
 

poetry.lock

@@ -29,10 +29,18 @@ pytest-cov = "^4.1.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.9.1"
+pylint = "^2.17.5"
 
 [tool.black]
 line-length = 100
 
+[tool.pylint.main]
+score = "n"
+no-docstring-rgx = "^_|^test_"
+
+[tool.pylint."messages control"]
+disable = ["missing-module-docstring"]
+
 [tool.pytest.ini_options]
 minversion = "7.4.0"
 pythonpath = "src"

pyproject.toml

@@ -1,8 +1,3 @@
-"""Serves as the main entrypoint for the package-name CLI tool.
-
-Package description.
-"""
-
 import argparse