aboutsummaryrefslogtreecommitdiffstats
path: root/onap-client/onap_client/util.py
blob: d3148d065855a9307f04261b55922ecc9c269861 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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