[PATCH] Applied changes as discussed in review (- WIP #175 -)

Changes in file .coderabbit.yaml:
 - mention code coverage for tests

Changes in file Makefile:
 - tweak MANIFEST.in to ignore .yaml

Changes in file multicast/exceptions.py:
 - refactor to avoid shadowing vars

Changes in file multicast/hear.py:
 - minor refactor for readability

Changes in file tests/context.py:
 - implemented managed_process context manager

Changes in file tests/test_fuzz.py:
 - Refactored to use managed_process context manager

Changes in file tests/test_usage.py:
 - minor fixes

Author: reactive-firewall

.coderabbit.yaml

@@ -38,6 +38,8 @@ reviews:
     # Test Code Review Instructions
     - Ensure that test code is automated, comprehensive, and follows testing best practices.
     - Verify that all critical functionality is covered by tests.
+    - Ensure that the test coverage meets or exceeds the project's required threshold
+      (e.g., aiming for 100% coverage as per Issue #53).
     - For **test** code, *also* follow
       [CEP-9](https://gist.github.com/reactive-firewall/d840ee9990e65f302ce2a8d78ebe73f6)
 

Makefile

@@ -173,6 +173,7 @@ MANIFEST.in: init
 	$(QUIET)$(ECHO) "exclude .deepsource.toml" >>"$@" ;
 	$(QUIET)$(ECHO) "exclude .*.ini" >>"$@" ;
 	$(QUIET)$(ECHO) "exclude .*.yml" >>"$@" ;
+	$(QUIET)$(ECHO) "exclude .*.yaml" >>"$@" ;
 	$(QUIET)$(ECHO) "global-exclude .git" >>"$@" ;
 	$(QUIET)$(ECHO) "global-exclude codecov_env" >>"$@" ;
 	$(QUIET)$(ECHO) "global-exclude .DS_Store" >>"$@" ;

multicast/exceptions.py

@@ -243,12 +243,13 @@ def __init__(self, *args, **kwargs):
 		else:
 			exit_code = kwargs.pop("exit_code", 1)
 		if len(args) > 0 and isinstance(args[0], BaseException):
-			__cause__ = args[0]
+			cause = args[0]
 			args = args[1:]
 		else:
-			__cause__ = kwargs.pop("__cause__", None)
+			cause = kwargs.pop("__cause__", None)
 		super().__init__(*args, **kwargs)
-		self.__cause__ = __cause__
+		if cause is not None:
+			self.__cause__ = cause
 		self.message = args[0] if args else kwargs.get("message", "An error occurred")
 		self.exit_code = exit_code
 

multicast/hear.py

@@ -87,7 +87,7 @@
 		True
 		>>> int(test_fixture) < int(256)
 		True
-		>>> (int(test_fixture) >= int(0)) and (int(test_fixture) < int(156))
+		>>> (int(test_fixture) >= int(0)) and (int(test_fixture) < int(256))
 		True
 		>>>
 
@@ -518,18 +518,22 @@ def doStep(self, *args, **kwargs):
 		"""
 		HOST = kwargs.get("group", multicast._MCAST_DEFAULT_GROUP)  # skipcq: PYL-W0212 - module ok
 		PORT = kwargs.get("port", multicast._MCAST_DEFAULT_PORT)  # skipcq: PYL-W0212 - module ok
-		_result = False
+		server_initialized = False
+		server = None
 		try:
 			with McastServer((HOST, PORT), HearUDPHandler) as server:
-				_result = True
+				server_initialized = True
 				server.serve_forever()
 		except KeyboardInterrupt as userInterrupt:
 			try:
-				old_sock = server.socket
-				if old_sock:
+				if server and server.socket:
+					old_sock = server.socket
 					multicast.endSocket(old_sock)
 			finally:
-				raise KeyboardInterrupt("HEAR ended after interruption was signaled.") from userInterrupt
+				raise KeyboardInterrupt(
+					f"HEAR has stopped due to interruption signal (was previously listening on ({HOST}, {PORT}))."
+				) from userInterrupt
 		finally:
-			server.shutdown()
-		return (_result, None)
+			if server:
+				server.shutdown()
+		return (server_initialized, None)

tests/context.py

@@ -94,6 +94,24 @@
 except ImportError as err:  # pragma: no branch
 	raise ModuleNotFoundError("[CWE-440] unittest Failed to import.") from err
 
+try:
+	if 'contextlib' not in sys.modules:
+		import contextlib
+	else:  # pragma: no branch
+		contextlib = sys.modules["""contextlib"""]
+except ImportError as err:  # pragma: no branch
+	raise ModuleNotFoundError("[CWE-440] contextlib Failed to import.") from err
+
+
+try:
+	if 'contextlib.contextmanager' not in sys.modules:
+		from contextlib import contextmanager
+	else:  # pragma: no branch
+		contextlib.contextmanager = sys.modules["""contextlib.contextmanager"""]
+		contextmanager = contextlib.contextmanager
+except ImportError as err:  # pragma: no branch
+	raise ModuleNotFoundError("[CWE-440] contextlib.contextmanager Failed to import.") from err
+
 
 try:
 	if 'Process' not in sys.modules:
@@ -832,6 +850,32 @@ def debugUnexpectedOutput(expectedOutput, actualOutput, thepython):
 	print(__BLANK)
 
 
+@contextmanager
+def managed_process(process):
+	"""
+	Context manager for safely handling multiprocessing processes.
+
+	Ensures that the given process is properly terminated and cleaned up,
+	even if exceptions occur during execution. This includes terminating,
+	joining, and closing the process to prevent resource leaks.
+
+	Args:
+		process (multiprocessing.Process): The process to manage.
+
+	Yields:
+		multiprocessing.Process: The managed process within the context.
+	"""
+	try:
+		yield process
+	finally:
+		if process.is_alive():
+			process.terminate()
+			process.join(timeout=3)
+			if process.is_alive():
+				process.kill()
+		process.close()
+
+
 class BasicUsageTestSuite(unittest.TestCase):
 	"""
 		Basic functional test cases.

tests/test_fuzz.py

@@ -174,14 +174,14 @@ def test_say_works_WHEN_using_stdin_GIVEN_alnum_of_any_size_fuzz_input(self, tex
 		"""
 		Test the multicast send response to valid alnum input.
 
-		???
-
 		Args:
 			text (str): A randomly generated string of ASCII letters and digits,
 				with length between 56 and 2048 characters.
 
 		Assertions:
-			- FIX ME
+			- Verifies that the multicast sender can handle input from stdin
+			- Confirms the process exits successfully after sending the message
+			- Validates the receiver process terminates cleanly
 		"""
 		theResult = False
 		fail_fixture = str(f"stdin({text.__sizeof__()}) --> SAY == error")
@@ -201,34 +201,31 @@ def test_say_works_WHEN_using_stdin_GIVEN_alnum_of_any_size_fuzz_input(self, tex
 			)
 			p.daemon = True
 			p.start()
-			self.assertIsNotNone(p)
-			self.assertTrue(p.is_alive())
-			try:
-				sender = multicast.send.McastSAY()
-				self.assertIsNotNone(sender)
-				test_input = str(text)
-				# ESSENTIAL PART OF THIS TEST
-				self.assertIsNotNone(test_input)
-				with patch('sys.stdin', io.StringIO(test_input)):
-					self.assertIsNotNone(
-						sender.doStep(data=['-'], group='224.0.0.1', port=_fixture_port_num)
-					)
-				self.assertIsNotNone(p)
-				self.assertTrue(p.is_alive())
-				while p.is_alive():
-					sender(group="224.0.0.1", port=_fixture_port_num, data=["STOP", "Test"])
-					p.join(1)
-				self.assertFalse(p.is_alive())
-			except Exception as _cause:
-				p.join(3)
-				if p.is_alive():
-					p.terminate()
-					p.close()
-				raise unittest.SkipTest(sub_fail_fixture) from _cause
-			p.join(5)
-			self.assertIsNotNone(p.exitcode)
-			self.assertEqual(int(p.exitcode), int(0))
-			theResult = (int(p.exitcode) <= int(0))
+			with context.managed_process(p) as managed_p:
+				self.assertIsNotNone(managed_p)
+				self.assertTrue(managed_p.is_alive())
+				try:
+					sender = multicast.send.McastSAY()
+					self.assertIsNotNone(sender)
+					test_input = str(text)
+					# ESSENTIAL PART OF THIS TEST
+					self.assertIsNotNone(test_input)
+					with patch('sys.stdin', io.StringIO(test_input)):
+						self.assertIsNotNone(
+							sender.doStep(data=['-'], group='224.0.0.1', port=_fixture_port_num)
+						)
+					self.assertIsNotNone(p)
+					self.assertTrue(p.is_alive())
+					while p.is_alive():
+						sender(group="224.0.0.1", port=_fixture_port_num, data=["STOP", "Test"])
+						managed_p.join(1)
+					self.assertFalse(managed_p.is_alive())
+				except Exception as _cause:
+					raise unittest.SkipTest(sub_fail_fixture) from _cause
+				self.assertFalse(managed_p.is_alive(), "RESOURCE LEAK")
+				self.assertIsNotNone(managed_p.exitcode)
+				self.assertEqual(int(managed_p.exitcode), int(0))
+				theResult = (int(managed_p.exitcode) <= int(0))
 		except unittest.SkipTest as _skip_not_invalid:
 			raise unittest.SkipTest(fail_fixture) from _skip_not_invalid
 		except Exception as err:

tests/test_usage.py

@@ -357,14 +357,15 @@ def test_hear_works_WHEN_say_works(self):
 			)
 			p.start()
 			try:
+				tst_fixture_sendDispatch = multicast.__main__.McastDispatch()
 				self.assertIsNotNone(
-					multicast.__main__.McastDispatch().doStep(["""SAY""", _fixture_SAY_args])
+					tst_fixture_sendDispatch.doStep(["""SAY""", _fixture_SAY_args])
 				)
 				self.assertIsNotNone(
-					multicast.__main__.McastDispatch().doStep(["""SAY""", _fixture_SAY_args])
+					tst_fixture_sendDispatch.doStep(["""SAY""", _fixture_SAY_args])
 				)
 				self.assertIsNotNone(
-					multicast.__main__.McastDispatch().doStep(["""SAY""", _fixture_SAY_args])
+					tst_fixture_sendDispatch.doStep(["""SAY""", _fixture_SAY_args])
 				)
 			except Exception as _cause:
 				p.join()
@@ -442,7 +443,7 @@ def test_say_works_WHEN_using_stdin(self):
 			test_input = "Test message from stdin"
 			self.assertIsNotNone(test_input)
 			with patch('sys.stdin', io.StringIO(test_input)):
-				self.assertIsNone(say.doStep(data=['-'], group='224.0.0.1', port=_fixture_port_num))
+				self.assertIsNotNone(say.doStep(data=['-'], group='224.0.0.1', port=_fixture_port_num))
 			# Assert that the result is as expected
 			# You might need to modify this based on what _sayStep returns
 			theResult = True  # or whatever the expected output is