pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestUtils.java

   1 /*
   2  * Copyright © 2017 AT&T, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.transportpce.pce.utils;
   9
  10 import com.google.gson.stream.JsonReader;
  11 import java.io.FileReader;
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.Reader;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.concurrent.ExecutionException;
  20 import java.util.stream.Collectors;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.junit.Assert;
  24 import org.opendaylight.mdsal.binding.api.DataBroker;
  25 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  27 import org.opendaylight.transportpce.common.DataStoreContext;
  28 import org.opendaylight.transportpce.common.NetworkUtils;
  29 import org.opendaylight.transportpce.common.converter.XMLDataObjectConverter;
  30 import org.opendaylight.transportpce.common.converter.api.DataObjectConverter;
  31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.pce.rev200128.PathComputationRequestOutput;
  32 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev200629.path.description.atoz.direction.AToZ;
  33 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev200629.path.description.atoz.direction.AToZKey;
  34 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev200629.pce.resource.resource.resource.Node;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.Networks;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkKey;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  45 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 public final class PceTestUtils {
  52
  53     private static final Logger LOG = LoggerFactory.getLogger(PceTestUtils.class);
  54
  55     private PceTestUtils() {
  56     }
  57
  58     public static void writeTopologyIntoDataStore(DataBroker dataBroker,
  59                                                   DataStoreContext dataStoreContext, String topologyDataPath)
  60             throws ExecutionException, InterruptedException {
  61
  62         DataObjectConverter dataObjectConverter = XMLDataObjectConverter.createWithDataStoreUtil(dataStoreContext);
  63         InputStream resourceAsStream = PceTestUtils.class.getClassLoader().getResourceAsStream(topologyDataPath);
  64         Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> normalizedNode
  65                 = dataObjectConverter.transformIntoNormalizedNode(resourceAsStream);
  66         DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> next
  67                 = ((ContainerNode) normalizedNode.get()).getValue().iterator().next();
  68         MapEntryNode mapNode = ((MapNode) next).getValue().iterator().next();
  69         Optional<DataObject> dataObject = dataObjectConverter.getDataObject(mapNode, Network.QNAME);
  70         InstanceIdentifier<Network> nwInstanceIdentifier = InstanceIdentifier.builder(Networks.class)
  71                 .child(Network.class, new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID)))
  72                 .build();
  73         WriteTransaction dataWriteTransaction = dataBroker.newWriteOnlyTransaction();
  74         dataWriteTransaction.put(LogicalDatastoreType.CONFIGURATION, nwInstanceIdentifier, (Network) dataObject.get());
  75         dataWriteTransaction.commit().get();
  76     }
  77
  78     public static void writeNetworkInDataStore(DataBroker dataBroker) {
  79
  80         try (
  81                 // load openroadm-network
  82                 Reader gnpyNetwork = new FileReader("src/test/resources/gnpy/gnpy_network.json");
  83                 // load openroadm-topology
  84                 Reader gnpyTopo = new FileReader("src/test/resources/gnpy/gnpy_topology.json");
  85                 JsonReader networkReader = new JsonReader(gnpyNetwork);
  86                 JsonReader topoReader = new JsonReader(gnpyTopo);
  87         ) {
  88
  89             Networks networks = (Networks) JsonUtil.getInstance().getDataObjectFromJson(networkReader,
  90                     QName.create("urn:ietf:params:xml:ns:yang:ietf-network", "2018-02-26", "networks"));
  91             @NonNull
  92             List<Network> networkMap = new ArrayList<>(networks.nonnullNetwork().values());
  93             saveOpenRoadmNetwork(networkMap.get(0), NetworkUtils.UNDERLAY_NETWORK_ID, dataBroker);
  94             networks = (Networks) JsonUtil.getInstance().getDataObjectFromJson(topoReader,
  95                     QName.create("urn:ietf:params:xml:ns:yang:ietf-network", "2018-02-26", "networks"));
  96             saveOpenRoadmNetwork(networkMap.get(0), NetworkUtils.UNDERLAY_NETWORK_ID, dataBroker);
  97         } catch (IOException | ExecutionException | InterruptedException e) {
  98             LOG.error("Cannot init test ", e);
  99             Assert.fail("Cannot init test ");
 100         }
 101     }
 102
 103     private static void saveOpenRoadmNetwork(Network network, String networkId, DataBroker dataBroker)
 104             throws InterruptedException, ExecutionException {
 105         InstanceIdentifier<Network> nwInstanceIdentifier = InstanceIdentifier.builder(Networks.class)
 106                 .child(Network.class, new NetworkKey(new NetworkId(networkId))).build();
 107         WriteTransaction dataWriteTransaction = dataBroker.newWriteOnlyTransaction();
 108         dataWriteTransaction.put(LogicalDatastoreType.CONFIGURATION, nwInstanceIdentifier, network);
 109         dataWriteTransaction.commit().get();
 110     }
 111
 112     public static void writeNetworkIntoDataStore(DataBroker dataBroker,
 113                                                  DataStoreContext dataStoreContext, Network network)
 114             throws ExecutionException, InterruptedException {
 115
 116         InstanceIdentifier<Network> nwInstanceIdentifier = InstanceIdentifier.builder(Networks.class)
 117                 .child(Network.class, new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID)))
 118                 .build();
 119         WriteTransaction dataWriteTransaction = dataBroker.newWriteOnlyTransaction();
 120         dataWriteTransaction.put(LogicalDatastoreType.CONFIGURATION, nwInstanceIdentifier, network);
 121         dataWriteTransaction.commit().get();
 122     }
 123
 124     public static void checkConfigurationResponse(PathComputationRequestOutput output,
 125                                                   PathComputationRequestOutput expectedOutput) {
 126         Assert.assertNotNull(output);
 127         Assert.assertEquals(
 128                 expectedOutput.getConfigurationResponseCommon().getAckFinalIndicator(),
 129                 output.getConfigurationResponseCommon().getAckFinalIndicator());
 130         Assert.assertEquals(
 131                 expectedOutput.getConfigurationResponseCommon().getResponseMessage(),
 132                 output.getConfigurationResponseCommon().getResponseMessage());
 133         Assert.assertEquals(
 134                 expectedOutput.getConfigurationResponseCommon().getResponseCode(),
 135                 output.getConfigurationResponseCommon().getResponseCode());
 136     }
 137
 138     public static void checkCalculatedPath(PathComputationRequestOutput output,
 139                                            PathComputationRequestOutput expectedOutput) {
 140         Assert.assertNotNull(output.getResponseParameters().getPathDescription());
 141         Assert.assertNotNull(output.getResponseParameters().getPathDescription().getAToZDirection());
 142         Assert.assertNotNull(output.getResponseParameters().getPathDescription().getZToADirection());
 143         Assert.assertNotNull(output.getResponseParameters().getPathDescription().getAToZDirection().getAToZ());
 144         Assert.assertNotNull(output.getResponseParameters().getPathDescription().getZToADirection().getZToA());
 145
 146         int atozSize = output.getResponseParameters().getPathDescription().getAToZDirection().getAToZ().size();
 147         int ztoaSize = output.getResponseParameters().getPathDescription().getZToADirection().getZToA().size();
 148         Assert.assertEquals(atozSize, ztoaSize);
 149
 150         Long actualAToZWavel = output.getResponseParameters().getPathDescription().getAToZDirection()
 151                 .getAToZWavelengthNumber().toJava();
 152         Long expectedAToZWavel = expectedOutput.getResponseParameters().getPathDescription().getAToZDirection()
 153                 .getAToZWavelengthNumber().toJava();
 154         Assert.assertEquals(actualAToZWavel, expectedAToZWavel);
 155
 156         Long actualZtoAWavel = output.getResponseParameters().getPathDescription().getZToADirection()
 157                 .getZToAWavelengthNumber().toJava();
 158         Long expectedZtoAWavel = expectedOutput.getResponseParameters().getPathDescription().getZToADirection()
 159                 .getZToAWavelengthNumber().toJava();
 160         Assert.assertEquals(actualZtoAWavel, expectedZtoAWavel);
 161
 162         Long actualAToZRate = output.getResponseParameters().getPathDescription().getAToZDirection().getRate().toJava();
 163         Long expectedAToZRate = expectedOutput.getResponseParameters().getPathDescription().getAToZDirection()
 164                 .getRate().toJava();
 165         Assert.assertEquals(expectedAToZRate, actualAToZRate);
 166
 167         Long actualZToARate = output.getResponseParameters().getPathDescription().getZToADirection().getRate().toJava();
 168         Long expectedZToARate = expectedOutput.getResponseParameters().getPathDescription().getZToADirection()
 169                 .getRate().toJava();
 170         Assert.assertEquals(actualZToARate, expectedZToARate);
 171     }
 172
 173     private static List<String> getNodesFromPath(PathComputationRequestOutput output) {
 174         @Nullable Map<AToZKey, AToZ> atozList = output.getResponseParameters()
 175                 .getPathDescription().getAToZDirection().getAToZ();
 176         return atozList.values().stream()
 177                 .filter(aToZ -> {
 178                     if ((aToZ.getResource() == null) || (aToZ.getResource().getResource() == null)) {
 179                         LOG.debug("Diversity constraint: Resource of AToZ node {} is null! Skipping this node!",
 180                                 aToZ.getId());
 181                         return false;
 182                     }
 183                     return aToZ.getResource().getResource() instanceof Node;
 184                 }).map(aToZ -> {
 185                     Node node = (Node) aToZ.getResource().getResource();
 186                     if (node.getNodeId() == null) {
 187                         LOG.warn("Node in AToZ node {} contains null! Skipping this node!", aToZ.getId());
 188                         return null;
 189                     }
 190                     return node.getNodeId().toString();
 191                 }).collect(Collectors.toList());
 192     }
 193
 194     public static boolean comparePath(PathComputationRequestOutput output1, PathComputationRequestOutput output2) {
 195         // return true if paths are different
 196         List<String> nodes1 = getNodesFromPath(output1);
 197         LOG.info("nodes1: {}", nodes1.toString());
 198         List<String> nodes2 = getNodesFromPath(output2);
 199         LOG.info("nodes2: {}", nodes2.toString());
 200         nodes1.retainAll(nodes2);
 201         LOG.info("nodes after intersection: {}", nodes1.toString());
 202         return nodes1.isEmpty();
 203     }
 204
 205     public static boolean checkPCECalculationConflicts(PathComputationRequestOutput[] outputs,
 206                                                        int iterationOrdinal, DataBroker dataBroker) {
 207
 208         return true;
 209     }
 210
 211 }