bgp/rib-impl/src/test/java/org/opendaylight/protocol/bgp/rib/impl/config/GracefulRestartUtilTest.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.protocol.bgp.rib.impl.config;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.MockitoAnnotations.initMocks;
  15
  16 import com.google.common.collect.ImmutableList;
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.HashMap;
  20 import java.util.HashSet;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.Set;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.mockito.Mock;
  28 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  29 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  30 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
  31 import org.opendaylight.protocol.bgp.rib.impl.BgpPeerUtil;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafiBuilder;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.afi.safi.GracefulRestartBuilder;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.afi.safi.graceful.restart.ConfigBuilder;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.IPV4LABELLEDUNICAST;
  37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.IPV4UNICAST;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.IPV6UNICAST;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.Config1;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.Config1Builder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.afi.safi.ll.graceful.restart.LlGracefulRestartBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParameters;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParameters;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.GracefulRestartCapability;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapability;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv6AddressFamily;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.uint24.rev200104.Uint24;
  54 import org.opendaylight.yangtools.yang.common.Uint32;
  55
  56 public class GracefulRestartUtilTest {
  57
  58     private static final int RESTART_TIME = 5;
  59     private static final int STALE_TIME = 10;
  60     private static final boolean RESTARTING = true;
  61     private static final AfiSafi IPV4_UNICAST_AFISAFI = new AfiSafiBuilder()
  62             .setAfiSafiName(IPV4UNICAST.class)
  63             .setGracefulRestart(new GracefulRestartBuilder()
  64                     .setConfig(new ConfigBuilder()
  65                             .setEnabled(true)
  66                             .build()).build()).build();
  67     private static final AfiSafi IPV4_MULTICAST_AFISAFI = new AfiSafiBuilder()
  68             .setAfiSafiName(IPV4LABELLEDUNICAST.class)
  69             .setGracefulRestart(new GracefulRestartBuilder()
  70                     .setConfig(new ConfigBuilder()
  71                             .setEnabled(false)
  72                             .build()).build()).build();
  73     private static final AfiSafi IPV6_AFISAFI = new AfiSafiBuilder()
  74             .setAfiSafiName(IPV6UNICAST.class)
  75             .setGracefulRestart(new GracefulRestartBuilder()
  76                     .setConfig(new ConfigBuilder()
  77                             .setEnabled(true)
  78                             .build()).build()).build();
  79     private static final TablesKey IPV4_KEY = new TablesKey(Ipv4AddressFamily.class,
  80             UnicastSubsequentAddressFamily.class);
  81     private static final TablesKey IPV6_KEY = new TablesKey(Ipv6AddressFamily.class,
  82             UnicastSubsequentAddressFamily.class);
  83
  84     private static final List<AfiSafi> AFISAFIS = ImmutableList.of(IPV4_UNICAST_AFISAFI, IPV4_MULTICAST_AFISAFI,
  85         IPV6_AFISAFI);
  86
  87     @Mock
  88     private BGPTableTypeRegistryConsumer tableRegistry;
  89
  90
  91     @Before
  92     public void setUp() {
  93         initMocks(this);
  94         doReturn(Optional.of(IPV4_KEY)).when(tableRegistry).getTableKey(IPV4UNICAST.class);
  95         doReturn(Optional.of(IPV6_KEY)).when(tableRegistry).getTableKey(IPV6UNICAST.class);
  96     }
  97
  98     @Test
  99     public void getGracefulCapabilityTest() {
 100         final Map<TablesKey, Boolean> gracefulMap = new HashMap<>();
 101         gracefulMap.put(IPV4_KEY, true);
 102         gracefulMap.put(IPV6_KEY, false);
 103         CParameters capability = GracefulRestartUtil.getGracefulCapability(gracefulMap, RESTART_TIME, RESTARTING);
 104         final CParameters1 params = capability.augmentation(CParameters1.class);
 105         assertNotNull(params);
 106         final GracefulRestartCapability gracefulCapability = params.getGracefulRestartCapability();
 107         assertNotNull(gracefulCapability);
 108         assertTrue(gracefulCapability.getRestartFlags().isRestartState());
 109         assertEquals(RESTART_TIME, gracefulCapability.getRestartTime().intValue());
 110         final var tables = gracefulCapability.getTables();
 111         assertNotNull(tables);
 112         assertEquals(2, tables.size());
 113         tables.values().forEach(table -> {
 114             assertTrue(isSameKey(IPV4_KEY, table.key()) && table.getAfiFlags().isForwardingState()
 115                 || isSameKey(IPV6_KEY, table.key()) && !table.getAfiFlags().isForwardingState());
 116         });
 117     }
 118
 119     @Test
 120     public void getGracefulTablesTest() {
 121         final Set<TablesKey> gracefulTables = GracefulRestartUtil.getGracefulTables(AFISAFIS, tableRegistry);
 122         assertEquals(2, gracefulTables.size());
 123         assertTrue(gracefulTables.contains(IPV4_KEY));
 124         assertTrue(gracefulTables.contains(IPV6_KEY));
 125     }
 126
 127     @Test
 128     public void getGracefulBgpParametersTest() {
 129         final OptionalCapabilities cap1 = new OptionalCapabilitiesBuilder()
 130                 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build();
 131         final OptionalCapabilities cap2 = new OptionalCapabilitiesBuilder()
 132                 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build();
 133         final List<OptionalCapabilities> fixedCaps = new ArrayList<>();
 134         fixedCaps.add(cap1);
 135         fixedCaps.add(cap2);
 136         final Set<TablesKey> gracefulTables = new HashSet<>();
 137         gracefulTables.add(IPV4_KEY);
 138         gracefulTables.add(IPV6_KEY);
 139         final Set<TablesKey> preservedTables = new HashSet<>();
 140         preservedTables.add(IPV4_KEY);
 141
 142         final Map<TablesKey, Boolean> gracefulMap = new HashMap<>();
 143         gracefulMap.put(IPV4_KEY, true);
 144         gracefulMap.put(IPV6_KEY, false);
 145         final OptionalCapabilities expectedGracefulCapability = new OptionalCapabilitiesBuilder()
 146                 .setCParameters(GracefulRestartUtil.getGracefulCapability(gracefulMap, RESTART_TIME, RESTARTING))
 147                 .build();
 148         final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulDTOs = Collections.singleton(
 149                 new BgpPeerUtil.LlGracefulRestartDTO(IPV4_KEY, STALE_TIME, true));
 150         final OptionalCapabilities expectedLlGracefulCapability = new OptionalCapabilitiesBuilder()
 151                 .setCParameters(GracefulRestartUtil.getLlGracefulCapability(llGracefulDTOs))
 152                 .build();
 153         final BgpParameters parameters = GracefulRestartUtil.getGracefulBgpParameters(fixedCaps, gracefulTables,
 154                 preservedTables, RESTART_TIME, RESTARTING, llGracefulDTOs);
 155         final List<OptionalCapabilities> capabilities = parameters.getOptionalCapabilities();
 156         assertTrue(capabilities != null);
 157         assertEquals(4, capabilities.size());
 158         assertTrue(capabilities.contains(cap1));
 159         assertTrue(capabilities.contains(cap2));
 160         assertTrue(capabilities.contains(expectedGracefulCapability));
 161         assertTrue(capabilities.contains(expectedLlGracefulCapability));
 162     }
 163
 164     @Test
 165     public void getLlGracefulCapabilityTest() {
 166         final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulRestartDTOs = new HashSet<>();
 167         llGracefulRestartDTOs.add(new BgpPeerUtil.LlGracefulRestartDTO(IPV4_KEY, STALE_TIME, true));
 168         llGracefulRestartDTOs.add(new BgpPeerUtil.LlGracefulRestartDTO(IPV6_KEY, STALE_TIME, false));
 169         CParameters capability = GracefulRestartUtil.getLlGracefulCapability(llGracefulRestartDTOs);
 170         final CParameters1 params = capability.augmentation(CParameters1.class);
 171         assertNotNull(params);
 172         final LlGracefulRestartCapability llGracefulCapability = params.getLlGracefulRestartCapability();
 173         assertNotNull(llGracefulCapability);
 174         final var tables = llGracefulCapability.getTables();
 175         assertNotNull(tables);
 176         assertEquals(2, tables.size());
 177         assertEquals(STALE_TIME, tables.values().iterator().next().getLongLivedStaleTime().getValue().intValue());
 178         tables.values().forEach(table -> {
 179             assertTrue(isSameKey(IPV4_KEY, table.key()) && table.getAfiFlags().isForwardingState()
 180                 || isSameKey(IPV6_KEY, table.key()) && !table.getAfiFlags().isForwardingState());
 181         });
 182     }
 183
 184     @Test
 185     public void getLlGracefulTimersTest() {
 186         final List<AfiSafi> afiSafi = new ArrayList<>();
 187         afiSafi.add(new AfiSafiBuilder()
 188             .setAfiSafiName(IPV4UNICAST.class)
 189             .setGracefulRestart(new GracefulRestartBuilder()
 190                 .setConfig(new ConfigBuilder()
 191                     .addAugmentation(Config1.class, new Config1Builder()
 192                         .setLlGracefulRestart(new LlGracefulRestartBuilder()
 193                             .setConfig(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll
 194                                 .graceful.restart.rev181112.afi.safi.ll.graceful.restart.ll.graceful.restart
 195                                 .ConfigBuilder().setLongLivedStaleTime(new Uint24(Uint32.valueOf(STALE_TIME))).build())
 196                             .build())
 197                         .build())
 198                     .build())
 199                 .build())
 200             .build());
 201         final Map<TablesKey, Integer> llGracefulTimers = GracefulRestartUtil.getLlGracefulTimers(afiSafi,
 202             this.tableRegistry);
 203         assertNotNull(llGracefulTimers);
 204         assertEquals(1, llGracefulTimers.size());
 205         assertEquals(STALE_TIME, llGracefulTimers.get(IPV4_KEY).intValue());
 206     }
 207
 208     private static boolean isSameKey(final TablesKey key1, final org.opendaylight.yang.gen.v1.urn.opendaylight.params
 209             .xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.graceful.restart.capability.TablesKey key2) {
 210         return key1.getAfi() == key2.getAfi() && key1.getSafi() == key2.getSafi();
 211     }
 212
 213     private static boolean isSameKey(final TablesKey key1, final org.opendaylight.yang.gen.v1.urn.opendaylight.params
 214             .xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesKey key2) {
 215         return key1.getAfi() == key2.getAfi() && key1.getSafi() == key2.getSafi();
 216     }
 217 }