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