netconf/mdsal-netconf-notification/src/test/java/org/opendaylight/netconf/mdsal/notification/impl/SessionNotificationProducerTest.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.mdsal.notification.impl;
   9
  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.mock;
  14 import static org.mockito.Mockito.never;
  15 import static org.mockito.Mockito.verify;
  16
  17 import java.util.Collections;
  18 import org.junit.Assert;
  19 import org.junit.Before;
  20 import org.junit.Test;
  21 import org.mockito.ArgumentCaptor;
  22 import org.mockito.Mock;
  23 import org.mockito.MockitoAnnotations;
  24 import org.opendaylight.mdsal.binding.api.DataBroker;
  25 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  26 import org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType;
  27 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
  28 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  29 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  30 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
  31 import org.opendaylight.netconf.notifications.NetconfNotificationCollector;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.HostBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfSessionEnd;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfSessionStart;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32;
  39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 public class SessionNotificationProducerTest {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(SessionNotificationProducerTest.class);
  46
  47     private SessionNotificationProducer publisher;
  48
  49     @Mock
  50     private BaseNotificationPublisherRegistration registration;
  51     @Mock
  52     private ListenerRegistration listenerRegistration;
  53
  54     @Mock
  55     private NetconfNotificationCollector netconfNotificationCollector;
  56     @Mock
  57     private DataBroker dataBroker;
  58
  59     @Before
  60     public void setUp() throws Exception {
  61         MockitoAnnotations.initMocks(this);
  62
  63         doReturn(listenerRegistration).when(dataBroker).registerDataTreeChangeListener(any(DataTreeIdentifier.class),
  64                 any(DataTreeChangeListener.class));
  65
  66         doNothing().when(registration).onCapabilityChanged(any(NetconfCapabilityChange.class));
  67         doNothing().when(registration).onSessionStarted(any());
  68         doNothing().when(registration).onSessionEnded(any());
  69
  70         doReturn(registration).when(netconfNotificationCollector).registerBaseNotificationPublisher();
  71
  72         publisher = new SessionNotificationProducer(netconfNotificationCollector, dataBroker);
  73     }
  74
  75     @Test
  76     public void testOnDataChangedSessionCreated() throws Exception {
  77         final Session session = createSession(1);
  78         final DataTreeModification<Session> treeChange = getTreeModification(session, ModificationType.WRITE);
  79         publisher.onDataTreeChanged(Collections.singleton(treeChange));
  80         ArgumentCaptor<NetconfSessionStart> captor = ArgumentCaptor.forClass(NetconfSessionStart.class);
  81         verify(registration).onSessionStarted(captor.capture());
  82         final NetconfSessionStart value = captor.getValue();
  83         Assert.assertEquals(session.getSessionId(), value.getSessionId().getValue());
  84         Assert.assertEquals(session.getSourceHost().getIpAddress(), value.getSourceHost());
  85         Assert.assertEquals(session.getUsername(), value.getUsername());
  86     }
  87
  88     @Test
  89     public void testOnDataChangedSessionUpdated() throws Exception {
  90         final DataTreeModification<Session> treeChange = mock(DataTreeModification.class);
  91         final DataObjectModification<Session> changeObject = mock(DataObjectModification.class);
  92         final Session sessionBefore = createSessionWithInRpcCount(1, 0);
  93         final Session sessionAfter = createSessionWithInRpcCount(1, 1);
  94         doReturn(sessionBefore).when(changeObject).getDataBefore();
  95         doReturn(sessionAfter).when(changeObject).getDataAfter();
  96         doReturn(ModificationType.WRITE).when(changeObject).getModificationType();
  97         doReturn(changeObject).when(treeChange).getRootNode();
  98         publisher.onDataTreeChanged(Collections.singleton(treeChange));
  99         //session didn't start, only stats changed. No notification should be produced
 100         verify(registration, never()).onSessionStarted(any());
 101         verify(registration, never()).onSessionEnded(any());
 102     }
 103
 104     @Test
 105     public void testOnDataChangedSessionDeleted() throws Exception {
 106         final Session session = createSession(1);
 107         final DataTreeModification<Session> data = getTreeModification(session, ModificationType.DELETE);
 108         publisher.onDataTreeChanged(Collections.singleton(data));
 109         ArgumentCaptor<NetconfSessionEnd> captor = ArgumentCaptor.forClass(NetconfSessionEnd.class);
 110         verify(registration).onSessionEnded(captor.capture());
 111         final NetconfSessionEnd value = captor.getValue();
 112         Assert.assertEquals(session.getSessionId(), value.getSessionId().getValue());
 113         Assert.assertEquals(session.getSourceHost().getIpAddress(), value.getSourceHost());
 114         Assert.assertEquals(session.getUsername(), value.getUsername());
 115     }
 116
 117     private static Session createSession(final long id) {
 118         return createSessionWithInRpcCount(id, 0);
 119     }
 120
 121     private static Session createSessionWithInRpcCount(final long id, final long inRpc) {
 122         return new SessionBuilder()
 123                 .setSessionId(id)
 124                 .setSourceHost(HostBuilder.getDefaultInstance("0.0.0.0"))
 125                 .setUsername("user")
 126                 .setInRpcs(new ZeroBasedCounter32(inRpc))
 127                 .build();
 128     }
 129
 130     @SuppressWarnings("unchecked")
 131     private static DataTreeModification<Session> getTreeModification(final Session session,
 132             final ModificationType type) {
 133         final DataTreeModification<Session> treeChange = mock(DataTreeModification.class);
 134         final DataObjectModification<Session> changeObject = mock(DataObjectModification.class);
 135         switch (type) {
 136             case WRITE:
 137                 doReturn(null).when(changeObject).getDataBefore();
 138                 doReturn(session).when(changeObject).getDataAfter();
 139                 break;
 140             case DELETE:
 141                 doReturn(session).when(changeObject).getDataBefore();
 142                 break;
 143             default:
 144                 LOG.debug("Received intentionally unhandled type: {}.", type);
 145         }
 146         doReturn(type).when(changeObject).getModificationType();
 147         doReturn(changeObject).when(treeChange).getRootNode();
 148         return treeChange;
 149     }
 150
 151 }