Add basic connection unit test for server/clients

Author: DavidPL1

hyperion/lib/networking/clientInterface.py

@@ -150,7 +150,7 @@ def forward_over_ssh(self):
 
 
 class RemoteSlaveInterface(BaseClient):
-    def __init__(self, host, port, cc):
+    def __init__(self, host, port, cc, loop_in_thread=False):
         """Init remote slave interface for communication to the server at `host` on `port` with slave controller `cc`.
 
         :param host: Hostname of the server to connect to
@@ -159,6 +159,9 @@ def __init__(self, host, port, cc):
         :type port: int
         :param cc: Slave manager to dispatch calls to and forward messages from
         :type cc: hyperion.manager.SlaveManager
+        :param loop_in_thread: Whether to run the loop function in an extra thread. Useful for unit tests and disabled
+        by default.
+        :type loop_in_thread: bool
         """
         BaseClient.__init__(self, host, port)
         self.cc = cc
@@ -210,7 +213,12 @@ def __init__(self, host, port, cc):
             'conf_reload': self.cc.reload_config
         }
         self._send_auth()
-        self._loop()
+
+        if not loop_in_thread:
+            self._loop()
+        else:
+            self.worker = worker = threading.Thread(target=self._loop)
+            worker.start()
 
         self.logger.debug("Shutdown complete!")
 

hyperion/lib/networking/server.py

@@ -98,7 +98,7 @@ def _quit(self):
 
 
 class Server(BaseServer):
-    def __init__(self, port, cc):
+    def __init__(self, port, cc, loop_in_thread=False):
         BaseServer.__init__(self)
         self.port = port
         self.cc = cc  # type: hyperion.ControlCenter
@@ -143,6 +143,13 @@ def __init__(self, port, cc):
 
         self.sel.register(server, selectors.EVENT_READ, self.accept)
 
+        if not loop_in_thread:
+            self._loop()
+        else:
+            self.worker = worker = threading.Thread(target=self._loop)
+            worker.start()
+
+    def _loop(self):
         while self.keep_running:
             try:
                 for key, mask in self.sel.select(timeout=1):

hyperion/lib/util/config.py

@@ -31,7 +31,7 @@ class HostState(Enum):
 SHELL_EXECUTABLE_PATH = '/bin/bash'
 """Path to shell executable"""
 
-DEFAULT_TCP_PORT = "23081"
+DEFAULT_TCP_PORT = 23081
 
 TMP_SLAVE_DIR = "/tmp/Hyperion/slave/conf"
 TMP_CONF_DIR = "/tmp/Hyperion/conf/"

hyperion/manager_tests.py

@@ -3,10 +3,8 @@
 import libtmux
 import lib.util.exception
 import os.path
-import time
-import sys
+from lib.networking import server, clientInterface
 import hyperion.lib.util.exception as exceptions
-import hyperion.lib.util.config as config
 from hyperion.lib.monitoring.threads import *
 
 is_py2 = sys.version[0] == '2'
@@ -28,8 +26,8 @@ def tearDown(self):
             pass
 
     def test_construction(self):
-        self.assertEqual(self.cc.config['name'], 'Unit test config')
-        self.assertTrue(self.cc.server.has_session('Unit test config'))
+        self.assertEqual(self.cc.config['name'], 'Unit-test-config')
+        self.assertTrue(self.cc.server.has_session('Unit-test-config'))
 
     def test_host_resolution(self):
         host_test_comp = self.cc.get_component_by_id('host_depends_test@localhost')
@@ -52,7 +50,7 @@ def test_component_fetch(self):
             self.cc.get_component_by_id('do fail')
 
         lst = self.cc.get_start_all_list()
-        self.assertEqual(lst[0].comp_id, 'tail@localhost')
+        self.assertEqual(lst[0].comp_id, 'host_test@resolved-host')
 
         wait = manager.get_component_wait(tail)
         self.assertEqual(wait, 0.2)
@@ -206,5 +204,49 @@ def test_stop(self):
         )
 
 
+class ServerClientsTests(unittest.TestCase):
+    def setUp(self):
+        sms = server.SlaveManagementServer()
+        self.cc = manager.ControlCenter('%s/data/test-config.yaml' % manager.BASE_DIR, slave_server=sms)
+        self.cc.init()
+
+        self.cc._establish_master_connection('localhost')
+        self.cc._copy_config_to_remote('localhost')
+
+        config_path = "%s/%s.yaml" % (config.TMP_SLAVE_DIR, self.cc.config['name'])
+        port = self.cc.slave_server.port
+
+        self.server = server.Server(config.DEFAULT_TCP_PORT, self.cc, loop_in_thread=True)
+
+        print("Starting slave manager")
+        self.slc = slc = manager.SlaveManager(config_path)
+        print("Starting slave interface")
+        self.si = clientInterface.RemoteSlaveInterface('localhost', port, slc, loop_in_thread=True)
+        print("Starting client interface")
+        self.ci_queue = queue.Queue()
+        self.ci = clientInterface.RemoteControllerInterface('localhost', config.DEFAULT_TCP_PORT)
+        self.ci.add_subscriber(self.ci_queue)
+        print("SETUP DONE")
+
+    def tearDown(self):
+        try:
+            self.ci.cleanup(True)
+            self.server.worker.join()
+
+            while self.cc.server.has_session(self.cc.session_name):
+                time.sleep(.5)
+
+        except SystemExit:
+            pass
+
+    def test_connection(self):
+        test_ev = events.CheckEvent('tail@localhost', config.CheckState.STOPPED)
+        self.si.event_queue.put(test_ev)
+        ci_msg = self.ci_queue.get(timeout=5)
+
+        self.assertEqual(ci_msg.comp_id, test_ev.comp_id)
+        self.assertEqual(ci_msg.check_state, test_ev.check_state)
+
+
 if __name__ == '__main__':
     unittest.main()