[TESTING] Implemented new test HearHandleNoneDataTestSuite (- WIP #53 -)

Changes in file multicast/__main__.py:
 - refactored McastRecvHearDispatch(mtool).setupArgs(cls, parser) for clearity and consistancy.

Changes in file multicast/recv.py:
 - removed unused implementation of McastRECV(multicast.mtool).setupArgs(cls, parser) for consistancy.

Changes in file tests/__init__.py:
 - releated changes to new test suite HearHandleNoneDataTestSuite

Changes in file tests/test_hear_data_processing.py:
 - added HearHandleNoneDataTestSuite implementation

Changes in file tests/test_usage.py:
 - refactored docstrings for clearity.

Author: reactive-firewall

multicast/__main__.py

@@ -348,7 +348,10 @@ class McastRecvHearDispatch(mtool):
 	@classmethod
 	def setupArgs(cls, parser):
 		"""
-		Will attempt to add send args.
+		Will attempt to add hear args.
+
+		Both HEAR and RECV use the same arguments, and are differentiated only by the global,
+		'--daemon' argument during dispatch.
 
 		Testing:
 
@@ -427,26 +430,39 @@ def setupArgs(cls, parser):
 
 		"""
 		if parser is not None:  # pragma: no branch
-			parser.add_argument("""--port""", type=int, default=_MCAST_DEFAULT_PORT)
+			parser.add_argument(
+				"""--port""",
+				type=int, default=_MCAST_DEFAULT_PORT  # skipcq: PYL-W0212 - module ok
+			)
 			__tmp_help = """local interface to use for listening to multicast data; """
 			__tmp_help += """if unspecified, any one interface may be chosen."""
 			parser.add_argument(
 				"""--iface""", default=None,
 				help=str(__tmp_help)
 			)
-			__tmp_help = """multicast groups (ip addrs) to bind to for the udp socket; """
+			__tmp_help = """multicast group (ip address) to bind-to for the udp socket; """
 			__tmp_help += """should be one of the multicast groups joined globally """
 			__tmp_help += """(not necessarily joined in this python program) """
 			__tmp_help += """in the interface specified by --iface. """
-			__tmp_help += """If unspecified, bind to 224.0.0.1 """
+			__tmp_help += f"If unspecified, bind-to {_MCAST_DEFAULT_GROUP} "
 			__tmp_help += """(all addresses (all multicast addresses) of that interface)"""
 			parser.add_argument(
-				"""--group""", default=_MCAST_DEFAULT_GROUP,
+				"""--group""",
+				default=_MCAST_DEFAULT_GROUP,  # skipcq: PYL-W0212 - module ok
 				help=str(__tmp_help)
 			)
+			__tmp_help = """multicast groups (ip addresses) to join globally; """
+			__tmp_help += """should be one of the multicast groups joined globally """
+			__tmp_help += """by the interface specified by --iface. """
+			__tmp_help += """If unspecified, or supplied an empty list, the default """
+			__tmp_help += """implementation will join """
+			__tmp_help += f"{_MCAST_DEFAULT_GROUP} (all addresses (all multicast addresses) "
+			__tmp_help += """of that interface) instead of not joining. NOTE: If you really need """
+			__tmp_help += """to NOT join the multicast group you should instead use the sockets """
+			__tmp_help += """module directly, as this module does not support such a use-case."""
 			parser.add_argument(
 				"""--groups""", default=[], nargs='*',
-				help="""multicast groups (ip addrs) to listen to join."""
+				help=str(__tmp_help)
 			)
 
 	@staticmethod

multicast/recv.py

@@ -438,84 +438,7 @@ class McastRECV(multicast.mtool):
 
 	@classmethod
 	def setupArgs(cls, parser):
-		"""
-		Will attempt add send args.
-
-			Testing:
-
-			Testcase 0: First set up test fixtures by importing multicast.
-
-				>>> import multicast
-				>>> import argparse as _argparse
-				>>> multicast.recv is not None
-				True
-				>>> multicast.recv.McastRECV is not None
-				True
-				>>>
-
-			Testcase 1: main should return an int.
-				A: Test that the multicast component is initialized.
-				B: Test that the recv component is initialized.
-				C: Test that the main(recv) function is initialized.
-				D: Test that the main(recv) function returns an int 0-255.
-
-				>>> multicast.recv is not None
-				True
-				>>> multicast.__main__.main is not None
-				True
-				>>> tst_fxtr_args = ['''RECV''', '''--port=1234''', '''--group''', '''224.0.0.1''']
-				>>> (test_fixture, junk_ignore) = multicast.__main__.main(tst_fxtr_args)
-				>>> test_fixture is not None
-				True
-				>>> type(test_fixture) #doctest: -DONT_ACCEPT_BLANKLINE, +ELLIPSIS
-				<...int...>
-				>>> int(test_fixture) >= int(0)
-				True
-				>>> int(test_fixture) < int(256)
-				True
-				>>>
-
-			Testcase 2: setupArgs should not error given valid input.
-				A: Test that the multicast component is initialized.
-				B: Test that the recv component is initialized.
-				C: Test that the McastRECV class is initialized.
-				D: Test that the setupArgs function returns without error.
-
-				>>> multicast.recv is not None
-				True
-				>>> multicast.__main__.main is not None
-				True
-				>>> tst_fxtr_args = _argparse.ArgumentParser(prog="testcase")
-				>>> multicast.recv.McastRECV.setupArgs(parser=tst_fxtr_args)
-				>>>
-
-		"""
-		if parser is not None:
-			parser.add_argument(
-				"""--port""",
-				type=int, default=multicast._MCAST_DEFAULT_PORT  # skipcq: PYL-W0212 - module ok
-			)
-			__tmp_help = """local interface to use for listening to multicast data; """
-			__tmp_help += """if unspecified, any one interface may be chosen."""
-			parser.add_argument(
-				"""--iface""", default=None,
-				help=str(__tmp_help)
-			)
-			__tmp_help = """multicast groups (ip addrs) to bind to for the udp socket; """
-			__tmp_help += """should be one of the multicast groups joined globally """
-			__tmp_help += """(not necessarily joined in this python program) """
-			__tmp_help += """in the interface specified by --iface. """
-			__tmp_help += """If unspecified, bind to 224.0.0.1 """
-			__tmp_help += """(all addresses (all multicast addresses) of that interface)"""
-			parser.add_argument(
-				"""--group""",
-				default=multicast._MCAST_DEFAULT_GROUP,  # skipcq: PYL-W0212 - module ok
-				help=str(__tmp_help)
-			)
-			parser.add_argument(
-				"""--groups""", default=[], nargs='*',
-				help="""multicast groups (ip addrs) to listen to join."""
-			)
+		pass  # skipcq - Optional abstract method
 
 	@staticmethod
 	def _hearstep(groups, port, iface=None, bind_group=None):

tests/__init__.py

@@ -150,6 +150,7 @@
 	test_install_requires.TestParseRequirements, test_usage.MulticastTestSuite,
 	test_usage.BasicIntegrationTestSuite, test_hear_server_activate.McastServerActivateTestSuite,
 	test_hear_cleanup.HearCleanupTestSuite, test_hear_data_processing.RecvDataProcessingTestSuite,
+	test_hear_data_processing.HearHandleNoneDataTestSuite,
 	test_hear_keyboard_interrupt.TestHearKeyboardInterrupt
 )
 

tests/test_hear_data_processing.py

@@ -31,14 +31,15 @@
 	else:
 		from context import multicast  # pylint: disable=cyclic-import - skipcq: PYL-R0401
 		from context import unittest
+		from unittest.mock import MagicMock
 		from context import Process
 except Exception as err:
 	raise ImportError("[CWE-758] Failed to import test context") from err
 
 
 class RecvDataProcessingTestSuite(context.BasicUsageTestSuite):
 	"""
-	A test suite that uses Hypothesis to perform fuzz testing on the multicast sender and receiver.
+	A test suite that checks empty data with the multicast sender and receiver.
 
 	"""
 
@@ -143,5 +144,30 @@ def test_multicast_sender_with_no_data_before_follow_by_stop(self):
 		self.assertTrue(theResult, fail_fixture)
 
 
+class HearHandleNoneDataTestSuite(context.BasicUsageTestSuite):
+	"""
+	A test suite that uses MagicMock to perform light testing of the default handler for HEAR.
+
+	"""
+
+	__module__ = """tests.test_hear_data_processing"""
+
+	__name__ = """tests.test_hear_data_processing.HearHandleNoneDataTestSuite"""
+
+	def test_handle_none_data(self):
+		_fixture_port_num = self._always_generate_random_port_WHEN_called()
+		self.assertIsNotNone(_fixture_port_num)
+		self.assertIsInstance(_fixture_port_num, int)
+		handler = multicast.hear.HearUDPHandler(
+			request=(None, None),
+			client_address=('224.0.0.1', _fixture_port_num),
+			server=None
+		)
+		# Mock the socket to prevent actual network calls
+		handler.request = (None, MagicMock())
+		handler.handle()
+		# Ensure that no exceptions are raised
+
+
 if __name__ == '__main__':
 	unittest.main()

tests/test_usage.py

@@ -704,7 +704,17 @@ def test_Usage_Error_WHEN_the_help_command_is_called(self):
 		self.assertTrue(theResult, str("""Could Not find usage from multicast --help"""))
 
 	def test_Usage_Error_WHEN_the_help_sub_command_is_called(self):
-		"""Test case for multicast* [HEAR|RECV] --help."""
+		"""
+		Test case for validating help output of multicast sub-commands.
+
+		This test ensures that the help output is correct for various sub-commands
+		(HEAR, RECV, SAY) in both daemon and non-daemon modes. It validates that
+		each command combination provides appropriate usage information.
+
+		Test fixtures use named tuples to organize:
+		- mode: daemon/non-daemon mode
+		- command: the sub-command being tested
+		"""
 		theResult = False
 		fail_fixture = str("""multicast [HEAR|RECV] --help == not helpful""")
 		try:
@@ -714,7 +724,8 @@ def test_Usage_Error_WHEN_the_help_sub_command_is_called(self):
 				TestCase(mode="{}", command="HEAR"),
 				TestCase(mode="--daemon {}", command="RECV"),
 				TestCase(mode="{}", command="RECV"),
-				TestCase(mode="{}", command="SAY")
+				TestCase(mode="{}", command="SAY"),
+				TestCase(mode="{}", command="NOOP")
 			]
 			if (self._thepython is not None):
 				theResult = True