netconf/netconf-impl/src/test/java/org/opendaylight/netconf/impl/osgi/NetconfCapabilityMonitoringServiceTest.java

   1 /*
   2  * Copyright (c) 2016 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.netconf.impl.osgi;
   9
  10 import static org.mockito.Matchers.any;
  11 import static org.mockito.Mockito.doNothing;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.times;
  14 import static org.mockito.Mockito.verify;
  15
  16 import com.google.common.base.Optional;
  17 import java.net.URI;
  18 import java.util.ArrayList;
  19 import java.util.Collections;
  20 import java.util.Date;
  21 import java.util.HashSet;
  22 import java.util.List;
  23 import java.util.Set;
  24 import org.junit.Assert;
  25 import org.junit.Before;
  26 import org.junit.BeforeClass;
  27 import org.junit.Test;
  28 import org.mockito.ArgumentCaptor;
  29 import org.mockito.Mock;
  30 import org.mockito.MockitoAnnotations;
  31 import org.opendaylight.controller.config.util.capability.BasicCapability;
  32 import org.opendaylight.controller.config.util.capability.Capability;
  33 import org.opendaylight.controller.config.util.capability.YangModuleCapability;
  34 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
  35 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
  36 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  37 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  47 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  48 import org.opendaylight.yangtools.yang.model.api.Module;
  49
  50 public class NetconfCapabilityMonitoringServiceTest {
  51
  52     private static final String TEST_MODULE_CONTENT = "content";
  53     private static final String TEST_MODULE_CONTENT2 = "content2";
  54     private static final String TEST_MODULE_REV = "1970-01-01";
  55     private static final String TEST_MODULE_REV2 = "1970-01-02";
  56     private static final  Uri TEST_MODULE_NAMESPACE = new Uri("testModuleNamespace");
  57     private static final String TEST_MODULE_NAME = "testModule";
  58     private static Date TEST_MODULE_DATE;
  59     private static Date TEST_MODULE_DATE2;
  60
  61     private YangModuleCapability moduleCapability1;
  62     private YangModuleCapability moduleCapability2;
  63     private static final Session SESSION = new SessionBuilder()
  64             .setSessionId(1L)
  65             .setSourceHost(new Host("0.0.0.0".toCharArray()))
  66             .setUsername("admin")
  67             .build();
  68     private int capabilitiesSize;
  69
  70     private final Set<Capability> CAPABILITIES = new HashSet<>();
  71
  72     @Mock
  73     private Module moduleMock;
  74     @Mock
  75     private Module moduleMock2;
  76     @Mock
  77     private NetconfOperationServiceFactory operationServiceFactoryMock;
  78     @Mock
  79     private NetconfManagementSession sessionMock;
  80     @Mock
  81     private NetconfMonitoringService.CapabilitiesListener listener;
  82     @Mock
  83     private BaseNotificationPublisherRegistration notificationPublisher;
  84
  85     private NetconfCapabilityMonitoringService monitoringService;
  86
  87     @BeforeClass
  88     public static void suiteSetUp() throws Exception {
  89         TEST_MODULE_DATE = SimpleDateFormatUtil.getRevisionFormat().parse(TEST_MODULE_REV);
  90         TEST_MODULE_DATE2= SimpleDateFormatUtil.getRevisionFormat().parse(TEST_MODULE_REV2);
  91     }
  92
  93     @Before
  94     public void setUp() throws Exception {
  95         MockitoAnnotations.initMocks(this);
  96
  97         doReturn(new URI(TEST_MODULE_NAMESPACE.getValue())).when(moduleMock).getNamespace();
  98         doReturn(TEST_MODULE_NAME).when(moduleMock).getName();
  99         doReturn(TEST_MODULE_DATE).when(moduleMock).getRevision();
 100         moduleCapability1 = new YangModuleCapability(moduleMock, TEST_MODULE_CONTENT);
 101
 102         CAPABILITIES.add(moduleCapability1);
 103
 104         doReturn(new URI(TEST_MODULE_NAMESPACE.getValue())).when(moduleMock2).getNamespace();
 105         doReturn(TEST_MODULE_NAME).when(moduleMock2).getName();
 106         doReturn(TEST_MODULE_DATE2).when(moduleMock2).getRevision();
 107         moduleCapability2 = new YangModuleCapability(moduleMock2, TEST_MODULE_CONTENT2);
 108
 109         CAPABILITIES.add(new BasicCapability("urn:ietf:params:netconf:base:1.0"));
 110         CAPABILITIES.add(new BasicCapability("urn:ietf:params:netconf:base:1.1"));
 111         CAPABILITIES.add(new BasicCapability("urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&amp;revision=2010-09-24"));
 112
 113         doReturn(CAPABILITIES).when(operationServiceFactoryMock).getCapabilities();
 114         doReturn(null).when(operationServiceFactoryMock).registerCapabilityListener(any(NetconfCapabilityMonitoringService.class));
 115
 116         doReturn(SESSION).when(sessionMock).toManagementSession();
 117         doNothing().when(listener).onCapabilitiesChanged(any());
 118         doNothing().when(listener).onSchemasChanged(any());
 119
 120         doNothing().when(notificationPublisher).onCapabilityChanged(any());
 121         doNothing().when(notificationPublisher).onSessionStarted(any());
 122         doNothing().when(notificationPublisher).onSessionEnded(any());
 123
 124         monitoringService = new NetconfCapabilityMonitoringService(operationServiceFactoryMock);
 125         monitoringService.onCapabilitiesChanged(CAPABILITIES, Collections.emptySet());
 126         monitoringService.setNotificationPublisher(notificationPublisher);
 127         monitoringService.registerListener(listener);
 128         capabilitiesSize = monitoringService.getCapabilities().getCapability().size();
 129     }
 130
 131     @Test
 132     public void testListeners() throws Exception {
 133         HashSet<Capability> added = new HashSet<>();
 134         added.add(new BasicCapability("toAdd"));
 135         monitoringService.onCapabilitiesChanged(added, Collections.emptySet());
 136         //onCapabilitiesChanged and onSchemasChanged are invoked also after listener registration
 137         verify(listener, times(2)).onCapabilitiesChanged(any());
 138         verify(listener, times(2)).onSchemasChanged(any());
 139     }
 140
 141     @Test
 142     public void testGetSchemas() throws Exception {
 143         Schemas schemas = monitoringService.getSchemas();
 144         Schema schema = schemas.getSchema().get(0);
 145         Assert.assertEquals(TEST_MODULE_NAMESPACE, schema.getNamespace());
 146         Assert.assertEquals(TEST_MODULE_NAME, schema.getIdentifier());
 147         Assert.assertEquals(TEST_MODULE_REV, schema.getVersion());
 148     }
 149
 150     @Test
 151     public void testGetSchemaForCapability() throws Exception {
 152         //test multiple revisions of the same capability
 153         monitoringService.onCapabilitiesChanged(Collections.singleton(moduleCapability2), Collections.emptySet());
 154         final String schema = monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.of(TEST_MODULE_REV));
 155         Assert.assertEquals(TEST_MODULE_CONTENT, schema);
 156         final String schema2 = monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.of(TEST_MODULE_REV2));
 157         Assert.assertEquals(TEST_MODULE_CONTENT2, schema2);
 158         //remove one revision
 159         monitoringService.onCapabilitiesChanged(Collections.emptySet(), Collections.singleton(moduleCapability1));
 160         //only one revision present
 161         final String schema3 = monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.absent());
 162         Assert.assertEquals(TEST_MODULE_CONTENT2, schema3);
 163     }
 164
 165     @Test
 166     public void testGetCapabilities() throws Exception {
 167         Capabilities actual = monitoringService.getCapabilities();
 168         List<Uri> exp = new ArrayList<>();
 169         for (Capability capability : CAPABILITIES) {
 170             exp.add(new Uri(capability.getCapabilityUri()));
 171         }
 172         //candidate is added by monitoring service automatically
 173         exp.add(0, new Uri("urn:ietf:params:netconf:capability:candidate:1.0"));
 174         Capabilities expected = new CapabilitiesBuilder().setCapability(exp).build();
 175         Assert.assertEquals(new HashSet<>(expected.getCapability()), new HashSet<>(actual.getCapability()));
 176     }
 177
 178     @Test
 179     public void testClose() throws Exception {
 180         Assert.assertFalse(monitoringService.getCapabilities().getCapability().isEmpty());
 181         monitoringService.close();
 182         Assert.assertTrue(monitoringService.getCapabilities().getCapability().isEmpty());
 183     }
 184
 185     @Test
 186     public void testOnCapabilitiesChanged() throws Exception {
 187         final String capUri = "test";
 188         final Uri uri = new Uri(capUri);
 189         final HashSet<Capability> testCaps = new HashSet<>();
 190         testCaps.add(new BasicCapability(capUri));
 191         final ArgumentCaptor<NetconfCapabilityChange> capabilityChangeCaptor = ArgumentCaptor.forClass(NetconfCapabilityChange.class);
 192         final ArgumentCaptor<Capabilities> monitoringListenerCaptor = ArgumentCaptor.forClass(Capabilities.class);
 193         //add capability
 194         monitoringService.onCapabilitiesChanged(testCaps, Collections.emptySet());
 195         //remove capability
 196         monitoringService.onCapabilitiesChanged(Collections.emptySet(), testCaps);
 197
 198         verify(listener, times(3)).onCapabilitiesChanged((monitoringListenerCaptor.capture()));
 199         verify(notificationPublisher, times(2)).onCapabilityChanged(capabilityChangeCaptor.capture());
 200
 201         //verify listener calls
 202         final List<Capabilities> listenerValues = monitoringListenerCaptor.getAllValues();
 203         final List<Uri> afterRegisterState = listenerValues.get(0).getCapability();
 204         final List<Uri> afterAddState = listenerValues.get(1).getCapability();
 205         final List<Uri> afterRemoveState = listenerValues.get(2).getCapability();
 206
 207         Assert.assertEquals(capabilitiesSize, afterRegisterState.size());
 208         Assert.assertEquals(capabilitiesSize + 1, afterAddState.size());
 209         Assert.assertEquals(capabilitiesSize, afterRemoveState.size());
 210         Assert.assertFalse(afterRegisterState.contains(uri));
 211         Assert.assertTrue(afterAddState.contains(uri));
 212         Assert.assertFalse(afterRemoveState.contains(uri));
 213
 214         //verify notification publication
 215         final List<NetconfCapabilityChange> publisherValues = capabilityChangeCaptor.getAllValues();
 216         final NetconfCapabilityChange afterAdd = publisherValues.get(0);
 217         final NetconfCapabilityChange afterRemove = publisherValues.get(1);
 218
 219         Assert.assertEquals(Collections.singleton(uri), new HashSet<>(afterAdd.getAddedCapability()));
 220         Assert.assertEquals(Collections.emptySet(), new HashSet<>(afterAdd.getDeletedCapability()));
 221         Assert.assertEquals(Collections.singleton(uri), new HashSet<>(afterRemove.getDeletedCapability()));
 222         Assert.assertEquals(Collections.emptySet(), new HashSet<>(afterRemove.getAddedCapability()));
 223     }
 224
 225 }