Merge pull request #44 from eficode/pydantic

Introduce pydantic to validate Oxygen handler result values. Fixes #43
eficode · Oct 27, 2023 · ffed224 · ffed224
2 parents dbd28be + abffa99
commit ffed224
Show file tree

Hide file tree

Showing 25 changed files with 1,019 additions and 974 deletions.
diff --git a/README.md b/README.md
@@ -93,6 +93,8 @@ Then `results_robot_output.xml` will be created under `path/to/`.
 
 ### [Read the developer guide on how to write your own handler](DEVGUIDE.md)
 
+You might also want to look at [specification for handler results](handler_result_specification.md)
+
 ### Configuring your handler to Oxygen
 
 Oxygen knows about different handlers based on the [`config.yml`](https://github.com/eficode/robotframework-oxygen/blob/master/config.yml) file. This configuration file can be interacted with through Oxygen's command line.

diff --git a/handler_result_specification.md b/handler_result_specification.md
@@ -0,0 +1,132 @@
+# Oxygen handler result specification
+```
+{
+  "$defs": {
+    "OxygenKeywordDict": {
+      "properties": {
+        "pass": {
+          "title": "Pass",
+          "type": "boolean"
+        },
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "elapsed": {
+          "title": "Elapsed",
+          "type": "number"
+        },
+        "tags": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Tags",
+          "type": "array"
+        },
+        "messages": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Messages",
+          "type": "array"
+        },
+        "teardown": {
+          "$ref": "#/$defs/OxygenKeywordDict"
+        },
+        "keywords": {
+          "items": {
+            "$ref": "#/$defs/OxygenKeywordDict"
+          },
+          "title": "Keywords",
+          "type": "array"
+        }
+      },
+      "required": [
+        "pass",
+        "name"
+      ],
+      "title": "OxygenKeywordDict",
+      "type": "object"
+    },
+    "OxygenSuiteDict": {
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "tags": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Tags",
+          "type": "array"
+        },
+        "setup": {
+          "$ref": "#/$defs/OxygenKeywordDict"
+        },
+        "teardown": {
+          "$ref": "#/$defs/OxygenKeywordDict"
+        },
+        "suites": {
+          "items": {
+            "$ref": "#/$defs/OxygenSuiteDict"
+          },
+          "title": "Suites",
+          "type": "array"
+        },
+        "tests": {
+          "items": {
+            "$ref": "#/$defs/OxygenTestCaseDict"
+          },
+          "title": "Tests",
+          "type": "array"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "title": "OxygenSuiteDict",
+      "type": "object"
+    },
+    "OxygenTestCaseDict": {
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "keywords": {
+          "items": {
+            "$ref": "#/$defs/OxygenKeywordDict"
+          },
+          "title": "Keywords",
+          "type": "array"
+        },
+        "tags": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Tags",
+          "type": "array"
+        },
+        "setup": {
+          "$ref": "#/$defs/OxygenKeywordDict"
+        },
+        "teardown": {
+          "$ref": "#/$defs/OxygenKeywordDict"
+        }
+      },
+      "required": [
+        "name",
+        "keywords"
+      ],
+      "title": "OxygenTestCaseDict",
+      "type": "object"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/$defs/OxygenSuiteDict"
+    }
+  ]
+}
+```
diff --git a/parser_specification.md b/parser_specification.md
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,7 @@
 robotframework>=3.0.4
 junitparser==2.0
 PyYAML>=3.13
+pydantic>=2.4.2
 
 ### Dev
 mock>=2.0.0

diff --git a/setup.py b/setup.py
@@ -34,7 +34,8 @@
       install_requires=[
            'robotframework>=3.0.4',
            'junitparser==2.0',
-           'PyYAML>=3.13'
+           'PyYAML>=3.13',
+           'pydantic>=2.4.2'
       ],
       packages=find_packages(SRC),
       package_dir={'': 'src'},

diff --git a/src/oxygen/base_handler.py b/src/oxygen/base_handler.py
@@ -2,10 +2,10 @@
 
 from inspect import signature, Parameter
 
-from oxygen.errors import MismatchArgumentException
+from .errors import MismatchArgumentException
 from .robot_interface import (RobotInterface, get_keywords_from,
                               set_special_keyword)
-
+from .utils import validate_with_deprecation_warning
 
 class BaseHandler(object):
     DEFAULT_CLI = {tuple(['result_file']): {}}
@@ -132,6 +132,8 @@ def _build_results(self, keyword, setup_keyword, teardown_keyword):
                 f'parse_results expects at least {accepted_params_min} '
                 'arguments but got 1')
 
+        self._validate(test_results)
+
         _, result_suite = self._interface.result.build_suite(
             100000, test_results)
 
@@ -149,6 +151,9 @@ def _build_results(self, keyword, setup_keyword, teardown_keyword):
 
         self._inject_suite_report(test, result_suite)
 
+    def _validate(self, oxygen_result_dict):
+        validate_with_deprecation_warning(oxygen_result_dict, self)
+
     def _inject_suite_report(self, test, result_suite):
         '''Add the given suite to the parent suite of the test case.
 

diff --git a/src/oxygen/errors.py b/src/oxygen/errors.py
@@ -32,3 +32,7 @@ class MismatchArgumentException(Exception):
 
 class InvalidConfigurationException(Exception):
     pass
+
+
+class InvalidOxygenResultException(Exception):
+    pass
diff --git a/src/oxygen/gatling.py b/src/oxygen/gatling.py
@@ -65,10 +65,7 @@ def _transform_tests(self, result_file):
             keyword = {
                     'name': ' | '.join(columns),
                     'pass': True,
-                    'tags': [],
                     'messages': [],
-                    'teardown': [],
-                    'keywords': [],
                 }
 
             if status == 'KO':
@@ -77,9 +74,6 @@ def _transform_tests(self, result_file):
 
             test_case = {
                 'name': step_name,
-                'tags': [],
-                'setup': [],
-                'teardown': [],
                 'keywords': [keyword]
             }
 
@@ -88,9 +82,6 @@ def _transform_tests(self, result_file):
         test_suite = {
             'name': 'Gatling Scenario',
             'tags': self._tags,
-            'setup': [],
-            'teardown': [],
-            'suites': [],
             'tests': test_cases,
         }
 

diff --git a/src/oxygen/junit.py b/src/oxygen/junit.py
@@ -38,10 +38,7 @@ def _transform_tests(self, node):
         suite_dict = {
             'name': 'JUnit Execution',
             'tags': self._tags,
-            'setup': [],
-            'teardown': [],
             'suites': [],
-            'tests': [],
         }
 
         if isinstance(node, JUnitXmlTestSuite):
@@ -63,8 +60,6 @@ def _transform_test_suite(self, test_suite):
         suite_dict = {
             'name': test_suite.name,
             'tags': [],
-            'setup': [],
-            'teardown': [],
             'suites': [],
             'tests': [],
         }
@@ -91,9 +86,7 @@ def _transform_test_case(self, test_case):
         test_dict = {
             'name': '{} (Execution)'.format(test_case.name),
             'pass': True,
-            'tags': [],
             'messages': [],
-            'teardown': [],
             'keywords': [],
         }
 
@@ -126,8 +119,6 @@ def _transform_test_case(self, test_case):
         test_case_dict = {
             'name': test_case.name,
             'tags': [],
-            'setup': [],
-            'teardown': [],
             'keywords': [
                 test_dict,
             ],

diff --git a/src/oxygen/oxygen.py b/src/oxygen/oxygen.py
@@ -18,6 +18,7 @@
                      InvalidConfigurationException,
                      ResultFileNotFoundException)
 from .robot_interface import RobotInterface
+from .utils import validate_with_deprecation_warning
 from .version import VERSION
 
 
@@ -301,6 +302,7 @@ def convert_to_robot_result(self, args):
         output_filename = self.get_output_filename(args.get('result_file'))
         parsed_results = args['func'](
             **{k: v for (k, v) in args.items() if not callable(v)})
+        validate_with_deprecation_warning(parsed_results, args['func'])
         robot_suite = RobotInterface().running.build_suite(parsed_results)
         robot_suite.run(output=output_filename,
                         log=None,