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.

1 files changed, 49 insertions, 0 deletions

diff --git a/tests/cloud_tests/testcases/examples/alter_completion_message.py b/tests/cloud_tests/testcases/examples/alter_completion_message.py
new file mode 100644
index 00000000..b06ad01b
--- /dev/null
+++ b/tests/cloud_tests/testcases/examples/alter_completion_message.py
@@ -0,0 +1,49 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+"""cloud-init Integration Test Verify Script"""
+from tests.cloud_tests.testcases import base
+
+
+class TestFinalMessage(base.CloudTestCase):
+    """
+    test cloud init module `cc_final_message`
+    """
+    subs_char = '$'
+
+    def get_final_message_config(self):
+        """
+        get config for final message
+        """
+        self.assertIn('final_message', self.cloud_config)
+        return self.cloud_config['final_message']
+
+    def get_final_message(self):
+        """
+        get final message from log
+        """
+        out = self.get_data_file('cloud-init-output.log')
+        lines = len(self.get_final_message_config().splitlines())
+        return '\n'.join(out.splitlines()[-1 * lines:])
+
+    def test_final_message_string(self):
+        """
+        ensure final handles regular strings
+        """
+        for actual, config in zip(
+                self.get_final_message().splitlines(),
+                self.get_final_message_config().splitlines()):
+            if self.subs_char not in config:
+                self.assertEqual(actual, config)
+
+    def test_final_message_subs(self):
+        """
+        test variable substitution in final message
+        """
+        # TODO: add verification of other substitutions
+        patterns = {'$datasource': self.get_datasource()}
+        for key, expected in patterns.items():
+            index = self.get_final_message_config().splitlines().index(key)
+            actual = self.get_final_message().splitlines()[index]
+            self.assertEqual(actual, expected)
+
+# vi: ts=4 expandtab