netconf/netconf-console/src/test/java/org/opendaylight/netconf/console/impl/NetconfCommandsImplTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, 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
   9 package org.opendaylight.netconf.console.impl;
  10
  11 import static junit.framework.TestCase.assertFalse;
  12 import static junit.framework.TestCase.assertNull;
  13 import static junit.framework.TestCase.assertTrue;
  14 import static org.junit.Assert.assertEquals;
  15 import static org.junit.Assert.assertNotNull;
  16
  17 import com.google.common.collect.ImmutableList;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import java.util.ArrayList;
  20 import java.util.EnumMap;
  21 import java.util.HashMap;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import java.util.concurrent.TimeUnit;
  26 import java.util.concurrent.TimeoutException;
  27 import javassist.ClassPool;
  28 import org.junit.Before;
  29 import org.junit.Test;
  30 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  31 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  32 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataBrokerAdapter;
  33 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
  34 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  35 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  37 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
  38 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory;
  39 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  40 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  41 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerGenerator;
  42 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
  43 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  44 import org.opendaylight.mdsal.binding.generator.impl.GeneratedClassLoadingStrategy;
  45 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  46 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  47 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
  48 import org.opendaylight.netconf.console.utils.NetconfConsoleConstants;
  49 import org.opendaylight.netconf.console.utils.NetconfConsoleUtils;
  50 import org.opendaylight.netconf.console.utils.NetconfIidFactory;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.HostBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilities;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapabilityBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  70 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  71 import org.opendaylight.yangtools.yang.model.api.Module;
  72 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  73 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  74 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  75
  76 public class NetconfCommandsImplTest {
  77
  78     private static final String NODE_ID = "NodeID";
  79     private static final String IP = "192.168.1.1";
  80     private static final int PORT = 1234;
  81     private static final NetconfNodeConnectionStatus.ConnectionStatus CONN_STATUS =
  82             NetconfNodeConnectionStatus.ConnectionStatus.Connected;
  83     private static final String CAP_PREFIX = "prefix";
  84
  85     private DataBroker dataBroker;
  86     private SchemaContext schemaContext;
  87     private NetconfCommandsImpl netconfCommands;
  88
  89     @Before
  90     public void setUp() throws Exception {
  91         schemaContext = YangParserTestUtils.parseYangResources(NetconfCommandsImplTest.class,
  92             "/schemas/network-topology@2013-10-21.yang", "/schemas/ietf-inet-types@2013-07-15.yang",
  93             "/schemas/yang-ext.yang", "/schemas/netconf-node-topology.yang");
  94         schemaContext.getModules();
  95         final SchemaService schemaService = createSchemaService();
  96
  97         final DOMStore operStore = InMemoryDOMDataStoreFactory.create("DOM-OPER", schemaService);
  98         final DOMStore configStore = InMemoryDOMDataStoreFactory.create("DOM-CFG", schemaService);
  99
 100         final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
 101         datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 102         datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 103
 104         final DOMDataBroker domDataBroker =
 105                 new SerializedDOMDataBroker(datastores, MoreExecutors.newDirectExecutorService());
 106
 107         final ClassPool pool = ClassPool.getDefault();
 108         final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(pool));
 109         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(generator);
 110         final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
 111         codecRegistry
 112                 .onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext, schemaContext));
 113
 114         final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
 115         final BindingToNormalizedNodeCodec bindingToNormalized =
 116                 new BindingToNormalizedNodeCodec(loading, codecRegistry);
 117         bindingToNormalized.onGlobalContextUpdated(schemaContext);
 118         dataBroker = new BindingDOMDataBrokerAdapter(domDataBroker, bindingToNormalized);
 119
 120         netconfCommands = new NetconfCommandsImpl(dataBroker);
 121     }
 122
 123     @Test
 124     public void testListDevice() throws TimeoutException, TransactionCommitFailedException {
 125         createTopology(LogicalDatastoreType.OPERATIONAL);
 126
 127         final Map<?, ?> map = netconfCommands.listDevices();
 128         map.containsKey(NetconfConsoleConstants.NETCONF_ID);
 129         assertTrue(map.containsKey(NODE_ID));
 130
 131         final Map<?, ?> mapNode = (Map<?, ?>) map.get(NODE_ID);
 132         assertBaseNodeAttributes(mapNode);
 133     }
 134
 135     @Test
 136     public void testShowDevice() throws TimeoutException, TransactionCommitFailedException {
 137         createTopology(LogicalDatastoreType.OPERATIONAL);
 138
 139         final Map<?, ?> mapCorrect = netconfCommands.showDevice(IP, String.valueOf(PORT));
 140         mapCorrect.containsKey(NetconfConsoleConstants.NETCONF_ID);
 141         assertTrue(mapCorrect.containsKey(NODE_ID));
 142
 143         assertBaseNodeAttributesImmutableList((Map<?, ?>) mapCorrect.get(NODE_ID));
 144
 145         final Map<?, ?> mapWrongPort = netconfCommands.showDevice(IP, "1");
 146         assertFalse(mapWrongPort.containsKey(NODE_ID));
 147
 148         final Map<?, ?> mapWrongIP = netconfCommands.showDevice("1.1.1.1", String.valueOf(PORT));
 149         assertFalse(mapWrongIP.containsKey(NODE_ID));
 150
 151         final Map<?, ?> mapId = netconfCommands.showDevice(NODE_ID);
 152         assertTrue(mapId.containsKey(NODE_ID));
 153         assertBaseNodeAttributesImmutableList((Map) mapId.get(NODE_ID));
 154     }
 155
 156     @Test
 157     public void testConnectDisconnectDevice()
 158             throws InterruptedException, TimeoutException, TransactionCommitFailedException {
 159         final NetconfNode netconfNode = new NetconfNodeBuilder()
 160                 .setPort(new PortNumber(7777)).setHost(HostBuilder.getDefaultInstance("10.10.1.1")).build();
 161
 162         createTopology(LogicalDatastoreType.CONFIGURATION);
 163         netconfCommands.connectDevice(netconfNode, "netconf-ID");
 164         NetconfConsoleUtils.waitForUpdate("10.10.1.1");
 165
 166         final Topology topology = NetconfConsoleUtils.read(LogicalDatastoreType.CONFIGURATION,
 167                 NetconfIidFactory.NETCONF_TOPOLOGY_IID, dataBroker);
 168         final List<Node> nodes = topology.getNode();
 169         assertEquals(2, nodes.size());
 170
 171         final Optional<Node> storedNode = nodes.stream().filter(node ->
 172                 node.key().getNodeId().getValue().equals("netconf-ID")).findFirst();
 173
 174         assertTrue(storedNode.isPresent());
 175
 176         NetconfNode storedNetconfNode = storedNode.get().augmentation(NetconfNode.class);
 177         assertEquals(7777, storedNetconfNode.getPort().getValue().longValue());
 178         assertEquals("10.10.1.1", storedNetconfNode.getHost().getIpAddress().getIpv4Address().getValue());
 179
 180         netconfCommands.disconnectDevice("netconf-ID");
 181
 182         final Topology topologyDeleted = NetconfConsoleUtils.read(LogicalDatastoreType.CONFIGURATION,
 183                 NetconfIidFactory.NETCONF_TOPOLOGY_IID, dataBroker);
 184         final List<Node> nodesDeleted = topologyDeleted.getNode();
 185         assertEquals(1, nodesDeleted.size());
 186
 187         final Optional<Node> storedNodeDeleted = nodesDeleted.stream().filter(node ->
 188                 node.key().getNodeId().getValue().equals("netconf-ID")).findFirst();
 189
 190         assertFalse(storedNodeDeleted.isPresent());
 191     }
 192
 193     @Test
 194     public void testUpdateDevice() throws TimeoutException, TransactionCommitFailedException {
 195         //We need both, read data from OPERATIONAL DS and update data in CONFIGURATIONAL DS
 196         createTopology(LogicalDatastoreType.OPERATIONAL);
 197         createTopology(LogicalDatastoreType.CONFIGURATION);
 198
 199         final Map<String, String> update = new HashMap<>();
 200         update.put(NetconfConsoleConstants.NETCONF_IP, "7.7.7.7");
 201         update.put(NetconfConsoleConstants.TCP_ONLY, "true");
 202         update.put(NetconfConsoleConstants.SCHEMALESS, "true");
 203
 204         netconfCommands.updateDevice(NODE_ID, "admin", "admin", update);
 205         NetconfConsoleUtils.waitForUpdate("7.7.7.7");
 206
 207         final Topology topology = NetconfConsoleUtils.read(LogicalDatastoreType.CONFIGURATION,
 208                 NetconfIidFactory.NETCONF_TOPOLOGY_IID, dataBroker);
 209         final List<Node> nodes = topology.getNode();
 210         assertEquals(1, nodes.size());
 211
 212         final Optional<Node> storedNode = nodes.stream().filter(node ->
 213                 node.key().getNodeId().getValue().equals(NODE_ID)).findFirst();
 214         assertTrue(storedNode.isPresent());
 215
 216         NetconfNode storedNetconfNode = storedNode.get().augmentation(NetconfNode.class);
 217         assertEquals("7.7.7.7", storedNetconfNode.getHost().getIpAddress().getIpv4Address().getValue());
 218     }
 219
 220     @Test
 221     public void testNetconfNodeFromIp() throws TimeoutException, TransactionCommitFailedException {
 222         final List<Node> nodesNotExist = NetconfConsoleUtils.getNetconfNodeFromIp(IP, dataBroker);
 223         assertNull(nodesNotExist);
 224         createTopology(LogicalDatastoreType.OPERATIONAL);
 225         final List<Node> nodes = NetconfConsoleUtils.getNetconfNodeFromIp(IP, dataBroker);
 226         assertNotNull(nodes);
 227         assertEquals(1, nodes.size());
 228     }
 229
 230     private void createTopology(final LogicalDatastoreType dataStoreType)
 231             throws TransactionCommitFailedException, TimeoutException {
 232         final List<Node> nodes = new ArrayList<>();
 233         final Node node = getNetconfNode(NODE_ID, IP, PORT, CONN_STATUS, CAP_PREFIX);
 234         nodes.add(node);
 235
 236         final Topology topology = new TopologyBuilder()
 237                 .withKey(new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())))
 238                 .setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).setNode(nodes).build();
 239
 240         final WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 241         writeTransaction.put(dataStoreType, NetconfIidFactory.NETCONF_TOPOLOGY_IID, topology);
 242         writeTransaction.submit().checkedGet(2, TimeUnit.SECONDS);
 243     }
 244
 245     private static Node getNetconfNode(final String nodeIdent, final String ip, final int portNumber,
 246             final NetconfNodeConnectionStatus.ConnectionStatus cs, final String notificationCapabilityPrefix) {
 247
 248         final Host host = HostBuilder.getDefaultInstance(ip);
 249         final PortNumber port = new PortNumber(portNumber);
 250
 251         final List<AvailableCapability> avCapList = new ArrayList<>();
 252         avCapList.add(new AvailableCapabilityBuilder()
 253                 .setCapabilityOrigin(AvailableCapability.CapabilityOrigin.UserDefined)
 254                 .setCapability(notificationCapabilityPrefix + "_availableCapabilityString1").build());
 255         final AvailableCapabilities avCaps =
 256                 new AvailableCapabilitiesBuilder().setAvailableCapability(avCapList).build();
 257
 258         final NetconfNode nn = new NetconfNodeBuilder().setConnectionStatus(cs).setHost(host).setPort(port)
 259                 .setAvailableCapabilities(avCaps).build();
 260         final NodeId nodeId = new NodeId(nodeIdent);
 261         final NodeKey nk = new NodeKey(nodeId);
 262         final NodeBuilder nb = new NodeBuilder();
 263         nb.withKey(nk);
 264         nb.setNodeId(nodeId);
 265         nb.addAugmentation(NetconfNode.class, nn);
 266         return nb.build();
 267     }
 268
 269     private static void assertBaseNodeAttributes(final Map<?, ?> mapNode) {
 270         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_ID));
 271         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_IP));
 272         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_PORT));
 273         assertTrue(mapNode.containsKey(NetconfConsoleConstants.STATUS));
 274
 275         assertEquals(NODE_ID, mapNode.get(NetconfConsoleConstants.NETCONF_ID));
 276         assertEquals(IP, mapNode.get(NetconfConsoleConstants.NETCONF_IP));
 277         assertEquals(String.valueOf(PORT), mapNode.get(NetconfConsoleConstants.NETCONF_PORT));
 278         assertEquals(CONN_STATUS.name().toLowerCase(), mapNode.get(NetconfConsoleConstants.STATUS));
 279     }
 280
 281     private static void assertBaseNodeAttributesImmutableList(final Map<?, ?> mapNode) {
 282         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_ID));
 283         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_IP));
 284         assertTrue(mapNode.containsKey(NetconfConsoleConstants.NETCONF_PORT));
 285         assertTrue(mapNode.containsKey(NetconfConsoleConstants.STATUS));
 286
 287         assertEquals(ImmutableList.of(NODE_ID), mapNode.get(NetconfConsoleConstants.NETCONF_ID));
 288         assertEquals(ImmutableList.of(IP), mapNode.get(NetconfConsoleConstants.NETCONF_IP));
 289         assertEquals(ImmutableList.of(String.valueOf(PORT)), mapNode.get(NetconfConsoleConstants.NETCONF_PORT));
 290         assertEquals(ImmutableList.of(CONN_STATUS.name()), mapNode.get(NetconfConsoleConstants.STATUS));
 291     }
 292
 293     private SchemaService createSchemaService() {
 294         return new SchemaService() {
 295
 296             @Override
 297             public void addModule(final Module module) {
 298             }
 299
 300             @Override
 301             public void removeModule(final Module module) {
 302
 303             }
 304
 305             @Override
 306             public SchemaContext getSessionContext() {
 307                 return schemaContext;
 308             }
 309
 310             @Override
 311             public SchemaContext getGlobalContext() {
 312                 return schemaContext;
 313             }
 314
 315             @Override
 316             public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(
 317                     final SchemaContextListener listener) {
 318                 listener.onGlobalContextUpdated(getGlobalContext());
 319                 return new ListenerRegistration<SchemaContextListener>() {
 320                     @Override
 321                     public void close() {
 322
 323                     }
 324
 325                     @Override
 326                     public SchemaContextListener getInstance() {
 327                         return listener;
 328                     }
 329                 };
 330             }
 331         };
 332     }
 333 }