100% test coverage with bad pylint (#15)

* 100% test coverage with bad pylint

* Run QC on any push or pull_request event

* Create about.py during QC action

* Correct bad pylint - QC should pass

* black does not rase error if fie is reforatted

* Fail QC if any files need formatting by black

* File reformatted by black - QC should pass

* Coverage fail_under set - QC should fail

* Coverage is 100% - QC should pass

Author: jitsuineccles

.github/workflows/python-package.yml

@@ -3,11 +3,7 @@
 
 name: Python Quality Control
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -30,7 +26,14 @@ jobs:
         python3 -m pip install -r requirements-dev.txt
     - name: Run integrity checks
       run: |
+        ./scripts/version.sh
         pycodestyle --format=pylint archivist unittests examples
         python3 -m pylint --rcfile=pylintrc archivist unittests examples
         black archivist examples unittests
+        modified=$(git status -s | wc -l)
+        if [ $modified -gt 0 ]
+        then
+            echo "there are $modified files that must be reformatted"
+            exit 1
+        fi
         ./scripts/unittests.sh

.gitignore

@@ -9,3 +9,4 @@ htmlcov/
 .pylint.d/
 .cache/
 .eggs/
+.task/

Taskfile.yml

@@ -2,13 +2,21 @@ version: '3'
 
 tasks:
 
+  about:
+    desc: Generate about.py
+    cmds:
+      - ./scripts/version.sh
+    status:
+      - test -s archivist/about.py
+
   builder:
     desc: Build a docker environment with the right dependencies and utilities
     cmds:
       - docker build --no-cache -f Dockerfile-builder -t jitsuin-archivist-python-builder .
 
   check:
     desc: Check the style, bug and quality of the code
+    deps: [about]
     cmds:
       - ./scripts/builder.sh pycodestyle --format=pylint archivist unittests examples
       - ./scripts/builder.sh python3 -m pylint --rcfile=pylintrc archivist unittests examples
@@ -19,25 +27,29 @@ tasks:
       - find -name '*,cover' -type f -delete
       - git clean -fdX
 
-  unittests:
-    desc: Run unittests
-    cmds:
-      - ./scripts/builder.sh ./scripts/unittests.sh
-  
+  format:
+    desc: Format code using black
+    deps: [about]
+    cmds: 
+      - ./scripts/builder.sh black archivist examples unittests
+
   publish:
     desc: pubish wheel package (will require username and password)
+    deps: [about]
     cmds:
       - ./scripts/builder.sh python3 -m twine upload --repository pypi dist/*
 
+  unittests:
+    desc: Run unittests
+    deps: [about]
+    cmds:
+      - ./scripts/builder.sh ./scripts/unittests.sh
+  
   wheel:
     desc: Builds python wheel package
+    deps: [about]
     cmds:
       - rm -rf *egg-info
       - rm -rf build 
       - rm -f dist/*
       - python3 setup.py bdist_wheel
-  
-  format:
-    desc: Format code using black
-    cmds: 
-      - ./scripts/builder.sh black archivist examples unittests

archivist/access_policies.py archivist/access_policies.py.disablearchivist/access_policies.py renamed to archivist/access_policies.py.disable

@@ -3,7 +3,6 @@
 """
 import logging
 
-# pragma: no cover
 
 # base logger from which all loggers are propagated
 LOGGER = logging.getLogger()
@@ -17,8 +16,8 @@ def set_logger(level):
     Setup logger
     Also used by unittests
     """
-    LOGGER.setLevel(level)
-    if not LOGGER.hasHandlers():
+    LOGGER.setLevel(level)  # pragma: no cover
+    if not LOGGER.hasHandlers():  # pragma: no cover
         handler = logging.StreamHandler()
         handler.setFormatter(
             logging.Formatter(

archivist/logger.py

@@ -6,6 +6,7 @@
 rm -f coverage.xml
 rm -rf htmlcov
 COVERAGE="coverage"
+${COVERAGE} --version
 ${COVERAGE} run --branch --source archivist -m unittest discover -v
 ${COVERAGE} annotate
 ${COVERAGE} html

archivist/timestamp.py

@@ -9,7 +9,7 @@ cat>archivist/about.py <<EOF
 
    WARNING: Do **not** edit directly
    This file is auto-generated by ./scripts/version.sh and is
-   not version controlled by git (ironically) as this would 
+   not version controlled by git (ironically) as this would
    make the generated version from the tag 'dirty'
 """
 __version__ = "$version"

scripts/unittests.sh

@@ -1,4 +1,7 @@
 [pycodestyle]
 ignore = E128, E203, E225, E265, E266, E402, E501, E713, E722, E741, W504, 
 statistics = True
-max-line-length = 88
+max-line-length = 88
+
+[coverage:report]
+fail_under = 100

scripts/version.sh

@@ -0,0 +1,27 @@
+"""
+Test archivist
+"""
+
+# pylint: disable=attribute-defined-outside-init
+# pylint: disable=missing-docstring
+# pylint: disable=too-few-public-methods
+
+from unittest import TestCase
+
+from archivist import about
+
+
+class TestAbout(TestCase):
+    """
+    Test about
+    """
+
+    def test_about(self):
+        """
+        Test about
+        """
+        self.assertGreater(
+            len(about.__version__),
+            0,
+            msg="about version should be populated",
+        )