API proposal for functest

1. Propose a basic framework for API
2. And these functions have been realized:
   1) Show environment
   2) Prepare Environment
   3) Show credentials
   4) List all testcases
   5) Show a testcase
   6) List all tiers
   7) Show a tier
   8) List all testcases within given tier

JIRA: FUNCTEST-843

Change-Id: Ib961446708077b56465eda0052f6d38806b62594
Signed-off-by: Linda Wang <wangwulin@huawei.com>

4 files changed, 96 insertions, 31 deletions

diff --git a/functest/cli/commands/cli_env.py b/functest/cli/commands/cli_env.py
index 99d36996..72a870b5 100644
--- a/functest/cli/commands/cli_env.py
+++ b/functest/cli/commands/cli_env.py
@@ -16,7 +16,7 @@ from functest.utils.constants import CONST
 import functest.utils.functest_utils as ft_utils
 
 
-class CliEnv(object):
+class Env(object):
 
     def __init__(self):
         pass
@@ -56,17 +56,14 @@ class CliEnv(object):
         if self.status(verbose=False) == 0:
             STATUS = "ready"
 
-        msg = prettytable.PrettyTable(
-            header_style='upper', padding_width=5,
-            field_names=['Functest Environment', 'value'])
-        msg.add_row(['INSTALLER', installer_info])
-        msg.add_row(['SCENARIO', scenario])
-        msg.add_row(['POD', node])
-        if build_tag:
-            msg.add_row(['BUILD TAG', build_tag])
-        msg.add_row(['DEBUG FLAG', is_debug])
-        msg.add_row(['STATUS', STATUS])
-        click.echo(msg.get_string())
+        env_info = {'INSTALLER': installer_info,
+                    'SCENARIO': scenario,
+                    'POD': node,
+                    'DEBUG FLAG': is_debug,
+                    'BUILD_TAG': build_tag,
+                    'STATUS': STATUS}
+
+        return env_info
 
     def status(self, verbose=True):
         ret_val = 0
@@ -78,3 +75,19 @@ class CliEnv(object):
             click.echo("Functest environment ready to run tests.\n")
 
         return ret_val
+
+
+class CliEnv(Env):
+
+    def __init__(self):
+        super(CliEnv, self).__init__()
+
+    def show(self):
+        env_info = super(CliEnv, self).show()
+        msg = prettytable.PrettyTable(
+            header_style='upper', padding_width=5,
+            field_names=['Functest Environment', 'value'])
+        for key, value in env_info.iteritems():
+            if key is not None:
+                msg.add_row([key, value])
+        click.echo(msg.get_string())
diff --git a/functest/cli/commands/cli_os.py b/functest/cli/commands/cli_os.py
index f4ec1661..e97ab080 100644
--- a/functest/cli/commands/cli_os.py
+++ b/functest/cli/commands/cli_os.py
@@ -18,7 +18,7 @@ import functest.utils.openstack_clean as os_clean
 import functest.utils.openstack_snapshot as os_snapshot
 
 
-class CliOpenStack(object):
+class OpenStack(object):
 
     def __init__(self):
         self.os_auth_url = CONST.__getattribute__('OS_AUTH_URL')
@@ -43,9 +43,11 @@ class CliOpenStack(object):
 
     @staticmethod
     def show_credentials():
+        dic_credentials = {}
         for key, value in os.environ.items():
             if key.startswith('OS_'):
-                click.echo("{}={}".format(key, value))
+                dic_credentials.update({key: value})
+        return dic_credentials
 
     def check(self):
         self.ping_endpoint()
@@ -88,3 +90,16 @@ class CliOpenStack(object):
                        "'functest openstack snapshot-create'")
             return
         os_clean.main()
+
+
+class CliOpenStack(OpenStack):
+
+    def __init__(self):
+        super(CliOpenStack, self).__init__()
+
+    @staticmethod
+    def show_credentials():
+        dic_credentials = OpenStack.show_credentials()
+        for key, value in dic_credentials.items():
+                if key.startswith('OS_'):
+                    click.echo("{}={}".format(key, value))
diff --git a/functest/cli/commands/cli_testcase.py b/functest/cli/commands/cli_testcase.py
index cb3d4739..65dd9ab7 100644
--- a/functest/cli/commands/cli_testcase.py
+++ b/functest/cli/commands/cli_testcase.py
@@ -20,7 +20,7 @@ import functest.utils.functest_utils as ft_utils
 import functest.utils.functest_vacation as vacation
 
 
-class CliTestcase(object):
+class Testcase(object):
 
     def __init__(self):
         self.tiers = tb.TierBuilder(
@@ -33,15 +33,11 @@ class CliTestcase(object):
         for tier in self.tiers.get_tiers():
             for test in tier.get_tests():
                 summary += (" %s\n" % test.get_name())
-        click.echo(summary)
+        return summary
 
     def show(self, testname):
         description = self.tiers.get_test(testname)
-        if description is None:
-            click.echo("The test case '%s' does not exist or is not supported."
-                       % testname)
-
-        click.echo(description)
+        return description
 
     @staticmethod
     def run(testname, noclean=False, report=False):
@@ -62,3 +58,20 @@ class CliTestcase(object):
             for test in tests:
                 cmd = "run_tests {}-t {}".format(flags, test)
                 ft_utils.execute_command(cmd)
+
+
+class CliTestcase(Testcase):
+
+    def __init__(self):
+        super(CliTestcase, self).__init__()
+
+    def list(self):
+        click.echo(super(CliTestcase, self).list())
+
+    def show(self, testname):
+        testcase_show = super(CliTestcase, self).show(testname)
+        if testcase_show:
+            click.echo(testcase_show)
+        else:
+            click.echo("The test case '%s' does not exist or is not supported."
+                       % testname)
diff --git a/functest/cli/commands/cli_tier.py b/functest/cli/commands/cli_tier.py
index 9b2e60ba..995354bb 100644
--- a/functest/cli/commands/cli_tier.py
+++ b/functest/cli/commands/cli_tier.py
@@ -19,7 +19,7 @@ from functest.utils.constants import CONST
 import functest.utils.functest_utils as ft_utils
 
 
-class CliTier(object):
+class Tier(object):
 
     def __init__(self):
         self.tiers = tb.TierBuilder(
@@ -34,26 +34,23 @@ class CliTier(object):
                         % (tier.get_order(),
                            tier.get_name(),
                            tier.get_test_names()))
-        click.echo(summary)
+        return summary
 
     def show(self, tiername):
         tier = self.tiers.get_tier(tiername)
         if tier is None:
-            tier_names = self.tiers.get_tier_names()
-            click.echo("The tier with name '%s' does not exist. "
-                       "Available tiers are:\n  %s\n" % (tiername, tier_names))
+            return None
         else:
-            click.echo(self.tiers.get_tier(tiername))
+            tier_info = self.tiers.get_tier(tiername)
+            return tier_info
 
     def gettests(self, tiername):
         tier = self.tiers.get_tier(tiername)
         if tier is None:
-            tier_names = self.tiers.get_tier_names()
-            click.echo("The tier with name '%s' does not exist. "
-                       "Available tiers are:\n  %s\n" % (tiername, tier_names))
+            return None
         else:
             tests = tier.get_test_names()
-            click.echo("Test cases in tier '%s':\n %s\n" % (tiername, tests))
+            return tests
 
     @staticmethod
     def run(tiername, noclean=False, report=False):
@@ -70,3 +67,30 @@ class CliTier(object):
         else:
             cmd = "run_tests {}-t {}".format(flags, tiername)
             ft_utils.execute_command(cmd)
+
+
+class CliTier(Tier):
+
+    def __init__(self):
+        super(CliTier, self).__init__()
+
+    def list(self):
+        click.echo(super(CliTier, self).list())
+
+    def show(self, tiername):
+        tier_info = super(CliTier, self).show(tiername)
+        if tier_info:
+            click.echo(tier_info)
+        else:
+            tier_names = self.tiers.get_tier_names()
+            click.echo("The tier with name '%s' does not exist. "
+                       "Available tiers are:\n  %s\n" % (tiername, tier_names))
+
+    def gettests(self, tiername):
+        tests = super(CliTier, self).gettests(tiername)
+        if tests:
+            click.echo("Test cases in tier '%s':\n %s\n" % (tiername, tests))
+        else:
+            tier_names = self.tiers.get_tier_names()
+            click.echo("The tier with name '%s' does not exist. "
+                       "Available tiers are:\n  %s\n" % (tiername, tier_names))