2 * Copyright (c) 2014 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
8 package org.opendaylight.controller.sal.connect.netconf;
10 import static org.mockito.Matchers.any;
11 import static org.mockito.Matchers.anyString;
12 import static org.mockito.Mockito.doNothing;
13 import static org.mockito.Mockito.doReturn;
14 import static org.mockito.Mockito.timeout;
15 import static org.mockito.Mockito.times;
16 import static org.mockito.Mockito.verify;
18 import java.io.InputStream;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.List;
24 import java.util.concurrent.ExecutorService;
25 import java.util.concurrent.Executors;
27 import org.junit.Test;
28 import org.mockito.Mockito;
29 import org.opendaylight.controller.netconf.api.NetconfMessage;
30 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
31 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
32 import org.opendaylight.controller.sal.connect.api.RemoteDeviceCommunicator;
33 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
34 import org.opendaylight.controller.sal.connect.api.SchemaContextProviderFactory;
35 import org.opendaylight.controller.sal.connect.api.SchemaSourceProviderFactory;
36 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionCapabilities;
37 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
38 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
39 import org.opendaylight.controller.sal.core.api.RpcImplementation;
40 import org.opendaylight.yangtools.yang.common.QName;
41 import org.opendaylight.yangtools.yang.common.RpcResult;
42 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
43 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
44 import org.opendaylight.yangtools.yang.model.api.Module;
45 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
47 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider;
48 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
50 import com.google.common.base.Optional;
51 import com.google.common.collect.Lists;
52 import com.google.common.util.concurrent.Futures;
54 public class NetconfDeviceTest {
56 private static final NetconfMessage netconfMessage;
57 private static final CompositeNode compositeNode;
61 netconfMessage = mockClass(NetconfMessage.class);
62 compositeNode = mockClass(CompositeNode.class);
63 } catch (final Exception e) {
64 throw new RuntimeException(e);
68 private static final RpcResult<NetconfMessage> rpcResult = RpcResultBuilder.success(netconfMessage).build();
69 private static final RpcResult<CompositeNode> rpcResultC = RpcResultBuilder.success(compositeNode).build();
71 public static final String TEST_NAMESPACE = "test:namespace";
72 public static final String TEST_MODULE = "test-module";
73 public static final String TEST_REVISION = "2013-07-22";
76 public void testNetconfDeviceWithoutMonitoring() throws Exception {
77 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
78 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
80 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), getMessageTransformer(), getSchemaContextProviderFactory(), getSourceProviderFactory());
81 device.onRemoteSessionUp(getSessionCaps(false, Collections.<String>emptyList()), listener);
83 Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
87 public void testNotificationBeforeSchema() throws Exception {
88 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
89 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
91 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
92 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, getSchemaContextProviderFactory(), getSourceProviderFactory());
94 device.onNotification(netconfMessage);
95 device.onNotification(netconfMessage);
97 verify(facade, times(0)).onNotification(any(CompositeNode.class));
99 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
100 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
102 device.onRemoteSessionUp(sessionCaps, listener);
104 verify(messageTransformer, timeout(10000).times(2)).toNotification(netconfMessage);
105 verify(facade, timeout(10000).times(2)).onNotification(compositeNode);
107 device.onNotification(netconfMessage);
108 verify(messageTransformer, timeout(10000).times(3)).toNotification(netconfMessage);
109 verify(facade, timeout(10000).times(3)).onNotification(compositeNode);
113 public void testNetconfDeviceReconnect() throws Exception {
114 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
115 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
117 final SchemaContextProviderFactory schemaContextProviderFactory = getSchemaContextProviderFactory();
118 final SchemaSourceProviderFactory<InputStream> sourceProviderFactory = getSourceProviderFactory();
119 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
121 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, schemaContextProviderFactory, sourceProviderFactory);
122 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
123 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
124 device.onRemoteSessionUp(sessionCaps, listener);
126 verify(sourceProviderFactory, timeout(5000)).createSourceProvider(any(RpcImplementation.class));
127 verify(schemaContextProviderFactory, timeout(5000)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
128 verify(messageTransformer, timeout(5000)).onGlobalContextUpdated(any(SchemaContext.class));
129 verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
131 device.onRemoteSessionDown();
132 verify(facade, timeout(5000)).onDeviceDisconnected();
134 device.onRemoteSessionUp(sessionCaps, listener);
136 verify(sourceProviderFactory, timeout(5000).times(2)).createSourceProvider(any(RpcImplementation.class));
137 verify(schemaContextProviderFactory, timeout(5000).times(2)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
138 verify(messageTransformer, timeout(5000).times(2)).onGlobalContextUpdated(any(SchemaContext.class));
139 verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
142 private SchemaContextProviderFactory getSchemaContextProviderFactory() {
143 final SchemaContextProviderFactory schemaContextProviderFactory = mockClass(SchemaContextProviderFactory.class);
144 doReturn(new SchemaContextProvider() {
146 public SchemaContext getSchemaContext() {
149 }).when(schemaContextProviderFactory).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
150 return schemaContextProviderFactory;
153 public static SchemaContext getSchema() {
154 final YangParserImpl parser = new YangParserImpl();
155 final List<InputStream> modelsToParse = Lists.newArrayList(
156 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
158 final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
159 return parser.resolveSchemaContext(models);
162 private RemoteDeviceHandler<NetconfSessionCapabilities> getFacade() throws Exception {
163 final RemoteDeviceHandler<NetconfSessionCapabilities> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
164 doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
165 doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
166 doNothing().when(remoteDeviceHandler).onNotification(any(CompositeNode.class));
167 return remoteDeviceHandler;
170 private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
171 final T mock = mockClass(remoteDeviceHandlerClass);
172 doNothing().when(mock).close();
176 public SchemaSourceProviderFactory<InputStream> getSourceProviderFactory() {
177 final SchemaSourceProviderFactory<InputStream> mock = mockClass(SchemaSourceProviderFactory.class);
179 final SchemaSourceProvider<InputStream> schemaSourceProvider = mockClass(SchemaSourceProvider.class);
180 doReturn(Optional.<String>absent()).when(schemaSourceProvider).getSchemaSource(anyString(), any(Optional.class));
182 doReturn(schemaSourceProvider).when(mock).createSourceProvider(any(RpcImplementation.class));
186 private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
187 final T mock = Mockito.mock(remoteDeviceHandlerClass);
188 Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
192 public RemoteDeviceId getId() {
193 return new RemoteDeviceId("test-D");
196 public ExecutorService getExecutor() {
197 return Executors.newSingleThreadExecutor();
200 public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
201 final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
202 doReturn(netconfMessage).when(messageTransformer).toRpcRequest(any(QName.class), any(CompositeNode.class));
203 doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(QName.class));
204 doReturn(compositeNode).when(messageTransformer).toNotification(any(NetconfMessage.class));
205 doNothing().when(messageTransformer).onGlobalContextUpdated(any(SchemaContext.class));
206 return messageTransformer;
209 public NetconfSessionCapabilities getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
210 final ArrayList<String> capabilities = Lists.newArrayList(
211 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
212 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
215 capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
218 capabilities.addAll(additionalCapabilities);
220 return NetconfSessionCapabilities.fromStrings(
224 public RemoteDeviceCommunicator<NetconfMessage> getListener() throws Exception {
225 final RemoteDeviceCommunicator<NetconfMessage> remoteDeviceCommunicator = mockCloseableClass(RemoteDeviceCommunicator.class);
226 doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
227 return remoteDeviceCommunicator;