Add Skip counter and corresponding colored icon to Project tree (#2480)

* Set default language to en_US

* Add skip counter and colored icon to project tree

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -10,6 +10,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 
 === Added
 
+- Added skipped tests counter and corresponding colored icon on Project tree
 - Added color processing in console log, when using ``-C`` or ``--consolecolors``
 - Added minimal support to open and edit resource files in Grid Editor
 - Added multiline comment and uncomment in Text Editor
@@ -70,6 +71,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 
 === Fixed
 
+- Fixed removal of animation in Project tree when test run is interrupted
 - Fixed console log width to fit visible area, depending on font size
 - Fixed not possible to use filenames/paths with spaces in TestRunner arguments. Use double quotes for space separated values,
 - Fixed error preventing to open old format, HTML test suites:

src/robotide/application/application.py

@@ -61,7 +61,7 @@ def __init__(self, path=None, updatecheck=True):
     def OnInit(self):
         # DEBUG To test RTL
         # self._initial_locale = wx.Locale(wx.LANGUAGE_ARABIC)
-        self._initial_locale = wx.Locale(wx.LANGUAGE_ENGLISH)
+        self._initial_locale = wx.Locale(wx.LANGUAGE_ENGLISH_US)
         # Needed for SetToolTipString to work
         wx.HelpProvider.Set(wx.SimpleHelpProvider())  # TODO adjust to wx versions 
         self.settings = RideSettings()

src/robotide/contrib/testrunner/testrunner.py

@@ -116,6 +116,9 @@ def _result_handler(self, event, *args):
             if args[1]['status'] == 'PASS':
                 self._results.set_passed(self._get_test_controller(longname,
                                                                    testname))
+            elif args[1]['status'] == 'SKIP':
+                self._results.set_skipped(self._get_test_controller(longname,
+                                                                    testname))
             else:
                 self._results.set_failed(self._get_test_controller(longname,
                                                                    testname))
@@ -181,6 +184,7 @@ def is_running(self):
         return self._process and self._process.is_alive()
 
     def command_ended(self):
+        self._results.set_stopped(None)
         self._process = None
 
 

src/robotide/contrib/testrunner/testrunnerplugin.py

@@ -1049,8 +1049,12 @@ def _handle_end_test(self, args):
             f"Ending test: {longname.decode(encoding['OUTPUT'], 'backslashreplace')}\n")
         if args[1]['status'] == 'PASS':
             self._progress_bar.add_pass()
-        else:
+        elif args[1]['status'] == 'SKIP':
+            self._progress_bar.add_skip()
+        elif args[1]['status'] == 'FAIL':
             self._progress_bar.add_fail()
+        else:
+            self._log_message_queue.put(f"UNKNOWN STATUS: {args[1]['status']}\n")
 
     def _handle_report_file(self, args):
         self._report_file = args[0]
@@ -1142,6 +1146,7 @@ def __init__(self, parent, fail_color='#FF8E8E', pass_color="#9FCC9F", skip_colo
         self.SetSizer(self._sizer)
         self._gauge.Hide()
         self._default_colour = parent.GetBackgroundColour()
+        self._foreground_colour = parent.GetForegroundColour()
         self.fail_color = fail_color
         self.pass_color = pass_color
         self.skip_color = skip_color
@@ -1175,6 +1180,7 @@ def Start(self):
         self._gauge.Show()
         self._sizer.Layout()
         self.SetBackgroundColour(self._default_colour)
+        self.SetForegroundColour(self._foreground_colour)
         self._timer.Start(50)
 
     def Stop(self):
@@ -1194,6 +1200,17 @@ def add_skip(self):
         """Add one to the skipped count"""
         self._skip += 1
 
+    def get_visible_color(self, color):
+        color_diff = wx.Colour.GetRGBA(wx.Colour(color)) - wx.Colour.GetRGBA(self._foreground_colour)
+        # print(f"DEBUG: get_visible_color color={wx.Colour.GetRGBA(wx.Colour(color)):0x} default={wx.Colour.GetRGBA(self._foreground_colour):0x}"
+        #       f" color_diff={wx.Colour.GetRGBA(wx.Colour(color_diff)):0x} white={wx.Colour.GetRGBA(wx.Colour('white')):0x}"
+        #       f" black={wx.Colour.GetRGBA(wx.Colour('black')):0x} gray={wx.Colour.GetRGBA(wx.Colour('gray')):0x}")
+        if wx.Colour.GetRGBA(wx.Colour(color)) > wx.Colour.GetRGBA(self._foreground_colour) > wx.Colour.GetRGBA(wx.Colour('gray')):
+            if color_diff > wx.Colour.GetRGBA(wx.Colour('gray')):
+                return wx.Colour(self._foreground_colour)
+        return wx.Colour('black')
+
+
     def _update_message(self):
         """Update the displayed elapsed time, passed and failed counts"""
         elapsed = time.time() - self._start_time
@@ -1202,10 +1219,13 @@ def _update_message(self):
         message += self._get_current_keyword_text()
         self._label.SetLabel(message)
         if self._fail > 0:
+            self.SetForegroundColour(self.get_visible_color(self.fail_color))
             self.SetBackgroundColour(self.fail_color)
         elif self._skip > 0:
+            self.SetForegroundColour(self.get_visible_color(self.skip_color))
             self.SetBackgroundColour(self.skip_color)
         elif self._pass > 0:
+            self.SetForegroundColour(self.get_visible_color(self.pass_color))
             self.SetBackgroundColour(self.pass_color)
         # not sure why this is required, but without it the background
         # colors don't look right on Windows

src/robotide/controller/testexecutionresults.py

@@ -13,14 +13,17 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-from ..publish.messages import RideTestExecutionStarted, RideTestPaused, RideTestPassed, RideTestFailed, RideTestRunning
+from ..publish.messages import (RideTestExecutionStarted, RideTestPaused, RideTestPassed, RideTestFailed,
+                                RideTestRunning, RideTestSkipped, RideTestStopped)
 
 
 class TestExecutionResults(object):
     RUNNING = 'Running'
+    STOPPED = 'Stopped'
     PASSED = 'Passed'
     FAILED = 'Failed'
     PAUSED = 'Paused'
+    SKIPPED = 'Skipped'
 
     def __init__(self):
         self.clear()
@@ -36,6 +39,11 @@ def set_running(self, test):
         self._results[test] = self.RUNNING
         RideTestRunning(item=test).publish()
 
+    def set_stopped(self, test):
+        if test:
+            self._results[test] = self.STOPPED
+        RideTestStopped(item=test).publish()
+
     def set_passed(self, test):
         self._results[test] = self.PASSED
         RideTestPassed(item=test).publish()
@@ -48,6 +56,10 @@ def set_paused(self, test):
         self._results[test] = self.PAUSED
         RideTestPaused(item=test).publish()
 
+    def set_skipped(self, test):
+        self._results[test] = self.SKIPPED
+        RideTestSkipped(item=test).publish()
+
     def is_running(self, test):
         return test in self._results and self._results[test] == self.RUNNING
 
@@ -60,3 +72,6 @@ def has_passed(self, test):
     def has_failed(self, test):
         return test in self._results and self._results[test] == self.FAILED
 
+    def has_skipped(self, test):
+        return test in self._results and self._results[test] == self.SKIPPED
+

src/robotide/publish/messages.py

@@ -20,6 +20,7 @@
 
 from robotide import utils
 
+
 class RideMessage:
     """Base class for all messages sent by RIDE.
 
@@ -205,12 +206,22 @@ class RideTestPaused(RideMessage):
 
 
 class RideTestPassed(RideMessage):
-    """Sent whenever RIDE has executed a test case and it passed."""
+    """Sent whenever RIDE has executed a test case, and it passed."""
     data = ['item']
 
 
 class RideTestFailed(RideMessage):
-    """Sent whenever RIDE has executed a test case and it failed."""
+    """Sent whenever RIDE has executed a test case, and it failed."""
+    data = ['item']
+
+
+class RideTestSkipped(RideMessage):
+    """Sent whenever RIDE has executed a test case, and it was skipped."""
+    data = ['item']
+
+
+class RideTestStopped(RideMessage):
+    """Sent whenever RIDE was executing a test case, and it was stopped or aborted."""
     data = ['item']
 
 

src/robotide/ui/images.py

@@ -33,6 +33,7 @@
 PASSED_IMAGE_INDEX = 8
 FAILED_IMAGE_INDEX = 9
 PAUSED_IMAGE_INDEX = 10
+SKIPPED_IMAGE_INDEX = 11
 
 
 class TreeImageList(wx.ImageList):
@@ -52,6 +53,7 @@ def __init__(self):
             'passed': _TreeImage(self, 'robot_passed.png'),
             'failed': _TreeImage(self, 'robot_failed.png'),
             'paused': _TreeImage(self, 'robot-pause.gif'),
+            'skipped': _TreeImage(self, 'robot_skipped.png'),
             filecontrollers.ExcludedDirectoryController: _TreeImage(self, 'folder_excluded.png')
         }
 # 'running': _TreeImage(self, 'robot_running.png'),
@@ -73,6 +75,8 @@ def __getitem__(self, controller):
                     return self._images['passed']
                 if self._execution_results.has_failed(controller):
                     return self._images['failed']
+                if self._execution_results.has_skipped(controller):
+                    return self._images['skipped']
         elif controller.__class__ == filecontrollers.TestDataDirectoryController:
             if not controller.contains_tests():
                 return self._images['resource directory']

src/robotide/ui/treeplugin.py

@@ -30,11 +30,11 @@
 
 from ..context import IS_WINDOWS
 # from ..controller.filecontrollers import ResourceFileController, TestDataDirectoryController, TestCaseFileController
-from ..publish.messages import (RideTestRunning, RideTestPaused, RideTestPassed, RideTestFailed,
-                                RideTestExecutionStarted, RideImportSetting, RideExcludesChanged, RideIncludesChanged,
+from ..publish.messages import (RideTestRunning, RideTestPaused, RideTestPassed, RideTestFailed, RideTestSkipped,
+                                RideTestExecutionStarted, RideTestStopped, RideImportSetting, RideExcludesChanged, RideIncludesChanged,
                                 RideOpenSuite, RideNewProject)
 from ..ui.images import (RUNNING_IMAGE_INDEX, PASSED_IMAGE_INDEX, FAILED_IMAGE_INDEX, PAUSED_IMAGE_INDEX,
-                         ROBOT_IMAGE_INDEX)
+                         SKIPPED_IMAGE_INDEX, ROBOT_IMAGE_INDEX)
 from ..ui.treenodehandlers import TestCaseHandler, TestDataDirectoryHandler, TestCaseFileHandler
 from ..publish import (PUBLISHER, RideTreeSelection, RideFileNameChanged, RideItem, RideUserKeywordAdded,
                        RideTestCaseAdded, RideUserKeywordRemoved, RideTestCaseRemoved, RideDataFileRemoved,
@@ -319,6 +319,8 @@ def _subscribe_to_messages(self):
             (self._test_result, RideTestPaused),
             (self._test_result, RideTestPassed),
             (self._test_result, RideTestFailed),
+            (self._test_result, RideTestSkipped),
+            (self._test_result, RideTestStopped),
             (self._handle_import_setting_message, RideImportSetting),
             (self._mark_excludes, RideExcludesChanged),
             (self._mark_excludes, RideIncludesChanged),
@@ -369,11 +371,19 @@ def _test_result(self, message):
         test: TestCaseController = message.item
         if not test:
             # test object will be None when running with DataDriver
+            # when runner is interrupted, is also None, so let's stop animation
+            if self._animctrl:
+                self._animctrl.Stop()
+                self._animctrl.Animation.Destroy()
+                self._animctrl.Destroy()
+                self._animctrl = None
             return
         if isinstance(message, RideTestPassed):
             test.run_passed = True
         elif isinstance(message, RideTestFailed):
             test.run_passed = False
+        elif isinstance(message, RideTestSkipped):
+            test.run_passed = False
         else:
             test.run_passed = None
         wx.CallAfter(self._set_icon_from_execution_results, message.item)
@@ -423,6 +433,8 @@ def _get_icon_index_for(self, controller):
             return PASSED_IMAGE_INDEX
         if self._execution_results.has_failed(controller):
             return FAILED_IMAGE_INDEX
+        if self._execution_results.has_skipped(controller):
+            return SKIPPED_IMAGE_INDEX
         return ROBOT_IMAGE_INDEX
 
     def populate(self, model):

src/robotide/version.py

@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0b2.dev21'
+VERSION = 'v2.0b2.dev22'