[NEW] Py Pkg Gen with better Code Coverage

boromir674 · web-flow · commit d5ad1cf38aa0 · 2024-02-09T16:37:06.000+01:00
Release Version '1.12.4' into 'master' Branch
diff --git a/.github/workflows/load-to-rt.yml b/.github/workflows/load-to-rt.yml
@@ -24,7 +24,6 @@ jobs:
   board_release_train:
     runs-on: ubuntu-latest
     env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       TRAIN: 'release-train'
       BOARDING: ${{ github.event.ref == 'refs/tags/auto-release' && 'boarding-auto' || 'boarding' }}
       MAIN_BRANCH: 'master'
@@ -110,6 +109,8 @@ jobs:
       - name: 'Create PR   ${{ env.BOARDING }}  -->  ${{ env.TRAIN }}'
         # --head is the branch where the changes were developed
         # --base is the branch you want to merge the changes into
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
         run: |
           gh pr create --head "${{ env.BOARDING }}" --base "${{ env.TRAIN }}" \
             --title "Boarding '${{ steps.user_branch.outputs.USER_BRANCH }}' on Release Train - Merging into ${{ env.TRAIN }} Branch" \
@@ -141,5 +142,6 @@ jobs:
       ############## Merge ##############
       - name: 'Merge PR   ${{ env.BOARDING }}  -->  ${{ env.TRAIN }}'
         run: gh pr merge "${{ env.BOARDING }}" --auto --delete-branch --squash
-
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
         # HEAD is now at ${{ env.TRAIN }}
diff --git a/.github/workflows/merge-rt-in-release.yml b/.github/workflows/merge-rt-in-release.yml
@@ -26,11 +26,7 @@ on:
 jobs:
   # RUN Job when 'boarding-auto --> 'release-train' PR is merged
   merge_rt_in_release:
-    # ALLOWED Head Branches
-    # if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'boarding-auto')
-    # if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
-    if: github.event_name == 'pull_request' && github.event.action == 'closed'
-    # && github.event.pull_request.head.ref == 'boarding-auto' && github.event.pull_request.merged == true
+    if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'boarding-auto')
     # github.event.pull_request.auto_merge_enabled
 
     runs-on: ubuntu-latest
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,6 +3,40 @@ Changelog
 =========
 
 
+1.12.4 (2024-02-09)
+===================
+
+**Improved Code Coverage.**
+
+
+Changes
+^^^^^^^
+
+fix
+"""
+- dynamic runtime loading of all CookiecutterException subclasses from cookiecutter
+
+test
+""""
+- unit-test *Exception Classifier* and cover all possible returned values
+
+documentation
+"""""""""""""
+- add docstrings
+
+ci
+""
+- use pat with Commit, PR, Workflow Trigger in merge-to-rt Workflow
+
+refactor
+""""""""
+- Exception Classifier more readable code and comment on *critical* / *not-critical* classification decisions
+
+release
+"""""""
+- bump version to 1.12.4
+
+
 1.12.3 (2024-02-08)
 ===================
 
diff --git a/README.rst b/README.rst
@@ -275,9 +275,9 @@ Free/Libre and Open Source Software (FLOSS)
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.12.3/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.12.4/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.12.3..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.12.4..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)
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,7 @@
 author = 'Konstantinos Lampridis'
 
 # The full version, including alpha/beta/rc tags
-release = '1.12.3'
+release = '1.12.4'
 
 # -- General configuration ---------------------------------------------------
 
diff --git a/pyproject.toml b/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.12.3"
+version = "1.12.4"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 authors = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
 maintainers = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
diff --git a/src/cookiecutter_python/__init__.py b/src/cookiecutter_python/__init__.py
@@ -1,3 +1,3 @@
-__version__ = '1.12.3'
+__version__ = '1.12.4'
 
 from . import _logging  # noqa
diff --git a/src/cookiecutter_python/backend/hosting_services/exceptions.py b/src/cookiecutter_python/backend/hosting_services/exceptions.py
@@ -2,4 +2,6 @@
 
 
 class ContextVariableDoesNotExist(Exception):
+    """Raised when a Context Variable does not exist, in a dict-like object."""
+
     pass
diff --git a/src/cookiecutter_python/backend/post_main.py b/src/cookiecutter_python/backend/post_main.py
@@ -14,4 +14,6 @@ def post_main(request):
 
 
 class CheckWebServerError(Exception):
+    """Raised on Connection Error, when Requesting a Web Server's Future."""
+
     pass
diff --git a/src/cookiecutter_python/exceptions.py b/src/cookiecutter_python/exceptions.py
@@ -18,10 +18,23 @@
 
 
 def error_2_str(error):
-    if isinstance(error, UndefinedVariableInTemplate):
+
+    recognized_non_critical = {UndefinedVariableInTemplate}
+    recognized_critical = set(exceptions['critical']).difference(recognized_non_critical)
+
+    ## Mark NON Critical for program execution ##
+    # Program should potentially be able to handle that exception and proceed
+    if isinstance(error, tuple(recognized_non_critical)):
+        # We 'mark as non-critical', when we find out-of-scope variables (when a
+        # template uses a variable which is not defined in the context),
+        # anticipating the injection of out-of-scope variables programmatically.
         return 'non-critical'
 
-    if isinstance(error,
-        tuple(set(exceptions['critical']).difference(set([UndefinedVariableInTemplate])))
-    ):
+    ## Mark CRITICAL for program execution ##
+    # Program's execution should potentially stop, as unable to handle exception 
+    if isinstance(error, tuple(recognized_critical)):
+        # We Classify as Critical, all our Generator's backend engine Exceptions
+        # which are cokiecutter exceptions, but we exclude
+        # UndefinedVariableInTemplate and we add our Generator's exceptions:
+        # - ContextVariableDoesNotExist
         return 'critical'
diff --git a/src/cookiecutter_python/utils.py b/src/cookiecutter_python/utils.py
@@ -40,6 +40,13 @@ def load(interface: Type[T], module: Optional[str] = None) -> List[Type[T]]:
         _module = relative_path.replace('\\', '/').replace('/', '.')
     else:
         directory = str(module).replace('/', '.')
+        # find the distro path as installed at runtime
+        module_object = import_module(directory)
+        # if top-level init is at '/site-packages/some_python_package/__init__.py'
+        # then distro_path is '/site-packages/some_python_package'
+        from pathlib import Path
+        distro_path: Path = Path(str(module_object.__file__)).parent
+        directory = str(distro_path) 
         _module = module
 
     objects = []
@@ -53,7 +60,7 @@ def load(interface: Type[T], module: Optional[str] = None) -> List[Type[T]]:
         for attribute_name in dir(module_object):
             attribute = getattr(module_object, attribute_name)
 
-            if isclass(attribute) and issubclass(attribute, interface):
+            if attribute != interface and isclass(attribute) and issubclass(attribute, interface):
                 # Add the class to this package's variables
                 globals()[attribute_name] = attribute
                 objects.append(attribute)
diff --git a/src/stubs/cookiecutter/exceptions.pyi b/src/stubs/cookiecutter/exceptions.pyi
@@ -5,3 +5,9 @@ class InvalidConfiguration(Exception): ...
 
 
 class UndefinedVariableInTemplate(Exception): ...
+
+
+class ContextDecodingException(Exception): ...
+
+
+class NonTemplatedInputDirException(Exception): ...
diff --git a/tests/test_error_classifier.py b/tests/test_error_classifier.py
@@ -0,0 +1,76 @@
+import typing as t
+
+import pytest
+
+
+@pytest.fixture
+def exception_classifier() -> t.Callable[[Exception], t.Optional[str]]:
+    from cookiecutter_python.exceptions import error_2_str
+
+    return error_2_str
+
+
+@pytest.mark.parametrize(
+    'unknown_exception',
+    [
+        TypeError,
+        ValueError,
+    ],
+)
+def test_unknown_exceptions_are_classified_as_None(
+    # GIVEN some Exceptions that are Unknown to the Classifier
+    unknown_exception: Exception,
+    # GIVEN an Exceptions Classifier
+    exception_classifier: t.Callable[[Exception], t.Optional[str]],
+):
+    # WHEN the Exceptions are classified
+    result = exception_classifier(unknown_exception)
+
+    # THEN the Exceptions are classified as None
+    assert result is None
+
+
+# this tests captures the logs to print them and help debugging
+def test_exceptions_that_hinder_generator_are_classified_as_critical(
+    # GIVEN an Exceptions Classifier
+    exception_classifier: t.Callable[[Exception], t.Optional[str]],
+):
+    # GIVEN some Exceptions that hinder the Generator
+    from cookiecutter.exceptions import (
+        ContextDecodingException,
+        NonTemplatedInputDirException,
+    )
+
+    critical_exceptions = [
+        NonTemplatedInputDirException(),
+        ContextDecodingException(),
+    ]
+    # SANITY
+    from cookiecutter_python.exceptions import cookiecutter_exceptions
+
+    assert len(cookiecutter_exceptions) > 0, "cookiecutter_exceptions is empty"
+
+    # WHEN the Exceptions are classified
+    result = [exception_classifier(exception) for exception in critical_exceptions]
+
+    # THEN the Exceptions are classified as Critical
+    assert all([x == 'critical' for x in result])
+
+
+def test_exceptions_not_hindering_generator_are_classified_as_non_critical(
+    # GIVEN an Exceptions Classifier
+    exception_classifier: t.Callable[[Exception], t.Optional[str]],
+):
+    # GIVEN some Exceptions that do not hinder the Generator
+    from cookiecutter.exceptions import UndefinedVariableInTemplate
+    from jinja2.exceptions import UndefinedError
+
+    non_critical_exceptions = [
+        UndefinedVariableInTemplate('', UndefinedError(), {}),
+    ]
+
+    # WHEN the Exceptions are classified
+    result = [exception_classifier(exception) for exception in non_critical_exceptions]
+
+    # THEN the Exceptions are classified as Non-Critical
+    assert all([x == 'non-critical' for x in result])

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-__version__ = '1.12.3'`
	`1`	`+__version__ = '1.12.4'`
`2`	`2`
`3`	`3`	`from . import _logging # noqa`