[MERGE] Alpha Seven Release Candidate for Version 2.0.9 (v2.0.9a7)

Author: reactive-firewall

.coderabbit.yaml

@@ -10,7 +10,7 @@ reviews:
 
     - Ensure the code follows best practices and coding standards.
     - Check for security vulnerabilities and potential issues.
-    - Ensure the code follows the **DRY, AHA, and SOLID** principles.
+    - Ensure the code follows the **DRY, Avoid-Hasty-Abstractions, and SOLID** design principles.
     - Our "Code Review Checklist Guide" is documented in
       [CEP-4](https://gist.github.com/reactive-firewall/cc041f10aad1d43a5ef15f50a6bbd5a5),
       be sure to always consider
@@ -35,7 +35,7 @@ reviews:
     - Verify that technical documentation includes a "References" section at
       the end of documentation, using the same format as actual RFCs, with
       both "Normative References" and "Informative References". Suggest improvements if unable.
-    - Ensure that that project documentation and comments follow
+    - Ensure that the project documentation and source-code comments follow
       [CEP-7](https://gist.github.com/reactive-firewall/123b8a45f1bdeb064079e0524a29ec20)
 
     # Test Code Review Instructions
@@ -44,7 +44,7 @@ reviews:
     - Verify that minimal acceptance tests (e.g., those run by the workflow CI-MATs) are passing and
       error free, pointing out any failure as below minimal acceptance (i.e. un-acceptable).
     - Ensure that the test coverage meets or exceeds the project's required threshold
-      (e.g., aiming for 100% coverage as per Issue #53).
+      (e.g., aiming for 100% coverage as per GitHub Issue #53).
     - For **test** code, *also* follow
       [CEP-9](https://gist.github.com/reactive-firewall/d840ee9990e65f302ce2a8d78ebe73f6)
 
@@ -57,6 +57,8 @@ reviews:
       not assume a dependency is optional, confirm if it is or is not optional.
     - For **Python** code, consider [PEP 290](https://peps.python.org/pep-0290/) whenever a python
       (e.g., has the extension '.py') file is changed.
+    - Our project's "AI Usage Policy" is documented in
+      [.github/AI_USAGE_POLICY.md](https://github.com/reactive-firewall-org/multicast/tree/master/.github/AI_USAGE_POLICY.md).
   request_changes_workflow: true
   high_level_summary: true
   high_level_summary_placeholder: '@coderabbitai summary'
@@ -77,17 +79,27 @@ reviews:
       instructions: >-
         Apply when the PR/MR contains changes to the file `Makefile` or makefile
         code snippets.
-    - label: Documentation
+    - label: documentation
       instructions: >-
         Apply whenever project documentation (namely markdown source-code) is
         updated by the PR/MR. Also apply when PR contains a commit with a commit
         message prefixed with "[DOCUMENTATION] "
+    - label: CI
+      instructions: >-
+        Apply whenever any project CI/CD components (namely GitHub Action source-code) are
+        updated by the PR/MR. Also apply when PR contains a commit with a commit
+        message prefixed with "[CI] "
     - label: Linter
       instructions: >-
         Apply when the purpose of the PR/MR is related to fixing the feedback
         from a linter. Also apply if suggested fixes are used and improve the
-        code's compliance with the PEP-8 standard.
-  path_filters: ['!*.xc*/**', '!node_modules/**', '!dist/**', '!build/**', '!.git/**', '!venv/**', '!__pycache__/**']
+        code's compliance with project conventions or adopted standards.
+    - label: Testing
+      instructions: >-
+        Apply when the purpose of the PR/MR is related to fixing/improving any
+        testing components or test-code. Also apply if suggested fixes are
+        used and improve the project's test-code.
+  path_filters: ['!*.xc*/**', '!node_modules/**', '!dist/**', '!package.json', '!package-lock.json', '!yarn.lock', '!build/**', '!.git/**', '!venv/**', '!__pycache__/**']
   path_instructions:
     - path: README.md
       instructions: >-
@@ -120,7 +132,7 @@ reviews:
            the guidelines set by
            [CEP-7](https://gist.github.com/reactive-firewall/123b8a45f1bdeb064079e0524a29ec20).
         6. Verify Flake8's configuration file is located at ".flake8.ini". Flake8 is run
-           automaticly by the `flake8-cq` GHA used by the `.github/workflows/flake8.yml` workflow.
+           automatically by the `flake8-cq` GHA used by the `.github/workflows/flake8.yml` workflow.
         7. Verify alignment of any new changes, with the code style advocated in
            [CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161),
            pointing out any introduced deviations.
@@ -167,8 +179,8 @@ reviews:
         4. Consider these 'requirements.txt' files the records of truth regarding project
            dependencies.
         5. Consider the 'requirements.txt' file in the base of the git repository
-           (e.g., './requirements.txt') the required python dependencies regarding Multicast project
-           dependencies.
+           (e.g., './requirements.txt') the required python dependencies regarding Multicast
+           project dependencies.
     - path: tests/requirements.txt
       instructions: >-
         1. The multicast project's own dependencies are recorded in './requirements.txt'

.github/actions/checkout-and-rebuild/action.yml

@@ -40,19 +40,22 @@ inputs:
     required: true
 outputs:
   branch-name:
-    description: "The name of the branch that was checked-out"
+    description: "The name of the branch that was checked-out."
     value: ${{ steps.output_branch_name.outputs.branch-name || '' }}
   sha:
-    description: "The SHA of the commit checked-out"
+    description: "The SHA of the commit checked-out."
     value: ${{ steps.output_sha.outputs.sha || 'HEAD' }}
   python-version:
     description: "The python version that was used in the run."
     value: ${{ steps.cp313.outputs.python-version || '' }}
+  python-path:
+    description: "Absolute path to the Python executable installed for the run."
+    value: ${{ steps.cp313.outputs.python-path }}
   artifact-name:
     description: "The downloaded artifact-name"
     value: "multicast-build-${{ steps.output_sha.outputs.sha }}.zip"
   artifact-files:
-    description: "The downloaded artifact-files"
+    description: "The downloaded artifact-files."
     value: ${{ steps.output_artifact_files.outputs.files }}
 
 runs:
@@ -92,6 +95,16 @@ runs:
     - run: python -m pip install --upgrade pip
       shell: bash
       if: ${{ !cancelled() && runner.os == 'Windows' }}
+    - id: output_python_env
+      name: "Python Environment"
+      shell: bash
+      run: |
+        printf "%s\n" "::group::python-env"
+        printf "python-path=%s\n" "${{ steps.cp313.outputs.python-path }}" >> "$GITHUB_OUTPUT"
+        printf "PYTHON=%s\n" "${{ steps.cp313.outputs.python-path }}" >> "$GITHUB_ENV"
+        printf "python-version=%s\n" "${{ steps.cp313.outputs.python-version }}" >> "$GITHUB_OUTPUT"
+        printf "PYTHON_VERSION=%s\n" "${{ steps.cp313.outputs.python-version }}" >> "$GITHUB_ENV"
+        printf "%s\n" "::endgroup::"
     - name: "Install Test Dependencies"
       shell: bash
       run: |
@@ -102,7 +115,8 @@ runs:
       if: ${{ success() }}
       shell: bash
       run: printf "artifact-name=%s\n" multicast-build-${{ steps.output_sha.outputs.sha }} >> "$GITHUB_OUTPUT"
-    - name: "Fetch Build Files"
+    - id: fetch_artifact_files
+      name: "Fetch Build Files"
       if: ${{ (github.repository == 'reactive-firewall-org/multicast') && success() }}
       uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
       with:

.github/actions/fetch-test-reporter/action.yml

@@ -14,16 +14,20 @@ inputs:
       rate limiting.
     default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
     required: true
-  codeclimate-token:
-    description: |
-      The token used to authenticate when performing codeclimate API operations.
+  codeclimate-token:  # deprecated in v2.0.9a7
+    description: "UNUSED."
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
-  cc-test-reporter-id:
-    description: |
-      The id used to report tests when performing codeclimate API operations.
+    required: false
+  cc-test-reporter-id:  # deprecated in v2.0.9a7
+    description: "UNUSED."
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
+    required: false
   deepsource-dsn:
     description: |
       The deepsource DSN when performing deepsource API operations.
@@ -70,8 +74,6 @@ runs:
       if: ${{ !cancelled() && (steps.output_can_fetch.outputs.can_fetch == 'true') && (runner.os != 'Windows') && (github.repository == 'reactive-firewall-org/multicast') }}
       shell: bash
       env:
-        CODECLIMATE_REPO_TOKEN: ${{ github.server_url == 'https://github.com' && inputs.codeclimate-token || '' }}
-        CC_TEST_REPORTER_ID: ${{ github.server_url == 'https://github.com' && inputs.cc-test-reporter-id || '' }}
         COVERALLS_REPO_TOKEN: ${{ github.server_url == 'https://github.com' && inputs.coveralls-token || '' }}
         DEEPSOURCE_DSN: ${{ github.server_url == 'https://github.com' && inputs.deepsource-dsn || '' }}
       run: |

.github/actions/purge-test-reporter/action.yml

@@ -14,16 +14,20 @@ inputs:
       rate limiting.
     default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
     required: true
-  codeclimate-token:
-    description: |
-      The token used to authenticate when performing codeclimate API operations.
+  codeclimate-token:  # deprecated in v2.0.9a7
+    description: "UNUSED"
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
-  cc-test-reporter-id:
-    description: |
-      The id used to report tests when performing codeclimate API operations.
+    required: false
+  cc-test-reporter-id:  # deprecated in v2.0.9a7
+    description: "UNUSED"
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
+    required: false
   deepsource-dsn:
     description: |
       The deepsource DSN when performing deepsource API operations.
@@ -70,13 +74,11 @@ runs:
       if: ${{ !cancelled() && (steps.output_can_purge.outputs.can_purge == 'true') && (runner.os != 'Windows') && (github.repository == 'reactive-firewall-org/multicast') }}
       shell: bash
       env:
-        CODECLIMATE_REPO_TOKEN: ${{ github.server_url == 'https://github.com' && inputs.codeclimate-token || '' }}
-        CC_TEST_REPORTER_ID: ${{ github.server_url == 'https://github.com' && inputs.cc-test-reporter-id || '' }}
         COVERALLS_REPO_TOKEN: ${{ github.server_url == 'https://github.com' && inputs.coveralls-token || '' }}
         DEEPSOURCE_DSN: ${{ github.server_url == 'https://github.com' && inputs.deepsource-dsn || '' }}
       run: |
         ${{ github.workspace }}/.github/tools/fetch-test-reporter/purge-test-reporter || exit $?
-    - name: "Evaluate Fetch Task"
+    - name: "Evaluate Purge Task"
       id: purge_outcome
       if: ${{ !cancelled() }}
       shell: bash

.github/actions/test-reporter-upload/action.yml

@@ -40,16 +40,20 @@ inputs:
       - Linux
       - Windows
     required: true
-  codeclimate-token:
-    description: |
-      The token used to authenticate when performing codeclimate API operations.
+  codeclimate-token:  # deprecated in v2.0.9a7
+    description: "UNUSED"
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
-  cc-test-reporter-id:
-    description: |
-      The id used to report tests when performing codeclimate API operations.
+    required: false
+  cc-test-reporter-id:  # deprecated in v2.0.9a7
+    description: "UNUSED"
+    deprecationMessage: |
+      This input is deprecated as of v2.0.9a7 and will be removed in a future release.
+      CodeClimate support has been discontinued.
     default: ''
-    required: true
+    required: false
   deepsource-dsn:
     description: |
       The deepsource DSN when performing deepsource API operations.
@@ -78,9 +82,9 @@ outputs:
   coverage_upload_codecov_outcome:
     description: "The outcome of the CodeCov coverage test reporter action."
     value: ${{ steps.coverage-codecov-upload.outcome || 'cancelled' }}
-  coverage_upload_codeclimate_outcome:
-    description: "The outcome of the CodeClimate coverage test reporter action."
-    value: ${{ steps.coverage-codeclimate-upload.outcome || 'cancelled' }}
+  coverage_upload_codeclimate_outcome:  # deprecated in v2.0.9a7
+    description: "The outcome of the CodeClimate coverage test reporter action. ALWAYS skipped."
+    value: 'skipped'
   coverage_upload_deepsource_outcome:
     description: "The outcome of the DeepSource coverage test reporter action."
     value: ${{ steps.coverage-deepsource-upload.outcome || 'cancelled' }}
@@ -140,6 +144,13 @@ runs:
           printf "::debug::%s\n" "Identified ${OS}"
         fi
         printf "%s\n" "OS=${OS}" >> "$GITHUB_ENV"
+    - id: output_branch_name
+      if: ${{ !cancelled() }}
+      shell: bash
+      run: |
+        printf "branch-name=%s\n" $(git name-rev --name-only HEAD 2>/dev/null | cut -d~ -f1-1) >> "$GITHUB_OUTPUT"
+        printf "::debug::%s %s\n" "Will report coverage as branch " $(git name-rev --name-only HEAD | cut -d~ -f1-1)
+        printf "BUILD_BRANCH=%s\n" $(git name-rev --name-only HEAD 2>/dev/null | cut -d~ -f1-1) >> "$GITHUB_ENV"
     - name: "Prepare Artifact Name"
       id: output_artifact_name
       if: ${{ !cancelled() }}
@@ -161,8 +172,9 @@ runs:
           if [[ -x ${{ github.workspace }}/cc-test-reporter ]] ; then
             printf "can_upload_to_codeclimate=true\n" >> "$GITHUB_OUTPUT"
             printf "::debug::%s\n" "Found ${{ github.workspace }}/cc-test-reporter"
+            printf "::warning title='Unexpected tool':: %s\n" "Can't use cc-test-reporter tool."
           else
-            printf "::warning title='Missing tool':: %s\n" "Can't find cc-test-reporter tool."
+            printf "::debug:: %s\n" "Can't find cc-test-reporter tool. This is normal."
             printf "can_upload_to_codeclimate=false\n" >> "$GITHUB_OUTPUT"
           fi
           LOCALBIN="${{ github.workspace }}/bin"
@@ -249,7 +261,6 @@ runs:
       run: |
         if [[ "${OS}" != "unknown" ]] ; then
           if [[ "${{ steps.output_upload_tools.outputs.can_upload_to_codecov }}" == "true" ]] || \
-             [[ "${{ steps.output_upload_tools.outputs.can_upload_to_codeclimate }}" == "true" ]] || \
              [[ "${{ steps.output_upload_tools.outputs.can_upload_to_coveralls }}" == "true" ]] || \
              [[ "${{ steps.output_upload_tools.outputs.can_upload_to_deepsource }}" == "true" ]] ; then
             THE_RESULT="success"
@@ -289,6 +300,9 @@ runs:
         token: ${{ inputs.codecov-token }}
         job_code: ${{ inputs.job_code || '' }}
         override_commit: ${{ steps.output_sha.outputs.sha }}
+        override_branch: ${{ steps.output_branch_name.outputs.branch-name }}
+        report_type: 'coverage'
+        slug: 'reactive-firewall-org/multicast'
         files: ./coverage.xml,./test-reports/coverage.xml
         directory: ${{ github.workspace }}
         flags: multicast
@@ -306,19 +320,6 @@ runs:
         compression-level: 9
         retention-days: 2
         overwrite: true
-    - name: Upload ${{ steps.output_os.outputs.os }} Python ${{ steps.output_python.outputs.python-version }} coverage to code-climate
-      if: ${{ !cancelled() && (steps.output_can_upload.outputs.can_upload == 'true') && (steps.output_upload_tools.outputs.can_upload_to_codeclimate == 'true') && (steps.output_os.outputs.os != 'Windows') && (github.repository == 'reactive-firewall-org/multicast') }}
-      id: coverage-codeclimate-upload
-      shell: bash
-      env:
-        CODECLIMATE_REPO_TOKEN: ${{ github.server_url == 'https://github.com' && inputs.codeclimate-token || '' }}
-        CC_TEST_REPORTER_ID: ${{ github.server_url == 'https://github.com' && inputs.cc-test-reporter-id || '' }}
-      run: |
-        if [[ "${{ inputs.tests-outcome }}" == "success" ]] ; then
-          ./cc-test-reporter after-build --exit-code 0 || exit 1 ;
-        else
-          ./cc-test-reporter after-build --exit-code 1 || exit 1 ;
-        fi
     - name: Upload ${{ steps.output_os.outputs.os }} Python ${{ steps.output_python.outputs.python-version }} coverage to deepsource
       if: ${{ !cancelled() && (steps.output_can_upload.outputs.can_upload == 'true') && (steps.output_upload_tools.outputs.can_upload_to_deepsource == 'true') && (steps.output_os.outputs.os != 'Windows') && (github.repository == 'reactive-firewall-org/multicast') }}
       id: coverage-deepsource-upload