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.common.util.Rpcs;
32 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
33 import org.opendaylight.controller.sal.connect.api.RemoteDeviceCommunicator;
34 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
35 import org.opendaylight.controller.sal.connect.api.SchemaContextProviderFactory;
36 import org.opendaylight.controller.sal.connect.api.SchemaSourceProviderFactory;
37 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionCapabilities;
38 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
39 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
40 import org.opendaylight.controller.sal.core.api.RpcImplementation;
41 import org.opendaylight.yangtools.yang.common.QName;
42 import org.opendaylight.yangtools.yang.common.RpcError;
43 import org.opendaylight.yangtools.yang.common.RpcResult;
44 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
45 import org.opendaylight.yangtools.yang.model.api.Module;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
47 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
48 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider;
49 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
51 import com.google.common.base.Optional;
52 import com.google.common.collect.Lists;
53 import com.google.common.util.concurrent.Futures;
55 public class NetconfDeviceTest {
57 private static final NetconfMessage netconfMessage;
58 private static final CompositeNode compositeNode;
62 netconfMessage = mockClass(NetconfMessage.class);
63 compositeNode = mockClass(CompositeNode.class);
64 } catch (final Exception e) {
65 throw new RuntimeException(e);
69 private static final RpcResult<NetconfMessage> rpcResult = Rpcs.getRpcResult(true, netconfMessage, Collections.<RpcError>emptySet());
70 private static final RpcResult<CompositeNode> rpcResultC = Rpcs.getRpcResult(true, compositeNode, Collections.<RpcError>emptySet());
72 public static final String TEST_NAMESPACE = "test:namespace";
73 public static final String TEST_MODULE = "test-module";
74 public static final String TEST_REVISION = "2013-07-22";
77 public void testNetconfDeviceWithoutMonitoring() throws Exception {
78 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
79 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
81 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), getMessageTransformer(), getSchemaContextProviderFactory(), getSourceProviderFactory());
82 device.onRemoteSessionUp(getSessionCaps(false, Collections.<String>emptyList()), listener);
84 Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
88 public void testNotificationBeforeSchema() throws Exception {
89 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
90 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
92 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
93 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, getSchemaContextProviderFactory(), getSourceProviderFactory());
95 device.onNotification(netconfMessage);
96 device.onNotification(netconfMessage);
98 verify(facade, times(0)).onNotification(any(CompositeNode.class));
100 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
101 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
103 device.onRemoteSessionUp(sessionCaps, listener);
105 verify(messageTransformer, timeout(10000).times(2)).toNotification(netconfMessage);
106 verify(facade, times(2)).onNotification(compositeNode);
108 device.onNotification(netconfMessage);
109 verify(messageTransformer, times(3)).toNotification(netconfMessage);
110 verify(facade, times(3)).onNotification(compositeNode);
114 public void testNetconfDeviceReconnect() throws Exception {
115 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
116 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
118 final SchemaContextProviderFactory schemaContextProviderFactory = getSchemaContextProviderFactory();
119 final SchemaSourceProviderFactory<InputStream> sourceProviderFactory = getSourceProviderFactory();
120 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
122 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, schemaContextProviderFactory, sourceProviderFactory);
123 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
124 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
125 device.onRemoteSessionUp(sessionCaps, listener);
127 verify(sourceProviderFactory, timeout(5000)).createSourceProvider(any(RpcImplementation.class));
128 verify(schemaContextProviderFactory, timeout(5000)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
129 verify(messageTransformer, timeout(5000)).onGlobalContextUpdated(any(SchemaContext.class));
130 verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
132 device.onRemoteSessionDown();
133 verify(facade, timeout(5000)).onDeviceDisconnected();
135 device.onRemoteSessionUp(sessionCaps, listener);
137 verify(sourceProviderFactory, timeout(5000).times(2)).createSourceProvider(any(RpcImplementation.class));
138 verify(schemaContextProviderFactory, timeout(5000).times(2)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
139 verify(messageTransformer, timeout(5000).times(2)).onGlobalContextUpdated(any(SchemaContext.class));
140 verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
143 private SchemaContextProviderFactory getSchemaContextProviderFactory() {
144 final SchemaContextProviderFactory schemaContextProviderFactory = mockClass(SchemaContextProviderFactory.class);
145 doReturn(new SchemaContextProvider() {
147 public SchemaContext getSchemaContext() {
150 }).when(schemaContextProviderFactory).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
151 return schemaContextProviderFactory;
154 public static SchemaContext getSchema() {
155 final YangParserImpl parser = new YangParserImpl();
156 final List<InputStream> modelsToParse = Lists.newArrayList(
157 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
159 final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
160 return parser.resolveSchemaContext(models);
163 private RemoteDeviceHandler<NetconfSessionCapabilities> getFacade() throws Exception {
164 final RemoteDeviceHandler<NetconfSessionCapabilities> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
165 doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
166 doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
167 doNothing().when(remoteDeviceHandler).onNotification(any(CompositeNode.class));
168 return remoteDeviceHandler;
171 private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
172 final T mock = mockClass(remoteDeviceHandlerClass);
173 doNothing().when(mock).close();
177 public SchemaSourceProviderFactory<InputStream> getSourceProviderFactory() {
178 final SchemaSourceProviderFactory<InputStream> mock = mockClass(SchemaSourceProviderFactory.class);
180 final SchemaSourceProvider<InputStream> schemaSourceProvider = mockClass(SchemaSourceProvider.class);
181 doReturn(Optional.<String>absent()).when(schemaSourceProvider).getSchemaSource(anyString(), any(Optional.class));
183 doReturn(schemaSourceProvider).when(mock).createSourceProvider(any(RpcImplementation.class));
187 private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
188 final T mock = Mockito.mock(remoteDeviceHandlerClass);
189 Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
193 public RemoteDeviceId getId() {
194 return new RemoteDeviceId("test-D");
197 public ExecutorService getExecutor() {
198 return Executors.newSingleThreadExecutor();
201 public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
202 final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
203 doReturn(netconfMessage).when(messageTransformer).toRpcRequest(any(QName.class), any(CompositeNode.class));
204 doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(QName.class));
205 doReturn(compositeNode).when(messageTransformer).toNotification(any(NetconfMessage.class));
206 doNothing().when(messageTransformer).onGlobalContextUpdated(any(SchemaContext.class));
207 return messageTransformer;
210 public NetconfSessionCapabilities getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
211 final ArrayList<String> capabilities = Lists.newArrayList(
212 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
213 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
216 capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
219 capabilities.addAll(additionalCapabilities);
221 return NetconfSessionCapabilities.fromStrings(
225 public RemoteDeviceCommunicator<NetconfMessage> getListener() throws Exception {
226 final RemoteDeviceCommunicator<NetconfMessage> remoteDeviceCommunicator = mockCloseableClass(RemoteDeviceCommunicator.class);
227 doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
228 return remoteDeviceCommunicator;