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