[VVP] Adding onap-client intial commit.

This is supplementary tooling to interact with various ONAP applications.
It will be used by the OVP VNF Testcase, it's not deployed
with the ONAP platform.

Issue-ID: VVP-381
Change-Id: I2ff3952ba8f4b9448acb5a24717ccc3b1f0a92fe
Signed-off-by: stark, steven <steven.stark@att.com>

1 files changed, 134 insertions, 0 deletions

diff --git a/onap-client/onap_client/util.py b/onap-client/onap_client/util.py
new file mode 100644
index 0000000..d3148d0
--- /dev/null
+++ b/onap-client/onap_client/util.py
@@ -0,0 +1,134 @@
+# -*- coding: utf8 -*-
+# ============LICENSE_START=======================================================
+# org.onap.vvp/validation-scripts
+# ===================================================================
+# Copyright © 2020 AT&T Intellectual Property. All rights reserved.
+# ===================================================================
+#
+# Unless otherwise specified, all software contained herein is licensed
+# under the Apache License, Version 2.0 (the "License");
+# you may not use this software 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.
+#
+#
+#
+# Unless otherwise specified, all documentation contained herein is licensed
+# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
+# you may not use this documentation except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#             https://creativecommons.org/licenses/by/4.0/
+#
+# Unless required by applicable law or agreed to in writing, documentation
+# 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.
+#
+# ============LICENSE_END============================================
+
+import json
+from prettytable import PrettyTable
+
+
+def utility_cli(onap_client, cli_arguments):
+    functions = onap_client.utility_functions
+
+    if len(cli_arguments) == 0 or cli_arguments[0] == "--help":
+        help(functions)
+    else:
+        while cli_arguments:
+            argument = cli_arguments.pop(0)
+
+            if argument == "--help":
+                help(functions)
+                return
+
+            argument = convert_to_underscores(argument)
+            functions = functions.get(argument)
+            if not functions:
+                print("Invalid argument {}. Try --help.".format(argument))
+                return
+
+            if callable(functions):
+                if cli_arguments[0] == "--help":
+                    help(functions)
+                    return
+
+                if functions.__code__.co_argcount != len(cli_arguments):
+                    print(
+                        "Function requires {} arguments, but {} were passed. Try --help.".format(
+                            functions.__code__.co_argcount, len(cli_arguments)
+                        )
+                    )
+                    return
+
+                return_data = functions(*cli_arguments[0:])
+                if isinstance(return_data, str):
+                    print(return_data)
+                elif isinstance(return_data, dict) or isinstance(return_data, list):
+                    print(json.dumps(return_data, indent=4))
+
+                return
+
+
+def convert_to_underscores(argument):
+    return argument.replace("-", "_")
+
+
+def convert_to_dash(argument):
+    return argument.replace("_", "-")
+
+
+def help(functions):
+    actions = {}
+    actions["--help"] = ("", "")
+    if isinstance(functions, dict):
+        for k, v in functions.items():
+            actions[convert_to_dash(k)] = (
+                v.__doc__,
+                list(v.__code__.co_varnames[: v.__code__.co_argcount]),
+            )
+    elif callable(functions):
+        actions[convert_to_dash(functions.__name__)] = (
+            functions.__doc__,
+            list(functions.__code__.co_varnames[: functions.__code__.co_argcount]),
+        )
+
+    print(help_table(actions))
+
+
+def help_table(actions):
+    x = PrettyTable()
+
+    x.field_names = [
+        "name",
+        "description",
+        "parameters",
+    ]
+    x.align["name"] = "l"
+    x.align["description"] = "l"
+    x.align["parameters"] = "l"
+
+    for action, data in actions.items():
+        name = action
+        description = data[0]
+        parameters = []
+        parameters.extend("<{}>".format(x) for x in data[1])
+        x.add_row([name, description, "\n".join(parameters)])
+        x.add_row(["", "", ""])
+
+    return x
+
+
+def utility(func):
+    func.utility_function = True
+    return func