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.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.verify;
  16
  17 import java.io.InputStream;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import java.util.Collections;
  21 import java.util.List;
  22 import java.util.Set;
  23 import java.util.concurrent.ExecutorService;
  24 import java.util.concurrent.Executors;
  25
  26 import org.junit.Test;
  27 import org.mockito.Mockito;
  28 import org.opendaylight.controller.netconf.api.NetconfMessage;
  29 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  30 import org.opendaylight.controller.sal.common.util.Rpcs;
  31 import org.opendaylight.controller.sal.connect.api.MessageTransformer;
  32 import org.opendaylight.controller.sal.connect.api.RemoteDeviceCommunicator;
  33 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
  34 import org.opendaylight.controller.sal.connect.api.SchemaContextProviderFactory;
  35 import org.opendaylight.controller.sal.connect.api.SchemaSourceProviderFactory;
  36 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionCapabilities;
  37 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  38 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  39 import org.opendaylight.controller.sal.core.api.RpcImplementation;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.common.RpcError;
  42 import org.opendaylight.yangtools.yang.common.RpcResult;
  43 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  44 import org.opendaylight.yangtools.yang.model.api.Module;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  47 import org.opendaylight.yangtools.yang.model.util.repo.SchemaSourceProvider;
  48 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
  49
  50 import com.google.common.base.Optional;
  51 import com.google.common.collect.Lists;
  52 import com.google.common.util.concurrent.Futures;
  53
  54 public class NetconfDeviceTest {
  55
  56     private static final NetconfMessage netconfMessage;
  57     private static final CompositeNode compositeNode;
  58
  59     static {
  60         try {
  61             netconfMessage = mockClass(NetconfMessage.class);
  62             compositeNode = mockClass(CompositeNode.class);
  63         } catch (final Exception e) {
  64             throw new RuntimeException(e);
  65         }
  66     }
  67
  68     private static final  RpcResult<NetconfMessage> rpcResult = Rpcs.getRpcResult(true, netconfMessage, Collections.<RpcError>emptySet());
  69     private static final  RpcResult<CompositeNode> rpcResultC = Rpcs.getRpcResult(true, compositeNode, Collections.<RpcError>emptySet());
  70
  71     public static final String TEST_NAMESPACE = "test:namespace";
  72     public static final String TEST_MODULE = "test-module";
  73     public static final String TEST_REVISION = "2013-07-22";
  74
  75     @Test
  76     public void testNetconfDeviceWithoutMonitoring() throws Exception {
  77         final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
  78         final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
  79
  80         final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), getMessageTransformer(), getSchemaContextProviderFactory(), getSourceProviderFactory());
  81         device.onRemoteSessionUp(getSessionCaps(false, Collections.<String>emptyList()), listener);
  82
  83         Mockito.verify(facade, Mockito.timeout(5000)).onDeviceDisconnected();
  84     }
  85
  86     @Test
  87     public void testNetconfDeviceReconnect() throws Exception {
  88         final RemoteDeviceHandler<NetconfSessionCapabilities> facade = getFacade();
  89         final RemoteDeviceCommunicator<NetconfMessage> listener = getListener();
  90
  91         final SchemaContextProviderFactory schemaContextProviderFactory = getSchemaContextProviderFactory();
  92         final SchemaSourceProviderFactory<InputStream> sourceProviderFactory = getSourceProviderFactory();
  93         final MessageTransformer<NetconfMessage> messageTransformer = getMessageTransformer();
  94
  95         final NetconfDevice device = new NetconfDevice(getId(), facade, getExecutor(), messageTransformer, schemaContextProviderFactory, sourceProviderFactory);
  96         final NetconfSessionCapabilities sessionCaps = getSessionCaps(true,
  97                 Lists.newArrayList(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&amp;revision=" + TEST_REVISION));
  98         device.onRemoteSessionUp(sessionCaps, listener);
  99
 100         verify(sourceProviderFactory, timeout(5000)).createSourceProvider(any(RpcImplementation.class));
 101         verify(schemaContextProviderFactory, timeout(5000)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
 102         verify(messageTransformer, timeout(5000)).onGlobalContextUpdated(any(SchemaContext.class));
 103         verify(facade, timeout(5000)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
 104
 105         device.onRemoteSessionDown();
 106         verify(facade, timeout(5000)).onDeviceDisconnected();
 107
 108         device.onRemoteSessionUp(sessionCaps, listener);
 109
 110         verify(sourceProviderFactory, timeout(5000).times(2)).createSourceProvider(any(RpcImplementation.class));
 111         verify(schemaContextProviderFactory, timeout(5000).times(2)).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
 112         verify(messageTransformer, timeout(5000).times(2)).onGlobalContextUpdated(any(SchemaContext.class));
 113         verify(facade, timeout(5000).times(2)).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
 114     }
 115
 116     private SchemaContextProviderFactory getSchemaContextProviderFactory() {
 117         final SchemaContextProviderFactory schemaContextProviderFactory = mockClass(SchemaContextProviderFactory.class);
 118         doReturn(new SchemaContextProvider() {
 119             @Override
 120             public SchemaContext getSchemaContext() {
 121                 return getSchema();
 122             }
 123         }).when(schemaContextProviderFactory).createContextProvider(any(Collection.class), any(SchemaSourceProvider.class));
 124         return schemaContextProviderFactory;
 125     }
 126
 127     public static SchemaContext getSchema() {
 128         final YangParserImpl parser = new YangParserImpl();
 129         final List<InputStream> modelsToParse = Lists.newArrayList(
 130                 NetconfDeviceTest.class.getResourceAsStream("/schemas/test-module.yang")
 131         );
 132         final Set<Module> models = parser.parseYangModelsFromStreams(modelsToParse);
 133         return parser.resolveSchemaContext(models);
 134     }
 135
 136     private RemoteDeviceHandler<NetconfSessionCapabilities> getFacade() throws Exception {
 137         final RemoteDeviceHandler<NetconfSessionCapabilities> remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
 138         doNothing().when(remoteDeviceHandler).onDeviceConnected(any(SchemaContextProvider.class), any(NetconfSessionCapabilities.class), any(RpcImplementation.class));
 139         doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
 140         return remoteDeviceHandler;
 141     }
 142
 143     private <T extends AutoCloseable> T mockCloseableClass(final Class<T> remoteDeviceHandlerClass) throws Exception {
 144         final T mock = mockClass(remoteDeviceHandlerClass);
 145         doNothing().when(mock).close();
 146         return mock;
 147     }
 148
 149     public SchemaSourceProviderFactory<InputStream> getSourceProviderFactory() {
 150         final SchemaSourceProviderFactory<InputStream> mock = mockClass(SchemaSourceProviderFactory.class);
 151
 152         final SchemaSourceProvider<InputStream> schemaSourceProvider = mockClass(SchemaSourceProvider.class);
 153         doReturn(Optional.<String>absent()).when(schemaSourceProvider).getSchemaSource(anyString(), any(Optional.class));
 154
 155         doReturn(schemaSourceProvider).when(mock).createSourceProvider(any(RpcImplementation.class));
 156         return mock;
 157     }
 158
 159     private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
 160         final T mock = Mockito.mock(remoteDeviceHandlerClass);
 161         Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
 162         return mock;
 163     }
 164
 165     public RemoteDeviceId getId() {
 166         return new RemoteDeviceId("test-D");
 167     }
 168
 169     public ExecutorService getExecutor() {
 170         return Executors.newSingleThreadExecutor();
 171     }
 172
 173     public MessageTransformer<NetconfMessage> getMessageTransformer() throws Exception {
 174         final MessageTransformer<NetconfMessage> messageTransformer = mockClass(MessageTransformer.class);
 175         doReturn(netconfMessage).when(messageTransformer).toRpcRequest(any(QName.class), any(CompositeNode.class));
 176         doReturn(rpcResultC).when(messageTransformer).toRpcResult(any(NetconfMessage.class), any(QName.class));
 177         doNothing().when(messageTransformer).onGlobalContextUpdated(any(SchemaContext.class));
 178         return messageTransformer;
 179     }
 180
 181     public NetconfSessionCapabilities getSessionCaps(final boolean addMonitor, final Collection<String> additionalCapabilities) {
 182         final ArrayList<String> capabilities = Lists.newArrayList(
 183                 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
 184                 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
 185
 186         if(addMonitor) {
 187             capabilities.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
 188         }
 189
 190         capabilities.addAll(additionalCapabilities);
 191
 192         return NetconfSessionCapabilities.fromStrings(
 193                 capabilities);
 194     }
 195
 196     public RemoteDeviceCommunicator<NetconfMessage> getListener() throws Exception {
 197         final RemoteDeviceCommunicator<NetconfMessage> remoteDeviceCommunicator = mockCloseableClass(RemoteDeviceCommunicator.class);
 198         doReturn(Futures.immediateFuture(rpcResult)).when(remoteDeviceCommunicator).sendRequest(any(NetconfMessage.class), any(QName.class));
 199         return remoteDeviceCommunicator;
 200     }
 201 }