1 files changed, 120 insertions, 0 deletions
diff --git a/openstackclient/tests/functional/base.py b/openstackclient/tests/functional/base.py
new file mode 100644
index 00000000..f7f0361e
--- /dev/null
+++ b/openstackclient/tests/functional/base.py
@@ -0,0 +1,120 @@
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import os
+import re
+import shlex
+import subprocess
+import testtools
+
+import six
+from tempest.lib.cli import output_parser
+from tempest.lib import exceptions
+
+
+COMMON_DIR = os.path.dirname(os.path.abspath(__file__))
+FUNCTIONAL_DIR = os.path.normpath(os.path.join(COMMON_DIR, '..'))
+ROOT_DIR = os.path.normpath(os.path.join(FUNCTIONAL_DIR, '..'))
+EXAMPLE_DIR = os.path.join(ROOT_DIR, 'examples')
+
+
+def execute(cmd, fail_ok=False, merge_stderr=False):
+    """Executes specified command for the given action."""
+    cmdlist = shlex.split(cmd)
+    result = ''
+    result_err = ''
+    stdout = subprocess.PIPE
+    stderr = subprocess.STDOUT if merge_stderr else subprocess.PIPE
+    proc = subprocess.Popen(cmdlist, stdout=stdout, stderr=stderr)
+    result, result_err = proc.communicate()
+    result = result.decode('utf-8')
+    if not fail_ok and proc.returncode != 0:
+        raise exceptions.CommandFailed(proc.returncode, cmd, result,
+                                       result_err)
+    return result
+
+
+class TestCase(testtools.TestCase):
+
+    delimiter_line = re.compile('^\+\-[\+\-]+\-\+$')
+
+    @classmethod
+    def openstack(cls, cmd, fail_ok=False):
+        """Executes openstackclient command for the given action."""
+        return execute('openstack ' + cmd, fail_ok=fail_ok)
+
+    @classmethod
+    def get_openstack_configuration_value(cls, configuration):
+        opts = cls.get_opts([configuration])
+        return cls.openstack('configuration show ' + opts)
+
+    @classmethod
+    def get_opts(cls, fields, format='value'):
+        return ' -f {0} {1}'.format(format,
+                                    ' '.join(['-c ' + it for it in fields]))
+
+    @classmethod
+    def assertOutput(cls, expected, actual):
+        if expected != actual:
+            raise Exception(expected + ' != ' + actual)
+
+    @classmethod
+    def assertInOutput(cls, expected, actual):
+        if expected not in actual:
+            raise Exception(expected + ' not in ' + actual)
+
+    def assert_table_structure(self, items, field_names):
+        """Verify that all items have keys listed in field_names."""
+        for item in items:
+            for field in field_names:
+                self.assertIn(field, item)
+
+    def assert_show_fields(self, items, field_names):
+        """Verify that all items have keys listed in field_names."""
+        for item in items:
+            for key in six.iterkeys(item):
+                self.assertIn(key, field_names)
+
+    def assert_show_structure(self, items, field_names):
+        """Verify that all field_names listed in keys of all items."""
+        if isinstance(items, list):
+            o = {}
+            for d in items:
+                o.update(d)
+        else:
+            o = items
+        item_keys = o.keys()
+        for field in field_names:
+            self.assertIn(field, item_keys)
+
+    def parse_show_as_object(self, raw_output):
+        """Return a dict with values parsed from cli output."""
+        items = self.parse_show(raw_output)
+        o = {}
+        for item in items:
+            o.update(item)
+        return o
+
+    def parse_show(self, raw_output):
+        """Return list of dicts with item values parsed from cli output."""
+
+        items = []
+        table_ = output_parser.table(raw_output)
+        for row in table_['values']:
+            item = {}
+            item[row[0]] = row[1]
+            items.append(item)
+        return items
+
+    def parse_listing(self, raw_output):
+        """Return list of dicts with basic item parsed from cli output."""
+        return output_parser.listing(raw_output)