Merge "OPNFLWPLUG-1062 Include additional LLDP fields in liblldp"
[openflowplugin.git] / applications / topology-lldp-discovery / src / test / java / org / opendaylight / openflowplugin / applications / topology / lldp / LLDPLinkAgerTest.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
9 package org.opendaylight.openflowplugin.applications.topology.lldp;
10
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertTrue;
13 import static org.mockito.ArgumentMatchers.any;
14 import static org.mockito.Mockito.verify;
15
16 import java.util.Optional;
17 import org.junit.Before;
18 import org.junit.Test;
19 import org.junit.runner.RunWith;
20 import org.mockito.Mock;
21 import org.mockito.Mockito;
22 import org.mockito.runners.MockitoJUnitRunner;
23 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
24 import org.opendaylight.mdsal.eos.binding.api.Entity;
25 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
26 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
27 import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationService;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkDiscovered;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemoved;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.NonZeroUint32Type;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.TopologyLldpDiscoveryConfig;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.lldp.discovery.config.rev160511.TopologyLldpDiscoveryConfigBuilder;
38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41
42 /**
43  * Test for {@link LLDPLinkAger}.
44  */
45 @RunWith(MockitoJUnitRunner.class)
46 public class LLDPLinkAgerTest {
47
48     private static final Logger LOG = LoggerFactory.getLogger(LLDPLinkAgerTest.class);
49
50     private static final long LLDP_INTERVAL = 5L;
51     private static final long LINK_EXPIRATION_TIME = 10L;
52
53     /**
54      * We need to wait while other tasks are finished before we can check anything in LLDPAgingTask.
55      */
56     private static final int SLEEP = 100;
57
58     private LLDPLinkAger lldpLinkAger;
59
60     @Mock
61     private LinkDiscovered link;
62     @Mock
63     private NotificationPublishService notificationService;
64     @Mock
65     private EntityOwnershipService eos;
66     @Mock
67     private LinkRemoved linkRemoved;
68
69     @Before
70     public void setUp() {
71         lldpLinkAger = new LLDPLinkAger(getConfig(), notificationService, getConfigurationService(), eos);
72         Mockito.when(link.getDestination()).thenReturn(new NodeConnectorRef(
73                 InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(new NodeId("openflow:1")))));
74         Mockito.when(eos.getOwnershipState(any(Entity.class))).thenReturn(
75                 Optional.of(EntityOwnershipState.IS_OWNER));
76     }
77
78     @Test
79     public void testPut() {
80         assertTrue(lldpLinkAger.isLinkToDateEmpty());
81         lldpLinkAger.put(link);
82         assertFalse(lldpLinkAger.isLinkToDateEmpty());
83     }
84
85     @Test
86     public void testClose() throws Exception {
87         lldpLinkAger.close();
88         assertTrue(lldpLinkAger.isLinkToDateEmpty());
89     }
90
91     /**
92      * Inner class LLDPAgingTask removes all expired records from linkToDate if any (in constructor of LLDPLinkAger).
93      */
94     @Test
95     public void testLLDPAgingTask() throws InterruptedException {
96         lldpLinkAger.put(link);
97         Thread.sleep(SLEEP);
98         verify(notificationService).putNotification(any(LinkRemoved.class));
99     }
100
101     private TopologyLldpDiscoveryConfig getConfig() {
102         TopologyLldpDiscoveryConfigBuilder cfgBuilder = new TopologyLldpDiscoveryConfigBuilder();
103         cfgBuilder.setTopologyLldpInterval(new NonZeroUint32Type(LLDP_INTERVAL));
104         cfgBuilder.setTopologyLldpExpirationInterval(new NonZeroUint32Type(LINK_EXPIRATION_TIME));
105         return cfgBuilder.build();
106     }
107
108     private ConfigurationService getConfigurationService() {
109         final ConfigurationService configurationService = Mockito.mock(ConfigurationService.class);
110         final TopologyLldpDiscoveryConfig config = getConfig();
111
112         Mockito.when(configurationService.registerListener(any())).thenReturn(() -> {
113         });
114
115         Mockito.lenient().when(configurationService.getProperty(Mockito.eq("topology-lldp-interval"), any()))
116                 .thenReturn(config.getTopologyLldpInterval());
117
118         Mockito.lenient().when(configurationService.getProperty(Mockito.eq("topology-lldp-expiration-interval"), any()))
119                 .thenReturn(config.getTopologyLldpExpirationInterval());
120
121         return configurationService;
122     }
123 }