#3423 Robot Framework JSON output

atest/resources/TestCheckerLibrary.py

@@ -4,7 +4,7 @@
 from robot import utils
 from robot.api import logger
 from robot.utils.asserts import assert_equal
-from robot.result import (ExecutionResultBuilder, For, If, ForIteration, Keyword,
+from robot.result import (XmlExecutionResultBuilder, For, If, ForIteration, Keyword,
                           Result, ResultVisitor, TestCase, TestSuite)
 from robot.result.model import Body, ForIterations, IfBranches, IfBranch
 from robot.libraries.BuiltIn import BuiltIn
@@ -71,7 +71,7 @@ def process_output(self, path):
         try:
             logger.info("Processing output '%s'." % path)
             result = Result(root_suite=NoSlotsTestSuite())
-            ExecutionResultBuilder(path).build(result)
+            XmlExecutionResultBuilder(path).build(result)
         except:
             set_suite_variable('$SUITE', None)
             msg, details = utils.get_error_details()

doc/schema/robot-10.schema.json

@@ -0,0 +1,247 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"definitions": {
+		"suite": {
+			"type": "object",
+			"properties": {
+				"setup": {"$ref": "#/definitions/keyword"},
+				"teardown": {"$ref": "#/definitions/keyword"},
+				"suites": {
+					"type": "array",
+					"items": {"$ref": "#/definitions/suite"},
+					"minItems": 0
+				},
+				"tests": {
+					"type": "array",
+					"items": {"$ref": "#/definitions/test"},
+					"minItems": 0
+				},
+				"doc": {"type": "string"},
+				"metadata": {
+					"type": "object",
+					"additionalProperties": true
+				},
+				"status": {"$ref": "#/definitions/status"},
+				"name" : {
+					"type": "string"
+				},
+				"id": {
+					"type": "string"
+				},
+				"source":{
+					"type": "string"
+				}
+			},
+			"required": ["name", "status"],
+			"additionalProperties": true
+		},
+		"test": {
+			"type": "object",
+			"properties": {
+				"body": {"$ref": "#/definitions/body"},
+				"doc": {"type": "string"},
+				"tags": {
+					"type": "array",
+					"items": {"type": "string"},
+					"minItems": 0
+				},
+				"timeout": {"type": "string"},
+				"status": {"$ref": "#/definitions/status"},
+				"name" : {
+					"type": "string"
+				},
+				"id" : {
+					"type": "string"
+				}
+			},
+			"required": ["name", "status"],
+			"additionalProperties": true	
+		},
+		"type": {
+			"type": "string",
+			"enum": ["kw", "setup", "teardown", "foritem", "for", "if", "elseif", "else"]
+		},
+		"keyword": {
+			"type": "object",
+			"properties": {
+				"body": {"$ref": "#/definitions/body"},
+				"msgs": {
+					"type": "array",
+					"items": {"$ref": "#/definitions/message"},
+					"minItems": 0
+				},
+				"doc": {"type": "string"},
+				"tags": {
+					"type": "array",
+					"items": {"type": "string"},
+					"minItems": 0
+				},
+				"timeout": {"type": "string"},
+				"args": {
+					"type": "array",
+					"items":  {"type": "string"},
+					"minItems": 0
+				},
+				"lib": {"type":  "string"},
+				"var": {
+					"type": "array",
+					"items": {"type": "string"},
+					"minItems": 0
+				},
+				"status": {"$ref": "#/definitions/status"},
+				"name" : {
+					"type": "string"
+				},
+				"sourcename" : {
+					"type": "string"
+				},
+				"type" : {"$ref": "#/definitions/type"}
+			},
+			"required": ["name", "status"],
+			"additionalProperties": true
+		},
+		"status": {
+			"type": "object",
+			"properties": {
+				"status": {"$ref": "#/definitions/status_enum"},
+				"endtime": {"type": "string"},
+				"starttime": {"type": "string"},
+				"elapsedtime": {"type": "string"},
+				"critical": {"type": "boolean"},
+				"msg": {"type": "string"}
+			},
+			"required": ["status"],
+			"additionalProperties": true
+		},
+		"message": {
+			"type": "object",
+			"properties": {
+				"msg": {"type": "string"},
+				"timestamp": {"type": "string"},
+				"level": {"$ref": "#/definitions/level_enum"},
+				"html": {"type": "boolean"}
+			},
+			"required": ["msg", "timestamp", "level"],
+			"additionalProperties": true
+		},
+		"metadata": {
+			"type": "object",
+			"properties": {
+				"name": {"type": "string"},
+				"value": {"type": "string"}
+			}
+		},
+		"for": {
+			"type": "object",
+			"properties": {
+				"flavor": {"type": "string"},
+				"var": {"type": "array",
+						"items": {"type": "string"}},
+				"value": {"type": "array",
+						  "items": {"type": "string"}},
+				"status": {"$ref": "#/definitions/status"},
+				"doc": {"type": "string"},
+				"type" : {"$ref": "#/definitions/type"},
+				"iter": {"type": "array",
+				         "items": {"$ref": "#/definitions/iter"}}
+			}
+		},
+		"itervar": {
+			"type": "object",
+			"properties": {
+				"name": {"type": "string"},
+				"value": {"type": "string"}
+			}
+		},
+		"iter": {
+			"type": "object",
+			"properties": {
+				"var": {"type": "array",
+						"items": {"$ref": "#/definitions/itervar"}},
+				"status": {"$ref": "#/definitions/status"},
+				"doc": {"type": "string"},
+				"body": {"$ref": "#/definitions/body"}
+			}
+		},
+		"if": {
+			"type": "object",
+			"properties": {
+				"doc": {"type": "string"},
+				"status": {"$ref": "#/definitions/status"},
+				"type" : {"$ref": "#/definitions/type"},
+				"branches": {"type": "array",
+							 "items": {"$ref": "#/definitions/branch"}}
+			}
+		},
+		"branch": {
+			"type": "object",
+			"properties": {
+				"type": {"type": "string"},
+				"condition": {"type": "string"},
+				"doc": {"type": "string"},
+				"status": {"$ref": "#/definitions/status"},
+				"body": {"$ref": "#/definitions/body"}
+			}
+		},
+		"body": {
+			"type": "array",
+			"items": {"oneOf": [{"$ref": "#/definitions/keyword"},
+								{"$ref": "#/definitions/for"},
+								{"$ref": "#/definitions/if"},
+								{"$ref": "#/definitions/message"}]},
+			"minItems": 0
+		},
+		"statistics": {
+			"type": "object",
+			"properties": {	
+				"total": {"$ref": "#/definitions/stats"},
+				"tag": {"$ref": "#/definitions/stats"},
+				"suite": {"$ref": "#/definitions/stats"}
+			},
+			"required": ["total", "tag", "suite"]
+		},
+		"stats": {
+			"type": "array",
+			"items": {"$ref": "#/definitions/stat"},
+			"minItems": 0
+		},
+		"stat": {
+			"type": "object",
+			"properties": {
+				"tag": {"type": "string"},
+				"fail": {"type": "number"},
+				"skip": {"type": "number"},
+				"critical": {"type": "boolean"},
+				"pass": {"type": "number"},
+				"info": {"type": "string"},
+				"doc": {"type": "string"},
+				"id": {"type": "string"},
+				"name": {"type": "string"}
+			},
+			"additionalProperties": true
+		},
+		"errors": {
+			"type": "array",
+			"items": {"$ref": "#/definitions/message"}
+		},
+		"status_enum": {
+			"type": "string",
+			"enum": ["PASS", "FAIL"]
+		},
+		"level_enum": {
+			"type": "string",
+			"enum": ["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FAIL"]
+		}
+	},
+	"type": "object",
+	"properties": {
+		"generator": {"type": "string"},
+		"generated": {"type": "string"},
+		"rpa": {"type": "boolean"},
+		"suite": {"$ref": "#/definitions/suite"},
+		"statistics": {"$ref": "#/definitions/statistics"},
+		"errors": {"$ref": "#/definitions/errors"}
+	},
+	"required": ["suite"],
+	"additionalProperties": true
+}

src/robot/conf/settings.py

@@ -49,6 +49,7 @@ class _BaseSettings(object):
                  'Log'              : ('log', 'log.html'),
                  'Report'           : ('report', 'report.html'),
                  'XUnit'            : ('xunit', None),
+                 'Json'             : ('json', False),
                  'SplitLog'         : ('splitlog', False),
                  'TimestampOutputs' : ('timestampoutputs', False),
                  'LogTitle'         : ('logtitle', None),
@@ -203,7 +204,7 @@ def __getitem__(self, name):
     def _get_output_file(self, option):
         """Returns path of the requested output file and creates needed dirs.
 
-        `option` can be 'Output', 'Log', 'Report', 'XUnit' or 'DebugFile'.
+        `option` can be 'Output', 'Log', 'Report', 'XUnit', or 'DebugFile'.
         """
         name = self._opts[option]
         if not name:
@@ -212,6 +213,8 @@ def _get_output_file(self, option):
             self['Log'] = None
             LOGGER.error('Log file is not created if output.xml is disabled.')
             return None
+        if option == 'Output' and self.json is True and name == 'output.xml':
+            name = 'output.json'
         name = self._process_output_name(option, name)
         path = abspath(os.path.join(self['OutputDir'], name))
         create_destination_directory(path, '%s file' % option.lower())
@@ -334,6 +337,10 @@ def report(self):
     def xunit(self):
         return self['XUnit']
 
+    @property
+    def json(self):
+        return self['Json']
+
     @property
     def log_level(self):
         return self['LogLevel']
@@ -421,6 +428,7 @@ def get_rebot_settings(self):
         for name in ['Name', 'Doc']:
             settings._opts[name] = None
         settings._opts['Output'] = None
+        settings._opts['Json'] = None
         settings._opts['LogLevel'] = 'TRACE'
         settings._opts['ProcessEmptySuite'] = self['RunEmptySuite']
         settings._opts['ExpandKeywords'] = self['ExpandKeywords']
@@ -553,6 +561,11 @@ class RebotSettings(_BaseSettings):
                        'EndTime'           : ('endtime', None),
                        'Merge'             : ('merge', False)}
 
+    def __init__(self, options=None, **extra_options):
+        # When using rebot Json is an output argument, rather than a flag
+        self._output_opts.append('Json')
+        super(RebotSettings, self).__init__(options, **extra_options)
+
     def _output_disabled(self):
         return False