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 com.google.common.base.Optional;
19 import com.google.common.collect.Lists;
20 import com.google.common.util.concurrent.Futures;
21 import java.io.InputStream;
22 import java.util.ArrayList;
23 import java.util.Collection;
24 import java.util.Collections;
25 import java.util.List;
27 import java.util.concurrent.ExecutorService;
28 import java.util.concurrent.Executors;
29 import org.junit.Test;
30 import org.mockito.Mockito;
31 import org.opendaylight.controller.netconf.api.NetconfMessage;
32 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
33 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
34 import org.opendaylight.controller.sal.connect.api.RemoteDeviceCommunicator;
35 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
36 import org.opendaylight.controller.sal.connect.api.SchemaContextProviderFactory;
37 import org.opendaylight.controller.sal.connect.api.SchemaSourceProviderFactory;
38 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionCapabilities;
39 import org.opendaylight.controller.sal.connect.netconf.sal.NetconfDeviceRpc;
40 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
41 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
42 import org.opendaylight.controller.sal.core.api.RpcImplementation;
43 import org.opendaylight.yangtools.yang.common.QName;
44 import org.opendaylight.yangtools.yang.common.RpcResult;
45 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
46 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
47 import org.opendaylight.yangtools.yang.model.api.Module;
48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
50 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider;
51 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
53 public class NetconfDeviceTest {
55 private static final NetconfMessage netconfMessage;
56 private static final CompositeNode compositeNode;
60 netconfMessage = mockClass(NetconfMessage.class);
61 compositeNode = mockClass(CompositeNode.class);
62 } catch (final Exception e) {
63 throw new RuntimeException(e);
67 private static final RpcResult<NetconfMessage> rpcResult = RpcResultBuilder.success(netconfMessage).build();
68 private static final RpcResult<CompositeNode> rpcResultC = RpcResultBuilder.success(compositeNode).build();
70 public static final String TEST_NAMESPACE = "test:namespace";
71 public static final String TEST_MODULE = "test-module";
72 public static final String TEST_REVISION = "2013-07-22";
73 private NetconfStateSchemas.NetconfStateSchemasResolver stateSchemasResolver = new NetconfStateSchemas.NetconfStateSchemasResolver() {
76 public NetconfStateSchemas resolve(final NetconfDeviceRpc deviceRpc, final NetconfSessionCapabilities remoteSessionCapabilities, final RemoteDeviceId id) {
77 return NetconfStateSchemas.EMPTY;
82 public void testNetconfDeviceWithoutMonitoring() throws Exception {
83 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
84 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
86 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), getMessageTransformer(), getSchemaContextProviderFactory(), getSourceProviderFactory(), stateSchemasResolver);
87 device.onRemoteSessionUp(getSessionCaps(false, Collections.<String>emptyList()), listener);
89 Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
93 public void testNotificationBeforeSchema() throws Exception {
94 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
95 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
97 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
98 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, getSchemaContextProviderFactory(), getSourceProviderFactory(), stateSchemasResolver);
100 device.onNotification(netconfMessage);
101 device.onNotification(netconfMessage);
103 verify(facade, times(0)).onNotification(any(CompositeNode.class));
105 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
106 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
108 device.onRemoteSessionUp(sessionCaps, listener);
110 verify(messageTransformer, timeout(10000).times(2)).toNotification(netconfMessage);
111 verify(facade, timeout(10000).times(2)).onNotification(compositeNode);
113 device.onNotification(netconfMessage);
114 verify(messageTransformer, timeout(10000).times(3)).toNotification(netconfMessage);
115 verify(facade, timeout(10000).times(3)).onNotification(compositeNode);
119 public void testNetconfDeviceReconnect() throws Exception {
120 final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
121 final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
123 final SchemaContextProviderFactory schemaContextProviderFactory = getSchemaContextProviderFactory();
124 final SchemaSourceProviderFactory<InputStream> sourceProviderFactory = getSourceProviderFactory();
125 final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
127 final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, schemaContextProviderFactory, sourceProviderFactory, stateSchemasResolver);
128 final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
129 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
130 device.onRemoteSessionUp(sessionCaps, listener);
132 verify(sourceProviderFactory, timeout(5000)).createSourceProvider(any(RpcImplementation.class));
133 verify(schemaContextProviderFactory, timeout(5000)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
134 verify(messageTransformer, timeout(5000)).onGlobalContextUpdated(any(SchemaContext.class));
135 verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
137 device.onRemoteSessionDown();
138 verify(facade, timeout(5000)).onDeviceDisconnected();
140 device.onRemoteSessionUp(sessionCaps, listener);
142 verify(sourceProviderFactory, timeout(5000).times(2)).createSourceProvider(any(RpcImplementation.class));
143 verify(schemaContextProviderFactory, timeout(5000).times(2)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
144 verify(messageTransformer, timeout(5000).times(2)).onGlobalContextUpdated(any(SchemaContext.class));
145 verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
148 private SchemaContextProviderFactory getSchemaContextProviderFactory() {
149 final SchemaContextProviderFactory schemaContextProviderFactory = mockClass(SchemaContextProviderFactory.class);
150 doReturn(new SchemaContextProvider() {
152 public SchemaContext getSchemaContext() {
155 }).when(schemaContextProviderFactory).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
156 return schemaContextProviderFactory;
159 public static SchemaContext getSchema() {
160 final YangParserImpl parser = new YangParserImpl();
161 final List<InputStream> modelsToParse = Lists.newArrayList(
162 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
164 final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
165 return parser.resolveSchemaContext(models);
168 private RemoteDeviceHandler<NetconfSessionCapabilities> getFacade() throws Exception {
169 final RemoteDeviceHandler<NetconfSessionCapabilities> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
170 doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
171 doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
172 doNothing().when(remoteDeviceHandler).onNotification(any(CompositeNode.class));
173 return remoteDeviceHandler;
176 private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
177 final T mock = mockClass(remoteDeviceHandlerClass);
178 doNothing().when(mock).close();
182 public SchemaSourceProviderFactory<InputStream> getSourceProviderFactory() {
183 final SchemaSourceProviderFactory<InputStream> mock = mockClass(SchemaSourceProviderFactory.class);
185 final SchemaSourceProvider<InputStream> schemaSourceProvider = mockClass(SchemaSourceProvider.class);
186 doReturn(Optional.<String>absent()).when(schemaSourceProvider).getSchemaSource(anyString(), any(Optional.class));
188 doReturn(schemaSourceProvider).when(mock).createSourceProvider(any(RpcImplementation.class));
192 private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
193 final T mock = Mockito.mock(remoteDeviceHandlerClass);
194 Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
198 public RemoteDeviceId getId() {
199 return new RemoteDeviceId("test-D");
202 public ExecutorService getExecutor() {
203 return Executors.newSingleThreadExecutor();
206 public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
207 final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
208 doReturn(netconfMessage).when(messageTransformer).toRpcRequest(any(QName.class), any(CompositeNode.class));
209 doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(QName.class));
210 doReturn(compositeNode).when(messageTransformer).toNotification(any(NetconfMessage.class));
211 doNothing().when(messageTransformer).onGlobalContextUpdated(any(SchemaContext.class));
212 return messageTransformer;
215 public NetconfSessionCapabilities getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
216 final ArrayList<String> capabilities = Lists.newArrayList(
217 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
218 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
221 capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
224 capabilities.addAll(additionalCapabilities);
226 return NetconfSessionCapabilities.fromStrings(
230 public RemoteDeviceCommunicator<NetconfMessage> getListener() throws Exception {
231 final RemoteDeviceCommunicator<NetconfMessage> remoteDeviceCommunicator = mockCloseableClass(RemoteDeviceCommunicator.class);
232 doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
233 return remoteDeviceCommunicator;