2 * Copyright (c) 2016 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.netconf.impl.osgi;
10 import static org.mockito.ArgumentMatchers.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 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0;
16 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0;
18 import com.google.common.base.Optional;
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.HashSet;
23 import java.util.List;
25 import org.junit.Assert;
26 import org.junit.Before;
27 import org.junit.Test;
28 import org.mockito.ArgumentCaptor;
29 import org.mockito.Mock;
30 import org.mockito.MockitoAnnotations;
31 import org.opendaylight.netconf.api.capability.BasicCapability;
32 import org.opendaylight.netconf.api.capability.Capability;
33 import org.opendaylight.netconf.api.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.HostBuilder;
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.Revision;
48 import org.opendaylight.yangtools.yang.model.api.Module;
50 public class NetconfCapabilityMonitoringServiceTest {
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 final Revision TEST_MODULE_DATE = Revision.of(TEST_MODULE_REV);
59 private static final Revision TEST_MODULE_DATE2 = Revision.of(TEST_MODULE_REV2);
61 private YangModuleCapability moduleCapability1;
62 private YangModuleCapability moduleCapability2;
63 private static final Session SESSION = new SessionBuilder()
65 .setSourceHost(HostBuilder.getDefaultInstance("0.0.0.0"))
68 private int capabilitiesSize;
70 private final Set<Capability> capabilities = new HashSet<>();
73 private Module moduleMock;
75 private Module moduleMock2;
77 private NetconfOperationServiceFactory operationServiceFactoryMock;
79 private NetconfManagementSession sessionMock;
81 private NetconfMonitoringService.CapabilitiesListener listener;
83 private BaseNotificationPublisherRegistration notificationPublisher;
85 private NetconfCapabilityMonitoringService monitoringService;
88 public void setUp() throws Exception {
89 MockitoAnnotations.initMocks(this);
91 doReturn(new URI(TEST_MODULE_NAMESPACE.getValue())).when(moduleMock).getNamespace();
92 doReturn(TEST_MODULE_NAME).when(moduleMock).getName();
93 doReturn(java.util.Optional.of(TEST_MODULE_DATE)).when(moduleMock).getRevision();
94 moduleCapability1 = new YangModuleCapability(moduleMock, TEST_MODULE_CONTENT);
96 capabilities.add(moduleCapability1);
98 doReturn(new URI(TEST_MODULE_NAMESPACE.getValue())).when(moduleMock2).getNamespace();
99 doReturn(TEST_MODULE_NAME).when(moduleMock2).getName();
100 doReturn(java.util.Optional.of(TEST_MODULE_DATE2)).when(moduleMock2).getRevision();
101 moduleCapability2 = new YangModuleCapability(moduleMock2, TEST_MODULE_CONTENT2);
103 capabilities.add(new BasicCapability("urn:ietf:params:netconf:base:1.0"));
104 capabilities.add(new BasicCapability("urn:ietf:params:netconf:base:1.1"));
105 capabilities.add(new BasicCapability("urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&"
106 + "revision=2010-09-24"));
108 doReturn(capabilities).when(operationServiceFactoryMock).getCapabilities();
109 doReturn(null).when(operationServiceFactoryMock)
110 .registerCapabilityListener(any(NetconfCapabilityMonitoringService.class));
112 doReturn(SESSION).when(sessionMock).toManagementSession();
113 doNothing().when(listener).onCapabilitiesChanged(any());
114 doNothing().when(listener).onSchemasChanged(any());
116 doNothing().when(notificationPublisher).onCapabilityChanged(any());
117 doNothing().when(notificationPublisher).onSessionStarted(any());
118 doNothing().when(notificationPublisher).onSessionEnded(any());
120 monitoringService = new NetconfCapabilityMonitoringService(operationServiceFactoryMock);
121 monitoringService.onCapabilitiesChanged(capabilities, Collections.emptySet());
122 monitoringService.setNotificationPublisher(notificationPublisher);
123 monitoringService.registerListener(listener);
124 capabilitiesSize = monitoringService.getCapabilities().getCapability().size();
128 public void testListeners() throws Exception {
129 HashSet<Capability> added = new HashSet<>();
130 added.add(new BasicCapability("toAdd"));
131 monitoringService.onCapabilitiesChanged(added, Collections.emptySet());
132 //onCapabilitiesChanged and onSchemasChanged are invoked also after listener registration
133 verify(listener, times(2)).onCapabilitiesChanged(any());
134 verify(listener, times(2)).onSchemasChanged(any());
138 public void testGetSchemas() throws Exception {
139 Schemas schemas = monitoringService.getSchemas();
140 Schema schema = schemas.getSchema().get(0);
141 Assert.assertEquals(TEST_MODULE_NAMESPACE, schema.getNamespace());
142 Assert.assertEquals(TEST_MODULE_NAME, schema.getIdentifier());
143 Assert.assertEquals(TEST_MODULE_REV, schema.getVersion());
147 public void testGetSchemaForCapability() throws Exception {
148 //test multiple revisions of the same capability
149 monitoringService.onCapabilitiesChanged(Collections.singleton(moduleCapability2), Collections.emptySet());
150 final String schema =
151 monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.of(TEST_MODULE_REV));
152 Assert.assertEquals(TEST_MODULE_CONTENT, schema);
153 final String schema2 =
154 monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.of(TEST_MODULE_REV2));
155 Assert.assertEquals(TEST_MODULE_CONTENT2, schema2);
156 //remove one revision
157 monitoringService.onCapabilitiesChanged(Collections.emptySet(), Collections.singleton(moduleCapability1));
158 //only one revision present
159 final String schema3 = monitoringService.getSchemaForModuleRevision(TEST_MODULE_NAME, Optional.absent());
160 Assert.assertEquals(TEST_MODULE_CONTENT2, schema3);
164 public void testGetCapabilities() throws Exception {
165 List<Uri> exp = new ArrayList<>();
166 for (Capability capability : capabilities) {
167 exp.add(new Uri(capability.getCapabilityUri()));
169 //candidate and url capabilities are added by monitoring service automatically
170 exp.add(new Uri(URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0));
171 exp.add(new Uri(URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0));
172 Capabilities expected = new CapabilitiesBuilder().setCapability(exp).build();
173 Capabilities actual = monitoringService.getCapabilities();
174 Assert.assertEquals(new HashSet<>(expected.getCapability()), new HashSet<>(actual.getCapability()));
178 public void testClose() throws Exception {
179 Assert.assertFalse(monitoringService.getCapabilities().getCapability().isEmpty());
180 monitoringService.close();
181 Assert.assertTrue(monitoringService.getCapabilities().getCapability().isEmpty());
185 public void testOnCapabilitiesChanged() throws Exception {
186 final String capUri = "test";
187 final Uri uri = new Uri(capUri);
188 final HashSet<Capability> testCaps = new HashSet<>();
189 testCaps.add(new BasicCapability(capUri));
190 final ArgumentCaptor<NetconfCapabilityChange> capabilityChangeCaptor =
191 ArgumentCaptor.forClass(NetconfCapabilityChange.class);
192 final ArgumentCaptor<Capabilities> monitoringListenerCaptor = ArgumentCaptor.forClass(Capabilities.class);
194 monitoringService.onCapabilitiesChanged(testCaps, Collections.emptySet());
196 monitoringService.onCapabilitiesChanged(Collections.emptySet(), testCaps);
198 verify(listener, times(3)).onCapabilitiesChanged(monitoringListenerCaptor.capture());
199 verify(notificationPublisher, times(2)).onCapabilityChanged(capabilityChangeCaptor.capture());
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();
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));
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);
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()));