resources/libraries/python/VppCounters.py

   1 # Copyright (c) 2016 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """VPP counters utilities library."""
  15
  16 import time
  17
  18 from robot.api import logger
  19
  20 from resources.libraries.python.topology import NodeType, Topology
  21 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
  22
  23
  24 class VppCounters(object):
  25     """VPP counters utilities."""
  26
  27     def __init__(self):
  28         self._stats_table = None
  29
  30     def vpp_nodes_clear_interface_counters(self, nodes):
  31         """Clear interface counters on all VPP nodes in topology.
  32
  33         :param nodes: Nodes in topology.
  34         :type nodes: dict
  35         """
  36         for node in nodes.values():
  37             if node['type'] == NodeType.DUT:
  38                 self.vpp_clear_interface_counters(node)
  39
  40     @staticmethod
  41     def vpp_show_errors(node):
  42         """Run "show errors" debug CLI command.
  43
  44         :param node: Node to run command on.
  45         :type node: dict
  46         """
  47         vat = VatExecutor()
  48         vat.execute_script("show_errors.vat", node, json_out=False)
  49
  50     @staticmethod
  51     def vpp_show_errors_verbose(node):
  52         """Run "show errors verbose" debug CLI command.
  53
  54         :param node: Node to run command on.
  55         :type node: dict
  56         """
  57         vat = VatExecutor()
  58         vat.execute_script("show_errors_verbose.vat", node, json_out=False)
  59
  60     @staticmethod
  61     def vpp_show_runtime(node):
  62         """Run "show runtime" CLI command.
  63
  64         :param node: Node to run command on.
  65         :type node: dict
  66         """
  67         vat = VatExecutor()
  68         vat.execute_script("show_runtime.vat", node, json_out=False)
  69
  70     @staticmethod
  71     def vpp_show_runtime_verbose(node):
  72         """Run "show runtime verbose" CLI command.
  73
  74         :param node: Node to run command on.
  75         :type node: dict
  76         """
  77         vat = VatExecutor()
  78         vat.execute_script("show_runtime_verbose.vat", node, json_out=False)
  79
  80     @staticmethod
  81     def vpp_show_hardware_detail(node):
  82         """Run "show hardware-interfaces detail" debug CLI command.
  83
  84         :param node: Node to run command on.
  85         :type node: dict
  86         """
  87         vat = VatExecutor()
  88         vat.execute_script("show_hardware_detail.vat", node, json_out=False)
  89
  90     @staticmethod
  91     def vpp_clear_runtime(node):
  92         """Run "clear runtime" CLI command.
  93
  94         :param node: Node to run command on.
  95         :type node: dict
  96         """
  97         vat = VatExecutor()
  98         vat.execute_script("clear_runtime.vat", node, json_out=False)
  99
 100     @staticmethod
 101     def vpp_clear_interface_counters(node):
 102         """Clear interface counters on VPP node.
 103
 104         :param node: Node to clear interface counters on.
 105         :type node: dict
 106         """
 107         vat = VatExecutor()
 108         vat.execute_script('clear_interface.vat', node)
 109         vat.script_should_have_passed()
 110
 111     def vpp_dump_stats_table(self, node):
 112         """Dump stats table on VPP node.
 113
 114         :param node: Node to dump stats table on.
 115         :type node: dict
 116         :return: Stats table.
 117         """
 118         with VatTerminal(node) as vat:
 119             vat.vat_terminal_exec_cmd('want_stats enable')
 120             for _ in range(0, 12):
 121                 stats_table = vat.vat_terminal_exec_cmd('dump_stats_table')
 122                 if_counters = stats_table['interface_counters']
 123                 if len(if_counters) > 0:
 124                     self._stats_table = stats_table
 125                     return stats_table
 126                 time.sleep(1)
 127             return None
 128
 129     def vpp_get_ipv4_interface_counter(self, node, interface):
 130         return self.vpp_get_ipv46_interface_counter(node, interface, False)
 131
 132     def vpp_get_ipv6_interface_counter(self, node, interface):
 133         return self.vpp_get_ipv46_interface_counter(node, interface, True)
 134
 135     def vpp_get_ipv46_interface_counter(self, node, interface, is_ipv6=True):
 136         """Return interface IPv4/IPv6 counter.
 137
 138         :param node: Node to get interface IPv4/IPv6 counter on.
 139         :param interface: Interface name.
 140         :param is_ipv6: Specify IP version.
 141         :type node: dict
 142         :type interface: str
 143         :type is_ipv6: bool
 144         :return: Interface IPv4/IPv6 counter.
 145         :rtype: int
 146         """
 147         version = 'ip6' if is_ipv6 else 'ip4'
 148         topo = Topology()
 149         if_index = topo.get_interface_sw_index(node, interface)
 150         if if_index is None:
 151             logger.trace('{i} sw_index not found.'.format(i=interface))
 152             return 0
 153
 154         if_counters = self._stats_table.get('interface_counters')
 155         if if_counters is None or len(if_counters) == 0:
 156             logger.trace('No interface counters.')
 157             return 0
 158         for counter in if_counters:
 159             if counter['vnet_counter_type'] == version:
 160                 data = counter['data']
 161                 return data[if_index]
 162         logger.trace('{i} {v} counter not found.'.format(i=interface,
 163                                                          v=version))
 164         return 0