Fix Unix socket test server cleanup

Shut down the Unix socket test server before closing it and wait for the
server thread to finish.

This avoids a race where serve_forever can access a closed file descriptor
and the client can fail with BrokenPipeError in CI.

Author: ozgen

tests/connections/test_debug_connection.py

@@ -8,12 +8,12 @@
 from gvm.connections._connection import AbstractGvmConnection
 
 
-class TestConnection(AbstractGvmConnection):
+class DummyConnection(AbstractGvmConnection):
     def connect(self) -> None:
         pass
 
 
 class DebugConnectionTestCase(unittest.TestCase):
     def test_is_gvm_connection(self):
-        connection = DebugConnection(TestConnection())
+        connection = DebugConnection(DummyConnection())
         self.assertTrue(isinstance(connection, GvmConnection))

tests/connections/test_gvm_connection.py

@@ -14,21 +14,21 @@
 from gvm.errors import GvmError
 
 
-class TestConnection(AbstractGvmConnection):
+class DummyConnection(AbstractGvmConnection):
     def connect(self) -> None:
         pass
 
 
 class GvmConnectionTestCase(unittest.TestCase):
     # pylint: disable=protected-access
     def test_init_no_args(self):
-        connection = TestConnection()
+        connection = DummyConnection()
 
         self.assertIsNone(connection._socket)
         self.assertEqual(connection._timeout, DEFAULT_TIMEOUT)
 
     def test_init_with_none(self):
-        connection = TestConnection(timeout=None)
+        connection = DummyConnection(timeout=None)
 
         self.assertIsNone(connection._socket)
         self.assertEqual(connection._timeout, DEFAULT_TIMEOUT)
@@ -37,7 +37,7 @@ def test_read_no_data(self):
         read_mock = MagicMock()
         read_mock.return_value = None
 
-        connection = TestConnection()
+        connection = DummyConnection()
         connection._read = read_mock
 
         with self.assertRaises(GvmError, msg="Remote closed the connection"):
@@ -49,7 +49,7 @@ def test_read_trigger_timeout(self):
         read_mock = MagicMock()
         read_mock.side_effect = [b"<foo>xyz<bar></bar>", b"</foo>"]
 
-        connection = TestConnection(timeout=0)
+        connection = DummyConnection(timeout=0)
         connection._read = read_mock
 
         with self.assertRaises(
@@ -58,5 +58,5 @@ def test_read_trigger_timeout(self):
             connection.read()
 
     def test_is_gvm_connection(self):
-        connection = TestConnection()
+        connection = DummyConnection()
         self.assertTrue(isinstance(connection, GvmConnection))

tests/connections/test_unix_socket_connection.py

@@ -23,6 +23,15 @@
 class DummyRequestHandler(socketserver.BaseRequestHandler):
     def handle(self):
         response = b'<gmp_response status="200" status_text="OK"/>'
+
+        self.request.settimeout(0.2)
+        try:
+            self.request.recv(16 * 1024)
+        except TimeoutError:
+            pass
+        except OSError:
+            pass
+
         self.request.sendall(response)
 
 
@@ -47,29 +56,33 @@ def setUp(self):
         self.server_thread.start()
 
     def tearDown(self):
-        self.socket_server.server_close()
         self.socket_server.shutdown()
         self.server_thread.join(60.0)
+        self.socket_server.server_close()
         self.socket_path.unlink(missing_ok=True)
 
     def test_unix_socket_connection_connect_read(self):
         connection = UnixSocketConnection(
             path=self.socket_name, timeout=DEFAULT_TIMEOUT
         )
+        self.addCleanup(connection.disconnect)
+
         connection.connect()
         resp = connection.read()
+
         self.assertEqual(resp, b'<gmp_response status="200" status_text="OK"/>')
-        connection.disconnect()
 
     def test_unix_socket_connection_connect_send_bytes_read(self):
         connection = UnixSocketConnection(
             path=self.socket_name, timeout=DEFAULT_TIMEOUT
         )
+        self.addCleanup(connection.disconnect)
+
         connection.connect()
         connection.send(b"<gmp/>")
         resp = connection.read()
+
         self.assertEqual(resp, b'<gmp_response status="200" status_text="OK"/>')
-        connection.disconnect()
 
     def test_unix_socket_connect_file_not_found(self):
         connection = UnixSocketConnection(path="foo", timeout=DEFAULT_TIMEOUT)