Refactor test imports to use path management helpers

Replaces a relative import (which prevented tests scripts from simply
being runnable) with a single line of boilerplate to set up the path and
an import that further alters the path as required.

malcolm/wscomms/wsservercomms.py

@@ -1,3 +1,8 @@
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 import json
 

tests/setup_malcolm_paths.py

@@ -0,0 +1,7 @@
+import sys
+import os
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+sys.path.append(os.path.join(os.path.dirname(__file__), "..", "..", "scanpointgenerator"))
+
+from pkg_resources import require
+require("mock", "numpy", "tornado")

tests/test_controllers/test_clientcontroller.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import MagicMock, patch
 
 # logging

tests/test_controllers/test_countercontroller.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import Mock
 
 from malcolm.controllers.countercontroller import CounterController

tests/test_controllers/test_hellocontroller.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import Mock
 
 from malcolm.controllers.hellocontroller import HelloController

tests/test_core/test_attribute.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import Mock, patch
 
 from malcolm.core.attribute import Attribute

tests/test_core/test_attributemeta.py

@@ -1,6 +1,11 @@
-from . import util
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
+
+import unittest
 from mock import MagicMock
 
 from malcolm.core.attributemeta import AttributeMeta

tests/test_core/test_block.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import MagicMock, patch
 
 # module imports

tests/test_core/test_cache.py

@@ -1,9 +1,13 @@
+import os
+import sys
 import unittest
 from collections import OrderedDict
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+
 # import logging
 # logging.basicConfig(level=logging.DEBUG)
 
-from . import util
+import setup_malcolm_paths
 from mock import MagicMock
 
 # module imports
@@ -38,3 +42,6 @@ def test_walkt_path(self):
         c[1] = {2: {3: "end"}}
         walked = c.walk_path([1, 2, 3])
         self.assertEqual(walked, "end")
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_core/test_clientcomms.py

@@ -1,12 +1,17 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import Mock, patch, call
 
 from malcolm.core.clientcomms import ClientComms
 from malcolm.core.syncfactory import SyncFactory
 
+
 class TestClientComms(unittest.TestCase):
     @patch("malcolm.core.clientcomms.ClientComms.add_spawn_function")
     @patch("malcolm.core.clientcomms.ClientComms.make_default_stop_func")

tests/test_core/test_controller.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import MagicMock, call
 
 # module imports

tests/test_core/test_loggable.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import patch
 
 from malcolm.core.loggable import Loggable

tests/test_core/test_mapmeta.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import MagicMock, patch, call
 
 from malcolm.core.mapmeta import MapMeta

tests/test_core/test_method.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import Mock, patch, call, MagicMock
 
 from malcolm.core.method import Method, takes, returns

tests/test_core/test_monitorable.py

@@ -1,10 +1,14 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import Mock
 
 from malcolm.core.monitorable import Monitorable
 
+
 class TestMonitorable(unittest.TestCase):
 
     def test_init(self):

tests/test_core/test_numbermeta.py

@@ -1,12 +1,17 @@
-from . import util
-import unittest
-from collections import OrderedDict
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
+from collections import OrderedDict
 import numpy as np
 
+import unittest
+
 from malcolm.core.numbermeta import NumberMeta
 from malcolm.core.attributemeta import AttributeMeta
 
+
 class TestNumberMeta(unittest.TestCase):
     def test_init_int(self):
         nm = NumberMeta("nm", "desc", np.int32)

tests/test_core/test_process.py

@@ -1,9 +1,13 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 # import logging
 # logging.basicConfig(level=logging.DEBUG)
 
-from . import util
+import unittest
 from mock import MagicMock
 
 # module imports

tests/test_core/test_request.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import MagicMock, patch
 
 from malcolm.core.request import Request

tests/test_core/test_response.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 from mock import Mock, MagicMock
 
 from malcolm.core.response import Response

tests/test_core/test_servercomms.py

@@ -1,12 +1,16 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import Mock, patch, call
 
 from malcolm.core.servercomms import ServerComms
 from malcolm.core.spawnable import Spawnable
 from malcolm.core.syncfactory import SyncFactory
 
+
 class TestServerComms(unittest.TestCase):
 
     def setUp(self):

tests/test_core/test_spawnable.py

@@ -1,6 +1,9 @@
+import os
+import sys
 import unittest
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
 
-from . import util
+import setup_malcolm_paths
 from mock import Mock, call
 
 from malcolm.core.spawnable import Spawnable

tests/test_core/test_stringmeta.py

@@ -1,7 +1,11 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from . import util
+import unittest
 
 from malcolm.core.stringmeta import StringMeta
 from malcolm.core.attributemeta import AttributeMeta

tests/test_core/test_syncfactory.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 from mock import patch
 
 # module imports

tests/test_core/test_system_core.py

@@ -1,6 +1,9 @@
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
-from . import util
+import unittest
 
 # logging
 # import logging

tests/test_wscomms/test_system_wscomms.py

@@ -1,15 +1,16 @@
-import unittest
-import time
-
-from . import util
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
 
+import time
 # logging
 # import logging
 # logging.basicConfig(level=logging.DEBUG)
 
+import unittest
+
 # tornado
-from pkg_resources import require
-require("tornado")
 from tornado.websocket import websocket_connect
 from tornado import gen
 from tornado.ioloop import IOLoop

tests/test_wscomms/test_wsclientcomms.py

@@ -1,9 +1,11 @@
-from . import util
-import unittest
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+import setup_malcolm_paths
+
 from collections import OrderedDict
 
-from pkg_resources import require
-require('tornado')
+import unittest
 from mock import MagicMock, patch, call
 
 from malcolm.wscomms.wsclientcomms import WSClientComms