From f53fc46aa732e3b29991b3e5e39da31a722945ee Mon Sep 17 00:00:00 2001
From: Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com>
Date: Thu, 22 Dec 2016 17:27:37 -0500
Subject: 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.
---
 tests/cloud_tests/testcases/base.py | 81 +++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 tests/cloud_tests/testcases/base.py

(limited to 'tests/cloud_tests/testcases/base.py')

diff --git a/tests/cloud_tests/testcases/base.py b/tests/cloud_tests/testcases/base.py
new file mode 100644
index 00000000..5395b9a3
--- /dev/null
+++ b/tests/cloud_tests/testcases/base.py
@@ -0,0 +1,81 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+from cloudinit import util as c_util
+
+import json
+import unittest
+
+
+class CloudTestCase(unittest.TestCase):
+    """
+    base test class for verifiers
+    """
+    data = None
+    conf = None
+    _cloud_config = None
+
+    @property
+    def cloud_config(self):
+        """
+        get the cloud-config used by the test
+        """
+        if not self._cloud_config:
+            self._cloud_config = c_util.load_yaml(self.conf)
+        return self._cloud_config
+
+    def get_config_entry(self, name):
+        """
+        get a config entry from cloud-config ensuring that it is present
+        """
+        if name not in self.cloud_config:
+            raise AssertionError('Key "{}" not in cloud config'.format(name))
+        return self.cloud_config[name]
+
+    def get_data_file(self, name):
+        """
+        get data file failing test if it is not present
+        """
+        if name not in self.data:
+            raise AssertionError('File "{}" missing from collect data'
+                                 .format(name))
+        return self.data[name]
+
+    def get_instance_id(self):
+        """
+        get recorded instance id
+        """
+        return self.get_data_file('instance-id').strip()
+
+    def get_status_data(self, data, version=None):
+        """
+        parse result.json and status.json like data files
+        data: data to load
+        version: cloud-init output version, defaults to 'v1'
+        return_value: dict of data or None if missing
+        """
+        if not version:
+            version = 'v1'
+        data = json.loads(data)
+        return data.get(version)
+
+    def get_datasource(self):
+        """
+        get datasource name
+        """
+        data = self.get_status_data(self.get_data_file('result.json'))
+        return data.get('datasource')
+
+    def test_no_stages_errors(self):
+        """
+        ensure that there were no errors in any stage
+        """
+        status = self.get_status_data(self.get_data_file('status.json'))
+        for stage in ('init', 'init-local', 'modules-config', 'modules-final'):
+            self.assertIn(stage, status)
+            self.assertEqual(len(status[stage]['errors']), 0,
+                             'errors {} were encountered in stage {}'
+                             .format(status[stage]['errors'], stage))
+        result = self.get_status_data(self.get_data_file('result.json'))
+        self.assertEqual(len(result['errors']), 0)
+
+# vi: ts=4 expandtab
-- 
cgit v1.2.3