2 # Copyright (c) 2016 Cisco and/or its affiliates.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at:
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 """Traffic script that sends an IP ICMPv4/ICMPv6 packet from one interface
16 to the other. Source and destination IP addresses and source and destination
17 MAC addresses are checked in received packet.
23 from robot.api import logger
24 from scapy.layers.inet import ICMP, IP
25 from scapy.layers.inet6 import ICMPv6EchoRequest
26 from scapy.layers.inet6 import IPv6
27 from scapy.layers.l2 import Ether, Dot1Q
29 from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
30 from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
35 ipaddress.IPv4Address(unicode(ip))
37 except (AttributeError, ipaddress.AddressValueError):
43 ipaddress.IPv6Address(unicode(ip))
45 except (AttributeError, ipaddress.AddressValueError):
50 """Send IP ICMP packet from one traffic generator interface to the other."""
51 args = TrafficScriptArg(
52 ['tg_src_mac', 'tg_dst_mac', 'src_ip', 'dst_ip', 'dut_if1_mac',
54 ['encaps_tx', 'vlan_tx', 'vlan_outer_tx',
55 'encaps_rx', 'vlan_rx', 'vlan_outer_rx'])
57 tx_src_mac = args.get_arg('tg_src_mac')
58 tx_dst_mac = args.get_arg('dut_if1_mac')
59 rx_dst_mac = args.get_arg('tg_dst_mac')
60 rx_src_mac = args.get_arg('dut_if2_mac')
61 src_ip = args.get_arg('src_ip')
62 dst_ip = args.get_arg('dst_ip')
63 tx_if = args.get_arg('tx_if')
64 rx_if = args.get_arg('rx_if')
66 encaps_tx = args.get_arg('encaps_tx')
67 vlan_tx = args.get_arg('vlan_tx')
68 vlan_outer_tx = args.get_arg('vlan_outer_tx')
69 encaps_rx = args.get_arg('encaps_rx')
70 vlan_rx = args.get_arg('vlan_rx')
71 vlan_outer_rx = args.get_arg('vlan_outer_rx')
77 pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
78 if encaps_tx == 'Dot1q':
79 pkt_raw /= Dot1Q(vlan=int(vlan_tx))
80 elif encaps_tx == 'Dot1ad':
82 pkt_raw /= Dot1Q(vlan=vlan_outer_tx)
83 pkt_raw /= Dot1Q(vlan=vlan_tx)
84 if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
85 pkt_raw /= IP(src=src_ip, dst=dst_ip)
88 elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
89 pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
90 pkt_raw /= ICMPv6EchoRequest()
93 raise ValueError("IP not in correct format")
95 sent_packets.append(pkt_raw)
98 ether = rxq.recv(2, ignore=sent_packets)
103 raise RuntimeError("ICMP echo Rx timeout")
105 if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
106 logger.trace("MAC matched")
109 "Matching packet unsuccessful: {0}".format(ether.__repr__()))
111 if encaps_rx == 'Dot1q':
112 if ether[Dot1Q].vlan == int(vlan_rx):
113 logger.trace("VLAN matched")
115 raise RuntimeError('Ethernet frame with wrong VLAN tag ({}-'
116 'received, {}-expected):\n{}'
117 .format(ether[Dot1Q].vlan, vlan_rx,
119 ip = ether[Dot1Q].payload
120 elif encaps_rx == 'Dot1ad':
121 raise NotImplementedError()
125 if not isinstance(ip, ip_format):
127 "Not an IP packet received {0}".format(ip.__repr__()))
129 # Compare data from packets
131 logger.trace("Src IP matched")
133 raise RuntimeError("Matching Src IP unsuccessful: {} != {}"
134 .format(src_ip, ip.src))
137 logger.trace("Dst IP matched")
139 raise RuntimeError("Matching Dst IP unsuccessful: {} != {}"
140 .format(dst_ip, ip.dst))
145 if __name__ == "__main__":