Merge pull request #24 from bp100a/restructure-clean

Restructure clean

Author: bp100a

.github/workflows/poetry-build.yml

@@ -46,8 +46,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          poetry install
-          python -m poetry run python -m pip install -r tool_requirements.txt
+          poetry install --with tests
 
       - name: lint
         run: |

poetry.lock

@@ -33,6 +33,8 @@ classifiers = [
     "Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Communications Device Class (CDC)",
 
     # Specify the Python versions you support here.
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -46,7 +48,7 @@ Repository = "https://github.com/bp100a/serial-usbipclient"
 name = "serial-usbipclient"
 authors = ["Harry J. Collins <bp100a@gmail.com>"]
 maintainers = ["Harry J. Collins <bp100a@gmail.com>"]
-version = "0.1.3"
+version = "0.1.4"
 description = "Simple serial connectivity to CDC (serial) USB devices exposed by a USBIPD service."
 readme = "README.md"
 package-mode = true
@@ -55,6 +57,18 @@ package-mode = true
 python = "^3.11"
 py-datastruct = "^1.0.0"
 
+[tool.poetry.group.tests.dependencies]
+pytest = "8.3.2"
+pytest-xdist = "3.6.1"
+coverage = "7.6.1"
+pylint = "3.2.6"
+pip-tools = "7.4.1"
+black = "24.8.0"
+pytest-cov = "5.0.0"
+pytest-timeout = "2.3.1"
+isort = "5.13.2"
+mypy = "1.11.2"
+
 [tool.mypy]
 check_untyped_defs = true
 exclude = [

pyproject.toml

@@ -1 +1 @@
-["serial_usbipclient.tests.test_connection.py.testusbipconnection.test_connection", "serial_usbipclient.tests.test_connection.py.testusbipconnection.test_connection_shutdown", "serial_usbipclient.tests.test_connection.py.testusbipconnection.test_queue_urbs", "serial_usbipclient.tests.test_descriptors.py.testinterfacedescriptor.test_descriptors", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mock_usbip_server_connection", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mock_usbip_server_startup", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mocked_response", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_reading_paths", "serial_usbipclient.tests.test_mock_usbip_server.py.testdeviceconfiguration.test_lsusb_parsing", "serial_usbipclient.tests.test_mock_usbip_server.py.testdeviceconfiguration.test_usbip_path", "serial_usbipclient.tests.test_packaging.py.testversion.test_version", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_cmd_response", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_cmd_submit", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_iso_packet_descriptor", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_metastruct_size", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_queue_urb", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_request_devlist", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_sizing", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_urb_endianness", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_configuration", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_delimited_read", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_failed_attachment", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_hardware_id_formatting", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_invalid_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_no_read_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_no_write_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_read_timeout", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_read_write", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_readline", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_readline_timeout", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_unattachable_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_unknown_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_timeout_error", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_unknown_device", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_write_string", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_attachment", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_connection", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_gai_error", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_list_published", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_recv_error", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_restore_connection", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_restore_connection_no_device", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_timeout_error", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_configuration_descriptor", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_descriptor_handlers", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_endpoint_descriptor_handlers", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_generate_configuration", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_interface_association_handlers"]
+["serial_usbipclient.tests.test_connection.py.testusbipconnection.test_connection", "serial_usbipclient.tests.test_connection.py.testusbipconnection.test_connection_shutdown", "serial_usbipclient.tests.test_connection.py.testusbipconnection.test_queue_urbs", "serial_usbipclient.tests.test_descriptors.py.testinterfacedescriptor.test_descriptors", "serial_usbipclient.tests.test_exceptions.py.testexceptions.test_endpoint_exceptions", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mock_usbip_server_connection", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mock_usbip_server_startup", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_mocked_response", "serial_usbipclient.tests.test_mock_usbip_server.py.testmockusbipserver.test_reading_paths", "serial_usbipclient.tests.test_mock_usbip_server.py.testdeviceconfiguration.test_lsusb_parsing", "serial_usbipclient.tests.test_mock_usbip_server.py.testdeviceconfiguration.test_usbip_path", "serial_usbipclient.tests.test_packaging.py.testversion.test_version", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_cmd_response", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_cmd_submit", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_iso_packet_descriptor", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_metastruct_size", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_queue_urb", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_request_devlist", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_sizing", "serial_usbipclient.tests.test_packet_generation.py.testpacketgeneration.test_urb_endianness", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_configuration", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_delimited_read", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_failed_attachment", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_hardware_id_formatting", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_invalid_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_no_read_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_no_write_response", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_read_timeout", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_read_write", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_readline", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_readline_timeout", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_unattachable_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_restore_unknown_connection", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_timeout_error", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_unknown_device", "serial_usbipclient.tests.test_rw_device.py.testreadwrite.test_write_string", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_attachment", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_connection", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_gai_error", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_list_published", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_recv_error", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_restore_connection", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_restore_connection_no_device", "serial_usbipclient.tests.test_socket_handling.py.testsocketwrapper.test_timeout_error", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_configuration_descriptor", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_descriptor_handlers", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_endpoint_descriptor_handlers", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_generate_configuration", "serial_usbipclient.tests.test_urb_packets.py.testurbpackets.test_interface_association_handlers"]

serial_usbipclient/tests/list_of_tests.json

@@ -0,0 +1,22 @@
+"""test exceptions are properly raised"""
+
+from common_test_base import CommonTestBase
+from serial_usbipclient.usbip_client import USBIPValueError, USBIP_Connection
+
+
+class TestExceptions(CommonTestBase):
+    """tests exception throwing"""
+    def test_endpoint_exceptions(self):
+        """test exceptions from endpoints"""
+        conn: USBIP_Connection = USBIP_Connection()
+        _ = conn.control  # no exception
+
+        # exceptions should be thrown from uninitialized endpoints
+        with self.assertRaisesRegex(expected_exception=USBIPValueError, expected_regex='no input endpoint!'):
+            _ = conn.input
+
+        with self.assertRaisesRegex(expected_exception=USBIPValueError, expected_regex='no output endpoint!'):
+            _ = conn.output
+
+        with self.assertRaisesRegex(expected_exception=USBIPValueError, expected_regex='no endpoint!'):
+            _ = conn.pending_reads