testbeds: Add docker testbed

This adds support for a testbed based on Docker containers running on
the local host. Bridging the containers can be done using built-in
Linux bridging or using OpenVSwitch bridges.

A new resource 'executor' has been added to abstract away command
execution on nodes on the testbed. Executors have been created for
local command execution, docker exec based command execution and
SSH-based command execution. This has also been changed in the
prototypes to execute using the correct executor.

4 files changed, 225 insertions, 0 deletions

diff --git a/rumba/executors/__init__.py b/rumba/executors/__init__.py
new file mode 100644
index 0000000..58fcfb5
--- /dev/null
+++ b/rumba/executors/__init__.py
@@ -0,0 +1,26 @@
+#
+# A library to manage ARCFIRE experiments
+#
+#    Copyright (C) 2017 Nextworks S.r.l.
+#    Copyright (C) 2017 imec
+#
+#    Sander Vrijders   <sander.vrijders@ugent.be>
+#    Dimitri Staessens <dimitri.staessens@ugent.be>
+#    Vincenzo Maffione <v.maffione@nextworks.it>
+#    Marco Capitani    <m.capitani@nextworks.it>
+#    Nick Aerts        <nick.aerts@ugent.be>
+#
+# This library 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., http://www.fsf.org/about/contact/.
+#
diff --git a/rumba/executors/docker.py b/rumba/executors/docker.py
new file mode 100644
index 0000000..e1e1480
--- /dev/null
+++ b/rumba/executors/docker.py
@@ -0,0 +1,80 @@
+#
+# A library to manage ARCFIRE experiments
+#
+#    Copyright (C) 2017 Nextworks S.r.l.
+#    Copyright (C) 2017 imec
+#
+#    Sander Vrijders   <sander.vrijders@ugent.be>
+#    Dimitri Staessens <dimitri.staessens@ugent.be>
+#    Vincenzo Maffione <v.maffione@nextworks.it>
+#    Marco Capitani    <m.capitani@nextworks.it>
+#    Nick Aerts        <nick.aerts@ugent.be>
+#
+# This library 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., http://www.fsf.org/about/contact/.
+#
+
+from rumba import model as mod
+
+import tempfile
+import tarfile
+
+from rumba import log
+
+logger = log.get_logger(__name__)
+
+
+class DockerException(Exception):
+    pass
+
+
+class DockerExecutor(mod.Executor):
+    def __init__(self, testbed):
+        self.testbed = testbed
+        self.running_containers = testbed.running_containers
+
+    def execute_command(self, node, command, sudo=False, time_out=3):
+        logger.debug("%s >> %s" % (node.name, command))
+
+        c, o = self.running_containers[node.name].exec_run(["sh", "-c",
+                                                            command])
+        if c:
+            raise DockerException('A remote command returned an error. '
+                                  'Output:\n\n\t' + o.decode("utf-8"))
+
+        return o.decode("utf-8")
+
+    def fetch_file(self, node, path, destination, as_root=False):
+        if not path.startswith("/"):
+            workingdir = self.running_containers[node.name].attrs["Config"][
+                "WorkingDir"]
+            path = os.path.join(workingdir, path)
+
+        try:
+            with tempfile.NamedTemporaryFile() as tmp:
+                archive, _ = self.running_containers[node.name].get_archive(
+                    path)
+
+                for c in archive:
+                    tmp.write(c)
+
+                tmp.seek(0)
+
+                tarfile.TarFile(fileobj=tmp, mode='r').extract(
+                    path.basename(path), destination)
+        except:
+            logger.error("Error when extracting %s" % path)
+
+    def copy_file(self, node, path, destination):
+        pass
diff --git a/rumba/executors/local.py b/rumba/executors/local.py
new file mode 100644
index 0000000..9f3f484
--- /dev/null
+++ b/rumba/executors/local.py
@@ -0,0 +1,55 @@
+#
+# A library to manage ARCFIRE experiments
+#
+#    Copyright (C) 2017 Nextworks S.r.l.
+#    Copyright (C) 2017 imec
+#
+#    Sander Vrijders   <sander.vrijders@ugent.be>
+#    Dimitri Staessens <dimitri.staessens@ugent.be>
+#    Vincenzo Maffione <v.maffione@nextworks.it>
+#    Marco Capitani    <m.capitani@nextworks.it>
+#    Nick Aerts        <nick.aerts@ugent.be>
+#
+# This library 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., http://www.fsf.org/about/contact/.
+#
+
+from rumba import model as mod
+
+import subprocess
+
+from rumba import log
+
+logger = log.get_logger(__name__)
+
+
+class LocalExecutor(mod.Executor):
+    def __init__(self, testbed):
+        self.testbed = testbed
+
+    def execute_command(self, node, cmd, sudo=False, time_out=3):
+        try:
+            logger.debug("%s >> %s" % (node.name, cmd))
+            subprocess.check_call(cmd.split(' '))
+        except subprocess.CalledProcessError as e:
+            logger.error("Return code was " + str(e.returncode))
+            raise
+
+    def fetch_file(self, node, path, destination, as_root=False):
+        logger.error("Fetch_file not supported for local testbed")
+        raise
+
+    def copy_file(self, node, path, destination):
+        logger.error("Copy_file not supported for local testbed")
+        raise
diff --git a/rumba/executors/ssh.py b/rumba/executors/ssh.py
new file mode 100644
index 0000000..6a3a41d
--- /dev/null
+++ b/rumba/executors/ssh.py
@@ -0,0 +1,64 @@
+#
+# A library to manage ARCFIRE experiments
+#
+#    Copyright (C) 2017 Nextworks S.r.l.
+#    Copyright (C) 2017 imec
+#
+#    Sander Vrijders   <sander.vrijders@ugent.be>
+#    Dimitri Staessens <dimitri.staessens@ugent.be>
+#    Vincenzo Maffione <v.maffione@nextworks.it>
+#    Marco Capitani    <m.capitani@nextworks.it>
+#    Nick Aerts        <nick.aerts@ugent.be>
+#
+# This library 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., http://www.fsf.org/about/contact/.
+#
+
+from rumba.model import Executor
+from rumba.ssh_support import execute_command, execute_commands, \
+    copy_file_to_testbed, copy_file_from_testbed, execute_proxy_command, \
+    execute_proxy_commands
+
+
+class SSHExecutor(Executor):
+    def __init__(self, testbed, use_proxy=False):
+        self.testbed = testbed
+        self.use_proxy = use_proxy
+
+    def execute_command(self, node, command, as_root=False, time_out=3):
+        if as_root:
+            if node.ssh_config.username != 'root':
+                command = "sudo %s" % command
+
+        if self.use_proxy:
+            return execute_proxy_command(self, node.ssh_config, command,
+                                         time_out)
+        else:
+            return execute_command(self.testbed, node.ssh_config, command,
+                                   time_out)
+
+    def execute_commands(self, node, commands, as_root=False, time_out=3):
+        if self.use_proxy:
+            return execute_proxy_commands(self, node.ssh_config, commands,
+                                          time_out)
+        else:
+            return execute_commands(self.testbed, node.ssh_config, commands,
+                                    time_out)
+
+    def fetch_file(self, node, path, destination, sudo):
+        copy_file_from_testbed(self.testbed, node.ssh_config, path,
+                               destination, sudo)
+
+    def copy_file(self, node, path, destination):
+        copy_file_to_testbed(self.testbed, node.ssh_config, path, destination)
\ No newline at end of file