2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.sal.connect.netconf.sal;
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;
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.test.util.YangParserTestUtils;
73 public class NetconfDeviceTopologyAdapterTest {
75 private RemoteDeviceId id = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
78 private DataBroker broker;
80 private WriteTransaction writeTx;
82 private BindingTransactionChain txChain;
84 private NetconfNode data;
86 private String txIdent = "test transaction";
88 private SchemaContext schemaContext = null;
89 private String sessionIdForReporting = "netconf-test-session1";
91 private BindingTransactionChain transactionChain;
93 private DataBroker dataBroker;
95 private ConcurrentDOMDataBroker cDOMDataBroker;
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).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
103 doNothing().when(writeTx).merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
105 doReturn(txIdent).when(writeTx).getIdentifier();
107 this.schemaContext = YangParserTestUtils.parseYangStreams(getYangSchemas());
108 schemaContext.getModules();
109 final SchemaService schemaService = createSchemaService();
111 final DOMStore operStore = InMemoryDOMDataStoreFactory.create("DOM-OPER", schemaService);
112 final DOMStore configStore = InMemoryDOMDataStoreFactory.create("DOM-CFG", schemaService);
114 final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
115 datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
116 datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
118 ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(
119 16, 16, "CommitFutures");
121 cDOMDataBroker = new ConcurrentDOMDataBroker(datastores, listenableFutureExecutor);
123 final ClassPool pool = ClassPool.getDefault();
124 final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(JavassistUtils.forClassPool(pool));
125 final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(generator);
126 final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
127 codecRegistry.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext, schemaContext));
129 final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
130 final BindingToNormalizedNodeCodec bindingToNormalized = new BindingToNormalizedNodeCodec(loading, codecRegistry);
131 bindingToNormalized.onGlobalContextUpdated(schemaContext);
132 dataBroker = new BindingDOMDataBrokerAdapter(cDOMDataBroker, bindingToNormalized);
134 transactionChain = dataBroker.createTransactionChain(new TransactionChainListener() {
136 public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
141 public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
149 public void testFailedDevice() throws Exception {
151 doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
152 NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
153 adapter.setDeviceAsFailed(null);
155 verify(txChain, times(2)).newWriteOnlyTransaction();
156 verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
159 adapter = new NetconfDeviceTopologyAdapter(id, transactionChain); //not a mock
160 adapter.setDeviceAsFailed(null);
162 Optional<NetconfNode> netconfNode = dataBroker.newReadWriteTransaction().read(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class)).checkedGet(5, TimeUnit.SECONDS);
164 assertEquals("Netconf node should be presented.", true, netconfNode.isPresent());
165 assertEquals("Connection status should be failed.", NetconfNodeConnectionStatus.ConnectionStatus.UnableToConnect.getName(), netconfNode.get().getConnectionStatus().getName());
170 public void testDeviceUpdate() throws Exception {
171 doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
173 NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
174 adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
176 verify(txChain, times(2)).newWriteOnlyTransaction();
177 verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(NetconfNode.class));
178 verify(writeTx, times(1)).put(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(Node.class));
183 public void testDeviceAugmentedNodePresence() throws Exception {
185 Integer dataTestId = 474747;
187 NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, transactionChain);
189 QName nTestLeafQname = QName.create("urn:TBD:params:xml:ns:yang:network-topology-augment-test", "2016-08-08", "test-id").intern();
191 YangInstanceIdentifier pathToAugmentedLeaf = YangInstanceIdentifier.builder().node(NetworkTopology.QNAME).
192 node(Topology.QNAME).nodeWithKey(Topology.QNAME, QName.create(Topology.QNAME, "topology-id"), "topology-netconf").
193 node(Node.QNAME).nodeWithKey(Node.QNAME, QName.create(Node.QNAME, "node-id"), "test").node(nTestLeafQname).build();
195 NormalizedNode<?, ?> augmentNode = ImmutableLeafNodeBuilder.create().withValue(dataTestId).withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(nTestLeafQname)).build();
197 DOMDataWriteTransaction writeTx = cDOMDataBroker.newWriteOnlyTransaction();
198 writeTx.put(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf, augmentNode);
201 adapter.updateDeviceData(true, new NetconfDeviceCapabilities());
202 Optional<NormalizedNode<?, ?>> testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
204 assertEquals("Augmented node data should be still present after device update.", true, testNode.isPresent());
205 assertEquals("Augmented data should be the same as before update node.", dataTestId, testNode.get().getValue());
207 adapter.setDeviceAsFailed(null);
208 testNode = cDOMDataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.OPERATIONAL, pathToAugmentedLeaf).checkedGet(2, TimeUnit.SECONDS);
210 assertEquals("Augmented node data should be still present after device failed.", true, testNode.isPresent());
211 assertEquals("Augmented data should be the same as before failed device.", dataTestId, testNode.get().getValue());
214 private List<InputStream> getYangSchemas() {
215 final List<String> schemaPaths = Arrays.asList("/schemas/network-topology@2013-10-21.yang",
216 "/schemas/ietf-inet-types@2013-07-15.yang", "/schemas/yang-ext.yang", "/schemas/netconf-node-topology.yang",
217 "/schemas/network-topology-augment-test@2016-08-08.yang");
218 final List<InputStream> schemas = new ArrayList<>();
220 for (String schemaPath : schemaPaths) {
221 InputStream resourceAsStream = getClass().getResourceAsStream(schemaPath);
222 schemas.add(resourceAsStream);
228 private SchemaService createSchemaService() {
229 return new SchemaService() {
232 public void addModule(Module module) {
236 public void removeModule(Module module) {
241 public SchemaContext getSessionContext() {
242 return schemaContext;
246 public SchemaContext getGlobalContext() {
247 return schemaContext;
251 public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(final SchemaContextListener listener) {
252 listener.onGlobalContextUpdated(getGlobalContext());
253 return new ListenerRegistration<SchemaContextListener>() {
255 public void close() {
260 public SchemaContextListener getInstance() {
269 public void testRemoveDeviceConfiguration() throws Exception {
270 doReturn(Futures.immediateCheckedFuture(null)).when(writeTx).submit();
272 NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(id, txChain);
275 verify(txChain, times(2)).newWriteOnlyTransaction();
276 verify(writeTx).delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
277 verify(writeTx, times(2)).submit();