netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceTopologyAdapterTest.java

   1 /*
   2  * Copyright (c) 2015 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.sal.connect.netconf.sal;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.times;
  16 import static org.mockito.Mockito.verify;
  17
  18 import com.google.common.base.Optional;
  19 import com.google.common.util.concurrent.Futures;
  20 import java.io.InputStream;
  21 import java.net.InetSocketAddress;
  22 import java.util.ArrayList;
  23 import java.util.Arrays;
  24 import java.util.EnumMap;
  25 import java.util.List;
  26 import java.util.Set;
  27 import java.util.concurrent.ExecutorService;
  28 import java.util.concurrent.TimeUnit;
  29 import java.util.concurrent.TimeoutException;
  30 import javassist.ClassPool;
  31 import org.custommonkey.xmlunit.XMLUnit;
  32 import org.junit.Before;
  33 import org.junit.Test;
  34 import org.mockito.Mock;
  35 import org.mockito.MockitoAnnotations;
  36 import org.mockito.internal.util.collections.Sets;
  37 import org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker;
  38 import org.opendaylight.controller.cluster.datastore.node.utils.AugmentationIdentifierGenerator;
  39 import org.opendaylight.controller.md.sal.binding.impl.BindingDOMDataBrokerAdapter;
  40 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  41 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  42 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  43 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  44 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  45 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  46 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
  47 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  48 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  49 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  50 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory;
  51 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  52 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  53 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  54 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeFields;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  64 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  65 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  66 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  67 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  68 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  69 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
  70 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  71 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
  72 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  73 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  74 import org.opendaylight.yangtools.yang.common.QName;
  75 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  76 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  77 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  78 import org.opendaylight.yangtools.yang.model.api.Module;
  79 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  80 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  81 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  82 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  83 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
  84
  85 public class NetconfDeviceTopologyAdapterTest {
  86
  87     private RemoteDeviceId id = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  88
  89     @Mock
  90     private DataBroker broker;
  91     @Mock
  92     private WriteTransaction writeTx;
  93     @Mock
  94     private BindingTransactionChain txChain;
  95     @Mock
  96     private NetconfNode data;
  97
  98     private String txIdent = "test transaction";
  99
 100     private SchemaContext schemaContext = null;
 101     private String sessionIdForReporting = "netconf-test-session1";
 102
 103     private BindingTransactionChain transactionChain;
 104
 105     private DataBroker dataBroker;
 106
 107     private ConcurrentDOMDataBroker cDOMDataBroker;
 108
 109     @Before
 110     public void setUp() throws Exception {
 111         MockitoAnnotations.initMocks(this);
 112         doReturn(txChain).when(broker).createTransactionChain(any(TransactionChainListener.class));
 113         doReturn(writeTx).when(txChain).newWriteOnlyTransaction();
 114         doNothing().when(writeTx).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 115         doNothing().when(writeTx).merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 116
 117         doReturn(txIdent).when(writeTx).getIdentifier();
 118
 119         this.schemaContext = parseYangStreams(getYangSchemas());
 120         schemaContext.getModules();
 121         final SchemaService schemaService = createSchemaService();
 122
 123         final DOMStore operStore = InMemoryDOMDataStoreFactory.create("DOM-OPER", schemaService);
 124         final DOMStore configStore = InMemoryDOMDataStoreFactory.create("DOM-CFG", schemaService);
 125
 126         final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
 127         datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 128         datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 129
 130         ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(
 131                 16, 16, "CommitFutures");
 132
 133         cDOMDataBroker = new ConcurrentDOMDataBroker(datastores, listenableFutureExecutor);
 134
 135         final ClassPool pool = ClassPool.getDefault();
 136         final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(pool));
 137         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(generator);
 138         final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
 139         codecRegistry.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext, schemaContext));
 140
 141         final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
 142         final BindingToNormalizedNodeCodec bindingToNormalized = new BindingToNormalizedNodeCodec(loading, codecRegistry);
 143         bindingToNormalized.onGlobalContextUpdated(schemaContext);
 144         dataBroker = new BindingDOMDataBrokerAdapter(cDOMDataBroker, bindingToNormalized);
 145
 146         transactionChain = dataBroker.createTransactionChain(new TransactionChainListener() {
 147             @Override
 148             public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
 149
 150             }
 151
 152             @Override
 153             public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
 154
 155             }
 156         });
 157
 158     }
 159
 160     @Test
 161     public void testFailedDevice() throws Exception {
 162
 163         doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
 164         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
 165         adapter.setDeviceAsFailed(null);
 166
 167         verify(txChain, times(2)).newWriteOnlyTransaction();
 168         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 169         adapter.close();
 170
 171         adapter = new NetconfDeviceTopologyAdapter(id, transactionChain); //not a mock
 172         adapter.setDeviceAsFailed(null);
 173
 174         Optional<NetconfNode> netconfNode = dataBroker.newReadWriteTransaction().read(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class)).checkedGet(5, TimeUnit.SECONDS);
 175
 176         assertEquals("Netconf node should be presented.", true, netconfNode.isPresent());
 177         assertEquals("Connection status should be failed.", NetconfNodeConnectionStatus.ConnectionStatus.UnableToConnect.getName(), netconfNode.get().getConnectionStatus().getName());
 178
 179     }
 180
 181     @Test
 182     public void testDeviceUpdate() throws Exception {
 183         doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
 184
 185         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
 186         adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
 187
 188         verify(txChain, times(2)).newWriteOnlyTransaction();
 189         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 190         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 191
 192     }
 193
 194     @Test
 195     public void testDeviceAugmentedNodePresence() throws Exception {
 196
 197         Integer dataTestId = 474747;
 198
 199         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, transactionChain);
 200
 201         QName nTestLeafQname = QName.create("urn:TBD:params:xml:ns:yang:network-topology-augment-test", "2016-08-08", "test-id").intern();
 202
 203         YangInstanceIdentifier pathToAugmentedLeaf = YangInstanceIdentifier.builder().node(NetworkTopology.QNAME).
 204                 node(Topology.QNAME).nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"), "topology-netconf").
 205                 node(Node.QNAME).nodeWithKey(Node.QNAME, QName.create(Node.QNAME, "node-id"), "test").node(nTestLeafQname).build();
 206
 207         NormalizedNode<?, ?> augmentNode = ImmutableLeafNodeBuilder.create().withValue(dataTestId).withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(nTestLeafQname)).build();
 208
 209         DOMDataWriteTransaction writeTx =  cDOMDataBroker.newWriteOnlyTransaction();
 210         writeTx.put(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf, augmentNode);
 211         writeTx.submit();
 212
 213         adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
 214         Optional<NormalizedNode<?, ?>> testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
 215
 216         assertEquals("Augmented node data should be still present after device update.", true, testNode.isPresent());
 217         assertEquals("Augmented data should be the same as before update node.", dataTestId, testNode.get().getValue());
 218
 219         adapter.setDeviceAsFailed(null);
 220         testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
 221
 222         assertEquals("Augmented node data should be still present after device failed.", true, testNode.isPresent());
 223         assertEquals("Augmented data should be the same as before failed device.", dataTestId, testNode.get().getValue());
 224     }
 225
 226     private List<InputStream> getYangSchemas() {
 227         final List<String> schemaPaths = Arrays.asList("/schemas/network-topology@2013-10-21.yang",
 228                 "/schemas/ietf-inet-types@2013-07-15.yang", "/schemas/yang-ext.yang", "/schemas/netconf-node-topology.yang",
 229                 "/schemas/network-topology-augment-test@2016-08-08.yang");
 230         final List<InputStream> schemas = new ArrayList<>();
 231
 232         for (String schemaPath : schemaPaths) {
 233             InputStream resourceAsStream = getClass().getResourceAsStream(schemaPath);
 234             schemas.add(resourceAsStream);
 235         }
 236
 237         return schemas;
 238     }
 239
 240     private static SchemaContext parseYangStreams(final List<InputStream> streams) {
 241         CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
 242                 .newBuild();
 243         final SchemaContext schemaContext;
 244         try {
 245             schemaContext = reactor.buildEffective(streams);
 246         } catch (ReactorException e) {
 247             throw new RuntimeException("Unable to build schema context from " + streams, e);
 248         }
 249         return schemaContext;
 250     }
 251
 252     private SchemaService createSchemaService() {
 253         return new SchemaService() {
 254
 255             @Override
 256             public void addModule(Module module) {
 257             }
 258
 259             @Override
 260             public void removeModule(Module module) {
 261
 262             }
 263
 264             @Override
 265             public SchemaContext getSessionContext() {
 266                 return schemaContext;
 267             }
 268
 269             @Override
 270             public SchemaContext getGlobalContext() {
 271                 return schemaContext;
 272             }
 273
 274             @Override
 275             public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(final SchemaContextListener listener) {
 276                 listener.onGlobalContextUpdated(getGlobalContext());
 277                 return new ListenerRegistration<SchemaContextListener>() {
 278                     @Override
 279                     public void close() {
 280
 281                     }
 282
 283                     @Override
 284                     public SchemaContextListener getInstance() {
 285                         return listener;
 286                     }
 287                 };
 288             }
 289         };
 290     }
 291
 292 }