Merge branch 'feature/code-coverage' into develop

Author: acmacunlay

.github/workflows/pipeline.yaml

@@ -54,6 +54,10 @@ jobs:
         run: |
           mypy .
 
-      - name: Run unit tests
+      - name: Run common security issue checker
         run: |
-          pytest .
+          bandit -c pyproject.toml -r .
+      
+      - name: Run unit tests + code coverage
+        run: |
+          coverage run -m pytest .

.gitignore

@@ -1,5 +1,6 @@
 __pycache__
 *.egg-info
+.coverage
 .mypy_cache
 .pytest_cache
 .ruff_cache

README.md

@@ -3,7 +3,7 @@
 With pywaveshare, you can easily use the functionality of the [Waveshare GSM/GPRS/GNSS HAT for Raspberry Pi](https://www.waveshare.com/gsm-gprs-gnss-hat.htm). On this module a SIM868 Controller is doing the job to connect your Raspberry Pi with the world just by using a SIM card.
 
 ## Changelog
-[See this document.](https://github.com/acmacunlay/pywaveshare/blob/master/CHANGELOG.md)
+[See this document.](https://github.com/acmacunlay/pywaveshare/blob/main/CHANGELOG.md)
 
 ## Overview
 pywaveshare was written for Python 3. It provides the following features
@@ -180,4 +180,4 @@ if gsm.UrlResponse_available() > 0:
 
 
 ## License
-[See this document.](https://github.com/acmacunlay/pywaveshare/blob/master/LICENSE)
+[See this document.](https://github.com/acmacunlay/pywaveshare/blob/main/LICENSE)

pyproject.toml

@@ -38,13 +38,25 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-dev = ["build", "mypy", "pytest", "ruff", "setuptools", "twine"]
+dev = [
+    "bandit",
+    "build",
+    "coverage",
+    "mypy",
+    "pytest",
+    "ruff",
+    "setuptools",
+    "twine",
+]
 
 [project.urls]
 Homepage = "https://github.com/acmacunlay/pywaveshare"
 Repository = "https://github.com/acmacunlay/pywaveshare.git"
-# TODO: Changelog = ""
+Changelog = "https://github.com/acmacunlay/pywaveshare/blob/main/CHANGELOG.md"
 
 [[tool.mypy.overrides]]
 module = ["RPi", "RPi.GPIO", "serial"]
 ignore_missing_imports = true
+
+[tool.bandit]
+exclude_dirs = ["tests", ".venv"]

src/pywaveshare/boards/sim868/__init__.py

@@ -320,7 +320,7 @@ def __processData(self):
                     rawData = match[0][1].split(",")
                     self.__GPRSIPaddress = rawData[2].replace('"', "")
 
-                    if self.__GPRSIPaddress != "0.0.0.0":
+                    if self.__GPRSIPaddress != "0.0.0.0": # nosec
                         self.__GPRSready = True
                     else:
                         self.__GPRSready = False