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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
/*
* ============LICENSE_START=======================================================
* ONAP : ccsdk features
* ================================================================================
* Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
* All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file 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.
* ============LICENSE_END=========================================================
*
*/
package org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.dataprovider;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.NetconfTimeStamp;
import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.types.NetconfTimeStampImpl;
import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.util.ORanDMDOMUtility;
import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.util.ORanDeviceManagerQNames;
import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.yangspecs.ORANFM;
import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.yangspecs.OnapSystem;
import org.opendaylight.mdsal.dom.api.DOMEvent;
import org.opendaylight.mdsal.dom.api.DOMNotification;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultlogBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultlogEntity;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Guicutthrough;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.GuicutthroughBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Inventory;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.InventoryBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.SeverityType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.SourceType;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
import org.opendaylight.yangtools.yang.binding.CodeHelpers;
import org.opendaylight.yangtools.yang.common.Uint32;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ORanDOMToInternalDataModel {
private static final Logger LOG = LoggerFactory.getLogger(ORanDOMToInternalDataModel.class);
private static final NetconfTimeStamp NETCONFTIME_CONVERTER = NetconfTimeStampImpl.getConverter();
public static List<Inventory> getInventoryList(NodeId nodeId, NormalizedNode hwData) {
List<Inventory> inventoryResultList = new ArrayList<Inventory>();
ContainerNode hwContainer = (ContainerNode) hwData;
MapNode componentMap = (MapNode) hwContainer
.getChildByArg(new NodeIdentifier(ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST));
Collection<MapEntryNode> componentMapEntries = componentMap.body();
for (MapEntryNode componentMapEntryNode : getRootComponents(componentMapEntries)) {
inventoryResultList =
recurseGetInventory(nodeId, componentMapEntryNode, componentMapEntries, 0, inventoryResultList);
}
// Verify if result is complete
if (componentMapEntries.size() != inventoryResultList.size()) {
LOG.warn(
"Not all data were written to the Inventory. Potential entries with missing "
+ "contained-child. Node Id = {}, Components Found = {}, Entries written to Database = {}",
nodeId.getValue(), componentMapEntries.size(), inventoryResultList.size());
}
return inventoryResultList;
}
private static List<Inventory> recurseGetInventory(NodeId nodeId, MapEntryNode component,
Collection<MapEntryNode> componentList, int treeLevel, List<Inventory> inventoryResultList) {
//Add element to list, if conversion successfull
Optional<Inventory> oInventory = getInternalEquipment(nodeId, component, treeLevel);
if (oInventory.isPresent()) {
inventoryResultList.add(oInventory.get());
}
//Walk through list of child keys and add to list
for (String childUuid : CodeHelpers.nonnull(new ArrayList<>(ORanDMDOMUtility.getLeafListValue(component,
ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_CONTAINS_CHILD)))) {
for (MapEntryNode c : getComponentsByName(childUuid, componentList)) {
inventoryResultList = recurseGetInventory(nodeId, c, componentList, treeLevel + 1, inventoryResultList);
}
}
return inventoryResultList;
}
public static List<MapEntryNode> getRootComponents(Collection<MapEntryNode> componentMapEntries) {
List<MapEntryNode> resultList = new ArrayList<>();
for (MapEntryNode componentMapEntryNode : componentMapEntries) {
if (ORanDMDOMUtility.getLeafValue(componentMapEntryNode,
ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_PARENT) == null) { // Root elements do not have a parent
resultList.add(componentMapEntryNode);
}
}
return resultList;
}
private static List<MapEntryNode> getComponentsByName(String name, Collection<MapEntryNode> componentList) {
List<MapEntryNode> resultList = new ArrayList<>();
for (MapEntryNode c : componentList) {
if (name.equals(ORanDMDOMUtility.getKeyValue(c))) { // <-- Component list is flat search for child's of name
resultList.add(c);
}
}
return resultList;
}
public static Optional<Inventory> getInternalEquipment(NodeId nodeId, MapEntryNode component, int treeLevel) {
// Make sure that expected data are not null
Objects.requireNonNull(nodeId);
Objects.requireNonNull(component);
// Read mandatory data
@Nullable
String nodeIdString = nodeId.getValue();
@Nullable
String uuid = ORanDMDOMUtility.getKeyValue(component);
@Nullable
String idParent =
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_PARENT);
@Nullable
String uuidParent = idParent != null ? idParent : uuid; //<- Passt nicht
// do consistency check if all mandatory parameters are there
if (treeLevel >= 0 && nodeIdString != null && uuid != null && uuidParent != null) {
// Build output data
InventoryBuilder inventoryBuilder = new InventoryBuilder();
// General assumed as mandatory
inventoryBuilder.setNodeId(nodeIdString);
inventoryBuilder.setUuid(uuid);
inventoryBuilder.setParentUuid(uuidParent);
inventoryBuilder.setTreeLevel(Uint32.valueOf(treeLevel));
// -- String list with ids of holders (optional)
inventoryBuilder.setContainedHolder(ORanDMDOMUtility.getLeafListValue(component,
ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_CONTAINS_CHILD));
// -- Manufacturer related things (optional)
@Nullable
String mfgName =
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_MFG_NAME);
inventoryBuilder.setManufacturerName(mfgName);
inventoryBuilder.setManufacturerIdentifier(mfgName);
// Equipment type (optional)
inventoryBuilder.setDescription(
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_DESC));
inventoryBuilder.setModelIdentifier(ORanDMDOMUtility.getLeafValue(component,
ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_MODEL_NAME));
inventoryBuilder.setPartTypeId(
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_CLASS));
inventoryBuilder.setTypeName(ORanDMDOMUtility.getKeyValue(component));
inventoryBuilder.setVersion(
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_HW_REV));
// Equipment instance (optional)
@Nullable
String mfgDate =
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_MFG_DATE);
if (mfgDate != null) {
inventoryBuilder.setDate(mfgDate);
}
inventoryBuilder.setSerial(
ORanDMDOMUtility.getLeafValue(component, ORanDeviceManagerQNames.IETF_HW_COMPONENT_LIST_SER_NUM));
return Optional.of(inventoryBuilder.build());
}
return Optional.empty();
}
/**
* If system data is available convert
*
* @param sys
* @return
*/
public static Optional<Guicutthrough> getGuicutthrough(@Nullable AugmentationNode onapSysAugData, @NonNull OnapSystem onapSys) {
if (onapSysAugData != null) {
String name = ORanDMDOMUtility.getLeafValue(onapSysAugData, onapSys.getName());
@Nullable
Uri uri = new Uri(ORanDMDOMUtility.getLeafValue(onapSysAugData, onapSys.getWebUi()));
if (uri.getValue() != null) {
GuicutthroughBuilder gcBuilder = new GuicutthroughBuilder();
if (name != null) {
gcBuilder.setName(name);
}
gcBuilder.setWeburi(uri.getValue());
return Optional.of(gcBuilder.build());
}
LOG.warn("Uri not set to invoke a Gui cut through session to the device. Please set the Uri in the device");
}
LOG.warn("Retrieving augmented System details failed. Gui cut through information not available");
return Optional.empty();
}
/**
* Convert fault notification into data-provider FaultLogEntity
*
* @param notification with O-RAN notification
* @param oranfm
* @param nodeId of node to handle
* @param counter to be integrated into data
* @return FaultlogEntity with data
*/
public static FaultlogEntity getFaultLog(DOMNotification notification, @NonNull ORANFM oranfm, NodeId nodeId, Integer counter) {
ContainerNode cn = notification.getBody();
FaultlogBuilder faultAlarm = new FaultlogBuilder();
faultAlarm.setNodeId(nodeId.getValue());
faultAlarm.setObjectId(ORanDMDOMUtility.getLeafValue(cn, oranfm.getFaultSourceQName()));
faultAlarm.setProblem(ORanDMDOMUtility.getLeafValue(cn, oranfm.getFaultTextQName()));
faultAlarm.setSeverity(getSeverityType(
ORanDMDOMUtility.getLeafValue(cn, oranfm.getFaultSeverityQName()),
ORanDMDOMUtility.getLeafValue(cn, oranfm.getFaultIsClearedQName()).equals("true")));
faultAlarm.setCounter(counter);
faultAlarm.setId(ORanDMDOMUtility.getLeafValue(cn, oranfm.getFaultIdQName()));
faultAlarm.setSourceType(SourceType.Netconf);
faultAlarm.setTimestamp(getEventTime(notification));
return faultAlarm.build();
}
public static FaultlogEntity getFaultLog(UnkeyedListEntryNode activeAlarmEntry, ORANFM oranfm, NodeId nodeId, Integer counter) {
FaultlogBuilder faultAlarm = new FaultlogBuilder();
faultAlarm.setNodeId(nodeId.getValue());
faultAlarm.setObjectId(getObjectId(
ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultSourceQName())));
faultAlarm.setProblem(
ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultTextQName()));
faultAlarm.setSeverity(getSeverityType(
ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultSeverityQName()),
ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultIsClearedQName())
.equals("true")));
faultAlarm.setCounter(counter);
faultAlarm.setId(ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultIdQName()));
faultAlarm.setSourceType(SourceType.Netconf);
faultAlarm.setTimestamp(NetconfTimeStampImpl.getConverter().getTimeStamp(
ORanDMDOMUtility.getLeafValue(activeAlarmEntry, oranfm.getFaultEventTimeQName())));
return faultAlarm.build();
}
/**
* Convert Instant to NETCONF DateAndTime
* @param eventTimeInstant
* @return DateAndTime
*/
public static DateAndTime getDateAndTimeOfInstant(Instant eventTimeInstant) {
Date eventDate = Date.from(eventTimeInstant);
return new DateAndTime(NETCONFTIME_CONVERTER.getTimeStamp(eventDate));
}
private static DateAndTime getEventTime(DOMNotification notification) {
DateAndTime eventTime;
Instant notificationEventTime = null;
if (notification instanceof DOMEvent) {
notificationEventTime = ((DOMEvent) notification).getEventInstant();
eventTime = NetconfTimeStampImpl.getConverter().getTimeStamp(notificationEventTime.toString());
} else {
eventTime = NetconfTimeStampImpl.getConverter().getTimeStamp();
}
return eventTime;
}
/**
* Convert O-RAN specific severity into data-provider severity
*
* @param faultSeverity O-RAN severity
* @param isCleared clear indicator
* @return data-provider severity type
* @throws IllegalArgumentException if conversion not possible.
*/
private static SeverityType getSeverityType(@Nullable String faultSeverity, @Nullable Boolean isCleared)
throws IllegalArgumentException {
if (isCleared != null && isCleared) {
return SeverityType.NonAlarmed;
}
if (faultSeverity != null) {
switch (faultSeverity) {
case "CRITICAL":
return SeverityType.Critical;
case "MAJOR":
return SeverityType.Major;
case "MINOR":
return SeverityType.Minor;
case "WARNING":
return SeverityType.Warning;
}
}
throw new IllegalArgumentException("Unknown Alarm state represent as Critical. isCleared=" + isCleared
+ " faultSeverity=" + faultSeverity);
}
private static String getObjectId(String leafValue) {
// fault-source = /ietf-hardware:hardware/component[name='slot0-logical0']
Pattern p = Pattern.compile("\\/ietf-hardware:hardware\\/component\\[name=\\'(.*)\\']");
Matcher m = p.matcher(leafValue);
if (m.find()) {
return m.group(1);
}
return leafValue;
}
}
|
