1 files changed, 99 insertions, 0 deletions
diff --git a/kernelci/lab/__init__.py b/kernelci/lab/__init__.py
new file mode 100644
index 0000000..d70e44d
--- /dev/null
+++ b/kernelci/lab/__init__.py
@@ -0,0 +1,99 @@
+# Copyright (C) 2019 Collabora Limited
+# Author: Guillaume Tucker <guillaume.tucker@collabora.com>
+#
+# This module is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
+# any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+import importlib
+import json
+import urlparse
+import xmlrpclib
+
+
+class LabAPI(object):
+    """Remote API to a test lab"""
+
+    def __init__(self, config):
+        """A test lab API object can be used to remotely interact with a lab
+
+        *config* is a kernelci.config.lab.Lab object
+        """
+        self._config = config
+        self._server = None
+        self._devices = None
+
+    @property
+    def config(self):
+        return self._config
+
+    @property
+    def devices(self):
+        if self._devices is None:
+            self._devices = self._get_devices()
+        return self._devices
+
+    def _get_devices(self):
+        return list()
+
+    def connect(self, user=None, token=None):
+        """Connect to the remote server API
+
+        *user* is the name of the user to connect to the lab
+        *token* is the token associated with the user to connect to the lab
+        """
+        if user and token:
+            url = urlparse.urlparse(self.config.url)
+            api_url = "{scheme}://{user}:{token}@{loc}{path}".format(
+                scheme=url.scheme, user=user, token=token,
+                loc=url.netloc, path=url.path)
+        else:
+            api_url = self.config.url
+        self._server = xmlrpclib.ServerProxy(api_url)
+
+    def import_devices(self, data):
+        self._devices = data
+
+    def device_type_online(self, device_type_name):
+        return True
+
+    def job_file_name(self, params):
+        return params['name']
+
+    def match(self, filter_data):
+        return self.config.match(filter_data)
+
+    def generate(self, params, target, plan, callback_opts):
+        raise NotImplementedError("Lab.generate() is required")
+
+    def submit(self, job):
+        raise NotImplementedError("Lab.submit() is required")
+
+
+def get_api(lab, user=None, token=None, lab_json=None):
+    """Get the LabAPI object for a given lab config.
+
+    *lab* is a kernelci.config.lab.Lab object
+    *user* is the name of the user to connect to the remote lab
+    *token* is the associated token to connect to the remote lab
+    *lab_json* is the path to a JSON file with cached lab information
+    """
+    m = importlib.import_module('.'.join(['kernelci', 'lab', lab.lab_type]))
+    api = m.get_api(lab)
+    if lab_json:
+        with open(lab_json) as json_file:
+            devices = json.load(json_file)['devices']
+            api.import_devices(devices)
+    if user and token:
+        api.connect(user, token)
+    return api