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