Merge "decrease OLM timers in functional tests"
[transportpce.git] / olm / src / main / java / org / opendaylight / transportpce / olm / util / OlmUtils.java
1 /*
2  * Copyright © 2017 AT&T 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.olm.util;
9
10 import java.util.Optional;
11 import java.util.concurrent.ExecutionException;
12 import java.util.concurrent.TimeUnit;
13 import java.util.concurrent.TimeoutException;
14
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
19 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev170418.GetPmInput;
20 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev170418.GetPmOutputBuilder;
21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.Network;
22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.Nodes;
23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.NodesKey;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33 public final class OlmUtils {
34
35     private static final Logger LOG = LoggerFactory.getLogger(OlmUtils.class);
36     private static long DATABROKER_READ_TIMEOUT_SECONDS = 120;
37     public static long OLM_TIMER_1 = 120000; //#FUNCTESTVAL= 3000;
38     public static long OLM_TIMER_2 = 20000;  //#FUNCTESTVAL= 2000;
39     private static final InstanceIdentifier<Topology> NETCONF_TOPO_IID =
40         InstanceIdentifier
41             .create(NetworkTopology.class)
42             .child(Topology.class,
43                 new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
44
45     /**
46      * This static method returns the port mapping {@link Nodes} for node.
47      *
48      * @param nodeId
49      *            Unique identifier for the mounted netconf node
50      * @param db
51      *            Databroker used to read data from data store.
52      * @return {@link Nodes } from portMapping for given nodeId
53      */
54     public static Optional<Nodes> getNode(String nodeId, DataBroker db) {
55         InstanceIdentifier<Nodes> nodesIID = InstanceIdentifier.create(Network.class)
56             .child(Nodes.class, new NodesKey(nodeId));
57         try (ReadOnlyTransaction readTransaction = db.newReadOnlyTransaction()) {
58             return readTransaction.read(LogicalDatastoreType.CONFIGURATION, nodesIID)
59                 .get(DATABROKER_READ_TIMEOUT_SECONDS, TimeUnit.SECONDS).toJavaUtil();
60         } catch (InterruptedException | ExecutionException | TimeoutException ex) {
61             LOG.error("Unable to read Portmapping for nodeId {}", nodeId, ex);
62             return Optional.empty();
63         }
64     }
65
66     /**
67      * This method retrieves list of current PMs for given nodeId,
68      * resourceType, resourceName and Granularity.Currently vendorExtentions
69      * are excluded but can be added back based on requirement
70      *
71      * <p>
72      * 1. pmFetch This operation traverse through current PM list and gets PM for
73      * given NodeId and Resource name
74      *
75      * @param input
76      *            Input parameter from the olm yang model get-pm rpc
77      * @param deviceTransactionManager
78      *            Device tx manager
79      * @param openRoadmVersion
80      *            OpenRoadm version number
81      *
82      * @return Result of the request list of PM readings
83      */
84     public static GetPmOutputBuilder pmFetch(GetPmInput input, DeviceTransactionManager deviceTransactionManager,
85                                              Nodes.OpenroadmVersion openRoadmVersion) {
86         LOG.info("Getting PM Data for NodeId: {} ResourceType: {} ResourceName: {}", input.getNodeId(),
87             input.getResourceType(), input.getResourceIdentifier());
88         GetPmOutputBuilder pmOutputBuilder = new GetPmOutputBuilder();
89         if (openRoadmVersion.equals(Nodes.OpenroadmVersion._121)) {
90             pmOutputBuilder = OlmUtils121.pmFetch(input, deviceTransactionManager);
91         } else {
92             pmOutputBuilder = OlmUtils22.pmFetch(input, deviceTransactionManager);
93         }
94         return pmOutputBuilder;
95     }
96
97     private OlmUtils() {
98     }
99
100 }