gerrit.onap Code Review - ccsdk/features.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP : ccsdk features
   4  * ================================================================================
   5  * Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
   6  * All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  */
  22 package org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.impl.dom;
  23
  24 import static org.junit.Assert.assertEquals;
  25 import static org.mockito.Mockito.mock;
  26 import static org.mockito.Mockito.when;
  27 import java.io.IOException;
  28 import java.io.InputStream;
  29 import java.net.URISyntaxException;
  30 import java.time.Instant;
  31 import java.util.List;
  32 import java.util.Optional;
  33 import javax.xml.stream.XMLStreamException;
  34 import javax.xml.stream.XMLStreamReader;
  35 import org.eclipse.jdt.annotation.NonNull;
  36 import org.junit.AfterClass;
  37 import org.junit.BeforeClass;
  38 import org.junit.Test;
  39 import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.dataprovider.ORanDOMToInternalDataModel;
  40 import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.impl.dom.util.TestYangParserUtil;
  41 import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.yangspecs.ORANFM;
  42 import org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.yangspecs.OnapSystem;
  43 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.Capabilities;
  44 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.NetconfDomAccessor;
  45 import org.opendaylight.mdsal.dom.api.DOMEvent;
  46 import org.opendaylight.mdsal.dom.api.DOMNotification;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultlogEntity;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Guicutthrough;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Inventory;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  51 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  52 import org.opendaylight.yangtools.yang.common.QName;
  53 import org.opendaylight.yangtools.yang.common.QNameModule;
  54 import org.opendaylight.yangtools.yang.common.Revision;
  55 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  58 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  61 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizationResult;
  62 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  63 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  64 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  65 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  66 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  67 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  68 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  69 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  70 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
  71 import org.xml.sax.SAXException;
  72
  73 public class TestORanDOMToInternalDataModel {
  74
  75     private static final QNameModule IETF_HARDWARE_MODULE =
  76             QNameModule.create(XMLNamespace.of("urn:ietf:params:xml:ns:yang:ietf-hardware"), Revision.of("2018-03-13"));
  77     private static final QName HW_CONTAINER = QName.create(IETF_HARDWARE_MODULE, "hardware");
  78
  79     private static final QNameModule IETF_SYSTEM_MODULE =
  80             QNameModule.create(XMLNamespace.of("urn:ietf:params:xml:ns:yang:ietf-system"), Revision.of("2014-08-06"));
  81     private static final QName IETF_CONTAINER = QName.create(IETF_SYSTEM_MODULE, "system");
  82
  83     private static final QNameModule ORAN_MODULE =
  84             QNameModule.create(XMLNamespace.of("urn:o-ran:fm:1.0"), Revision.of("2022-08-15"));
  85     private static final QName ORAN_ACTIVE_ALARM_CONTAINER = QName.create(ORAN_MODULE, "active-alarm-list");
  86
  87     private static EffectiveModelContext schemaContext;
  88     private static Inference hwContainerSchema;
  89     private static Inference systemSchema;
  90     private static Inference activeAlarmSchema;
  91     private static Capabilities capabilities;
  92     private static Optional<OnapSystem> onapSystem;
  93     private static Optional<ORANFM> oranfm;
  94     private static NetconfDomAccessor domAccessor;
  95
  96     private static final NodeId nodeId = new NodeId("nSky");
  97
  98     @BeforeClass
  99     public static void setup() throws IOException {
 100         schemaContext = TestYangParserUtil.parseYangResourceDirectory("/");
 101         hwContainerSchema = Inference.ofDataTreePath(schemaContext, HW_CONTAINER);
 102         systemSchema = Inference.ofDataTreePath(schemaContext, IETF_CONTAINER);
 103         activeAlarmSchema = Inference.ofDataTreePath(schemaContext, ORAN_ACTIVE_ALARM_CONTAINER);
 104
 105         capabilities = mock(Capabilities.class);
 106         domAccessor = mock(NetconfDomAccessor.class);
 107         when(domAccessor.getCapabilites()).thenReturn(capabilities);
 108         when(capabilities.isSupportingNamespaceAndRevision(
 109                 QNameModule.create(XMLNamespace.of(OnapSystem.NAMESPACE), Revision.of("2022-11-04")))).thenReturn(true);
 110         onapSystem = OnapSystem.getModule(domAccessor);
 111         when(capabilities.isSupportingNamespaceAndRevision(
 112                 QNameModule.create(XMLNamespace.of(ORANFM.NAMESPACE), Revision.of("2022-08-15")))).thenReturn(true);
 113         oranfm = ORANFM.getModule(domAccessor);
 114
 115     }
 116
 117     @AfterClass
 118     public static void cleanup() {
 119         schemaContext = null;
 120         hwContainerSchema = null;
 121         systemSchema = null;
 122         activeAlarmSchema = null;
 123     }
 124
 125     @Test
 126     public void testIetfHardwareFromXML() throws XMLStreamException, URISyntaxException, IOException, SAXException {
 127
 128         final InputStream resourceAsStream =
 129                 TestORanDOMToInternalDataModel.class.getResourceAsStream("/ietf-hardware.xml");
 130
 131         /*
 132          * final XMLInputFactory factory = XMLInputFactory.newInstance();
 133          * XMLStreamReader reader = factory.createXMLStreamReader(resourceAsStream);
 134          */
 135         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 136
 137         final NormalizationResultHolder result = new NormalizationResultHolder();
 138         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 139
 140         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, hwContainerSchema);
 141         xmlParser.parse(reader);
 142
 143         xmlParser.flush();
 144         xmlParser.close();
 145
 146         NormalizedNode transformedInput = result.getResult().data();
 147
 148         List<Inventory> inventoryList = ORanDOMToInternalDataModel.getInventoryList(nodeId, transformedInput);
 149         assertEquals("All elements", 27, inventoryList.size());
 150         assertEquals("Treelevel always there", 0,
 151                 inventoryList.stream().filter(inventory -> inventory.getTreeLevel() == null).count());
 152     }
 153
 154     @Test
 155     public void testIetfSystemFromXML() throws XMLStreamException, URISyntaxException, IOException, SAXException {
 156
 157         final InputStream resourceAsStream =
 158                 TestORanDOMToInternalDataModel.class.getResourceAsStream("/onap-system.xml");
 159
 160         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 161
 162         final NormalizationResultHolder result = new NormalizationResultHolder();
 163         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 164
 165         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, systemSchema);
 166         xmlParser.parse(reader);
 167
 168         xmlParser.flush();
 169         xmlParser.close();
 170
 171         NormalizedNode transformedInput = result.getResult().data();
 172         ContainerNode cn = (ContainerNode) transformedInput;
 173         Optional<Guicutthrough> gc = ORanDOMToInternalDataModel.getGuicutthrough(cn, onapSystem.get());
 174         assertEquals(gc.isPresent(), true);
 175     }
 176
 177     @Test
 178     public void testORANFault() {
 179         ContainerNode cn = createORANDOMFault();
 180         NetconfDeviceNotification faultNotif = new NetconfDeviceNotification(cn, Instant.now());
 181         FaultlogEntity fle = ORanDOMToInternalDataModel.getFaultLog(faultNotif, oranfm.get(), nodeId);
 182         assertEquals(fle.getId(), "47");
 183     }
 184
 185     @Test
 186     public void testORANActiveAlarms() throws XMLStreamException, URISyntaxException, IOException, SAXException {
 187         final InputStream resourceAsStream =
 188                 TestORanDOMToInternalDataModel.class.getResourceAsStream("/oran-fm-active-alarm.xml");
 189
 190         final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
 191         final NormalizationResultHolder result = new NormalizationResultHolder();
 192         final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 193
 194         final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, activeAlarmSchema);
 195         xmlParser.parse(reader);
 196
 197         xmlParser.flush();
 198         xmlParser.close();
 199         @NonNull NormalizationResult<?> transformedInput = result.getResult();
 200         ContainerNode cn = (ContainerNode) transformedInput.data();
 201
 202         UnkeyedListNode activeAlarmsList =
 203                 (UnkeyedListNode) cn.childByArg(new NodeIdentifier(oranfm.get().getFaultActiveAlarmsQName()));
 204         for (UnkeyedListEntryNode activeAlarmEntry : activeAlarmsList.body())
 205             ORanDOMToInternalDataModel.getFaultLog(activeAlarmEntry, oranfm.get(), new NodeId("nSky"));
 206     }
 207
 208     public static ContainerNode createORANDOMFault() {
 209         return Builders.containerBuilder().withNodeIdentifier(NodeIdentifier.create(oranfm.get().getAlarmNotifQName()))
 210                 .withChild(ImmutableNodes.leafNode(oranfm.get().getFaultIdQName(), "47"))
 211                 .withChild(ImmutableNodes.leafNode(oranfm.get().getFaultSourceQName(), "Slot-2-Port-B"))
 212                 .withChild(ImmutableNodes.leafNode(oranfm.get().getFaultSeverityQName(), "MAJOR"))
 213                 .withChild(ImmutableNodes.leafNode(oranfm.get().getFaultIsClearedQName(), "true"))
 214                 .withChild(ImmutableNodes.leafNode(oranfm.get().getFaultTextQName(), "CPRI Port Down"))
 215                 .withChild(
 216                         ImmutableNodes.leafNode(oranfm.get().getFaultEventTimeQName(), "2024-02-29T09:33:31.000+00:00"))
 217                 .build();
 218     }
 219
 220     public static class NetconfDeviceNotification implements DOMNotification, DOMEvent {
 221         private final ContainerNode content;
 222         private final Absolute schemaPath;
 223         private final Instant eventTime;
 224
 225         NetconfDeviceNotification(final ContainerNode content, final Instant eventTime) {
 226             this.content = content;
 227             this.eventTime = eventTime;
 228             this.schemaPath = Absolute.of(content.getIdentifier().getNodeType());
 229         }
 230
 231         NetconfDeviceNotification(final ContainerNode content, final Absolute schemaPath, final Instant eventTime) {
 232             this.content = content;
 233             this.eventTime = eventTime;
 234             this.schemaPath = schemaPath;
 235         }
 236
 237         @Override
 238         public Absolute getType() {
 239             return schemaPath;
 240         }
 241
 242         @Override
 243         public ContainerNode getBody() {
 244             return content;
 245         }
 246
 247         @Override
 248         public Instant getEventInstant() {
 249             return eventTime;
 250         }
 251     }
 252 }