wip: system testing service

Author: KennedyRichard

nodezator/our3rdlibs/svgutils.py

@@ -83,7 +83,7 @@ def get_pie_chart_svg_text(
         place_items_clockwise=True,
     ):
 
-    total_radius = fill_radius + inner_outline_width
+    total_radius = fill_radius + outer_outline_width
     width = height = total_radius * 2
     cx, cy = width // 2, height // 2
 

nodezator/systemtesting/reportviewer.py

@@ -33,6 +33,8 @@
 
 from ..config import APP_REFS
 
+from ..dialog import create_and_show_dialog
+
 from ..pygamesetup import SERVICES_NS, SCREEN_RECT
 
 from ..ourstdlibs.behaviour import empty_function
@@ -78,12 +80,6 @@
 REPORT_BG = (235, 235, 250)
 REPORT_FG = (28, 28, 28)
 
-RESULT_TO_COLOR = {
-    'passed': (30, 160, 70),
-    'error': (255, 30, 70),
-    'failed': (255, 255, 70),
-}
-
 TEXT_SETTINGS = {
     "font_height": ENC_SANS_BOLD_FONT_HEIGHT,
     "font_path": ENC_SANS_BOLD_FONT_PATH,
@@ -101,11 +97,13 @@
 }
 
 PIE_COLOR_MAP = {
-    'passed': 'green',
-    'failed': 'yellow',
-    'error': 'red',
+    'passed': (30, 160, 70),
+    'error': (255, 30, 70),
+    'failed': (255, 140, 0),
 }
 
+RESULT_TO_COLOR = PIE_COLOR_MAP
+
 RESULTS = []
 RESULTS_COUNTER = Counter()
 
@@ -205,9 +203,14 @@ def __init__(self):
         ### build widgets
         self.create_general_widgets()
 
-        ### create placeholder attribute to hold next loop holder
+        ### create placeholder attributes
+
+        ## to hold next loop holder
         self.loop_holder = None
 
+        ## to hold report data
+        self.report_data = None
+
         ### center form and also append centering method
         ### as a window resize setup
 
@@ -231,7 +234,7 @@ def create_general_widgets(self):
         """Build general widgets to use/reuse in reports."""
         ### define an initial topleft relative to the
         ### topleft corner of the form 'rect'
-        topleft = self.rect.move(10, 10).topleft
+        topleft = self.rect.move(20, 20).topleft
 
         ### instantiate a caption for the form
 
@@ -270,21 +273,24 @@ def create_general_widgets(self):
 
         midright = self.exit_button.rect.move(-10, 0).midleft
 
-        self.save_button = Button.from_text(
-            text="Save as html",
-            command=self.save_report,
+        self.export_button = Button.from_text(
+            text="Export as HTML",
+            command=self.export_report,
             coordinates_name='midright',
             coordinates_value=midright,
             **BUTTON_SETTINGS,
         )
 
-        draw_depth_finish(self.save_button.image)
+        draw_depth_finish(self.export_button.image)
 
         ## store them
-        self.widgets.extend((self.save_button, self.exit_button))
+        self.widgets.extend((self.export_button, self.exit_button))
 
     def prepare_report(self, report_data):
         """Create visuals showing report results."""
+        ### store report data
+        self.report_data = report_data
+
         ### reference widgets locally
         widgets = self.widgets
 
@@ -293,35 +299,11 @@ def prepare_report(self, report_data):
 
         ### reposition and store caption
 
-        self.caption_label.rect.topleft = self.rect.move(10, 10).topleft
+        self.caption_label.rect.topleft = self.rect.move(20, 20).topleft
         widgets.append(self.caption_label)
 
         ### create report-related visuals
 
-        ## result label
-
-        topleft = self.caption_label.rect.move(0, 10).bottomleft
-
-        overall_result = report_data['overall_result']
-        fg_color = RESULT_TO_COLOR[overall_result]
-
-        result_label = Object2D.from_surface(
-            surface=(
-                render_text(
-                    text=f'Overall result: {overall_result}',
-                    **{
-                        **TEXT_SETTINGS,
-                        'font_height': 40,
-                        'foreground_color': fg_color,
-                    },
-                )
-            ),
-            coordinates_name="topleft",
-            coordinates_value=topleft,
-        )
-
-        widgets.append(result_label)
-
         ## create pie chart
 
         # update results
@@ -359,7 +341,7 @@ def prepare_report(self, report_data):
                 (pie_surf, PIE_LEGEND),
                 retrieve_pos_from='midright',
                 assign_pos_to='midleft',
-                offset_pos_by=(10, 0),
+                offset_pos_by=(20, 0),
                 background_color=REPORT_BG,
             )
         )
@@ -377,20 +359,150 @@ def prepare_report(self, report_data):
         # append to widgets
         widgets.append(pie)
 
-        ## legend
+        overall_objects = self.get_overall_objects()
+
+        overall_objects.rect.topleft = pie.rect.move(0, 10).bottomleft
+
+        widgets.extend(overall_objects)
 
         ### position and store buttons
 
         self.exit_button.rect.bottomright = (
             self.rect.right - 10,
-            widgets.rect.bottom + 20,
+            widgets.rect.bottom + 10,
         )
 
-        self.save_button.rect.midright = (
+        self.export_button.rect.midright = (
             self.exit_button.rect.move(-10, 0).midleft
         )
 
-        widgets.extend((self.save_button, self.exit_button))
+        widgets.extend((self.export_button, self.exit_button))
+
+    def get_overall_objects(self):
+
+        ###
+        rd = self.report_data
+
+        ###
+        overall_objs = List2D()
+
+        ##
+
+        result_label = Object2D.from_surface(
+            surface=(
+                render_text(
+                    text='Overall result:',
+                    **TEXT_SETTINGS,
+                )
+            ),
+            coordinates_name='midright',
+            coordinates_value=(0, 0),
+        )
+
+        ##
+        overall_result = rd['overall_result']
+
+        extra_settings = {
+            'foreground_color': RESULT_TO_COLOR[overall_result],
+            'font_height': 40,
+        }
+
+        result_text = Object2D.from_surface(
+            surface=(
+                render_text(
+                    text=overall_result,
+                    **{
+                        **TEXT_SETTINGS,
+                        **extra_settings,
+                    },
+                )
+            ),
+            coordinates_name='midleft',
+            coordinates_value=(10, 0),
+        )
+
+        overall_objs.extend((result_label, result_text))
+
+        ###
+
+        top = overall_objs.rect.bottom + 10
+
+        for key, title, source in (
+            ('session_start_time', "Start time", rd,),
+            ('session_end_time', "End time", rd,),
+            ('utc_offset', "Timezone", rd,),
+            ('passed', "Passed", RESULTS_COUNTER),
+            ('failed', "Failed", RESULTS_COUNTER),
+            ('error', "Error", RESULTS_COUNTER),
+        ):
+
+            ## keys to skip
+
+            if key in ('cases_requested', 'overall_result', 'test_cases_stats'):
+                continue
+
+            ##
+
+            overall_objs.append(
+                Object2D.from_surface(
+                    surface=(
+                        render_text(
+                            text=f'{title}:',
+                            **TEXT_SETTINGS,
+                        )
+                    ),
+                    coordinates_name='topright',
+                    coordinates_value=(0, top),
+                )
+            )
+
+            text = (
+                str(source[key]) + '/' + str(source.total())
+                if isinstance(source, Counter)
+                else source[key]
+            )
+
+            overall_objs.append(
+                Object2D.from_surface(
+                    surface=(
+                        render_text(
+                            text=text,
+                            **TEXT_SETTINGS,
+                        )
+                    ),
+                    coordinates_name='topleft',
+                    coordinates_value=(10, top),
+                )
+            )
+
+            top = overall_objs.rect.bottom
+
+        ###
+        return overall_objs
+
+    def view_last_report(self):
+        """Show report if there are report data, otherwise notify user."""
+
+        ### if there are report data, show report
+
+        if self.report_data is not None:
+
+            ### set loop holder to None
+            self.loop_holder = None
+
+            ### set itself as the current loop holder by raising
+            ### the corresponding exception
+            raise SwitchLoopException(self)
+
+        ### otherwise, notify user via dialog
+
+        else:
+
+            create_and_show_dialog(
+                "System tests were not performed yet."
+                " Go to \"Playback > Perform system testing session\""
+                " to set and start a system testing session."
+            )
 
     def handle_input(self):
         """Process events from event queue."""
@@ -512,8 +624,8 @@ def draw(self):
         ### update screen
         SERVICES_NS.update_screen()
 
-    def save_report(self):
-        ...
+    def export_report(self):
+        """Export report to HTML."""
 
     def exit(self):
         """Exit report viewer."""

nodezator/winman/menu.py

@@ -53,6 +53,10 @@
     THIRDLIB_CATEGORY_TO_SORTED_ITEMS,
 )
 
+from ..systemtesting.reportviewer import report_viewer
+
+
+
 ### class definition
 
 
@@ -143,6 +147,10 @@ def create_menubar(self):
                         ),
                     },
                     {"label": "------"},
+                    {
+                        "label": "Show system testing report",
+                        "command": report_viewer.view_last_report,
+                    },
                     {
                         "label": "Show user log",
                         "key_text": "Shift+Ctrl+J",