[PATCH] Even more Improvements (- WIP PR #448 -)

Changes in file .coderabbit.yaml:
 * minor style changes

Changes in file .github/actions/purge-test-reporter/action.yml:
 * minor re-wording

Changes in file .github/dependabot.yml:
 * changes to better reflect dependencies

Changes in file .github/workflows/CI-BUILD.yml:
 * minor improvements

Changes in file .github/workflows/scorecard.yml:
 * minor changes

Changes in file Makefile:
 * improvement to coverage logic slightly

Changes in file README.md:
 * minor tweak to example

Changes in file multicast/hear.py:
 * minor style change

Changes in file tests/test_hear_cleanup.py:
 * re-re-re fix for misleading comments

Author: reactive-firewall

.coderabbit.yaml

@@ -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

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

@@ -78,7 +78,7 @@ runs:
         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/dependabot.yml

@@ -9,7 +9,7 @@ updates:
     directory: "/"  # Location of package manifests
     milestone: 1
     target-branch: "master"
-    versioning-strategy: increase-if-necessary
+    versioning-strategy: increase
     # Labels on pull requests for version updates only
     labels:
       - "Configs"
@@ -29,6 +29,11 @@ updates:
         dependency-type: "production"
       - dependency-name: "build"
         dependency-type: "production"
+    ignore:
+      - dependency-name: "*"
+        dependency-type: "development"
+      - dependency-name: "*"
+        dependency-type: "indirect"
     assignees:
       - "reactive-firewall"
     commit-message:
@@ -47,23 +52,32 @@ updates:
       - "Testing"
       - "Python Lang"
       - "CI"
-    rebase-strategy: "disabled"
     groups:
       production-dependencies:
         dependency-type: "production"
+        patterns:
+          - "pip"
+          - "setuptools"
+          - "wheel"
+          - "build"
       development-dependencies:
         dependency-type: "development"
         exclude-patterns:
+          - "pip"
           - "setuptools*"
+          - "wheel"
+          - "build"
     allow:
       - dependency-name: "setuptools"
         dependency-type: "production"
       - dependency-name: "pip"
-        dependency-type: "direct"
+        dependency-type: "production"
       - dependency-name: "wheel"
         dependency-type: "production"
       - dependency-name: "build"
         dependency-type: "production"
+      - dependency-name: "virtualenv"
+        dependency-type: "development"
       - dependency-name: "tox"
         dependency-type: "development"
       - dependency-name: "virtualenv"
@@ -73,15 +87,22 @@ updates:
       - dependency-name: "pep8"
         dependency-type: "development"
       - dependency-name: "pytest"
-        dependency-type: "direct"
+        dependency-type: "development"
+      - dependency-name: "pytest-doctestplus"
+        dependency-type: "development"
       - dependency-name: "pytest-cov"
         dependency-type: "development"
       - dependency-name: "pytest-enabler"
         dependency-type: "development"
       - dependency-name: "pytest-flake8"
         dependency-type: "development"
       - dependency-name: "coverage"
+        dependency-type: "development"
+    ignore:
+      - dependency-name: "*"
         dependency-type: "direct"
+      - dependency-name: "*"
+        dependency-type: "indirect"
     assignees:
       - "reactive-firewall"
     commit-message:
@@ -101,6 +122,7 @@ updates:
       - "Duplicate"
       - "GitHub"
       - "Testing"
+      - "CI"
     assignees:
       - "reactive-firewall"
     commit-message:
@@ -122,8 +144,15 @@ updates:
     groups:
       development-dependencies:
         dependency-type: "development"
+        patterns:
+          - "markdownlint*"
     allow:
-      - dependency-type: "development"
+      - dependency-name: "markdownlint"
+        dependency-type: "development"
+      - dependency-name: "markdownlint-cli"
+        dependency-type: "development"
+    ignore:
+      - dependency-name: "*"
     assignees:
       - "reactive-firewall"
     commit-message:

.github/workflows/CI-BUILD.yml

@@ -45,6 +45,7 @@ jobs:
       LANG: "en_US.UTF-8"
       BUILD_MATCH_PATTERN: "${{ vars.BUILD_MATCH_PATTERN }}"
     outputs:
+      build_environment: ${{ env.ENVIRONMENT }}
       build_status: ${{ steps.build.outcome }}
       artifact-id: ${{ steps.upload.outputs.artifact-id }}
       artifact-url: ${{ steps.upload.outputs.artifact-url }}
@@ -173,7 +174,7 @@ jobs:
             experimental: false
           - python-version: "${{ vars.PYTHON_EXPERIMENTAL }}"
             lang-var: "en_US.utf-8"
-            experimental: ${{ (needs.BUILD.environment == 'Experimenting') }}
+            experimental: ${{ (needs.BUILD.outputs.build_environment == 'Experimenting') }}
     outputs:
       bootstrap_status: ${{ steps.bootstrap.outcome }}
     env:
@@ -247,7 +248,7 @@ jobs:
       attestations: write
     needs: [BUILD]
     runs-on: ubuntu-latest
-    environment: ${{ needs.BUILD.envs.ENVIRONMENT }}
+    environment: ${{ needs.BUILD.outputs.build_environment }}
     if: ${{ !cancelled() && (github.repository == 'reactive-firewall-org/multicast') }}
     outputs:
       build-artifact-attestation-url: ${{ steps.multicast-build-attest.outputs.attestation-url }}
@@ -286,7 +287,7 @@ jobs:
       pull-requests: read
     needs: [BUILD, BOOTSTRAP, BUILD_ATTEST]
     runs-on: ubuntu-latest
-    environment: ${{ needs.BUILD.envs.ENVIRONMENT }}
+    environment: ${{ needs.BUILD.outputs.build_environment }}
     if: ${{ !cancelled() }}
     outputs:
       didBUILD: ${{ steps.check_status.outputs.build_success }}

.github/workflows/scorecard.yml

@@ -1,5 +1,5 @@
 # .github/workflows/scorecard.yml
-# Referance: https://github.com/ossf/scorecard/blob/main/.github/workflows/scorecard-analysis.yml
+# Reference: https://github.com/ossf/scorecard/blob/main/.github/workflows/scorecard-analysis.yml
 ---
 name: Scorecard analysis workflow
 on:  # yamllint disable-line rule:truthy

Makefile

@@ -261,13 +261,13 @@ test: just-test
 
 test-mats: test-mat
 	$(QUIET)$(DO_FAIL) ;
-	$(QUIET)$(COVERAGE) combine --keep ./coverage_* 2>$(ERROR_LOG_PATH) || : ;
-	$(QUIET)$(COVERAGE) combine --append 2>$(ERROR_LOG_PATH) || : ;
+	$(QUIET)$(COVERAGE) combine --data-file=coverage_mats ./.coverage.* 2>$(ERROR_LOG_PATH) || : ; \
+	$(QUIET)$(COVERAGE) combine --keep --append ./coverage_* 2>$(ERROR_LOG_PATH) || : ; \
 	$(QUIET)$(COVERAGE) report -m --include=multicast/* 2>$(ERROR_LOG_PATH) || : ;
-	$(COVERAGE) xml  -o test-reports/coverage.xml --include=multicast/* 2>$(ERROR_LOG_PATH) || : ;
+	$(QUIET)$(COVERAGE) xml  -o test-reports/coverage.xml --include=multicast/* 2>$(ERROR_LOG_PATH) || : ;
 	$(QUIET)$(ECHO) "$@: Done."
 
-test-tox: build
+test-tox: ./dist
 	$(QUIET)$(PYTHON) -m tox -v --stderr-color RESET -- ;
 	$(QUIET)$(ECHO) "$@: Done."
 
@@ -414,8 +414,13 @@ must_have_flake:
 	if test $$runner -le 0 ; then $(ECHO) "No Linter found for test." ; exit 126 ; fi
 
 must_have_pytest: init
-	$(QUIET)runner=`$(PYTHON) -m pip freeze --all | grep --count -oF pytest` ; \
-	if test $$runner -le 0 ; then $(ECHO) "No python framework (pytest) found for test." ; exit 126 ; fi
+	$(QUIET)if [ -n "$$TESTS_USE_PYTEST" ]; then \
+		runner=`$(PYTHON) -m pip freeze --all | grep --count -oF pytest` ; \
+		if test $$runner -le 0 ; then \
+			$(ECHO) "No python framework (pytest) found for test." ; \
+			exit 126 ; \
+		fi ; \
+	fi
 
 cleanup-dev-backups::
 	$(QUIET)$(RM) ./*/*~ 2>$(ERROR_LOG_PATH) || :

README.md

@@ -153,9 +153,8 @@ print('Received:', message)
 # setup console logging as example
 import logging
 multicast_logging_sink = logging.getLogger()
-handler = logging.StreamHandler()
-multicast_logging_sink.setLevel(logging.INFO)  # increase default logging from multicast module
 handler = logging.StreamHandler()  # example trivial log handler
+multicast_logging_sink.setLevel(logging.INFO)  # increase default logging from multicast module
 multicast_logging_sink.addHandler(handler)
 
 # import multicast

multicast/hear.py

@@ -654,7 +654,7 @@ def handle(self) -> None:
 		By default:
 			Processes the incoming data from the client, logs the messages,
 			and sends a response back. If the data contains the
-			keyword "STOP", it raises a `RuntimeError` to
+			keyword "STOP", it raises a `ShutdownCommandReceived` to
 			initiate server shutdown.
 			Silently ignores any UnicodeDecodeError when decoding data.
 			Returns early if data or socket is None.

tests/test_hear_cleanup.py

@@ -233,7 +233,7 @@ def test_should_not_invoke_kill_func_when_handle_error_not_called(self) -> None:
 			self.server = multicast.hear.McastServer(server_address, None, False)
 			self.server.shutdown = MagicMock()  # Mock the shutdown method
 			client_address = (self.get_default_ip(), _fixture_port_num)
-			# Mock a request containing "STOP"
+			# Mock a request not containing "STOP"
 			request = ("Any other message with O, P, S, T", multicast.genSocket())
 			# Add assertions for initial state
 			self.assertIsNotNone(request[1], "Socket should be created")
@@ -277,7 +277,7 @@ def test_should_invoke_kill_func_when_handle_error_called(self) -> None:
 			self.server = multicast.hear.McastServer(server_address, None, False)
 			self.server.shutdown = MagicMock()  # Mock the shutdown method
 			client_address = (self.get_default_ip(), _fixture_port_num)
-			# Mock a request not containing "STOP"
+			# Mock a request containing "STOP"
 			request = ("STOP message", multicast.genSocket())
 			# Add assertions for initial state
 			self.assertIsNotNone(request[1], "Socket should be created")