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