[DEV] Code Coverage CI fix & Docs Testing

Release Cookiecutter Python Package v1.5.2

Author: boromir674

.github/workflows/test.yaml

@@ -23,12 +23,14 @@ jobs:
       matrix:
         platform: [ubuntu-latest, macos-latest]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -45,25 +47,49 @@ jobs:
     - name: Specify current package version to assist build tool
       run: |
         PARSER="src/cookiecutter_python/{{ cookiecutter.project_slug }}/scripts/parse_version.py"
-        A=$(python "${PARSER}")
-        echo $A
-        echo "PKG_VERSION=$A" >> $GITHUB_ENV
+        PARSED_VERSION=$(python "${PARSER}")
+        echo $PARSED_VERSION
+        echo "PKG_VERSION=$PARSED_VERSION" >> $GITHUB_ENV
 
     - name: Run Test Suite
-      run: tox -vv -s false -- --run-network_bound
+      run: tox --sitepackages -vv -s false -- -n auto --run-network_bound
       env:
         PLATFORM: ${{ matrix.platform }}
 
     - name: Check for compliance with Python Best Practices
       run: |
         DIST_DIR=dist
         echo "DIST_DIR=dist" >> $GITHUB_ENV
-
-        mkdir "$DIST_DIR"
+        ls -l ./
+        mkdir ${DIST_DIR}
         mv ".tox/${DIST_DIR}/cookiecutter_python-${PKG_VERSION}.tar.gz" "${DIST_DIR}"
         mv ".tox/${DIST_DIR}/cookiecutter_python-${PKG_VERSION}-py3-none-any.whl" "${DIST_DIR}"
         tox -e check -vv -s false
 
+    - name: Aggregate Test Coverage Data
+      run: tox -e coverage --sitepackages -vv -s false
+
+    - run: pip install coverage[toml]>=5.1
+
+    - name: Send Coverage Data to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        directory: ./.tox
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        files: ./.tox/coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        verbose: true
+
+    - name: Install documentation test dependencies
+      if: ${{ matrix.platform == 'macos-latest' && matrix.python-version != '3.6' }}
+      run: brew install enchant
+
+    - name: Run Documentation Tests
+      if: ${{ matrix.platform == 'ubuntu-latest' || matrix.python-version  != '3.6' }}
+      run: tox -e docs --sitepackages -vv -s false
+
     - name: Upload Source & Wheel distributions as Artefacts
       uses: actions/upload-artifact@v2
       with:
@@ -72,33 +98,14 @@ jobs:
         path: ${{ env.DIST_DIR }}
         if-no-files-found: error
 
-    - name: Aggregate Test Coverage Data
-      run: |
-        python -m pip install coverage
-        tox -e coverage --sitepackages -vv -s false
-
     - name: Upload Coverage Data as Artefacts
       uses: actions/upload-artifact@v2
       with:
         name: coverage-xml-data
         path: ./.tox/coverage.xml
         if-no-files-found: error
 
-  host_coverage_results:
-    needs: test_suite
-    runs-on: ubuntu-latest
-    steps:
-    - name: Download Coverage Data
-      uses: actions/download-artifact@v2
-      with:
-        name: coverage-xml-data
-    - name: Send Coverage Data to Codecov
-      uses: codecov/codecov-action@v2
-      with:
-        directory: .
-        env_vars: OS,PYTHON
-        fail_ci_if_error: true
-        files: coverage.xml
-        flags: unittests
-        name: codecov-umbrella
-        verbose: true
+    # - name: Download Coverage Data
+    #   uses: actions/download-artifact@v2
+    #   with:
+    #     name: coverage-xml-data

CHANGELOG.rst

@@ -2,6 +2,23 @@
 Changelog
 =========
 
+1.5.2 (2022-06-22)
+==================
+
+Development Update fixing the communication between the CI server and the Test
+Coverage Hosting Service. It also enable CI tests for the Documentation
+side of the project.
+
+Changes
+^^^^^^^
+
+ci
+""
+- install pyenchant on macos using homebrew
+- test documentation tests and building command
+- upload code coverage data to codecov.io from within the 'test_suite' job
+
+
 1.5.1 (2022-06-20)
 ==================
 

README.rst

@@ -196,9 +196,9 @@ For more complex use cases, you can modify the Template and also leverage all of
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.5.1/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.5.2/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.1..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.2..master
 
 .. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
     :alt: GitHub commits since latest release (by SemVer)

pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "poetry.core.masonry.api"
 ## Also renders on pypi as 'subtitle'
 [tool.poetry]
 name = "cookiecutter_python"
-version = "1.5.1"
+version = "1.5.2"
 description = "Yet another modern Python Package (pypi) with emphasis in CI/CD and automation."
 authors = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
 maintainers = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
@@ -130,7 +130,6 @@ test = [
     "pytest-explicit",
     "pytest-xdist",
     "pytest-object-getter",
-    "gitpython",
 ]
 docs = [
     "sphinx",

src/cookiecutter_python/__init__.py

@@ -1 +1 @@
-__version__ = '1.5.1'
+__version__ = '1.5.2'

src/cookiecutter_python/exceptions.py

@@ -1,4 +1,3 @@
-
 from cookiecutter.exceptions import (
     CookiecutterException,
     UndefinedVariableInTemplate,
@@ -9,8 +8,9 @@
 
 cookiecutter_exceptions = load(CookiecutterException, 'cookiecutter')
 
+
 exceptions = {
-    'critical': cookiecutter_exceptions + [ContextVariableDoesNotExist],
+    'critical': cookiecutter_exceptions + [ContextVariableDoesNotExist],  # type: ignore
     'non-critical': (
         CheckPypiError,
     )

src/cookiecutter_python/utils.py

@@ -1,6 +1,6 @@
 from os import path
 import sys
-from typing import Optional, Type, TypeVar
+from typing import List, Optional, Type, TypeVar
 from inspect import isclass
 from pkgutil import iter_modules
 from importlib import import_module
@@ -9,7 +9,7 @@
 T = TypeVar('T')
 
 
-def load(interface: Type[T], dire: Optional[str] = None) -> None:
+def load(interface: Type[T], module: Optional[str] = None) -> List[Type[T]]:
     """Dynamically import all class objects that implement the given interface.
 
     The classes (class objects) are discovered and imported in the namespace, by
@@ -27,32 +27,30 @@ def load(interface: Type[T], dire: Optional[str] = None) -> None:
     Args:
         interface (Type[T]): the type (ie class) that the imported classes
             should 'inherit' (subclass) from
-        dire (str): directory containing the modules to inspect. Defaults to the
-            same directory as the one where the module of the invoking code
-            resides.
+        module (str): module containing the modules to inspect. Defaults to the
+            same module (directory) as the one where the module of the invoking
+            code resides.
     """
     project_package_location = path.dirname(
         path.realpath(path.dirname(path.realpath(__file__))))
-
-    if not dire:  # set as dir the directory path where the invoking code is
+    if module is None:  # set path as the dir where the invoking code is
         namespace = sys._getframe(1).f_globals  # caller's globals
-        dire = path.dirname(path.realpath(namespace['__file__']))
-        # dot representation as in an import statement: ie software_release.utils
-        _module = str(dire).replace(str(project_package_location), '')[1:].replace('/', '.')
+        directory: str = path.dirname(path.realpath(namespace['__file__']))
+        _module = directory.replace(str(project_package_location), '')[1:].replace('/', '.')
     else:
-        _module = dire
+        directory = str(module).replace('/', '.')
+        _module = module
 
     objects = []
-    # iterate through the modules in the dire folder
-    for (_, module_name, _) in iter_modules([dire]):
-
-        module = import_module('{package}.{module}'.format(
+    # iterate through the modules inside the directory
+    for (_, module_name, _) in iter_modules([directory]):
+        module_object = import_module('{package}.{module}'.format(
             package=_module,
             module=module_name
         ))
 
-        for attribute_name in dir(module):
-            attribute = getattr(module, attribute_name)
+        for attribute_name in dir(module_object):
+            attribute = getattr(module_object, attribute_name)
 
             if isclass(attribute) and issubclass(attribute, interface):
                 # Add the class to this package's variables

src/stubs/cookiecutter/exceptions.pyi

@@ -1 +1,7 @@
+class CookiecutterException(Exception): ...
+
+
 class InvalidConfiguration(Exception): ...
+
+
+class UndefinedVariableInTemplate(Exception): ...