tests/topotests/ospf_gr_helper/test_ospf_gr_helper3.py

   1 #!/usr/bin/python
   2
   3 #
   4 # Copyright (c) 2021 by VMware, Inc. ("VMware")
   5 # Used Copyright (c) 2018 by Network Device Education Foundation, Inc.
   6 # ("NetDEF") in this file.
   7 #
   8 # Permission to use, copy, modify, and/or distribute this software
   9 # for any purpose with or without fee is hereby granted, provided
  10 # that the above copyright notice and this permission notice appear
  11 # in all copies.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS" AND VMWARE DISCLAIMS ALL WARRANTIES
  14 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  15 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL VMWARE BE LIABLE FOR
  16 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
  17 # DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  18 # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  19 # ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20 # OF THIS SOFTWARE.
  21 #
  22
  23
  24 """OSPF Basic Functionality Automation."""
  25 import os
  26 import sys
  27 import time
  28 import pytest
  29
  30 # Save the Current Working Directory to find configuration files.
  31 CWD = os.path.dirname(os.path.realpath(__file__))
  32 sys.path.append(os.path.join(CWD, "../"))
  33
  34 # pylint: disable=C0413
  35 # Import topogen and topotest helpers
  36 from lib.topogen import Topogen, get_topogen
  37
  38 # Import topoJson from lib, to create topology and initial configuration
  39 from lib.common_config import (
  40     start_topology,
  41     write_test_header,
  42     write_test_footer,
  43     reset_config_on_routers,
  44     step,
  45     create_interfaces_cfg,
  46     scapy_send_raw_packet,
  47 )
  48
  49 from lib.topolog import logger
  50 from lib.topojson import build_config_from_json
  51
  52 from lib.ospf import (
  53     verify_ospf_neighbor,
  54     clear_ospf,
  55     verify_ospf_gr_helper,
  56     create_router_ospf,
  57 )
  58
  59 pytestmark = [pytest.mark.ospfd]
  60
  61 # Global variables
  62 topo = None
  63 Iters = 5
  64 sw_name = None
  65 intf = None
  66 intf1 = None
  67 pkt = None
  68
  69 """
  70 Topology:
  71
  72       Please view in a fixed-width font such as Courier.
  73       Topo : Broadcast Networks
  74       DUT - HR      RR
  75         +---+       +---+          +---+           +---+
  76         |R0 +       +R1 +          +R2 +           +R3 |
  77         +-+-+       +-+-+          +-+-+           +-+-+
  78           |           |              |               |
  79           |           |              |               |
  80         --+-----------+--------------+---------------+-----
  81                          Ethernet Segment
  82
  83 Testcases:
  84
  85 TC1.    Verify by default helper support is disabled for FRR ospf
  86 TC2.    OSPF GR on Broadcast : Verify DUT enters Helper mode when neighbor
  87         sends grace lsa, helps RR to restart gracefully (RR = DR)
  88 TC3.    OSPF GR on Broadcast : Verify DUT enters Helper mode when neighbor
  89         sends grace lsa, helps RR to restart gracefully (RR = BDR)
  90 TC4.    OSPF GR on Broadcast : Verify DUT enters Helper mode when neighbor
  91         sends grace lsa, helps RR to restart gracefully (RR = DRother)
  92 TC5.    OSPF GR on P2P : Verify DUT enters Helper mode when neighbor sends
  93         grace lsa, helps RR to restart gracefully.
  94 TC6.    Verify all the show commands newly introducted as part of ospf
  95         helper support - Json Key verification wrt to show commands.
  96 TC7.    Verify helper when grace lsa is received with different configured
  97         value in process level (higher, lower, grace lsa timer above 1800)
  98 TC8.    Verify helper functionality when dut is helping RR and new grace lsa
  99         is received from RR.
 100 """
 101
 102
 103 def setup_module(mod):
 104     """
 105     Sets up the pytest environment
 106
 107     * `mod`: module name
 108     """
 109     global topo, intf, intf1, sw_name, pkt
 110     testsuite_run_time = time.asctime(time.localtime(time.time()))
 111     logger.info("Testsuite start time: {}".format(testsuite_run_time))
 112     logger.info("=" * 40)
 113
 114     logger.info("Running setup_module to create topology")
 115
 116     # This function initiates the topology build with Topogen...
 117     json_file = "{}/ospf_gr_helper.json".format(CWD)
 118     tgen = Topogen(json_file, mod.__name__)
 119     global topo
 120     topo = tgen.json_topo
 121     # ... and here it calls Mininet initialization functions.
 122
 123     # Starting topology, create tmp files which are loaded to routers
 124     #  to start daemons and then start routers
 125     start_topology(tgen)
 126
 127     # Creating configuration from JSON
 128     build_config_from_json(tgen, topo)
 129
 130     # Don't run this test if we have any failure.
 131     if tgen.routers_have_failure():
 132         pytest.skip(tgen.errors)
 133
 134     ospf_covergence = verify_ospf_neighbor(tgen, topo, lan=True)
 135     assert ospf_covergence is True, "setup_module :Failed \n Error:" " {}".format(
 136         ospf_covergence
 137     )
 138
 139     sw_name = "s1"
 140     intf = topo["routers"]["r0"]["links"][sw_name]["interface"]
 141     intf1 = topo["routers"]["r1"]["links"][sw_name]["interface"]
 142     pkt = topo["routers"]["r1"]["opq_lsa_hex"]
 143
 144     logger.info("Running setup_module() done")
 145
 146
 147 def teardown_module():
 148     """Teardown the pytest environment"""
 149
 150     logger.info("Running teardown_module to delete topology")
 151
 152     tgen = get_topogen()
 153
 154     try:
 155         # Stop toplogy and Remove tmp files
 156         tgen.stop_topology()
 157
 158     except OSError:
 159         # OSError exception is raised when mininet tries to stop switch
 160         # though switch is stopped once but mininet tries to stop same
 161         # switch again, where it ended up with exception
 162         pass
 163
 164
 165 def delete_ospf():
 166     """delete ospf process after each test"""
 167     tgen = get_topogen()
 168     step("Delete ospf process")
 169     for rtr in topo["routers"]:
 170         ospf_del = {rtr: {"ospf": {"delete": True}}}
 171         result = create_router_ospf(tgen, topo, ospf_del)
 172         assert result is True, "Testcase: Failed \n Error: {}".format(result)
 173
 174
 175 # ##################################
 176 # Test cases start here.
 177 # ##################################
 178
 179
 180 def test_ospf_gr_helper_tc7_p1(request):
 181     """
 182     Test ospf gr helper
 183     Verify helper when grace lsa is received with different configured
 184     value in process level (higher, lower, grace lsa timer above 1800)
 185     """
 186     tc_name = request.node.name
 187     write_test_header(tc_name)
 188     tgen = get_topogen()
 189
 190     # Don't run this test if we have any failure.
 191     if tgen.routers_have_failure():
 192         pytest.skip(tgen.errors)
 193
 194     global topo, intf, intf1, pkt
 195
 196     step("Bring up the base config as per the topology")
 197     step(
 198         "Configure DR priority as 99 in RR , DUT dr priority = 98 "
 199         "& reset ospf process in all the routers"
 200     )
 201     step(
 202         "Enable GR on RR and DUT with grace period on RR = 333"
 203         "and grace period on DUT = 300"
 204     )
 205     reset_config_on_routers(tgen)
 206     ospf_covergence = verify_ospf_neighbor(tgen, topo, lan=True)
 207     assert (
 208         ospf_covergence is True
 209     ), "OSPF is not after reset config \n Error:" " {}".format(ospf_covergence)
 210     ospf_gr_r0 = {
 211         "r0": {"ospf": {"graceful-restart": {"helper enable": [], "opaque": True}}}
 212     }
 213     result = create_router_ospf(tgen, topo, ospf_gr_r0)
 214     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 215
 216     ospf_gr_r1 = {
 217         "r1": {"ospf": {"graceful-restart": {"helper enable": [], "opaque": True}}}
 218     }
 219     result = create_router_ospf(tgen, topo, ospf_gr_r1)
 220     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 221
 222     input_dict = {"supportedGracePeriod": 1800}
 223     dut = "r0"
 224     result = verify_ospf_gr_helper(tgen, topo, dut, input_dict)
 225     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 226
 227     step("Configure grace period = 1801 on RR and restart ospf .")
 228     grace_period_1801 = "01005e00000570708bd051ef080045c0005cbeb10000015907d111010101e00000050204004801010101000000009714000000000000000000000000000100010209030000000101010180000001c8e9002c000100040000016800020001010000000003000411010101"
 229     gracelsa_sent = scapy_send_raw_packet(tgen, topo, "r1", intf1, grace_period_1801)
 230
 231     step("Verify R0 does not enter helper mode.")
 232     input_dict = {"activeRestarterCnt": 1}
 233     dut = "r0"
 234     result = verify_ospf_gr_helper(tgen, topo, dut, input_dict, expected=False)
 235     assert (
 236         result is not True
 237     ), "Testcase {} : Failed. DUT entered helper role " " \n Error: {}".format(
 238         tc_name, result
 239     )
 240
 241     delete_ospf()
 242
 243     write_test_footer(tc_name)
 244
 245
 246 def test_ospf_gr_helper_tc8_p1(request):
 247     """
 248     Test ospf gr helper
 249
 250     Verify helper functionality when dut is helping RR and new grace lsa
 251     is received from RR.
 252     """
 253     tc_name = request.node.name
 254     write_test_header(tc_name)
 255     tgen = get_topogen()
 256
 257     # Don't run this test if we have any failure.
 258     if tgen.routers_have_failure():
 259         pytest.skip(tgen.errors)
 260
 261     global topo, intf, intf1, pkt
 262
 263     step("Bring up the base config as per the topology")
 264     step("Enable GR")
 265     reset_config_on_routers(tgen)
 266     ospf_covergence = verify_ospf_neighbor(tgen, topo, lan=True)
 267     assert (
 268         ospf_covergence is True
 269     ), "OSPF is not after reset config \n Error:" " {}".format(ospf_covergence)
 270     ospf_gr_r0 = {
 271         "r0": {"ospf": {"graceful-restart": {"helper enable": [], "opaque": True}}}
 272     }
 273     result = create_router_ospf(tgen, topo, ospf_gr_r0)
 274     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 275
 276     ospf_gr_r1 = {
 277         "r1": {"ospf": {"graceful-restart": {"helper enable": [], "opaque": True}}}
 278     }
 279     result = create_router_ospf(tgen, topo, ospf_gr_r1)
 280     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 281
 282     input_dict = {"supportedGracePeriod": 1800}
 283     dut = "r0"
 284     result = verify_ospf_gr_helper(tgen, topo, dut, input_dict)
 285     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 286
 287     step("Verify that DUT enters into helper mode.")
 288
 289     input_dict = {"activeRestarterCnt": 1}
 290     gracelsa_sent = False
 291     repeat = 0
 292     dut = "r0"
 293     while not gracelsa_sent and repeat < Iters:
 294         gracelsa_sent = scapy_send_raw_packet(tgen, topo, "r1", intf1, pkt)
 295         result = verify_ospf_gr_helper(tgen, topo, dut, input_dict)
 296         if isinstance(result, str):
 297             repeat += 1
 298             gracelsa_sent = False
 299
 300     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 301
 302     step("Send the Grace LSA again to DUT when RR is in GR.")
 303     input_dict = {"activeRestarterCnt": 1}
 304     gracelsa_sent = False
 305     repeat = 0
 306     dut = "r0"
 307     while not gracelsa_sent and repeat < Iters:
 308         gracelsa_sent = scapy_send_raw_packet(tgen, topo, "r1", intf1, pkt)
 309         result = verify_ospf_gr_helper(tgen, topo, dut, input_dict)
 310         if isinstance(result, str):
 311             repeat += 1
 312             gracelsa_sent = False
 313
 314     assert result is True, "Testcase {} : Failed \n Error: {}".format(tc_name, result)
 315
 316     delete_ospf()
 317
 318     write_test_footer(tc_name)
 319
 320
 321 if __name__ == "__main__":
 322     args = ["-s"] + sys.argv[1:]
 323     sys.exit(pytest.main(args))