builtinurl: mark api as deprecated
[vpp.git] / test / vpp_udp_encap.py
1 #!/usr/bin/env python3
2 """
3   UDP encap objects
4 """
5
6 from vpp_object import VppObject
7 from socket import inet_pton, inet_ntop, AF_INET, AF_INET6
8
9
10 def find_udp_encap(test, ue):
11     encaps = test.vapi.udp_encap_dump()
12     for e in encaps:
13         if (
14             ue.id == e.udp_encap.id
15             and ue.src_ip == str(e.udp_encap.src_ip)
16             and ue.dst_ip == str(e.udp_encap.dst_ip)
17             and e.udp_encap.dst_port == ue.dst_port
18             and e.udp_encap.src_port == ue.src_port
19         ):
20             return True
21
22     return False
23
24
25 class VppUdpEncap(VppObject):
26     def __init__(self, test, src_ip, dst_ip, src_port, dst_port, table_id=0):
27         self._test = test
28         self.table_id = table_id
29         self.src_ip_s = src_ip
30         self.dst_ip_s = dst_ip
31         self.src_ip = src_ip
32         self.dst_ip = dst_ip
33         self.src_port = src_port
34         self.dst_port = dst_port
35
36     def add_vpp_config(self):
37         r = self._test.vapi.udp_encap_add(
38             self.src_ip, self.dst_ip, self.src_port, self.dst_port, self.table_id
39         )
40         self.id = r.id
41         self._test.registry.register(self, self._test.logger)
42
43     def remove_vpp_config(self):
44         self._test.vapi.udp_encap_del(self.id)
45
46     def query_vpp_config(self):
47         return find_udp_encap(self._test, self)
48
49     def object_id(self):
50         return "udp-encap-%d" % self.id
51
52     def get_stats(self):
53         c = self._test.statistics.get_counter("/net/udp-encap")
54         return c[0][self.id]