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

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