integration test: initial commit of integration test framework

The adds in end-to-end testing of cloud-init. The framework utilizes
LXD and cloud images as a backend to test user-data passed in.
Arbitrary data is then captured from predefined commands specified
by the user. After collection, data verification is completed by
running a series of Python unit tests against the collected data.

Currently only the Ubuntu Trusty, Xenial, Yakkety, and Zesty
releases are supported. Test cases for 50% of the modules is
complete and available.

Additionally a Read the Docs file was created to guide test
writing and execution.

3 files changed, 104 insertions, 0 deletions

diff --git a/tests/cloud_tests/snapshots/__init__.py b/tests/cloud_tests/snapshots/__init__.py
new file mode 100644
index 00000000..2ab654de
--- /dev/null
+++ b/tests/cloud_tests/snapshots/__init__.py
@@ -0,0 +1,10 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+
+def get_snapshot(image):
+    """
+    get snapshot from image
+    """
+    return image.snapshot()
+
+# vi: ts=4 expandtab
diff --git a/tests/cloud_tests/snapshots/base.py b/tests/cloud_tests/snapshots/base.py
new file mode 100644
index 00000000..d715f037
--- /dev/null
+++ b/tests/cloud_tests/snapshots/base.py
@@ -0,0 +1,44 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+
+class Snapshot(object):
+    """
+    Base class for snapshots
+    """
+    platform_name = None
+
+    def __init__(self, properties, config):
+        """
+        Set up snapshot
+        """
+        self.properties = properties
+        self.config = config
+
+    def __str__(self):
+        """
+        a brief description of the snapshot
+        """
+        return '-'.join((self.properties['os'], self.properties['release']))
+
+    def launch(self, user_data, meta_data=None, block=True, start=True,
+               use_desc=None):
+        """
+        launch instance
+
+        user_data: user-data for the instance
+        instance_id: instance-id for the instance
+        block: wait until instance is created
+        start: start instance and wait until fully started
+        use_desc: description of snapshot instance use
+
+        return_value: an Instance
+        """
+        raise NotImplementedError
+
+    def destroy(self):
+        """
+        Clean up snapshot data
+        """
+        pass
+
+# vi: ts=4 expandtab
diff --git a/tests/cloud_tests/snapshots/lxd.py b/tests/cloud_tests/snapshots/lxd.py
new file mode 100644
index 00000000..eabbce3f
--- /dev/null
+++ b/tests/cloud_tests/snapshots/lxd.py
@@ -0,0 +1,50 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+from tests.cloud_tests.snapshots import base
+
+
+class LXDSnapshot(base.Snapshot):
+    """
+    LXD image copy backed snapshot
+    """
+    platform_name = "lxd"
+
+    def __init__(self, properties, config, platform, pylxd_frozen_instance):
+        """
+        Set up snapshot
+        """
+        self.platform = platform
+        self.pylxd_frozen_instance = pylxd_frozen_instance
+        super(LXDSnapshot, self).__init__(properties, config)
+
+    def launch(self, user_data, meta_data=None, block=True, start=True,
+               use_desc=None):
+        """
+        launch instance
+
+        user_data: user-data for the instance
+        instance_id: instance-id for the instance
+        block: wait until instance is created
+        start: start instance and wait until fully started
+        use_desc: description of snapshot instance use
+
+        return_value: an Instance
+        """
+        inst_config = {'user.user-data': user_data}
+        if meta_data:
+            inst_config['user.meta-data'] = meta_data
+        instance = self.platform.launch_container(
+            container=self.pylxd_frozen_instance.name, config=inst_config,
+            block=block, image_desc=str(self), use_desc=use_desc)
+        if start:
+            instance.start(wait=True, wait_time=self.config.get('timeout'))
+        return instance
+
+    def destroy(self):
+        """
+        Clean up snapshot data
+        """
+        self.pylxd_frozen_instance.destroy()
+        super(LXDSnapshot, self).destroy()
+
+# vi: ts=4 expandtab