frr/tests/topotests/isis-sr-te-topo1/test_isis_sr_te_topo1.py
Sebastien Merle 4d7b695d3a pathd: New SR-TE policy management daemon
This new daemon manages Segment-Routing Traffic-Engineering
(SR-TE) Policies and installs them into zebra. It provides
the usual yang support and vtysh commands to define or change
SR-TE Policies.

In a nutshell SR-TE Policies provide the possibility to steer
traffic through a (possibly dynamic) list of Segment Routing
segments to the endpoint of the policy. This list of segments
is part of a Candidate Path which again belongs to the SR-TE
Policy. SR-TE Policies are uniquely identified by their color
and endpoint. The color can be used to e.g. match BGP
communities on incoming traffic.

There can be multiple Candidate Paths for a single
policy, the active Candidate Path is chosen according to
certain conditions of which the most important is its
preference. Candidate Paths can be explicit (fixed list of
segments) or dynamic (list of segment comes from e.g. PCEP, see
below).

Configuration example:

segment-routing
 traffic-eng
  segment-list SL
   index 10 mpls label 1111
   index 20 mpls label 2222
  !
  policy color 4 endpoint 10.10.10.4
   name POL4
   binding-sid 104
   candidate-path preference 100 name exp explicit segment-list SL
   candidate-path preference 200 name dyn dynamic
  !
 !
!

There is an important connection between dynamic Candidate
Paths and the overall topic of Path Computation. Later on for
pathd a dynamic module will be introduced that is capable
of communicating via the PCEP protocol with a PCE (Path
Computation Element) which again is capable of calculating
paths according to its local TED (Traffic Engineering Database).
This dynamic module will be able to inject the mentioned
dynamic Candidate Paths into pathd based on calculated paths
from a PCE.

https://tools.ietf.org/html/draft-ietf-spring-segment-routing-policy-06

Co-authored-by: Sebastien Merle <sebastien@netdef.org>
Co-authored-by: Renato Westphal <renato@opensourcerouting.org>
Co-authored-by: GalaxyGorilla <sascha@netdef.org>
Co-authored-by: Emanuele Di Pascale <emanuele@voltanet.io>
Signed-off-by: Sebastien Merle <sebastien@netdef.org>
2020-12-18 16:34:02 +01:00

526 lines
20 KiB
Python
Executable file

#!/usr/bin/env python
#
# test_isis_sr_topo1.py
# Part of NetDEF Topology Tests
#
# Copyright (c) 2019 by
# Network Device Education Foundation, Inc. ("NetDEF")
#
# Permission to use, copy, modify, and/or distribute this software
# for any purpose with or without fee is hereby granted, provided
# that the above copyright notice and this permission notice appear
# in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND NETDEF DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL NETDEF BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
# OF THIS SOFTWARE.
#
"""
test_isis_sr_te_topo1.py:
+---------+
| |
| RT1 |
| 1.1.1.1 |
| |
+---------+
|eth-sw1
|
|
|
+---------+ | +---------+
| | | | |
| RT2 |eth-sw1 | eth-sw1| RT3 |
| 2.2.2.2 +----------+----------+ 3.3.3.3 |
| | 10.0.1.0/24 | |
+---------+ +---------+
eth-rt4-1| |eth-rt4-2 eth-rt5-1| |eth-rt5-2
| | | |
10.0.2.0/24| |10.0.3.0/24 10.0.4.0/24| |10.0.5.0/24
| | | |
eth-rt2-1| |eth-rt2-2 eth-rt3-1| |eth-rt3-2
+---------+ +---------+
| | | |
| RT4 | 10.0.6.0/24 | RT5 |
| 4.4.4.4 +---------------------+ 5.5.5.5 |
| |eth-rt5 eth-rt4| |
+---------+ +---------+
eth-rt6| |eth-rt6
| |
10.0.7.0/24| |10.0.8.0/24
| +---------+ |
| | | |
| | RT6 | |
+----------+ 6.6.6.6 +-----------+
eth-rt4| |eth-rt5
+---------+
|eth-dst (.1)
|
|10.0.11.0/24
|
|eth-rt6 (.2)
+---------+
| |
| DST |
| 9.9.9.2 |
| |
+---------+
"""
import os
import sys
import pytest
import json
import re
from time import sleep
from functools import partial
# Save the Current Working Directory to find configuration files.
CWD = os.path.dirname(os.path.realpath(__file__))
sys.path.append(os.path.join(CWD, '../'))
# pylint: disable=C0413
# Import topogen and topotest helpers
from lib import topotest
from lib.topogen import Topogen, TopoRouter, get_topogen
from lib.topolog import logger
# Required to instantiate the topology builder class.
from mininet.topo import Topo
class TemplateTopo(Topo):
"Test topology builder"
def build(self, *_args, **_opts):
"Build function"
tgen = get_topogen(self)
#
# Define FRR Routers
#
for router in ['rt1', 'rt2', 'rt3', 'rt4', 'rt5', 'rt6', 'dst']:
tgen.add_router(router)
#
# Define connections
#
switch = tgen.add_switch('s1')
switch.add_link(tgen.gears['rt1'], nodeif="eth-sw1")
switch.add_link(tgen.gears['rt2'], nodeif="eth-sw1")
switch.add_link(tgen.gears['rt3'], nodeif="eth-sw1")
switch = tgen.add_switch('s2')
switch.add_link(tgen.gears['rt2'], nodeif="eth-rt4-1")
switch.add_link(tgen.gears['rt4'], nodeif="eth-rt2-1")
switch = tgen.add_switch('s3')
switch.add_link(tgen.gears['rt2'], nodeif="eth-rt4-2")
switch.add_link(tgen.gears['rt4'], nodeif="eth-rt2-2")
switch = tgen.add_switch('s4')
switch.add_link(tgen.gears['rt3'], nodeif="eth-rt5-1")
switch.add_link(tgen.gears['rt5'], nodeif="eth-rt3-1")
switch = tgen.add_switch('s5')
switch.add_link(tgen.gears['rt3'], nodeif="eth-rt5-2")
switch.add_link(tgen.gears['rt5'], nodeif="eth-rt3-2")
switch = tgen.add_switch('s6')
switch.add_link(tgen.gears['rt4'], nodeif="eth-rt5")
switch.add_link(tgen.gears['rt5'], nodeif="eth-rt4")
switch = tgen.add_switch('s7')
switch.add_link(tgen.gears['rt4'], nodeif="eth-rt6")
switch.add_link(tgen.gears['rt6'], nodeif="eth-rt4")
switch = tgen.add_switch('s8')
switch.add_link(tgen.gears['rt5'], nodeif="eth-rt6")
switch.add_link(tgen.gears['rt6'], nodeif="eth-rt5")
switch = tgen.add_switch('s9')
switch.add_link(tgen.gears['rt6'], nodeif="eth-dst")
switch.add_link(tgen.gears['dst'], nodeif="eth-rt6")
def setup_module(mod):
"Sets up the pytest environment"
tgen = Topogen(TemplateTopo, mod.__name__)
tgen.start_topology()
router_list = tgen.routers()
# For all registered routers, load the zebra configuration file
for rname, router in router_list.iteritems():
router.load_config(
TopoRouter.RD_ZEBRA,
os.path.join(CWD, '{}/zebra.conf'.format(rname))
)
router.load_config(
TopoRouter.RD_ISIS,
os.path.join(CWD, '{}/isisd.conf'.format(rname))
)
router.load_config(
TopoRouter.RD_PATH,
os.path.join(CWD, '{}/pathd.conf'.format(rname))
)
router.load_config(
TopoRouter.RD_BGP,
os.path.join(CWD, '{}/bgpd.conf'.format(rname))
)
tgen.start_router()
def teardown_module(mod):
"Teardown the pytest environment"
tgen = get_topogen()
# This function tears down the whole topology.
tgen.stop_topology()
def setup_testcase(msg):
logger.info(msg)
tgen = get_topogen()
# Skip if previous fatal error condition is raised
if tgen.routers_have_failure():
pytest.skip(tgen.errors)
return tgen
def print_cmd_result(rname, command):
print(get_topogen().gears[rname].vtysh_cmd(command, isjson=False))
def compare_json_test(router, command, reference, exact):
output = router.vtysh_cmd(command, isjson=True)
result = topotest.json_cmp(output, reference)
# Note: topotest.json_cmp() just checks on inclusion of keys.
# For exact matching also compare the other way around.
if not result and exact:
return topotest.json_cmp(reference, output)
else:
return result
def cmp_json_output(rname, command, reference, exact=False):
"Compare router JSON output"
logger.info('Comparing router "%s" "%s" output', rname, command)
tgen = get_topogen()
filename = '{}/{}/{}'.format(CWD, rname, reference)
expected = json.loads(open(filename).read())
# Run test function until we get an result. Wait at most 60 seconds.
test_func = partial(compare_json_test,
tgen.gears[rname], command, expected, exact)
_, diff = topotest.run_and_expect(test_func, None, count=120, wait=0.5)
assertmsg = '"{}" JSON output mismatches the expected result'.format(rname)
assert diff is None, assertmsg
def cmp_json_output_exact(rname, command, reference):
return cmp_json_output(rname, command, reference, True)
def add_candidate_path(rname, endpoint, pref, name, segment_list='default'):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "policy color 1 endpoint ''' + endpoint + '''" \
-c "candidate-path preference ''' + str(pref) + ''' name ''' + name + ''' explicit segment-list ''' + segment_list + '''"''')
def delete_candidate_path(rname, endpoint, pref):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "policy color 1 endpoint ''' + endpoint + '''" \
-c "no candidate-path preference ''' + str(pref) + '''"''')
def add_segment(rname, name, index, label):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "segment-list ''' + name + '''" \
-c "index ''' + str(index) + ''' mpls label ''' + str(label) + '''"''')
def delete_segment(rname, name, index):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "segment-list ''' + name + '''" \
-c "no index ''' + str(index) + '''"''')
def create_sr_policy(rname, endpoint, bsid):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "policy color 1 endpoint ''' + endpoint + '''" \
-c "name default" \
-c "binding-sid ''' + str(bsid) + '''"''')
def delete_sr_policy(rname, endpoint):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "segment-routing" \
-c "traffic-eng" \
-c "no policy color 1 endpoint ''' + endpoint + '''"''')
def create_prefix_sid(rname, prefix, sid):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "router isis 1" \
-c "segment-routing prefix ''' + prefix + " index " + str(sid) + '''"''')
def delete_prefix_sid(rname, prefix):
get_topogen().net[rname].cmd(''' \
vtysh -c "conf t" \
-c "router isis 1" \
-c "no segment-routing prefix "''' + prefix)
#
# Step 1
#
# Checking the MPLS table using a single SR Policy and a single Candidate Path
#
def test_srte_init_step1():
setup_testcase("Test (step 1): wait for IS-IS convergence / label distribution")
for rname in ['rt1', 'rt6']:
cmp_json_output(rname,
"show mpls table json",
"step1/show_mpls_table_without_candidate.ref")
def test_srte_add_candidate_check_mpls_table_step1():
setup_testcase("Test (step 1): check MPLS table regarding the added Candidate Path")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
add_candidate_path(rname, endpoint, 100, 'default')
cmp_json_output(rname,
"show mpls table json",
"step1/show_mpls_table_with_candidate.ref")
delete_candidate_path(rname, endpoint, 100)
def test_srte_reinstall_sr_policy_check_mpls_table_step1():
setup_testcase("Test (step 1): check MPLS table after the SR Policy was removed and reinstalled")
for rname, endpoint, bsid in [('rt1', '6.6.6.6', 1111), ('rt6', '1.1.1.1', 6666)]:
add_candidate_path(rname, endpoint, 100, 'default')
delete_sr_policy(rname, endpoint)
cmp_json_output(rname,
"show mpls table json",
"step1/show_mpls_table_without_candidate.ref")
create_sr_policy(rname, endpoint, bsid)
add_candidate_path(rname, endpoint, 100, 'default')
cmp_json_output(rname,
"show mpls table json",
"step1/show_mpls_table_with_candidate.ref")
delete_candidate_path(rname, endpoint, 100)
#
# Step 2
#
# Checking pathd operational data using a single SR Policy and a single Candidate Path
#
def test_srte_bare_policy_step2():
setup_testcase("Test (step 2): bare SR Policy should not be operational")
for rname in ['rt1', 'rt6']:
cmp_json_output_exact(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step2/show_operational_data.ref")
def test_srte_add_candidate_check_operational_data_step2():
setup_testcase("Test (step 2): add single Candidate Path, SR Policy should be operational")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
add_candidate_path(rname, endpoint, 100, 'default')
cmp_json_output(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step2/show_operational_data_with_candidate.ref")
def test_srte_config_remove_candidate_check_operational_data_step2():
setup_testcase("Test (step 2): remove single Candidate Path, SR Policy should not be operational anymore")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
delete_candidate_path(rname, endpoint, 100)
cmp_json_output_exact(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step2/show_operational_data.ref")
#
# Step 3
#
# Testing the Candidate Path selection
#
def test_srte_add_two_candidates_step3():
setup_testcase("Test (step 3): second Candidate Path has higher Priority")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
for pref, cand_name in [('100', 'first'), ('200', 'second')]:
add_candidate_path(rname, endpoint, pref, cand_name)
cmp_json_output(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step3/show_operational_data_with_two_candidates.ref")
# cleanup
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
for pref in ['100', '200']:
delete_candidate_path(rname, endpoint, pref)
def test_srte_add_two_candidates_with_reverse_priority_step3():
setup_testcase("Test (step 3): second Candidate Path has lower Priority")
# Use reversed priorities here
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
for pref, cand_name in [('200', 'first'), ('100', 'second')]:
add_candidate_path(rname, endpoint, pref, cand_name)
cmp_json_output(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step3/show_operational_data_with_two_candidates.ref")
# cleanup
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
for pref in ['100', '200']:
delete_candidate_path(rname, endpoint, pref)
def test_srte_remove_best_candidate_step3():
setup_testcase("Test (step 3): delete the Candidate Path with higher priority")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
for pref, cand_name in [('100', 'first'), ('200', 'second')]:
add_candidate_path(rname, endpoint, pref, cand_name)
# Delete candidate with higher priority
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
delete_candidate_path(rname, endpoint, 200)
# Candidate with lower priority should get active now
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
cmp_json_output(rname,
"show yang operational-data /frr-pathd:pathd pathd",
"step3/show_operational_data_with_single_candidate.ref")
# cleanup
delete_candidate_path(rname, endpoint, 100)
#
# Step 4
#
# Checking MPLS table with a single SR Policy and a Candidate Path with different Segment Lists and other modifications
#
def test_srte_change_segment_list_check_mpls_table_step4():
setup_testcase("Test (step 4): check MPLS table for changed Segment List")
for rname, endpoint in [('rt1', '6.6.6.6'), ('rt6', '1.1.1.1')]:
add_candidate_path(rname, endpoint, 100, 'default')
# now change the segment list name
add_candidate_path(rname, endpoint, 100, 'default', 'test')
cmp_json_output(rname,
"show mpls table json",
"step4/show_mpls_table.ref")
delete_candidate_path(rname, endpoint, 100)
def test_srte_segment_list_add_segment_check_mpls_table_step4():
setup_testcase("Test (step 4): check MPLS table for added (then changed and finally deleted) segment")
add_candidate_path('rt1', '6.6.6.6', 100, 'default', 'test')
# first add a new segment
add_segment('rt1', 'test', 25, 16050)
cmp_json_output('rt1',
"show mpls table json",
"step4/show_mpls_table_add_segment.ref")
# ... then change it ...
add_segment('rt1', 'test', 25, 16030)
cmp_json_output('rt1',
"show mpls table json",
"step4/show_mpls_table_change_segment.ref")
# ... and finally delete it
delete_segment('rt1', 'test', 25)
cmp_json_output('rt1',
"show mpls table json",
"step4/show_mpls_table.ref")
delete_candidate_path('rt1', '6.6.6.6', 100)
#
# Step 5
#
# Checking the nexthop using a single SR Policy and a Candidate Path with configured route-map
#
def test_srte_route_map_with_sr_policy_check_nextop_step5():
setup_testcase("Test (step 5): recursive nexthop learned through BGP neighbour should be aligned with SR Policy from route-map")
# (re-)build the SR Policy two times to ensure that reinstalling still works
for i in [1,2]:
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_inactive_srte.ref")
delete_sr_policy('rt1', '6.6.6.6')
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_inactive_srte.ref")
create_sr_policy('rt1', '6.6.6.6', 1111)
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_inactive_srte.ref")
add_candidate_path('rt1', '6.6.6.6', 100, 'default')
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_active_srte.ref")
delete_candidate_path('rt1', '6.6.6.6', 100)
def test_srte_route_map_with_sr_policy_reinstall_prefix_sid_check_nextop_step5():
setup_testcase("Test (step 5): remove and re-install prefix SID on fist path element and check SR Policy activity")
# first add a candidate path so the SR Policy is active
add_candidate_path('rt1', '6.6.6.6', 100, 'default')
cmp_json_output('rt1',
"show yang operational-data /frr-pathd:pathd pathd",
"step5/show_operational_data_active.ref")
# delete prefix SID from first element of the configured path and check
# if the SR Policy is inactive since the label can't be resolved anymore
delete_prefix_sid('rt5', "5.5.5.5/32")
cmp_json_output('rt1',
"show yang operational-data /frr-pathd:pathd pathd",
"step5/show_operational_data_inactive.ref")
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_inactive_srte.ref")
# re-create the prefix SID and check if the SR Policy is active
create_prefix_sid('rt5', "5.5.5.5/32", 50)
cmp_json_output('rt1',
"show yang operational-data /frr-pathd:pathd pathd",
"step5/show_operational_data_active.ref")
cmp_json_output('rt1',
"show ip route bgp json",
"step5/show_ip_route_bgp_active_srte.ref")
# Memory leak test template
def test_memory_leak():
"Run the memory leak test and report results."
tgen = get_topogen()
if not tgen.is_memleak_enabled():
pytest.skip('Memory leak test/report is disabled')
tgen.report_memory_leaks()
if __name__ == '__main__':
args = ["-s"] + sys.argv[1:]
sys.exit(pytest.main(args))