opendaylight/netconf/sal-netconf-connector/src/test/java/org/opendaylight/controller/sal/connect/netconf/NetconfDeviceTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.sal.connect.netconf;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Matchers.anyCollectionOf;
  13 import static org.mockito.Mockito.doAnswer;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.timeout;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20
  21 import com.google.common.base.Optional;
  22 import com.google.common.collect.HashMultimap;
  23 import com.google.common.collect.Iterables;
  24 import com.google.common.collect.Lists;
  25 import com.google.common.collect.Sets;
  26 import com.google.common.util.concurrent.Futures;
  27 import java.io.InputStream;
  28 import java.net.InetSocketAddress;
  29 import java.util.ArrayList;
  30 import java.util.Collection;
  31 import java.util.Collections;
  32 import java.util.List;
  33 import java.util.Set;
  34 import java.util.concurrent.ExecutorService;
  35 import java.util.concurrent.Executors;
  36 import org.junit.Test;
  37 import org.mockito.Mockito;
  38 import org.mockito.invocation.InvocationOnMock;
  39 import org.mockito.stubbing.Answer;
  40 import org.opendaylight.controller.config.util.xml.XmlUtil;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
  42 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  43 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  44 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  45 import org.opendaylight.controller.netconf.api.NetconfMessage;
  46 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  47 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
  48 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
  49 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  50 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
  51 import org.opendaylight.controller.sal.connect.netconf.sal.NetconfDeviceRpc;
  52 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  53 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  54 import org.opendaylight.yangtools.yang.common.QName;
  55 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  57 import org.opendaylight.yangtools.yang.model.api.Module;
  58 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  59 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  60 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  61 import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
  62 import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory;
  63 import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException;
  64 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  65 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
  66 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration;
  67 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry;
  68 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  69
  70 public class NetconfDeviceTest {
  71
  72     private static final NetconfMessage notification;
  73
  74     private static final ContainerNode compositeNode;
  75
  76     static {
  77         try {
  78             compositeNode = mockClass(ContainerNode.class);
  79         } catch (final Exception e) {
  80             throw new RuntimeException(e);
  81         }
  82         try {
  83             notification = new NetconfMessage(XmlUtil.readXmlToDocument(NetconfDeviceTest.class.getResourceAsStream("/notification-payload.xml")));
  84         } catch (Exception e) {
  85             throw new ExceptionInInitializerError(e);
  86         }
  87     }
  88
  89     private static final DOMRpcResult rpcResultC = new DefaultDOMRpcResult(compositeNode);
  90
  91     public static final String TEST_NAMESPACE = "test:namespace";
  92     public static final String TEST_MODULE = "test-module";
  93     public static final String TEST_REVISION = "2013-07-22";
  94     public static final SourceIdentifier TEST_SID = new SourceIdentifier(TEST_MODULE, Optional.of(TEST_REVISION));
  95     public static final String TEST_CAPABILITY = TEST_NAMESPACE + "?module=" + TEST_MODULE + "&amp;revision=" + TEST_REVISION;
  96
  97     public static final SourceIdentifier TEST_SID2 = new SourceIdentifier(TEST_MODULE + "2", Optional.of(TEST_REVISION));
  98     public static final String TEST_CAPABILITY2 = TEST_NAMESPACE + "?module=" + TEST_MODULE + "2" + "&amp;revision=" + TEST_REVISION;
  99
 100     private static final NetconfStateSchemas.NetconfStateSchemasResolver stateSchemasResolver = new NetconfStateSchemas.NetconfStateSchemasResolver() {
 101
 102         @Override
 103         public NetconfStateSchemas resolve(final NetconfDeviceRpc deviceRpc, final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id) {
 104             return NetconfStateSchemas.EMPTY;
 105         }
 106     };
 107
 108     @Test
 109     public void testNetconfDeviceFailFirstSchemaFailSecondEmpty() throws Exception {
 110         final ArrayList<String> capList = Lists.newArrayList(TEST_CAPABILITY);
 111
 112         final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
 113         final NetconfDeviceCommunicator listener = getListener();
 114
 115         final SchemaContextFactory schemaFactory = getSchemaFactory();
 116
 117         // Make fallback attempt to fail due to empty resolved sources
 118         final SchemaResolutionException schemaResolutionException
 119                 = new SchemaResolutionException("fail first",
 120                 Collections.<SourceIdentifier>emptyList(), HashMultimap.<SourceIdentifier, ModuleImport>create());
 121         doReturn(Futures.immediateFailedCheckedFuture(
 122                 schemaResolutionException))
 123                 .when(schemaFactory).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
 124
 125         final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
 126                 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaFactory, stateSchemasResolver);
 127         final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(),true);
 128         // Monitoring not supported
 129         final NetconfSessionPreferences sessionCaps = getSessionCaps(false, capList);
 130         device.onRemoteSessionUp(sessionCaps, listener);
 131
 132         Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
 133         Mockito.verify(listener, Mockito.timeout(5000)).close();
 134         Mockito.verify(schemaFactory, times(1)).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
 135     }
 136
 137     @Test
 138     public void testNetconfDeviceMissingSource() throws Exception {
 139         final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
 140         final NetconfDeviceCommunicator listener = getListener();
 141         final SchemaContext schema = getSchema();
 142
 143         final SchemaContextFactory schemaFactory = getSchemaFactory();
 144
 145         // Make fallback attempt to fail due to empty resolved sources
 146         final MissingSchemaSourceException schemaResolutionException = new MissingSchemaSourceException("fail first", TEST_SID);
 147         doAnswer(new Answer<Object>() {
 148             @Override
 149             public Object answer(final InvocationOnMock invocation) throws Throwable {
 150                 if(((Collection<?>) invocation.getArguments()[0]).size() == 2) {
 151                     return Futures.immediateFailedCheckedFuture(schemaResolutionException);
 152                 } else {
 153                     return Futures.immediateCheckedFuture(schema);
 154                 }
 155             }
 156         }).when(schemaFactory).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
 157
 158         final NetconfStateSchemas.NetconfStateSchemasResolver stateSchemasResolver = new NetconfStateSchemas.NetconfStateSchemasResolver() {
 159             @Override
 160             public NetconfStateSchemas resolve(final NetconfDeviceRpc deviceRpc, final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id) {
 161                 final Module first = Iterables.getFirst(schema.getModules(), null);
 162                 final QName qName = QName.create(first.getQNameModule(), first.getName());
 163                 final NetconfStateSchemas.RemoteYangSchema source1 = new NetconfStateSchemas.RemoteYangSchema(qName);
 164                 final NetconfStateSchemas.RemoteYangSchema source2 = new NetconfStateSchemas.RemoteYangSchema(QName.create(first.getQNameModule(), "test-module2"));
 165                 return new NetconfStateSchemas(Sets.newHashSet(source1, source2));
 166             }
 167         };
 168
 169         final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
 170                 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaFactory, stateSchemasResolver);
 171
 172         final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
 173         // Monitoring supported
 174         final NetconfSessionPreferences sessionCaps = getSessionCaps(true, Lists.newArrayList(TEST_CAPABILITY, TEST_CAPABILITY2));
 175         device.onRemoteSessionUp(sessionCaps, listener);
 176
 177         Mockito.verify(facade, Mockito.timeout(5000)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(NetconfDeviceRpc.class));
 178         Mockito.verify(schemaFactory, times(2)).createSchemaContext(anyCollectionOf(SourceIdentifier.class));
 179     }
 180
 181     private SchemaSourceRegistry getSchemaRegistry() {
 182         final SchemaSourceRegistry mock = mock(SchemaSourceRegistry.class);
 183         final SchemaSourceRegistration<?> mockReg = mock(SchemaSourceRegistration.class);
 184         doNothing().when(mockReg).close();
 185         doReturn(mockReg).when(mock).registerSchemaSource(any(org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider.class), any(PotentialSchemaSource.class));
 186         return mock;
 187     }
 188
 189     @Test
 190     public void testNotificationBeforeSchema() throws Exception {
 191         final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
 192         final NetconfDeviceCommunicator listener = getListener();
 193
 194         final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
 195                 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), getSchemaFactory(), stateSchemasResolver);
 196         final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
 197
 198         device.onNotification(notification);
 199         device.onNotification(notification);
 200
 201         verify(facade, times(0)).onNotification(any(DOMNotification.class));
 202
 203         final NetconfSessionPreferences sessionCaps = getSessionCaps(true,
 204                 Lists.newArrayList(TEST_CAPABILITY));
 205
 206         final DOMRpcService deviceRpc = mock(DOMRpcService.class);
 207
 208         device.handleSalInitializationSuccess(NetconfToNotificationTest.getNotificationSchemaContext(getClass()), sessionCaps, deviceRpc);
 209
 210         verify(facade, timeout(10000).times(2)).onNotification(any(DOMNotification.class));
 211
 212         device.onNotification(notification);
 213         verify(facade, timeout(10000).times(3)).onNotification(any(DOMNotification.class));
 214     }
 215
 216     @Test
 217     public void testNetconfDeviceReconnect() throws Exception {
 218         final RemoteDeviceHandler<NetconfSessionPreferences> facade = getFacade();
 219         final NetconfDeviceCommunicator listener = getListener();
 220
 221         final SchemaContextFactory schemaContextProviderFactory = getSchemaFactory();
 222
 223         final NetconfDevice.SchemaResourcesDTO schemaResourcesDTO
 224                 = new NetconfDevice.SchemaResourcesDTO(getSchemaRegistry(), schemaContextProviderFactory, stateSchemasResolver);
 225         final NetconfDevice device = new NetconfDevice(schemaResourcesDTO, getId(), facade, getExecutor(), true);
 226         final NetconfSessionPreferences sessionCaps = getSessionCaps(true,
 227                 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&amp;revision=" + TEST_REVISION));
 228         device.onRemoteSessionUp(sessionCaps, listener);
 229
 230         verify(schemaContextProviderFactory, timeout(5000)).createSchemaContext(any(Collection.class));
 231         verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 232
 233         device.onRemoteSessionDown();
 234         verify(facade, timeout(5000)).onDeviceDisconnected();
 235
 236         device.onRemoteSessionUp(sessionCaps, listener);
 237
 238         verify(schemaContextProviderFactory, timeout(5000).times(2)).createSchemaContext(any(Collection.class));
 239         verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 240     }
 241
 242     private SchemaContextFactory getSchemaFactory() {
 243         final SchemaContextFactory schemaFactory = mockClass(SchemaContextFactory.class);
 244         doReturn(Futures.immediateCheckedFuture(getSchema())).when(schemaFactory).createSchemaContext(any(Collection.class));
 245         return schemaFactory;
 246     }
 247
 248     public static SchemaContext getSchema() {
 249         final YangParserImpl parser = new YangParserImpl();
 250         final List<InputStream> modelsToParse = Lists.newArrayList(
 251                 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
 252         );
 253         final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
 254         return parser.resolveSchemaContext(models);
 255     }
 256
 257     private RemoteDeviceHandler<NetconfSessionPreferences> getFacade() throws Exception {
 258         final RemoteDeviceHandler<NetconfSessionPreferences> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
 259         doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(NetconfDeviceRpc.class));
 260         doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
 261         doNothing().when(remoteDeviceHandler).onNotification(any(DOMNotification.class));
 262         return remoteDeviceHandler;
 263     }
 264
 265     private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
 266         final T mock = mockClass(remoteDeviceHandlerClass);
 267         doNothing().when(mock).close();
 268         return mock;
 269     }
 270
 271     private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
 272         final T mock = mock(remoteDeviceHandlerClass);
 273         Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
 274         return mock;
 275     }
 276
 277     public RemoteDeviceId getId() {
 278         return new RemoteDeviceId("test-D", InetSocketAddress.createUnresolved("localhost", 22));
 279     }
 280
 281     public ExecutorService getExecutor() {
 282         return Executors.newSingleThreadExecutor();
 283     }
 284
 285     public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
 286         final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
 287         doReturn(notification).when(messageTransformer).toRpcRequest(any(SchemaPath.class), any(NormalizedNode.class));
 288         doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(SchemaPath.class));
 289         doReturn(compositeNode).when(messageTransformer).toNotification(any(NetconfMessage.class));
 290         return messageTransformer;
 291     }
 292
 293     public NetconfSessionPreferences getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
 294         final ArrayList<String> capabilities = Lists.newArrayList(
 295                 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
 296                 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
 297
 298         if(addMonitor) {
 299             capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
 300         }
 301
 302         capabilities.addAll(additionalCapabilities);
 303
 304         return NetconfSessionPreferences.fromStrings(
 305                 capabilities);
 306     }
 307
 308     public NetconfDeviceCommunicator getListener() throws Exception {
 309         final NetconfDeviceCommunicator remoteDeviceCommunicator = mockCloseableClass(NetconfDeviceCommunicator.class);
 310 //        doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
 311         return remoteDeviceCommunicator;
 312     }
 313 }