robot.result.executionresult
¶
Result
¶
Test execution results.
Can be created based on XML output files using the
:func:~.resultbuilder.ExecutionResult
factory method. Also returned by the
:meth:robot.running.TestSuite.run <robot.running.model.TestSuite.run>
method.
Source code in src/robot/result/executionresult.py
statistics
property
¶
|
Execution statistics.
Statistics are created based on the contained suite
and possible
:func:configuration <configure>
.
Statistics are created every time this property is accessed. Saving them to a variable is thus often a good idea to avoid re-creating them unnecessarily::
1 2 3 4 5 6 7 8 9 |
|
return_code
property
¶
Execution return code.
By default, returns the number of failed tests or tasks (max 250),
but can be :func:configured <configure>
to always return 0.
configure
¶
Configures the result object and objects it contains.
:param status_rc: If set to False
, :attr:return_code
always
returns 0.
:param suite_config: A dictionary of configuration options passed
to :meth:~.result.testsuite.TestSuite.configure
method of
the contained suite
.
:param stat_config: A dictionary of configuration options used when
creating :attr:statistics
.
Source code in src/robot/result/executionresult.py
from_json
classmethod
¶
Construct a result object from JSON data.
The data is given as the source
parameter. It can be:
- a string (or bytes) containing the data directly,
- an open file object where to read the data from, or
- a path (
pathlib.Path
or string) to a UTF-8 encoded file to read.
Data can contain either:
- full result data (contains suite information, execution errors, etc.)
got, for example, from the :meth:
to_json
method, or - only suite information got, for example, from
:meth:
result.testsuite.TestSuite.to_json <TestSuite.to_json>
.
:attr:statistics
are populated automatically based on suite information
and thus ignored if they are present in the data.
New in Robot Framework 7.2.
Source code in src/robot/result/executionresult.py
to_json
¶
Serialize results into JSON.
The file
parameter controls what to do with the resulting JSON data.
It can be:
None
(default) to return the data as a string,- an open file object where to write the data to, or
- a path (
pathlib.Path
or string) to a file where to write the data using UTF-8 encoding.
The include_statistics
controls including statistics information
in the resulting JSON data. Statistics are not needed if the serialized
JSON data is converted back to a Result
object, but they can be
useful for external tools.
The remaining optional parameters are used for JSON formatting.
They are passed directly to the underlying json__ module, but
the defaults differ from what json
uses.
New in Robot Framework 7.2.
__ https://docs.python.org/3/library/json.html
Source code in src/robot/result/executionresult.py
save
¶
Save results as XML or JSON file.
:param target: Target where to save results to. Can be a path
(pathlib.Path
or str
) or an open file object. If omitted,
uses the :attr:source
which overwrites the original file.
:param legacy_output: Save XML results in Robot Framework 6.x compatible
format. New in Robot Framework 7.0.
File type is got based on the target
. The type is JSON if the target
is a path that has a .json
suffix or if it is an open file that has
a name
attribute with a .json
suffix. Otherwise, the type is XML.
It is also possible to use :meth:to_json
for JSON serialization. Compared
to this method, it allows returning the JSON in addition to writing it
into a file, and it also supports customizing JSON formatting.
Support for saving results in JSON is new in Robot Framework 7.0. Originally only suite information was saved in that case, but starting from Robot Framework 7.2, also JSON results contain full result data including, for example, execution errors and statistics.
Source code in src/robot/result/executionresult.py
visit
¶
An entry point to visit the whole result object.
:param visitor: An instance of :class:~.visitor.ResultVisitor
.
Visitors can gather information, modify results, etc. See
:mod:~robot.result
package for a simple usage example.
Notice that it is also possible to call :meth:result.suite.visit
<robot.result.testsuite.TestSuite.visit>
if there is no need to
visit the contained statistics
or errors
.
Source code in src/robot/result/executionresult.py
handle_suite_teardown_failures
¶
set_execution_mode
¶
Set execution mode based on other result. Internal usage only.
Source code in src/robot/result/executionresult.py
CombinedResult
¶
Bases: Result
Combined results of multiple test executions.
Source code in src/robot/result/executionresult.py
statistics
property
¶
|
Execution statistics.
Statistics are created based on the contained suite
and possible
:func:configuration <configure>
.
Statistics are created every time this property is accessed. Saving them to a variable is thus often a good idea to avoid re-creating them unnecessarily::
1 2 3 4 5 6 7 8 9 |
|
return_code
property
¶
Execution return code.
By default, returns the number of failed tests or tasks (max 250),
but can be :func:configured <configure>
to always return 0.
configure
¶
Configures the result object and objects it contains.
:param status_rc: If set to False
, :attr:return_code
always
returns 0.
:param suite_config: A dictionary of configuration options passed
to :meth:~.result.testsuite.TestSuite.configure
method of
the contained suite
.
:param stat_config: A dictionary of configuration options used when
creating :attr:statistics
.
Source code in src/robot/result/executionresult.py
from_json
classmethod
¶
Construct a result object from JSON data.
The data is given as the source
parameter. It can be:
- a string (or bytes) containing the data directly,
- an open file object where to read the data from, or
- a path (
pathlib.Path
or string) to a UTF-8 encoded file to read.
Data can contain either:
- full result data (contains suite information, execution errors, etc.)
got, for example, from the :meth:
to_json
method, or - only suite information got, for example, from
:meth:
result.testsuite.TestSuite.to_json <TestSuite.to_json>
.
:attr:statistics
are populated automatically based on suite information
and thus ignored if they are present in the data.
New in Robot Framework 7.2.
Source code in src/robot/result/executionresult.py
to_json
¶
Serialize results into JSON.
The file
parameter controls what to do with the resulting JSON data.
It can be:
None
(default) to return the data as a string,- an open file object where to write the data to, or
- a path (
pathlib.Path
or string) to a file where to write the data using UTF-8 encoding.
The include_statistics
controls including statistics information
in the resulting JSON data. Statistics are not needed if the serialized
JSON data is converted back to a Result
object, but they can be
useful for external tools.
The remaining optional parameters are used for JSON formatting.
They are passed directly to the underlying json__ module, but
the defaults differ from what json
uses.
New in Robot Framework 7.2.
__ https://docs.python.org/3/library/json.html
Source code in src/robot/result/executionresult.py
save
¶
Save results as XML or JSON file.
:param target: Target where to save results to. Can be a path
(pathlib.Path
or str
) or an open file object. If omitted,
uses the :attr:source
which overwrites the original file.
:param legacy_output: Save XML results in Robot Framework 6.x compatible
format. New in Robot Framework 7.0.
File type is got based on the target
. The type is JSON if the target
is a path that has a .json
suffix or if it is an open file that has
a name
attribute with a .json
suffix. Otherwise, the type is XML.
It is also possible to use :meth:to_json
for JSON serialization. Compared
to this method, it allows returning the JSON in addition to writing it
into a file, and it also supports customizing JSON formatting.
Support for saving results in JSON is new in Robot Framework 7.0. Originally only suite information was saved in that case, but starting from Robot Framework 7.2, also JSON results contain full result data including, for example, execution errors and statistics.
Source code in src/robot/result/executionresult.py
visit
¶
An entry point to visit the whole result object.
:param visitor: An instance of :class:~.visitor.ResultVisitor
.
Visitors can gather information, modify results, etc. See
:mod:~robot.result
package for a simple usage example.
Notice that it is also possible to call :meth:result.suite.visit
<robot.result.testsuite.TestSuite.visit>
if there is no need to
visit the contained statistics
or errors
.
Source code in src/robot/result/executionresult.py
handle_suite_teardown_failures
¶
set_execution_mode
¶
Set execution mode based on other result. Internal usage only.