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.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  48 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  54 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  55 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  56 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  57 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  58 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  59 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
  60 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  61 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
  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.parser.spi.meta.ReactorException;
  72 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  73 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
  74
  75 public class NetconfDeviceTopologyAdapterTest {
  76
  77     private RemoteDeviceId id = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  78
  79     @Mock
  80     private DataBroker broker;
  81     @Mock
  82     private WriteTransaction writeTx;
  83     @Mock
  84     private BindingTransactionChain txChain;
  85     @Mock
  86     private NetconfNode data;
  87
  88     private String txIdent = "test transaction";
  89
  90     private SchemaContext schemaContext = null;
  91     private String sessionIdForReporting = "netconf-test-session1";
  92
  93     private BindingTransactionChain transactionChain;
  94
  95     private DataBroker dataBroker;
  96
  97     private ConcurrentDOMDataBroker cDOMDataBroker;
  98
  99     @Before
 100     public void setUp() throws Exception {
 101         MockitoAnnotations.initMocks(this);
 102         doReturn(txChain).when(broker).createTransactionChain(any(TransactionChainListener.class));
 103         doReturn(writeTx).when(txChain).newWriteOnlyTransaction();
 104         doNothing().when(writeTx).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 105         doNothing().when(writeTx).merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 106
 107         doReturn(txIdent).when(writeTx).getIdentifier();
 108
 109         this.schemaContext = 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         cDOMDataBroker = 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(BindingRuntimeContext.create(moduleInfoBackedContext, schemaContext));
 130
 131         final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
 132         final BindingToNormalizedNodeCodec bindingToNormalized = new BindingToNormalizedNodeCodec(loading, codecRegistry);
 133         bindingToNormalized.onGlobalContextUpdated(schemaContext);
 134         dataBroker = new BindingDOMDataBrokerAdapter(cDOMDataBroker, bindingToNormalized);
 135
 136         transactionChain = dataBroker.createTransactionChain(new TransactionChainListener() {
 137             @Override
 138             public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
 139
 140             }
 141
 142             @Override
 143             public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
 144
 145             }
 146         });
 147
 148     }
 149
 150     @Test
 151     public void testFailedDevice() throws Exception {
 152
 153         doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
 154         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
 155         adapter.setDeviceAsFailed(null);
 156
 157         verify(txChain, times(2)).newWriteOnlyTransaction();
 158         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 159         adapter.close();
 160
 161         adapter = new NetconfDeviceTopologyAdapter(id, transactionChain); //not a mock
 162         adapter.setDeviceAsFailed(null);
 163
 164         Optional<NetconfNode> netconfNode = dataBroker.newReadWriteTransaction().read(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class)).checkedGet(5, TimeUnit.SECONDS);
 165
 166         assertEquals("Netconf node should be presented.", true, netconfNode.isPresent());
 167         assertEquals("Connection status should be failed.", NetconfNodeConnectionStatus.ConnectionStatus.UnableToConnect.getName(), netconfNode.get().getConnectionStatus().getName());
 168
 169     }
 170
 171     @Test
 172     public void testDeviceUpdate() throws Exception {
 173         doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
 174
 175         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
 176         adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
 177
 178         verify(txChain, times(2)).newWriteOnlyTransaction();
 179         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
 180         verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
 181
 182     }
 183
 184     @Test
 185     public void testDeviceAugmentedNodePresence() throws Exception {
 186
 187         Integer dataTestId = 474747;
 188
 189         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, transactionChain);
 190
 191         QName nTestLeafQname = QName.create("urn:TBD:params:xml:ns:yang:network-topology-augment-test", "2016-08-08", "test-id").intern();
 192
 193         YangInstanceIdentifier pathToAugmentedLeaf = YangInstanceIdentifier.builder().node(NetworkTopology.QNAME).
 194                 node(Topology.QNAME).nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"), "topology-netconf").
 195                 node(Node.QNAME).nodeWithKey(Node.QNAME, QName.create(Node.QNAME, "node-id"), "test").node(nTestLeafQname).build();
 196
 197         NormalizedNode<?, ?> augmentNode = ImmutableLeafNodeBuilder.create().withValue(dataTestId).withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(nTestLeafQname)).build();
 198
 199         DOMDataWriteTransaction writeTx =  cDOMDataBroker.newWriteOnlyTransaction();
 200         writeTx.put(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf, augmentNode);
 201         writeTx.submit();
 202
 203         adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
 204         Optional<NormalizedNode<?, ?>> testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
 205
 206         assertEquals("Augmented node data should be still present after device update.", true, testNode.isPresent());
 207         assertEquals("Augmented data should be the same as before update node.", dataTestId, testNode.get().getValue());
 208
 209         adapter.setDeviceAsFailed(null);
 210         testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
 211
 212         assertEquals("Augmented node data should be still present after device failed.", true, testNode.isPresent());
 213         assertEquals("Augmented data should be the same as before failed device.", dataTestId, testNode.get().getValue());
 214     }
 215
 216     private List<InputStream> getYangSchemas() {
 217         final List<String> schemaPaths = Arrays.asList("/schemas/network-topology@2013-10-21.yang",
 218                 "/schemas/ietf-inet-types@2013-07-15.yang", "/schemas/yang-ext.yang", "/schemas/netconf-node-topology.yang",
 219                 "/schemas/network-topology-augment-test@2016-08-08.yang");
 220         final List<InputStream> schemas = new ArrayList<>();
 221
 222         for (String schemaPath : schemaPaths) {
 223             InputStream resourceAsStream = getClass().getResourceAsStream(schemaPath);
 224             schemas.add(resourceAsStream);
 225         }
 226
 227         return schemas;
 228     }
 229
 230     private static SchemaContext parseYangStreams(final List<InputStream> streams) {
 231         CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR
 232                 .newBuild();
 233         final SchemaContext schemaContext;
 234         try {
 235             schemaContext = reactor.buildEffective(streams);
 236         } catch (ReactorException e) {
 237             throw new RuntimeException("Unable to build schema context from " + streams, e);
 238         }
 239         return schemaContext;
 240     }
 241
 242     private SchemaService createSchemaService() {
 243         return new SchemaService() {
 244
 245             @Override
 246             public void addModule(Module module) {
 247             }
 248
 249             @Override
 250             public void removeModule(Module module) {
 251
 252             }
 253
 254             @Override
 255             public SchemaContext getSessionContext() {
 256                 return schemaContext;
 257             }
 258
 259             @Override
 260             public SchemaContext getGlobalContext() {
 261                 return schemaContext;
 262             }
 263
 264             @Override
 265             public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(final SchemaContextListener listener) {
 266                 listener.onGlobalContextUpdated(getGlobalContext());
 267                 return new ListenerRegistration<SchemaContextListener>() {
 268                     @Override
 269                     public void close() {
 270
 271                     }
 272
 273                     @Override
 274                     public SchemaContextListener getInstance() {
 275                         return listener;
 276                     }
 277                 };
 278             }
 279         };
 280     }
 281
 282     @Test
 283     public void testRemoveDeviceConfiguration() throws Exception {
 284         doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
 285
 286         NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
 287         adapter.close();
 288
 289         verify(txChain, times(2)).newWriteOnlyTransaction();
 290         verify(writeTx).delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 291         verify(writeTx, times(2)).submit();
 292     }
 293
 294 }