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
|
# http://www.apache.org/licenses/LICENSE-2.0
"""CDS onboard module."""
from abc import ABC
from pathlib import Path
from typing import Any, Dict
from kubernetes import client, config
from kubernetes.client.exceptions import ApiException
from onapsdk.cds import Blueprint, DataDictionarySet
from onapsdk.cds.blueprint import Workflow
from onapsdk.cds.blueprint_processor import Blueprintprocessor
from onapsdk.configuration import settings
import urllib3
from onaptests.steps.base import BaseStep
from onaptests.utils.exceptions import OnapTestException
class CDSBaseStep(BaseStep, ABC):
"""Abstract CDS base step."""
@property
def component(self) -> str:
"""Component name."""
return "CDS"
class ExposeCDSBlueprintprocessorNodePortStep(CDSBaseStep):
"""Expose CDS blueprintsprocessor port."""
def __init__(self, cleanup: bool) -> None:
"""Initialize step."""
super().__init__(cleanup=cleanup)
self.service_name: str = "cds-blueprints-processor-http"
config.load_kube_config(settings.K8S_CONFIG)
self.k8s_client: client.CoreV1Api = client.CoreV1Api()
@property
def description(self) -> str:
"""Step description."""
return "Expose CDS blueprintsprocessor NodePort."
def is_service_node_port_type(self) -> bool:
"""Check if CDS blueprints processor service type is 'NodePort'
Raises:
OnapTestException: Kubernetes API error
Returns:
bool: True if service type is 'NodePort', False otherwise
"""
try:
service_data: Dict[str, Any] = self.k8s_client.read_namespaced_service(
self.service_name,
settings.K8S_ONAP_NAMESPACE
)
return service_data.spec.type == "NodePort"
except ApiException:
self._logger.exception("Kubernetes API exception")
raise OnapTestException
@BaseStep.store_state
def execute(self) -> None:
"""Expose CDS blueprintprocessor port using kubernetes client.
Use settings values:
- K8S_CONFIG,
- K8S_ONAP_NAMESPACE.
- EXPOSE_SERVICES_NODE_PORTS
"""
super().execute()
if not self.is_service_node_port_type():
try:
self.k8s_client.patch_namespaced_service(
self.service_name,
settings.K8S_ONAP_NAMESPACE,
{"spec": {"ports": [{"port": 8080, "nodePort": 30449}], "type": "NodePort"}}
)
except ApiException:
self._logger.exception("Kubernetes API exception")
raise OnapTestException
except urllib3.exceptions.HTTPError:
self._logger.exception("Can't connect with k8s")
raise OnapTestException
else:
self._logger.debug("Service already patched, skip")
def cleanup(self) -> None:
"""Step cleanup.
Restore CDS blueprintprocessor service.
"""
if self.is_service_node_port_type():
try:
self.k8s_client.patch_namespaced_service(
self.service_name,
settings.K8S_ONAP_NAMESPACE,
[
{
"op": "remove",
"path": "/spec/ports/0/nodePort"
},
{
"op": "replace",
"path": "/spec/type",
"value": "ClusterIP"
}
]
)
except ApiException:
self._logger.exception("Kubernetes API exception")
raise OnapTestException
except urllib3.exceptions.HTTPError:
self._logger.exception("Can't connect with k8s")
raise OnapTestException
else:
self._logger.debug("Service is not 'NodePort' type, skip")
return super().cleanup()
class BootstrapBlueprintprocessor(CDSBaseStep):
"""Bootstrap blueprintsprocessor."""
def __init__(self, cleanup: bool = False) -> None:
"""Initialize step.
Substeps:
- ExposeCDSBlueprintprocessorNodePortStep.
"""
super().__init__(cleanup=cleanup)
if settings.EXPOSE_SERVICES_NODE_PORTS:
self.add_step(ExposeCDSBlueprintprocessorNodePortStep(cleanup=cleanup))
@property
def description(self) -> str:
"""Step description."""
return "Bootstrap CDS blueprintprocessor"
@BaseStep.store_state
def execute(self) -> None:
"""Bootsrap CDS blueprintprocessor."""
super().execute()
Blueprintprocessor.bootstrap()
class DataDictionaryUploadStep(CDSBaseStep):
"""Upload data dictionaries to CDS step."""
def __init__(self, cleanup: bool = False) -> None:
"""Initialize data dictionary upload step."""
super().__init__(cleanup=cleanup)
self.add_step(BootstrapBlueprintprocessor(cleanup=cleanup))
@property
def description(self) -> str:
"""Step description."""
return "Upload data dictionaries to CDS."
@BaseStep.store_state
def execute(self) -> None:
"""Upload data dictionary to CDS.
Use settings values:
- CDS_DD_FILE.
"""
super().execute()
dd_set: DataDictionarySet = DataDictionarySet.load_from_file(settings.CDS_DD_FILE)
dd_set.upload()
class CbaEnrichStep(CDSBaseStep):
"""Enrich CBA file step."""
def __init__(self, cleanup=False) -> None:
"""Initialize CBA enrichment step."""
super().__init__(cleanup=cleanup)
self.add_step(DataDictionaryUploadStep(cleanup=cleanup))
@property
def description(self) -> str:
"""Step description."""
return "Enrich CBA file."
@BaseStep.store_state
def execute(self) -> None:
"""Enrich CBA file.
Use settings values:
- CDS_DD_FILE.
"""
super().execute()
blueprint: Blueprint = Blueprint.load_from_file(settings.CDS_CBA_UNENRICHED)
enriched: Blueprint = blueprint.enrich()
enriched.save(settings.CDS_CBA_ENRICHED)
@BaseStep.store_state(cleanup=True)
def cleanup(self) -> None:
"""Cleanup enrichment step.
Delete enriched CBA file.
"""
super().cleanup()
Path(settings.CDS_CBA_ENRICHED).unlink()
class CbaPublishStep(CDSBaseStep):
"""Publish CBA file step."""
def __init__(self, cleanup=False) -> None:
"""Initialize CBA publish step."""
super().__init__(cleanup=cleanup)
"""Let's skip enrichment if enriched CBA is already present"""
if Path.is_file(settings.CDS_CBA_UNENRICHED):
self.add_step(CbaEnrichStep(cleanup=cleanup))
elif settings.EXPOSE_SERVICES_NODE_PORTS:
self.add_step(ExposeCDSBlueprintprocessorNodePortStep(cleanup=cleanup))
@property
def description(self) -> str:
"""Step description."""
return "Publish CBA file."
@BaseStep.store_state
def execute(self) -> None:
"""Publish CBA file.
Use settings values:
- CDS_CBA_ENRICHED.
"""
super().execute()
blueprint: Blueprint = Blueprint.load_from_file(settings.CDS_CBA_ENRICHED)
blueprint.publish()
class CbaProcessStep(CDSBaseStep):
"""Process CBA step."""
def __init__(self, cleanup=False) -> None:
"""Initialize CBA process step."""
super().__init__(cleanup=cleanup)
self.add_step(CbaPublishStep(cleanup=cleanup))
@property
def description(self) -> str:
"""Step description."""
return "Process CBA file."
@BaseStep.store_state
def execute(self) -> None:
"""Process CBA file.
Check if output is equal to expected
Use settings values:
- CDS_CBA_ENRICHED,
- CDS_WORKFLOW_NAME,
- CDS_WORKFLOW_INPUT
"""
super().execute()
blueprint: Blueprint = Blueprint.load_from_file(settings.CDS_CBA_ENRICHED)
workflow: Workflow = blueprint.get_workflow_by_name(settings.CDS_WORKFLOW_NAME)
output: Dict[str, Any] = workflow.execute(settings.CDS_WORKFLOW_INPUT)
if not output == settings.CDS_WORKFLOW_EXPECTED_OUTPUT:
raise OnapTestException("Response is not equal to the expected one")
|
