Feature/39 - Robot Framework 4.0 support (salabs#39)

Author: Muusssi

Diff for: .github/workflows/basic_pipeline.yaml

@@ -24,7 +24,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install pylint==2.4.4 pytest mock testarchiver
         pip install setuptools wheel
-        pip install robotframework==3.2.2
+        pip install robotframework~=4.0
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with pylint
       run: |

Diff for: robot_tests/tests/loop_suite/for_tests.robot

@@ -1,8 +1,6 @@
 *** Settings ***
 Library         String
 Force tags      loops
-Test setup      Log  foo
-Test teardown   Log  foo
 
 *** Test Cases ***
 For-Loop-In-Range

Diff for: robot_tests/tests/top_suite/conditonal.robot

@@ -0,0 +1,19 @@
+*** Settings ***
+Force tags  ifelse  rf4
+
+*** Test cases ***
+This test contains if else structures
+    Log negative or positive number  -2
+    Log negative or positive number  3
+    Log negative or positive number  0
+
+*** Keywords ***
+Log negative or positive number
+    [Arguments]     ${value}
+    IF  ${value} < 0
+        Log  The value is zero.
+    ELSE IF  ${value} > 0
+        Log  The value is zero.
+    ELSE
+        Log  The value is zero.
+    END

Diff for: robot_tests/tests/top_suite/lower_suite/embedded.robot

@@ -16,9 +16,6 @@ Template and for loops
     FOR                      ${item}                IN                     @{ITEMS}
                              ${item}                Robot
     END
-    FOR                       ${index}               IN RANGE               5
-                              Framework              @{ITEMS}[${index}]
-    END
 
 *** Keywords ***
 The result of ${calculation} should be ${expected}

Diff for: robot_tests/tests/top_suite/skipping.robot

@@ -0,0 +1,16 @@
+*** Settings ***
+Resource    common_keywords.robot
+Force tags  skipping  rf4
+
+*** Test cases ***
+This test is skipped after doing something
+    Do nothing twice
+    Skip  This is skipped
+
+This test is skipped in setup
+    [Setup]  Skip  This is skipped
+    Do nothing twice
+
+This test is skipped in teardown
+    Do nothing twice
+    [Teardown]  Skip  This is skipped

Diff for: test_archiver/ArchiverRobotListener.py

@@ -49,7 +49,13 @@ def end_test(self, name, attrs):
         self.archiver.end_test(attrs)
 
     def start_keyword(self, name, attrs):
-        self.archiver.begin_keyword(attrs['kwname'], attrs['libname'], attrs['type'], attrs['args'])
+        kw_type = attrs['type']
+        contol_structure = kw_type.lower() in ('if', 'else if', 'else', 'for', 'for iteration')
+        name = attrs['type'] if contol_structure else attrs['kwname']
+        library = attrs['libname']
+        arguments = [attrs['kwname']] if contol_structure else attrs['args']
+        arguments = [] if len(arguments) == 1 and arguments[0] == '' else arguments
+        self.archiver.begin_keyword(name, library, kw_type, arguments)
 
     def end_keyword(self, name, attrs):
         self.archiver.end_keyword(attrs)

Diff for: test_archiver/configs.py

@@ -30,6 +30,7 @@ def parse_key_value_pairs(values):
 LOG_LEVEL_MAP["DEBUG"] = 10
 LOG_LEVEL_MAP["INFO"] = 20
 LOG_LEVEL_MAP["WARN"] = 30
+LOG_LEVEL_MAP["SKIP"] = 30
 LOG_LEVEL_MAP["ERROR"] = 40
 LOG_LEVEL_MAP["FAIL"] = 50
 

Diff for: test_archiver/output_parser.py

@@ -1,17 +1,18 @@
 # pylint: disable=R0912,R0915
 
+import datetime
 import os.path
 import sys
 import xml.sax
-import datetime
+
 from . import archiver, configs
 
 DEFAULT_SUITE_NAME = 'Unnamed suite'
 
 
 class XmlOutputParser(xml.sax.handler.ContentHandler):
     def __init__(self, archiver_instance):
-        super(XmlOutputParser, self).__init__()
+        super().__init__()
         self.archiver = archiver_instance
         self._current_content = []
         self.excluding = False
@@ -39,7 +40,7 @@ class RobotFrameworkOutputParser(XmlOutputParser):
     EXCLUDED_SECTIONS = ('statistics', 'errors')
 
     def __init__(self, archiver_instance):
-        super(RobotFrameworkOutputParser, self).__init__(archiver_instance)
+        super().__init__(archiver_instance)
         self.archiver.test_type = "Robot Framework"
 
     def startElement(self, name, attrs):
@@ -53,19 +54,32 @@ def startElement(self, name, attrs):
                                          attrs.get('generator'),
                                          attrs.get('rpa') if 'rpa' in attrs.getNames() else False,
                                          None,
-                                         )
+                                        )
         elif name == 'suite':
             execution_path = attrs.getValue('id') if 'id' in attrs.getNames() else None
             self.archiver.begin_suite(attrs.getValue('name'), execution_path=execution_path)
         elif name == 'test':
             execution_path = attrs.getValue('id') if 'id' in attrs.getNames() else None
             self.archiver.begin_test(attrs.getValue('name'), execution_path=execution_path)
         elif name == 'kw':
-            name = attrs.getValue('name') if 'name' in attrs.getNames() else '${EMPTY}'
+            name = attrs.getValue('name') if 'name' in attrs.getNames() else ''
             kw_type = attrs.getValue('type') if 'type' in attrs.getNames() else 'Keyword'
             library = attrs.getValue('library') if 'library' in attrs.getNames() else ''
             self.archiver.begin_keyword(name, library, kw_type)
-            # self.archiver.set_execution_path(attrs.getValue('id'))
+        elif name == 'for':
+            self.archiver.begin_keyword('FOR', '', 'FOR')
+            self.archiver.update_arguments(attrs.getValue('flavor'))
+        elif name == 'iter':
+            self.archiver.begin_keyword('FOR ITERATION', '', 'FOR ITERATION')
+        elif name == 'branch':
+            self.archiver.begin_keyword(attrs.getValue('type'), '', attrs.getValue('type'))
+            if 'condition' in attrs.getNames():
+                self.archiver.update_arguments(attrs.getValue('condition'))
+        elif name == 'var':
+            if 'name' in attrs.getNames():
+                self.archiver.update_arguments(attrs.getValue('name'))
+        elif name == 'value':
+            pass
         elif name == 'arg':
             pass
         elif name == 'msg':
@@ -78,19 +92,17 @@ def startElement(self, name, attrs):
                                        attrs.getValue('endtime'), critical=critical)
         elif name == 'assign':
             pass
-        elif name == 'var':
-            pass
         elif name == 'timeout':
             pass
         elif name == 'tag':
             pass
-        elif name == 'item':  # metadata item
+        elif name == 'item':  # metadata item # <RF4.0
             self.archiver.begin_metadata(attrs.getValue('name'))
         elif name == 'meta':  # metadata item # RF4.0
             self.archiver.begin_metadata(attrs.getValue('name'))
         elif name == 'doc':
             pass
-        elif name in ('arguments', 'tags', 'metadata', 'for', 'iter', 'value'):
+        elif name in ('arguments', 'tags', 'metadata', 'if'):
             pass
         else:
             print("WARNING: begin unknown item '{}'".format(name))
@@ -108,6 +120,12 @@ def endElement(self, name):
             self.archiver.end_test()
         elif name == 'kw':
             self.archiver.end_keyword()
+        elif name == 'for':
+            self.archiver.end_keyword()
+        elif name == 'iter':
+            self.archiver.end_keyword()
+        elif name == 'branch':
+            self.archiver.end_keyword()
         elif name == 'arg':
             self.archiver.update_arguments(self.content())
         elif name == 'msg':
@@ -118,7 +136,9 @@ def endElement(self, name):
         elif name == 'assign':
             pass
         elif name == 'var':
-            pass
+            self.archiver.update_arguments(self.content())
+        elif name == 'value':
+            self.archiver.update_arguments(self.content())
         elif name == 'timeout':
             pass
         elif name == 'tag':
@@ -130,7 +150,7 @@ def endElement(self, name):
             self.archiver.end_metadata(self.content())
         elif name == 'doc':
             pass
-        elif name in ('arguments', 'tags', 'metadata', 'for', 'iter', 'value'):
+        elif name in ('arguments', 'tags', 'metadata', 'if'):
             pass
         else:
             print("WARNING: ending unknown item '{}'".format(name))
@@ -785,7 +805,7 @@ def argument_parser():
     "context": "The execution context, same as --execution-context and command line will override this setting.",
     "changes": [
         {
-            "name": "string representing the changed item, for example file path", 
+            "name": "string representing the changed item, for example file path",
             "repository": "Repository (optional), for separating between changed items with identical names.",
             "item_type": "Separating items (optional) and for filtering subsets when prioritising",
             "subtype": "(optional, for separating items for filtering subsets when prioritising"