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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
# -*- 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 onap_client
import pkgutil
import inspect
import sys
import os
import importlib
from abc import ABC, abstractmethod
from datetime import datetime
from onap_client.lib import make_request
from onap_client import config, exceptions
CACHED_MODULES = {}
def get_modules():
catalog = sys.modules[__name__]
if not catalog.CACHED_MODULES:
catalog.CACHED_MODULES = import_submodules(onap_client)
return catalog.CACHED_MODULES
class Catalog(ABC):
"""Abstract class for an ONAP client, automatically loads
child classes as attributes."""
class CallHandle:
"""Attached as an attribute for each catalog entry in a catalog.
Used to make a request to ONAP."""
def __init__(self, catalog_resource, response_callback=None, verify=False):
self.resource = catalog_resource
self.verify_request = verify
self.callback = response_callback if response_callback else self.empty_callback
def empty_callback(self, *args, **kwargs):
pass
def __call__(self, **kwargs):
self.callback(message=f"Submitting request: {self.resource.description}")
response_handler = make_request(self.resource, self.verify_request, **kwargs)
self.callback(response_handler=response_handler)
if not response_handler.success:
self.callback(message=f"Request Failure: {self.resource.catalog_resource_name} {response_handler.response_data}")
raise exceptions.RequestFailure(
"Failed making request for catalog item {}: {}".format(
self.resource.catalog_resource_name,
response_handler.response_data
)
)
self.callback(message="Request was Successful")
return response_handler
def __init__(
self,
config_file=None,
history_buffer=[],
**kwargs
):
"""Iterates through all child classes and attaches them as attributes, named
after the namespace property.
If the child Catalog class has items in the
catalog_resources property, they will be added as attributes to the child attribute
as a CallHandle object.
"""
if not config_file:
config_file = os.environ.get("OC_CONFIG") or "/etc/onap_client/config.yaml"
self.catalog_items = {}
self.modules = get_modules()
self._config_overrides = kwargs
self.history = history_buffer
if not self.history:
self.add_to_history("Creating ONAP Client...")
for cls in self.__class__.__subclasses__():
subclass = cls(config_file=config_file, history_buffer=self.history, **kwargs)
namespace = subclass.namespace
catalog_resources = subclass.catalog_resources
for k, v in catalog_resources.items():
subclass.load(k, v)
setattr(self, namespace, subclass)
self.set_config(config_file)
def load(self, item_name, resource_data, verify=False):
"""Consume a catalog resource entry as an APICatalogResource,
and set it as an attribute on this.class as a CallHandle object"""
resource = APICatalogResource(item_name, resource_data)
self.catalog_items[item_name] = resource
callback = self.add_to_history
setattr(self, item_name.lower(), self.CallHandle(resource, response_callback=callback, verify=verify))
def add_to_history(self, message="", response_handler=None):
if response_handler:
request_object = response_handler.request_object
request_data = {}
if request_object.verb:
request_data["method"] = request_object.verb
if request_object.uri:
request_data["url"] = request_object.uri
if request_object.headers:
request_data["headers"] = request_object.headers
if request_object.payload:
request_data["data"] = request_object.payload
if request_object.files:
request_data["files"] = str(request_object.files)
message = request_data
self.add_message_to_history(message)
def add_message_to_history(self, message):
current_time = datetime.now()
history_message = {
"date": f"{current_time}",
"message": message
}
self.history.append(history_message)
@property
@abstractmethod
def namespace(self):
raise NotImplementedError
@property
@abstractmethod
def catalog_resources(self):
raise NotImplementedError
@property
def utility_functions(self):
utility_functions = {}
for module_name, module in self.modules.items():
all_functions = inspect.getmembers(module, inspect.isfunction)
for func in all_functions:
function = func[1]
if hasattr(function, "utility_function"):
utility_functions[func[0]] = func[1]
return utility_functions
def set_config(self, config_file):
self.config = config.load_config(config_file, "onap_client")
verify = self.config.REQUESTS_VERIFY
for attr_name, attr in self.__dict__.items():
if isinstance(attr, Catalog):
attr.set_config(config_file)
for k, v in attr.catalog_resources.items():
attr.load(k, v, verify=verify)
def override(override_key):
def decorator(func):
def override_check(self):
o = self._config_overrides.get(override_key)
return o if o else func(self)
return override_check
return decorator
class APICatalogResource:
"""Class representation of a single catalog entry"""
def __init__(self, catalog_resource_name, resource_data):
"""
:catalog_resource_name: name of the catalog resource
:resource_data: dictionary containing catalog resource attributes
"""
self.catalog_resource_name = catalog_resource_name
self.catalog_resource_data = resource_data
@property
def verb(self):
return self.catalog_resource_data.get("verb", None)
@property
def description(self):
return self.catalog_resource_data.get("description", None)
@property
def uri(self):
return self.catalog_resource_data.get("uri", None)
@property
def payload(self):
return self.catalog_resource_data.get("payload", None)
@property
def uri_parameters(self):
return self.catalog_resource_data.get("uri-parameters", [])
@property
def payload_parameters(self):
return self.catalog_resource_data.get("payload-parameters", [])
@property
def payload_path(self):
return self.catalog_resource_data.get("payload-path", [])
@property
def file_parameters(self):
return self.catalog_resource_data.get("files-parameters", [])
@property
def header_parameters(self):
return self.catalog_resource_data.get("header_parameters", [])
@property
def success_code(self):
return self.catalog_resource_data.get("success_code", None)
@property
def headers(self):
return self.catalog_resource_data.get("headers", None)
@property
def return_data(self):
return self.catalog_resource_data.get("return_data", {})
@property
def auth(self):
return self.catalog_resource_data.get("auth", None)
def import_submodules(package, recursive=True):
"""Import all the modules in onap-client, except for those starting
with tests*. This is needed so that the Client object can register child classes"""
if isinstance(package, str):
package = importlib.import_module(package)
results = {}
for loader, name, is_pkg in pkgutil.walk_packages(package.__path__):
full_name = package.__name__ + "." + name
if full_name.find("tests") == -1:
results[full_name] = importlib.import_module(full_name)
if recursive and is_pkg:
results.update(import_submodules(full_name))
return results
|
