git.puffer.fish Git - mirror/frr.git/blob

   1 #!/usr/bin/env python
   2
   3 #
   4 # Copyright (c) 2019 by VMware, Inc. ("VMware")
   5 # Used Copyright (c) 2018 by Network Device Education Foundation, Inc. ("NetDEF")
   6 # 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 <example>.py: Test <example tests>.
  25 """
  26
  27 import os
  28 import sys
  29 import json
  30 import time
  31 import inspect
  32 import pytest
  33
  34 # Save the Current Working Directory to find configuration files.
  35 CWD = os.path.dirname(os.path.realpath(__file__))
  36 sys.path.append(os.path.join(CWD, "../"))
  37 sys.path.append(os.path.join(CWD, "../../"))
  38
  39 # pylint: disable=C0413
  40 from lib.topogen import Topogen, get_topogen
  41
  42 # Required to instantiate the topology builder class.
  43 from mininet.topo import Topo
  44
  45 # Import topoJson from lib, to create topology and initial configuration
  46 from lib.common_config import (
  47     start_topology,
  48     write_test_header,
  49     write_test_footer,
  50     verify_rib,
  51 )
  52 from lib.topolog import logger
  53 from lib.bgp import verify_bgp_convergence
  54 from lib.topojson import build_topo_from_json, build_config_from_json
  55
  56
  57 # TODO: select markers based on daemons used during test
  58 # pytest module level markers
  59 """
  60 pytestmark = pytest.mark.bfdd # single marker
  61 pytestmark = [
  62         pytest.mark.bgpd,
  63         pytest.mark.ospfd,
  64         pytest.mark.ospf6d
  65 ] # multiple markers
  66 """
  67
  68
  69 # Reading the data from JSON File for topology and configuration creation
  70 jsonFile = "{}/example_topojson_multiple_links.json".format(CWD)
  71 try:
  72     with open(jsonFile, "r") as topoJson:
  73         topo = json.load(topoJson)
  74 except IOError:
  75     assert False, "Could not read file {}".format(jsonFile)
  76
  77 # Global variables
  78 bgp_convergence = False
  79 input_dict = {}
  80
  81
  82 class TemplateTopo(Topo):
  83     """
  84     Test topology builder
  85
  86     * `Topo`: Topology object
  87     """
  88
  89     def build(self, *_args, **_opts):
  90         "Build function"
  91         tgen = get_topogen(self)
  92
  93         # This function only purpose is to create topology
  94         # as defined in input json file.
  95         #
  96         # Example
  97         #
  98         # Creating 2 routers having 2 links in between,
  99         # one is used to establised BGP neighborship
 100
 101         # Building topology from json file
 102         build_topo_from_json(tgen, topo)
 103
 104
 105 def setup_module(mod):
 106     """
 107     Sets up the pytest environment
 108
 109     * `mod`: module name
 110     """
 111
 112     testsuite_run_time = time.asctime(time.localtime(time.time()))
 113     logger.info("Testsuite start time: {}".format(testsuite_run_time))
 114     logger.info("=" * 40)
 115
 116     logger.info("Running setup_module to create topology")
 117
 118     # This function initiates the topology build with Topogen...
 119     tgen = Topogen(TemplateTopo, mod.__name__)
 120     # ... and here it calls Mininet initialization functions.
 121
 122     # Starting topology, create tmp files which are loaded to routers
 123     #  to start deamons and then start routers
 124     start_topology(tgen)
 125
 126     # This function only purpose is to create configuration
 127     # as defined in input json file.
 128     #
 129     # Example
 130     #
 131     # Creating configuration defined in input JSON
 132     # file, example, BGP config, interface config, static routes
 133     # config, prefix list config
 134
 135     # Creating configuration from JSON
 136     build_config_from_json(tgen, topo)
 137
 138     logger.info("Running setup_module() done")
 139
 140
 141 def teardown_module(mod):
 142     """
 143     Teardown the pytest environment
 144
 145     * `mod`: module name
 146     """
 147
 148     logger.info("Running teardown_module to delete topology")
 149
 150     tgen = get_topogen()
 151
 152     # Stop toplogy and Remove tmp files
 153     tgen.stop_topology()
 154
 155
 156 def test_bgp_convergence(request):
 157     " Test BGP daemon convergence "
 158
 159     tgen = get_topogen()
 160     global bgp_convergence
 161     # test case name
 162     tc_name = request.node.name
 163     write_test_header(tc_name)
 164
 165     # Don't run this test if we have any failure.
 166     if tgen.routers_have_failure():
 167         pytest.skip(tgen.errors)
 168
 169     # Api call verify whether BGP is converged
 170     bgp_convergence = verify_bgp_convergence(tgen, topo)
 171     assert (
 172         bgp_convergence is True
 173     ), "test_bgp_convergence failed.. \n" " Error: {}".format(bgp_convergence)
 174
 175     logger.info("BGP is converged successfully \n")
 176     write_test_footer(tc_name)
 177
 178
 179 def test_static_routes(request):
 180     " Test to create and verify static routes. "
 181
 182     tgen = get_topogen()
 183     if bgp_convergence is not True:
 184         pytest.skip("skipped because of BGP Convergence failure")
 185
 186     # test case name
 187     tc_name = request.node.name
 188     write_test_header(tc_name)
 189
 190     # Static routes are created as part of initial configuration,
 191     # verifying RIB
 192     dut = "r3"
 193     protocol = "bgp"
 194     next_hop = "10.0.0.1"
 195     input_dict = {"r1": topo["routers"]["r1"]}
 196
 197     # Uncomment below to debug
 198     # tgen.mininet_cli()
 199     result = verify_rib(tgen, "ipv4", dut, input_dict, next_hop=next_hop)
 200     assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
 201
 202     write_test_footer(tc_name)
 203
 204
 205 if __name__ == "__main__":
 206     args = ["-s"] + sys.argv[1:]
 207     sys.exit(pytest.main(args))