many capture modes in Python console

Signed-off-by: imarom <imarom@cisco.com>

3 files changed, 108 insertions, 109 deletions

diff --git a/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py b/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py
index d75c554e..c632ad7c 100755
--- a/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py
+++ b/scripts/automation/trex_control_plane/stl/trex_stl_lib/trex_stl_client.py
@@ -17,10 +17,12 @@ from .utils.text_opts import *
 from functools import wraps
 from texttable import ansi_len
 
+
 from collections import namedtuple
 from yaml import YAMLError
 import time
 import datetime
+import threading
 import re
 import random
 import json
@@ -601,7 +603,7 @@ class STLClient(object):
                                                                  self.util_stats,
                                                                  self.xstats,
                                                                  self.async_client.monitor)
-
+        
     ############# private functions - used by the class itself ###########
 
     
@@ -2981,7 +2983,7 @@ class STLClient(object):
         self.logger.post_cmd(rc)
 
         if verbose:
-            for x in filter(bool, rc.data()):
+            for x in filter(bool, listify(rc.data())):
                 self.logger.log(format_text("{0}".format(x), 'bold'))
                 
         if not rc:
@@ -2999,6 +3001,10 @@ class STLClient(object):
                 tx_ports       - on which ports to capture TX
                 rx_ports       - on which ports to capture RX
                 limit          - limit how many packets will be written
+                
+            :returns:
+                the new capture_id
+                
             :raises:
                 + :exe:'STLError'
 
@@ -3018,7 +3024,7 @@ class STLClient(object):
 
         non_service_ports =  list_difference(set(tx_ports + rx_ports), self.get_service_enabled_ports())
         if non_service_ports:
-            raise STLError("Port(s) {0} are not under service mode. PCAP capturing requires all ports to be in service mode")
+            raise STLError("Port(s) {0} are not under service mode. PCAP capturing requires all ports to be in service mode".format(non_service_ports))
         
             
         self.logger.pre_cmd("Starting PCAP capturing up to {0} packets".format(limit))
@@ -3030,8 +3036,39 @@ class STLClient(object):
         if not rc:
             raise STLError(rc)
 
+        return rc.data()['capture_id']
 
 
+        
+                
+    def __fetch_capture_packets (self, capture_id, output_filename, pkt_count):
+        self.logger.pre_cmd("Writing {0} packets to '{1}'".format(pkt_count, output_filename))
+
+        # create a PCAP file
+        writer = RawPcapWriter(output_filename, linktype = 1)
+        writer._write_header(None)
+        
+        # fetch
+        pending = pkt_count
+        rc = RC_OK()
+        while pending > 0:
+            rc = self._transmit("capture", params = {'command': 'fetch', 'capture_id': capture_id, 'pkt_limit': 50})
+            if not rc:
+                self.logger.post_cmd(rc)
+                raise STLError(rc)
+        
+            pkts = rc.data()['pkts']
+            for pkt in pkts:
+                ts = pkt['ts']
+                pkt_bin = base64.b64decode(pkt['binary'])
+                writer._write_packet(pkt_bin, sec = 0, usec = 0)
+                
+            pending = rc.data()['pending']
+            
+        
+        self.logger.post_cmd(rc)
+        
+        
     @__api_check(True)
     def stop_capture (self, capture_id, output_filename):
         """
@@ -3045,8 +3082,6 @@ class STLClient(object):
                 + :exe:'STLError'
 
         """
-
-        
         
         # stopping a capture requires:
         # 1. stopping
@@ -3063,36 +3098,19 @@ class STLClient(object):
         
         # pkt count
         pkt_count = rc.data()['pkt_count']
-            
-        if not output_filename or pkt_count == 0:
-            return
         
-        self.logger.pre_cmd("Writing {0} packets to '{1}'".format(pkt_count, output_filename))
-
-        # create a PCAP file
-        writer = RawPcapWriter(output_filename, linktype = 1)
-        writer._write_header(None)
-        
-        # fetch
-        while True:
-            rc = self._transmit("capture", params = {'command': 'fetch', 'capture_id': capture_id, 'pkt_limit': 50})
-            if not rc:
-                self.logger.post_cmd(rc)
-                raise STLError(rc)
-        
-            pkts = rc.data()['pkts']
-            for pkt in pkts:
-                ts = pkt['ts']
-                pkt_bin = base64.b64decode(pkt['binary'])
-                writer._write_packet(pkt_bin, sec = 0, usec = 0)
-                
-            if rc.data()['pending'] == 0:
-                break
+        # fetch packets    
+        if output_filename:
+            self.__fetch_capture_packets(capture_id, output_filename, pkt_count)
         
+        # remove
+        self.logger.pre_cmd("Removing PCAP capture {0} from server".format(capture_id))
+        rc = self._transmit("capture", params = {'command': 'remove', 'capture_id': capture_id})
         self.logger.post_cmd(rc)
+        if not rc:
+            raise STLError(rc)
         
 
-    # get capture status
     @__api_check(True)
     def get_capture_status (self):
         """
@@ -3109,7 +3127,25 @@ class STLClient(object):
 
         return rc.data()
 
-    
+    @__api_check(True)
+    def remove_all_captures (self):
+        """
+            Removes any existing captures
+        """
+        captures = self.get_capture_status()
+        
+        self.logger.pre_cmd("Removing all PCAP captures from server")
+        
+        for c in captures:
+            # remove
+            rc = self._transmit("capture", params = {'command': 'remove', 'capture_id': c['id']})
+            if not rc:
+                raise STLError(rc)
+
+        self.logger.post_cmd(RC_OK())
+                
+
+        
     @__api_check(True)
     def set_rx_queue (self, ports = None, size = 1000):
         """
@@ -3230,6 +3266,7 @@ class STLClient(object):
 
         return wrap
 
+
     @__console
     def ping_line (self, line):
         '''pings the server / specific IP'''
@@ -3820,77 +3857,9 @@ class STLClient(object):
                                 opts.link,
                                 opts.led,
                                 opts.flow_ctrl)
+                         
+               
              
-             
-
-             
-    @__console
-    def capture_line (self, line):
-        '''Manage PCAP recorders'''
-
-        # default
-        if not line:
-            line = "show"
-
-        parser = parsing_opts.gen_parser(self, "capture", self.capture_line.__doc__)
-        subparsers = parser.add_subparsers(title = "commands", dest="commands")
-
-        # start
-        start_parser = subparsers.add_parser('start', help = "starts a new capture")
-        start_parser.add_arg_list(parsing_opts.TX_PORT_LIST,
-                                  parsing_opts.RX_PORT_LIST,
-                                  parsing_opts.LIMIT)
-
-        # stop
-        stop_parser = subparsers.add_parser('stop', help = "stops an active capture")
-        stop_parser.add_arg_list(parsing_opts.CAPTURE_ID,
-                                 parsing_opts.OUTPUT_FILENAME)
-
-        # show
-        show_parser = subparsers.add_parser('show', help = "show all active captures")
-
-        opts = parser.parse_args(line.split())
-
-        if not opts:
-            return opts
-
-        # start
-        if opts.commands == 'start':
-            if not opts.tx_port_list and not opts.rx_port_list:
-                start_parser.formatted_error('please provide either --tx or --rx')
-                return
-
-            self.start_capture(opts.tx_port_list, opts.rx_port_list, opts.limit)
-
-        # stop
-        elif opts.commands == 'stop':
-            self.stop_capture(opts.capture_id, opts.output_filename)
-
-        # show
-        else:
-            data = self.get_capture_status()
-
-            stats_table = text_tables.TRexTextTable()
-            stats_table.set_cols_align(["c"] * 6)
-            stats_table.set_cols_width([15] * 6)
-
-            for elem in data:
-                row = [elem['id'],
-                       elem['state'],
-                       '[{0}/{1}]'.format(elem['count'], elem['limit']),
-                       format_num(elem['bytes'], suffix = 'B'),
-                       bitfield_to_str(elem['filter']['tx']),
-                       bitfield_to_str(elem['filter']['rx'])]
-                
-                stats_table.add_rows([row], header=False)
-
-            stats_table.header(['ID', 'Status', 'Count', 'Bytes', 'TX Ports', 'RX Ports'])
-            text_tables.print_table_with_header(stats_table, "Captures")
-            
-
-        return RC_OK()
-
-        
 
     @__console
     def resolve_line (self, line):
@@ -4089,3 +4058,4 @@ class STLClient(object):
             
         self.set_service_mode(ports = opts.ports, enabled = opts.enabled)
         
+
diff --git a/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/parsing_opts.py b/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/parsing_opts.py
index cb594ef4..8d3aedbe 100755
--- a/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/parsing_opts.py
+++ b/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/parsing_opts.py
@@ -85,6 +85,10 @@ STREAMS_MASK
 CORE_MASK_GROUP
 CAPTURE_PORTS_GROUP
 
+MONITOR_TYPE_VERBOSE
+MONITOR_TYPE_PIPE
+MONITOR_TYPE
+
 # ALL_STREAMS
 # STREAM_LIST_WITH_ALL
 
@@ -606,6 +610,7 @@ OPTIONS_DB = {MULTIPLIER: ArgumentPack(['-m', '--multiplier'],
                                           'help': 'A list of ports to capture on the TX side',
                                           'default': []}),
                
+              
               RX_PORT_LIST: ArgumentPack(['--rx'],
                                          {'nargs': '+',
                                           'dest':'rx_port_list',
@@ -614,7 +619,21 @@ OPTIONS_DB = {MULTIPLIER: ArgumentPack(['-m', '--multiplier'],
                                           'type': int,
                                           'help': 'A list of ports to capture on the RX side',
                                           'default': []}),
-                
+              
+              
+              MONITOR_TYPE_VERBOSE: ArgumentPack(['-v', '--verbose'],
+                                                 {'action': 'store_true',
+                                                  'dest': 'verbose',
+                                                  'default': False,
+                                                  'help': 'output to screen as verbose'}),
+              
+              MONITOR_TYPE_PIPE: ArgumentPack(['-p', '--pipe'],
+                                              {'action': 'store_true',
+                                               'dest': 'pipe',
+                                               'default': False,
+                                               'help': 'forward packets to a pipe'}),
+
+
               CAPTURE_ID: ArgumentPack(['-i', '--id'],
                                   {'help': "capture ID to remove",
                                    'dest': "capture_id",
@@ -646,6 +665,12 @@ OPTIONS_DB = {MULTIPLIER: ArgumentPack(['-m', '--multiplier'],
                                               {'required': False}),
 
               CAPTURE_PORTS_GROUP: ArgumentGroup(NON_MUTEX, [TX_PORT_LIST, RX_PORT_LIST], {}),
+              
+              
+              MONITOR_TYPE: ArgumentGroup(MUTEX, [MONITOR_TYPE_VERBOSE,
+                                                  MONITOR_TYPE_PIPE],
+                                          {'required': False}),
+              
               }
 
 class _MergeAction(argparse._AppendAction):
@@ -760,7 +785,7 @@ class CCmdArgParser(argparse.ArgumentParser):
 
     def formatted_error (self, msg):
         self.print_usage()
-        self.stateless_client.logger.log(msg)
+        self._print_message(('%s: error: %s\n') % (self.prog, msg))
 
 
 def get_flags (opt):
diff --git a/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/text_opts.py b/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/text_opts.py
index 63b05bf4..3ffd07e2 100644
--- a/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/text_opts.py
+++ b/scripts/automation/trex_control_plane/stl/trex_stl_lib/utils/text_opts.py
@@ -133,12 +133,16 @@ def underline(text):
 
 # apply attribute on each non-empty line
 def text_attribute(text, attribute):
-    return '\n'.join(['{start}{txt}{end}'.format(
-            start = TEXT_CODES[attribute]['start'],
-            txt = line,
-            end = TEXT_CODES[attribute]['end'])
-                    if line else '' for line in ('%s' % text).split('\n')])
-
+    if isinstance(text, str):
+        return "{start}{txt}{stop}".format(start=TEXT_CODES[attribute]['start'],
+                                           txt=text,
+                                           stop=TEXT_CODES[attribute]['end'])
+    elif isinstance(text, unicode):
+        return u"{start}{txt}{stop}".format(start=TEXT_CODES[attribute]['start'],
+                                            txt=text,
+                                            stop=TEXT_CODES[attribute]['end'])
+    else:
+        raise Exception("not a string")
 
 FUNC_DICT = {'blue': blue,
              'bold': bold,