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