Merge pull request #27 from pritam001/development

Add testing and coverage reporting

Author: pritam001

.bandit.yml

@@ -1,5 +1,4 @@
-[bandit]
-    targets: src,test,*.py
-    exclude: dummy.py
-    skips:
-    tests:
+targets: src,*.py
+exclude: dummy.py
+skips:
+tests:

.github/workflows/pythonpackage.yml

@@ -26,4 +26,8 @@ jobs:
       run: |
         pip install flake8
         make lint
+    - name: Test and CC
+      run: |
+        make test-n-cover
+        bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}
     

.gitignore

@@ -138,9 +138,7 @@ DS_Store
 
 # logs
 logs/
-
-# mypy
-.mypy_cache/
+**/logs/
 
 # terminalizer
 config.yml

Makefile

@@ -21,7 +21,7 @@ PYTHON = python3
 
 # .PHONY defines parts of the makefile that are not dependant on any specific file
 # This is most often used to store functions
-.PHONY = help setup format lint test debug clean
+.PHONY = all help setup format lint format-n-lint test-n-cover pre-commit
 
 # Defining an array variable
 FILES = input output
@@ -37,7 +37,9 @@ help:
 	@echo "$(BOLD_CYAN)make setup$(RESET_STYLES) : Setup pyflask-service"
 	@echo "$(BOLD_CYAN)make format$(RESET_STYLES) : Format and fix python code in pyflask-service"
 	@echo "$(BOLD_CYAN)make lint$(RESET_STYLES) : Lint pyflask-service"
-	@echo "$(BOLD_CYAN)make test$(RESET_STYLES) : Test pyflask-service"
+	@echo "$(BOLD_CYAN)make format-n-lint$(RESET_STYLES) : Format and lint python code in pyflask-service"
+	@echo "$(BOLD_CYAN)make test-n-cover$(RESET_STYLES) : Test and code coverage pyflask-service"
+	@echo "$(BOLD_CYAN)make pre-commit$(RESET_STYLES) : Run pre-commit checks for pyflask-service"
 	@echo "$(BOLD_CYAN)make debug$(RESET_STYLES) : Debug pyflask-service"
 	@echo "$(BOLD_CYAN)make clean$(RESET_STYLES) : Clean pyflask-service"
 	@echo "$(BOLD_CYAN)make dev-run$(RESET_STYLES) : Run pyflask-service in environment=development"
@@ -73,6 +75,9 @@ format: #: Format and fix python code with black, isort, autoflake
 	@echo "\n$(BOLD_CYAN)Flaking$(RESET_STYLES) ❄️"
 	flake8 --version
 	autoflake --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys --ignore-init-module-imports -i -r $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
+	@echo "\n$(BOLD_CYAN)Running pre-commit hooks$(RESET_STYLES) 🏁️️️"
+	pre-commit run --all-files
+	@echo "\n$(BOLD_CYAN)All checks passed$(RESET_STYLES) 🏳️️️️"
 	@echo "\n"
 
 
@@ -88,9 +93,25 @@ lint: #: Run static analysis with flake8, radon, mypy and bandit
 	mypy $(APP_DIR) $(HOME_DIR_PY_FILES)
 	@echo "\n$(BOLD_CYAN)Securing with bandit$(RESET_STYLES) 🕵️️"
 	bandit --version
-	bandit -l -i -r . --format=custom
-	@echo "\n$(BOLD_CYAN)Running pre-commit hooks$(RESET_STYLES) 🏁️️️"
-	pre-commit run --all-files
-	@echo "\n$(BOLD_CYAN)All checks passed$(RESET_STYLES) 🏳️️️️"
+	bandit -l -i -r . --format=custom  -c .bandit.yml -x ./$(TEST_DIR)
+	@echo "\n"
+
+
+format-n-lint: #: Format and lint
+	make format
+	make lint
 	@echo "\n"
 
+
+test-n-cover: #: Test with pytest, Code coverage with pytest-cov plugin
+	@echo "\n$(BOLD_CYAN)Testing with pytest$(RESET_STYLES) 📊️"
+	pytest --version
+	pytest
+	@echo "\n"
+
+
+pre-commit: #: Run pre-commit checks : format, lint, test, cover
+	make format-n-lint
+	make test-n-cover
+	@echo "\n$(BOLD_CYAN)Pre commit jobs completed$(RESET_STYLES) 👍"
+	@echo "\n"

README.md

@@ -6,7 +6,13 @@ An "optionally opinionated and structured" flask boilerplate microservice for ju
 ![Python](https://img.shields.io/badge/-Python-3776AB?style=flat-square&logo=Python&logoColor=white)
 ![Flask](https://img.shields.io/badge/-Flask-000000?style=flat-square&logo=flask&logoColor=white)
 ![License](https://img.shields.io/github/license/pritam001/pyflask-microservice-base?style=flat-square&label=License)
+
+
+Project status
+------------------------------------------------------------------------------
 ![WIP](https://img.shields.io/badge/%20%F0%9F%9A%A7%20-Dev%20in%20progress-important)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cc34f11b1a2b9bb8e216/maintainability)](https://codeclimate.com/github/pritam001/pyflask-microservice-base/maintainability)
+[![codecov](https://codecov.io/gh/pritam001/pyflask-microservice-base/branch/master/graph/badge.svg)](https://codecov.io/gh/pritam001/pyflask-microservice-base)
 
 
 Tools
@@ -20,6 +26,8 @@ Tools
 [![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg?style=flat)](https://github.com/PyCQA/bandit)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![API Specs](https://img.shields.io/badge/specs-flasgger-6D9A00?style=flat&logo=swagger&logoColor=white)](https://github.com/flasgger/flasgger)
+[![Tests: pytest](https://img.shields.io/badge/%20tests-pytest-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)
+[![Coverage: pytest-cov](https://img.shields.io/badge/%20coverage-pytest--cov-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)
 
 
 Usage Guide
@@ -44,9 +52,13 @@ Type `make help` for available commands
 
 <p align="center"><img src="documentation/assets/make-help.gif" /></p>
 
+Type `make pre-commit` before committing your changes to run formatters, linters, tests and code coverage collectors
+
+<p align="center"><img src="documentation/assets/make-pre-commit.gif" /></p>
+
 
 ### Linting Guide
-`make format` : Format and fix python code with black, isort, autoflake
+`make format` : Format and fix python code with black, isort, autoflake and pre-commit hooks
 
 <p align="center"><img src="documentation/assets/make-format.gif" /></p>
 
@@ -86,8 +98,9 @@ TODO
 -----------------------------------------------------------------------------
 - [x] Swagger support
 - [ ] Update linting documentation
-- [ ] Introduction of testing tools
+- [x] Introduction of testing tools
 - [ ] Testing tools documentation
+- [x] Code coverage
 - [ ] Version handling by tbump
-- [ ] Add CoC, Contribution guidelines, PR and issue 
+- [ ] Add CoC, Contribution guidelines, PR and issue templates