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.anyCollectionOf;
12 import static org.mockito.Mockito.doAnswer;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
16 import static org.mockito.Mockito.timeout;
17 import static org.mockito.Mockito.times;
18 import static org.mockito.Mockito.verify;
20 import com.google.common.base.Optional;
21 import com.google.common.collect.HashMultimap;
22 import com.google.common.collect.Iterables;
23 import com.google.common.collect.Lists;
24 import com.google.common.collect.Sets;
25 import com.google.common.util.concurrent.Futures;
26 import java.io.InputStream;
27 import java.util.ArrayList;
28 import java.util.Collection;
29 import java.util.Collections;
30 import java.util.List;
32 import java.util.concurrent.ExecutorService;
33 import java.util.concurrent.Executors;
34 import org.junit.Test;
35 import org.mockito.Mockito;
36 import org.mockito.invocation.InvocationOnMock;
37 import org.mockito.stubbing.Answer;
38 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
39 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
40 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
41 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
42 import org.opendaylight.controller.netconf.api.NetconfMessage;
43 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
44 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
45 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
46 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
47 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCommunicator;
48 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
49 import org.opendaylight.controller.sal.connect.netconf.sal.NetconfDeviceRpc;
50 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
51 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
52 import org.opendaylight.yangtools.yang.common.QName;
53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
55 import org.opendaylight.yangtools.yang.model.api.Module;
56 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
57 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
58 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
59 import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
60 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
61 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
62 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
63 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
64 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
65 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
66 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
68 public class NetconfDeviceTest {
70 private static final NetconfMessage notification;
72 private static final ContainerNode compositeNode;
76 compositeNode = mockClass(ContainerNode.class);
77 } catch (final Exception e) {
78 throw new RuntimeException(e);
81 notification = new NetconfMessage(XmlUtil.readXmlToDocument(NetconfDeviceTest.class.getResourceAsStream("/notification-payload.xml")));
82 } catch (Exception e) {
83 throw new ExceptionInInitializerError(e);
87 private static final DOMRpcResult rpcResultC = new DefaultDOMRpcResult(compositeNode);
89 public static final String TEST_NAMESPACE = "test:namespace";
90 public static final String TEST_MODULE = "test-module";
91 public static final String TEST_REVISION = "2013-07-22";
92 public static final SourceIdentifier TEST_SID = new SourceIdentifier(TEST_MODULE, Optional.of(TEST_REVISION));
93 public static final String TEST_CAPABILITY = TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION;
95 public static final SourceIdentifier TEST_SID2 = new SourceIdentifier(TEST_MODULE + "2", Optional.of(TEST_REVISION));
96 public static final String TEST_CAPABILITY2 = TEST_NAMESPACE + "?module=" + TEST_MODULE + "2" + "&revision=" + TEST_REVISION;
98 private static final NetconfStateSchemas.NetconfStateSchemasResolver stateSchemasResolver = new NetconfStateSchemas.NetconfStateSchemasResolver() {
101 public NetconfStateSchemas resolve(final NetconfDeviceRpc deviceRpc, final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id) {
102 return NetconfStateSchemas.EMPTY;
107 public void testNetconfDeviceFailFirstSchemaFailSecondEmpty() throws Exception {
108 final ArrayList<String> capList = Lists.newArrayList(TEST_CAPABILITY);
110 final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
111 final NetconfDeviceCommunicator listener = getListener();
113 final SchemaContextFactory schemaFactory = getSchemaFactory();
115 // Make fallback attempt to fail due to empty resolved sources
116 final SchemaResolutionException schemaResolutionException
117 = new SchemaResolutionException("fail first",
118 Collections.<SourceIdentifier>emptyList(), HashMultimap.<SourceIdentifier, ModuleImport>create());
119 doReturn(Futures.immediateFailedCheckedFuture(
120 schemaResolutionException))
121 .when(schemaFactory).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
123 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
124 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaFactory, stateSchemasResolver);
125 final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(),true);
126 // Monitoring not supported
127 final NetconfSessionPreferences sessionCaps = getSessionCaps(false, capList);
128 device.onRemoteSessionUp(sessionCaps, listener);
130 Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
131 Mockito.verify(listener, Mockito.timeout(5000)).close();
132 Mockito.verify(schemaFactory, times(1)).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
136 public void testNetconfDeviceMissingSource() throws Exception {
137 final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
138 final NetconfDeviceCommunicator listener = getListener();
139 final SchemaContext schema = getSchema();
141 final SchemaContextFactory schemaFactory = getSchemaFactory();
143 // Make fallback attempt to fail due to empty resolved sources
144 final MissingSchemaSourceException schemaResolutionException = new MissingSchemaSourceException("fail first", TEST_SID);
145 doAnswer(new Answer<Object>() {
147 public Object answer(final InvocationOnMock invocation) throws Throwable {
148 if(((Collection<?>) invocation.getArguments()[0]).size() == 2) {
149 return Futures.immediateFailedCheckedFuture(schemaResolutionException);
151 return Futures.immediateCheckedFuture(schema);
154 }).when(schemaFactory).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
156 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
157 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaFactory, new NetconfStateSchemas.NetconfStateSchemasResolver() {
159 public NetconfStateSchemas resolve(final NetconfDeviceRpc deviceRpc, final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id) {
160 final Module first = Iterables.getFirst(schema.getModules(), null);
161 final QName qName = QName.create(first.getQNameModule(), first.getName());
162 final NetconfStateSchemas.RemoteYangSchema source1 = new NetconfStateSchemas.RemoteYangSchema(qName);
163 final NetconfStateSchemas.RemoteYangSchema source2 = new NetconfStateSchemas.RemoteYangSchema(QName.create(first.getQNameModule(), "test-module2"));
164 return new NetconfStateSchemas(Sets.newHashSet(source1, source2));
168 final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
169 // Monitoring supported
170 final NetconfSessionPreferences sessionCaps = getSessionCaps(true, Lists.newArrayList(TEST_CAPABILITY, TEST_CAPABILITY2));
171 device.onRemoteSessionUp(sessionCaps, listener);
173 Mockito.verify(facade, Mockito.timeout(5000)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(NetconfDeviceRpc.class));
174 Mockito.verify(schemaFactory, times(2)).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
177 private SchemaSourceRegistry getSchemaRegistry() {
178 final SchemaSourceRegistry mock = mock(SchemaSourceRegistry.class);
179 final SchemaSourceRegistration<?> mockReg = mock(SchemaSourceRegistration.class);
180 doNothing().when(mockReg).close();
181 doReturn(mockReg).when(mock).registerSchemaSource(any(org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider.class), any(PotentialSchemaSource.class));
186 public void testNotificationBeforeSchema() throws Exception {
187 final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
188 final NetconfDeviceCommunicator listener = getListener();
190 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
191 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), getSchemaFactory(), stateSchemasResolver);
192 final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
194 device.onNotification(notification);
195 device.onNotification(notification);
197 verify(facade, times(0)).onNotification(any(DOMNotification.class));
199 final NetconfSessionPreferences sessionCaps = getSessionCaps(true,
200 Lists.newArrayList(TEST_CAPABILITY));
202 final DOMRpcService deviceRpc = mock(DOMRpcService.class);
204 device.handleSalInitializationSuccess(NetconfToNotificationTest.getNotificationSchemaContext(getClass()), sessionCaps, deviceRpc);
206 verify(facade, timeout(10000).times(2)).onNotification(any(DOMNotification.class));
208 device.onNotification(notification);
209 verify(facade, timeout(10000).times(3)).onNotification(any(DOMNotification.class));
213 public void testNetconfDeviceReconnect() throws Exception {
214 final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
215 final NetconfDeviceCommunicator listener = getListener();
217 final SchemaContextFactory schemaContextProviderFactory = getSchemaFactory();
219 final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
220 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaContextProviderFactory, stateSchemasResolver);
221 final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
222 final NetconfSessionPreferences sessionCaps = getSessionCaps(true,
223 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&revision=" + TEST_REVISION));
224 device.onRemoteSessionUp(sessionCaps, listener);
226 verify(schemaContextProviderFactory, timeout(5000)).createSchemaContext(any(Collection.class));
227 verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
229 device.onRemoteSessionDown();
230 verify(facade, timeout(5000)).onDeviceDisconnected();
232 device.onRemoteSessionUp(sessionCaps, listener);
234 verify(schemaContextProviderFactory, timeout(5000).times(2)).createSchemaContext(any(Collection.class));
235 verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
238 private SchemaContextFactory getSchemaFactory() {
239 final SchemaContextFactory schemaFactory = mockClass(SchemaContextFactory.class);
240 doReturn(Futures.immediateCheckedFuture(getSchema())).when(schemaFactory).createSchemaContext(any(Collection.class));
241 return schemaFactory;
244 public static SchemaContext getSchema() {
245 final YangParserImpl parser = new YangParserImpl();
246 final List<InputStream> modelsToParse = Lists.newArrayList(
247 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
249 final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
250 return parser.resolveSchemaContext(models);
253 private RemoteDeviceHandler<NetconfSessionPreferences> getFacade() throws Exception {
254 final RemoteDeviceHandler<NetconfSessionPreferences> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
255 doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(NetconfDeviceRpc.class));
256 doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
257 doNothing().when(remoteDeviceHandler).onNotification(any(DOMNotification.class));
258 return remoteDeviceHandler;
261 private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
262 final T mock = mockClass(remoteDeviceHandlerClass);
263 doNothing().when(mock).close();
267 private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
268 final T mock = mock(remoteDeviceHandlerClass);
269 Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
273 public RemoteDeviceId getId() {
274 return new RemoteDeviceId("test-D");
277 public ExecutorService getExecutor() {
278 return Executors.newSingleThreadExecutor();
281 public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
282 final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
283 doReturn(notification).when(messageTransformer).toRpcRequest(any(SchemaPath.class), any(NormalizedNode.class));
284 doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(SchemaPath.class));
285 doReturn(compositeNode).when(messageTransformer).toNotification(any(NetconfMessage.class));
286 return messageTransformer;
289 public NetconfSessionPreferences getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
290 final ArrayList<String> capabilities = Lists.newArrayList(
291 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
292 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
295 capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
298 capabilities.addAll(additionalCapabilities);
300 return NetconfSessionPreferences.fromStrings(
304 public NetconfDeviceCommunicator getListener() throws Exception {
305 final NetconfDeviceCommunicator remoteDeviceCommunicator = mockCloseableClass(NetconfDeviceCommunicator.class);
306 // doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
307 return remoteDeviceCommunicator;