packages/Python/lldbsuite/test/curses_results.py

   1 #!/usr/bin/env python
   2
   3 """
   4                      The LLVM Compiler Infrastructure
   5
   6  This file is distributed under the University of Illinois Open Source
   7  License. See LICENSE.TXT for details.
   8
   9 Configuration options for lldbtest.py set by dotest.py during initialization
  10 """
  11
  12 from __future__ import print_function
  13 from __future__ import absolute_import
  14
  15 # System modules
  16 import curses
  17 import datetime
  18 import math
  19 import sys
  20 import time
  21
  22 # Third-party modules
  23
  24 # LLDB modules
  25 from . import lldbcurses
  26 from . import result_formatter
  27 from .result_formatter import EventBuilder
  28
  29
  30 class Curses(result_formatter.ResultsFormatter):
  31     """Receives live results from tests that are running and reports them to the terminal in a curses GUI"""
  32
  33     def __init__(self, out_file, options):
  34         # Initialize the parent
  35         super(Curses, self).__init__(out_file, options)
  36         self.using_terminal = True
  37         self.have_curses = True
  38         self.initialize_event = None
  39         self.jobs = [None] * 64
  40         self.job_tests = [None] * 64
  41         self.results = list()
  42         try:
  43             self.main_window = lldbcurses.intialize_curses()
  44             self.main_window.add_key_action('\t', self.main_window.select_next_first_responder, "Switch between views that can respond to keyboard input")
  45             self.main_window.refresh()
  46             self.job_panel = None
  47             self.results_panel = None
  48             self.status_panel = None
  49             self.info_panel = None
  50             self.hide_status_list = list()
  51             self.start_time = time.time()
  52         except:
  53             self.have_curses = False
  54             lldbcurses.terminate_curses()
  55             self.using_terminal = False
  56             print("Unexpected error:", sys.exc_info()[0])
  57             raise
  58
  59         self.line_dict = dict()
  60         # self.events_file = open("/tmp/events.txt", "w")
  61         # self.formatters = list()
  62         # if tee_results_formatter:
  63         #     self.formatters.append(tee_results_formatter)
  64
  65     def status_to_short_str(self, status):
  66         if status == EventBuilder.STATUS_SUCCESS:
  67             return '.'
  68         elif status == EventBuilder.STATUS_FAILURE:
  69             return 'F'
  70         elif status == EventBuilder.STATUS_UNEXPECTED_SUCCESS:
  71             return '?'
  72         elif status == EventBuilder.STATUS_EXPECTED_FAILURE:
  73             return 'X'
  74         elif status == EventBuilder.STATUS_SKIP:
  75             return 'S'
  76         elif status == EventBuilder.STATUS_ERROR:
  77             return 'E'
  78         else:
  79             return status
  80
  81     def show_info_panel(self):
  82         selected_idx = self.results_panel.get_selected_idx()
  83         if selected_idx >= 0 and selected_idx < len(self.results):
  84             if self.info_panel is None:
  85                 info_frame = self.results_panel.get_contained_rect(top_inset=10, left_inset=10, right_inset=10, height=30)
  86                 self.info_panel = lldbcurses.BoxedPanel(info_frame, "Result Details")
  87                 # Add a key action for any key that will hide this panel when any key is pressed
  88                 self.info_panel.add_key_action(-1, self.hide_info_panel, 'Hide the info panel')
  89                 self.info_panel.top()
  90             else:
  91                 self.info_panel.show()
  92
  93             self.main_window.push_first_responder(self.info_panel)
  94             test_start = self.results[selected_idx][0]
  95             test_result = self.results[selected_idx][1]
  96             self.info_panel.set_line(0, "File: %s" % (test_start['test_filename']))
  97             self.info_panel.set_line(1, "Test: %s.%s" % (test_start['test_class'], test_start['test_name']))
  98             self.info_panel.set_line(2, "Time: %s" % (test_result['elapsed_time']))
  99             self.info_panel.set_line(3, "Status: %s" % (test_result['status']))
 100
 101     def hide_info_panel(self):
 102         self.main_window.pop_first_responder(self.info_panel)
 103         self.info_panel.hide()
 104         self.main_window.refresh()
 105
 106     def toggle_status(self, status):
 107         if status:
 108             # Toggle showing and hiding results whose status matches "status" in "Results" window
 109             if status in self.hide_status_list:
 110                 self.hide_status_list.remove(status)
 111             else:
 112                 self.hide_status_list.append(status)
 113             self.update_results()
 114
 115     def update_results(self, update=True):
 116         '''Called after a category of test have been show/hidden to update the results list with
 117            what the user desires to see.'''
 118         self.results_panel.clear(update=False)
 119         for result in self.results:
 120             test_result = result[1]
 121             status = test_result['status']
 122             if status in self.hide_status_list:
 123                 continue
 124             name = test_result['test_class'] + '.' + test_result['test_name']
 125             self.results_panel.append_line('%s (%6.2f sec) %s' % (self.status_to_short_str(status), test_result['elapsed_time'], name))
 126         if update:
 127             self.main_window.refresh()
 128
 129     def handle_event(self, test_event):
 130         with self.lock:
 131             super(Curses, self).handle_event(test_event)
 132             # for formatter in self.formatters:
 133             #     formatter.process_event(test_event)
 134             if self.have_curses:
 135                 worker_index = -1
 136                 if 'worker_index' in test_event:
 137                     worker_index = test_event['worker_index']
 138                 if 'event' in test_event:
 139                     check_for_one_key = True
 140                     #print(str(test_event), file=self.events_file)
 141                     event = test_event['event']
 142                     if self.status_panel:
 143                         self.status_panel.update_status('time', str(datetime.timedelta(seconds=math.floor(time.time() - self.start_time))))
 144                     if event == 'test_start':
 145                         name = test_event['test_class'] + '.' + test_event['test_name']
 146                         self.job_tests[worker_index] = test_event
 147                         if 'pid' in test_event:
 148                             line = 'pid: %5d ' % (test_event['pid']) + name
 149                         else:
 150                             line = name
 151                         self.job_panel.set_line(worker_index, line)
 152                         self.main_window.refresh()
 153                     elif event == 'test_result':
 154                         status = test_event['status']
 155                         self.status_panel.increment_status(status)
 156                         if 'pid' in test_event:
 157                             line = 'pid: %5d ' % (test_event['pid'])
 158                         else:
 159                             line = ''
 160                         self.job_panel.set_line(worker_index, line)
 161                         name = test_event['test_class'] + '.' + test_event['test_name']
 162                         elapsed_time = test_event['event_time'] - self.job_tests[worker_index]['event_time']
 163                         if not status in self.hide_status_list:
 164                             self.results_panel.append_line('%s (%6.2f sec) %s' % (self.status_to_short_str(status), elapsed_time, name))
 165                         self.main_window.refresh()
 166                         # Append the result pairs
 167                         test_event['elapsed_time'] = elapsed_time
 168                         self.results.append([self.job_tests[worker_index], test_event])
 169                         self.job_tests[worker_index] = ''
 170                     elif event == 'job_begin':
 171                         self.jobs[worker_index] = test_event
 172                         if 'pid' in test_event:
 173                             line = 'pid: %5d ' % (test_event['pid'])
 174                         else:
 175                             line = ''
 176                         self.job_panel.set_line(worker_index, line)
 177                     elif event == 'job_end':
 178                         self.jobs[worker_index] = ''
 179                         self.job_panel.set_line(worker_index, '')
 180                     elif event == 'initialize':
 181                         self.initialize_event = test_event
 182                         num_jobs = test_event['worker_count']
 183                         job_frame = self.main_window.get_contained_rect(height=num_jobs+2)
 184                         results_frame = self.main_window.get_contained_rect(top_inset=num_jobs+2, bottom_inset=1)
 185                         status_frame = self.main_window.get_contained_rect(height=1, top_inset=self.main_window.get_size().h-1)
 186                         self.job_panel = lldbcurses.BoxedPanel(frame=job_frame, title="Jobs")
 187                         self.results_panel = lldbcurses.BoxedPanel(frame=results_frame, title="Results")
 188
 189                         self.results_panel.add_key_action(curses.KEY_UP,    self.results_panel.select_prev      , "Select the previous list entry")
 190                         self.results_panel.add_key_action(curses.KEY_DOWN,  self.results_panel.select_next      , "Select the next list entry")
 191                         self.results_panel.add_key_action(curses.KEY_HOME,  self.results_panel.scroll_begin     , "Scroll to the start of the list")
 192                         self.results_panel.add_key_action(curses.KEY_END,   self.results_panel.scroll_end       , "Scroll to the end of the list")
 193                         self.results_panel.add_key_action(curses.KEY_ENTER, self.show_info_panel                , "Display info for the selected result item")
 194                         self.results_panel.add_key_action('.', lambda : self.toggle_status(EventBuilder.STATUS_SUCCESS)           , "Toggle showing/hiding tests whose status is 'success'")
 195                         self.results_panel.add_key_action('e', lambda : self.toggle_status(EventBuilder.STATUS_ERROR)             , "Toggle showing/hiding tests whose status is 'error'")
 196                         self.results_panel.add_key_action('f', lambda : self.toggle_status(EventBuilder.STATUS_FAILURE)           , "Toggle showing/hiding tests whose status is 'failure'")
 197                         self.results_panel.add_key_action('s', lambda : self.toggle_status(EventBuilder.STATUS_SKIP)              , "Toggle showing/hiding tests whose status is 'skip'")
 198                         self.results_panel.add_key_action('x', lambda : self.toggle_status(EventBuilder.STATUS_EXPECTED_FAILURE)  , "Toggle showing/hiding tests whose status is 'expected_failure'")
 199                         self.results_panel.add_key_action('?', lambda : self.toggle_status(EventBuilder.STATUS_UNEXPECTED_SUCCESS), "Toggle showing/hiding tests whose status is 'unexpected_success'")
 200                         self.status_panel = lldbcurses.StatusPanel(frame=status_frame)
 201
 202                         self.main_window.add_child(self.job_panel)
 203                         self.main_window.add_child(self.results_panel)
 204                         self.main_window.add_child(self.status_panel)
 205                         self.main_window.set_first_responder(self.results_panel)
 206
 207                         self.status_panel.add_status_item(name="time", title="Elapsed", format="%s", width=20, value="0:00:00", update=False)
 208                         self.status_panel.add_status_item(name=EventBuilder.STATUS_SUCCESS, title="Success", format="%u", width=20, value=0, update=False)
 209                         self.status_panel.add_status_item(name=EventBuilder.STATUS_FAILURE, title="Failure", format="%u", width=20, value=0, update=False)
 210                         self.status_panel.add_status_item(name=EventBuilder.STATUS_ERROR, title="Error", format="%u", width=20, value=0, update=False)
 211                         self.status_panel.add_status_item(name=EventBuilder.STATUS_SKIP, title="Skipped", format="%u", width=20, value=0, update=True)
 212                         self.status_panel.add_status_item(name=EventBuilder.STATUS_EXPECTED_FAILURE, title="Expected Failure", format="%u", width=30, value=0, update=False)
 213                         self.status_panel.add_status_item(name=EventBuilder.STATUS_UNEXPECTED_SUCCESS, title="Unexpected Success", format="%u", width=30, value=0, update=False)
 214                         self.main_window.refresh()
 215                     elif event == 'terminate':
 216                         #self.main_window.key_event_loop()
 217                         lldbcurses.terminate_curses()
 218                         check_for_one_key = False
 219                         self.using_terminal = False
 220                         # Check for 1 keypress with no delay
 221
 222                     # Check for 1 keypress with no delay
 223                     if check_for_one_key:
 224                         self.main_window.key_event_loop(0, 1)