Enum Members
[Template] NONE
${exp_list} Evaluate [{"name": "equal","value": "=="},{"name": "==","value": "=="},{"name": "<","value": "<"},{"name": ">","value": ">"},{"name": "<=","value": "<="},{"name": ">=","value": ">="}]
- FOR ${cur} ${exp} IN ZIP ${MODEL}[dataTypes][enums][0][members] ${exp_list}
- Dictionaries Should Be Equal ${cur} ${exp}
- END
- FOR ${cur} ${exp} IN ZIP ${MODEL}[typedocs][0][members] ${exp_list}
+ FOR ${cur} ${exp} IN ZIP ${MODEL}[typedocs][1][members] ${exp_list}
Dictionaries Should Be Equal ${cur} ${exp}
END
Custom types
- ${MODEL}[typedocs][2][type] Custom
- ${MODEL}[typedocs][2][name] CustomType
- ${MODEL}[typedocs][2][doc]
Only specified values are accepted. start=True
+
+Standard types with generics
+ ${MODEL}[typedocs][5][type] Standard
+ ${MODEL}[typedocs][5][name] dictionary
+ ${MODEL}[typedocs][5][doc]
Enum Members
[Template] NONE
${exp_list} Evaluate [{"name": "equal","value": "=="},{"name": "==","value": "=="},{"name": "<","value": "<"},{"name": ">","value": ">"},{"name": "<=","value": "<="},{"name": ">=","value": ">="}]
- FOR ${cur} ${exp} IN ZIP ${MODEL}[dataTypes][enums][0][members] ${exp_list}
- Dictionaries Should Be Equal ${cur} ${exp}
- END
- FOR ${cur} ${exp} IN ZIP ${MODEL}[typedocs][0][members] ${exp_list}
+ FOR ${cur} ${exp} IN ZIP ${MODEL}[typedocs][1][members] ${exp_list}
Dictionaries Should Be Equal ${cur} ${exp}
END
Custom types
- ${MODEL}[typedocs][2][type] Custom
- ${MODEL}[typedocs][2][name] CustomType
- ${MODEL}[typedocs][2][doc]
Only specified values are accepted. start=True
+
+Standard types with generics
+ ${MODEL}[typedocs][5][type] Standard
+ ${MODEL}[typedocs][5][name] dictionary
+ ${MODEL}[typedocs][5][doc]
+ Should Contain ${MODEL}[keywords][2][doc]
+ ... This link to Keyword
+ Should Contain ${MODEL}[keywords][2][doc]
+ ... *** Test Cases ***
+
reST format
[Template] NONE
[Tags] require-docutils require-pygments
Test Format in HTML bold or <b>bold</b> Keyword.
- Should Contain ${MODEL}[keywords][2][doc]
+ ... --docformat rest
+ ... doc2=Link to Keyword or not?
+ Should Contain ${MODEL}[keywords][3][doc]
... This link to Keyword
- Should Contain ${MODEL}[keywords][2][doc]
- ... *** Test Cases ***\x3c/span>
+ Should Contain ${MODEL}[keywords][3][doc]
+ ... *** Test Cases ***
Format from Python library
*bold* or bold http://example.com lib=DocFormatHtml.py shortdoc=*bold* or *bold* http://example.com
@@ -42,6 +54,7 @@ Format in XML
Format in JSON RAW
[Template] Test Format in JSON
+ [Tags] require-jsonschema
${RAW DOC} TEXT -F TEXT --specdocformat rAw DocFormat.py
${RAW DOC} ROBOT --docfor RoBoT -s RAW DocFormatHtml.py
${RAW DOC} HTML -s raw DocFormatHtml.py
@@ -55,6 +68,7 @@ Format in LIBSPEC
Format in JSON
[Template] Test Format in JSON
+ [Tags] require-jsonschema
${HTML DOC}
HTML --format jSoN --specdocformat hTML DocFormat.py
${HTML DOC}
HTML --format jSoN DocFormat.py
${HTML DOC}
HTML --docfor RoBoT -f JSON -s HTML DocFormatHtml.py
@@ -68,6 +82,7 @@ Format from XML spec
Format from JSON RAW spec
[Template] NONE
+ [Tags] require-jsonschema
Test Format In JSON ${RAW DOC} ROBOT -F Robot -s RAW lib=DocFormat.py
Copy File ${OUTJSON} ${OUTBASE}-2.json
Test Format In JSON
${HTML DOC}
HTML lib=${OUTBASE}-2.json
@@ -80,6 +95,7 @@ Format from LIBSPEC spec
Format from JSON spec
[Template] NONE
+ [Tags] require-jsonschema
Test Format In JSON
${HTML DOC}
HTML -F Robot lib=DocFormat.py
Copy File ${OUTJSON} ${OUTBASE}-2.json
Test Format In JSON
${HTML DOC}
HTML lib=${OUTBASE}-2.json
@@ -93,7 +109,7 @@ Compare HTML from LIBSPEC
*** Keywords ***
Test Format In HTML
[Arguments] ${doc} ${cli}= ${lib}=DocFormat.py
- ... ${doc2}=Link to Keyword.
+ ... ${doc2}=Link to Keyword or not?
... ${shortdoc}=*bold* or bold http://example.com
${lib} = Join Path ${TESTDATADIR} ${lib}
Run Libdoc And Parse Model From HTML ${cli} ${lib}
diff --git a/atest/robot/libdoc/dynamic_library.robot b/atest/robot/libdoc/dynamic_library.robot
index 6539af01d7e..ea4698aca0b 100644
--- a/atest/robot/libdoc/dynamic_library.robot
+++ b/atest/robot/libdoc/dynamic_library.robot
@@ -39,7 +39,7 @@ Init arguments
Init Source Info
Keyword Should Not Have Source 0 xpath=inits/init
- Keyword Lineno Should Be 0 9 xpath=inits/init
+ Keyword Lineno Should Be 0 10 xpath=inits/init
Keyword names
Keyword Name Should Be 0 0
@@ -90,6 +90,9 @@ Keyword tags from documentation
Keyword types
Keyword Arguments Should Be 18 integer: int no type boolean: bool = True
+Return type
+ Return Type Should Be 18 int
+
No keyword source info
Keyword Name Should Be 0 0
Keyword Should Not Have Source 0
@@ -98,7 +101,7 @@ No keyword source info
Keyword source info
Keyword Name Should Be 14 Source Info
Keyword Should Not Have Source 14
- Keyword Lineno Should Be 14 83
+ Keyword Lineno Should Be 14 90
Keyword source info with different path than library
Keyword Name Should Be 16 Source Path Only
diff --git a/atest/robot/libdoc/html_output.robot b/atest/robot/libdoc/html_output.robot
index f42a4b150b8..ffe1bfc9b46 100644
--- a/atest/robot/libdoc/html_output.robot
+++ b/atest/robot/libdoc/html_output.robot
@@ -15,7 +15,7 @@ Version
Generated
[Template] Should Match Regexp
- ${MODEL}[generated] \\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}
+ ${MODEL}[generated] \\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[+-]\\d{2}:\\d{2}
Scope
${MODEL}[scope] GLOBAL
@@ -33,7 +33,7 @@ Keyword Arguments
[Template] Verify Argument Models
${MODEL}[keywords][0][args]
${MODEL}[keywords][1][args] a1=d *a2
- ${MODEL}[keywords][6][args] arg=hyv\\xe4
+ ${MODEL}[keywords][6][args] arg=hyvä
${MODEL}[keywords][9][args] arg=hyvä
${MODEL}[keywords][10][args] a=1 b=True c=(1, 2, None)
${MODEL}[keywords][11][args] arg=\\ robot \\ escapers\\n\\t\\r \\ \\
@@ -41,8 +41,18 @@ Keyword Arguments
Embedded Arguments
[Template] NONE
- Should Be Equal ${MODEL}[keywords][13][name] Takes \${embedded} \${args}
- Should Be Empty ${MODEL}[keywords][13][args]
+ Should Be Equal ${MODEL}[keywords][13][name] Takes \${embedded} \${args}
+ Should Be Empty ${MODEL}[keywords][13][args]
+
+Embedded and Normal Arguments
+ [Template] NONE
+ Should Be Equal ${MODEL}[keywords][14][name] Takes \${embedded} and normal args
+ Verify Argument Models ${MODEL}[keywords][14][args] mandatory optional=None
+
+Embedded and Positional-only Arguments
+ [Template] NONE
+ Should Be Equal ${MODEL}[keywords][15][name] Takes \${embedded} and positional-only args
+ Verify Argument Models ${MODEL}[keywords][15][args] mandatory / optional=None
Keyword Documentation
${MODEL}[keywords][1][doc]
@@ -105,6 +115,16 @@ User keyword documentation formatting
...
...
+Private keyword should be excluded
+ [Setup] Run Libdoc And Parse Model From HTML ${TESTDATADIR}/resource.robot
+ [Template] None
+ FOR ${keyword} IN @{MODEL}[keywords]
+ Should Not Be Equal ${keyword}[name] Private
+ END
+
+All tags does not include tags from private keywords
+ ${MODEL}[tags] ['\${3}', '?!?!??', 'a', 'b', 'bar', 'common', 'dar', 'foo', 'Has', 'kw4', 'tags']
+
*** Keywords ***
Verify Argument Models
[Arguments] ${arg_models} @{expected_reprs}
diff --git a/atest/robot/libdoc/internal_linking.robot b/atest/robot/libdoc/internal_linking.robot
index ddee356be9c..043aeb97aad 100644
--- a/atest/robot/libdoc/internal_linking.robot
+++ b/atest/robot/libdoc/internal_linking.robot
@@ -23,6 +23,9 @@ Linking to keywords in importing and keywords
${MODEL['inits'][0]} Keyword keyword
${MODEL['keywords'][1]} Second%20Keyword Second Keyword
+Linking to types
+ ${MODEL} type-integer Integer
+
Non-matching text in backticks gets formatting
[Template] Doc Should Contain Name
${MODEL} backticks
@@ -49,9 +52,10 @@ Linking to second and third level headers
Doc Should Contain ${MODEL}
Third level
Only headers in introduction are linkable
+ [Documentation] Starting from RF 7.5 all headers get id, though.
[Template] NONE
Doc Should Contain Name ${MODEL['keywords'][2]} not linkable
- Doc Should Contain ${MODEL['keywords'][2]}
Not linkable
+ Doc Should Contain ${MODEL['keywords'][2]}
Not linkable
Special characters are percent encoded
${MODEL['keywords'][0]}
diff --git a/atest/robot/libdoc/invalid_library_keywords.robot b/atest/robot/libdoc/invalid_library_keywords.robot
index 4f212480158..f923179c717 100644
--- a/atest/robot/libdoc/invalid_library_keywords.robot
+++ b/atest/robot/libdoc/invalid_library_keywords.robot
@@ -20,7 +20,7 @@ Invalid embedded arguments
Keyword Count Should Be 3
Stdout should contain adding keyword error
... Invalid embedded \${args}
- ... Embedded argument count does not match number of accepted arguments.
+ ... Keyword must accept at least as many positional arguments as it has embedded arguments.
*** Keywords ***
Stdout should contain adding keyword error
diff --git a/atest/robot/libdoc/invalid_usage.robot b/atest/robot/libdoc/invalid_usage.robot
index 24f1c0b4ec7..fca20a1557f 100644
--- a/atest/robot/libdoc/invalid_usage.robot
+++ b/atest/robot/libdoc/invalid_usage.robot
@@ -2,7 +2,6 @@
Resource libdoc_resource.robot
Test Setup Remove File ${OUT HTML}
Test Template Run libdoc and verify error
-Test Teardown Should Not Exist ${OUT HTML}
*** Test Cases ***
No arguments
@@ -22,6 +21,7 @@ Invalid format
--format XML:XXX BuiltIn ${OUT HTML} Format must be 'HTML', 'XML', 'JSON' or 'LIBSPEC', got 'XML:XXX'.
--format XML:HTML BuiltIn ${OUT HTML} Format must be 'HTML', 'XML', 'JSON' or 'LIBSPEC', got 'XML:HTML'.
BuiltIn out.ext Format must be 'HTML', 'XML', 'JSON' or 'LIBSPEC', got 'EXT'.
+ BuiltIn BuiltIn Format must be 'HTML', 'XML', 'JSON' or 'LIBSPEC', got ''.
Invalid specdocformat
-s XXX BuiltIn ${OUT HTML} Spec doc format must be 'RAW' or 'HTML', got 'XXX'.
@@ -31,11 +31,15 @@ Invalid specdocformat for HTML output format
--specdocformat HTML BuiltIn ${OUT HTML} The --specdocformat option is not applicable with HTML outputs.
Invalid doc format
- --docformat inv BuiltIn ${OUT HTML} Doc format must be 'ROBOT', 'TEXT', 'HTML' or 'REST', got 'INV'.
+ --docformat inv BuiltIn ${OUT HTML} Doc format must be 'ROBOT', 'MARKDOWN', 'TEXT', 'HTML' or 'REST', got 'INV'.
Invalid doc format in library
${TESTDATADIR}/DocFormatInvalid.py ${OUT HTML} Invalid documentation format 'INVALID'.
+Invalid theme
+ --theme bad String ${OUT XML} Theme must be 'DARK', 'LIGHT' or 'NONE', got 'BAD'.
+ --theme light --format xml String ${OUT XML} The --theme option is only applicable with HTML outputs.
+
Non-existing library
NonExistingLib ${OUT HTML} Importing library 'NonExistingLib' failed: *
@@ -53,11 +57,17 @@ Non-XML spec
[Teardown] Remove File ${OUT XML}
Invalid resource
- ${CURDIR}/invalid_usage.robot ${OUT HTML}
- ... ? ERROR ? Error in file '*' on line 3: Setting 'Test Setup' is not allowed in resource file.
- ... ? ERROR ? Error in file '*' on line 4: Setting 'Test Template' is not allowed in resource file.
- ... ? ERROR ? Error in file '*' on line 5: Setting 'Test Teardown' is not allowed in resource file.
- ... Error in file '*[/\\]invalid_usage.robot' on line 7: Resource file with 'Test Cases' section is invalid.
+ ${TESTDATADIR}/invalid_resource.resource ${OUT HTML}
+ ... ? ERROR ? Error in file '*[/\\]invalid_resource.resource' on line 2: Setting 'Metadata' is not allowed in resource file.
+ ... ? ERROR ? Error in file '*[/\\]invalid_resource.resource' on line 3: Setting 'Test Setup' is not allowed in resource file.
+ ... Error in file '*[/\\]invalid_resource.resource' on line 5: Resource file with 'Test Cases' section is invalid.
+
+Invalid resource with '.robot' extension
+ ${TESTDATADIR}/invalid_resource.robot ${OUT HTML}
+ ... ? ERROR ? Error in file '*[/\\]invalid_resource.robot' on line 2: Setting 'Metadata' is not allowed in resource file.
+ ... ? ERROR ? Error in file '*[/\\]invalid_resource.robot' on line 3: Setting 'Test Setup' is not allowed in resource file.
+ ... ${OUT HTML}
+ ... fatal=False
Invalid output file
[Setup] Run Keywords
@@ -70,10 +80,16 @@ Invalid output file
... Remove Directory ${OUT HTML} AND
... Remove Directory ${OUT XML}
-invalid Spec File version
- ${TESTDATADIR}/OldSpec.xml ${OUT XML} Invalid spec file version 'None'. Supported versions are 3 and 4.
+Invalid Spec File version
+ ${TESTDATADIR}/OldSpec.xml ${OUT XML} Invalid spec file version 'None'. Supported versions are 3, 4, 5, and 6.
*** Keywords ***
Run libdoc and verify error
- [Arguments] ${args} @{error}
- Run libdoc and verify output ${args} @{error} ${USAGE TIP[1:]}
+ [Arguments] ${args} @{error} ${fatal}=True
+ IF ${fatal}
+ Run Libdoc And Verify Output ${args} @{error} ${USAGE TIP[1:]}
+ File Should Not Exist ${OUT HTML}
+ ELSE
+ Run Libdoc And Verify Output ${args} @{error}
+ File Should Exist ${OUT HTML}
+ END
diff --git a/atest/robot/libdoc/invalid_user_keywords.robot b/atest/robot/libdoc/invalid_user_keywords.robot
index 530cec1840c..9dcec3a8cf7 100644
--- a/atest/robot/libdoc/invalid_user_keywords.robot
+++ b/atest/robot/libdoc/invalid_user_keywords.robot
@@ -6,16 +6,16 @@ Resource libdoc_resource.robot
Invalid arg spec
Keyword Name Should Be 0 Invalid arg spec
Keyword Doc Should Be 0 *Creating keyword failed:* Invalid argument specification: Only last argument can be kwargs.
- Stdout should contain error Invalid arg spec 2
+ Stdout should contain error Invalid arg spec 3
... Invalid argument specification: Only last argument can be kwargs.
-Dublicate name
- Keyword Name Should Be 3 Same twice
+Duplicate name
+ Keyword Name Should Be 3 Same Twice
Keyword Doc Should Be 3 *Creating keyword failed:* Keyword with same name defined multiple times.
- Stdout should contain error Same twice 8
+ Stdout should contain error Same twice 10
... Keyword with same name defined multiple times
-Dublicate name with embedded arguments
+Duplicate name with embedded arguments
Keyword Name Should Be 1 same \${embedded match}
Keyword Doc Should Be 1 ${EMPTY}
Keyword Name Should Be 2 Same \${embedded}
diff --git a/atest/robot/libdoc/json_output.robot b/atest/robot/libdoc/json_output.robot
index 78305a45851..e658e963369 100644
--- a/atest/robot/libdoc/json_output.robot
+++ b/atest/robot/libdoc/json_output.robot
@@ -2,6 +2,7 @@
Resource libdoc_resource.robot
Suite Setup Run Libdoc And Parse Model From JSON ${TESTDATADIR}/module.py
Test Template Should Be Equal Multiline
+Test Tags require-jsonschema
*** Test Cases ***
Name
@@ -15,7 +16,7 @@ Version
Generated
[Template] Should Match Regexp
- ${MODEL}[generated] \\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}
+ ${MODEL}[generated] \\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[+-]\\d{2}:\\d{2}
Scope
${MODEL}[scope] GLOBAL
@@ -33,7 +34,7 @@ Keyword Arguments
[Template] Verify Argument Models
${MODEL}[keywords][0][args]
${MODEL}[keywords][1][args] a1=d *a2
- ${MODEL}[keywords][6][args] arg=hyv\\xe4
+ ${MODEL}[keywords][6][args] arg=hyvä
${MODEL}[keywords][9][args] arg=hyvä
${MODEL}[keywords][10][args] a=1 b=True c=(1, 2, None)
${MODEL}[keywords][11][args] arg=\\ robot \\ escapers\\n\\t\\r \\ \\
@@ -41,8 +42,18 @@ Keyword Arguments
Embedded Arguments
[Template] NONE
- Should Be Equal ${MODEL}[keywords][13][name] Takes \${embedded} \${args}
- Should Be Empty ${MODEL}[keywords][13][args]
+ Should Be Equal ${MODEL}[keywords][13][name] Takes \${embedded} \${args}
+ Should Be Empty ${MODEL}[keywords][13][args]
+
+Embedded and Normal Arguments
+ [Template] NONE
+ Should Be Equal ${MODEL}[keywords][14][name] Takes \${embedded} and normal args
+ Verify Argument Models ${MODEL}[keywords][14][args] mandatory optional=None
+
+Embedded and Positional-only Arguments
+ [Template] NONE
+ Should Be Equal ${MODEL}[keywords][15][name] Takes \${embedded} and positional-only args
+ Verify Argument Models ${MODEL}[keywords][15][args] mandatory / optional=None
Keyword Documentation
${MODEL}[keywords][1][doc]
@@ -105,6 +116,20 @@ User keyword documentation formatting
...
...
+Private user keyword should be included
+ [Setup] Run Libdoc And Parse Model From JSON ${TESTDATADIR}/resource.robot
+ ${MODEL}[keywords][-2][name] Private
+ ${MODEL}[keywords][-2][tags] ['common', 'robot:private', 'tag-in-private', 'tags']
+ ${MODEL}[keywords][-2][private] True
+ ${MODEL['keywords'][0].get('private')} None
+
+Deprecation
+ [Setup] Run Libdoc And Parse Model From JSON ${TESTDATADIR}/Deprecation.py
+ ${MODEL}[keywords][0][deprecated] True
+ ${MODEL}[keywords][1][deprecated] True
+ ${MODEL['keywords'][2].get('deprecated')} None
+ ${MODEL['keywords'][3].get('deprecated')} None
+
*** Keywords ***
Verify Argument Models
[Arguments] ${arg_models} @{expected_reprs}
diff --git a/atest/robot/libdoc/libdoc_resource.robot b/atest/robot/libdoc/libdoc_resource.robot
index 351b5e793d3..d67a3188f44 100644
--- a/atest/robot/libdoc/libdoc_resource.robot
+++ b/atest/robot/libdoc/libdoc_resource.robot
@@ -1,7 +1,6 @@
*** Settings ***
Resource atest_resource.robot
Library LibDocLib.py ${INTERPRETER}
-Library OperatingSystem
*** Variables ***
${TESTDATADIR} ${DATADIR}/libdoc
@@ -31,8 +30,8 @@ Run Libdoc And Parse Output
Run Libdoc And Verify Output
[Arguments] ${args} @{expected}
+ VAR ${expected} @{expected} separator=\n
${output}= Run Libdoc ${args}
- ${expected}= Catenate SEPARATOR=\n @{expected}
Should Match ${output} ${expected}\n
Run Libdoc And Parse Model From HTML
@@ -80,7 +79,7 @@ Type Should Be
Element Attribute Should Be ${LIBDOC} type ${type}
Scope Should Be
- [Arguments] ${scope} ${old}=${{ {'GLOBAL': 'global', 'SUITE': 'test suite', 'TEST': 'test case'}[$scope] }}
+ [Arguments] ${scope}
Element Attribute Should Be ${LIBDOC} scope ${scope}
Source Should Be
@@ -93,10 +92,16 @@ Lineno Should Be
Element Attribute Should Be ${LIBDOC} lineno ${lineno}
Generated Should Be Defined
- Element Attribute Should Match ${LIBDOC} generated ????-??-??T??:??:??Z
+ # For example, '1970-01-01T00:00:01+00:00'.
+ Element Attribute Should Match ${LIBDOC} generated ????-??-??T??:??:?????:??
+
+Generated Should Be
+ [Arguments] ${generated}
+ Generated Should Be Defined
+ Element Attribute Should Be ${LIBDOC} generated ${generated}
Spec version should be correct
- Element Attribute Should Be ${LIBDOC} specversion 4
+ Element Attribute Should Be ${LIBDOC} specversion 6
Should Have No Init
${inits} = Get Elements ${LIBDOC} xpath=inits/init
@@ -132,12 +137,19 @@ Verify Arguments Structure
[Arguments] ${index} ${xpath} ${expected}
${kws}= Get Elements ${LIBDOC} xpath=${xpath}
${arg_elems}= Get Elements ${kws}[${index}] xpath=arguments/arg
- FOR ${arg_elem} ${exp_repr} IN ZIP ${arg_elems} ${expected}
+ FOR ${arg_elem} ${exp_repr} IN ZIP ${arg_elems} ${expected} mode=STRICT
${kind}= Get Element Attribute ${arg_elem} kind
${required}= Get Element Attribute ${arg_elem} required
${repr}= Get Element Attribute ${arg_elem} repr
${name}= Get Element Optional Text ${arg_elem} name
- ${type}= Get Elements Texts ${arg_elem} type
+ ${types}= Get Elements ${arg_elem} type
+ IF not $types
+ ${type}= Set Variable ${None}
+ ELSE IF len($types) == 1
+ ${type}= Get Type ${types}[0]
+ ELSE
+ Fail Cannot have more than one element
+ END
${default}= Get Element Optional Text ${arg_elem} default
${arg_model}= Create Dictionary
... kind=${kind}
@@ -148,7 +160,37 @@ Verify Arguments Structure
Verify Argument Model ${arg_model} ${exp_repr}
Should Be Equal ${repr} ${exp_repr}
END
- Should Be Equal ${{len($arg_elems)}} ${{len($expected)}}
+
+Return Type Should Be
+ [Arguments] ${index} ${name} @{nested}
+ ${kws}= Get Elements ${LIBDOC} xpath=keywords/kw
+ VAR ${kw} ${kws}[${index}]
+ IF $name.upper() == 'NONE'
+ Element Should Not Exist ${kw} returntype
+ RETURN
+ END
+ Element Attribute Should Be ${kw} name ${name} xpath=returntype
+ ${type_elems} = Get Elements ${kw} returntype/type
+ FOR ${elem} ${expected} IN ZIP ${type_elems} ${nested} mode=STRICT
+ Element Attribute Should Be ${elem} name ${expected}
+ END
+
+Get Type
+ [Arguments] ${elem}
+ ${children} = Get Elements ${elem} type
+ ${nested} = Create List
+ FOR ${child} IN @{children}
+ ${type} = Get Type ${child}
+ Append To List ${nested} ${type}
+ END
+ ${type} = Get Element Attribute ${elem} name
+ IF $elem.get('union') == 'true'
+ ${type} = Catenate SEPARATOR=${SPACE}|${SPACE} @{nested}
+ ELSE IF $nested
+ ${args} = Catenate SEPARATOR=,${SPACE} @{nested}
+ ${type} = Set Variable ${type}\[${args}]
+ END
+ RETURN ${type}
Get Element Optional Text
[Arguments] ${source} ${xpath}
@@ -193,7 +235,7 @@ Keyword Tags Should Be
Specfile Tags Should Be
[Arguments] @{expected}
- ${tags} Get Elements Texts ${LIBDOC} xpath=tags/tag
+ ${tags}= Get Elements Texts ${LIBDOC} xpath=tags/tag
Should Be Equal ${tags} ${expected}
Keyword Source Should Be
@@ -217,6 +259,16 @@ Keyword Should Not Have Lineno
${kws}= Get Elements ${LIBDOC} xpath=${xpath}
Element Should Not Have Attribute ${kws}[${index}] lineno
+Keyword Should Be Private
+ [Arguments] ${index}
+ ${kws}= Get Elements ${LIBDOC} xpath=keywords/kw
+ Element Attribute Should be ${kws}[${index}] private true
+
+Keyword Should Not Be Private
+ [Arguments] ${index}
+ ${kws}= Get Elements ${LIBDOC} xpath=keywords/kw
+ Element Should Not Have Attribute ${kws}[${index}] private
+
Keyword Should Be Deprecated
[Arguments] ${index}
${kws}= Get Elements ${LIBDOC} xpath=keywords/kw
@@ -252,52 +304,48 @@ List of Dict Should Be Equal
DataType Enum Should Be
[Arguments] ${index} ${name} ${doc} @{exp_members}
- FOR ${xpath} IN datatypes/enums/enum typedocs/type[@type='Enum']
- ${enums}= Get Elements ${LIBDOC} xpath=${xpath}
- Element Attribute Should Be ${enums}[${index}] name ${name}
- Element Text Should Be ${enums}[${index}] ${doc} xpath=doc
- ${members}= Get Elements ${enums}[${index}] xpath=members/member
- FOR ${member} ${exp_member} IN ZIP ${members} ${exp_members}
- ${attrs}= Get Element Attributes ${member}
- Element Attribute Should Be ${member} name ${{${exp_member}}}[name]
- Element Attribute Should Be ${member} value ${{${exp_member}}}[value]
- END
+ ${enums}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='Enum']
+ Element Attribute Should Be ${enums}[${index}] name ${name}
+ Element Text Should Be ${enums}[${index}] ${doc} xpath=doc
+ ${members}= Get Elements ${enums}[${index}] xpath=members/member
+ FOR ${member} ${exp_member} IN ZIP ${members} ${exp_members}
+ ${attrs}= Get Element Attributes ${member}
+ Element Attribute Should Be ${member} name ${{${exp_member}}}[name]
+ Element Attribute Should Be ${member} value ${{${exp_member}}}[value]
END
DataType TypedDict Should Be
[Arguments] ${index} ${name} ${doc} @{exp_items}
- FOR ${xpath} IN datatypes/typeddicts/typeddict typedocs/type[@type='TypedDict']
- ${dicts}= Get Elements ${LIBDOC} xpath=${xpath}
- Element Attribute Should Be ${dicts}[${index}] name ${name}
- Element Text Should Be ${dicts}[${index}] ${doc} xpath=doc
- ${items}= Get Elements ${dicts}[${index}] xpath=items/item
- FOR ${exp_item} IN @{exp_items}
- ${exp}= Evaluate json.loads($exp_item)
- FOR ${item} IN @{items}
- ${cur}= Get Element Attributes ${item}
- IF $cur['key'] == $exp['key']
- Should Be Equal ${cur}[key] ${exp}[key]
- Should Be Equal ${cur}[type] ${exp}[type]
- IF 'required' in $exp
- Should Be Equal ${cur}[required] ${exp}[required]
- END
- BREAK
+ ${dicts}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='TypedDict']
+ Element Attribute Should Be ${dicts}[${index}] name ${name}
+ Element Text Should Be ${dicts}[${index}] ${doc} xpath=doc
+ ${items}= Get Elements ${dicts}[${index}] xpath=items/item
+ FOR ${exp_item} IN @{exp_items}
+ ${exp}= Evaluate json.loads($exp_item)
+ FOR ${item} IN @{items}
+ ${cur}= Get Element Attributes ${item}
+ IF $cur['key'] == $exp['key']
+ Should Be Equal ${cur}[key] ${exp}[key]
+ Should Be Equal ${cur}[type] ${exp}[type]
+ IF 'required' in $exp
+ Should Be Equal ${cur}[required] ${exp}[required]
END
+ BREAK
END
END
END
DataType Custom Should Be
[Arguments] ${index} ${name} ${doc}
- ${customs}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='Custom']
- Element Attribute Should Be ${customs}[${index}] name ${name}
- Element Text Should Be ${customs}[${index}] ${doc} xpath=doc
+ ${types}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='Custom']
+ Element Attribute Should Be ${types}[${index}] name ${name}
+ Element Text Should Be ${types}[${index}] ${doc} xpath=doc
DataType Standard Should Be
[Arguments] ${index} ${name} ${doc}
- ${customs}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='Standard']
- Element Attribute Should Be ${customs}[${index}] name ${name}
- Element Text Should Match ${customs}[${index}] ${doc}* xpath=doc
+ ${types}= Get Elements ${LIBDOC} xpath=typedocs/type[@type='Standard']
+ Element Attribute Should Be ${types}[${index}] name ${name}
+ Element Text Should Match ${types}[${index}] ${doc}* xpath=doc
Usages Should Be
[Arguments] ${index} ${type} ${name} @{expected}
@@ -322,15 +370,21 @@ Accepted Types Should Be
END
Typedoc links should be
- [Arguments] ${kw} ${arg} @{typedocs}
- ${types} = Get Elements ${LIBDOC} keywords/kw[${${kw} + 1}]/arguments/arg[${${arg} + 1}]/type
- Length Should Be ${types} ${{len($typedocs)}}
- FOR ${type} ${typedoc} IN ZIP ${types} ${typedocs}
- IF ':' in $typedoc
- ${typename} ${typedoc} = Split String ${typedoc} :
- ELSE
- ${typename} = Set Variable ${typedoc}
- END
- Element Text Should Be ${type} ${typename}
- Element Attribute Should Be ${type} typedoc ${{$typedoc or None}}
+ [Arguments] ${kw} ${arg} ${typedoc} @{nested typedocs}
+ ${type} = Get Element ${LIBDOC} keywords/kw[${${kw} + 1}]/arguments/arg[${${arg} + 1}]/type
+ Typedoc link should be ${type} ${typedoc}
+ ${nested} = Get Elements ${type} type
+ Length Should Be ${nested} ${{len($nested_typedocs)}}
+ FOR ${type} ${typedoc} IN ZIP ${nested} ${nested typedocs}
+ Typedoc link should be ${type} ${typedoc}
+ END
+
+Typedoc link should be
+ [Arguments] ${type} ${typedoc}
+ IF ':' in $typedoc
+ ${typename} ${typedoc} = Split String ${typedoc} :
+ ELSE
+ ${typename} = Set Variable ${typedoc}
END
+ Element Attribute Should Be ${type} name ${typename}
+ Element Attribute Should Be ${type} typedoc ${{$typedoc or None}}
diff --git a/atest/robot/libdoc/markdown_format.robot b/atest/robot/libdoc/markdown_format.robot
new file mode 100644
index 00000000000..c3cf9dbaa59
--- /dev/null
+++ b/atest/robot/libdoc/markdown_format.robot
@@ -0,0 +1,168 @@
+*** Settings ***
+Suite Setup Generate doc using Markdown source
+Test Template Doc should contain
+Resource libdoc_resource.robot
+
+*** Test Cases ***
+Basic formatting
+ Basic Markdown formatting such as bold, italics and code works as expected.
+
+Linking
+ Normal Markdown inline and reference links are supported.
+
+Automatic reference targets
+ Keywords like References and admonitions.
+ Headers in the library introduction like linking and Basics.
+ Predefined targets like Introduction and keywords.
+ We can link to predefined targets like introduction, to intro headers
+ ... like linking and to keywords like Admonitions.
+ ... model=${MODEL}[keywords][2]
+
+Custom references work only in current context
+ Custom references defined elsewhere like [reference] do not work.
+ ... model=${MODEL}[keywords][2]
+
+Unordered lists
+
+
+Lines starting with `#` in code blocks are not considered headers
+ # This is not a header!
+ ...
+ # This is not a header either!
+ ...
+
+Table of contents in keyword documentation
+
+ ... model=${MODEL}[keywords][5]
+
+*** Keywords ***
+Generate doc using Markdown source
+ Run Libdoc And Parse Model From HTML ${TESTDATADIR}/MarkdownFormat.py
+
+Doc should contain
+ [Arguments] @{content} ${model}=${MODEL}
+ VAR ${content} @{content} separator=\n
+ Should Contain ${model}[doc] ${content}
diff --git a/atest/robot/libdoc/module_library.robot b/atest/robot/libdoc/module_library.robot
index 3744d8e82d4..deb44bffdb7 100644
--- a/atest/robot/libdoc/module_library.robot
+++ b/atest/robot/libdoc/module_library.robot
@@ -44,7 +44,7 @@ Keyword Arguments
Keyword Arguments Should Be 12 a b *args **kwargs
Non-ASCII Bytes Defaults
- Keyword Arguments Should Be 6 arg=hyv\\xe4
+ Keyword Arguments Should Be 6 arg=hyvä
Non-ASCII String Defaults
Keyword Arguments Should Be 9 arg=hyvä
@@ -53,6 +53,14 @@ Embedded Arguments
Keyword Name Should Be 13 Takes \${embedded} \${args}
Keyword Arguments Should Be 13
+Embedded and Normal Arguments
+ Keyword Name Should Be 14 Takes \${embedded} and normal args
+ Keyword Arguments Should Be 14 mandatory optional=None
+
+Embedded and Positional-only Arguments
+ Keyword Name Should Be 15 Takes \${embedded} and positional-only args
+ Keyword Arguments Should Be 15 mandatory / optional=None
+
Keyword Documentation
Keyword Doc Should Be 1 A keyword.\n\nSee `get hello` for details.
Keyword Shortdoc Should Be 1 A keyword.
@@ -92,9 +100,9 @@ Keyword tags
Keyword source info
Keyword Name Should Be 0 Get Hello
Keyword Should Not Have Source 0
- Keyword Lineno Should Be 0 17
+ Keyword Lineno Should Be 0 16
Keyword source info with decorated function
Keyword Name Should Be 13 Takes \${embedded} \${args}
Keyword Should Not Have Source 13
- Keyword Lineno Should Be 13 71
+ Keyword Lineno Should Be 13 70
diff --git a/atest/robot/libdoc/python_library.robot b/atest/robot/libdoc/python_library.robot
index c6266e6cbff..c5ed46783f2 100644
--- a/atest/robot/libdoc/python_library.robot
+++ b/atest/robot/libdoc/python_library.robot
@@ -13,7 +13,7 @@ Documentation
... ``Telnet`` is Robot Framework's standard library that makes it possible to
Version
- Version Should Match [345].*
+ Version Should Match [6789].*
Type
Type Should Be LIBRARY
@@ -26,7 +26,7 @@ Scope
Source info
Source should be ${CURDIR}/../../../src/robot/libraries/Telnet.py
- Lineno should be 36
+ Lineno should be 37
Spec version
Spec version should be correct
@@ -45,7 +45,7 @@ Init Arguments
Init Source Info
Keyword Should Not Have Source 0 xpath=inits/init
- Keyword Lineno Should Be 0 281 xpath=inits/init
+ Keyword Lineno Should Be 0 287 xpath=inits/init
Keyword Names
Keyword Name Should Be 0 Close All Connections
@@ -53,10 +53,10 @@ Keyword Names
Keyword Arguments
Keyword Arguments Should Be 0
- Keyword Arguments Should Be 1 loglevel=None
+ Keyword Arguments Should Be 1 loglevel=None
Keyword Documentation
- Keyword Doc Should Start With 0 Closes all open connections
+ Keyword Doc Should Start With 0 Closes all open connections
Keyword Doc Should Start With 2
... Executes the given ``command`` and reads, logs, and returns everything until the prompt.
...
@@ -76,44 +76,48 @@ Keyword Source Info
# This keyword is from the "main library".
Keyword Name Should Be 0 Close All Connections
Keyword Should Not Have Source 0
- Keyword Lineno Should Be 0 470
+ Keyword Lineno Should Be 0 517
# This keyword is from an external library component.
Keyword Name Should Be 7 Read Until Prompt
Keyword Should Not Have Source 7
- Keyword Lineno Should Be 7 1009
+ Keyword Lineno Should Be 7 1087
KwArgs and VarArgs
- Run Libdoc And Parse Output Process
- Keyword Name Should Be 7 Run Process
- Keyword Arguments Should Be 7 command *arguments **configuration
+ Run Libdoc And Parse Output ${TESTDATADIR}/KwArgs.py
+ Keyword Arguments Should Be 2 *varargs **kwargs
+ Keyword Arguments Should Be 3 a / b c=d *e f g=h **i
Keyword-only Arguments
- Run Libdoc And Parse Output ${TESTDATADIR}/KeywordOnlyArgs.py
+ Run Libdoc And Parse Output ${TESTDATADIR}/KwArgs.py
Keyword Arguments Should Be 0 * kwo
Keyword Arguments Should Be 1 *varargs kwo another=default
Positional-only Arguments
- [Tags] require-py3.8
Run Libdoc And Parse Output ${DATADIR}/keywords/PositionalOnly.py
- Keyword Arguments Should Be 2 arg /
+ Keyword Arguments Should Be 1 arg /
Keyword Arguments Should Be 5 posonly / normal
Keyword Arguments Should Be 0 required optional=default /
- Keyword Arguments Should Be 4 first: int second: float /
+ Keyword Arguments Should Be 3 first: int second: float /
Decorators
Run Libdoc And Parse Output ${TESTDATADIR}/Decorators.py
Keyword Name Should Be 0 Keyword Using Decorator
Keyword Arguments Should Be 0 *args **kwargs
Keyword Should Not Have Source 0
- Keyword Lineno Should Be 0 8
+ Keyword Lineno Should Be 0 7
Keyword Name Should Be 1 Keyword Using Decorator With Wraps
Keyword Arguments Should Be 1 args are preserved=True
- Keyword Lineno Should Be 1 26
+ Keyword Lineno Should Be 1 27
Documentation set in __init__
Run Libdoc And Parse Output ${TESTDATADIR}/DocSetInInit.py
Doc Should Be Doc set in __init__!!
+__init__ with only named-only arguments
+ Run Libdoc And Parse Output ${TESTDATADIR}/InitWithOnlyNamedOnlyArgs.py::b=2
+ Init Arguments Should Be 0 * a=1 b
+ Init Doc Should Be 0 xxx
+
Deprecation
Run Libdoc And Parse Output ${TESTDATADIR}/Deprecation.py
Keyword Name Should Be 0 Deprecated
@@ -130,3 +134,8 @@ Deprecation
...
... RF and Libdoc don't consider this being deprecated.
Keyword Should Not Be Deprecated 3
+
+NOT_SET as default value
+ Run Libdoc And Parse Output Collections
+ Keyword Name Should Be 17 Get From Dictionary
+ Keyword Arguments Should Be 17 dictionary: Mapping key: object default: object = \
diff --git a/atest/robot/libdoc/resource_file.robot b/atest/robot/libdoc/resource_file.robot
index 35e06f8def1..b19014c1af2 100644
--- a/atest/robot/libdoc/resource_file.robot
+++ b/atest/robot/libdoc/resource_file.robot
@@ -19,7 +19,7 @@ Documentation
...
... | *TABLE* |
... | \${NONEX} | $\{CURDIR} | \${TEMPDIR} |
- ... | foo | bar |
+ ... | foo${SPACE*6}|${SPACE*4}bar${SPACE*4}|
... tabs \t\t\t here
Version
@@ -32,7 +32,7 @@ Generated
Generated Should Be Defined
Scope
- Scope Should Be GLOBAL old=${EMPTY}
+ Scope Should Be GLOBAL
Source Info
Source Should Be ${TESTDATADIR}/resource.robot
@@ -42,8 +42,9 @@ Spec version
Spec version should be correct
Resource Tags
- Specfile Tags Should Be \${3} ?!?!?? a b bar dar
- ... foo Has kw4 tags
+ Specfile Tags Should Be \${3} ?!?!?? a b bar common
+ ... dar foo Has kw4 robot:private
+ ... tag-in-private tags
Resource Has No Inits
Should Have No Init
@@ -59,11 +60,24 @@ Keyword Arguments
Different Argument Types
Keyword Arguments Should Be 2 mandatory optional=default *varargs
- ... kwo=default another **kwargs
+ ... kwo: int = default another **kwargs
Embedded Arguments
Keyword Name Should Be 3 Embedded \${arguments}
Keyword Arguments Should Be 3
+ Keyword Name Should Be 12 With embedded \${arg: int} and normal arg
+ Keyword Arguments Should Be 12 normal
+
+Argument Types
+ Keyword Arguments Should Be 9 a: int b: Literal['R', 'F'] c: int | None = None
+
+Type Docs
+ DataType Standard Should Be 0 integer Conversion is done using
+ Usages Should Be 0 Standard integer Different argument types kw 6
+ DataType Standard Should Be 1 Literal Only specified values are accepted.
+ Usages Should Be 1 Standard Literal kw 6
+ DataType Standard Should Be 2 None String ``NONE`` (case-insensitive) and
+ Usages Should Be 2 Standard None kw 6
Keyword Documentation
Keyword Doc Should Be 0 $\{CURDIR}
@@ -85,7 +99,7 @@ Keyword Documentation
... -------------
...
... | = first = | = second = |
- ... | foo | bar |
+ ... | foo${SPACE*7}|${SPACE*4}bar${SPACE*5}|
Keyword Doc Should Be 9
... Summary line
...
@@ -99,10 +113,10 @@ Deprecation
END
Keyword tags
- Keyword Tags Should Be 6
+ Keyword Tags Should Be 6 common
Keyword Tags Should Be 7 ?!?!?? Has kw4 tags
Keyword Tags Should Be 8 \${3} a b
- Keyword Tags Should Be 9 bar dar foo
+ Keyword Tags Should Be 9 bar common dar foo
Non ASCII
Keyword Doc Should Be 10 Hyvää yötä.\n\nСпаÑибо!
@@ -110,14 +124,19 @@ Non ASCII
Keyword Source Info
Keyword Name Should Be 0 curdir
Keyword Should Not Have Source 0
- Keyword Lineno Should Be 0 65
+ Keyword Lineno Should Be 0 76
'*.resource' extension is accepted
Run Libdoc And Parse Output ${TESTDATADIR}/resource.resource
Source Should Be ${TESTDATADIR}/resource.resource
Lineno Should Be 1
- Keyword Name Should Be 0 Yay, I got new extension!
- Keyword Arguments Should Be 0 Awesome!!
- Keyword Doc Should Be 0 Yeah!!!
- Keyword Should Not Have Source 0
- Keyword Lineno Should Be 0 2
+ Keyword Name Should Be 2 Yay, I got new extension!
+ Keyword Arguments Should Be 2 Awesome!!
+ Keyword Doc Should Be 2 Yeah!!!
+ Keyword Should Not Have Source 2
+ Keyword Lineno Should Be 2 5
+
+Keyword Tags setting
+ Keyword Tags Should Be 0 keyword own tags
+ Keyword Tags Should Be 1 in doc keyword own tags
+ Keyword Tags Should Be 2 keyword tags
diff --git a/atest/robot/libdoc/return_type.robot b/atest/robot/libdoc/return_type.robot
new file mode 100644
index 00000000000..dd0c283d324
--- /dev/null
+++ b/atest/robot/libdoc/return_type.robot
@@ -0,0 +1,49 @@
+*** Settings ***
+Suite Setup Run Libdoc And Parse Output ${TESTDATADIR}/ReturnType.py
+Test Template Return Type Should Be
+Resource libdoc_resource.robot
+
+*** Test Cases ***
+No return
+ 0 None
+
+None return
+ 1 None
+
+Simple return
+ 2 int
+
+Parameterized return
+ 3 List int
+
+Union return
+ 4 Union int float
+
+Stringified return
+ 5 Union int float
+
+Unknown return
+ 6 Unknown
+
+Invalid return
+ [Template] NONE
+ VAR ${error}
+ ... [ ERROR ] Error in library 'ReturnType':
+ ... Adding keyword 'H_invalid_return' failed:
+ ... Parsing type 'list[int' failed:
+ ... Error at end:
+ ... Closing ']' missing.
+ Should Start With ${OUTPUT} ${error}
+
+Return types are in typedocs
+ [Template] Usages Should Be
+ 0 Standard float
+ ... E Union Return
+ ... F Stringified Return
+ 1 Standard integer
+ ... C Simple Return
+ ... D Parameterized Return
+ ... E Union Return
+ ... F Stringified Return
+ 2 Standard list
+ ... D Parameterized Return
diff --git a/atest/robot/libdoc/return_type_json.robot b/atest/robot/libdoc/return_type_json.robot
new file mode 100644
index 00000000000..2a2de45eff5
--- /dev/null
+++ b/atest/robot/libdoc/return_type_json.robot
@@ -0,0 +1,59 @@
+*** Settings ***
+Suite Setup Run Libdoc And Parse Model From JSON ${TESTDATADIR}/ReturnType.py
+Test Template Return type should be
+Resource libdoc_resource.robot
+Test Tags require-jsonschema
+
+*** Test Cases ***
+No return
+ 0 None
+
+None return
+ 1 None
+
+Simple return
+ 2 {'name': 'int', 'typedoc': 'integer', 'nested': [], 'union': False}
+
+Parameterized return
+ 3 {'name': 'List',
+ ... 'typedoc': 'list',
+ ... 'nested': [{'name': 'int', 'typedoc': 'integer', 'nested': [], 'union': False}],
+ ... 'union': False}
+
+Union return
+ 4 {'name': 'Union',
+ ... 'typedoc': None,
+ ... 'nested': [{'name': 'int', 'typedoc': 'integer', 'nested': [], 'union': False},
+ ... {'name': 'float', 'typedoc': 'float', 'nested': [], 'union': False}],
+ ... 'union': True}
+
+Stringified return
+ 5 {'name': 'Union',
+ ... 'typedoc': None,
+ ... 'nested': [{'name': 'int', 'typedoc': 'integer', 'nested': [], 'union': False},
+ ... {'name': 'float', 'typedoc': 'float', 'nested': [], 'union': False}],
+ ... 'union': True}
+
+Unknown return
+ 6 {'name': 'Unknown', 'typedoc': None, 'nested': [], 'union': False}
+
+Return types are in typedocs
+ [Template] Should Be Equal
+ ${MODEL}[typedocs][0][name] float
+ ${MODEL}[typedocs][0][usages][0] E Union Return
+ ${MODEL}[typedocs][0][usages][1] F Stringified Return
+ ${MODEL}[typedocs][1][name] integer
+ ${MODEL}[typedocs][1][usages][0] C Simple Return
+ ${MODEL}[typedocs][1][usages][1] D Parameterized Return
+ ${MODEL}[typedocs][1][usages][2] E Union Return
+ ${MODEL}[typedocs][1][usages][3] F Stringified Return
+ ${MODEL}[typedocs][2][name] list
+ ${MODEL}[typedocs][2][usages][0] D Parameterized Return
+
+*** Keywords ***
+Return type should be
+ [Arguments] ${index} @{expected}
+ VAR ${expected} @{expected}
+ Should Be Equal As Strings
+ ... ${MODEL}[keywords][${index}][returnType]
+ ... ${expected}
diff --git a/atest/robot/libdoc/spec_library.robot b/atest/robot/libdoc/spec_library.robot
index 1d74736c308..be96d7477ba 100644
--- a/atest/robot/libdoc/spec_library.robot
+++ b/atest/robot/libdoc/spec_library.robot
@@ -85,6 +85,16 @@ Keyword Tags
Keyword Tags Should Be 1
Keyword Tags Should Be 2
+Private Keywords
+ Keyword Should Not Be Private 0
+ Keyword Should Be Private 1
+ Keyword Should Not Be Private 2
+
+Keyword Deprecation
+ Keyword Should Not Be Deprecated 0
+ Keyword Should Be Deprecated 1
+ Keyword Should Not Be Deprecated 2
+
Keyword Source Info
Keyword Should Not Have Source 0
Keyword Should Not Have Lineno 0
@@ -98,6 +108,13 @@ Keyword Source Info
Run Libdoc And Parse Output %{TEMPDIR}/Example.libspec
Test Everything
+SOURCE_DATE_EPOCH is honored in Libdoc output
+ [Setup] Set Environment Variable SOURCE_DATE_EPOCH 0
+ Copy File ${TESTDATADIR}/ExampleSpec.xml %{TEMPDIR}/Example.libspec
+ Run Libdoc And Parse Output %{TEMPDIR}/Example.libspec
+ Generated Should Be 1970-01-01T00:00:00+00:00
+ [Teardown] Remove Environment Variable SOURCE_DATE_EPOCH
+
*** Keywords ***
Test Everything
Name Should Be Example
@@ -130,6 +147,12 @@ Test Everything
Keyword Tags Should Be 0 tag1 tag2
Keyword Tags Should Be 1
Keyword Tags Should Be 2
+ Keyword Should Not Be Private 0
+ Keyword Should Be Private 1
+ Keyword Should Not Be Private 2
+ Keyword Should Not Be Deprecated 0
+ Keyword Should Be Deprecated 1
+ Keyword Should Not Be Deprecated 2
Keyword Should Not Have Source 0
Keyword Should Not Have Lineno 0
Keyword Should Not Have Source 1
diff --git a/atest/robot/libdoc/suite_file.robot b/atest/robot/libdoc/suite_file.robot
new file mode 100644
index 00000000000..9de82cc644d
--- /dev/null
+++ b/atest/robot/libdoc/suite_file.robot
@@ -0,0 +1,70 @@
+*** Settings ***
+Suite Setup Run Libdoc And Parse Output ${TESTDATADIR}/suite.robot
+Resource libdoc_resource.robot
+
+*** Test Cases ***
+Name
+ Name Should Be Suite
+
+Documentation
+ Doc Should Be Documentation for keywords in suite ``Suite``.
+
+Version
+ Version Should Be ${EMPTY}
+
+Type
+ Type Should Be SUITE
+
+Generated
+ Generated Should Be Defined
+
+Scope
+ Scope Should Be GLOBAL
+
+Source Info
+ Source Should Be ${TESTDATADIR}/suite.robot
+ Lineno Should Be 1
+
+Spec version
+ Spec version should be correct
+
+Tags
+ Specfile Tags Should Be $\{CURDIR} keyword tags tags
+
+Suite Has No Inits
+ Should Have No Init
+
+Keyword Names
+ Keyword Name Should Be 0 1. Example
+ Keyword Name Should Be 1 2. Keyword with some "stuff" to
+
+Keyword Arguments
+ Keyword Arguments Should Be 0
+ Keyword Arguments Should Be 1 a1 a2=c:\\temp\\
+
+Different Argument Types
+ Keyword Arguments Should Be 2 mandatory optional=default *varargs
+ ... kwo=default another **kwargs
+
+Embedded Arguments
+ Keyword Name Should Be 3 4. Embedded \${arguments}
+ Keyword Arguments Should Be 3
+
+Keyword Documentation
+ Keyword Doc Should Be 0 Keyword doc with $\{CURDIR}.
+ Keyword Doc Should Be 1 foo bar `kw` & some "stuff" to .\n\nbaa `\${a1}`
+ Keyword Doc Should Be 2 Multiple\n\nlines.
+
+Keyword tags
+ Keyword Tags Should Be 0 keyword tags tags
+ Keyword Tags Should Be 1 $\{CURDIR} keyword tags
+
+Non ASCII
+ Keyword Doc Should Be 3 Hyvää yötä. дÑкую!
+
+Keyword Source Info
+ Keyword Should Not Have Source 0
+ Keyword Lineno Should Be 0 10
+
+Test related settings should not cause errors
+ Should Not Contain ${OUTPUT} ERROR
diff --git a/atest/robot/libdoc/suite_init_file.robot b/atest/robot/libdoc/suite_init_file.robot
new file mode 100644
index 00000000000..0d1abb685ea
--- /dev/null
+++ b/atest/robot/libdoc/suite_init_file.robot
@@ -0,0 +1,70 @@
+*** Settings ***
+Suite Setup Run Libdoc And Parse Output ${TESTDATADIR}/__init__.robot
+Resource libdoc_resource.robot
+
+*** Test Cases ***
+Name
+ Name Should Be Libdoc
+
+Documentation
+ Doc Should Be Documentation for keywords in suite ``Libdoc``.
+
+Version
+ Version Should Be ${EMPTY}
+
+Type
+ Type Should Be SUITE
+
+Generated
+ Generated Should Be Defined
+
+Scope
+ Scope Should Be GLOBAL
+
+Source Info
+ Source Should Be ${TESTDATADIR}
+ Lineno Should Be 1
+
+Spec version
+ Spec version should be correct
+
+Tags
+ Specfile Tags Should Be $\{CURDIR} keyword tags tags
+
+Suite Has No Inits
+ Should Have No Init
+
+Keyword Names
+ Keyword Name Should Be 0 1. Example
+ Keyword Name Should Be 1 2. Keyword with some "stuff" to
+
+Keyword Arguments
+ Keyword Arguments Should Be 0
+ Keyword Arguments Should Be 1 a1 a2=c:\\temp\\
+
+Different Argument Types
+ Keyword Arguments Should Be 2 mandatory optional=default *varargs
+ ... kwo=default another **kwargs
+
+Embedded Arguments
+ Keyword Name Should Be 3 4. Embedded \${arguments}
+ Keyword Arguments Should Be 3
+
+Keyword Documentation
+ Keyword Doc Should Be 0 Keyword doc with $\{CURDIR}.
+ Keyword Doc Should Be 1 foo bar `kw` & some "stuff" to .\n\nbaa `\${a1}`
+ Keyword Doc Should Be 2 Multiple\n\nlines.
+
+Keyword tags
+ Keyword Tags Should Be 0 keyword tags tags
+ Keyword Tags Should Be 1 $\{CURDIR} keyword tags
+
+Non ASCII
+ Keyword Doc Should Be 3 Hyvää yötä. дÑкую!
+
+Keyword Source Info
+ Keyword Should Not Have Source 0
+ Keyword Lineno Should Be 0 7
+
+Test related settings should not cause errors
+ Should Not Contain ${OUTPUT} ERROR
diff --git a/atest/robot/libdoc/type_annotations.robot b/atest/robot/libdoc/type_annotations.robot
index e3d8983ec63..2dcb74a947c 100644
--- a/atest/robot/libdoc/type_annotations.robot
+++ b/atest/robot/libdoc/type_annotations.robot
@@ -12,8 +12,7 @@ Enums
... big: Big
With defaults
- Keyword Arguments Should Be 2 integer: int = 42 list_: list | None = None
- ... enum: Small | None = None
+ Keyword Arguments Should Be 2 i: int = 42 t: tuple = () e: Small = one
Keyword-only arguments
Keyword Arguments Should Be 3 * kwo: int with_default: str = value
@@ -22,7 +21,7 @@ Varargs and kwargs
Keyword Arguments Should Be 4 *varargs: int **kwargs: bool
Unknown types
- Keyword Arguments Should Be 5 unknown: UnknownType unrecognized: Ellipsis
+ Keyword Arguments Should Be 5 unknown: UnknownType unrecognized: ...
Non-type annotations
Keyword Arguments Should Be 6 arg: One of the usages in PEP-3107
@@ -33,9 +32,19 @@ Drop `typing.` prefix
Union from typing
Keyword Arguments Should Be 8 a: int | str | list | tuple
- Keyword Arguments Should Be 9 a: int | str | list | tuple | None = None
+ Keyword Arguments Should Be 9 a: int | str | list | None = None
+
+Nested
+ Keyword Arguments Should Be 10 a: List[int] b: List[int | float] c: Tuple[Tuple[UnknownType], Dict[str, Tuple[float]]]
+
+
+Literal
+ Keyword Arguments Should Be 11 a: Literal['on', 'off', 'int'] b: Literal[1, 2, 3] c: Literal[one, True, None]
+
+Secret type
+ Keyword Arguments Should Be 12 token: Secret
Union syntax
[Tags] require-py3.10
- Keyword Arguments Should Be 10 a: int | str | list | tuple
- Keyword Arguments Should Be 11 a: int | str | list | tuple | None = None
+ Keyword Arguments Should Be 13 a: int | str | list | tuple
+ Keyword Arguments Should Be 14 a: int | str | list | None = None
diff --git a/atest/robot/libdoc/types_via_keyword_decorator.robot b/atest/robot/libdoc/types_via_keyword_decorator.robot
index 3d9576da3d8..8f0c9ebf8ac 100644
--- a/atest/robot/libdoc/types_via_keyword_decorator.robot
+++ b/atest/robot/libdoc/types_via_keyword_decorator.robot
@@ -13,7 +13,7 @@ Varargs and kwargs
Keyword Arguments Should Be 2 *varargs: int **kwargs: bool
Unknown types
- Keyword Arguments Should Be 3 unknown: UnknownType unrecognized: Ellipsis
+ Keyword Arguments Should Be 3 unknown: UnknownType unrecognized: ...
Non-type annotations
Keyword Arguments Should Be 4 arg: One of the usages in PEP-3107
@@ -21,3 +21,11 @@ Non-type annotations
Keyword-only arguments
Keyword Arguments Should Be 5 * kwo: int with_default: str = value
+
+Return type
+ Keyword Arguments Should Be 6
+ Return Type Should Be 6 int
+
+Return type as tuple
+ Keyword Arguments Should Be 7 arg: int
+ Return Type Should Be 7 Union int float
diff --git a/atest/robot/output/LegacyOutputHelper.py b/atest/robot/output/LegacyOutputHelper.py
new file mode 100644
index 00000000000..f9e558a5ccf
--- /dev/null
+++ b/atest/robot/output/LegacyOutputHelper.py
@@ -0,0 +1,13 @@
+import re
+
+
+def mask_changing_parts(path):
+ with open(path, encoding="UTF-8") as file:
+ content = file.read()
+ for pattern, replace in [
+ (r'"20\d{6} \d{2}:\d{2}:\d{2}\.\d{3}"', '"[timestamp]"'),
+ (r'generator=".*?"', 'generator="[generator]"'),
+ (r'source=".*?"', 'source="[source]"'),
+ ]:
+ content = re.sub(pattern, replace, content)
+ return content
diff --git a/atest/robot/output/LogDataFinder.py b/atest/robot/output/LogDataFinder.py
index 18f11d08051..98d731cf595 100644
--- a/atest/robot/output/LogDataFinder.py
+++ b/atest/robot/output/LogDataFinder.py
@@ -26,25 +26,27 @@ def get_all_stats(path):
def _get_output_line(path, prefix):
- logger.info("Getting '%s' from '%s'."
- % (prefix, path, path), html=True)
- prefix += ' = '
- with open(path, encoding='UTF-8') as file:
+ logger.info(
+ f"Getting '{prefix}' from '{path}'.",
+ html=True,
+ )
+ prefix += " = "
+ with open(path, encoding="UTF-8") as file:
for line in file:
if line.startswith(prefix):
- logger.info('Found: %s' % line)
- return line[len(prefix):-2]
+ logger.info(f"Found: {line}")
+ return line[len(prefix) : -2]
def verify_stat(stat, *attrs):
- stat.pop('elapsed')
+ stat.pop("elapsed")
expected = dict(_get_expected_stat(attrs))
if stat != expected:
- raise WrongStat('\n%-9s: %s\n%-9s: %s' % ('Got', stat, 'Expected', expected))
+ raise WrongStat(f"\nGot : {stat}\nExpected : {expected}")
def _get_expected_stat(attrs):
- for key, value in (a.split(':', 1) for a in attrs):
+ for key, value in (a.split(":", 1) for a in attrs):
value = int(value) if value.isdigit() else str(value)
yield str(key), value
diff --git a/atest/robot/output/expand_keywords.robot b/atest/robot/output/expand_keywords.robot
index 931b4283e9f..475584c25ca 100644
--- a/atest/robot/output/expand_keywords.robot
+++ b/atest/robot/output/expand_keywords.robot
@@ -34,13 +34,18 @@ Tag as pattern
Keywords with skip status are expanded
s1-s9-t1-k2 s1-s9-t2-k2-k1 # NAME:BuiltIn.Skip
+Keywords with fail status are expanded
+ [Documentation] Expanding happens regardless is test skipped or not.
+ s1-s1-t2-k2 s1-s2-t7-k1 s1-s7-t1-k1-k1-k1-k1-k1-k1 # NAME:BuiltIn.Fail
+
*** Keywords ***
Run tests with expanding
${options} = Catenate
... --log log.html
+ ... --skiponfailure fail
... --expandkeywords name:MyKeyword
... --ExpandKeywords NAME:BuiltIn.Sleep
- ... --ExpandKeywords NAME:BuiltIn.Fail # Failed and not run keywords aren't expanded so this doesn't match anything.
+ ... --ExpandKeywords NAME:BuiltIn.Fail
... --ExpandKeywords NAME:BuiltIn.Skip
... --expand "Name:???-Ä* K?ywörd Näm?"
... --expandkeywords name:
diff --git a/atest/robot/output/flatten_keyword.robot b/atest/robot/output/flatten_keyword.robot
deleted file mode 100644
index 08b41ff7ef5..00000000000
--- a/atest/robot/output/flatten_keyword.robot
+++ /dev/null
@@ -1,175 +0,0 @@
-*** Settings ***
-Suite Setup Run And Rebot Flattened
-Resource atest_resource.robot
-
-*** Variables ***
-${FLATTEN} --FlattenKeywords NAME:Keyword3
-... --flat name:key*others
-... --FLAT name:builtin.*
-... --flat TAG:flattenNOTkitty
-... --flatten "name:Flatten controls in keyword"
-... --log log.html
-${FLAT TEXT} _*Content flattened.*_
-${FLAT HTML}
Content flattened.\\x3c/b>\\x3c/i>\\x3c/p>
-${ERROR} [ ERROR ] Invalid value for option '--flattenkeywords': Expected 'FOR', 'WHILE', 'ITERATION', 'TAG:' or 'NAME:', got 'invalid'.${USAGE TIP}\n
-
-*** Test Cases ***
-Non-matching keyword is not flattened
- Should Be Equal ${TC.kws[0].doc} Doc of keyword 2
- Length Should Be ${TC.kws[0].kws} 2
- Length Should Be ${TC.kws[0].msgs} 0
- Check Log Message ${TC.kws[0].kws[0].msgs[0]} 2
- Check Log Message ${TC.kws[0].kws[1].kws[0].msgs[0]} 1
-
-Exact match
- Should Be Equal ${TC.kws[1].doc} Doc of keyword 3\n\n${FLAT TEXT}
- Length Should Be ${TC.kws[1].kws} 0
- Length Should Be ${TC.kws[1].msgs} 3
- Check Log Message ${TC.kws[1].msgs[0]} 3
- Check Log Message ${TC.kws[1].msgs[1]} 2
- Check Log Message ${TC.kws[1].msgs[2]} 1
-
-Pattern match
- Should Be Equal ${TC.kws[2].doc} ${FLAT TEXT}
- Length Should Be ${TC.kws[2].kws} 0
- Length Should Be ${TC.kws[2].msgs} 6
- Check Log Message ${TC.kws[2].msgs[0]} 3
- Check Log Message ${TC.kws[2].msgs[1]} 2
- Check Log Message ${TC.kws[2].msgs[2]} 1
- Check Log Message ${TC.kws[2].msgs[3]} 2
- Check Log Message ${TC.kws[2].msgs[4]} 1
- Check Log Message ${TC.kws[2].msgs[5]} 1
-
-Tag match when keyword has documentation
- Should Be Equal ${TC.kws[5].doc} Doc of flat keyword.\n\n${FLAT TEXT}
- Length Should Be ${TC.kws[5].kws} 0
- Length Should Be ${TC.kws[5].msgs} 1
-
-Tag match when keyword has no documentation
- Should Be Equal ${TC.kws[6].doc} ${FLAT TEXT}
- Length Should Be ${TC.kws[6].kws} 0
- Length Should Be ${TC.kws[6].msgs} 1
-
-Match full name
- Should Be Equal ${TC.kws[3].doc} Logs the given message with the given level.\n\n${FLAT TEXT}
- Length Should Be ${TC.kws[3].kws} 0
- Length Should Be ${TC.kws[3].msgs} 1
- Check Log Message ${TC.kws[3].msgs[0]} Flatten me too!!
-
-Flattened in log after execution
- Should Contain X Times ${LOG} Doc of keyword 3 1
- Should Contain X Times ${LOG} Doc of keyword 2 1
- Should Contain X Times ${LOG} Doc of keyword 1 1
- Should Contain X Times ${LOG} ${FLAT HTML} 6
- Should Contain ${LOG} *
Doc of keyword 3\\x3c/p>\\n${FLAT HTML}
- Should Contain ${LOG} *${FLAT HTML}
- Should Contain ${LOG} *
Logs the given message with the given level.\\x3c/p>\\n${FLAT HTML}
-
-Flatten controls in keyword
- ${tc} = Check Test Case ${TEST NAME}
- Length Should Be ${tc.body[0].body.filter(messages=False)} 0
- Length Should Be ${tc.body[0].body.filter(messages=True)} 23
- Length Should Be ${tc.body[0].body} 23
- @{expected} = Create List
- ... Outside IF Inside IF 1 Nested IF
- ... 3 2 1 BANG!
- ... FOR: 0 1 FOR: 1 1 FOR: 2 1
- ... WHILE: 2 1 \${i} = 1 WHILE: 1 1 \${i} = 0
- FOR ${msg} ${exp} IN ZIP ${tc.body[0].body} ${expected}
- Check Log Message ${msg} ${exp}
- END
- Check log message ${tc.body[0].body[20]} AssertionError level=FAIL
- Check log message ${tc.body[0].body[21]} 1
- Check log message ${tc.body[0].body[22]} finally
-
-Flatten for loops
- Run Rebot --flatten For ${OUTFILE COPY}
- ${tc} = Check Test Case For loop
- Should Be Equal ${tc.kws[0].type} FOR
- Should Be Equal ${tc.kws[0].doc} ${FLAT TEXT}
- Length Should Be ${tc.kws[0].kws} 0
- Length Should Be ${tc.kws[0].msgs} 60
- FOR ${index} IN RANGE 10
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 0}]} index: ${index}
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 1}]} 3
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 2}]} 2
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 3}]} 1
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 4}]} 2
- Check Log Message ${tc.kws[0].msgs[${index * 6 + 5}]} 1
- END
-
-Flatten for loop iterations
- Run Rebot --flatten ForItem ${OUTFILE COPY}
- ${tc} = Check Test Case For loop
- Should Be Equal ${tc.kws[0].type} FOR
- Should Be Empty ${tc.kws[0].doc}
- Length Should Be ${tc.kws[0].kws} 10
- Should Be Empty ${tc.kws[0].msgs}
- FOR ${index} IN RANGE 10
- Should Be Equal ${tc.kws[0].kws[${index}].type} ITERATION
- Should Be Equal ${tc.kws[0].kws[${index}].doc} ${FLAT TEXT}
- Should Be Empty ${tc.kws[0].kws[${index}].kws}
- Length Should Be ${tc.kws[0].kws[${index}].msgs} 6
- Check Log Message ${tc.kws[0].kws[${index}].msgs[0]} index: ${index}
- Check Log Message ${tc.kws[0].kws[${index}].msgs[1]} 3
- Check Log Message ${tc.kws[0].kws[${index}].msgs[2]} 2
- Check Log Message ${tc.kws[0].kws[${index}].msgs[3]} 1
- Check Log Message ${tc.kws[0].kws[${index}].msgs[4]} 2
- Check Log Message ${tc.kws[0].kws[${index}].msgs[5]} 1
- END
-
-Flatten while loops
- Run Rebot --flatten WHile ${OUTFILE COPY}
- ${tc} = Check Test Case WHILE loop
- Should Be Equal ${tc.body[1].type} WHILE
- Should Be Equal ${tc.body[1].doc} ${FLAT TEXT}
- Length Should Be ${tc.body[1].kws} 0
- Length Should Be ${tc.body[1].msgs} 70
- FOR ${index} IN RANGE 10
- Check Log Message ${tc.body[1].msgs[${index * 7 + 0}]} index: ${index}
- Check Log Message ${tc.body[1].msgs[${index * 7 + 1}]} 3
- Check Log Message ${tc.body[1].msgs[${index * 7 + 2}]} 2
- Check Log Message ${tc.body[1].msgs[${index * 7 + 3}]} 1
- Check Log Message ${tc.body[1].msgs[${index * 7 + 4}]} 2
- Check Log Message ${tc.body[1].msgs[${index * 7 + 5}]} 1
- ${i}= Evaluate $index + 1
- Check Log Message ${tc.body[1].msgs[${index * 7 + 6}]} \${i} = ${i}
- END
-
-Flatten while loop iterations
- Run Rebot --flatten iteration ${OUTFILE COPY}
- ${tc} = Check Test Case WHILE loop
- Should Be Equal ${tc.body[1].type} WHILE
- Should Be Empty ${tc.body[1].doc}
- Length Should Be ${tc.body[1].body} 10
- Should Be Empty ${tc.body[1].msgs}
- FOR ${index} IN RANGE 10
- Should Be Equal ${tc.kws[1].kws[${index}].type} ITERATION
- Should Be Equal ${tc.kws[1].kws[${index}].doc} ${FLAT TEXT}
- Should Be Empty ${tc.kws[1].kws[${index}].kws}
- Length Should Be ${tc.kws[1].kws[${index}].msgs} 7
- Check Log Message ${tc.kws[1].kws[${index}].msgs[0]} index: ${index}
- Check Log Message ${tc.kws[1].kws[${index}].msgs[1]} 3
- Check Log Message ${tc.kws[1].kws[${index}].msgs[2]} 2
- Check Log Message ${tc.kws[1].kws[${index}].msgs[3]} 1
- Check Log Message ${tc.kws[1].kws[${index}].msgs[4]} 2
- Check Log Message ${tc.kws[1].kws[${index}].msgs[5]} 1
- ${i}= Evaluate $index + 1
- Check Log Message ${tc.kws[1].kws[${index}].msgs[6]} \${i} = ${i}
- END
-
-Invalid usage
- Run Rebot Without Processing Output ${FLATTEN} --FlattenKeywords invalid ${OUTFILE COPY}
- Stderr Should Be Equal To ${ERROR}
- Run Tests Without Processing Output ${FLATTEN} --FlattenKeywords invalid output/flatten_keywords.robot
- Stderr Should Be Equal To ${ERROR}
-
-*** Keywords ***
-Run And Rebot Flattened
- Run Tests Without Processing Output ${FLATTEN} output/flatten_keywords.robot
- ${LOG} = Get File ${OUTDIR}/log.html
- Set Suite Variable $LOG
- Copy Previous Outfile
- Run Rebot ${FLATTEN} ${OUTFILE COPY}
- ${TC} = Check Test Case Flatten stuff
- Set Suite Variable $TC
diff --git a/atest/robot/output/flatten_keywords.robot b/atest/robot/output/flatten_keywords.robot
new file mode 100644
index 00000000000..fa66e863a4b
--- /dev/null
+++ b/atest/robot/output/flatten_keywords.robot
@@ -0,0 +1,279 @@
+*** Settings ***
+Suite Setup Run And Rebot Flattened
+Resource atest_resource.robot
+
+*** Variables ***
+${FLATTEN} --FlattenKeywords NAME:Keyword3
+... --flat name:key*others
+... --FLAT name:builtin.*
+... --flat TAG:flattenNOTkitty
+... --flatten "name:Flatten controls in keyword"
+${FLATTENED} Content flattened.
+${ERROR} [ ERROR ] Invalid value for option '--flattenkeywords': Expected 'FOR', 'WHILE', 'ITERATION', 'TAG:' or 'NAME:', got 'invalid'.${USAGE TIP}\n
+
+*** Test Cases ***
+Non-matching keyword is not flattened
+ Should Be Equal ${TC[0].message} ${EMPTY}
+ Should Be Equal ${TC[0].doc} Doc of keyword 2
+ Should Have Tags ${TC[0]} kw2
+ Should Be Equal ${TC[0].timeout} 2 minutes
+ Check Counts ${TC[0]} 0 2
+ Check Log Message ${TC[0, 0, 0]} 2
+ Check Log Message ${TC[0, 1, 1, 0]} 1
+
+Exact match
+ Should Be Equal ${TC[1].message} *HTML* ${FLATTENED}
+ Should Be Equal ${TC[1].doc} Doc of keyword 3
+ Should Have Tags ${TC[1]} kw3
+ Should Be Equal ${TC[1].timeout} 3 minutes
+ Check Counts ${TC[1]} 3
+ Check Log Message ${TC[1, 0]} 3
+ Check Log Message ${TC[1, 1]} 2
+ Check Log Message ${TC[1, 2]} 1
+
+Pattern match
+ Should Be Equal ${TC[2].message} *HTML* ${FLATTENED}
+ Should Be Equal ${TC[2].doc} ${EMPTY}
+ Should Have Tags ${TC[2]}
+ Should Be Equal ${TC[2].timeout} ${NONE}
+ Check Counts ${TC[2]} 6
+ Check Log Message ${TC[2, 0]} 3
+ Check Log Message ${TC[2, 1]} 2
+ Check Log Message ${TC[2, 2]} 1
+ Check Log Message ${TC[2, 3]} 2
+ Check Log Message ${TC[2, 4]} 1
+ Check Log Message ${TC[2, 5]} 1
+
+Tag match when keyword has no message
+ Should Be Equal ${TC[5].message} *HTML* ${FLATTENED}
+ Should Be Equal ${TC[5].doc} ${EMPTY}
+ Should Have Tags ${TC[5]} flatten hi
+ Check Counts ${TC[5]} 1
+
+Tag match when keyword has message
+ Should Be Equal ${TC[6].message} *HTML* Expected e&<aped failure!${FLATTENED}
+ Should Be Equal ${TC[6].doc} Doc of flat keyword.
+ Should Have Tags ${TC[6]} flatten hello
+ Check Counts ${TC[6]} 1
+
+Match full name
+ Should Be Equal ${TC[3].message} *HTML* ${FLATTENED}
+ Should Be Equal ${TC[3].doc} Logs the given message with the given level.
+ Check Counts ${TC[3]} 1
+ Check Log Message ${TC[3, 0]} Flatten me too!!
+
+Flattened in log after execution
+ Should Contain ${LOG} "*Content flattened."
+
+Flatten controls in keyword
+ ${tc} = Check Test Case ${TEST NAME}
+ @{expected} = Create List
+ ... Outside IF Inside IF 1 Nested IF
+ ... 3 2 1 BANG!
+ ... FOR: 0 1 FOR: 1 1 FOR: 2 1
+ ... WHILE: 2 1 \${i} = 1 WHILE: 1 1 \${i} = 0
+ ... AssertionError 1 finally
+ ... Inside GROUP \${x} = Using VAR
+ FOR ${msg} ${exp} IN ZIP ${tc[0].body} ${expected} mode=STRICT
+ Check Log Message ${msg} ${exp} level=IGNORE
+ END
+
+Flatten FOR
+ Run Rebot --flatten For ${OUTFILE COPY}
+ ${tc} = Check Test Case FOR loop
+ Should Be Equal ${tc[0].type} FOR
+ Should Be Equal ${tc[0].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[0]} 60
+ FOR ${index} IN RANGE 10
+ Check Log Message ${tc[0, ${index * 6 + 0}]} index: ${index}
+ Check Log Message ${tc[0, ${index * 6 + 1}]} 3
+ Check Log Message ${tc[0, ${index * 6 + 2}]} 2
+ Check Log Message ${tc[0, ${index * 6 + 3}]} 1
+ Check Log Message ${tc[0, ${index * 6 + 4}]} 2
+ Check Log Message ${tc[0, ${index * 6 + 5}]} 1
+ END
+
+Flatten FOR iterations
+ Run Rebot --flatten ForItem ${OUTFILE COPY}
+ ${tc} = Check Test Case FOR loop
+ Should Be Equal ${tc[0].type} FOR
+ Should Be Equal ${tc[0].message} ${EMPTY}
+ Check Counts ${tc[0]} 0 10
+ FOR ${index} IN RANGE 10
+ Should Be Equal ${tc[0, ${index}].type} ITERATION
+ Should Be Equal ${tc[0, ${index}].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[0, ${index}]} 6
+ Check Log Message ${tc[0, ${index}, 0]} index: ${index}
+ Check Log Message ${tc[0, ${index}, 1]} 3
+ Check Log Message ${tc[0, ${index}, 2]} 2
+ Check Log Message ${tc[0, ${index}, 3]} 1
+ Check Log Message ${tc[0, ${index}, 4]} 2
+ Check Log Message ${tc[0, ${index}, 5]} 1
+ END
+
+Flatten WHILE
+ Run Rebot --flatten WHile ${OUTFILE COPY}
+ ${tc} = Check Test Case WHILE loop
+ Should Be Equal ${tc[1].type} WHILE
+ Should Be Equal ${tc[1].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[1]} 70
+ FOR ${index} IN RANGE 10
+ Check Log Message ${tc[1, ${index * 7 + 0}]} index: ${index}
+ Check Log Message ${tc[1, ${index * 7 + 1}]} 3
+ Check Log Message ${tc[1, ${index * 7 + 2}]} 2
+ Check Log Message ${tc[1, ${index * 7 + 3}]} 1
+ Check Log Message ${tc[1, ${index * 7 + 4}]} 2
+ Check Log Message ${tc[1, ${index * 7 + 5}]} 1
+ ${i}= Evaluate $index + 1
+ Check Log Message ${tc[1, ${index * 7 + 6}]} \${i} = ${i}
+ END
+
+Flatten WHILE iterations
+ Run Rebot --flatten iteration ${OUTFILE COPY}
+ ${tc} = Check Test Case WHILE loop
+ Should Be Equal ${tc[1].type} WHILE
+ Should Be Equal ${tc[1].message} ${EMPTY}
+ Check Counts ${tc[1]} 0 10
+ FOR ${index} IN RANGE 10
+ Should Be Equal ${tc[1, ${index}].type} ITERATION
+ Should Be Equal ${tc[1, ${index}].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[1, ${index}]} 7
+ Check Log Message ${tc[1, ${index}, 0]} index: ${index}
+ Check Log Message ${tc[1, ${index}, 1]} 3
+ Check Log Message ${tc[1, ${index}, 2]} 2
+ Check Log Message ${tc[1, ${index}, 3]} 1
+ Check Log Message ${tc[1, ${index}, 4]} 2
+ Check Log Message ${tc[1, ${index}, 5]} 1
+ ${i}= Evaluate $index + 1
+ Check Log Message ${tc[1, ${index}, 6]} \${i} = ${i}
+ END
+
+Flatten with JSON
+ GROUP Run tests
+ VAR ${flatten}
+ ... --flattenkeywords name:Keyword3
+ ... --flatten-keywords tag:flattenNOTkitty
+ ... --flatten FOR
+ ... --flatten WHILE
+ Run Tests Without Processing Output ${flatten} --output output.json --log log.html output/flatten_keywords.robot
+ END
+ GROUP Check flattening in log after afecution.
+ ${log} = Get File ${OUTDIR}/log.html
+ Should Contain ${log} "*Content flattened."
+ END
+ GROUP Run Rebot
+ Copy File ${OUTDIR}/output.json %{TEMPDIR}/output.json
+ Run Rebot ${flatten} %{TEMPDIR}/output.json
+ END
+ GROUP Check flattening by keyword name and tags
+ ${tc} = Check Test Case Flatten stuff
+ Should Be Equal ${tc[0].message} ${EMPTY}
+ Should Be Equal ${tc[0].doc} Doc of keyword 2
+ Should Have Tags ${tc[0]} kw2
+ Should Be Equal ${tc[0].timeout} 2 minutes
+ Check Counts ${tc[0]} 0 2
+ Check Log Message ${tc[0, 0, 0]} 2
+ Check Log Message ${tc[0, 1, 1, 0]} 1
+ Should Be Equal ${tc[1].message} *HTML* ${FLATTENED}
+ Should Be Equal ${tc[1].doc} Doc of keyword 3
+ Should Have Tags ${tc[1]} kw3
+ Should Be Equal ${tc[1].timeout} 3 minutes
+ Check Counts ${tc[1]} 3
+ Check Log Message ${tc[1, 0]} 3
+ Check Log Message ${tc[1, 1]} 2
+ Check Log Message ${tc[1, 2]} 1
+ Should Be Equal ${tc[5].message} *HTML* ${FLATTENED}
+ Should Be Equal ${tc[5].doc} ${EMPTY}
+ Should Have Tags ${tc[5]} flatten hi
+ Check Counts ${tc[5]} 1
+ Should Be Equal ${tc[6].message} *HTML* Expected e&<aped failure!${FLATTENED}
+ Should Be Equal ${tc[6].doc} Doc of flat keyword.
+ Should Have Tags ${tc[6]} flatten hello
+ Check Counts ${tc[6]} 1
+ END
+ GROUP Check flattening FOR loop
+ ${tc} = Check Test Case FOR loop
+ Should Be Equal ${tc[0].type} FOR
+ Should Be Equal ${tc[0].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[0]} 60
+ FOR ${index} IN RANGE 10
+ Check Log Message ${tc[0, ${index * 6 + 0}]} index: ${index}
+ Check Log Message ${tc[0, ${index * 6 + 1}]} 3
+ Check Log Message ${tc[0, ${index * 6 + 2}]} 2
+ Check Log Message ${tc[0, ${index * 6 + 3}]} 1
+ Check Log Message ${tc[0, ${index * 6 + 4}]} 2
+ Check Log Message ${tc[0, ${index * 6 + 5}]} 1
+ END
+ END
+ GROUP Check flattening WHILE loop
+ ${tc} = Check Test Case WHILE loop
+ Should Be Equal ${tc[1].type} WHILE
+ Should Be Equal ${tc[1].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[1]} 70
+ FOR ${index} IN RANGE 10
+ Check Log Message ${tc[1, ${index * 7 + 0}]} index: ${index}
+ Check Log Message ${tc[1, ${index * 7 + 1}]} 3
+ Check Log Message ${tc[1, ${index * 7 + 2}]} 2
+ Check Log Message ${tc[1, ${index * 7 + 3}]} 1
+ Check Log Message ${tc[1, ${index * 7 + 4}]} 2
+ Check Log Message ${tc[1, ${index * 7 + 5}]} 1
+ ${i}= Evaluate $index + 1
+ Check Log Message ${tc[1, ${index * 7 + 6}]} \${i} = ${i}
+ END
+ END
+ GROUP Check flattening FOR and WHILE iterations
+ Run Rebot --flatten ITERATION %{TEMPDIR}/output.json
+ ${tc} = Check Test Case FOR loop
+ Should Be Equal ${tc[0].type} FOR
+ Should Be Equal ${tc[0].message} ${EMPTY}
+ Check Counts ${tc[0]} 0 10
+ FOR ${index} IN RANGE 10
+ Should Be Equal ${tc[0, ${index}].type} ITERATION
+ Should Be Equal ${tc[0, ${index}].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[0, ${index}]} 6
+ Check Log Message ${tc[0, ${index}, 0]} index: ${index}
+ Check Log Message ${tc[0, ${index}, 1]} 3
+ Check Log Message ${tc[0, ${index}, 2]} 2
+ Check Log Message ${tc[0, ${index}, 3]} 1
+ Check Log Message ${tc[0, ${index}, 4]} 2
+ Check Log Message ${tc[0, ${index}, 5]} 1
+ END
+ ${tc} = Check Test Case WHILE loop
+ Should Be Equal ${tc[1].type} WHILE
+ Should Be Equal ${tc[1].message} ${EMPTY}
+ Check Counts ${tc[1]} 0 10
+ FOR ${index} IN RANGE 10
+ Should Be Equal ${tc[1, ${index}].type} ITERATION
+ Should Be Equal ${tc[1, ${index}].message} *HTML* ${FLATTENED}
+ Check Counts ${tc[1, ${index}]} 7
+ Check Log Message ${tc[1, ${index}, 0]} index: ${index}
+ Check Log Message ${tc[1, ${index}, 1]} 3
+ Check Log Message ${tc[1, ${index}, 2]} 2
+ Check Log Message ${tc[1, ${index}, 3]} 1
+ Check Log Message ${tc[1, ${index}, 4]} 2
+ Check Log Message ${tc[1, ${index}, 5]} 1
+ ${i}= Evaluate $index + 1
+ Check Log Message ${tc[1, ${index}, 6]} \${i} = ${i}
+ END
+ END
+
+Invalid usage
+ Run Rebot Without Processing Output ${FLATTEN} --FlattenKeywords invalid ${OUTFILE COPY}
+ Stderr Should Be Equal To ${ERROR}
+ Run Tests Without Processing Output ${FLATTEN} --FlattenKeywords invalid output/flatten_keywords.robot
+ Stderr Should Be Equal To ${ERROR}
+
+*** Keywords ***
+Run And Rebot Flattened
+ Run Tests Without Processing Output ${FLATTEN} --log log.html output/flatten_keywords.robot
+ ${LOG} = Get File ${OUTDIR}/log.html
+ Set Suite Variable $LOG
+ Copy Previous Outfile
+ Run Rebot ${FLATTEN} ${OUTFILE COPY}
+ ${TC} = Check Test Case Flatten stuff
+ Set Suite Variable $TC
+
+Check Counts
+ [Arguments] ${item} ${messages} ${non_messages}=0
+ Length Should Be ${item.messages} ${messages}
+ Length Should Be ${item.non_messages} ${non_messages}
diff --git a/atest/robot/output/js_model.robot b/atest/robot/output/js_model.robot
index 9c63ece6380..bfdb0d6e3c2 100644
--- a/atest/robot/output/js_model.robot
+++ b/atest/robot/output/js_model.robot
@@ -44,4 +44,4 @@ Get JS model
${file} = Get File ${OUTDIR}/${type}.html
${strings} = Get Lines Matching Pattern ${file} window.output?"strings"?*
${settings} = Get Lines Matching Pattern ${file} window.settings =*
- [Return] ${strings} ${settings}
+ RETURN ${strings} ${settings}
diff --git a/atest/robot/output/json_output.robot b/atest/robot/output/json_output.robot
new file mode 100644
index 00000000000..03f09aa4de8
--- /dev/null
+++ b/atest/robot/output/json_output.robot
@@ -0,0 +1,42 @@
+*** Settings ***
+Documentation JSON output is tested in detailed level using unit tests.
+Resource atest_resource.robot
+
+*** Variables ***
+${JSON} %{TEMPDIR}/output.json
+${XML} %{TEMPDIR}/output.xml
+
+*** Test Cases ***
+JSON output contains same suite information as XML output
+ Run Tests ${EMPTY} misc
+ Copy File ${OUTFILE} ${XML}
+ Run Tests Without Processing Output -o ${JSON} misc
+ Outputs Should Contain Same Data ${JSON} ${XML} ignore_timestamps=True
+
+JSON output structure
+ [Documentation] Full JSON schema validation would be good, but it's too slow with big output files.
+ ... The test after this one validates a smaller suite against a schema.
+ ${data} = Evaluate json.load(open($JSON, encoding='UTF-8'))
+ Lists Should Be Equal ${data} ${{['generator', 'generated', 'rpa', 'suite', 'statistics', 'errors']}}
+ Should Match ${data}[generator] Robot ?.* (* on *)
+ Should Match ${data}[generated] 20??-??-??T??:??:??.??????
+ Should Be Equal ${data}[rpa] ${False}
+ Should Be Equal ${data}[suite][name] Misc
+ Should Be Equal ${data}[suite][suites][2][name] Everything
+ Should Be Equal ${data}[statistics][total][skip] ${3}
+ Should Be Equal ${data}[statistics][tags][4][label] f1
+ Should Be Equal ${data}[statistics][suites][-1][id] s1-s18
+ Should Be Equal ${data}[errors][0][level] ERROR
+
+JSON output matches schema
+ [Tags] require-jsonschema
+ Run Tests Without Processing Output -o OUT.JSON misc/everything.robot
+ Validate JSON Output ${OUTDIR}/OUT.JSON
+
+Invalid JSON output file
+ ${path} = Normalize Path ${JSON}
+ Remove File ${path}
+ Create Directory ${path}
+ Run Tests Without Processing Output -o ${path} misc/pass_and_fail.robot
+ Stderr Should Match [[] ERROR ] Opening output file '${path}' failed: *${USAGE TIP}\n
+ [Teardown] Remove Directory ${JSON}
diff --git a/atest/robot/output/legacy_output.robot b/atest/robot/output/legacy_output.robot
new file mode 100644
index 00000000000..017cf0cc68a
--- /dev/null
+++ b/atest/robot/output/legacy_output.robot
@@ -0,0 +1,28 @@
+*** Settings ***
+Library LegacyOutputHelper.py
+Resource atest_resource.robot
+
+*** Test Cases ***
+Legacy output with Robot
+ Run Tests --legacyoutput output/legacy.robot validate output=False
+ Validate output
+
+Legacy output with Rebot
+ Run Tests ${EMPTY} output/legacy.robot
+ Copy Previous Outfile
+ Run Rebot --legacy-output ${OUTFILE COPY} validate output=False
+ Validate output
+
+Legacy output with Rebot when all times are not set
+ Run Rebot --legacy-output --test Passing ${OUTFILE COPY} validate output=False
+ Should Be Equal ${SUITE.start_time} ${None}
+ Should Be Equal ${SUITE.end_time} ${None}
+ Should Contain Tests ${SUITE} Passing
+
+*** Keywords ***
+Validate output
+ Should Contain Tests ${SUITE} Passing Failing Failing setup
+ ... Failing teardown Controls Embedded Warning
+ ${output} = Mask Changing Parts ${OUTFILE}
+ ${expected} = Mask Changing Parts ${DATADIR}/output/legacy.xml
+ Elements Should Be Equal ${output} ${expected} sort_children=True
diff --git a/atest/robot/output/listener_interface/body_items_v3.robot b/atest/robot/output/listener_interface/body_items_v3.robot
new file mode 100644
index 00000000000..fab0a6ee538
--- /dev/null
+++ b/atest/robot/output/listener_interface/body_items_v3.robot
@@ -0,0 +1,75 @@
+*** Settings ***
+Suite Setup Run Tests --listener ${DATADIR}/${MODIFIER} ${SOURCE}
+Resource atest_resource.robot
+
+*** Variables ***
+${SOURCE} output/listener_interface/body_items_v3/tests.robot
+${MODIFIER} output/listener_interface/body_items_v3/Modifier.py
+@{ALL TESTS} Library keyword User keyword Non-existing keyword
+... Empty keyword Duplicate keyword Invalid keyword
+... IF TRY FOR WHILE WHILE with modified limit VAR RETURN
+... Invalid syntax Run Keyword
+
+*** Test Cases ***
+Modify library keyword
+ Check Test Case Library keyword FAIL Expected state to be 'initial', but it was 'set by listener'.
+
+Modify user keyword
+ Check Test Case User keyword FAIL Failed by listener once!
+ Check Test Case Empty keyword PASS ${EMPTY}
+
+Modify invalid keyword
+ Check Test Case Non-existing keyword PASS ${EMPTY}
+ Check Test Case Duplicate keyword PASS ${EMPTY}
+ Check Test Case Invalid keyword PASS ${EMPTY}
+
+Modify keyword results
+ ${tc} = Get Test Case Invalid keyword
+ Check Keyword Data ${tc[0]} Invalid keyword
+ ... args=\${secret}
+ ... tags=end, fixed, start
+ ... doc=Results can be modified both in start and end!
+
+Modify FOR
+ ${tc} = Check Test Case FOR FAIL Listener failed me at 'b'!
+ Length Should Be ${tc[0].body} 2
+ Should Be Equal ${tc[0].assign}[0] secret
+ Should Be Equal ${tc[0, 0].assign}[\${x}] xxx
+ Should Be Equal ${tc[0, 1].assign}[\${x}] xxx
+
+Modify WHILE
+ ${tc} = Check Test Case WHILE FAIL Fail at iteration 10.
+ Length Should Be ${tc[0].body} 10
+
+Modify WHILE limit
+ ${tc} = Check Test Case WHILE with modified limit PASS ${EMPTY}
+ Length Should Be ${tc[1].body} 3
+ Check Log Message ${tc[1, 0, 0, 0]} \${x} = 1
+ Check Log Message ${tc[1, 1, 0, 0]} \${x} = 2
+ Check Log Message ${tc[1, 2]} Modified limit message.
+
+Modify IF
+ ${tc} = Check Test Case IF FAIL Executed!
+ Should Be Equal ${tc[0, 0].message} Secret message!
+ Should Be Equal ${tc[0, 1].message} Secret message!
+ Should Be Equal ${tc[0, 2].message} Executed!
+
+Modify TRY
+ ${tc} = Check Test Case TRY FAIL Not caught!
+ Length Should Be ${tc[0].body} 3
+
+Modify VAR
+ ${tc} = Check Test Case VAR FAIL value != VAR by listener
+ Should Be Equal ${tc[0].value}[0] secret
+ Should Be Equal ${tc[1].value}[0] secret
+
+Modify RETURN
+ ${tc} = Check Test Case RETURN FAIL RETURN by listener != value
+ Should Be Equal ${tc[0, 1].values}[0] secret
+
+Validate that all methods are called correctly
+ Run Tests --variable VALIDATE_EVENTS:True ${SOURCE}
+ Should contain tests ${SUITE} @{ALL TESTS}
+ Check Log Message ${SUITE.teardown.messages[0]} Listener StartEndBobyItemOnly is OK.
+ Check Log Message ${SUITE.teardown.messages[1]} Listener SeparateMethods is OK.
+ Check Log Message ${SUITE.teardown.messages[2]} Listener SeparateMethodsAlsoForKeywords is OK.
diff --git a/atest/robot/output/listener_interface/change_status.robot b/atest/robot/output/listener_interface/change_status.robot
new file mode 100644
index 00000000000..be97fe5db3f
--- /dev/null
+++ b/atest/robot/output/listener_interface/change_status.robot
@@ -0,0 +1,73 @@
+*** Settings ***
+Suite Setup Run Tests --listener ${DATADIR}/${MODIFIER} ${SOURCE}
+Resource atest_resource.robot
+
+*** Variables ***
+${SOURCE} output/listener_interface/body_items_v3/change_status.robot
+${MODIFIER} output/listener_interface/body_items_v3/ChangeStatus.py
+
+*** Test Cases ***
+Fail to pass
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Fail args=Pass me! status=PASS message=Failure hidden!
+ Check Log Message ${tc[0, 0]} Pass me! level=FAIL
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm run. status=PASS message=
+
+Pass to fail
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Log args=Fail me! status=FAIL message=Ooops!!
+ Check Log Message ${tc[0, 0]} Fail me! level=INFO
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+
+Pass to fail without a message
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Log args=Silent fail! status=FAIL message=
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+
+Skip to fail
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Skip args=Fail me! status=FAIL message=Failing!
+ Check Log Message ${tc[0, 0]} Fail me! level=SKIP
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+
+Fail to skip
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Fail args=Skip me! status=SKIP message=Skipping!
+ Check Log Message ${tc[0, 0]} Skip me! level=FAIL
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+
+Not run to fail
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Log args=Fail me! status=FAIL message=Ooops!!
+ Check Keyword Data ${tc[1]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+ Check Keyword Data ${tc[2]} BuiltIn.Log args=Fail me! status=FAIL message=Failing without running!
+ Check Keyword Data ${tc[3]} BuiltIn.Log args=I'm not run. status=NOT RUN message=
+
+Pass and fail to not run
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Log args=Mark not run! status=NOT RUN message=
+ Check Keyword Data ${tc[1]} BuiltIn.Fail args=Mark not run! status=NOT RUN message=Mark not run!
+ Check Keyword Data ${tc[2]} BuiltIn.Fail args=I fail! status=FAIL message=I fail!
+
+Only message
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Fail args=Change me! status=FAIL message=Changed!
+ Check Keyword Data ${tc[1]} Change message status=NOT RUN message=Changed!
+
+Control structures
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Control Structure ${tc[0]} FOR
+ Check Control Structure ${tc[1]} WHILE
+ Check Control Structure ${tc[2]} IF/ELSE ROOT
+ Check Control Structure ${tc[3]} TRY/EXCEPT ROOT
+
+*** Keywords ***
+Check Control Structure
+ [Arguments] ${item} ${type}
+ VAR ${msg} Handled on ${type} level.
+ Should Be Equal ${item.type} ${type}
+ Should Be Equal ${item.status} PASS
+ Should Be Equal ${item.message} ${msg}
+ Should Be Equal ${item[0].status} FAIL
+ Should Be Equal ${item[0].message} ${msg}
+ Check Keyword Data ${item[0, 0]} BuiltIn.Fail args=${msg} status=FAIL message=${msg}
diff --git a/atest/robot/output/listener_interface/importing_listeners.robot b/atest/robot/output/listener_interface/importing_listeners.robot
index cd82a6b0416..f50534abe50 100644
--- a/atest/robot/output/listener_interface/importing_listeners.robot
+++ b/atest/robot/output/listener_interface/importing_listeners.robot
@@ -14,6 +14,15 @@ Python Class Listener From A Module With Different Name
Python Module Listener
module module_listener module_listener
+Listener Versions
+ [Template] NONE
+ Check Listener File listener-versions.txt
+ ... V2
+ ... V2AsNonInt
+ ... V3Implicit
+ ... V3Explicit
+ ... V3AsNonInt
+
Listener With Arguments
class listeners.WithArgs listeners 6
[Teardown] Check Listener File ${ARGS_FILE}
@@ -27,23 +36,33 @@ Listener With Argument Conversion
Listener With Path
class ${LISTENERS}${/}ListenAll.py ListenAll
- [Teardown] File Should Exist %{TEMPDIR}${/}${ALL_FILE2}
+ [Teardown] File Should Exist %{TEMPDIR}${/}${ALL_FILE2}
Listener With Wrong Number Of Arguments
[Template] Importing Listener Failed
0 listeners.WithArgs Listener 'WithArgs' expected 1 to 2 arguments, got 0.
1 listeners.WithArgs:1:2:3 Listener 'WithArgs' expected 1 to 2 arguments, got 3.
-
Non Existing Listener
[Template] Importing Listener Failed
2 NonExistingListener *${EMPTY TB}PYTHONPATH:* pattern=True
+Unsupported version
+ [Template] Taking Listener Into Use Failed
+ 3 unsupported_listeners.V1Listener Unsupported API version '1'.
+ 4 unsupported_listeners.V4Listener Unsupported API version '4'.
+ 5 unsupported_listeners.InvalidVersionListener Unsupported API version 'kekkonen'.
+
*** Keywords ***
Run Tests With Listeners
${listeners} = Catenate
... --listener ListenAll
... --listener listeners.ListenSome
... --listener module_listener
+ ... --listener listener_versions.V2
+ ... --listener listener_versions.V2AsNonInt
+ ... --listener listener_versions.V3Implicit
+ ... --listener listener_versions.V3Explicit
+ ... --listener listener_versions.V3AsNonInt
... --listener listeners.WithArgs:value
... --listener "listeners.WithArgs:a1:a;2"
... --listener "listeners.WithArgs;semi;colons:here"
@@ -53,11 +72,19 @@ Run Tests With Listeners
... --listener listeners.WithArgs
... --listener listeners.WithArgs:1:2:3
... --listener NonExistingListener
+ ... --listener unsupported_listeners.V1Listener
+ ... --listener unsupported_listeners.V4Listener
+ ... --listener unsupported_listeners.InvalidVersionListener
Run Tests ${listeners} misc/pass_and_fail.robot
Importing Listener Failed
+ [Arguments] ${index} ${name} ${error} ${pattern}=False
+ VAR ${error} Importing listener '${name.split(':')[0]}' failed: ${error}
+ Taking Listener Into Use Failed ${index} ${name} ${error} ${pattern}
+
+Taking Listener Into Use Failed
[Arguments] ${index} ${name} ${error} ${pattern}=False
Check Log Message
... ${ERRORS}[${index}]
- ... Taking listener '${name}' into use failed: Importing listener '${name.split(':')[0]}' failed: ${error}
+ ... Taking listener '${name}' into use failed: ${error}
... ERROR pattern=${pattern}
diff --git a/atest/robot/output/listener_interface/keyword_arguments_v3.robot b/atest/robot/output/listener_interface/keyword_arguments_v3.robot
new file mode 100644
index 00000000000..09b8b7d26b1
--- /dev/null
+++ b/atest/robot/output/listener_interface/keyword_arguments_v3.robot
@@ -0,0 +1,52 @@
+*** Settings ***
+Suite Setup Run Tests --listener ${DATADIR}/${MODIFIER} ${SOURCE}
+Resource atest_resource.robot
+
+*** Variables ***
+${SOURCE} output/listener_interface/body_items_v3/keyword_arguments.robot
+${MODIFIER} output/listener_interface/body_items_v3/ArgumentModifier.py
+
+*** Test Cases ***
+Library keyword arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} Library.Library Keyword
+ ... args=\${STATE}, number=\${123}, obj=None, escape=c:\\\\temp\\\\new
+ Check Keyword Data ${tc[1]} Library.Library Keyword
+ ... args=new, 123, c:\\\\temp\\\\new, NONE
+ Check Keyword Data ${tc[2]} Library.Library Keyword
+ ... args=new, number=\${42}, escape=c:\\\\temp\\\\new, obj=Object(42)
+ Check Keyword Data ${tc[3]} Library.Library Keyword
+ ... args=number=1.0, escape=c:\\\\temp\\\\new, obj=Object(1), state=new
+
+User keyword arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} User keyword
+ ... args=A, B, C, D
+ Check Keyword Data ${tc[1]} User keyword
+ ... args=A, B, d=D, c=\${{"c".upper()}}
+
+Invalid keyword arguments
+ ${tc} = Check Test Case Library keyword arguments
+ Check Keyword Data ${tc[4]} Non-existing
+ ... args=p, n=1 status=FAIL
+
+Too many arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} Library.Library Keyword
+ ... args=a, b, c, d, e, f, g status=FAIL
+ Check Keyword Data ${tc[1]} User keyword
+ ... args=a, b, c, d, e, f, g status=FAIL
+ Check Keyword Data ${tc[2]} Library.Library Keyword
+ ... args=${{', '.join(str(i) for i in range(100))}} status=FAIL
+
+Conversion error
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} Library.Library Keyword
+ ... args=whatever, not a number status=FAIL
+ Check Keyword Data ${tc[1]} Library.Library Keyword
+ ... args=number=bad status=FAIL
+
+Positional after named
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} Library.Library Keyword
+ ... args=positional, number=-1, ooops status=FAIL
diff --git a/atest/robot/output/listener_interface/lineno_and_source.robot b/atest/robot/output/listener_interface/lineno_and_source.robot
index 2214c99a763..cc61cbe667d 100644
--- a/atest/robot/output/listener_interface/lineno_and_source.robot
+++ b/atest/robot/output/listener_interface/lineno_and_source.robot
@@ -12,206 +12,254 @@ ${RESOURCE FILE} ${LISTENER DIR}/lineno_and_source.resource
*** Test Cases ***
Keyword
START KEYWORD No Operation 6 NOT SET
- END KEYWORD No Operation 6 PASS
+ \END KEYWORD No Operation 6 PASS
User keyword
- START KEYWORD User Keyword 9 NOT SET
- START KEYWORD No Operation 85 NOT SET
- END KEYWORD No Operation 85 PASS
- START RETURN ${EMPTY} 86 NOT SET
- END RETURN ${EMPTY} 86 PASS
- END KEYWORD User Keyword 9 PASS
+ START KEYWORD User Keyword 9 NOT SET
+ START KEYWORD No Operation 101 NOT SET
+ \END KEYWORD No Operation 101 PASS
+ START RETURN ${EMPTY} 102 NOT SET
+ \END RETURN ${EMPTY} 102 PASS
+ \END KEYWORD User Keyword 9 PASS
User keyword in resource
START KEYWORD User Keyword In Resource 12 NOT SET
START KEYWORD No Operation 3 NOT SET source=${RESOURCE FILE}
- END KEYWORD No Operation 3 PASS source=${RESOURCE FILE}
- END KEYWORD User Keyword In Resource 12 PASS
+ \END KEYWORD No Operation 3 PASS source=${RESOURCE FILE}
+ \END KEYWORD User Keyword In Resource 12 PASS
Not run keyword
START KEYWORD Fail 16 NOT SET
- END KEYWORD Fail 16 FAIL
+ \END KEYWORD Fail 16 FAIL
START KEYWORD Fail 17 NOT RUN
- END KEYWORD Fail 17 NOT RUN
+ \END KEYWORD Fail 17 NOT RUN
START KEYWORD Non-existing 18 NOT RUN
- END KEYWORD Non-existing 18 NOT RUN
+ \END KEYWORD Non-existing 18 NOT RUN
FOR
- START FOR \${x} IN [ first | second ] 21 NOT SET
+ START FOR \${x} IN first second 21 NOT SET
START ITERATION \${x} = first 21 NOT SET
START KEYWORD No Operation 22 NOT SET
- END KEYWORD No Operation 22 PASS
- END ITERATION \${x} = first 21 PASS
+ \END KEYWORD No Operation 22 PASS
+ \END ITERATION \${x} = first 21 PASS
START ITERATION \${x} = second 21 NOT SET
START KEYWORD No Operation 22 NOT SET
- END KEYWORD No Operation 22 PASS
- END ITERATION \${x} = second 21 PASS
- END FOR \${x} IN [ first | second ] 21 PASS
+ \END KEYWORD No Operation 22 PASS
+ \END ITERATION \${x} = second 21 PASS
+ \END FOR \${x} IN first second 21 PASS
FOR in keyword
- START KEYWORD FOR In Keyword 26 NOT SET
- START FOR \${x} IN [ once ] 89 NOT SET
- START ITERATION \${x} = once 89 NOT SET
- START KEYWORD No Operation 90 NOT SET
- END KEYWORD No Operation 90 PASS
- END ITERATION \${x} = once 89 PASS
- END FOR \${x} IN [ once ] 89 PASS
- END KEYWORD FOR In Keyword 26 PASS
+ START KEYWORD FOR In Keyword 26 NOT SET
+ START FOR \${x} IN once 105 NOT SET
+ START ITERATION \${x} = once 105 NOT SET
+ START KEYWORD No Operation 106 NOT SET
+ \END KEYWORD No Operation 106 PASS
+ \END ITERATION \${x} = once 105 PASS
+ \END FOR \${x} IN once 105 PASS
+ \END KEYWORD FOR In Keyword 26 PASS
FOR in IF
START IF True 29 NOT SET
- START FOR \${x} | \${y} IN [ x | y ] 30 NOT SET
+ START FOR \${x} \${y} IN x y 30 NOT SET
START ITERATION \${x} = x, \${y} = y 30 NOT SET
START KEYWORD No Operation 31 NOT SET
- END KEYWORD No Operation 31 PASS
- END ITERATION \${x} = x, \${y} = y 30 PASS
- END FOR \${x} | \${y} IN [ x | y ] 30 PASS
- END IF True 29 PASS
+ \END KEYWORD No Operation 31 PASS
+ \END ITERATION \${x} = x, \${y} = y 30 PASS
+ \END FOR \${x} \${y} IN x y 30 PASS
+ \END IF True 29 PASS
FOR in resource
START KEYWORD FOR In Resource 36 NOT SET
- START FOR \${x} IN [ once ] 6 NOT SET source=${RESOURCE FILE}
+ START FOR \${x} IN once 6 NOT SET source=${RESOURCE FILE}
START ITERATION \${x} = once 6 NOT SET source=${RESOURCE FILE}
START KEYWORD Log 7 NOT SET source=${RESOURCE FILE}
- END KEYWORD Log 7 PASS source=${RESOURCE FILE}
- END ITERATION \${x} = once 6 PASS source=${RESOURCE FILE}
- END FOR \${x} IN [ once ] 6 PASS source=${RESOURCE FILE}
- END KEYWORD FOR In Resource 36 PASS
+ \END KEYWORD Log 7 PASS source=${RESOURCE FILE}
+ \END ITERATION \${x} = once 6 PASS source=${RESOURCE FILE}
+ \END FOR \${x} IN once 6 PASS source=${RESOURCE FILE}
+ \END KEYWORD FOR In Resource 36 PASS
IF
- START IF 1 > 2 39 NOT RUN
- START KEYWORD Fail 40 NOT RUN
- END KEYWORD Fail 40 NOT RUN
- END IF 1 > 2 39 NOT RUN
- START ELSE IF 1 < 2 41 NOT SET
- START KEYWORD No Operation 42 NOT SET
- END KEYWORD No Operation 42 PASS
- END ELSE IF 1 < 2 41 PASS
- START ELSE ${EMPTY} 43 NOT RUN
- START KEYWORD Fail 44 NOT RUN
- END KEYWORD Fail 44 NOT RUN
- END ELSE ${EMPTY} 43 NOT RUN
+ START IF 1 > 2 39 NOT RUN
+ START KEYWORD Fail 40 NOT RUN
+ \END KEYWORD Fail 40 NOT RUN
+ \END IF 1 > 2 39 NOT RUN
+ START ELSE IF 1 < 2 41 NOT SET
+ START KEYWORD No Operation 42 NOT SET
+ \END KEYWORD No Operation 42 PASS
+ \END ELSE IF 1 < 2 41 PASS
+ START ELSE \ 43 NOT RUN
+ START KEYWORD Fail 44 NOT RUN
+ \END KEYWORD Fail 44 NOT RUN
+ \END ELSE \ 43 NOT RUN
IF in keyword
- START KEYWORD IF In Keyword 48 NOT SET
- START IF True 94 NOT SET
- START KEYWORD No Operation 95 NOT SET
- END KEYWORD No Operation 95 PASS
- START RETURN ${EMPTY} 96 NOT SET
- END RETURN ${EMPTY} 96 PASS
- END IF True 94 PASS
- END KEYWORD IF In Keyword 48 PASS
+ START KEYWORD IF In Keyword 48 NOT SET
+ START IF True 110 NOT SET
+ START KEYWORD No Operation 111 NOT SET
+ \END KEYWORD No Operation 111 PASS
+ START RETURN ${EMPTY} 112 NOT SET
+ \END RETURN ${EMPTY} 112 PASS
+ \END IF True 110 PASS
+ \END KEYWORD IF In Keyword 48 PASS
IF in FOR
- START FOR \${x} IN [ 1 | 2 ] 52 NOT SET
- START ITERATION \${x} = 1 52 NOT SET
- START IF \${x} == 1 53 NOT SET
- START KEYWORD Log 54 NOT SET
- END KEYWORD Log 54 PASS
- END IF \${x} == 1 53 PASS
- START ELSE ${EMPTY} 55 NOT RUN
- START KEYWORD Fail 56 NOT RUN
- END KEYWORD Fail 56 NOT RUN
- END ELSE ${EMPTY} 55 NOT RUN
- END ITERATION \${x} = 1 52 PASS
- START ITERATION \${x} = 2 52 NOT SET
- START IF \${x} == 1 53 NOT RUN
- START KEYWORD Log 54 NOT RUN
- END KEYWORD Log 54 NOT RUN
- END IF \${x} == 1 53 NOT RUN
- START ELSE ${EMPTY} 55 NOT SET
- START KEYWORD Fail 56 NOT SET
- END KEYWORD Fail 56 FAIL
- END ELSE ${EMPTY} 55 FAIL
- END ITERATION \${x} = 2 52 FAIL
- END FOR \${x} IN [ 1 | 2 ] 52 FAIL
+ START FOR \${x} IN 1 2 52 NOT SET
+ START ITERATION \${x} = 1 52 NOT SET
+ START IF \${x} == 1 53 NOT SET
+ START KEYWORD Log 54 NOT SET
+ \END KEYWORD Log 54 PASS
+ \END IF \${x} == 1 53 PASS
+ START ELSE \ 55 NOT RUN
+ START KEYWORD Fail 56 NOT RUN
+ \END KEYWORD Fail 56 NOT RUN
+ \END ELSE \ 55 NOT RUN
+ \END ITERATION \${x} = 1 52 PASS
+ START ITERATION \${x} = 2 52 NOT SET
+ START IF \${x} == 1 53 NOT RUN
+ START KEYWORD Log 54 NOT RUN
+ \END KEYWORD Log 54 NOT RUN
+ \END IF \${x} == 1 53 NOT RUN
+ START ELSE \ 55 NOT SET
+ START KEYWORD Fail 56 NOT SET
+ \END KEYWORD Fail 56 FAIL
+ \END ELSE \ 55 FAIL
+ \END ITERATION \${x} = 2 52 FAIL
+ \END FOR \${x} IN 1 2 52 FAIL
IF in resource
- START KEYWORD IF In Resource 61 NOT SET
- START IF True 11 NOT SET source=${RESOURCE FILE}
- START KEYWORD No Operation 12 NOT SET source=${RESOURCE FILE}
- END KEYWORD No Operation 12 PASS source=${RESOURCE FILE}
- END IF True 11 PASS source=${RESOURCE FILE}
- END KEYWORD IF In Resource 61 PASS
+ START KEYWORD IF In Resource 61 NOT SET
+ START IF True 11 NOT SET source=${RESOURCE FILE}
+ START KEYWORD No Operation 12 NOT SET source=${RESOURCE FILE}
+ \END KEYWORD No Operation 12 PASS source=${RESOURCE FILE}
+ \END IF True 11 PASS source=${RESOURCE FILE}
+ \END KEYWORD IF In Resource 61 PASS
TRY
START TRY ${EMPTY} 65 NOT SET
START KEYWORD Fail 66 NOT SET
- END KEYWORD Fail 66 FAIL
- END TRY ${EMPTY} 65 FAIL
+ \END KEYWORD Fail 66 FAIL
+ \END TRY ${EMPTY} 65 FAIL
START EXCEPT AS \${name} 67 NOT SET
START TRY ${EMPTY} 68 NOT SET
START KEYWORD Fail 69 NOT SET
- END KEYWORD Fail 69 FAIL
- END TRY ${EMPTY} 68 FAIL
+ \END KEYWORD Fail 69 FAIL
+ \END TRY ${EMPTY} 68 FAIL
START FINALLY ${EMPTY} 70 NOT SET
START KEYWORD Should Be Equal 71 NOT SET
- END KEYWORD Should Be Equal 71 PASS
- END FINALLY ${EMPTY} 70 PASS
- END EXCEPT AS \${name} 67 FAIL
+ \END KEYWORD Should Be Equal 71 PASS
+ \END FINALLY ${EMPTY} 70 PASS
+ \END EXCEPT AS \${name} 67 FAIL
START ELSE ${EMPTY} 73 NOT RUN
START KEYWORD Fail 74 NOT RUN
- END KEYWORD Fail 74 NOT RUN
- END ELSE ${EMPTY} 73 NOT RUN
+ \END KEYWORD Fail 74 NOT RUN
+ \END ELSE ${EMPTY} 73 NOT RUN
TRY in keyword
START KEYWORD TRY In Keyword 78 NOT SET
- START TRY ${EMPTY} 100 NOT SET
- START RETURN ${EMPTY} 101 NOT SET
- END RETURN ${EMPTY} 101 PASS
- START KEYWORD Fail 102 NOT RUN
- END KEYWORD Fail 102 NOT RUN
- END TRY ${EMPTY} 100 PASS
- START EXCEPT No match AS \${var} 103 NOT RUN
- START KEYWORD Fail 104 NOT RUN
- END KEYWORD Fail 104 NOT RUN
- END EXCEPT No match AS \${var} 103 NOT RUN
- START EXCEPT No | Match | 2 AS \${x} 105 NOT RUN
- START KEYWORD Fail 106 NOT RUN
- END KEYWORD Fail 106 NOT RUN
- END EXCEPT No | Match | 2 AS \${x} 105 NOT RUN
- START EXCEPT ${EMPTY} 107 NOT RUN
- START KEYWORD Fail 108 NOT RUN
- END KEYWORD Fail 108 NOT RUN
- END EXCEPT ${EMPTY} 107 NOT RUN
- END KEYWORD TRY In Keyword 78 PASS
+ START TRY ${EMPTY} 116 NOT SET
+ START RETURN ${EMPTY} 117 NOT SET
+ \END RETURN ${EMPTY} 117 PASS
+ START KEYWORD Fail 118 NOT RUN
+ \END KEYWORD Fail 118 NOT RUN
+ \END TRY ${EMPTY} 116 PASS
+ START EXCEPT No match AS \${var} 119 NOT RUN
+ START KEYWORD Fail 120 NOT RUN
+ \END KEYWORD Fail 120 NOT RUN
+ \END EXCEPT No match AS \${var} 119 NOT RUN
+ START EXCEPT No Match 2 AS \${x} 121 NOT RUN
+ START KEYWORD Fail 122 NOT RUN
+ \END KEYWORD Fail 122 NOT RUN
+ \END EXCEPT No Match 2 AS \${x} 121 NOT RUN
+ START EXCEPT ${EMPTY} 123 NOT RUN
+ START KEYWORD Fail 124 NOT RUN
+ \END KEYWORD Fail 124 NOT RUN
+ \END EXCEPT ${EMPTY} 123 NOT RUN
+ \END KEYWORD TRY In Keyword 78 PASS
TRY in resource
START KEYWORD TRY In Resource 81 NOT SET
START TRY ${EMPTY} 16 NOT SET source=${RESOURCE FILE}
START KEYWORD Log 17 NOT SET source=${RESOURCE FILE}
- END KEYWORD Log 17 PASS source=${RESOURCE FILE}
- END TRY ${EMPTY} 16 PASS source=${RESOURCE FILE}
+ \END KEYWORD Log 17 PASS source=${RESOURCE FILE}
+ \END TRY ${EMPTY} 16 PASS source=${RESOURCE FILE}
START FINALLY ${EMPTY} 18 NOT SET source=${RESOURCE FILE}
START KEYWORD Log 19 NOT SET source=${RESOURCE FILE}
- END KEYWORD Log 19 PASS source=${RESOURCE FILE}
- END FINALLY ${EMPTY} 18 PASS source=${RESOURCE FILE}
- END KEYWORD TRY In Resource 81 PASS
+ \END KEYWORD Log 19 PASS source=${RESOURCE FILE}
+ \END FINALLY ${EMPTY} 18 PASS source=${RESOURCE FILE}
+ \END KEYWORD TRY In Resource 81 PASS
-Test
- [Template] Expect test
- Keyword 5
- User keyword 8
- User keyword in resource 11
- Not run keyword 14 FAIL
- \FOR 20
- FOR in keyword 25
- FOR in IF 28
- FOR in resource 35
- \IF 38
- IF in keyword 47
- IF in FOR 50 FAIL
- IF in resource 60
- \TRY 63 FAIL
- TRY in keyword 77
- TRY in resource 80
- [Teardown] Validate tests
+Run Keyword
+ START KEYWORD Run Keyword 84 NOT SET
+ START KEYWORD Log 84 NOT SET
+ \END KEYWORD Log 84 PASS
+ \END KEYWORD Run Keyword 84 PASS
+ START KEYWORD Run Keyword If 85 NOT SET
+ START KEYWORD User Keyword 85 NOT SET
+ START KEYWORD No Operation 101 NOT SET
+ \END KEYWORD No Operation 101 PASS
+ START RETURN ${EMPTY} 102 NOT SET
+ \END RETURN ${EMPTY} 102 PASS
+ \END KEYWORD User Keyword 85 PASS
+ \END KEYWORD Run Keyword If 85 PASS
+
+Run Keyword in keyword
+ START KEYWORD Run Keyword in keyword 89 NOT SET
+ START KEYWORD Run Keyword 128 NOT SET
+ START KEYWORD No Operation 128 NOT SET
+ \END KEYWORD No Operation 128 PASS
+ \END KEYWORD Run Keyword 128 PASS
+ \END KEYWORD Run Keyword in keyword 89 PASS
+
+Run Keyword in resource
+ START KEYWORD Run Keyword in resource 92 NOT SET
+ START KEYWORD Run Keyword 23 NOT SET source=${RESOURCE FILE}
+ START KEYWORD Log 23 NOT SET source=${RESOURCE FILE}
+ \END KEYWORD Log 23 PASS source=${RESOURCE FILE}
+ \END KEYWORD Run Keyword 23 PASS source=${RESOURCE FILE}
+ \END KEYWORD Run Keyword in resource 92 PASS
+
+In setup and teardown
+ START SETUP User Keyword 95 NOT SET
+ START KEYWORD No Operation 101 NOT SET
+ \END KEYWORD No Operation 101 PASS
+ START RETURN ${EMPTY} 102 NOT SET
+ \END RETURN ${EMPTY} 102 PASS
+ \END SETUP User Keyword 95 PASS
+ START KEYWORD No Operation 96 NOT SET
+ \END KEYWORD No Operation 96 PASS
+ START TEARDOWN Run Keyword 97 NOT SET
+ START KEYWORD Log 97 NOT SET
+ \END KEYWORD Log 97 PASS
+ \END TEARDOWN Run Keyword 97 PASS
Suite
- START SUITE Lineno And Source
- END SUITE Lineno And Source status=FAIL
+ START SUITE Lineno And Source
+ \END SUITE Lineno And Source status=FAIL
[Teardown] Validate suite
+Test
+ [Template] Expect test
+ Keyword 5
+ User keyword 8
+ User keyword in resource 11
+ Not run keyword 14 FAIL
+ \FOR 20
+ FOR in keyword 25
+ FOR in IF 28
+ FOR in resource 35
+ \IF 38
+ IF in keyword 47
+ IF in FOR 50 FAIL
+ IF in resource 60
+ \TRY 63 FAIL
+ TRY in keyword 77
+ TRY in resource 80
+ Run Keyword 83
+ Run Keyword in keyword 88
+ Run Keyword in resource 91
+ In setup and teardown 94
+ [Teardown] Validate tests
+
*** Keywords ***
Expect
[Arguments] ${event} ${type} ${name} ${lineno}=-1 ${status}= ${source}=${TEST CASE FILE}
diff --git a/atest/robot/output/listener_interface/listener_failing.robot b/atest/robot/output/listener_interface/listener_failing.robot
index 9ac1fd3eded..da2f6870fb2 100644
--- a/atest/robot/output/listener_interface/listener_failing.robot
+++ b/atest/robot/output/listener_interface/listener_failing.robot
@@ -43,12 +43,11 @@ Listener errors should be reported
Library listener errors should be reported
FOR ${index} ${method} IN ENUMERATE
- ... start_suite start_test start_keyword log_message
+ ... message start_suite start_test start_keyword log_message
... end_keyword end_test end_suite
Error should be reported in execution errors ${index} ${method} failing_listener
END
Error should be reported in stderr close failing_listener
- ... Error in library 'LibraryWithFailingListener':
Error should be reported in execution errors
[Arguments] ${index} ${method} ${listener}
@@ -58,9 +57,8 @@ Error should be reported in execution errors
Check log message ${ERRORS}[${index}] ${error} ERROR
Error should be reported in stderr
- [Arguments] ${method} ${listener} @{prefix}
+ [Arguments] ${method} ${listener}
${error} = Catenate
- ... @{prefix}
... Calling method '${method}' of listener '${listener}' failed:
... Expected failure in ${method}!
Stderr Should Contain [ ERROR ] ${error}
diff --git a/atest/robot/output/listener_interface/listener_logging.robot b/atest/robot/output/listener_interface/listener_logging.robot
index a6acb42e6df..35d400088f4 100644
--- a/atest/robot/output/listener_interface/listener_logging.robot
+++ b/atest/robot/output/listener_interface/listener_logging.robot
@@ -10,16 +10,29 @@ Logging from listener does not break output file
All start and end methods can log warnings to execution errors
Correct warnings should be shown in execution errors
-Methods inside start_keyword and end_keyword can log normal messages
+Methods under tests can log normal messages
Correct messages should be logged to normal log
-Methods outside start_keyword and end_keyword can log messages to syslog
+Methods outside tests can log messages to syslog
+ Correct messages should be logged to syslog
+
+Logging from listener when using JSON output
+ [Setup] Run Tests With Logging Listener format=json
+ Test statuses should be correct
+ Log and report should be created
+ Correct messages should be logged to normal log
+ Correct warnings should be shown in execution errors
Correct messages should be logged to syslog
*** Keywords ***
Run Tests With Logging Listener
- ${path} = Normalize Path ${LISTENER DIR}/logging_listener.py
- Run Tests --listener ${path} -l l.html -r r.html misc/pass_and_fail.robot
+ [Arguments] ${format}=xml
+ Should Be True $format in ('xml', 'json')
+ VAR ${output} ${OUTDIR}/output.${format}
+ VAR ${options}
+ ... --listener ${LISTENER DIR}/logging_listener.py
+ ... -o ${output} -l l.html -r r.html
+ Run Tests ${options} misc/pass_and_fail.robot output=${output}
Test statuses should be correct
Check Test Case Pass
@@ -35,23 +48,28 @@ Correct warnings should be shown in execution errors
Execution errors should have messages from message and log_message methods
Check Log Message ${ERRORS[0]} message: INFO Robot Framework * WARN pattern=yes
- Check Log Message ${ERRORS[-4]} log_message: FAIL Expected failure WARN
+ Check Log Message ${ERRORS[-7]} log_message: FAIL Expected failure WARN
Correct start/end warnings should be shown in execution errors
${msgs} = Get start/end messages ${ERRORS}
@{kw} = Create List start keyword end keyword
+ @{var} = Create List start var end var
@{return} = Create List start return end return
- @{setup} = Create List start setup @{kw} @{kw} @{kw} @{return} end setup
- @{uk} = Create List start keyword @{kw} @{kw} @{kw} @{return} end keyword
+ @{setup} = Create List start setup @{kw} @{kw} @{kw} @{var} @{kw} @{return} end setup
+ @{uk} = Create List start keyword @{kw} @{kw} @{kw} @{var} @{kw} @{return} end keyword
FOR ${index} ${method} IN ENUMERATE
... start_suite
... @{setup}
... start_test
... @{uk}
+ ... start keyword start keyword end keyword end keyword
+ ... @{kw}
+ ... start teardown end teardown
... end_test
... start_test
... @{uk}
... @{kw}
+ ... start teardown end teardown
... end_test
... end_suite
Check Log Message ${msgs}[${index}] ${method} WARN
@@ -70,62 +88,91 @@ Get start/end messages
Correct messages should be logged to normal log
'My Keyword' has correct messages ${SUITE.setup} Suite Setup
${tc} = Check Test Case Pass
- 'My Keyword' has correct messages ${tc.kws[0]} Pass
+ Check Log Message ${tc[0]} start_test INFO
+ Check Log Message ${tc[1]} start_test WARN
+ 'My Keyword' has correct messages ${tc[2]} Pass
+ Check Log Message ${tc[5]} end_test INFO
+ Check Log Message ${tc[6]} end_test WARN
+ Teardown has correct messages ${tc.teardown}
${tc} = Check Test Case Fail
- 'My Keyword' has correct messages ${tc.kws[0]} Fail
- 'Fail' has correct messages ${tc.kws[1]}
+ Check Log Message ${tc[0]} start_test INFO
+ Check Log Message ${tc[1]} start_test WARN
+ 'My Keyword' has correct messages ${tc[2]} Fail
+ 'Fail' has correct messages ${tc[3]}
+ Check Log Message ${tc[4]} end_test INFO
+ Check Log Message ${tc[5]} end_test WARN
+ Teardown has correct messages ${tc.teardown}
'My Keyword' has correct messages
[Arguments] ${kw} ${name}
IF '${name}' == 'Suite Setup'
- ${type} = Set Variable setup
+ VAR ${type} setup
ELSE
- ${type} = Set Variable keyword
+ VAR ${type} keyword
END
- Check Log Message ${kw.body[0]} start ${type} INFO
- Check Log Message ${kw.body[1]} start ${type} WARN
- Check Log Message ${kw.body[2].body[0]} start keyword INFO
- Check Log Message ${kw.body[2].body[1]} start keyword WARN
- Check Log Message ${kw.body[2].body[2]} log_message: INFO Hello says "${name}"! INFO
- Check Log Message ${kw.body[2].body[3]} log_message: INFO Hello says "${name}"! WARN
- Check Log Message ${kw.body[2].body[4]} Hello says "${name}"! INFO
- Check Log Message ${kw.body[2].body[5]} end keyword INFO
- Check Log Message ${kw.body[2].body[6]} end keyword WARN
- Check Log Message ${kw.body[3].body[0]} start keyword INFO
- Check Log Message ${kw.body[3].body[1]} start keyword WARN
- Check Log Message ${kw.body[3].body[2]} end keyword INFO
- Check Log Message ${kw.body[3].body[3]} end keyword WARN
- Check Log Message ${kw.body[4].body[0]} start keyword INFO
- Check Log Message ${kw.body[4].body[1]} start keyword WARN
- Check Log Message ${kw.body[4].body[2]} log_message: INFO \${assign} = JUST TESTING... INFO
- Check Log Message ${kw.body[4].body[3]} log_message: INFO \${assign} = JUST TESTING... WARN
- Check Log Message ${kw.body[4].body[4]} \${assign} = JUST TESTING... INFO
- Check Log Message ${kw.body[4].body[5]} end keyword INFO
- Check Log Message ${kw.body[4].body[6]} end keyword WARN
- Check Log Message ${kw.body[5].body[0]} start return INFO
- Check Log Message ${kw.body[5].body[1]} start return WARN
- Check Log Message ${kw.body[5].body[2]} end return INFO
- Check Log Message ${kw.body[5].body[3]} end return WARN
- Check Log Message ${kw.body[6]} end ${type} INFO
- Check Log Message ${kw.body[7]} end ${type} WARN
+ Check Log Message ${kw[0]} start ${type} INFO
+ Check Log Message ${kw[1]} start ${type} WARN
+ Check Log Message ${kw[2, 0]} start keyword INFO
+ Check Log Message ${kw[2, 1]} start keyword WARN
+ Check Log Message ${kw[2, 2]} log_message: INFO Hello says "${name}"! INFO
+ Check Log Message ${kw[2, 3]} log_message: INFO Hello says "${name}"! WARN
+ Check Log Message ${kw[2, 4]} Hello says "${name}"! INFO
+ Check Log Message ${kw[2, 5]} end keyword INFO
+ Check Log Message ${kw[2, 6]} end keyword WARN
+ Check Log Message ${kw[3, 0]} start keyword INFO
+ Check Log Message ${kw[3, 1]} start keyword WARN
+ Check Log Message ${kw[3, 2]} end keyword INFO
+ Check Log Message ${kw[3, 3]} end keyword WARN
+ Check Log Message ${kw[4, 0]} start keyword INFO
+ Check Log Message ${kw[4, 1]} start keyword WARN
+ Check Log Message ${kw[4, 2]} log_message: INFO \${assign} = JUST TESTING... INFO
+ Check Log Message ${kw[4, 3]} log_message: INFO \${assign} = JUST TESTING... WARN
+ Check Log Message ${kw[4, 4]} \${assign} = JUST TESTING... INFO
+ Check Log Message ${kw[4, 5]} end keyword INFO
+ Check Log Message ${kw[4, 6]} end keyword WARN
+ Check Log Message ${kw[5, 0]} start var INFO
+ Check Log Message ${kw[5, 1]} start var WARN
+ Check Log Message ${kw[5, 2]} log_message: INFO \${expected} = JUST TESTING... INFO
+ Check Log Message ${kw[5, 3]} log_message: INFO \${expected} = JUST TESTING... WARN
+ Check Log Message ${kw[5, 4]} \${expected} = JUST TESTING... INFO
+ Check Log Message ${kw[5, 5]} end var INFO
+ Check Log Message ${kw[5, 6]} end var WARN
+ Check Log Message ${kw[6, 0]} start keyword INFO
+ Check Log Message ${kw[6, 1]} start keyword WARN
+ Check Log Message ${kw[6, 2]} end keyword INFO
+ Check Log Message ${kw[6, 3]} end keyword WARN
+ Check Log Message ${kw[7, 0]} start return INFO
+ Check Log Message ${kw[7, 1]} start return WARN
+ Check Log Message ${kw[7, 2]} end return INFO
+ Check Log Message ${kw[7, 3]} end return WARN
+ Check Log Message ${kw[8]} end ${type} INFO
+ Check Log Message ${kw[9]} end ${type} WARN
+
+Teardown has correct messages
+ [Arguments] ${teardown}
+ Check Log Message ${teardown[0]} start teardown INFO
+ Check Log Message ${teardown[1]} start teardown WARN
+ Check Log Message ${teardown[2]} log_message: INFO Teardown! INFO
+ Check Log Message ${teardown[3]} log_message: INFO Teardown! WARN
+ Check Log Message ${teardown[4]} Teardown!
+ Check Log Message ${teardown[5]} end teardown INFO
+ Check Log Message ${teardown[6]} end teardown WARN
'Fail' has correct messages
[Arguments] ${kw}
- Check Log Message ${kw.body[0]} start keyword INFO
- Check Log Message ${kw.body[1]} start keyword WARN
- Check Log Message ${kw.body[2]} log_message: FAIL Expected failure INFO
- Check Log Message ${kw.body[3]} log_message: FAIL Expected failure WARN
- Check Log Message ${kw.body[4]} Expected failure FAIL
- Check Log Message ${kw.body[5]} end keyword INFO
- Check Log Message ${kw.body[6]} end keyword WARN
+ Check Log Message ${kw[0]} start keyword INFO
+ Check Log Message ${kw[1]} start keyword WARN
+ Check Log Message ${kw[2]} log_message: FAIL Expected failure INFO
+ Check Log Message ${kw[3]} log_message: FAIL Expected failure WARN
+ Check Log Message ${kw[4]} Expected failure FAIL
+ Check Log Message ${kw[5]} end keyword INFO
+ Check Log Message ${kw[6]} end keyword WARN
Correct messages should be logged to syslog
FOR ${msg} IN
... message: INFO Robot Framework
... start_suite
... end_suite
- ... start_test
- ... end_test
... output_file
... log_file
... report_file
diff --git a/atest/robot/output/listener_interface/listener_methods.robot b/atest/robot/output/listener_interface/listener_methods.robot
index ff96e7c101a..c8dce3cea93 100644
--- a/atest/robot/output/listener_interface/listener_methods.robot
+++ b/atest/robot/output/listener_interface/listener_methods.robot
@@ -21,12 +21,12 @@ Listen Some
Correct Attributes To Listener Methods
${status} = Log File %{TEMPDIR}/${ATTR_TYPE_FILE}
- Stderr Should Not Contain attributeverifyinglistener
+ Stderr Should Not Contain VerifyAttributes
Should Not Contain ${status} FAILED
Keyword Tags
${status} = Log File %{TEMPDIR}/${ATTR_TYPE_FILE}
- Should Contain X Times ${status} PASSED | tags: [force, keyword, tags] 6
+ Should Contain X Times ${status} passed | tags: [force, keyword, tags] 6
Suite And Test Counts
Run Tests --listener listeners.SuiteAndTestCounts misc/suites/subsuites misc/suites/subsuites2
@@ -47,8 +47,8 @@ Keyword Status
Executing Keywords from Listeners
Run Tests --listener listeners.KeywordExecutingListener misc/pass_and_fail.robot
${tc}= Get Test Case Pass
- Check Log Message ${tc.kws[0].msgs[0]} Start Pass
- Check Log Message ${tc.kws[2].msgs[0]} End Pass
+ Check Log Message ${tc[0, 0]} Start Pass
+ Check Log Message ${tc[4, 0]} End Pass
Test Template
${listener} = Normalize Path ${LISTENER DIR}/verify_template_listener.py
@@ -56,13 +56,19 @@ Test Template
Stderr Should Be Empty
Keyword Arguments Are Always Strings
- ${result} = Run Tests --listener attributeverifyinglistener ${LISTENER DIR}/keyword_argument_types.robot
+ ${result} = Run Tests --listener VerifyAttributes ${LISTENER DIR}/keyword_argument_types.robot
Should Be Empty ${result.stderr}
Check Test Tags Run Keyword with already resolved non-string arguments in test data 1 2
Check Test Case Run Keyword with non-string arguments in library
${status} = Log File %{TEMPDIR}/${ATTR_TYPE_FILE}
Should Not Contain ${status} FAILED
+Keyword Attributes For Control Structures
+ Run Tests --listener VerifyAttributes misc/for_loops.robot misc/while.robot misc/try_except.robot misc/if_else.robot
+ Stderr Should Be Empty
+ ${status} = Log File %{TEMPDIR}/${ATTR_TYPE_FILE}
+ Should Not Contain ${status} FAILED
+
TimeoutError occurring during listener method is propagaged
[Documentation] Timeouts can only occur inside `log_message`.
... Cannot reliable set timeouts to occur during it, so the listener
@@ -79,7 +85,7 @@ Run Tests With Listeners
... --listener ListenAll:%{TEMPDIR}${/}${ALL_FILE2}
... --listener module_listener
... --listener listeners.ListenSome
- ... --listener attributeverifyinglistener
+ ... --listener VerifyAttributes
... --metadata ListenerMeta:Hello
Run Tests ${args} misc/pass_and_fail.robot
@@ -88,51 +94,80 @@ Check Listen All File
@{expected}= Create List Got settings on level: INFO
... SUITE START: Pass And Fail (s1) 'Some tests here' [ListenerMeta: Hello]
... SETUP START: My Keyword ['Suite Setup'] (line 3)
- ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 27)
+ ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 32)
... LOG MESSAGE: [INFO] Hello says "Suite Setup"!
... KEYWORD END: PASS
- ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 28)
+ ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 33)
... KEYWORD END: PASS
- ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 29)
+ ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 34)
... LOG MESSAGE: [INFO] \${assign} = JUST TESTING...
... KEYWORD END: PASS
- ... RETURN START: (line 30)
+ ... VAR START: \${expected}${SPACE*4}JUST TESTING... (line 35)
+ ... LOG MESSAGE: [INFO] \${expected} = JUST TESTING...
+ ... VAR END: PASS
+ ... KEYWORD START: BuiltIn.Should Be Equal ['\${assign}', '\${expected}'] (line 36)
+ ... KEYWORD END: PASS
+ ... RETURN START: (line 37)
... RETURN END: PASS
... SETUP END: PASS
- ... TEST START: Pass (s1-t1, line 12) '' ['force', 'pass']
- ... KEYWORD START: My Keyword ['Pass'] (line 15)
- ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 27)
+ ... TEST START: Pass (s1-t1, line 15) '' ['force', 'pass']
+ ... KEYWORD START: My Keyword ['Pass'] (line 18)
+ ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 32)
... LOG MESSAGE: [INFO] Hello says "Pass"!
... KEYWORD END: PASS
- ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 28)
+ ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 33)
... KEYWORD END: PASS
- ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 29)
+ ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 34)
... LOG MESSAGE: [INFO] \${assign} = JUST TESTING...
... KEYWORD END: PASS
- ... RETURN START: (line 30)
+ ... VAR START: \${expected}${SPACE*4}JUST TESTING... (line 35)
+ ... LOG MESSAGE: [INFO] \${expected} = JUST TESTING...
+ ... VAR END: PASS
+ ... KEYWORD START: BuiltIn.Should Be Equal ['\${assign}', '\${expected}'] (line 36)
+ ... KEYWORD END: PASS
+ ... RETURN START: (line 37)
... RETURN END: PASS
... KEYWORD END: PASS
+ ... KEYWORD START: example.Resource Keyword (line 19)
+ ... KEYWORD START: BuiltIn.Log ['Hello, resource!'] (line 3)
+ ... LOG MESSAGE: [INFO] Hello, resource!
+ ... KEYWORD END: PASS
+ ... KEYWORD END: PASS
+ ... KEYWORD START: BuiltIn.Should Be Equal ['\${VARIABLE}', 'From variables.py with arg 1'] (line 20)
+ ... KEYWORD END: PASS
+ ... TEARDOWN START: BuiltIn.Log ['Teardown!'] (line 4)
+ ... LOG MESSAGE: [INFO] Teardown!
+ ... TEARDOWN END: PASS
... TEST END: PASS
- ... TEST START: Fail (s1-t2, line 17) 'FAIL Expected failure' ['fail', 'force']
- ... KEYWORD START: My Keyword ['Fail'] (line 20)
- ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 27)
+ ... TEST START: Fail (s1-t2, line 22) 'FAIL Expected failure' ['fail', 'force']
+ ... KEYWORD START: My Keyword ['Fail'] (line 25)
+ ... KEYWORD START: BuiltIn.Log ['Hello says "\${who}"!', '\${LEVEL1}'] (line 32)
... LOG MESSAGE: [INFO] Hello says "Fail"!
... KEYWORD END: PASS
- ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 28)
+ ... KEYWORD START: BuiltIn.Log ['Debug message', '\${LEVEL2}'] (line 33)
... KEYWORD END: PASS
- ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 29)
+ ... KEYWORD START: \${assign} = String.Convert To Upper Case ['Just testing...'] (line 34)
... LOG MESSAGE: [INFO] \${assign} = JUST TESTING...
... KEYWORD END: PASS
- ... RETURN START: (line 30)
+ ... VAR START: \${expected}${SPACE*4}JUST TESTING... (line 35)
+ ... LOG MESSAGE: [INFO] \${expected} = JUST TESTING...
+ ... VAR END: PASS
+ ... KEYWORD START: BuiltIn.Should Be Equal ['\${assign}', '\${expected}'] (line 36)
+ ... KEYWORD END: PASS
+ ... RETURN START: (line 37)
... RETURN END: PASS
... KEYWORD END: PASS
- ... KEYWORD START: BuiltIn.Fail ['Expected failure'] (line 21)
+ ... KEYWORD START: BuiltIn.Fail ['Expected failure'] (line 26)
... LOG MESSAGE: [FAIL] Expected failure
... KEYWORD END: FAIL
+ ... TEARDOWN START: BuiltIn.Log ['Teardown!'] (line 4)
+ ... LOG MESSAGE: [INFO] Teardown!
+ ... TEARDOWN END: PASS
... TEST END: FAIL Expected failure
... SUITE END: FAIL 2 tests, 1 passed, 1 failed
... Output: output.xml Closing...
Check Listener File ${filename} @{expected}
+ Stderr Should Be Empty
Calling listener failed
[Arguments] ${method} ${error}
diff --git a/atest/robot/output/listener_interface/listener_order.robot b/atest/robot/output/listener_interface/listener_order.robot
new file mode 100644
index 00000000000..162b4a50154
--- /dev/null
+++ b/atest/robot/output/listener_interface/listener_order.robot
@@ -0,0 +1,57 @@
+*** Settings ***
+Suite Setup Run Tests With Ordered Listeners
+Resource atest_resource.robot
+
+*** Variables ***
+${LISTENER} ${DATADIR}/output/listener_interface/ListenerOrder.py
+
+*** Test Cases ***
+Validate normal order
+ VAR ${expected}
+ ... LIB 3 (999.9): start_suite
+ ... CLI 2 (3.14): start_suite
+ ... CLI 3 (None): start_suite
+ ... LIB 1 (0): start_suite
+ ... LIB 2 (None): start_suite
+ ... CLI 1 (-1): start_suite
+ ... LIB 3 (999.9): log_message
+ ... CLI 2 (3.14): log_message
+ ... CLI 3 (None): log_message
+ ... LIB 1 (0): log_message
+ ... LIB 2 (None): log_message
+ ... CLI 1 (-1): log_message
+ ... LIB 3 (999.9): end_test
+ ... CLI 2 (3.14): end_test
+ ... CLI 3 (None): end_test
+ ... LIB 1 (0): end_test
+ ... LIB 2 (None): end_test
+ ... CLI 1 (-1): end_test
+ ... separator=\n
+ File Should Be Equal To %{TEMPDIR}/listener_order.log ${expected}\n
+
+Validate close order
+ [Documentation] Library listeners are closed when libraries go out of scope.
+ VAR ${expected}
+ ... LIB 1 (0): close
+ ... LIB 2 (None): close
+ ... LIB 3 (999.9): close
+ ... CLI 2 (3.14): close
+ ... CLI 3 (None): close
+ ... CLI 1 (-1): close
+ ... separator=\n
+ File Should Be Equal To %{TEMPDIR}/listener_close_order.log ${expected}\n
+
+Invalid priority
+ ${listener} = Normalize Path ${LISTENER}
+ Check Log Message ${ERRORS}[0] Taking listener '${listener}:NOT USED:invalid' into use failed: Invalid listener priority 'invalid'. ERROR
+ Check Log Message ${ERRORS}[1] Error in library 'BAD': Registering listeners failed: Taking listener 'SELF' into use failed: Invalid listener priority 'bad'. ERROR
+
+*** Keywords ***
+Run Tests With Ordered Listeners
+ ${listener} = Normalize Path ${LISTENER}
+ VAR ${options}
+ ... --listener "${listener}:CLI 1:-1"
+ ... --listener "${listener}:CLI 2:3.14"
+ ... --listener "${listener}:NOT USED:invalid"
+ ... --listener "${listener}:CLI 3"
+ Run Tests ${options} output/listener_interface/listener_order.robot
diff --git a/atest/robot/output/listener_interface/listener_resource.robot b/atest/robot/output/listener_interface/listener_resource.robot
index 6b94649e09a..23d4da59ca3 100644
--- a/atest/robot/output/listener_interface/listener_resource.robot
+++ b/atest/robot/output/listener_interface/listener_resource.robot
@@ -42,4 +42,4 @@ Get Listener File
[Arguments] ${file}
${path} = Join Path %{TEMPDIR} ${file}
${content} = Get File ${path}
- [Return] ${content}
+ RETURN ${content}
diff --git a/atest/robot/output/listener_interface/listener_v3.robot b/atest/robot/output/listener_interface/listener_v3.robot
index d533bbd7c35..031dd246aaa 100644
--- a/atest/robot/output/listener_interface/listener_v3.robot
+++ b/atest/robot/output/listener_interface/listener_v3.robot
@@ -1,5 +1,5 @@
*** Settings ***
-Suite Setup Run Tests --listener ${LISTENER DIR}/v3.py -l l -r r -b d -x x misc/pass_and_fail.robot
+Suite Setup Run Tests --listener ${LISTENER DIR}/v3.py -l l -r r -b d -x x -L trace misc/pass_and_fail.robot
Resource listener_resource.robot
*** Variables ***
@@ -8,11 +8,11 @@ ${SEPARATOR} ${EMPTY + '-' * 78}
*** Test Cases ***
New tests and keywords can be added
${tc} = Check test case Added by start_suite [start suite] FAIL [start] [end]
- Check keyword data ${tc.kws[0]} BuiltIn.No Operation
+ Check keyword data ${tc[0]} BuiltIn.No Operation
${tc} = Check test case Added by startTest PASS Dynamically added! [end]
- Check keyword data ${tc.kws[0]} BuiltIn.Fail args=Dynamically added! status=FAIL
+ Check keyword data ${tc[0]} BuiltIn.Fail args=Dynamically added! status=FAIL
${tc} = Check test case Added by end_Test FAIL [start] [end]
- Check keyword data ${tc.kws[0]} BuiltIn.Log args=Dynamically added!, INFO
+ Check keyword data ${tc[0]} BuiltIn.Log args=Dynamically added!, INFO
Stdout Should Contain SEPARATOR=\n
... Added by start_suite [start suite] :: [start suite] ${SPACE*17} | FAIL |
... [start] [end]
@@ -63,12 +63,34 @@ Changing current element docs does not change console output, but does change ou
Check Test Doc Pass [start suite] [start suite] [start test] [end test]
Log messages and timestamps can be changed
- ${tc} = Get test case Pass [start suite]
- Check log message ${tc.kws[0].kws[0].msgs[0]} HELLO SAYS "PASS"!
- Should be equal ${tc.kws[0].kws[0].msgs[0].timestamp} 20151216 15:51:20.141
+ ${tc} = Get Test Case Pass [start suite]
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Log args=Hello says "\${who}"!, \${LEVEL1}
+ Check Log Message ${tc[0, 0, 0]} HELLO SAYS "PASS"!
+ Should Be Equal ${tc[0, 0, 0].timestamp} ${datetime(2015, 12, 16, 15, 51, 20, 141000)}
+
+Log message can be removed by setting message to `None`
+ ${tc} = Get Test Case Fail [start suite]
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Log args=Hello says "\${who}"!, \${LEVEL1}
+ Should Be Empty ${tc[0, 0].body}
+ File Should Not Contain ${OUTDIR}/d.txt HELLO SAYS "FAIL"!
+ File Should Not Contain ${OUTDIR}/d.txt None
Syslog messages can be changed
- Syslog Should Contain Match 20151216 15:51:20.141 | INFO \ | TESTS EXECUTION ENDED. STATISTICS:
+ Syslog Should Contain Match 2015-12-16 15:51:20.141000 | INFO \ | TESTS EXECUTION ENDED. STATISTICS:
+
+Library import
+ Stdout Should Contain Imported library 'BuiltIn' with 107 keywords.
+ Stdout Should Contain Imported library 'String' with 32 keywords.
+ ${tc} = Get Test Case Pass [start suite]
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Log doc=Changed! args=Hello says "\${who}"!, \${LEVEL1}
+
+Resource import
+ Stdout Should Contain Imported resource 'example' with 2 keywords.
+ ${tc} = Get Test Case Pass [start suite]
+ Check Keyword Data ${tc[1, 1]} example.New! doc=Dynamically created.
+
+Variables import
+ Stdout Should Contain Imported variables 'variables.py' without much info.
File methods and close are called
Stderr Should Be Equal To SEPARATOR=\n
@@ -78,3 +100,9 @@ File methods and close are called
... Log: l.html
... Report: r.html
... Close\n
+
+File methods when files are disabled
+ Run Tests Without Processing Output --listener ${LISTENER DIR}/v3.py -o NONE -r NONE -l NONE misc/pass_and_fail.robot
+ Stderr Should Be Equal To SEPARATOR=\n
+ ... Output: None
+ ... Close\n
diff --git a/atest/robot/output/listener_interface/listening_imports.robot b/atest/robot/output/listener_interface/listening_imports.robot
index 9dfcb8d1ae2..e66c38abb59 100644
--- a/atest/robot/output/listener_interface/listening_imports.robot
+++ b/atest/robot/output/listener_interface/listening_imports.robot
@@ -73,19 +73,19 @@ Listen Imports
... Library
... OperatingSystem
... args: []
- ... importer: None
+ ... importer: //imports.robot
... originalname: OperatingSystem
... source: //OperatingSystem.py
Expect
... Resource
... dynamically_imported_resource
- ... importer: None
+ ... importer: //imports.robot
... source: //dynamically_imported_resource.robot
Expect
... Variables
... vars.py
... args: [new, args]
- ... importer: None
+ ... importer: //imports.robot
... source: //vars.py
Verify Expected
diff --git a/atest/robot/output/listener_interface/log_levels.robot b/atest/robot/output/listener_interface/log_levels.robot
index e48ad12f0ac..0cc5d59efe0 100644
--- a/atest/robot/output/listener_interface/log_levels.robot
+++ b/atest/robot/output/listener_interface/log_levels.robot
@@ -11,11 +11,17 @@ Log messages are collected on INFO level by default
Logged messages should be
... INFO: Hello says "Suite Setup"!
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
... INFO: Hello says "Pass"!
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
+ ... INFO: Hello, resource!
+ ... INFO: Teardown!
... INFO: Hello says "Fail"!
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
... FAIL: Expected failure
+ ... INFO: Teardown!
Log messages are collected on specified level
Run Tests -L DEBUG --listener listeners.Messages;${MESSAGE FILE} misc/pass_and_fail.robot
@@ -23,16 +29,34 @@ Log messages are collected on specified level
... INFO: Hello says "Suite Setup"!
... DEBUG: Debug message
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
+ ... DEBUG: Argument types are:
+ ...
+ ...
... INFO: Hello says "Pass"!
... DEBUG: Debug message
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
+ ... DEBUG: Argument types are:
+ ...
+ ...
+ ... INFO: Hello, resource!
+ ... DEBUG: Argument types are:
+ ...
+ ...
+ ... INFO: Teardown!
... INFO: Hello says "Fail"!
... DEBUG: Debug message
... INFO: \${assign} = JUST TESTING...
+ ... INFO: \${expected} = JUST TESTING...
+ ... DEBUG: Argument types are:
+ ...
+ ...
... FAIL: Expected failure
... DEBUG: Traceback (most recent call last):
... ${SPACE*2}None
... AssertionError: Expected failure
+ ... INFO: Teardown!
*** Keywords ***
Logged messages should be
diff --git a/atest/robot/output/listener_interface/output_files.robot b/atest/robot/output/listener_interface/output_files.robot
index c03b1afa115..f75323b1188 100644
--- a/atest/robot/output/listener_interface/output_files.robot
+++ b/atest/robot/output/listener_interface/output_files.robot
@@ -1,7 +1,6 @@
*** Settings ***
Documentation Testing that listener gets information about different output files.
... Tests also that the listener can be taken into use with path.
-Suite Setup Run Some Tests
Suite Teardown Remove Listener Files
Resource listener_resource.robot
@@ -9,23 +8,38 @@ Resource listener_resource.robot
${LISTENERS} ${CURDIR}${/}..${/}..${/}..${/}testresources${/}listeners
*** Test Cases ***
-Output Files
- ${file} = Get Listener File ${ALL_FILE}
- ${expected} = Catenate SEPARATOR=\n
+Output files
+ ${options} = Catenate
+ ... --listener "${LISTENERS}${/}ListenAll.py"
+ ... --output myout.xml
+ ... --report myrep.html
+ ... --log mylog.html
+ ... --xunit myxun.xml
+ ... --debugfile mydeb.txt
+ Run Tests ${options} misc/pass_and_fail.robot output=${OUTDIR}/myout.xml
+ Validate result files
... Debug: mydeb.txt
... Output: myout.xml
+ ... Xunit: myxun.xml
... Log: mylog.html
... Report: myrep.html
- ... Closing...\n
- Should End With ${file} ${expected}
-*** Keywords ***
-Run Some Tests
+Output files disabled
${options} = Catenate
- ... --listener "${LISTENERS}${/}ListenAll.py"
- ... --log mylog.html
- ... --report myrep.html
- ... --output myout.xml
- ... --debugfile mydeb.txt
- Run Tests ${options} misc/pass_and_fail.robot output=${OUTDIR}/myout.xml
- Should Be Equal ${SUITE.name} Pass And Fail
+ ... --listener "${LISTENERS}${/}ListenAll.py:output_file_disabled=True"
+ ... --log NONE
+ ... --report NONE
+ ... --output NONE
+ Run Tests Without Processing Output ${options} misc/pass_and_fail.robot
+ Validate result files
+ ... Output: None
+
+*** Keywords ***
+Validate result files
+ [Arguments] @{files}
+ ${file} = Get Listener File ${ALL_FILE}
+ ${expected} = Catenate SEPARATOR=\n
+ ... @{files}
+ ... Closing...\n
+ Should End With ${file} ${expected}
+ Stderr Should Be Empty
diff --git a/atest/robot/output/listener_interface/recursion.robot b/atest/robot/output/listener_interface/recursion.robot
new file mode 100644
index 00000000000..2b951649ca0
--- /dev/null
+++ b/atest/robot/output/listener_interface/recursion.robot
@@ -0,0 +1,41 @@
+*** Settings ***
+Suite Setup Run Tests --listener ${LISTENER DIR}/Recursion.py ${LISTENER DIR}/recursion.robot
+Resource listener_resource.robot
+
+*** Test Cases ***
+Limited recursion in start_keyword, end_keyword and log_message
+ ${tc} = Check Test Case Limited recursion
+ Length Should Be ${tc.body} 1
+ VAR ${kw} ${tc[0]}
+ Check Keyword Data ${kw} BuiltIn.Log args=Limited 3 children=5
+ Check Keyword Data ${kw[0]} BuiltIn.Log args=Limited 2 (by start_keyword) children=4
+ Check Keyword Data ${kw[0, 0]} BuiltIn.Log args=Limited 1 (by start_keyword) children=1
+ Check Log Message ${kw[0, 0, 0]} Limited 1 (by start_keyword)
+ Check Log Message ${kw[0, 1]} Limited 1 (by log_message)
+ Check Log Message ${kw[0, 2]} Limited 2 (by start_keyword)
+ Check Keyword Data ${kw[0, 3]} BuiltIn.Log args=Limited 1 (by end_keyword) children=1
+ Check Log Message ${kw[0, 3, 0]} Limited 1 (by end_keyword)
+ Check Log Message ${kw[1]} Limited 1 (by log_message)
+ Check Log Message ${kw[2]} Limited 2 (by log_message)
+ Check Log Message ${kw[3]} Limited 3
+ Check Keyword Data ${kw[4]} BuiltIn.Log args=Limited 2 (by end_keyword) children=4
+ Check Keyword Data ${kw[4, 0]} BuiltIn.Log args=Limited 1 (by start_keyword) children=1
+ Check Log Message ${kw[4, 0, 0]} Limited 1 (by start_keyword)
+ Check Log Message ${kw[4, 1]} Limited 1 (by log_message)
+ Check Log Message ${kw[4, 2]} Limited 2 (by end_keyword)
+ Check Keyword Data ${kw[4, 3]} BuiltIn.Log args=Limited 1 (by end_keyword) children=1
+ Check Log Message ${kw[4, 3, 0]} Limited 1 (by end_keyword)
+
+Unlimited recursion in start_keyword, end_keyword and log_message
+ Check Test Case Unlimited recursion
+ Check Recursion Error ${ERRORS[0]} start_keyword Recursive execution stopped.
+ Check Recursion Error ${ERRORS[1]} end_keyword Recursive execution stopped.
+ Check Recursion Error ${ERRORS[2]} log_message RecursionError: *
+
+*** Keywords ***
+Check Recursion Error
+ [Arguments] ${msg} ${method} ${error}
+ ${listener} = Normalize Path ${LISTENER DIR}/Recursion.py
+ Check Log Message ${msg}
+ ... Calling method '${method}' of listener '${listener}' failed: ${error}
+ ... ERROR pattern=True
diff --git a/atest/robot/output/listener_interface/result_model.robot b/atest/robot/output/listener_interface/result_model.robot
new file mode 100644
index 00000000000..3f56c5c0472
--- /dev/null
+++ b/atest/robot/output/listener_interface/result_model.robot
@@ -0,0 +1,29 @@
+*** Settings ***
+Suite Setup Run Tests --listener "${LISTENER DIR}/ResultModel.py;${MODEL FILE}" --loglevel DEBUG ${LISTENER DIR}/result_model.robot
+Resource listener_resource.robot
+
+*** Variables ***
+${MODEL FILE} %{TEMPDIR}/listener_result_model.json
+
+*** Test Cases ***
+Result model is consistent with information sent to listeners
+ Should Be Empty ${ERRORS}
+
+Result model build during execution is same as saved to output.xml
+ ${expected} = Check Test Case Test
+ ${actual} = Evaluate robot.result.TestCase.from_json($MODEL_FILE)
+ ${suite} = Evaluate robot.result.TestSuite.from_dict({'tests': [$actual]}) # Required to get correct id.
+ Dictionaries Should Be Equal ${actual.to_dict()} ${expected.to_dict()}
+
+Messages below log level and messages explicitly removed are not included
+ ${tc} = Check Test Case Test
+ Check Keyword Data ${tc[2, 1]} BuiltIn.Log args=User keyword, DEBUG children=3
+ Check Log Message ${tc[2, 1, 0]} Starting KEYWORD
+ Check Log Message ${tc[2, 1, 1]} User keyword DEBUG
+ Check Log Message ${tc[2, 1, 2]} Ending KEYWORD
+ Check Keyword Data ${tc[2, 2]} BuiltIn.Log args=Not logged, TRACE children=2
+ Check Log Message ${tc[2, 2, 0]} Starting KEYWORD
+ Check Log Message ${tc[2, 2, 1]} Ending KEYWORD
+ Check Keyword Data ${tc[2, 3]} BuiltIn.Log args=Remove me! children=2
+ Check Log Message ${tc[2, 3, 0]} Starting KEYWORD
+ Check Log Message ${tc[2, 3, 1]} Ending KEYWORD
diff --git a/atest/robot/output/listener_interface/unsupported_listener_version.robot b/atest/robot/output/listener_interface/unsupported_listener_version.robot
deleted file mode 100644
index 6828330164c..00000000000
--- a/atest/robot/output/listener_interface/unsupported_listener_version.robot
+++ /dev/null
@@ -1,28 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests With Listeners
-Resource listener_resource.robot
-Test Template Taking listener into use should have failed
-
-*** Test Cases ***
-Unsupported version
- 0 unsupported_listeners.V1ClassListener
- ... Listener 'unsupported_listeners.V1ClassListener' uses unsupported API version '1'.
- 1 unsupported_listeners.InvalidVersionClassListener
- ... Listener 'unsupported_listeners.InvalidVersionClassListener' uses unsupported API version 'kekkonen'.
-
-No version information
- 2 unsupported_listeners
- ... Listener 'unsupported_listeners' does not have mandatory 'ROBOT_LISTENER_API_VERSION' attribute.
-
-*** Keywords ***
-Run Tests With Listeners
- ${listeners} = Catenate
- ... --listener unsupported_listeners.V1ClassListener
- ... --listener unsupported_listeners.InvalidVersionClassListener
- ... --listener unsupported_listeners
- Run Tests ${listeners} misc/pass_and_fail.robot
-
-Taking listener into use should have failed
- [Arguments] ${index} ${name} ${error}
- Check Log Message ${ERRORS}[${index}]
- ... Taking listener '${name}' into use failed: ${error} ERROR
diff --git a/atest/robot/output/listener_interface/using_run_keyword.robot b/atest/robot/output/listener_interface/using_run_keyword.robot
index 264b0d70699..be7635fe20a 100644
--- a/atest/robot/output/listener_interface/using_run_keyword.robot
+++ b/atest/robot/output/listener_interface/using_run_keyword.robot
@@ -4,178 +4,289 @@ Resource listener_resource.robot
*** Test Cases ***
In start_suite when suite has no setup
- Should Be Equal ${SUITE.setup.name} Implicit setup
- Should Be Equal ${SUITE.setup.body[0].name} BuiltIn.Log
- Check Log Message ${SUITE.setup.body[0].body[0]} start_suite
- Length Should Be ${SUITE.setup.body} 1
+ Check Keyword Data ${SUITE.setup} Implicit setup type=SETUP children=1
+ Validate Log ${SUITE.setup[0]} start_suite
In end_suite when suite has no teardown
- Should Be Equal ${SUITE.teardown.name} Implicit teardown
- Should Be Equal ${SUITE.teardown.body[0].name} BuiltIn.Log
- Check Log Message ${SUITE.teardown.body[0].body[0]} end_suite
- Length Should Be ${SUITE.teardown.body} 1
+ Check Keyword Data ${SUITE.teardown} Implicit teardown type=TEARDOWN children=1
+ Validate Log ${SUITE.teardown[0]} end_suite
In start_suite when suite has setup
- ${suite} = Set Variable ${SUITE.suites[1]}
- Should Be Equal ${suite.setup.name} Suite Setup
- Should Be Equal ${suite.setup.body[0].name} BuiltIn.Log
- Check Log Message ${suite.setup.body[0].body[0]} start_suite
- Length Should Be ${suite.setup.body} 5
+ VAR ${kw} ${SUITE.suites[1].setup}
+ Check Keyword Data ${kw} Suite Setup type=SETUP children=5
+ Validate Log ${kw[0]} start_suite
+ Check Keyword Data ${kw[1]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${kw[1, 0]} start_keyword
+ Validate Log ${kw[2]} Keyword
+ Check Keyword Data ${kw[3]} Keyword children=3
+ Check Keyword Data ${kw[3, 0]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${kw[3, 0, 0]} start_keyword
+ Check Keyword Data ${kw[3, 1]} BuiltIn.Log args=Keyword children=3
+ Check Keyword Data ${kw[3, 2]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${kw[3, 2, 0]} end_keyword
+ Check Keyword Data ${kw[4]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${kw[4, 0]} end_keyword
In end_suite when suite has teardown
- ${suite} = Set Variable ${SUITE.suites[1]}
- Should Be Equal ${suite.teardown.name} Suite Teardown
- Should Be Equal ${suite.teardown.body[-1].name} BuiltIn.Log
- Check Log Message ${suite.teardown.body[-1].body[0]} end_suite
- Length Should Be ${suite.teardown.body} 5
+ VAR ${kw} ${SUITE.suites[1].teardown}
+ Check Keyword Data ${kw} Suite Teardown type=TEARDOWN children=5
+ Check Keyword Data ${kw[0]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${kw[0, 0]} start_keyword
+ Validate Log ${kw[1]} Keyword
+ Check Keyword Data ${kw[2]} Keyword children=3
+ Check Keyword Data ${kw[2, 0]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${kw[2, 0, 0]} start_keyword
+ Check Keyword Data ${kw[2, 1]} BuiltIn.Log args=Keyword children=3
+ Check Keyword Data ${kw[2, 2]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${kw[2, 2, 0]} end_keyword
+ Check Keyword Data ${kw[3]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${kw[3, 0]} end_keyword
+ Validate Log ${kw[4]} end_suite
In start_test and end_test when test has no setup or teardown
- ${tc} = Check Test Case First One
- Should Be Equal ${tc.body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[0].body[0]} start_test
- Should Be Equal ${tc.body[-1].name} BuiltIn.Log
- Check Log Message ${tc.body[-1].body[0]} end_test
- Length Should Be ${tc.body} 5
+ ${tc} = Check Test Case First One
+ Length Should Be ${tc.body} 5
Should Not Be True ${tc.setup}
Should Not Be True ${tc.teardown}
+ Validate Log ${tc[0]} start_test
+ Validate Log ${tc[1]} Test 1
+ Validate Log ${tc[2]} Logging with debug level DEBUG
+ Check Keyword Data ${tc[3]} logs on trace tags=kw, tags children=3
+ Check Keyword Data ${tc[3, 0]} BuiltIn.Log args=start_keyword children=1
+ Check Keyword Data ${tc[3, 1]} BuiltIn.Log args=Log on \${TEST NAME}, TRACE children=3
+ Check Keyword Data ${tc[3, 2]} BuiltIn.Log args=end_keyword children=1
+ Validate Log ${tc[4]} end_test
In start_test and end_test when test has setup and teardown
- ${tc} = Check Test Case Test with setup and teardown
- Should Be Equal ${tc.body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[0].body[0]} start_test
- Should Be Equal ${tc.body[-1].name} BuiltIn.Log
- Check Log Message ${tc.body[-1].body[0]} end_test
- Length Should Be ${tc.body} 3
- Should Be Equal ${tc.setup.name} Test Setup
- Should Be Equal ${tc.teardown.name} Test Teardown
+ ${tc} = Check Test Case Test with setup and teardown
+ Length Should Be ${tc.body} 3
+ Check Keyword Data ${tc.setup} Test Setup type=SETUP children=4
+ Check Keyword Data ${tc.teardown} Test Teardown type=TEARDOWN children=4
+ Validate Log ${tc[0]} start_test
+ Check Keyword Data ${tc[1]} Keyword children=3
+ Check Keyword Data ${tc[1, 0]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${tc[1, 0, 0]} start_keyword
+ Check Keyword Data ${tc[1, 1]} BuiltIn.Log args=Keyword children=3
+ Check Keyword Data ${tc[1, 2]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${tc[1, 2, 0]} end_keyword
+ Validate Log ${tc[2]} end_test
In start_keyword and end_keyword with library keyword
- ${tc} = Check Test Case First One
- Should Be Equal ${tc.body[1].name} BuiltIn.Log
- Should Be Equal ${tc.body[1].body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[1].body[0].body[0]} start_keyword
- Check Log Message ${tc.body[1].body[1]} Test 1
- Should Be Equal ${tc.body[1].body[2].name} BuiltIn.Log
- Check Log Message ${tc.body[1].body[2].body[0]} end_keyword
- Length Should Be ${tc.body[1].body} 3
+ ${tc} = Check Test Case First One
+ Should Be Equal ${tc[1].full_name} BuiltIn.Log
+ Should Be Equal ${tc[1, 0].full_name} BuiltIn.Log
+ Check Log Message ${tc[1, 0, 0]} start_keyword
+ Check Log Message ${tc[1, 1]} Test 1
+ Should Be Equal ${tc[1, 2].full_name} BuiltIn.Log
+ Check Log Message ${tc[1, 2, 0]} end_keyword
+ Length Should Be ${tc[1].body} 3
In start_keyword and end_keyword with user keyword
- ${tc} = Check Test Case First One
- Should Be Equal ${tc.body[3].name} logs on trace
- Should Be Equal ${tc.body[3].body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[0].body[0]} start_keyword
- Should Be Equal ${tc.body[3].body[1].name} BuiltIn.Log
- Should Be Equal ${tc.body[3].body[1].body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[1].body[0].body[0]} start_keyword
- Should Be Equal ${tc.body[3].body[1].body[1].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[1].body[1].body[0]} end_keyword
- Length Should Be ${tc.body[3].body[1].body} 2
- Should Be Equal ${tc.body[3].body[2].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[2].body[0]} end_keyword
- Length Should Be ${tc.body[3].body} 3
+ ${tc} = Check Test Case First One
+ Should Be Equal ${tc[3].full_name} logs on trace
+ Should Be Equal ${tc[3, 0].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 0, 0]} start_keyword
+ Should Be Equal ${tc[3, 1].full_name} BuiltIn.Log
+ Should Be Equal ${tc[3, 1, 0].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 1, 0, 1]} start_keyword
+ Should Be Equal ${tc[3, 1, 2].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 1, 2, 1]} end_keyword
+ Length Should Be ${tc[3, 1].body} 3
+ Should Be Equal ${tc[3, 2].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 2, 0]} end_keyword
+ Length Should Be ${tc[3].body} 3
In start_keyword and end_keyword with FOR loop
- ${tc} = Check Test Case FOR loop in test
- ${for} = Set Variable ${tc.body[1]}
- Should Be Equal ${for.type} FOR
- Length Should Be ${for.body} 5
- Length Should Be ${for.body.filter(keywords=True)} 2
- Should Be Equal ${for.body[0].name} BuiltIn.Log
- Check Log Message ${for.body[0].body[0]} start_keyword
- Should Be Equal ${for.body[-1].name} BuiltIn.Log
- Check Log Message ${for.body[-1].body[0]} end_keyword
+ ${tc} = Check Test Case FOR
+ ${for} = Set Variable ${tc[1]}
+ Should Be Equal ${for.type} FOR
+ Length Should Be ${for.body} 5
+ Length Should Be ${for.keywords} 2
+ Should Be Equal ${for[0].full_name} BuiltIn.Log
+ Check Log Message ${for[0, 0]} start_keyword
+ Should Be Equal ${for[-1].full_name} BuiltIn.Log
+ Check Log Message ${for[-1,0]} end_keyword
In start_keyword and end_keyword with WHILE
- ${tc} = Check Test Case While loop executed multiple times
- ${while} = Set Variable ${tc.body[2]}
- Should Be Equal ${while.type} WHILE
- Length Should Be ${while.body} 7
- Length Should Be ${while.body.filter(keywords=True)} 2
- Should Be Equal ${while.body[0].name} BuiltIn.Log
- Check Log Message ${while.body[0].body[0]} start_keyword
- Should Be Equal ${while.body[-1].name} BuiltIn.Log
- Check Log Message ${while.body[-1].body[0]} end_keyword
-
- In start_keyword and end_keyword with IF/ELSE
- ${tc} = Check Test Case IF structure
- Should Be Equal ${tc.body[1].type} IF/ELSE ROOT
- Length Should Be ${tc.body[1].body} 3 # Listener is not called with root
- Validate IF branch ${tc.body[1].body[0]} IF NOT RUN # but is called with unexecuted branches.
- Validate IF branch ${tc.body[1].body[1]} ELSE IF PASS
- Validate IF branch ${tc.body[1].body[2]} ELSE NOT RUN
+ ${tc} = Check Test Case While loop executed multiple times
+ ${while} = Set Variable ${tc[2]}
+ Should Be Equal ${while.type} WHILE
+ Length Should Be ${while.body} 7
+ Length Should Be ${while.keywords} 2
+ Should Be Equal ${while[0].full_name} BuiltIn.Log
+ Check Log Message ${while[0, 0]} start_keyword
+ Should Be Equal ${while[-1].full_name} BuiltIn.Log
+ Check Log Message ${while[-1,0]} end_keyword
+
+In start_keyword and end_keyword with IF/ELSE
+ ${tc} = Check Test Case IF structure
+ Should Be Equal ${tc[1].type} VAR
+ Should Be Equal ${tc[2].type} IF/ELSE ROOT
+ Length Should Be ${tc[2].body} 3 # Listener is not called with root
+ Validate IF branch ${tc[2, 0]} IF NOT RUN # but is called with unexecuted branches.
+ Validate IF branch ${tc[2, 1]} ELSE IF PASS
+ Validate IF branch ${tc[2, 2]} ELSE NOT RUN
In start_keyword and end_keyword with TRY/EXCEPT
- ${tc} = Check Test Case Everything
- Should Be Equal ${tc.body[1].type} TRY/EXCEPT ROOT
- Length Should Be ${tc.body[1].body} 5 # Listener is not called with root
- Validate FOR branch ${tc.body[1].body[0]} TRY FAIL
- Validate FOR branch ${tc.body[1].body[1]} EXCEPT NOT RUN # but is called with unexecuted branches.
- Validate FOR branch ${tc.body[1].body[2]} EXCEPT PASS
- Validate FOR branch ${tc.body[1].body[3]} ELSE NOT RUN
- Validate FOR branch ${tc.body[1].body[4]} FINALLY PASS
+ ${tc} = Check Test Case Everything
+ Should Be Equal ${tc[1].type} TRY/EXCEPT ROOT
+ Length Should Be ${tc[1].body} 5 # Listener is not called with root
+ Validate FOR branch ${tc[1, 0]} TRY FAIL
+ Validate FOR branch ${tc[1, 1]} EXCEPT NOT RUN # but is called with unexecuted branches.
+ Validate FOR branch ${tc[1, 2]} EXCEPT PASS
+ Validate FOR branch ${tc[1, 3]} ELSE NOT RUN
+ Validate FOR branch ${tc[1, 4]} FINALLY PASS
In start_keyword and end_keyword with BREAK and CONTINUE
- ${tc} = Check Test Case WHILE loop in keyword
- FOR ${iter} IN @{tc.body[1].body[2].body[1:-1]}
- Should Be Equal ${iter.body[3].body[0].body[1].type} CONTINUE
- Should Be Equal ${iter.body[3].body[0].body[1].body[0].name} BuiltIn.Log
- Check Log Message ${iter.body[3].body[0].body[1].body[0].body[0]} start_keyword
- Should Be Equal ${iter.body[3].body[0].body[1].body[1].name} BuiltIn.Log
- Check Log Message ${iter.body[3].body[0].body[1].body[1].body[0]} end_keyword
- Should Be Equal ${iter.body[4].body[0].body[1].type} BREAK
- Should Be Equal ${iter.body[4].body[0].body[1].body[0].name} BuiltIn.Log
- Check Log Message ${iter.body[4].body[0].body[1].body[0].body[0]} start_keyword
- Should Be Equal ${iter.body[4].body[0].body[1].body[1].name} BuiltIn.Log
- Check Log Message ${iter.body[4].body[0].body[1].body[1].body[0]} end_keyword
+ ${tc} = Check Test Case WHILE loop in keyword
+ FOR ${iter} IN @{tc[1, 2][1:-1]}
+ Should Be Equal ${iter[3, 0, 1].type} CONTINUE
+ Should Be Equal ${iter[3, 0, 1, 0].full_name} BuiltIn.Log
+ Check Log Message ${iter[3, 0, 1, 0, 0]} start_keyword
+ Should Be Equal ${iter[3, 0, 1, 1].full_name} BuiltIn.Log
+ Check Log Message ${iter[3, 0, 1, 1, 0]} end_keyword
+ Should Be Equal ${iter[4, 0, 1].type} BREAK
+ Should Be Equal ${iter[4, 0, 1, 0].full_name} BuiltIn.Log
+ Check Log Message ${iter[4, 0, 1, 0, 0]} start_keyword
+ Should Be Equal ${iter[4, 0, 1, 1].full_name} BuiltIn.Log
+ Check Log Message ${iter[4, 0, 1, 1, 0]} end_keyword
END
In start_keyword and end_keyword with RETURN
- ${tc} = Check Test Case Second One
- Should Be Equal ${tc.body[3].body[1].body[1].body[2].type} RETURN
- Should Be Equal ${tc.body[3].body[1].body[1].body[2].body[0].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[1].body[1].body[2].body[0].body[0]} start_keyword
- Should Be Equal ${tc.body[3].body[1].body[1].body[2].body[1].name} BuiltIn.Log
- Check Log Message ${tc.body[3].body[1].body[1].body[2].body[1].body[0]} end_keyword
+ ${tc} = Check Test Case Second One
+ Should Be Equal ${tc[3, 1, 1, 2].type} RETURN
+ Should Be Equal ${tc[3, 1, 1, 2, 0].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 1, 1, 2, 0, 1]} start_keyword
+ Should Be Equal ${tc[3, 1, 1, 2, 1].full_name} BuiltIn.Log
+ Check Log Message ${tc[3, 1, 1, 2, 1, 1]} end_keyword
+
+With JSON output
+ [Documentation] Mainly test that executed keywords don't cause problems.
+ ...
+ ... Some data, such as keywords and messages on suite level,
+ ... are discarded and thus the exact output isn't the same as
+ ... with XML.
+ ...
+ ... Cannot validate output, because it doesn't match the schema.
+ Run Tests With Keyword Running Listener format=json validate=False
+ Should Contain Tests ${SUITE}
+ ... First One
+ ... Second One
+ ... Test with setup and teardown
+ ... Test with failing setup
+ ... Test with failing teardown
+ ... Failing test with failing teardown
+ ... FOR
+ ... FOR IN RANGE
+ ... FOR IN ENUMERATE
+ ... FOR IN ZIP
+ ... WHILE loop executed multiple times
+ ... WHILE loop in keyword
+ ... IF structure
+ ... Everything
+ ... Library keyword
+ ... User keyword and RETURN
+ ... Test documentation, tags and timeout
+ ... Test setup and teardown
+ ... Keyword Keyword documentation, tags and timeout
+ ... Keyword setup and teardown
+ ... Failure
+ ... VAR
+ ... IF
+ ... TRY
+ ... FOR and CONTINUE
+ ... WHILE and BREAK
+ ... GROUP
+ ... Syntax error
+
+In dry-run
+ Run Tests With Keyword Running Listener --dry-run
+ Should Contain Tests ${SUITE}
+ ... First One
+ ... Test with setup and teardown
+ ... FOR
+ ... FOR IN ENUMERATE
+ ... FOR IN ZIP
+ ... WHILE loop executed multiple times
+ ... WHILE loop in keyword
+ ... IF structure
+ ... Everything
+ ... Library keyword
+ ... User keyword and RETURN
+ ... Test documentation, tags and timeout
+ ... Test setup and teardown
+ ... Keyword Keyword documentation, tags and timeout
+ ... Keyword setup and teardown
+ ... VAR
+ ... IF
+ ... TRY
+ ... FOR and CONTINUE
+ ... WHILE and BREAK
+ ... GROUP
+ ... Second One=FAIL:Several failures occurred:\n\n1) No keyword with name 'Not executed' found.\n\n2) No keyword with name 'Not executed' found.
+ ... Test with failing setup=PASS
+ ... Test with failing teardown=PASS
+ ... Failing test with failing teardown=PASS
+ ... FOR IN RANGE=FAIL:No keyword with name 'Not executed!' found.
+ ... Failure=PASS
+ ... Syntax error=FAIL:Several failures occurred:\n\n1) Non-existing setting 'Bad'.\n\n2) Non-existing setting 'Ooops'.
*** Keywords ***
Run Tests With Keyword Running Listener
- ${path} = Normalize Path ${LISTENER DIR}/keyword_running_listener.py
- ${files} = Catenate
+ [Arguments] ${options}= ${format}=xml ${validate}=True
+ VAR ${listener} ${LISTENER DIR}/keyword_running_listener.py
+ VAR ${output} ${OUTDIR}/output.${format}
+ VAR ${files}
... misc/normal.robot
... misc/setups_and_teardowns.robot
... misc/for_loops.robot
... misc/while.robot
... misc/if_else.robot
... misc/try_except.robot
- Run Tests --listener ${path} ${files} validate output=True
- Should Be Empty ${ERRORS}
+ ... misc/everything.robot
+ Run Tests --listener ${listener} ${options} -L debug -o ${output} ${files} output=${output} validate output=${validate}
+ Length Should Be ${ERRORS} 1
+
+Validate Log
+ [Arguments] ${kw} ${message} ${level}=INFO
+ IF $level == 'INFO'
+ VAR ${args} ${message}
+ ELSE
+ VAR ${args} ${message}, ${level}
+ END
+ Check Keyword Data ${kw} BuiltIn.Log args=${args} children=3
+ Check Keyword Data ${kw[0]} BuiltIn.Log args=start_keyword children=1
+ Check Log Message ${kw[0, 0]} start_keyword
+ Check Log Message ${kw[1]} ${message} ${level}
+ Check Keyword Data ${kw[2]} BuiltIn.Log args=end_keyword children=1
+ Check Log Message ${kw[2, 0]} end_keyword
Validate IF branch
[Arguments] ${branch} ${type} ${status}
- Should Be Equal ${branch.type} ${type}
- Should Be Equal ${branch.status} ${status}
- Length Should Be ${branch.body} 3
- Should Be Equal ${branch.body[0].name} BuiltIn.Log
- Check Log Message ${branch.body[0].body[0]} start_keyword
+ Should Be Equal ${branch.type} ${type}
+ Should Be Equal ${branch.status} ${status}
+ Length Should Be ${branch.body} 3
+ Should Be Equal ${branch[0].full_name} BuiltIn.Log
+ Check Log Message ${branch[0, 0]} start_keyword
IF $status == 'PASS'
- Should Be Equal ${branch.body[1].name} BuiltIn.Log
- Should Be Equal ${branch.body[1].body[0].name} BuiltIn.Log
- Check Log Message ${branch.body[1].body[0].body[0]} start_keyword
- Check Log Message ${branch.body[1].body[1]} else if branch
- Should Be Equal ${branch.body[1].body[2].name} BuiltIn.Log
- Check Log Message ${branch.body[1].body[2].body[0]} end_keyword
+ Should Be Equal ${branch[1].full_name} BuiltIn.Log
+ Should Be Equal ${branch[1, 0].full_name} BuiltIn.Log
+ Check Log Message ${branch[1, 0, 0]} start_keyword
+ Check Log Message ${branch[1, 1]} else if branch
+ Should Be Equal ${branch[1, 2].full_name} BuiltIn.Log
+ Check Log Message ${branch[1, 2, 0]} end_keyword
ELSE
- Should Be Equal ${branch.body[1].name} BuiltIn.Fail
- Should Be Equal ${branch.body[1].status} NOT RUN
+ Should Be Equal ${branch[1].full_name} BuiltIn.Fail
+ Should Be Equal ${branch[1].status} NOT RUN
END
- Should Be Equal ${branch.body[-1].name} BuiltIn.Log
- Check Log Message ${branch.body[-1].body[0]} end_keyword
+ Should Be Equal ${branch[-1].full_name} BuiltIn.Log
+ Check Log Message ${branch[-1,0]} end_keyword
Validate FOR branch
[Arguments] ${branch} ${type} ${status}
- Should Be Equal ${branch.type} ${type}
- Should Be Equal ${branch.status} ${status}
- Should Be Equal ${branch.body[0].name} BuiltIn.Log
- Check Log Message ${branch.body[0].body[0]} start_keyword
- Should Be Equal ${branch.body[-1].name} BuiltIn.Log
- Check Log Message ${branch.body[-1].body[0]} end_keyword
+ Should Be Equal ${branch.type} ${type}
+ Should Be Equal ${branch.status} ${status}
+ Should Be Equal ${branch[0].full_name} BuiltIn.Log
+ Check Log Message ${branch[0, 0]} start_keyword
+ Should Be Equal ${branch[-1].full_name} BuiltIn.Log
+ Check Log Message ${branch[-1,0]} end_keyword
diff --git a/atest/robot/output/names_needing_escaping.robot b/atest/robot/output/names_needing_escaping.robot
index b7942b154c8..50006670bf3 100644
--- a/atest/robot/output/names_needing_escaping.robot
+++ b/atest/robot/output/names_needing_escaping.robot
@@ -34,4 +34,4 @@ Check TC And UK Name
[Arguments] ${name}
${tc} = Check Test Case ${name}
Should Be Equal ${tc.name} ${name}
- Should Be Equal ${tc.kws[0].name} ${name}
+ Should Be Equal ${tc[0].name} ${name}
diff --git a/atest/robot/output/processing_output.robot b/atest/robot/output/processing_output.robot
index 522772bc735..e7265026383 100644
--- a/atest/robot/output/processing_output.robot
+++ b/atest/robot/output/processing_output.robot
@@ -45,12 +45,19 @@ Minimal hand-created output
My Run Robot And Rebot
[Arguments] ${params} ${paths}
Run Tests Without Processing Output ${params} ${paths}
+ Validate Elapsed In Output
Copy Previous Outfile
Run Rebot ${EMPTY} ${OUTFILE COPY}
+ Validate Elapsed In Output
+
+Validate Elapsed In Output
+ ${statuses} = Get Elements ${OUTFILE} .//status
+ FOR ${elem} IN @{statuses}
+ Should Match Regexp ${elem.attrib}[elapsed] ^\\d+\\.\\d+$
+ END
Check Normal Suite Defaults
[Arguments] ${suite} ${message}= ${setup}=${None} ${teardown}=${None}
- Log ${suite.name}
Check Suite Defaults ${suite} ${message} ${setup} ${teardown}
Check Normal Suite Times ${suite}
@@ -61,27 +68,28 @@ Check Minimal Suite Defaults
Check Normal Suite Times
[Arguments] ${suite}
- Timestamp Should Be Valid ${suite.starttime}
- Timestamp Should Be Valid ${suite.endtime}
- Elapsed Time Should Be Valid ${suite.elapsedtime}
- Should Be True ${suite.elapsedtime} >= 1
+ Timestamp Should Be Valid ${suite.start_time}
+ Timestamp Should Be Valid ${suite.end_time}
+ Elapsed Time Should Be Valid ${suite.elapsed_time} minimum=0.001
Check Minimal Suite Times
[Arguments] ${suite}
- Should Be Equal ${suite.starttime} ${NONE}
- Should Be Equal ${suite.endtime} ${NONE}
- Should Be Equal ${suite.elapsedtime} ${0}
+ Should Be Equal ${suite.start_time} ${NONE}
+ Should Be Equal ${suite.end_time} ${NONE}
+ Elapsed Time Should Be ${suite.elapsed_time} 0
Check Suite Defaults
[Arguments] ${suite} ${message}= ${setup}=${None} ${teardown}=${None}
- Should Be Equal ${suite.message} ${message}
- Should Be Equal ${suite.setup.name} ${setup}
- Should Be Equal ${suite.teardown.name} ${teardown}
+ Should Be Equal ${suite.message} ${message}
+ Should Be Equal ${suite.setup.full_name} ${setup}
+ Should Be Equal ${suite.teardown.full_name} ${teardown}
Check Suite Got From Misc/suites/ Directory
Check Normal Suite Defaults ${SUITE} teardown=BuiltIn.Log
Should Be Equal ${SUITE.status} FAIL
- Should Contain Suites ${SUITE} Suite With Prefix Fourth Subsuites Subsuites2 Suite With Double Underscore Tsuite1 Tsuite2 Tsuite3
+ Should Contain Suites ${SUITE} Suite With Prefix Fourth Subsuites
+ ... Custom name for 📂 'subsuites2' Suite With Double Underscore
+ ... Tsuite1 Tsuite2 Tsuite3
Should Be Empty ${SUITE.tests}
Should Contain Suites ${SUITE.suites[2]} Sub1 Sub2
FOR ${s} IN
diff --git a/atest/robot/output/source_and_lineno_output.robot b/atest/robot/output/source_and_lineno_output.robot
index 17c77812fae..0b8837406d8 100644
--- a/atest/robot/output/source_and_lineno_output.robot
+++ b/atest/robot/output/source_and_lineno_output.robot
@@ -2,6 +2,9 @@
Resource atest_resource.robot
Suite Setup Run Tests ${EMPTY} misc/suites/subsuites2
+*** Variables ***
+${SOURCE} ${{pathlib.Path(r'${DATADIR}/misc/suites/subsuites2')}}
+
*** Test Cases ***
Suite source and test lineno in output after execution
Source info should be correct
@@ -13,10 +16,9 @@ Suite source and test lineno in output after Rebot
*** Keywords ***
Source info should be correct
- ${source} = Normalize Path ${DATADIR}/misc/suites/subsuites2
- Should Be Equal ${SUITE.source} ${source}
- Should Be Equal ${SUITE.suites[0].source} ${source}${/}sub.suite.4.robot
+ Should Be Equal ${SUITE.source} ${SOURCE}
+ Should Be Equal ${SUITE.suites[0].source} ${SOURCE / 'sub.suite.4.robot'}
Should Be Equal ${SUITE.suites[0].tests[0].lineno} ${2}
- Should Be Equal ${SUITE.suites[1].source} ${source}${/}subsuite3.robot
- Should Be Equal ${SUITE.suites[1].tests[0].lineno} ${8}
- Should Be Equal ${SUITE.suites[1].tests[1].lineno} ${13}
+ Should Be Equal ${SUITE.suites[1].source} ${SOURCE / 'subsuite3.robot'}
+ Should Be Equal ${SUITE.suites[1].tests[0].lineno} ${9}
+ Should Be Equal ${SUITE.suites[1].tests[1].lineno} ${14}
diff --git a/atest/robot/output/statistics.robot b/atest/robot/output/statistics.robot
index 9ab66e25f89..0190482c298 100644
--- a/atest/robot/output/statistics.robot
+++ b/atest/robot/output/statistics.robot
@@ -43,13 +43,13 @@ Combined Tag Statistics Name Can Be Given
Tag Node Should Be Correct ${stats[0]} Combined tag with new name AND-OR-NOT
... 1 0 info=combined combined=d1 AND d2
-Suite statistics should be Correct
+Suite statistics should be correct
${stats} = Get Element ${OUTFILE} statistics/suite
Suite Node Should Be Correct ${stats[0]} Suites 12 1
Suite Node Should Be Correct ${stats[1]} Suites.Suite With Prefix 1 0
Suite Node Should Be Correct ${stats[2]} Suites.Fourth 0 1
Suite Node Should Be Correct ${stats[3]} Suites.Subsuites 2 0
- Suite Node Should Be Correct ${stats[4]} Suites.Subsuites2 3 0
+ Suite Node Should Be Correct ${stats[4]} Suites.Custom name for 📂 'subsuites2' 3 0
Suite Node Should Be Correct ${stats[5]} Suites.Suite With Double Underscore 1 0
Suite Node Should Be Correct ${stats[6]} Suites.Tsuite1 3 0
Suite Node Should Be Correct ${stats[7]} Suites.Tsuite2 1 0
diff --git a/atest/robot/output/statistics_in_log_and_report.robot b/atest/robot/output/statistics_in_log_and_report.robot
index 95ab992c2cc..d879fab6141 100644
--- a/atest/robot/output/statistics_in_log_and_report.robot
+++ b/atest/robot/output/statistics_in_log_and_report.robot
@@ -66,7 +66,7 @@ Verify suite stats
... id:s1-s2 pass:0 fail:1 skip:0
Verify stat ${stats[3]} label:Suites.Subsuites name:Subsuites
... id:s1-s3 pass:2 fail:0 skip:0
- Verify stat ${stats[4]} label:Suites.Subsuites2 name:Subsuites2
+ Verify stat ${stats[4]} label:Suites.Custom name for 📂 'subsuites2' name:Custom name for 📂 'subsuites2'
... id:s1-s4 pass:3 fail:0 skip:0
Verify stat ${stats[5]} label:Suites.Suite With Double Underscore name:Suite With Double Underscore
... id:s1-s5 pass:1 fail:0 skip:0
diff --git a/atest/robot/output/statistics_with_rebot.robot b/atest/robot/output/statistics_with_rebot.robot
index 9e83e99cf91..d71c8ecfdad 100644
--- a/atest/robot/output/statistics_with_rebot.robot
+++ b/atest/robot/output/statistics_with_rebot.robot
@@ -33,13 +33,13 @@ Tag statistics should be Correct
Tag Node Should Be Correct ${stats[7]} XxX
... 12 1
-Suite statistics should be Correct
+Suite statistics should be correct
${stats} = Get Element ${OUTFILE} statistics/suite
Node Should Be Correct ${stats[0]} Suites 12 1
Node Should Be Correct ${stats[1]} Suites.Suite With Prefix 1 0
Node Should Be Correct ${stats[2]} Suites.Fourth 0 1
Node Should Be Correct ${stats[3]} Suites.Subsuites 2 0
- Node Should Be Correct ${stats[4]} Suites.Subsuites2 3 0
+ Node Should Be Correct ${stats[4]} Suites.Custom name for 📂 'subsuites2' 3 0
Node Should Be Correct ${stats[5]} Suites.Suite With Double Underscore 1 0
Node Should Be Correct ${stats[6]} Suites.Tsuite1 3 0
Node Should Be Correct ${stats[7]} Suites.Tsuite2 1 0
diff --git a/atest/robot/output/xunit.robot b/atest/robot/output/xunit.robot
index 82e28d590a1..25843cde935 100644
--- a/atest/robot/output/xunit.robot
+++ b/atest/robot/output/xunit.robot
@@ -18,7 +18,7 @@ XUnit File Is Created
File Structure Is Correct
${root} = Get Root Node
- Suite Stats Should Be ${root} 8 3 1 ${SUITE.starttime}
+ Suite Stats Should Be ${root} 8 3 1 ${SUITE.start_time}
${tests} = Get XUnit Nodes testcase
Length Should Be ${tests} 8
${fails} = Get XUnit Nodes testcase/failure
@@ -29,7 +29,7 @@ File Structure Is Correct
${skips} = Get XUnit Nodes testcase/skipped
Length Should Be ${skips} 1
Element Attribute Should Be ${skips}[0] message
- ... Test failed but skip-on-failure mode was active and it was marked skipped.\n\nOriginal failure:\n${MESSAGES}
+ ... Failed test skipped using 'täg' tag.\n\nOriginal failure:\n${MESSAGES}
Element Attribute Should Be ${skips}[0] type SkipExecution
Element Should Not Exist ${root} testsuite/properties
@@ -118,9 +118,9 @@ XUnit File Testsuite Properties From Metadata
Element Attribute Should be ${property_elements}[0] name Escaping
Element Attribute Should be ${property_elements}[0] value Three backslashes \\\\\\\ & \${version}
Element Attribute Should be ${property_elements}[1] name Multiple columns
- Element Attribute Should be ${property_elements}[1] value Value in multiple columns
+ Element Attribute Should be ${property_elements}[1] value Value in${SPACE*4}multiple${SPACE*4}columns
Element Attribute Should be ${property_elements}[2] name multiple lines
- Element Attribute Should be ${property_elements}[2] value Metadata in multiple lines\nis parsed using\nsame semantics as documentation.\n| table |\n| ! |
+ Element Attribute Should be ${property_elements}[2] value Metadata in multiple lines\nis parsed using\nsame semantics${SPACE*4}as${SPACE*4}documentation.\n| table |\n|${SPACE*3}!${SPACE*3}|
Element Attribute Should be ${property_elements}[3] name Name
Element Attribute Should be ${property_elements}[3] value Value
Element Attribute Should be ${property_elements}[4] name Overridden
@@ -144,14 +144,13 @@ Get XUnit Nodes
RETURN ${nodes}
Suite Stats Should Be
- [Arguments] ${elem} ${tests} ${failures} ${skipped} ${starttime}
+ [Arguments] ${elem} ${tests} ${failures} ${skipped} ${start_time}
Element Attribute Should Be ${elem} tests ${tests}
Element Attribute Should Be ${elem} failures ${failures}
Element Attribute Should Be ${elem} skipped ${skipped}
Element Attribute Should Match ${elem} time ?.???
Element Attribute Should Be ${elem} errors 0
- Element Attribute Should Be ${elem} timestamp
- ... ${{datetime.datetime.strptime($starttime, '%Y%m%d %H:%M:%S.%f').strftime('%Y-%m-%dT%H:%M:%S.%f')}}
+ Element Attribute Should Be ${elem} timestamp ${start_time.isoformat()}
Verify Outputs
Stderr should be empty
diff --git a/atest/robot/parsing/caching_libs_and_resources.robot b/atest/robot/parsing/caching_libs_and_resources.robot
index eed9f7c46de..3276fc81d6c 100644
--- a/atest/robot/parsing/caching_libs_and_resources.robot
+++ b/atest/robot/parsing/caching_libs_and_resources.robot
@@ -11,23 +11,23 @@ Import Libraries Only Once
Should Contain X Times ${SYSLOG} Found library 'BuiltIn' with arguments [ ] from cache. 2
Should Contain X Times ${SYSLOG} Imported library 'OperatingSystem' with arguments [ ] (version 1
Should Contain X Times ${SYSLOG} Found library 'OperatingSystem' with arguments [ ] from cache. 3
- Syslog Should Contain | INFO \ | Library 'OperatingSystem' already imported by suite 'Library Caching.File1'.
- Syslog Should Contain | INFO \ | Library 'OperatingSystem' already imported by suite 'Library Caching.File2'.
+ Syslog Should Contain | INFO \ | Suite 'Library Caching.File1' has already imported library 'OperatingSystem' with same arguments. This import is ignored.
+ Syslog Should Contain | INFO \ | Suite 'Library Caching.File2' has already imported library 'OperatingSystem' with same arguments. This import is ignored.
Process Resource Files Only Once
[Setup] Run Tests And Set $SYSLOG parsing/resource_parsing
# Check that tests are run ok
${tc} = Check Test Case Test 1.1
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} variable value from 02 resource
- Check Log Message ${tc.kws[1].msgs[0]} variable value from 02 resource
+ Check Log Message ${tc[0, 0, 0]} variable value from 02 resource
+ Check Log Message ${tc[1, 0]} variable value from 02 resource
${tc} = Check Test Case Test 4.1
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} variable value from 02 resource
- Check Log Message ${tc.kws[1].msgs[0]} variable value from 02 resource
+ Check Log Message ${tc[0, 0, 0]} variable value from 02 resource
+ Check Log Message ${tc[1, 0]} variable value from 02 resource
${tc} = Check Test Case Test 4.2
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} variable value from 03 resource
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} variable value from 02 resource
- Check Log Message ${tc.kws[0].kws[2].kws[0].msgs[0]} variable value from 02 resource
- Check Log Message ${tc.kws[1].msgs[0]} variable value from 03 resource
+ Check Log Message ${tc[0, 0, 0]} variable value from 03 resource
+ Check Log Message ${tc[0, 1, 0]} variable value from 02 resource
+ Check Log Message ${tc[0, 2, 0, 0]} variable value from 02 resource
+ Check Log Message ${tc[1, 0]} variable value from 03 resource
${dir} = Normalize Path ${DATADIR}/parsing/resource_parsing
Should Contain X Times ${SYSLOG} Parsing file '${dir}${/}02_resource.robot' 1
Should Contain X Times ${SYSLOG} Parsing resource file '${dir}${/}02_resource.robot' 1
diff --git a/atest/robot/parsing/custom_parsers.robot b/atest/robot/parsing/custom_parsers.robot
new file mode 100644
index 00000000000..cd720142ee9
--- /dev/null
+++ b/atest/robot/parsing/custom_parsers.robot
@@ -0,0 +1,130 @@
+*** Settings ***
+Resource atest_resource.robot
+
+*** Variables ***
+${DIR} ${{pathlib.Path(r'${DATADIR}/parsing/custom')}}
+
+*** Test Cases ***
+Single file
+ [Documentation] Also tests parser implemented as a module.
+ Run Tests --parser ${DIR}/custom.py ${DIR}/tests.custom
+ Validate Suite ${SUITE} Tests ${DIR}/tests.custom
+ ... Passing=PASS
+ ... Failing=FAIL:Error message
+ ... Empty=FAIL:Test cannot be empty.
+
+Directory
+ [Documentation] Also tests parser implemented as a class.
+ Run Tests --parser ${DIR}/CustomParser.py ${DIR}
+ Validate Directory Suite
+
+Directory with init
+ Run Tests --parser ${DIR}/CustomParser.py:init=True ${DIR}
+ Validate Directory Suite init=True
+
+Extension with multiple parts
+ [Documentation] Also tests usage with `--parse-include`.
+ Run Tests --parser ${DIR}/CustomParser.py:multi.part.ext --parse-include *.multi.part.ext ${DIR}
+ Validate Suite ${SUITE} Custom ${DIR} custom=False
+ ... Passing=PASS
+ Validate Suite ${SUITE.suites[0]} Tests ${DIR}/tests.multi.part.ext
+ ... Passing=PASS
+
+Override Robot parser
+ Run Tests --parser ${DIR}/CustomParser.py:.robot ${DIR}/tests.robot
+ Validate Suite ${SUITE} Tests ${DIR}/tests.robot
+ ... Test in Robot file=PASS
+ Run Tests --parser ${DIR}/CustomParser.py:ROBOT ${DIR}
+ Validate Suite ${SUITE} Custom ${DIR} custom=False
+ ... Test in Robot file=PASS
+ Validate Suite ${SUITE.suites[0]} Tests ${DIR}/tests.robot
+ ... Test in Robot file=PASS
+
+Multiple parsers
+ Run Tests --parser ${DIR}/CustomParser.py:ROBOT --PARSER ${DIR}/custom.py ${DIR}
+ Validate Directory Suite custom_robot=True
+
+Directory with init when parser does not support inits
+ Parsing Should Fail init
+ ... Parsing '${DIR}${/}__init__.init' failed:
+ ... 'CustomParser' does not support parsing initialization files.
+
+Incompatible parser
+ Parsing Should Fail parse=False
+ ... Importing parser '${DIR}${/}CustomParser.py' failed:
+ ... 'CustomParser' does not have mandatory 'parse' method.
+ Parsing Should Fail extension=
+ ... Importing parser '${DIR}${/}CustomParser.py' failed:
+ ... 'CustomParser' does not have mandatory 'EXTENSION' or 'extension' attribute.
+
+Failing parser
+ Parsing Should Fail fail=True
+ ... Parsing '${DIR}${/}more.custom' failed:
+ ... Calling 'CustomParser.parse()' failed:
+ ... TypeError: Ooops!
+ Parsing Should Fail fail=True:init=True
+ ... Parsing '${DIR}${/}__init__.init' failed:
+ ... Calling 'CustomParser.parse_init()' failed:
+ ... TypeError: Ooops in init!
+
+Bad return value
+ Parsing Should Fail bad_return=True
+ ... Parsing '${DIR}${/}more.custom' failed:
+ ... Calling 'CustomParser.parse()' failed:
+ ... TypeError: Return value should be 'robot.running.TestSuite', got 'string'.
+ Parsing Should Fail bad_return=True:init=True
+ ... Parsing '${DIR}${/}__init__.init' failed:
+ ... Calling 'CustomParser.parse_init()' failed:
+ ... TypeError: Return value should be 'robot.running.TestSuite', got 'integer'.
+
+*** Keywords ***
+Validate Suite
+ [Arguments] ${suite} ${name} ${source} ${custom}=True &{tests}
+ ${source} = Normalize Path ${source}
+ Should Be Equal ${suite.name} ${name}
+ Should Be Equal As Strings ${suite.source} ${source}
+ IF ${custom}
+ Should Be Equal ${suite.metadata}[Parser] Custom
+ ELSE
+ Should Not Contain ${suite.metadata} Parser
+ END
+ Should Contain Tests ${suite} &{tests}
+
+Validate Directory Suite
+ [Arguments] ${init}=False ${custom_robot}=False
+ Validate Suite ${SUITE} ${{'ðŸ“' if ${init} else 'Custom'}} ${DIR} ${init}
+ ... Passing=PASS
+ ... Failing=FAIL:Error message
+ ... Empty=FAIL:Test cannot be empty.
+ ... Test in Robot file=PASS
+ ... Yet another test=PASS
+ Validate Suite ${SUITE.suites[0]} More ${DIR}/more.custom
+ ... Yet another test=PASS
+ Validate Suite ${SUITE.suites[1]} Tests ${DIR}/tests.custom
+ ... Passing=PASS
+ ... Failing=FAIL:Error message
+ ... Empty=FAIL:Test cannot be empty.
+ Validate Suite ${SUITE.suites[2]} Tests ${DIR}/tests.robot custom=${custom robot}
+ ... Test in Robot file=PASS
+ FOR ${test} IN @{SUITE.all_tests}
+ IF ${init}
+ Should Have Tags ${test} tag from init
+ Should Be Equal ${test.timeout} 42 seconds
+ IF '${test.name}' != 'Empty'
+ Check Log Message ${test.setup[0]} setup from init
+ Check Log Message ${test.teardown[0]} teardown from init
+ END
+ ELSE
+ Should Not Be True ${test.tags}
+ Should Not Be True ${test.timeout}
+ Should Not Be True ${test.setup}
+ Should Not Be True ${test.teardown}
+ END
+ END
+
+Parsing should fail
+ [Arguments] ${config} @{error}
+ ${result} = Run Tests --parser ${DIR}/CustomParser.py:${config} ${DIR} output=None
+ ${error} = Catenate @{error}
+ Should Be Equal ${result.rc} ${252}
+ Should Be Equal ${result.stderr} [ ERROR ] ${error}${USAGETIP}
diff --git a/atest/robot/parsing/data_formats/formats_resource.robot b/atest/robot/parsing/data_formats/formats_resource.robot
index 376810d8caf..728862a7a8b 100644
--- a/atest/robot/parsing/data_formats/formats_resource.robot
+++ b/atest/robot/parsing/data_formats/formats_resource.robot
@@ -7,6 +7,7 @@ ${TSV DIR} ${FORMATS DIR}/tsv
${TXT DIR} ${FORMATS DIR}/txt
${ROBOT DIR} ${FORMATS DIR}/robot
${REST DIR} ${FORMATS DIR}/rest
+${JSON DIR} ${FORMATS DIR}/json
${MIXED DIR} ${FORMATS DIR}/mixed_data
${RESOURCE DIR} ${FORMATS DIR}/resources
@{SAMPLE TESTS} Passing Failing User Keyword Nön-äscïï Own Tags Default Tags Variable Table
@@ -16,7 +17,7 @@ ${RESOURCE DIR} ${FORMATS DIR}/resources
*** Keywords ***
Previous Run Should Have Been Successful
- Should Not Be Equal ${SUITE} ${None} Running tests failed. No Values
+ Should Not Be Equal ${SUITE} ${None} Running tests failed. values=False
Run Sample File And Check Tests
[Arguments] ${options} ${path}
@@ -32,7 +33,7 @@ Run Sample File And Check Tests
${test} = Check Test Case Test Timeout
Should Be Equal ${test.timeout} 10 milliseconds
${test} = Check Test Case Keyword Timeout
- Should Be Equal ${test.kws[0].timeout} 2 milliseconds
+ Should Be Equal ${test[0].timeout} 2 milliseconds
Check Test Doc Document Testing the metadata parsing.
${test} = Check Test Case Default Fixture
Setup Should Not Be Defined ${test}
@@ -51,15 +52,17 @@ Run Suite Dir And Check Results
Should Contain Suites ${SUITE.suites[1]} Sub Suite1 Sub Suite2
Should Contain Tests ${SUITE} @{SAMPLE_TESTS} @{SUBSUITE_TESTS}
${path} = Normalize Path ${path}
- Syslog Should Contain | INFO \ | Data source '${path}${/}invalid.${type}' has no tests or tasks.
- Syslog Should Contain | INFO \ | Data source '${path}${/}empty.${type}' has no tests or tasks.
+ IF $type != 'json'
+ Syslog Should Contain | INFO \ | Data source '${path}${/}invalid.${type}' has no tests or tasks.
+ Syslog Should Contain | INFO \ | Data source '${path}${/}empty.${type}' has no tests or tasks.
+ END
Syslog Should Contain | INFO \ | Ignoring file or directory '${path}${/}not_a_picture.jpg'.
Check Suite With Init
[Arguments] ${suite}
Should Be Equal ${suite.name} With Init
Should Be Equal ${suite.doc} Testing suite init file
- Check Log Message ${suite.setup.kws[0].messages[0]} Running suite setup
+ Check Log Message ${suite.setup[0].messages[0]} Running suite setup
Teardown Should Not Be Defined ${suite}
Should Contain Suites ${suite} Sub Suite1 Sub Suite2
Should Contain Tests ${suite} @{SUBSUITE_TESTS}
diff --git a/atest/robot/parsing/data_formats/json.robot b/atest/robot/parsing/data_formats/json.robot
new file mode 100644
index 00000000000..ebcae1ec497
--- /dev/null
+++ b/atest/robot/parsing/data_formats/json.robot
@@ -0,0 +1,32 @@
+*** Settings ***
+Resource formats_resource.robot
+
+*** Test Cases ***
+One JSON
+ Run sample file and check tests ${EMPTY} ${JSON DIR}/sample.rbt
+
+JSON With JSON Resource
+ Previous Run Should Have Been Successful
+ Check Test Case Resource File
+
+Invalid JSON Resource
+ Previous Run Should Have Been Successful
+ ${path} = Normalize Path atest/testdata/parsing/data_formats/json/sample.rbt
+ ${inva} = Normalize Path ${JSON DIR}/_invalid.json
+ Check Log Message ${ERRORS}[0]
+ ... Error in file '${path}' on line 12: Parsing JSON resource file '${inva}' failed: Loading JSON data failed: Invalid JSON data: *
+ ... level=ERROR pattern=True
+
+Invalid JSON Suite
+ ${result} = Run Tests ${EMPTY} ${JSON DIR}/_invalid.json output=None
+ Should Be Equal As Integers ${result.rc} 252
+ ${path} = Normalize Path ${JSON DIR}/_invalid.json
+ Should Start With ${result.stderr}
+ ... [ ERROR ] Parsing '${path}' failed: Loading JSON data failed: Invalid JSON data:
+
+JSON Directory
+ Run Suite Dir And Check Results -F json:rbt ${JSON DIR}
+
+Directory With JSON Init
+ Previous Run Should Have Been Successful
+ Check Suite With Init ${SUITE.suites[1]}
diff --git a/atest/robot/parsing/data_formats/resource_extensions.robot b/atest/robot/parsing/data_formats/resource_extensions.robot
index d28e15c85a7..e168ea65964 100644
--- a/atest/robot/parsing/data_formats/resource_extensions.robot
+++ b/atest/robot/parsing/data_formats/resource_extensions.robot
@@ -5,11 +5,11 @@ Resource atest_resource.robot
*** Test Cases ***
Resource with '*.resource' extension
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[1].msgs[0]} nested.resource
- Check Log Message ${tc.kws[0].kws[3].msgs[0]} resource.resource
- Check Log Message ${tc.kws[1].kws[1].msgs[0]} nested.resource
- Check Log Message ${tc.kws[4].msgs[0]} resource.resource
- Check Log Message ${tc.kws[5].msgs[0]} nested.resource
+ Check Log Message ${tc[0, 0, 1, 0]} nested.resource
+ Check Log Message ${tc[0, 3, 0]} resource.resource
+ Check Log Message ${tc[1, 1, 0]} nested.resource
+ Check Log Message ${tc[4, 0]} resource.resource
+ Check Log Message ${tc[5, 0]} nested.resource
'*.resource' files are not parsed for tests
Should Contain Suites ${SUITE} Tests
@@ -33,9 +33,15 @@ Resource with '*.rest' extension
[Tags] require-docutils
Check Test Case ${TESTNAME}
+Resource with '*.rsrc' extension
+ Check Test Case ${TESTNAME}
+
+Resource with '*.json' extension
+ Check Test Case ${TESTNAME}
+
Resource with invalid extension
Check Test Case ${TESTNAME}
- Error in file 0 parsing/data_formats/resource_extensions/tests.robot 6
+ Error in file 0 parsing/data_formats/resource_extensions/tests.robot 10
... Invalid resource file extension '.invalid'.
- ... Supported extensions are '.resource', '.robot', '.txt', '.tsv', '.rst' and '.rest'.
+ ... Supported extensions are '.json', '.resource', '.rest', '.robot', '.rsrc', '.rst', '.tsv' and '.txt'.
Length should be ${ERRORS} 1
diff --git a/atest/robot/parsing/data_formats/rest.robot b/atest/robot/parsing/data_formats/rest.robot
index 7120a31e463..6b13fb1bb58 100644
--- a/atest/robot/parsing/data_formats/rest.robot
+++ b/atest/robot/parsing/data_formats/rest.robot
@@ -5,15 +5,38 @@ Resource formats_resource.robot
*** Test Cases ***
One reST using code-directive
Run sample file and check tests ${EMPTY} ${RESTDIR}/sample.rst
- Stderr Should Be Empty
ReST With reST Resource
Previous Run Should Have Been Successful
Check Test Case Resource File
+Parsing errors have correct source
+ Previous Run Should Have Been Successful
+ Error in file 0 ${RESTDIR}/sample.rst 14
+ ... Non-existing setting 'Invalid'.
+ Error in file 1 ${RESTDIR}/../resources/rest_directive_resource.rst 3
+ ... Non-existing setting 'Invalid Resource'.
+ Length should be ${ERRORS} 2
+
ReST Directory
Run Suite Dir And Check Results -F rst:rest ${RESTDIR}
Directory With reST Init
Previous Run Should Have Been Successful
Check Suite With Init ${SUITE.suites[1]}
+
+Parsing errors in init file have correct source
+ Previous Run Should Have Been Successful
+ Error in file 0 ${RESTDIR}/sample.rst 14
+ ... Non-existing setting 'Invalid'.
+ Error in file 1 ${RESTDIR}/with_init/__init__.rst 4
+ ... Non-existing setting 'Invalid Init'.
+ Error in file 2 ${RESTDIR}/../resources/rest_directive_resource.rst 3
+ ... Non-existing setting 'Invalid Resource'.
+ Length should be ${ERRORS} 3
+
+'.robot.rst' files are parsed automatically
+ Run Tests ${EMPTY} ${RESTDIR}/with_init
+ Should Be Equal ${SUITE.name} With Init
+ Should Be Equal ${SUITE.suites[0].name} Sub Suite2
+ Should Contain Tests ${SUITE} Suite2 Test
diff --git a/atest/robot/parsing/ignore_bom.robot b/atest/robot/parsing/ignore_bom.robot
index c8bb2b799a6..6897f32c885 100644
--- a/atest/robot/parsing/ignore_bom.robot
+++ b/atest/robot/parsing/ignore_bom.robot
@@ -7,12 +7,12 @@ Resource atest_resource.robot
Byte order mark in plain text file
[Setup] File Should Have Bom parsing/bom.robot
${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]} Hyvää päivää €åppa!
+ Check log message ${tc[0, 0]} Hyvää päivää €åppa!
Byte order mark in TSV file
[Setup] File Should Have Bom parsing/bom.robot
${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]} Hyvää päivää €åppa!
+ Check log message ${tc[0, 0]} Hyvää päivää €åppa!
*** Keywords ***
File Should Have Bom
diff --git a/atest/robot/parsing/line_continuation.robot b/atest/robot/parsing/line_continuation.robot
index d90847facad..2a06b84067d 100644
--- a/atest/robot/parsing/line_continuation.robot
+++ b/atest/robot/parsing/line_continuation.robot
@@ -1,5 +1,5 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} parsing/line_continuation.robot
+Suite Setup Run Tests ${EMPTY} parsing/line_continuation.robot
Resource atest_resource.robot
*** Test Cases ***
@@ -8,13 +8,13 @@ Multiline suite documentation and metadata
Should Be Equal ${SUITE.metadata['Name']} 1.1\n1.2\n\n2.1\n2.2\n2.3\n\n3.1
Multiline suite level settings
- Should Contain Tags ${SUITE.tests[0]}
+ Should Have Tags ${SUITE.tests[0]}
... ... t1 t2 t3 t4 t5 t6 t7 t8 t9
- Check Log Message ${SUITE.tests[0].teardown.msgs[0]} 1st
- Check Log Message ${SUITE.tests[0].teardown.msgs[1]} ${EMPTY}
- Check Log Message ${SUITE.tests[0].teardown.msgs[2]} 2nd last
- Check Log Message ${SUITE.tests[0].teardown.msgs[3]} ${EMPTY}
- Length Should Be ${SUITE.tests[0].teardown.msgs} 4
+ Check Log Message ${SUITE.tests[0].teardown[0]} 1st
+ Check Log Message ${SUITE.tests[0].teardown[1]} ${EMPTY}
+ Check Log Message ${SUITE.tests[0].teardown[2]} 2nd last
+ Check Log Message ${SUITE.tests[0].teardown[3]} ${EMPTY}
+ Length Should Be ${SUITE.tests[0].teardown.body} 4
Multiline import
Check Test Case ${TEST NAME}
@@ -24,21 +24,21 @@ Multiline variables
Multiline arguments with library keyword
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} one
- Check Log Message ${tc.kws[0].msgs[1]} two
- Check Log Message ${tc.kws[0].msgs[2]} three
- Check Log Message ${tc.kws[0].msgs[3]} ${EMPTY}
- Check Log Message ${tc.kws[0].msgs[4]} four
- Check Log Message ${tc.kws[0].msgs[5]} five
+ Check Log Message ${tc[0, 0]} one
+ Check Log Message ${tc[0, 1]} two
+ Check Log Message ${tc[0, 2]} three
+ Check Log Message ${tc[0, 3]} ${EMPTY}
+ Check Log Message ${tc[0, 4]} four
+ Check Log Message ${tc[0, 5]} five
Multiline arguments with user keyword
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} 1
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} ${EMPTY}
- Check Log Message ${tc.kws[0].kws[0].msgs[2]} 2
- Check Log Message ${tc.kws[0].kws[0].msgs[3]} 3
- Check Log Message ${tc.kws[0].kws[0].msgs[4]} 4
- Check Log Message ${tc.kws[0].kws[0].msgs[5]} 5
+ Check Log Message ${tc[0, 0, 0]} 1
+ Check Log Message ${tc[0, 0, 1]} ${EMPTY}
+ Check Log Message ${tc[0, 0, 2]} 2
+ Check Log Message ${tc[0, 0, 3]} 3
+ Check Log Message ${tc[0, 0, 4]} 4
+ Check Log Message ${tc[0, 0, 5]} 5
Multiline assignment
Check Test Case ${TEST NAME}
@@ -48,20 +48,22 @@ Multiline in user keyword
Multiline test settings
${tc} = Check Test Case ${TEST NAME}
- @{expected} = Evaluate ['my'+str(i) for i in range(1,6)]
- Should Contain Tags ${tc} @{expected}
- Should Be Equal ${tc.doc} One.\nTwo.\nThree.\n\nSecond paragraph.
- Check Log Message ${tc.setup.msgs[0]} first
- Check Log Message ${tc.setup.msgs[1]} ${EMPTY}
- Check Log Message ${tc.setup.msgs[2]} last
+ Should Have Tags ${tc} @{{[f'my{i}' for i in range(1,6)]}}
+ Should Be Equal ${tc.doc} One.\nTwo.\nThree.\n\n${SPACE*32}Second paragraph.
+ Check Log Message ${tc.setup[0]} first
+ Check Log Message ${tc.setup[1]} ${EMPTY}
+ Check Log Message ${tc.setup[2]} last
-Multiline user keyword settings
- Check Test Case ${TEST NAME}
+Multiline user keyword settings and control structures
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} Multiline user keyword settings and control structures
+ ... \${x} 1, 2 tags=keyword, tags
+ Check Log Message ${tc[0].teardown[0]} Bye!
-Multiline for Loop declaration
+Multiline FOR Loop declaration
Check Test Case ${TEST NAME}
-Multiline in for loop body
+Multiline in FOR loop body
Check Test Case ${TEST NAME}
Escaped empty cells before line continuation do not work
diff --git a/atest/robot/parsing/non_ascii_spaces.robot b/atest/robot/parsing/non_ascii_spaces.robot
index c077abe9767..3a7743ec85d 100644
--- a/atest/robot/parsing/non_ascii_spaces.robot
+++ b/atest/robot/parsing/non_ascii_spaces.robot
@@ -5,19 +5,19 @@ Resource atest_resource.robot
*** Test Cases ***
In suite settings
${tc} = Check Test Case In test and keywords
- Check Log Message ${tc.setup.kws[0].msgs[0]} ':\\xa0:'
- Check Log Message ${tc.setup.kws[1].msgs[0]} :Â :
- Check Log Message ${tc.teardown.kws[0].msgs[0]} ':\\u1680:'
- Check Log Message ${tc.teardown.kws[1].msgs[0]} : :
+ Check Log Message ${tc.setup[0, 0]} ':\\xa0:'
+ Check Log Message ${tc.setup[1, 0]} :Â :
+ Check Log Message ${tc.teardown[0, 0]} ':\\u1680:'
+ Check Log Message ${tc.teardown[1, 0]} : :
In test and keywords
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} ':\\xa0:'
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} :Â :
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} ':\\u1680:'
- Check Log Message ${tc.kws[1].kws[1].msgs[0]} : :
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} ':\\u3000:'
- Check Log Message ${tc.kws[2].kws[1].msgs[0]} :　:
+ Check Log Message ${tc[0, 0, 0]} ':\\xa0:'
+ Check Log Message ${tc[0, 1, 0]} :Â :
+ Check Log Message ${tc[1, 0, 0]} ':\\u1680:'
+ Check Log Message ${tc[1, 1, 0]} : :
+ Check Log Message ${tc[2, 0, 0]} ':\\u3000:'
+ Check Log Message ${tc[2, 1, 0]} :　:
As separator
Check Test Case ${TESTNAME}
@@ -39,7 +39,10 @@ In FOR separator
In ELSE IF
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.body[0].body[3].body[0].msgs[0]} Should be executed
+ Check Log Message ${tc[0, 3, 0, 0]} Should be executed
In inline ELSE IF
Check Test Case ${TESTNAME}
+
+With embedded arguments and BDD prefixes
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/parsing/paths_are_not_case_normalized.robot b/atest/robot/parsing/paths_are_not_case_normalized.robot
index b47e380b3dd..82a599a17ad 100644
--- a/atest/robot/parsing/paths_are_not_case_normalized.robot
+++ b/atest/robot/parsing/paths_are_not_case_normalized.robot
@@ -7,7 +7,7 @@ Suite name is not case normalized
Should Be Equal ${SUITE.name} suiTe 8
Suite source should not be case normalized
- Should End With ${SUITE.source} multiple_suites${/}suiTe_8.robot
+ Should Be True str($SUITE.source).endswith(r'multiple_suites${/}suiTe_8.robot')
Outputs are not case normalized
Stdout Should Contain ${/}LOG.html
diff --git a/atest/robot/parsing/same_setting_multiple_times.robot b/atest/robot/parsing/same_setting_multiple_times.robot
index 4e5c3224ff6..82854d277c9 100644
--- a/atest/robot/parsing/same_setting_multiple_times.robot
+++ b/atest/robot/parsing/same_setting_multiple_times.robot
@@ -5,111 +5,76 @@ Resource atest_resource.robot
*** Test Cases ***
Suite Documentation
Should Be Equal ${SUITE.doc} S1
- Setting multiple times 0 3 Documentation
Suite Metadata
Should Be Equal ${SUITE.metadata['Foo']} M2
Suite Setup
- Should Be Equal ${SUITE.setup.name} BuiltIn.Log Many
- Setting multiple times 1 7 Suite Setup
+ Should Be Equal ${SUITE.setup.full_name} BuiltIn.Log Many
Suite Teardown
- Should Be Equal ${SUITE.teardown.name} BuiltIn.Comment
- Setting multiple times 2 9 Suite Teardown
+ Should Be Equal ${SUITE.teardown.full_name} BuiltIn.Comment
Force and Default Tags
Check Test Tags Use Defaults D1
- Setting multiple times 7 18 Force Tags
- Setting multiple times 8 19 Force Tags
- Setting multiple times 9 21 Default Tags
- Setting multiple times 10 22 Default Tags
Test Setup
${tc} = Check Test Case Use Defaults
- Should Be Equal ${tc.setup.name} BuiltIn.Log Many
- Setting multiple times 3 11 Test Setup
+ Should Be Equal ${tc.setup.full_name} BuiltIn.Log Many
Test Teardown
${tc} = Check Test Case Use Defaults
Teardown Should Not Be Defined ${tc}
- Setting multiple times 4 13 Test Teardown
Test Template
${tc} = Check Test Case Use Defaults
- Check Keyword Data ${tc.kws[0]} BuiltIn.Log Many args=Sleep, 0.1s
- Setting multiple times 6 16 Test Template
+ Check Keyword Data ${tc[0]} BuiltIn.Log Many args=Sleep, 0.1s
Test Timeout
${tc} = Check Test Case Use Defaults
Should Be Equal ${tc.timeout} 1 second
- Setting multiple times 11 24 Test Timeout
Test [Documentation]
${tc} = Check Test Case Test Settings
- Should Be Equal ${tc.doc} T1
- Setting multiple times 12 32 Documentation
+ Should Be Equal ${tc[0].type} ERROR
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0].values[0]} [Documentation]
Test [Tags]
Check Test Tags Test Settings
- Setting multiple times 13 34 Tags
- Setting multiple times 14 35 Tags
Test [Setup]
${tc} = Check Test Case Test Settings
- Should Be Equal ${tc.setup.name} BuiltIn.Log Many
- Setting multiple times 15 37 Setup
+ Should Be Equal ${tc.setup.full_name} BuiltIn.Log Many
Test [Teardown]
${tc} = Check Test Case Test Settings
Teardown Should Not Be Defined ${tc}
- Setting multiple times 16 39 Teardown
- Setting multiple times 17 40 Teardown
Test [Template]
${tc} = Check Test Case Test Settings
- Check Keyword Data ${tc.kws[0]} BuiltIn.Log args=No Operation
- Setting multiple times 18 42 Template
+ Check Keyword Data ${tc[7]} BuiltIn.Log args=No Operation
Test [Timeout]
${tc} = Check Test Case Test Settings
Should Be Equal ${tc.timeout} 2 seconds
- Setting multiple times 19 44 Timeout
Keyword [Arguments]
${tc} = Check Test Case Keyword Settings
- Check Keyword Data ${tc.kws[0]} Keyword Settings assign=\${ret} args=1, 2, 3 tags=K1
- Check Log Message ${tc.kws[0].msgs[0]} Arguments: [ \${a1}='1' | \${a2}='2' | \${a3}='3' ] TRACE
- Setting multiple times 20 55 Arguments
+ Check Keyword Data ${tc[0]} Keyword Settings assign=\${ret} args=1, 2, 3 tags=K1 status=FAIL
+ Check Log Message ${tc[0, 0]} Arguments: [ \${a1}='1' | \${a2}='2' | \${a3}='3' ] TRACE
Keyword [Documentation]
${tc} = Check Test Case Keyword Settings
- Should Be Equal ${tc.kws[0].doc} ${EMPTY}
- Setting multiple times 21 57 Documentation
- Setting multiple times 22 58 Documentation
+ Should Be Equal ${tc[0].doc} ${EMPTY}
Keyword [Tags]
${tc} = Check Test Case Keyword Settings
- Should Be True list($tc.kws[0].tags) == ['K1']
- Setting multiple times 23 60 Tags
+ Should Be True list($tc[0].tags) == ['K1']
Keyword [Timeout]
${tc} = Check Test Case Keyword Settings
- Should Be Equal ${tc.kws[0].timeout} ${NONE}
- Setting multiple times 24 62 Timeout
- Setting multiple times 25 63 Timeout
+ Should Be Equal ${tc[0].timeout} ${NONE}
Keyword [Return]
- ${tc} = Check Test Case Keyword Settings
- Check Log Message ${tc.kws[0].msgs[1]} Return: 'R0' TRACE
- Check Log Message ${tc.kws[0].msgs[2]} \${ret} = R0
- Setting multiple times 26 66 Return
- Setting multiple times 27 67 Return
- Setting multiple times 28 68 Return
-
-*** Keywords ***
-Setting multiple times
- [Arguments] ${index} ${lineno} ${setting}
- Error In File
- ... ${index} parsing/same_setting_multiple_times.robot ${lineno}
- ... Setting '${setting}' is allowed only once. Only the first value is used.
+ Check Test Case Keyword Settings
diff --git a/atest/robot/parsing/spaces_and_tabs.robot b/atest/robot/parsing/spaces_and_tabs.robot
index 1d514e1903a..f517f7239ae 100644
--- a/atest/robot/parsing/spaces_and_tabs.robot
+++ b/atest/robot/parsing/spaces_and_tabs.robot
@@ -14,16 +14,16 @@ Lot of spaces
Trailing spaces
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} No spaces at end
- Check Log Message ${tc.kws[1].msgs[0]} One space at end
- Check Log Message ${tc.kws[2].msgs[0]} Two spaces at end
- Check Log Message ${tc.kws[3].msgs[0]} Ten spaces at end
- Check Log Message ${tc.kws[4].msgs[0]} Tab at end
+ Check Log Message ${tc[0, 0]} No spaces at end
+ Check Log Message ${tc[1, 0]} One space at end
+ Check Log Message ${tc[2, 0]} Two spaces at end
+ Check Log Message ${tc[3, 0]} Ten spaces at end
+ Check Log Message ${tc[4, 0]} Tab at end
Tabs
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} I ignore tabs DEBUG
+ Check Log Message ${tc[0, 0]} I ignore tabs DEBUG
Tabs and spaces
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} I ignore tabs (and spaces) DEBUG
+ Check Log Message ${tc[0, 0]} I ignore tabs (and spaces) DEBUG
diff --git a/atest/robot/parsing/suite_metadata.robot b/atest/robot/parsing/suite_metadata.robot
index 64b3162ddd1..b0e359f485e 100644
--- a/atest/robot/parsing/suite_metadata.robot
+++ b/atest/robot/parsing/suite_metadata.robot
@@ -12,14 +12,14 @@ Metadata
NAME Value
Metadata In Multiple Columns
- Multiple columns Value in multiple columns
+ Multiple columns Value in${SPACE*4}multiple${SPACE*4}columns
Metadata In Multiple Lines
Multiple lines Metadata in multiple lines
... is parsed using
- ... same semantics as documentation.
+ ... same semantics${SPACE*4}as${SPACE*4}documentation.
... | table |
- ... | ! |
+ ... |${SPACE*3}!${SPACE*3}|
Metadata With Variables
Variables Version: 1.2
diff --git a/atest/robot/parsing/suite_names.robot b/atest/robot/parsing/suite_names.robot
new file mode 100644
index 00000000000..329ff59104a
--- /dev/null
+++ b/atest/robot/parsing/suite_names.robot
@@ -0,0 +1,45 @@
+*** Settings ***
+Documentation Tests for default and custom suite names.
+... Using `--name` is tested elsewhere.
+Suite Setup Run Tests ${EMPTY} misc/suites misc/multiple_suites
+Test Template Should Be Equal
+Resource atest_resource.robot
+
+*** Test Cases ***
+Combined suite name
+ ${SUITE.name} Suites & Multiple Suites
+
+Directory suite name
+ ${SUITE.suites[0].name} Suites
+ ${SUITE.suites[1].name} Multiple Suites
+
+File suite name
+ ${SUITE.suites[0].suites[1].name} Fourth
+ ${SUITE.suites[1].suites[9].name} Suite 9 Name
+
+Names with upper case chars are not title cased
+ ${SUITE.suites[1].suites[7].name} SUite7
+ ${SUITE.suites[1].suites[8].name} suiTe 8
+ ${SUITE.suites[1].suites[1].suites[1].name} .Sui.te.2.
+
+Spaces are preserved
+ ${SUITE.suites[1].suites[6].name} Suite 6
+
+Dots in name
+ ${SUITE.suites[1].suites[1].name} Sub.Suite.1
+ ${SUITE.suites[1].suites[1].suites[1].name} .Sui.te.2.
+
+Name with prefix
+ ${SUITE.suites[0].suites[0].name} Suite With Prefix
+ ${SUITE.suites[0].suites[0].suites[0].name} Tests With Prefix
+ ${SUITE.suites[1].suites[1].name} Sub.Suite.1
+
+Name with double underscore at end
+ ${SUITE.suites[0].suites[4].name} Suite With Double Underscore
+ ${SUITE.suites[0].suites[4].suites[0].name} Tests With Double Underscore
+
+Custom directory suite name
+ ${SUITE.suites[0].suites[3].name} Custom name for 📂 'subsuites2'
+
+Custom file suite name
+ ${SUITE.suites[0].suites[3].suites[1].name} Custom name for 📜 'subsuite3.robot'
diff --git a/atest/robot/parsing/suite_settings.robot b/atest/robot/parsing/suite_settings.robot
index c890b0a0b4d..40a69865eee 100644
--- a/atest/robot/parsing/suite_settings.robot
+++ b/atest/robot/parsing/suite_settings.robot
@@ -7,7 +7,7 @@ Resource atest_resource.robot
*** Test Cases ***
Suite Name
- Should Be Equal ${SUITE.name} Suite Settings
+ Should Be Equal ${SUITE.name} Custom name
Suite Documentation
${doc} = Catenate SEPARATOR=\n
@@ -16,11 +16,14 @@ Suite Documentation
... is shortdoc on console.
...
... Documentation can have multiple rows
- ... and also multiple columns.
+ ... and${SPACE*4}also${SPACE*4}multiple${SPACE*4}columns.
+ ...
... Newlines can also be added literally with "\n".
+ ... If a row ends with a newline
+ ... or backslash no automatic newline is added.
...
... | table | =header= |
- ... | foo | bar |
+ ... | foo${SPACE*3}|${SPACE*4}bar${SPACE*3}|
... | ragged |
...
... Variables work since Robot 1.2 and doc_from_cli works too.
@@ -30,8 +33,8 @@ Suite Documentation
Should Be Equal ${SUITE.doc} ${doc}
Suite Name And Documentation On Console
- Stdout Should Contain Suite Settings :: 1st logical line (i.e. paragraph) is shortdoc on console.${SPACE * 3}\n
- Stdout Should Contain Suite Settings :: 1st logical line (i.e. paragraph) is shortdoc on... | PASS |\n
+ Stdout Should Contain Custom name :: 1st logical line (i.e. paragraph) is shortdoc on console.${SPACE * 6}\n
+ Stdout Should Contain Custom name :: 1st logical line (i.e. paragraph) is shortdoc on co... | PASS |\n
Test Setup
${test} = Check Test Case Test Case
@@ -51,11 +54,11 @@ Suite Teardown
Verify Teardown ${SUITE} BuiltIn.Log Default suite teardown
Invalid Setting
- Error In File 0 parsing/suite_settings.robot 27
+ Error In File 0 parsing/suite_settings.robot 32
... Non-existing setting 'Invalid Setting'.
Small typo should provide recommendation.
- Error In File 1 parsing/suite_settings.robot 28
+ Error In File 1 parsing/suite_settings.robot 33
... SEPARATOR=\n
... Non-existing setting 'Megadata'. Did you mean:
... ${SPACE*4}Metadata
@@ -71,5 +74,5 @@ Verify Teardown
Verify Fixture
[Arguments] ${fixture} ${expected_name} ${expected_message}
- Should be Equal ${fixture.name} ${expected_name}
+ Should be Equal ${fixture.full_name} ${expected_name}
Check Log Message ${fixture.messages[0]} ${expected_message}
diff --git a/atest/robot/parsing/table_names.robot b/atest/robot/parsing/table_names.robot
index 6224f229644..21d8109333e 100644
--- a/atest/robot/parsing/table_names.robot
+++ b/atest/robot/parsing/table_names.robot
@@ -3,47 +3,55 @@ Suite Setup Run Tests ${EMPTY} parsing/table_names.robot
Resource atest_resource.robot
*** Test Cases ***
-Setting Table
- Should Be Equal ${SUITE.doc} Testing different ways to write "Setting(s)".
+Settings section
+ Should Be Equal ${SUITE.doc} Testing different ways to write "Settings".
Check Test Tags Test Case Settings
-Variable Table
- Check First Log Entry Test Case Variable
- Check First Log Entry Test Cases Variables
+Variables section
+ Check First Log Entry Test Case Variables
+ Check First Log Entry Test Cases VARIABLES
-Test Case Table
+Test Cases section
Check Test Case Test Case
Check Test Case Test Cases
-Keyword Table
+Keywords section
${tc} = Check Test Case Test Case
- Check Log Message ${tc.kws[1].kws[0].kws[0].msgs[0]} "Keywords" was executed
+ Check Log Message ${tc[1, 0, 0, 0]} "Keywords" was executed
-Comment Table
- Check Test Case Comment tables exist
- Length Should Be ${ERRORS} 1
+Comments section
+ Check Test Case Comment section exist
+ Length Should Be ${ERRORS} 6
-Section Names Are Space Sensitive
+Section names are space sensitive
${path} = Normalize Path ${DATADIR}/parsing/table_names.robot
Invalid Section Error 0 table_names.robot 43 * * * K e y w o r d * * *
-Invalid Tables
+Singular headers are deprecated
+ Should Be Equal ${SUITE.metadata['Singular headers']} Deprecated
+ Check Test Case Singular headers are deprecated
+ Deprecated Section Warning 1 table_names.robot 47 *** Setting *** *** Settings ***
+ Deprecated Section Warning 2 table_names.robot 49 *** variable*** *** Variables ***
+ Deprecated Section Warning 3 table_names.robot 51 ***TEST CASE*** *** Test Cases ***
+ Deprecated Section Warning 4 table_names.robot 54 *keyword *** Keywords ***
+ Deprecated Section Warning 5 table_names.robot 57 *** Comment *** *** Comments ***
+
+Invalid sections
[Setup] Run Tests ${EMPTY} parsing/invalid_table_names.robot
${tc} = Check Test Case Test in valid table
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Keyword in valid table
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} Keyword in valid table in resource
- Length Should Be ${ERRORS} 5
+ ${path} = Normalize Path ${DATADIR}/parsing/invalid_tables_resource.robot
+ Check Log Message ${tc[0, 0, 0]} Keyword in valid table
+ Length Should Be ${ERRORS} 4
Invalid Section Error 0 invalid_table_names.robot 1 *** Error ***
Invalid Section Error 1 invalid_table_names.robot 8 *** ***
- Invalid Section Error 2 invalid_table_names.robot 17 *one more table cause an error
- Invalid Section Error 3 invalid_tables_resource.robot 1 *** *** test and task=
- Invalid Section Error 4 invalid_tables_resource.robot 10 ***Resource Error*** test and task=
+ Invalid Section Error 2 invalid_table_names.robot 18 *one more table cause an error
+ Error In File 3 parsing/invalid_table_names.robot 6 Error in file '${path}' on line 1: Unrecognized section header '*** ***'. Valid sections: 'Settings', 'Variables', 'Keywords' and 'Comments'.
*** Keywords ***
Check First Log Entry
[Arguments] ${test case name} ${expected}
${tc} = Check Test Case ${test case name}
- Check Log Message ${tc.kws[0].msgs[0]} ${expected}
+ Check Log Message ${tc[0, 0]} ${expected}
Invalid Section Error
[Arguments] ${index} ${file} ${lineno} ${header} ${test and task}=, 'Test Cases', 'Tasks'
@@ -51,3 +59,9 @@ Invalid Section Error
... Unrecognized section header '${header}'.
... Valid sections: 'Settings', 'Variables'${test and task},
... 'Keywords' and 'Comments'.
+
+Deprecated Section Warning
+ [Arguments] ${index} ${file} ${lineno} ${used} ${expected}
+ Error In File ${index} parsing/${file} ${lineno}
+ ... Singular section headers like '${used}' are deprecated. Use plural format like '${expected}' instead.
+ ... level=WARN
diff --git a/atest/robot/parsing/test_case_settings.robot b/atest/robot/parsing/test_case_settings.robot
index d366d9656bc..b321b6df9ea 100644
--- a/atest/robot/parsing/test_case_settings.robot
+++ b/atest/robot/parsing/test_case_settings.robot
@@ -42,17 +42,21 @@ Documentation
Verify Documentation Documentation in single line and column.
Documentation in multiple columns
- Verify Documentation Documentation for this test case in multiple columns
+ Verify Documentation Documentation${SPACE*4}for this test case${SPACE*4}in multiple columns
Documentation in multiple rows
Verify Documentation 1st logical line
... is shortdoc.
...
... This documentation has multiple rows
- ... and also multiple columns.
+ ... and also${SPACE*4}multiple columns.
+ ...
+ ... Newlines can also be added literally with "\n".
+ ... If a row ends with a newline
+ ... or backslash no automatic newline is added.
...
... | table | =header= |
- ... | foo | bar |
+ ... | foo${SPACE*3}|${SPACE*4}bar${SPACE*3}|
... | ragged |
Documentation with variables
@@ -87,7 +91,7 @@ Empty and NONE tags are ignored
Duplicate tags are ignored and first used format has precedence
[Documentation] Case, space and underscore insensitive
- Verify Tags FORCE-1 Test_1 test 2
+ Verify Tags force-1 Test_1 test 2
Tags in multiple rows
Verify Tags force-1 test-0 test-1 test-2 test-3 test-4 test-5
@@ -141,17 +145,12 @@ Setup and teardown with escaping
Template
[Documentation] Mainly tested elsewhere
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Hello, world!
- Check Log Message ${tc.kws[1].msgs[0]} Hi, tellus!
+ Check Log Message ${tc[0, 0]} Hello, world!
+ Check Log Message ${tc[1, 0]} Hi, tellus!
Timeout
Verify Timeout 1 day
-Timeout with message
- Verify Timeout 1 minute 39 seconds 999 milliseconds
- Error In File 0 parsing/test_case_settings.robot 184
- ... Setting 'Timeout' accepts only one value, got 2.
-
Default timeout
Verify Timeout 1 minute 39 seconds 999 milliseconds
@@ -176,15 +175,13 @@ Multiple settings
Invalid setting
Check Test Case ${TEST NAME}
- Error In File 1 parsing/test_case_settings.robot 217
- ... Non-existing setting 'Invalid'.
+
+Setting not valid with tests
+ Check Test Case ${TEST NAME}
Small typo should provide recommendation
- Check Test Doc ${TEST NAME}
- Error In File 2 parsing/test_case_settings.robot 221
- ... SEPARATOR=\n
- ... Non-existing setting 'Doc U ment a tion'. Did you mean:
- ... ${SPACE*4}Documentation
+ Check Test Case ${TEST NAME}
+
*** Keywords ***
Verify Documentation
@@ -200,14 +197,14 @@ Verify Tags
Verify Setup
[Arguments] ${message}
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.setup.name} BuiltIn.Log
- Check Log Message ${tc.setup.msgs[0]} ${message}
+ Should Be Equal ${tc.setup.full_name} BuiltIn.Log
+ Check Log Message ${tc.setup[0]} ${message}
Verify Teardown
[Arguments] ${message}
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.teardown.name} BuiltIn.Log
- Check Log Message ${tc.teardown.msgs[0]} ${message}
+ Should Be Equal ${tc.teardown.full_name} BuiltIn.Log
+ Check Log Message ${tc.teardown[0]} ${message}
Verify Timeout
[Arguments] ${timeout}
diff --git a/atest/robot/parsing/test_suite_names.robot b/atest/robot/parsing/test_suite_names.robot
deleted file mode 100644
index 278160739de..00000000000
--- a/atest/robot/parsing/test_suite_names.robot
+++ /dev/null
@@ -1,47 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests ${EMPTY} misc/multiple_suites
-Resource atest_resource.robot
-Documentation Giving suite names from commandline is tested in robot/cli/runner/suite_name_doc_and_metadata.txt
-
-
-*** Test Cases ***
-Root Directory Suite Name
- Should Be Equal ${SUITE.name} Multiple Suites
-
-Prefix Is Removed From File Suite Name
- Should Be Equal ${SUITE.suites[0].name} Suite First
-
-Prefix Is Removed From Directory Suite Name
- Should Be Equal ${SUITE.suites[1].name} Sub.Suite.1
-
-Child File Suite Name
- Should Be Equal ${SUITE.suites[6].name} Suite 6
-
-Child Directory Suite Name
- Should Be Equal ${SUITE.suites[1].name} Sub.Suite.1
-
-Dots in suite names
- Should Be Equal ${SUITE.suites[1].name} Sub.Suite.1
- Should Be Equal ${SUITE.suites[1].suites[1].name} .Sui.te.2.
-
-Names without uppercase chars are titlecased
- Should Be Equal ${SUITE.suites[1].name} Sub.Suite.1
- Should Be Equal ${SUITE.suites[6].name} Suite 6
- Should Be Equal ${SUITE.suites[9].name} Suite 9 Name
-
-Names with uppercase chars are not titlecased
- Should Be Equal ${SUITE.suites[7].name} SUite7
- Should Be Equal ${SUITE.suites[8].name} suiTe 8
- Should Be Equal ${SUITE.suites[1].suites[1].name} .Sui.te.2.
-
-Underscores are converted to spaces
- Should Be Equal ${SUITE.suites[8].name} suiTe 8
- Should Be Equal ${SUITE.suites[9].name} Suite 9 Name
-
-Spaces are preserved
- Should Be Equal ${SUITE.suites[6].name} Suite 6
-
-Root File Suite Name
- [Setup] Run Tests ${EMPTY} misc/pass_and_fail.robot
- Should Be Equal ${SUITE.name} Pass And Fail
-
diff --git a/atest/robot/parsing/translations.robot b/atest/robot/parsing/translations.robot
new file mode 100644
index 00000000000..ebf6386d6e0
--- /dev/null
+++ b/atest/robot/parsing/translations.robot
@@ -0,0 +1,108 @@
+*** Settings ***
+Resource atest_resource.robot
+
+*** Test Cases ***
+Finnish
+ Run Tests --language fi parsing/translations/finnish/tests.robot
+ Validate Translations
+
+Finnish task aliases
+ [Documentation]
+ ... Also tests that
+ ... - '--language' works when running a directory,
+ ... - it is possible to use language class docstring, and
+ ... - '-' is ignored in the given name to support e.g. 'pt-br'.
+ Run Tests --language fin-nish --rpa parsing/translations/finnish
+ Validate Task Translations
+
+Custom
+ Run Tests --lang ${DATADIR}/parsing/translations/custom/custom.py parsing/translations/custom/tests.robot
+ Validate Translations
+
+Custom task aliases
+ Run Tests --lang ${DATADIR}/parsing/translations/custom/custom.py --rpa parsing/translations/custom/tasks.robot
+ Validate Task Translations
+
+Custom Per file configuration
+ Run Tests -P ${DATADIR}/parsing/translations/custom parsing/translations/custom/custom_per_file.robot
+ Validate Translations
+
+Invalid
+ ${result} = Run Tests Without Processing Output --lang bad parsing/finnish.robot
+ Should Be Equal ${result.rc} ${252}
+ Should Be Empty ${result.stdout}
+ ${error} = Catenate SEPARATOR=\n
+ ... Invalid value for option '--language': Importing language file 'bad' failed: ModuleNotFoundError: No module named 'bad'
+ ... Traceback \\(most recent call last\\):
+ ... .*${USAGE TIP}
+ Should Match Regexp ${result.stderr} ^\\[ ERROR \\] ${error}$ flags=DOTALL
+
+Per file configuration
+ Run Tests ${EMPTY} parsing/translations/per_file_config/fi.robot
+ Validate Translations
+
+Per file configuration with multiple languages
+ Run Tests ${EMPTY} parsing/translations/per_file_config/many.robot
+ Should Be Equal ${SUITE.doc} Exemplo
+ ${tc} = Check Test Case ตัวà¸à¸¢à¹ˆà¸²à¸‡
+ Should Be Equal ${tc.doc} приклад
+
+Invalid per file configuration
+ Error in file 0 parsing/translations/per_file_config/many.robot 4
+ ... Invalid language configuration:
+ ... Language 'invalid' not found nor importable as a language module.
+ Error in file 1 parsing/translations/per_file_config/many.robot 5
+ ... Invalid language configuration:
+ ... Language 'another invalid value' not found nor importable as a language module.
+
+Per file configuration bleeds to other files
+ [Documentation] This is a technical limitation and will hopefully change!
+ Run Tests ${EMPTY} parsing/translations/per_file_config/fi.robot parsing/translations/finnish/tests.robot
+ Validate Translations ${SUITE.suites[0]}
+ Validate Translations ${SUITE.suites[1]}
+
+*** Keywords ***
+Validate Translations
+ [Arguments] ${suite}=${SUITE}
+ Should Be Equal ${suite.name} Custom name
+ Should Be Equal ${suite.doc} Suite documentation.
+ Should Be Equal ${suite.metadata}[Metadata] Value
+ Should Be Equal ${suite.setup.full_name} Suite Setup
+ Should Be Equal ${suite.teardown.full_name} Suite Teardown
+ Should Be Equal ${suite.status} PASS
+ ${tc} = Check Test Case Test without settings
+ Should Be Equal ${tc.doc} ${EMPTY}
+ Should Be Equal ${tc.tags} ${{['test', 'tags']}}
+ Should Be Equal ${tc.timeout} 1 minute
+ Should Be Equal ${tc.setup.full_name} Test Setup
+ Should Be Equal ${tc.teardown.full_name} Test Teardown
+ Should Be Equal ${tc[0].full_name} Test Template
+ Should Be Equal ${tc[0].tags} ${{['keyword', 'tags']}}
+ ${tc} = Check Test Case Test with settings
+ Should Be Equal ${tc.doc} Test documentation.
+ Should Be Equal ${tc.tags} ${{['test', 'tags', 'own tag']}}
+ Should Be Equal ${tc.timeout} ${NONE}
+ Should Be Equal ${tc.setup.full_name} ${NONE}
+ Should Be Equal ${tc.teardown.full_name} ${NONE}
+ Should Be Equal ${tc[0].full_name} Keyword
+ Should Be Equal ${tc[0].doc} Keyword documentation.
+ Should Be Equal ${tc[0].tags} ${{['keyword', 'tags', 'own tag']}}
+ Should Be Equal ${tc[0].timeout} 1 hour
+ Should Be Equal ${tc[0].setup.full_name} BuiltIn.Log
+ Should Be Equal ${tc[0].teardown.full_name} BuiltIn.No Operation
+
+Validate Task Translations
+ ${tc} = Check Test Case Task without settings
+ Should Be Equal ${tc.doc} ${EMPTY}
+ Should Be Equal ${tc.tags} ${{['task', 'tags']}}
+ Should Be Equal ${tc.timeout} 1 minute
+ Should Be Equal ${tc.setup.full_name} Task Setup
+ Should Be Equal ${tc.teardown.full_name} Task Teardown
+ Should Be Equal ${tc[0].full_name} Task Template
+ ${tc} = Check Test Case Task with settings
+ Should Be Equal ${tc.doc} Task documentation.
+ Should Be Equal ${tc.tags} ${{['task', 'tags', 'own tag']}}
+ Should Be Equal ${tc.timeout} ${NONE}
+ Should Be Equal ${tc.setup.full_name} ${NONE}
+ Should Be Equal ${tc.teardown.full_name} ${NONE}
+ Should Be Equal ${tc[0].full_name} BuiltIn.Log
diff --git a/atest/robot/parsing/user_keyword_settings.robot b/atest/robot/parsing/user_keyword_settings.robot
index bad894c487d..8ab9eaec0ea 100644
--- a/atest/robot/parsing/user_keyword_settings.robot
+++ b/atest/robot/parsing/user_keyword_settings.robot
@@ -5,12 +5,12 @@ Resource atest_resource.robot
*** Test Cases ***
Name
${tc} = Check Test Case Normal name
- Should Be Equal ${tc.kws[0].name} Normal name
+ Should Be Equal ${tc[0].full_name} Normal name
Names are not formatted
${tc} = Check Test Case Names are not formatted
- FOR ${kw} IN @{tc.kws}
- Should Be Equal ${kw.name} user_keyword nameS _are_not_ FORmatted
+ FOR ${kw} IN @{tc.body}
+ Should Be Equal ${kw.full_name} user_keyword nameS _are_not_ FORmatted
END
No documentation
@@ -20,7 +20,7 @@ Documentation
Verify Documentation Documentation for this user keyword
Documentation in multiple columns
- Verify Documentation Documentation for this user keyword in multiple columns
+ Verify Documentation Documentation${SPACE * 4}for this user keyword${SPACE*10}in multiple columns
Documentation in multiple rows
Verify Documentation 1st line is shortdoc.
@@ -43,19 +43,19 @@ Documentation with escaping
Arguments
[Documentation] Tested more thoroughly elsewhere.
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} mandatory
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} default
- Should Be True ${tc.kws[0].args} == ('mandatory',)
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} 1
- Check Log Message ${tc.kws[1].kws[0].msgs[1]} 2
- Should Be True ${tc.kws[1].args} == ('1', '2')
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} 1
- Check Log Message ${tc.kws[2].kws[0].msgs[1]} 2
- Check Log Message ${tc.kws[2].kws[0].msgs[2]} 3
- Check Log Message ${tc.kws[2].kws[0].msgs[3]} 4
- Check Log Message ${tc.kws[2].kws[0].msgs[4]} 5
- Check Log Message ${tc.kws[2].kws[0].msgs[5]} key=6
- Should Be True ${tc.kws[2].args} == ('\${1}', '\${2}', '\${3}', '\${4}', '\${5}', 'key=\${6}')
+ Check Log Message ${tc[0, 0, 0]} mandatory
+ Check Log Message ${tc[0, 0, 1]} default
+ Should Be True ${tc[0].args} == ('mandatory',)
+ Check Log Message ${tc[1, 0, 0]} 1
+ Check Log Message ${tc[1, 0, 1]} 2
+ Should Be True ${tc[1].args} == ('1', '2')
+ Check Log Message ${tc[2, 0, 0]} 1
+ Check Log Message ${tc[2, 0, 1]} 2
+ Check Log Message ${tc[2, 0, 2]} 3
+ Check Log Message ${tc[2, 0, 3]} 4
+ Check Log Message ${tc[2, 0, 4]} 5
+ Check Log Message ${tc[2, 0, 5]} key=6
+ Should Be True ${tc[2].args} == ('\${1}', '\${2}', '\${3}', '\${4}', '\${5}', 'key=\${6}')
Teardown
Verify Teardown Keyword teardown
@@ -67,16 +67,33 @@ Teardown with escaping
Verify Teardown \${notvar} is not a variable
Return
- Check Test Case ${TEST NAME}
+ [Documentation] [Return] is deprecated. In parsing it is transformed to RETURN.
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0].values} ${{('Return value',)}}
+ Error in File 0 parsing/user_keyword_settings.robot 167
+ ... The '[[]Return]' setting is deprecated. Use the 'RETURN' statement instead. level=WARN
Return using variables
- Check Test Case ${TEST NAME}
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0, 1].type} RETURN
+ Should Be Equal ${tc[0, 1].values} ${{('\${ret}',)}}
+ Error in File 1 parsing/user_keyword_settings.robot 171
+ ... The '[[]Return]' setting is deprecated. Use the 'RETURN' statement instead. level=WARN
Return multiple
- Check Test Case ${TEST NAME}
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0, 1].type} RETURN
+ Should Be Equal ${tc[0, 1].values} ${{('\${arg1}', '+', '\${arg2}', '=', '\${result}')}}
+ Error in File 2 parsing/user_keyword_settings.robot 176
+ ... The '[[]Return]' setting is deprecated. Use the 'RETURN' statement instead. level=WARN
Return with escaping
- Check Test Case ${TEST NAME}
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0].values} ${{('\\\${XXX}', 'c:\\\\temp', '\\', '\\\\')}}
+ Error in File 3 parsing/user_keyword_settings.robot 179
+ ... The '[[]Return]' setting is deprecated. Use the 'RETURN' statement instead. level=WARN
Timeout
Verify Timeout 2 minutes 3 seconds
@@ -89,41 +106,36 @@ Invalid timeout
Multiple settings
Verify Documentation Documentation for a user keyword
- Verify Teardown Teardown World
- Verify Timeout 6 minutes
+ Verify Teardown Teardown World
+ Verify Timeout 6 minutes
Invalid setting
Check Test Case ${TEST NAME}
- Error In File 0 parsing/user_keyword_settings.robot 195
- ... Non-existing setting 'Invalid Setting'.
- Error In File 1 parsing/user_keyword_settings.robot 199
- ... Non-existing setting 'invalid'.
-Small typo should provide recommendation
+Setting not valid with user keywords
Check Test Case ${TEST NAME}
- Error In File 2 parsing/user_keyword_settings.robot 203
- ... SEPARATOR=\n
- ... Non-existing setting 'Doc Umentation'. Did you mean:
- ... ${SPACE*4}Documentation
-Invalid empty line continuation in arguments should throw an error
- Error in File 3 parsing/user_keyword_settings.robot 206
- ... Creating keyword 'Invalid empty line continuation in arguments should throw an error' failed: Invalid argument specification: Invalid argument syntax ''.
+Small typo should provide recommendation
+ Check Test Case ${TEST NAME}
+Invalid empty line continuation in arguments should throw an error
+ Error in File 4 parsing/user_keyword_settings.robot 214
+ ... Creating keyword 'Invalid empty line continuation in arguments should throw an error' failed:
+ ... Invalid argument specification: Invalid argument syntax ''.
*** Keywords ***
Verify Documentation
[Arguments] ${doc} ${test}=${TEST NAME}
${tc} = Check Test Case ${test}
- Should Be Equal ${tc.kws[0].doc} ${doc}
+ Should Be Equal ${tc[0].doc} ${doc}
Verify Teardown
[Arguments] ${message}
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].teardown.name} BuiltIn.Log
- Check Log Message ${tc.kws[0].teardown.msgs[0]} ${message}
+ Should Be Equal ${tc[0].teardown.full_name} BuiltIn.Log
+ Check Log Message ${tc[0].teardown[0]} ${message}
Verify Timeout
[Arguments] ${timeout}
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].timeout} ${timeout}
+ Should Be Equal ${tc[0].timeout} ${timeout}
diff --git a/atest/robot/parsing/utf8_data/utf8_in_tsv.robot b/atest/robot/parsing/utf8_data/utf8_in_tsv.robot
index 5cf83c7bd4a..8b63e3cd8cf 100644
--- a/atest/robot/parsing/utf8_data/utf8_in_tsv.robot
+++ b/atest/robot/parsing/utf8_data/utf8_in_tsv.robot
@@ -1,25 +1,25 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} parsing/utf8_data.tsv
-Resource atest_resource.robot
+Suite Setup Run Tests ${EMPTY} parsing/utf8_data.tsv
+Resource atest_resource.robot
*** Test Cases ***
UTF-8 In Metadata
- Should Be Equal ${SUITE.doc} Testing that reading and writing of Unicode (äöå §½€ etc.) works properly.
- Should Be Equal as Strings ${SUITE.metadata} {Ä: §}
- Check Test Tags UTF-8 tag-§ tag-€
- Check Test Doc UTF-8 äöå §½€
+ Should Be Equal ${SUITE.doc} Testing that reading and writing of Unicode (äöå §½€ etc.) works properly.
+ Should Be Equal As Strings ${SUITE.metadata} {Ä: §}
+ Check Test Tags UTF-8 tag-§ tag-€
+ Check Test Doc UTF-8 äöå §½€
UTF-8 In Keyword Arguments
- ${tc} = Check Test Case UTF-8
- Check Log Message ${tc.setup.msgs[0]} äöå
- Check Log Message ${tc.kws[0].msgs[0]} §½€
- Check Log Message ${tc.kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} äöå
- Check Log Message ${tc.kws[2].kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[2].kws[2].msgs[0]} §½€
+ ${tc} = Check Test Case UTF-8
+ Check Log Message ${tc.setup[0]} äöå
+ Check Log Message ${tc[0, 0]} §½€
+ Check Log Message ${tc[1, 0]} äöå §½€
+ Check Log Message ${tc[2, 0, 0]} äöå
+ Check Log Message ${tc[2, 1, 0]} äöå §½€
+ Check Log Message ${tc[2, 2, 0]} §½€
UTF-8 In Test Case And UK Names
- ${tc} = Check Test Case UTF-8 Name Äöå §½€"
- Check Keyword Data ${tc.kws[0]} Äöå §½€ \${ret}
- Check Log Message ${tc.kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[3].msgs[0]} value
+ ${tc} = Check Test Case UTF-8 Name Äöå §½€"
+ Check Keyword Data ${tc[0]} Äöå §½€ \${ret}
+ Check Log Message ${tc[1, 0]} äöå §½€
+ Check Log Message ${tc[3, 0]} value
diff --git a/atest/robot/parsing/utf8_data/utf8_in_txt.robot b/atest/robot/parsing/utf8_data/utf8_in_txt.robot
index fca9e1856d3..c22049aa238 100644
--- a/atest/robot/parsing/utf8_data/utf8_in_txt.robot
+++ b/atest/robot/parsing/utf8_data/utf8_in_txt.robot
@@ -1,25 +1,25 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} parsing/utf8_data.robot
-Resource atest_resource.robot
+Suite Setup Run Tests ${EMPTY} parsing/utf8_data.robot
+Resource atest_resource.robot
*** Test Cases ***
UTF-8 In Metadata
- Should Be Equal ${SUITE.doc} Testing that reading and writing of Unicode (äöå §½€ etc.) works properly.
- Should Be Equal as Strings ${SUITE.metadata} {Ä: §}
- Check Test Tags UTF-8 tag-§ tag-€
- Check Test Doc UTF-8 äöå §½€
+ Should Be Equal ${SUITE.doc} Testing that reading and writing of Unicode (äöå §½€ etc.) works properly.
+ Should Be Equal As Strings ${SUITE.metadata} {Ä: §}
+ Check Test Tags UTF-8 tag-§ tag-€
+ Check Test Doc UTF-8 äöå §½€
UTF-8 In Keyword Arguments
- ${tc} = Check Test Case UTF-8
- Check Log Message ${tc.setup.msgs[0]} äöå
- Check Log Message ${tc.kws[0].msgs[0]} §½€
- Check Log Message ${tc.kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} äöå
- Check Log Message ${tc.kws[2].kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[2].kws[2].msgs[0]} §½€
+ ${tc} = Check Test Case UTF-8
+ Check Log Message ${tc.setup[0]} äöå
+ Check Log Message ${tc[0, 0]} §½€
+ Check Log Message ${tc[1, 0]} äöå §½€
+ Check Log Message ${tc[2, 0, 0]} äöå
+ Check Log Message ${tc[2, 1, 0]} äöå §½€
+ Check Log Message ${tc[2, 2, 0]} §½€
UTF-8 In Test Case And UK Names
- ${tc} = Check Test Case UTF-8 Name Äöå §½€"
- Check Keyword Data ${tc.kws[0]} Äöå §½€ \${ret}
- Check Log Message ${tc.kws[1].msgs[0]} äöå §½€
- Check Log Message ${tc.kws[3].msgs[0]} value
+ ${tc} = Check Test Case UTF-8 Name Äöå §½€"
+ Check Keyword Data ${tc[0]} Äöå §½€ \${ret}
+ Check Log Message ${tc[1, 0]} äöå §½€
+ Check Log Message ${tc[3, 0]} value
diff --git a/atest/robot/rebot/combine.robot b/atest/robot/rebot/combine.robot
index 02612e85ab3..f8aedbd16ad 100644
--- a/atest/robot/rebot/combine.robot
+++ b/atest/robot/rebot/combine.robot
@@ -81,49 +81,34 @@ Suite Metadata
Should Be Equal ${SUITE2.metadata['Other Meta']} Another value
Suite Times
- Should Be Equal ${SUITE3.starttime} ${NONE}
- Should Be Equal ${SUITE3.endtime} ${NONE}
- Elapsed Time Should Be Valid ${SUITE3.elapsedtime}
- Should Be True ${SUITE3.elapsedtime} == ${MILLIS1} + ${MILLIS2} + 9999
- Timestamp Should Be Valid ${SUITE3.suites[0].starttime}
- Timestamp Should Be Valid ${SUITE3.suites[0].endtime}
- Elapsed Time Should Be Valid ${SUITE3.suites[0].elapsedtime}
- Should Be Equal ${SUITE3.suites[0].elapsedtime} ${MILLIS1}
- Timestamp Should Be Valid ${SUITE3.suites[1].starttime}
- Timestamp Should Be Valid ${SUITE3.suites[1].endtime}
- Elapsed Time Should Be Valid ${SUITE3.suites[1].elapsedtime}
- Should Be Equal ${SUITE3.suites[1].elapsedtime} ${MILLIS2}
- Should Be Equal ${SUITE3.suites[2].starttime} 20061227 11:59:59.000
- Should Be Equal ${SUITE3.suites[2].endtime} 20061227 12:00:08.999
- Should Be Equal ${SUITE3.suites[2].elapsedtime} ${9999}
+ Should Be Equal ${SUITE3.start_time} ${NONE}
+ Should Be Equal ${SUITE3.end_time} ${NONE}
+ Elapsed Time Should Be ${SUITE3.elapsed_time} ${ELAPSED1} + ${ELAPSED2} + 9.999
+ Timestamp Should Be Valid ${SUITE3.suites[0].start_time}
+ Timestamp Should Be Valid ${SUITE3.suites[0].end_time}
+ Elapsed Time Should Be ${SUITE3.suites[0].elapsed_time} ${ELAPSED1}
+ Timestamp Should Be Valid ${SUITE3.suites[1].start_time}
+ Timestamp Should Be Valid ${SUITE3.suites[1].end_time}
+ Elapsed Time Should Be ${SUITE3.suites[1].elapsed_time} ${ELAPSED2}
+ Timestamp Should Be ${SUITE3.suites[2].start_time} 2006-12-27 11:59:59
+ Timestamp Should Be ${SUITE3.suites[2].end_time} 2006-12-27 12:00:08.999
+ Elapsed Time Should Be ${SUITE3.suites[2].elapsed_time} 9.999
Suite Times In Recombine
- Should Be Equal ${SUITE4.starttime} ${NONE}
- Should Be Equal ${SUITE4.endtime} ${NONE}
- Should Be True ${SUITE4.elapsedtime} == 9999 + ${MILLIS1} + ${MILLIS2}
- Should Be Equal ${SUITE4.suites[0].starttime} 20061227 11:59:59.000
- Should Be Equal ${SUITE4.suites[0].endtime} 20061227 12:00:08.999
- Should Be Equal ${SUITE4.suites[0].elapsedtime} ${9999}
- Should Be Equal ${SUITE4.suites[1].starttime} ${NONE}
- Should Be Equal ${SUITE4.suites[1].endtime} ${NONE}
- Timestamp Should Be Valid ${SUITE4.suites[1].suites[0].starttime}
- Timestamp Should Be Valid ${SUITE4.suites[1].suites[0].endtime}
- Elapsed Time Should Be Valid ${SUITE4.suites[1].suites[0].elapsedtime}
- Should Be Equal ${SUITE4.suites[1].suites[0].elapsedtime} ${MILLIS1}
- Timestamp Should Be Valid ${SUITE4.suites[1].suites[1].starttime}
- Timestamp Should Be Valid ${SUITE4.suites[1].suites[1].endtime}
- Elapsed Time Should Be Valid ${SUITE4.suites[1].suites[1].elapsedtime}
- Should Be Equal ${SUITE4.suites[1].suites[1].elapsedtime} ${MILLIS2}
-
-Elapsed Time Should Be Written To Output When Start And End Time Are Not Known
- ${combined} = Get Element ${COMB OUT 1} suite/status
- Element Attribute Should Be ${combined} starttime N/A
- Element Attribute Should Be ${combined} endtime N/A
- Should Be True int($combined.get('elapsedtime')) >= 0
- ${originals} = Get Elements ${COMB OUT 1} suite/suite/status
- Element Attribute Should Match ${originals[0]} starttime 20?????? ??:??:??.???
- Element Attribute Should Match ${originals[0]} endtime 20?????? ??:??:??.???
- Element Should Not Have Attribute ${originals[0]} elapsedtime
+ Should Be Equal ${SUITE4.start_time} ${NONE}
+ Should Be Equal ${SUITE4.end_time} ${NONE}
+ Elapsed Time Should Be ${SUITE4.elapsed_time} ${ELAPSED1} + ${ELAPSED2} + 9.999
+ Timestamp Should Be ${SUITE4.suites[0].start_time} 2006-12-27 11:59:59
+ Timestamp Should Be ${SUITE4.suites[0].end_time} 2006-12-27 12:00:08.999
+ Elapsed Time Should Be ${SUITE4.suites[0].elapsed_time} 9.999
+ Should Be Equal ${SUITE4.suites[1].start_time} ${NONE}
+ Should Be Equal ${SUITE4.suites[1].end_time} ${NONE}
+ Timestamp Should Be Valid ${SUITE4.suites[1].suites[0].start_time}
+ Timestamp Should Be Valid ${SUITE4.suites[1].suites[0].end_time}
+ Elapsed Time Should Be ${SUITE4.suites[1].suites[0].elapsed_time} ${ELAPSED1}
+ Timestamp Should Be Valid ${SUITE4.suites[1].suites[1].start_time}
+ Timestamp Should Be Valid ${SUITE4.suites[1].suites[1].end_time}
+ Elapsed Time Should Be ${SUITE4.suites[1].suites[1].elapsed_time} ${ELAPSED2}
Combined Suite Names Are Correct In Statistics
${suites} = Get Suite Stat Nodes ${COMB OUT 1}
@@ -152,11 +137,11 @@ Create inputs for Rebot
Create first input for Rebot
Create Output With Robot ${TEMP OUT 1} ${EMPTY} misc/pass_and_fail.robot
- Set Suite Variable $MILLIS1 ${ORIG ELAPSED}
+ Set Suite Variable $ELAPSED1 ${ORIG ELAPSED.total_seconds()}
Create second input for Rebot
Create Output With Robot ${TEMP OUT 2} ${EMPTY} misc/normal.robot
- Set Suite Variable $MILLIS2 ${ORIG ELAPSED}
+ Set Suite Variable $ELAPSED2 ${ORIG ELAPSED.total_seconds()}
Combine without options
Run Rebot ${EMPTY} ${TEMP OUT 1} ${TEMP OUT 2}
diff --git a/atest/robot/rebot/compatibility.robot b/atest/robot/rebot/compatibility.robot
index 1c5ed3bc3d8..4df330d0753 100644
--- a/atest/robot/rebot/compatibility.robot
+++ b/atest/robot/rebot/compatibility.robot
@@ -15,18 +15,23 @@ RF 4.0 compatibility
RF 5.0 compatibility
Run Rebot And Validate Statistics rebot/output-5.0.xml 175 10
+Suite only
+ Run Rebot And Validate Statistics rebot/suite_only.xml 179 10 3
+
Message directly under test
Run Rebot And Validate Statistics rebot/issue-3762.xml 1 0
${tc} = Check Test Case test A
- Check Log Message ${tc.body[0]} Hi from test WARN
- Check Log Message ${tc.body[1].body[0]} Hi from keyword WARN
- Check Log Message ${tc.body[2]} Hi from test again INFO
+ Check Log Message ${tc[0]} Hi from test WARN
+ Check Log Message ${tc[1, 0]} Hi from keyword WARN
+ Check Log Message ${tc[2]} Hi from test again INFO
*** Keywords ***
Run Rebot And Validate Statistics
- [Arguments] ${path} ${passed} ${failed} ${validate}=True
+ [Arguments] ${path} ${passed} ${failed} ${skipped}=0 ${validate}=True
Run Rebot ${EMPTY} ${path} validate output=${validate}
- ${total} ${passed} ${failed} = Evaluate ${passed} + ${failed}, ${passed}, ${failed}
- Should Be Equal ${SUITE.statistics.total} ${total}
- Should Be Equal ${SUITE.statistics.passed} ${passed}
- Should Be Equal ${SUITE.statistics.failed} ${failed}
+ ${total} ${passed} ${failed} ${skipped} =
+ ... Evaluate ${passed} + ${failed} + ${skipped}, ${passed}, ${failed}, ${skipped}
+ Should Be Equal ${SUITE.statistics.total} ${total}
+ Should Be Equal ${SUITE.statistics.passed} ${passed}
+ Should Be Equal ${SUITE.statistics.failed} ${failed}
+ Should Be Equal ${SUITE.statistics.skipped} ${skipped}
diff --git a/atest/robot/rebot/filter_by_names.robot b/atest/robot/rebot/filter_by_names.robot
index 66d9275c572..971b8a36e7a 100644
--- a/atest/robot/rebot/filter_by_names.robot
+++ b/atest/robot/rebot/filter_by_names.robot
@@ -25,7 +25,7 @@ ${INPUT FILE} %{TEMPDIR}${/}robot-test-file.xml
--test not matching
Failing Rebot
... Suite 'Root' contains no tests matching name 'nonex'.
- ... --test nonex ${INPUT FILE}
+ ... --test nonex
--test not matching with multiple inputs
Failing Rebot
@@ -35,6 +35,18 @@ ${INPUT FILE} %{TEMPDIR}${/}robot-test-file.xml
... Suite 'My Name' contains no tests matching name 'nonex'.
... --test nonex -N "My Name" ${INPUT FILE} ${INPUT FILE}
+--test and --include must both match
+ Run And Check Tests --test first --include t1 -i f1 First
+ Failing Rebot
+ ... Suite 'Root' contains no tests matching name 'fifth' and matching tag 't1'.
+ ... --test fifth --include t1
+
+--exclude wins over --test
+ Run And Check Tests --test fi* --exclude t1 Fifth
+ Failing Rebot
+ ... Suite 'Root' contains no tests matching name 'first' and not matching tag 'f1'.
+ ... --test first --exclude f1
+
--suite once
Run And Check Suites --suite tsuite1 Tsuite1
@@ -51,10 +63,11 @@ ${INPUT FILE} %{TEMPDIR}${/}robot-test-file.xml
Should Contain Suites ${SUITE} Suites
Should Contain Suites ${SUITE.suites[0].suites[0]} Sub1 Sub2
---suite with end of long name
- Run And Check Suites --suite suites.subsuites Subsuites
- Should Contain Suites ${SUITE} Suites
- Should Contain Suites ${SUITE.suites[0].suites[0]} Sub1 Sub2
+--suite matching end of long name is not enough anymore
+ [Documentation] This was supported until RF 7.0.
+ Failing Rebot
+ ... Suite 'Root' contains no tests in suite 'suites.subsuites'.
+ ... --suite suites.subsuites ${INPUT FILE}
--suite not matching
Failing Rebot
@@ -70,33 +83,50 @@ ${INPUT FILE} %{TEMPDIR}${/}robot-test-file.xml
... --name CustomName --suite nonex ${INPUT FILE} ${INPUT FILE}
--suite and --test together
- Run And Check Suites and Tests --suite tsuite1 --suite tsuite3 --test *1first --test nomatch Tsuite1 Suite1 First
+ [Documentation] Validate that only tests matching --test under suites matching --suite are selected.
+ Run Suites --suite root.*.tsuite2 --suite manytests --test *first* --test nomatch --log log
+ Should Contain Suites ${SUITE} Many Tests Suites
+ Should Contain Tests ${SUITE.suites[0]} First
+ Should Contain Tests ${SUITE.suites[1]} Suite2 First
+ Check Stats
--suite and --test together not matching
Failing Rebot
... Suite 'Root' contains no tests matching name 'first', 'nonex' or '*one' in suites 'nonex' or 'suites'.
... --suite nonex --suite suites --test first --test nonex --test *one ${INPUT FILE}
+--suite with --include/--exclude
+ Run Suites --suite tsuite[13] --include t? --exclude t2
+ Should Contain Suites ${SUITE} Suites
+ Should Contain Suites ${SUITE.suites[0]} Tsuite1 Tsuite3
+ Should Contain Tests ${SUITE} Suite1 First Suite3 First
+
+--suite, --test, --include and --exclude
+ Run Suites --suite sub* --suite "custom name *" --test "subsuite3 second" -t *first -s nomatch -t nomatch --include f1 --exclude t1
+ Should Contain Suites ${SUITE} Suites
+ Should Contain Suites ${SUITE.suites[0]} Custom name for 📂 'subsuites2' Subsuites
+ Should Contain Tests ${SUITE} SubSuite2 First SubSuite3 Second
+
Elapsed Time
[Documentation] Test setting start, end and elapsed times correctly when filtering by tags
- Comment 1) Rebot hand-edited output with predefined times and check that times are read correctly. (A sanity check)
+ # 1) Rebot hand-edited output with predefined times and check that times are read correctly. (A sanity check)
Run Rebot ${EMPTY} rebot${/}times.xml
- Check Times ${SUITE.tests[0]} 20061227 12:00:00.000 20061227 12:00:01.000 1000 # Incl-1
- Check Times ${SUITE.tests[1]} 20061227 12:00:01.000 20061227 12:00:03.000 2000 # Incl-12
- Check Times ${SUITE.tests[2]} 20061227 12:00:03.000 20061227 12:00:07.000 4000 # Incl-123
- Check Times ${SUITE.tests[3]} 20061227 12:00:07.000 20061227 12:00:07.001 0001 # Excl-1
- Check Times ${SUITE.tests[4]} 20061227 12:00:07.001 20061227 12:00:07.003 0002 # Excl-12
- Check Times ${SUITE.tests[5]} 20061227 12:00:07.003 20061227 12:00:07.007 0004 # Excl-123
- Check Times ${SUITE} 20061227 11:59:59.000 20061227 12:00:08.999 9999 # Suite
+ Times Should Be ${SUITE.tests[0]} 2006-12-27 12:00:00.000 2006-12-27 12:00:01.000 1.000 # Incl-1
+ Times Should Be ${SUITE.tests[1]} 2006-12-27 12:00:01.000 2006-12-27 12:00:03.000 2.000 # Incl-12
+ Times Should Be ${SUITE.tests[2]} 2006-12-27 12:00:03.000 2006-12-27 12:00:07.000 4.000 # Incl-123
+ Times Should Be ${SUITE.tests[3]} 2006-12-27 12:00:07.000 2006-12-27 12:00:07.001 0.001 # Excl-1
+ Times Should Be ${SUITE.tests[4]} 2006-12-27 12:00:07.001 2006-12-27 12:00:07.003 0.002 # Excl-12
+ Times Should Be ${SUITE.tests[5]} 2006-12-27 12:00:07.003 2006-12-27 12:00:07.007 0.004 # Excl-123
+ Times Should Be ${SUITE} 2006-12-27 11:59:59.000 2006-12-27 12:00:08.999 9.999 # Suite
Should Be Equal As Integers ${SUITE.test_count} 6
- Comment 2) Filter output created in earlier step and check that times are set accordingly.
+ # 2) Filter output created in earlier step and check that times are set accordingly.
Copy Previous Outfile
Run Rebot --test Exc* --test Incl-1 ${OUTFILE COPY}
- Check Times ${SUITE.tests[0]} 20061227 12:00:00.000 20061227 12:00:01.000 1000 # Incl-1
- Check Times ${SUITE.tests[1]} 20061227 12:00:07.000 20061227 12:00:07.001 0001 # Excl-1
- Check Times ${SUITE.tests[2]} 20061227 12:00:07.001 20061227 12:00:07.003 0002 # Excl-12
- Check Times ${SUITE.tests[3]} 20061227 12:00:07.003 20061227 12:00:07.007 0004 # Excl-123
- Check Times ${SUITE} ${NONE} ${NONE} 1007 # Suite
+ Times Should Be ${SUITE.tests[0]} 2006-12-27 12:00:00.000 2006-12-27 12:00:01.000 1.000 # Incl-1
+ Times Should Be ${SUITE.tests[1]} 2006-12-27 12:00:07.000 2006-12-27 12:00:07.001 0.001 # Excl-1
+ Times Should Be ${SUITE.tests[2]} 2006-12-27 12:00:07.001 2006-12-27 12:00:07.003 0.002 # Excl-12
+ Times Should Be ${SUITE.tests[3]} 2006-12-27 12:00:07.003 2006-12-27 12:00:07.007 0.004 # Excl-123
+ Times Should Be ${SUITE} ${NONE} ${NONE} 1.007 # Suite
Should Be Equal As Integers ${SUITE.test_count} 4
*** Keywords ***
@@ -106,9 +136,9 @@ Create Input File
Remove Temps
Remove Directory ${MYOUTDIR} recursive
- Remove FIle ${INPUT FILE}
+ Remove File ${INPUT FILE}
-Run and check Tests
+Run and Check Tests
[Arguments] ${params} @{tests}
Run Rebot ${params} ${INPUT FILE}
Stderr Should Be Empty
@@ -118,10 +148,9 @@ Run and check Tests
Check Stats
Should Be True ${SUITE.statistics.failed} == 0
- Should Be Equal ${SUITE.starttime} ${NONE}
- Should Be Equal ${SUITE.endtime} ${NONE}
- Elapsed Time Should Be Valid ${SUITE.elapsedtime}
- Should Be True ${SUITE.elapsedtime} <= ${ORIGELAPSED}
+ Should Be Equal ${SUITE.start_time} ${NONE}
+ Should Be Equal ${SUITE.end_time} ${NONE}
+ Elapsed Time Should Be Valid ${SUITE.elapsed_time} maximum=${ORIG_ELAPSED.total_seconds()}
Run and Check Suites
[Arguments] ${params} @{suites}
@@ -129,20 +158,12 @@ Run and Check Suites
Should Contain Suites ${SUITE.suites[0]} @{suites}
Check Stats
-Run And Check Suites and Tests
- [Arguments] ${params} ${subsuite} @{tests}
- Run Suites ${params}
- Should Contain Suites ${SUITE.suites[0]} ${subsuite}
- Should Contain Tests ${SUITE} @{tests}
- Should Be True ${SUITE.statistics.passed} == len(@{tests})
- Check Stats
-
Run Suites
[Arguments] ${options}
Run Rebot ${options} ${INPUT FILE}
Stderr Should Be Empty
Failing Rebot
- [Arguments] ${error} ${options} ${sources}
+ [Arguments] ${error} ${options} ${sources}=${INPUT FILE}
Run Rebot Without Processing Output ${options} ${sources}
Stderr Should Be Equal To [ ERROR ] ${error}${USAGE TIP}\n
diff --git a/atest/robot/rebot/json_output_and_input.robot b/atest/robot/rebot/json_output_and_input.robot
new file mode 100644
index 00000000000..e02631ce7f6
--- /dev/null
+++ b/atest/robot/rebot/json_output_and_input.robot
@@ -0,0 +1,66 @@
+*** Settings ***
+Suite Setup Create XML and JSON outputs
+Resource rebot_resource.robot
+
+*** Variables ***
+${XML} %{TEMPDIR}/rebot.xml
+${JSON} %{TEMPDIR}/rebot.json
+
+*** Test Cases ***
+JSON output contains same suite information as XML output
+ Outputs Should Contain Same Data ${JSON} ${XML}
+
+JSON output structure
+ [Documentation] JSON schema validation would be good, but it's too slow with big output files.
+ ... The test after this one validates a smaller suite against a schema.
+ ${data} = Evaluate json.load(open($JSON, encoding='UTF-8'))
+ Lists Should Be Equal ${data} ${{['generator', 'generated', 'rpa', 'suite', 'statistics', 'errors']}}
+ Should Match ${data}[generator] Rebot ?.* (* on *)
+ Should Match ${data}[generated] 20??-??-??T??:??:??.??????
+ Should Be Equal ${data}[rpa] ${False}
+ Should Be Equal ${data}[suite][name] Misc
+ Should Be Equal ${data}[suite][suites][2][name] Everything
+ Should Be Equal ${data}[statistics][total][skip] ${3}
+ Should Be Equal ${data}[statistics][tags][4][label] f1
+ Should Be Equal ${data}[statistics][suites][-1][id] s1-s18
+ Should Be Equal ${data}[errors][0][level] ERROR
+
+JSON output schema validation
+ [Tags] require-jsonschema
+ Run Rebot Without Processing Output --suite Everything --output %{TEMPDIR}/everything.json ${JSON}
+ Validate JSON Output %{TEMPDIR}/everything.json
+
+JSON input
+ Run Rebot ${EMPTY} ${JSON}
+ Outputs Should Contain Same Data ${JSON} ${OUTFILE}
+
+JSON input combined
+ Run Rebot ${EMPTY} ${XML} ${XML}
+ Copy Previous Outfile # Expected result
+ Run Rebot ${EMPTY} ${JSON} ${XML}
+ Outputs Should Contain Same Data ${OUTFILE} ${OUTFILE COPY}
+ Run Rebot ${EMPTY} ${JSON} ${JSON}
+ Outputs Should Contain Same Data ${OUTFILE} ${OUTFILE COPY}
+
+Invalid JSON input
+ Create File ${JSON} bad
+ Run Rebot Without Processing Output ${EMPTY} ${JSON}
+ ${json} = Normalize Path ${JSON}
+ VAR ${error}
+ ... Reading JSON source '${json}' failed:
+ ... Loading JSON data failed:
+ ... Invalid JSON data: *
+ Stderr Should Match [[] ERROR ] ${error}${USAGE TIP}\n
+
+Non-existing JSON input
+ Run Rebot Without Processing Output ${EMPTY} non_existing.json
+ ${json} = Normalize Path ${DATADIR}/non_existing.json
+ VAR ${error}
+ ... Reading JSON source '${json}' failed:
+ ... No such file or directory
+ Stderr Should Match [[] ERROR ] ${error}${USAGE TIP}\n
+
+*** Keywords ***
+Create XML and JSON outputs
+ Create Output With Robot ${XML} ${EMPTY} misc
+ Run Rebot Without Processing Output --output ${JSON} ${XML}
diff --git a/atest/robot/rebot/merge.robot b/atest/robot/rebot/merge.robot
index 90b0a2acb1b..b2539d6214a 100644
--- a/atest/robot/rebot/merge.robot
+++ b/atest/robot/rebot/merge.robot
@@ -15,11 +15,11 @@ ${MERGE 2} %{TEMPDIR}/merge-2.xml
... Suite1 First Suite1 Second
... Test With Double Underscore Test With Prefix Third In Suite1
... Suite2 First Suite3 First
-@{ALL SUITES} Fourth Subsuites Subsuites2
+@{ALL SUITES} Fourth Subsuites Custom name for 📂 'subsuites2'
... Suite With Double Underscore Suite With Prefix
... Tsuite1 Tsuite2 Tsuite3
@{SUB SUITES 1} Sub1 Sub2
-@{SUB SUITES 2} Sub.suite.4 Subsuite3
+@{SUB SUITES 2} Sub.suite.4 Custom name for 📜 'subsuite3.robot'
@{RERUN TESTS} Suite4 First SubSuite1 First
@{RERUN SUITES} Fourth Subsuites
@@ -33,6 +33,14 @@ Merge suite setup and teardown
[Setup] Should Be Equal ${PREV_TEST_STATUS} PASS
Suite setup and teardown should have been merged
+Merge suite documentation and metadata
+ [Setup] Should Be Equal ${PREV_TEST_STATUS} PASS
+ Suite documentation and metadata should have been merged
+
+Suite elapsed time should be updated
+ [Setup] Should Be Equal ${PREV_TEST_STATUS} PASS
+ Should Be True $SUITE.elapsed_time > $ORIGINAL_ELAPSED
+
Merge re-executed and re-re-executed tests
Re-run tests
Re-re-run tests
@@ -66,9 +74,9 @@ Using other options
... --merge. Most importantly verify that options handled
... by ExecutionResult (--flattenkeyword) work correctly.
Re-run tests
- Run merge --nomerge --log log.html --merge --flattenkeyword name:BuiltIn.Log --name Custom
+ Run merge --nomerge --log log.html --merge --flattenkeyword name:BuiltIn.Fail --name Custom
Test merge should have been successful suite name=Custom
- Log should have been created with all Log keywords flattened
+ Log should have been created with Fail keywords flattened
Merge ignores skip
Create Output With Robot ${ORIGINAL} ${EMPTY} rebot/merge_statuses.robot
@@ -78,14 +86,20 @@ Merge ignores skip
... *HTML* Test has been re-executed and results merged.
... Latter result had SKIP status and was ignored. Message:
Should Contain Tests ${SUITE}
- ... Pass=PASS:${prefix}\nTest skipped using '--skip' command line option.
- ... Fail=FAIL:${prefix}\nTest skipped using '--skip' command line option.Original message:\nNot <b>HTML</b> fail
+ ... Pass=PASS:${prefix}\nTest skipped using 'NOT skip' tag pattern.
+ ... Fail=FAIL:${prefix}\nTest skipped using 'NOT skip' tag pattern.Original message:\nNot <b>HTML</b> fail
... Skip=SKIP:${prefix}\nHTML skipOriginal message:\nHTML skip
*** Keywords ***
Run original tests
- Create Output With Robot ${ORIGINAL} --variable FAIL:YES --variable LEVEL:WARN ${SUITES}
+ ${options} = Catenate
+ ... --variable FAIL:YES
+ ... --variable LEVEL:WARN
+ ... --doc "Doc for original run"
+ ... --metadata Original:True
+ Create Output With Robot ${ORIGINAL} ${options} ${SUITES}
Verify original tests
+ VAR ${ORIGINAL ELAPSED} ${SUITE.elapsed_time} scope=SUITE
Verify original tests
Should Be Equal ${SUITE.name} Suites
@@ -98,12 +112,15 @@ Verify original tests
Re-run tests
[Arguments] ${options}=
${options} = Catenate
+ ... --doc "Doc for re-run"
+ ... --metadata ReRun:True
... --variable SUITE_SETUP:NoOperation # Affects misc/suites/__init__.robot
... --variable SUITE_TEARDOWN:NONE # -- ;; --
... --variable SETUP_MSG:Rerun! # Affects misc/suites/fourth.robot
... --variable TEARDOWN_MSG:New! # -- ;; --
... --variable SETUP:NONE # Affects misc/suites/subsuites/sub1.robot
... --variable TEARDOWN:NONE # -- ;; --
+ ... --variable SLEEP:0.5 # -- ;; --
... --rerunfailed ${ORIGINAL} ${options}
Create Output With Robot ${MERGE 1} ${options} ${SUITES}
Should Be Equal ${SUITE.name} Suites
@@ -164,15 +181,20 @@ Test merge should have been successful
... ${SUITE.suites[7]}
Suite setup and teardown should have been merged
- Should Be Equal ${SUITE.setup.name} BuiltIn.No Operation
+ Should Be Equal ${SUITE.setup.full_name} BuiltIn.No Operation
Should Be Equal ${SUITE.teardown.name} ${NONE}
Should Be Equal ${SUITE.suites[1].name} Fourth
- Check Log Message ${SUITE.suites[1].setup.msgs[0]} Rerun!
- Check Log Message ${SUITE.suites[1].teardown.msgs[0]} New!
+ Check Log Message ${SUITE.suites[1].setup[0]} Rerun!
+ Check Log Message ${SUITE.suites[1].teardown[0]} New!
Should Be Equal ${SUITE.suites[2].suites[0].name} Sub1
Should Be Equal ${SUITE.suites[2].suites[0].setup.name} ${NONE}
Should Be Equal ${SUITE.suites[2].suites[0].teardown.name} ${NONE}
+Suite documentation and metadata should have been merged
+ Should Be Equal ${SUITE.doc} Doc for re-run
+ Should Be Equal ${SUITE.metadata}[ReRun] True
+ Should Be Equal ${SUITE.metadata}[Original] True
+
Test add should have been successful
Should Be Equal ${SUITE.name} Suites
Should Contain Suites ${SUITE} @{ALL SUITES}
@@ -227,7 +249,7 @@ Warnings should have been merged
Check Log Message ${ERRORS[0]} Original message WARN
Check Log Message ${ERRORS[1]} Override WARN
${tc} = Check Test Case SubSuite1 First
- Check Log Message ${tc.kws[0].msgs[0]} Override WARN
+ Check Log Message ${tc[0, 0]} Override WARN
Merge should have failed
Stderr Should Be Equal To
@@ -237,15 +259,15 @@ Merge should have failed
Timestamps should be cleared
[Arguments] @{suites}
FOR ${suite} IN @{suites}
- Should Be Equal ${suite.starttime} ${None}
- Should Be Equal ${suite.endtime} ${None}
+ Should Be Equal ${suite.start_time} ${None}
+ Should Be Equal ${suite.end_time} ${None}
END
Timestamps should be set
[Arguments] @{suites}
FOR ${suite} IN @{suites}
- Timestamp Should Be Valid ${suite.starttime}
- Timestamp Should Be Valid ${suite.endtime}
+ Timestamp Should Be Valid ${suite.start_time}
+ Timestamp Should Be Valid ${suite.end_time}
END
Create expected merge message header
@@ -300,7 +322,6 @@ Create expected multi-merge message
... ${message 1}
... ${message 2}
-Log should have been created with all Log keywords flattened
+Log should have been created with Fail keywords flattened
${log} = Get File ${OUTDIR}/log.html
- Should Not Contain ${log} "*
Logs the given message with the given level.\\x3c/p>"
- Should Contain ${log} "*
Logs the given message with the given level.\\x3c/p>\\n
Content flattened.\\x3c/b>\\x3c/i>\\x3c/p>"
+ Should Contain ${log} "*Content flattened."
diff --git a/atest/robot/rebot/start_and_endtime_from_cli.robot b/atest/robot/rebot/start_and_endtime_from_cli.robot
index 6f2f424f7a3..b22cdc84d2b 100644
--- a/atest/robot/rebot/start_and_endtime_from_cli.robot
+++ b/atest/robot/rebot/start_and_endtime_from_cli.robot
@@ -9,67 +9,67 @@ ${INPUT2} %{TEMPDIR}${/}rebot-test-b.xml
${COMBINED} %{TEMPDIR}${/}combined.xml
*** Test Cases ***
-Combine With Both Starttime and endtime should Set Correct Elapsed Time
+Combine with both start time and end time
Log Many ${INPUT1} ${INPUT2}
- Run Rebot --starttime 2007:09:25:21:51 --endtime 2007:09:26:01:12:30.200 ${INPUT1} ${INPUT2}
- Should Be Equal ${SUITE.starttime} 20070925 21:51:00.000
- Should Be Equal ${SUITE.endtime} 20070926 01:12:30.200
- Should Be True ${SUITE.elapsedtime} == (3*60*60 + 21*60 + 30) * 1000 + 200
+ Run Rebot --starttime 2007:09:25:21:51 --endtime 2007-09-26T01:12:30.200 ${INPUT1} ${INPUT2}
+ Should Be Equal ${SUITE.start_time} ${datetime(2007, 9, 25, 21, 51)}
+ Should Be Equal ${SUITE.end_time} ${datetime(2007, 9, 26, 1, 12, 30, 200000)}
+ Should Be Equal ${SUITE.elapsed_time} ${timedelta(seconds=3*60*60 + 21*60 + 30.2)}
-Combine With Only Starttime Should Only Affect Starttime
+Combine with only start time
Run Rebot --starttime 20070925-2151 ${INPUT1} ${INPUT2}
- Should Be Equal ${SUITE.starttime} 20070925 21:51:00.000
- Should Be Equal ${SUITE.endtime} ${ORIG_END}
- Should Be Equal ${SUITE.elapsedtime} ${ORIG_ELAPSED}
+ Should Be Equal ${SUITE.start_time} ${datetime(2007, 9, 25, 21, 51)}
+ Should Be Equal ${SUITE.end_time} ${{datetime.datetime(2007, 9, 25, 21, 51) + $ORIG_ELAPSED}}
+ Should Be Equal ${SUITE.elapsed_time} ${ORIG_ELAPSED}
-Combine With Only Endtime Should Only Affect Endtime
+Combine with only end time
Run Rebot --endtime 2010_01.01:12-33 ${INPUT1} ${INPUT2}
- Should Be Equal ${SUITE.starttime} ${ORIG_START}
- Should Be Equal ${SUITE.endtime} 20100101 12:33:00.000
- Should Be Equal ${SUITE.elapsedtime} ${ORIG_ELAPSED}
+ Should Be Equal ${SUITE.start_time} ${{datetime.datetime(2010, 1, 1, 12, 33) - $ORIG_ELAPSED}}
+ Should Be Equal ${SUITE.end_time} ${datetime(2010, 1, 1, 12, 33)}
+ Should Be Equal ${SUITE.elapsed_time} ${ORIG_ELAPSED}
-Recombining Should Work
+Recombining
${options} = Catenate
... --starttime 2007:09:25:21:51
... --endtime 2007:09:26:01:12:30:200
... --output ${COMBINED}
Run Rebot Without Processing Output ${options} ${INPUT1} ${INPUT2}
Run Rebot ${EMPTY} ${INPUT1} ${INPUT2} ${COMBINED}
- Should Be True '${SUITE.elapsedtime}' > '03:21:30.200'
+ Should Be True $SUITE.elapsed_time > datetime.timedelta(hours=3, minutes=21, seconds=30.2)
-It should Be possible to Omit Time Altogether
+Omit time part altogether
Run Rebot --starttime 2007-10-01 --endtime 20071006 ${INPUT1} ${INPUT2}
- Should Be Equal ${SUITE.starttime} 20071001 00:00:00.000
- Should Be Equal ${SUITE.endtime} 20071006 00:00:00.000
- Should Be True ${SUITE.elapsedtime} == 120*60*60 * 1000
+ Should Be Equal ${SUITE.start_time} ${datetime(2007, 10, 1)}
+ Should Be Equal ${SUITE.end_time} ${datetime(2007, 10, 6)}
+ Should Be Equal ${SUITE.elapsed_time} ${timedelta(days=5)}
-Use Starttime With Single Output
- Run Rebot --starttime 20070925-2151 ${INPUT1}
- Should Be Equal ${SUITE.starttime} 20070925 21:51:00.000
- Should Be Equal ${SUITE.endtime} ${SINGLE_SUITE_ORIG_END}
- Should Be True ${SUITE.elapsedtime} > ${SINGLE SUITE ORIG ELAPSED}
+Start time and end time with single output
+ Run Rebot --starttime 20070925-2151 --endtime 20070925-2252 ${INPUT1}
+ Should Be Equal ${SUITE.start_time} ${datetime(2007, 9, 25, 21, 51)}
+ Should Be Equal ${SUITE.end_time} ${datetime(2007, 9, 25, 22, 52)}
+ Should Be Equal ${SUITE.elapsed_time} ${timedelta(hours=1, minutes=1)}
-Use Endtime With Single Output
- Run Rebot --endtime 20070925-2151 ${INPUT1}
- Should Be Equal ${SUITE.starttime} ${SINGLE_SUITE_ORIG_START}
- Should Be Equal ${SUITE.endtime} 20070925 21:51:00.000
- Should Be True ${SUITE.elapsedtime} < ${SINGLE SUITE ORIG ELAPSED}
+Start time with single output
+ Run Rebot --starttime 20070925-2151 ${INPUT1}
+ Should Be Equal ${SUITE.start_time} ${datetime(2007, 9, 25, 21, 51)}
+ Should Be Equal ${SUITE.end_time} ${SINGLE_SUITE_ORIG_END}
+ Should Be True $SUITE.elapsed_time > $SINGLE_SUITE_ORIG_ELAPSED
-Use Starttime And Endtime With Single Output
- Run Rebot --starttime 20070925-2151 --endtime 20070925-2252 ${INPUT1}
- Should Be Equal ${SUITE.starttime} 20070925 21:51:00.000
- Should Be Equal ${SUITE.endtime} 20070925 22:52:00.000
- Should Be Equal ${SUITE.elapsedtime} ${3660000}
+End time with single output
+ Run Rebot --endtime '2023-09-07 19:31:01.234' ${INPUT1}
+ Should Be Equal ${SUITE.start_time} ${SINGLE_SUITE_ORIG_START}
+ Should Be Equal ${SUITE.end_time} ${datetime(2023, 9, 7, 19, 31, 1, 234000)}
+ Should Be True $SUITE.elapsed_time < $SINGLE_SUITE_ORIG_ELAPSED
*** Keywords ***
Create Input Files
Create Output With Robot ${INPUT1} ${EMPTY} misc/normal.robot
Create Output With Robot ${INPUT2} ${EMPTY} misc/suites/tsuite1.robot
Run Rebot ${EMPTY} ${INPUT1} ${INPUT2}
- Set Suite Variable $ORIG_START ${SUITE.starttime}
- Set Suite Variable $ORIG_END ${SUITE.endtime}
- Set Suite Variable $ORIG_ELAPSED ${SUITE.elapsedtime}
+ Set Suite Variable $ORIG_START ${SUITE.start_time}
+ Set Suite Variable $ORIG_END ${SUITE.end_time}
+ Set Suite Variable $ORIG_ELAPSED ${SUITE.elapsed_time}
Run Rebot ${EMPTY} ${INPUT1}
- Set Suite Variable $SINGLE_SUITE_ORIG_START ${SUITE.starttime}
- Set Suite Variable $SINGLE_SUITE_ORIG_END ${SUITE.endtime}
- Set Suite Variable $SINGLE_SUITE_ORIG_ELAPSED ${SUITE.elapsedtime}
+ Set Suite Variable $SINGLE_SUITE_ORIG_START ${SUITE.start_time}
+ Set Suite Variable $SINGLE_SUITE_ORIG_END ${SUITE.end_time}
+ Set Suite Variable $SINGLE_SUITE_ORIG_ELAPSED ${SUITE.elapsed_time}
diff --git a/atest/robot/rebot/xunit.robot b/atest/robot/rebot/xunit.robot
index c3b2293a391..81567c6960e 100644
--- a/atest/robot/rebot/xunit.robot
+++ b/atest/robot/rebot/xunit.robot
@@ -135,7 +135,7 @@ Remove Temps
Suite Stats Should Be
[Arguments] ${tests} ${failures} ${skipped}=0
- ... ${time}=?.??? ${timestamp}=20??-??-??T??:??:??.???000
+ ... ${time}=?.??? ${timestamp}=20??-??-??T??:??:??.??????
... ${xpath}=.
${suite} = Get Element ${OUTDIR}/xunit.xml xpath=${xpath}
Element Attribute Should Be ${suite} tests ${tests}
diff --git a/atest/robot/rpa/run_rpa_tasks.robot b/atest/robot/rpa/run_rpa_tasks.robot
index cd64a3a7221..b2d9b8a762e 100644
--- a/atest/robot/rpa/run_rpa_tasks.robot
+++ b/atest/robot/rpa/run_rpa_tasks.robot
@@ -5,7 +5,7 @@ Test Template Run and validate RPA tasks
Resource atest_resource.robot
*** Variables ***
-@{ALL TASKS} Task Another task Task Failing Passing Test
+@{ALL TASKS} Defaults Override Task Another task Task Failing Passing Test
... Defaults Override Task timeout exceeded Invalid task timeout
*** Test Cases ***
@@ -16,30 +16,30 @@ Task header in multiple files
${EMPTY} rpa/tasks1.robot rpa/tasks2.robot Task Failing Passing
Task header in directory
- ${EMPTY} rpa/tasks Task Another task
+ ${EMPTY} rpa/tasks Task Another task Defaults Override
Test header with --rpa
--rpa rpa/tests.robot Test
Task header with --norpa
[Template] Run and validate test cases
- --norpa rpa/tasks Task Another task
+ --norpa rpa/tasks Task Another task Defaults Override
Conflicting headers cause error
[Template] Run and validate conflict
- rpa/tests.robot rpa/tasks rpa/tasks/stuff.robot tasks tests
- rpa/ rpa/tests.robot tests tasks
- ... [[] ERROR ] Error in file '*[/\\]task_setup_teardown_template_timeout.robot' on line 6:
+ rpa/tests.robot rpa/tasks Rpa.Tests Rpa.Tasks tests tasks
+ rpa/ Rpa.Task Aliases Rpa.Tests tasks tests
+ ... [[] ERROR ] Error in file '*[/\\]task_aliases.robot' on line 7:
... Non-existing setting 'Tesk Setup'. Did you mean:\n
... ${SPACE*3}Test Setup\n
... ${SPACE*3}Task Setup\n
Conflicting headers with --rpa are fine
- --RPA rpa/tasks rpa/tests.robot Task Another task Test
+ --RPA rpa/tasks rpa/tests.robot Task Another task Defaults Override Test
Conflicting headers with --norpa are fine
[Template] Run and validate test cases
- --NorPA -v TIMEOUT:Test rpa/ @{ALL TASKS}
+ --NorPA -v TIMEOUT:Test -v RPA:False rpa/ @{ALL TASKS}
Conflicting headers in same file cause error
[Documentation] Using --rpa or --norpa doesn't affect the behavior.
@@ -66,11 +66,15 @@ Conflicting headers in same file cause error when executing directory
--task task rpa/tasks Task
--rpa --task Test --test "An* T???" rpa/ Another task Test
+Suite containing tests is ok if only tasks are selected
+ --task task rpa/tasks rpa/tests.robot Task
+ --suite stuff rpa/tasks rpa/tests.robot Task Another task
+
Error message is correct if no task match --task or other options
[Template] Run and validate no task found
- --task nonex matching name 'nonex'
- --include xxx --exclude yyy matching tag 'xxx' and not matching tag 'yyy'
- --suite nonex --task task matching name 'task' in suite 'nonex'
+ --rpa --task nonex no tasks matching name 'nonex'
+ --norpa --include xxx --exclude yyy no tests matching tag 'xxx' and not matching tag 'yyy'
+ --suite nonex --task task no tests or tasks matching name 'task' in suite 'nonex'
Error message is correct if task name is empty or task contains no keywords
[Template] NONE
@@ -92,20 +96,19 @@ Run and validate test cases
Should contain tests ${SUITE} @{tasks}
Run and validate conflict
- [Arguments] ${paths} ${conflicting} ${this} ${that} @{extra errors}
- Run tests without processing output ${EMPTY} ${paths}
- ${conflicting} = Normalize path ${DATADIR}/${conflicting}
+ [Arguments] ${paths} ${suite1} ${suite2} ${mode1} ${mode2} @{extra errors}
+ Run tests without processing output --name Rpa ${paths}
${extra} = Catenate @{extra errors}
${error} = Catenate
- ... [[] ERROR ] Parsing '${conflicting}' failed: Conflicting execution modes.
- ... File has ${this} but files parsed earlier have ${that}.
- ... Fix headers or use '--rpa' or '--norpa' options to set the execution mode explicitly.
+ ... [[] ERROR ] Conflicting execution modes:
+ ... Suite '${suite1}' has ${mode1} but suite '${suite2}' has ${mode2}.
+ ... Resolve the conflict or use '--rpa' or '--norpa' options to set the execution mode explicitly.
Stderr Should Match ${extra}${error}${USAGE TIP}\n
Run and validate no task found
[Arguments] ${options} ${message}
- Run tests without processing output --rpa ${options} rpa/tasks
- Stderr Should Be Equal To [ ERROR ] Suite 'Tasks' contains no tasks ${message}.${USAGE TIP}\n
+ Run tests without processing output ${options} rpa/tasks rpa/tests.robot
+ Stderr Should Be Equal To [ ERROR ] Suite 'Tasks & Tests' contains ${message}.${USAGE TIP}\n
Outputs should contain correct mode information
[Arguments] ${rpa}
diff --git a/atest/robot/rpa/task_aliases.robot b/atest/robot/rpa/task_aliases.robot
new file mode 100644
index 00000000000..533eab1baa1
--- /dev/null
+++ b/atest/robot/rpa/task_aliases.robot
@@ -0,0 +1,68 @@
+*** Settings ***
+Suite Setup Run Tests --loglevel DEBUG rpa/task_aliases.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Defaults
+ ${tc} = Check Test Tags ${TESTNAME} task tags
+ Check timeout message ${tc.setup[0]} 1 minute 10 seconds
+ Check log message ${tc.setup[1]} Setup has an alias!
+ Check timeout message ${tc[0, 0]} 1 minute 10 seconds
+ Check log message ${tc[0, 1]} Using default settings
+ Check log message ${tc.teardown[0]} Also teardown has an alias!!
+ Should be equal ${tc.timeout} 1 minute 10 seconds
+
+Override
+ ${tc} = Check Test Tags ${TESTNAME} task tags own
+ Check log message ${tc.setup[0]} Overriding setup
+ Check log message ${tc[0, 0]} Overriding settings
+ Check log message ${tc.teardown[0]} Overriding teardown as well
+ Should be equal ${tc.timeout} ${NONE}
+
+Task timeout exceeded
+ ${tc} = Check Test Case ${TESTNAME}
+ Check timeout message ${tc[0, 0]} 99 milliseconds
+ Check log message ${tc[0, 1]} Task timeout 99 milliseconds exceeded. FAIL
+
+Invalid task timeout
+ Check Test Case ${TESTNAME}
+
+Task aliases are included in setting recommendations
+ Error In File
+ ... 0 rpa/task_aliases.robot 7
+ ... SEPARATOR=\n
+ ... Non-existing setting 'Tesk Setup'. Did you mean:
+ ... ${SPACE*4}Test Setup
+ ... ${SPACE*4}Task Setup
+
+Task settings are not allowed in resource file
+ [Template] Validate invalid setting error
+ 1 2 Task Setup
+ 2 3 Task Teardown
+ 3 4 Task Template
+ 4 5 Task Timeout
+
+In init file
+ Run Tests --loglevel DEBUG rpa/tasks
+ ${tc} = Check Test Tags Defaults file tag task tags
+ Check timeout message ${tc.setup[0]} 1 minute 10 seconds
+ Check log message ${tc.setup[1]} Setup has an alias!
+ Check timeout message ${tc[0, 0]} 1 minute 10 seconds
+ Check log message ${tc.teardown[0]} Also teardown has an alias!!
+ Should be equal ${tc.timeout} 1 minute 10 seconds
+ ${tc} = Check Test Tags Override file tag task tags own
+ Check log message ${tc.setup[0]} Overriding setup
+ Check log message ${tc.teardown[0]} Overriding teardown as well
+ Should be equal ${tc.timeout} ${NONE}
+ Should be empty ${ERRORS}
+
+*** Keywords ***
+Check timeout message
+ [Arguments] ${msg} ${timeout}
+ Check log message ${msg} Task timeout ${timeout} active. * seconds left. DEBUG pattern=True
+
+Validate invalid setting error
+ [Arguments] ${index} ${lineno} ${setting}
+ Error In File
+ ... ${index} rpa/resource_with_invalid_task_settings.robot ${lineno}
+ ... Setting '${setting}' is not allowed in resource file.
diff --git a/atest/robot/rpa/task_setup_teardown_template_timeout.robot b/atest/robot/rpa/task_setup_teardown_template_timeout.robot
deleted file mode 100644
index 1df6f414510..00000000000
--- a/atest/robot/rpa/task_setup_teardown_template_timeout.robot
+++ /dev/null
@@ -1,54 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests --loglevel DEBUG rpa/task_setup_teardown_template_timeout.robot
-Resource atest_resource.robot
-
-*** Test Cases ***
-Defaults
- ${tc} = Check Test Case ${TESTNAME}
- Check timeout message ${tc.setup.msgs[0]} 1 minute 10 seconds
- Check log message ${tc.setup.msgs[1]} Setup has an alias!
- Check timeout message ${tc.kws[0].msgs[0]} 1 minute 10 seconds
- Check log message ${tc.kws[0].msgs[1]} Using default settings
- Check log message ${tc.teardown.msgs[0]} Also teardown has an alias!!
- Should be equal ${tc.timeout} 1 minute 10 seconds
-
-Override
- ${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.setup.msgs[0]} Overriding setup
- Check log message ${tc.kws[0].msgs[0]} Overriding settings
- Check log message ${tc.teardown.msgs[0]} Overriding teardown as well
- Should be equal ${tc.timeout} ${NONE}
-
-Task timeout exceeded
- ${tc} = Check Test Case ${TESTNAME}
- Check timeout message ${tc.kws[0].msgs[0]} 99 milliseconds
- Check log message ${tc.kws[0].msgs[1]} Task timeout 99 milliseconds exceeded. FAIL
-
-Invalid task timeout
- Check Test Case ${TESTNAME}
-
-Task aliases are included in setting recommendations
- Error In File
- ... 0 rpa/task_setup_teardown_template_timeout.robot 6
- ... SEPARATOR=\n
- ... Non-existing setting 'Tesk Setup'. Did you mean:
- ... ${SPACE*4}Test Setup
- ... ${SPACE*4}Task Setup
-
-Task settings are not allowed in resource file
- [Template] Validate invalid setting error
- 1 2 Task Setup
- 2 3 Task Teardown
- 3 4 Task Template
- 4 5 Task Timeout
-
-*** Keywords ***
-Check timeout message
- [Arguments] ${msg} ${timeout}
- Check log message ${msg} Task timeout ${timeout} active. * seconds left. DEBUG pattern=True
-
-Validate invalid setting error
- [Arguments] ${index} ${lineno} ${setting}
- Error In File
- ... ${index} rpa/resource_with_invalid_task_settings.robot ${lineno}
- ... Non-existing setting '${setting}'.
diff --git a/atest/robot/running/GetNestingLevel.py b/atest/robot/running/GetNestingLevel.py
new file mode 100644
index 00000000000..1f091c2a720
--- /dev/null
+++ b/atest/robot/running/GetNestingLevel.py
@@ -0,0 +1,21 @@
+from robot.api import SuiteVisitor
+
+
+class Nesting(SuiteVisitor):
+
+ def __init__(self):
+ self.level = 0
+ self.max = 0
+
+ def start_keyword(self, kw):
+ self.level += 1
+ self.max = max(self.level, self.max)
+
+ def end_keyword(self, kw):
+ self.level -= 1
+
+
+def get_nesting_level(test):
+ nesting = Nesting()
+ test.visit(nesting)
+ return nesting.max
diff --git a/atest/robot/running/continue_on_failure.robot b/atest/robot/running/continue_on_failure.robot
index bcffd3559c4..784d162727f 100644
--- a/atest/robot/running/continue_on_failure.robot
+++ b/atest/robot/running/continue_on_failure.robot
@@ -6,93 +6,93 @@ Resource atest_resource.robot
Continue in test
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} This should be executed
+ Check Log Message ${tc[1, 0]} This should be executed
Continue in user keyword
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} This should be executed in Test Case
+ Check Log Message ${tc[0, 1, 0]} This should be executed in Test Case
Continue in test with several continuable failures
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} This should be executed
- Check Log Message ${tc.kws[3].msgs[0]} This should also be executed
- Check Log Message ${tc.kws[5].msgs[0]} This too should also be executed
+ Check Log Message ${tc[1, 0]} This should be executed
+ Check Log Message ${tc[3, 0]} This should also be executed
+ Check Log Message ${tc[5, 0]} This too should also be executed
Continue in user keyword with several continuable failures
${tc}= Check Test Case ${TESTNAME}
- Verify all failures in user keyword ${tc.kws[0]} Test Case
- Verify all failures in user keyword ${tc.kws[1]} Test Case, Again
+ Verify all failures in user keyword ${tc[0]} Test Case
+ Verify all failures in user keyword ${tc[1]} Test Case, Again
Continuable and regular failure
${tc}= Check Test Case ${TESTNAME}
- Length Should Be ${tc.kws} 4
- Should Be Equal ${tc.kws[-1].status} NOT RUN
+ Length Should Be ${tc.body} 4
+ Should Be Equal ${tc[-1].status} NOT RUN
Continue in nested user keyword
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} This should be executed in Top Level UK (with âˆÃ¶n ÄßÇïï ۤ)
- Verify all failures in user keyword ${tc.kws[0].kws[2]} Nested UK
+ Check Log Message ${tc[0, 1, 0]} This should be executed in Top Level UK (with âˆÃ¶n ÄßÇïï ۤ)
+ Verify all failures in user keyword ${tc[0, 2]} Nested UK
Continuable and regular failure in UK
Check Test Case ${TESTNAME}
Several continuable failures and regular failure in nested UK
${tc}= Check Test Case ${TESTNAME}
- Verify all failures in user keyword ${tc.kws[0].kws[2]} Nested UK
- Verify all failures in user keyword ${tc.kws[1].kws[1].kws[2]} Nested UK
+ Verify all failures in user keyword ${tc[0, 2]} Nested UK
+ Verify all failures in user keyword ${tc[1, 1, 2]} Nested UK
Continue when setting variables
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} \${ret} = None
- Check Log Message ${tc.kws[0].msgs[1]} ContinuableApocalypseException: Can be continued FAIL
- Check Log Message ${tc.kws[2].msgs[0]} \${r1} = None
- Check Log Message ${tc.kws[2].msgs[1]} \${r2} = None
- Check Log Message ${tc.kws[2].msgs[2]} \${r3} = None
- Check Log Message ${tc.kws[2].msgs[3]} ContinuableApocalypseException: Can be continued FAIL
- Check Log Message ${tc.kws[4].msgs[0]} \@{list} = [ ]
- Check Log Message ${tc.kws[4].msgs[1]} ContinuableApocalypseException: Can be continued FAIL
- Check Log Message ${tc.kws[6].msgs[0]} No jokes FAIL
- Length Should Be ${tc.kws[6].msgs} 1
+ Check Log Message ${tc[0, 0]} \${ret} = None
+ Check Log Message ${tc[0, 1]} ContinuableApocalypseException: Can be continued FAIL
+ Check Log Message ${tc[2, 0]} \${r1} = None
+ Check Log Message ${tc[2, 1]} \${r2} = None
+ Check Log Message ${tc[2, 2]} \${r3} = None
+ Check Log Message ${tc[2, 3]} ContinuableApocalypseException: Can be continued FAIL
+ Check Log Message ${tc[4, 0]} \@{list} = [ ]
+ Check Log Message ${tc[4, 1]} ContinuableApocalypseException: Can be continued FAIL
+ Check Log Message ${tc[6, 0]} No jokes FAIL
+ Length Should Be ${tc[6].body} 1
Continuable failure in user keyword returning value
Check Test Case ${TESTNAME}
Continue in test setup
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.setup.kws[1].msgs[0]} This should be executed in Test Setup
- Should Be Empty ${tc.kws}
+ Check Log Message ${tc.setup[1, 0]} This should be executed in Test Setup
+ Should Be Empty ${tc.body}
Continue in test teardown
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.kws[1].msgs[0]} This should be executed in Test Teardown
+ Check Log Message ${tc.teardown[1, 0]} This should be executed in Test Teardown
Continue many times in test setup and teardown
${tc}= Check Test Case ${TESTNAME}
- Verify all failures in user keyword ${tc.setup} Test Setup
- Should Be Empty ${tc.kws}
+ Verify all failures in user keyword ${tc.setup} Test Setup
+ Should Be Empty ${tc.body}
Verify all failures in user keyword ${tc.teardown} Test Teardown
Continue in suite teardown
${suite}= Get Test Suite Continue On Failure
- Check Log Message ${suite.teardown.kws[1].msgs[0]} This should be executed in Suite Teardown
+ Check Log Message ${suite.teardown[1, 0]} This should be executed in Suite Teardown
Continue in suite setup
${suite}= Get Test Suite Continue On Failure In Suite Setup
- Check Log Message ${suite.setup.kws[1].msgs[0]} This should be executed in Suite Setup (with âˆÃ¶n ÄßÇïï ۤ)
+ Check Log Message ${suite.setup[1, 0]} This should be executed in Suite Setup (with âˆÃ¶n ÄßÇïï ۤ)
Continue in for loop
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} ContinuableApocalypseException: 0 FAIL
- Check Log Message ${tc.kws[0].kws[0].kws[1].msgs[0]} This should be executed inside for loop
- Check Log Message ${tc.kws[0].kws[1].kws[0].msgs[0]} ContinuableApocalypseException: 1 FAIL
- Check Log Message ${tc.kws[0].kws[1].kws[1].msgs[0]} This should be executed inside for loop
- Check Log Message ${tc.kws[0].kws[2].kws[0].msgs[0]} ContinuableApocalypseException: 2 FAIL
- Check Log Message ${tc.kws[0].kws[2].kws[1].msgs[0]} This should be executed inside for loop
- Check Log Message ${tc.kws[0].kws[3].kws[0].msgs[0]} ContinuableApocalypseException: 3 FAIL
- Check Log Message ${tc.kws[0].kws[3].kws[1].msgs[0]} This should be executed inside for loop
- Check Log Message ${tc.kws[0].kws[4].kws[0].msgs[0]} ContinuableApocalypseException: 4 FAIL
- Check Log Message ${tc.kws[0].kws[4].kws[1].msgs[0]} This should be executed inside for loop
- Check Log Message ${tc.kws[1].msgs[0]} This should be executed after for loop
+ Check Log Message ${tc[0, 0, 0, 0]} ContinuableApocalypseException: 0 FAIL
+ Check Log Message ${tc[0, 0, 1, 0]} This should be executed inside for loop
+ Check Log Message ${tc[0, 1, 0, 0]} ContinuableApocalypseException: 1 FAIL
+ Check Log Message ${tc[0, 1, 1, 0]} This should be executed inside for loop
+ Check Log Message ${tc[0, 2, 0, 0]} ContinuableApocalypseException: 2 FAIL
+ Check Log Message ${tc[0, 2, 1, 0]} This should be executed inside for loop
+ Check Log Message ${tc[0, 3, 0, 0]} ContinuableApocalypseException: 3 FAIL
+ Check Log Message ${tc[0, 3, 1, 0]} This should be executed inside for loop
+ Check Log Message ${tc[0, 4, 0, 0]} ContinuableApocalypseException: 4 FAIL
+ Check Log Message ${tc[0, 4, 1, 0]} This should be executed inside for loop
+ Check Log Message ${tc[1, 0]} This should be executed after for loop
Continuable and regular failure in for loop
Check Test Case ${TESTNAME}
@@ -102,9 +102,9 @@ robot.api.ContinuableFailure
*** Keywords ***
Verify all failures in user keyword [Arguments] ${kw} ${where}
- Check Log Message ${kw.kws[0].msgs[0]} ContinuableApocalypseException: 1 FAIL
- Check Log Message ${kw.kws[1].msgs[0]} This should be executed in ${where} (with âˆÃ¶n ÄßÇïï ۤ)
- Check Log Message ${kw.kws[2].msgs[0]} ContinuableApocalypseException: 2 FAIL
- Check Log Message ${kw.kws[3].msgs[0]} This should also be executed in ${where}
- Check Log Message ${kw.kws[4].msgs[0]} ContinuableApocalypseException: 3 FAIL
- Check Log Message ${kw.kws[5].msgs[0]} This too should also be executed in ${where}
+ Check Log Message ${kw[0, 0]} ContinuableApocalypseException: 1 FAIL
+ Check Log Message ${kw[1, 0]} This should be executed in ${where} (with âˆÃ¶n ÄßÇïï ۤ)
+ Check Log Message ${kw[2, 0]} ContinuableApocalypseException: 2 FAIL
+ Check Log Message ${kw[3, 0]} This should also be executed in ${where}
+ Check Log Message ${kw[4, 0]} ContinuableApocalypseException: 3 FAIL
+ Check Log Message ${kw[5, 0]} This too should also be executed in ${where}
diff --git a/atest/robot/running/continue_on_failure_tag.robot b/atest/robot/running/continue_on_failure_tag.robot
index 336ed2d7a1a..17443e98f2d 100644
--- a/atest/robot/running/continue_on_failure_tag.robot
+++ b/atest/robot/running/continue_on_failure_tag.robot
@@ -3,25 +3,25 @@ Suite Setup Run Tests ${EMPTY} running/continue_on_failure_tag.robot
Resource atest_resource.robot
*** Test Cases ***
-Continue in test with tag
+Continue in test with continue tag
Check Test Case ${TESTNAME}
Continue in test with Set Tags
Check Test Case ${TESTNAME}
-Continue in user keyword with tag
+Continue in user keyword with continue tag
Check Test Case ${TESTNAME}
-Continue in test with tag and UK without tag
+Continue in test with continue tag and UK without tag
Check Test Case ${TESTNAME}
-Continue in test with tag and nested UK with and without tag
+Continue in test with continue tag and nested UK with and without tag
Check Test Case ${TESTNAME}
-Continue in test with tag and two nested UK with tag
+Continue in test with continue tag and two nested UK with continue tag
Check Test Case ${TESTNAME}
-Continue in FOR loop with tag
+Continue in FOR loop with continue tag
Check Test Case ${TESTNAME}
Continue in FOR loop with Set Tags
@@ -30,13 +30,13 @@ Continue in FOR loop with Set Tags
No continue in FOR loop without tag
Check Test Case ${TESTNAME}
-Continue in FOR loop in UK with tag
+Continue in FOR loop in UK with continue tag
Check Test Case ${TESTNAME}
Continue in FOR loop in UK without tag
Check Test Case ${TESTNAME}
-Continue in IF with tag
+Continue in IF with continue tag
Check Test Case ${TESTNAME}
Continue in IF with set and remove tag
@@ -45,22 +45,28 @@ Continue in IF with set and remove tag
No continue in IF without tag
Check Test Case ${TESTNAME}
-Continue in IF in UK with tag
+Continue in IF in UK with continue tag
Check Test Case ${TESTNAME}
No continue in IF in UK without tag
Check Test Case ${TESTNAME}
-Continue in Run Keywords with tag
+Continue in Run Keywords with continue tag
Check Test Case ${TESTNAME}
-Recursive continue in test with tag and two nested UK without tag
+Recursive continue in test with continue tag and two nested UK without tag
Check Test Case ${TESTNAME}
Recursive continue in test with Set Tags and two nested UK without tag
Check Test Case ${TESTNAME}
-Recursive continue in test with tag and two nested UK with and without tag
+Recursive continue in test with continue tag and two nested UK with and without tag
+ Check Test Case ${TESTNAME}
+
+Recursive continue in test with continue tag and UK with stop tag
+ Check Test Case ${TESTNAME}
+
+Recursive continue in test with continue tag and UK with recursive stop tag
Check Test Case ${TESTNAME}
Recursive continue in user keyword
@@ -68,3 +74,69 @@ Recursive continue in user keyword
Recursive continue in nested keyword
Check Test Case ${TESTNAME}
+
+stop-on-failure in keyword in Teardown
+ Check Test Case ${TESTNAME}
+
+stop-on-failure with continuable failure in keyword in Teardown
+ Check Test Case ${TESTNAME}
+
+stop-on-failure with run-kw-and-continue failure in keyword in Teardown
+ Check Test Case ${TESTNAME}
+
+stop-on-failure with run-kw-and-continue failure in keyword
+ Check Test Case ${TESTNAME}
+
+Test teardown using run keywords with stop tag in test case
+ Check Test Case ${TESTNAME}
+
+Test teardown using user keyword with recursive stop tag in test case
+ Check Test Case ${TESTNAME}
+
+Test teardown using user keyword with stop tag in test case
+ Check Test Case ${TESTNAME}
+
+Test Teardown with stop tag in user keyword
+ Check Test Case ${TESTNAME}
+
+Test Teardown with recursive stop tag in user keyword
+ Check Test Case ${TESTNAME}
+
+Test Teardown with recursive stop tag and UK with continue tag
+ Check Test Case ${TESTNAME}
+
+Test Teardown with recursive stop tag and UK with recursive continue tag
+ Check Test Case ${TESTNAME}
+
+stop-on-failure with Template
+ Check Test Case ${TESTNAME}
+
+recursive-stop-on-failure with Template
+ Check Test Case ${TESTNAME}
+
+stop-on-failure with Template and Teardown
+ Check Test Case ${TESTNAME}
+
+stop-on-failure does not stop continuable failure in test
+ Check Test Case ${TESTNAME}
+
+Test recursive-continue-recursive-stop
+ Check Test Case ${TESTNAME}
+
+Test recursive-stop-recursive-continue
+ Check Test Case ${TESTNAME}
+
+Test recursive-stop-recursive-continue-recursive-stop
+ Check Test Case ${TESTNAME}
+
+Test test setup with continue-on-failure
+ Check Test Case ${TESTNAME}
+
+Test test setup with recursive-continue-on-failure
+ Check Test Case ${TESTNAME}
+
+recursive-stop-on-failure with continue-on-failure
+ Check Test Case ${TESTNAME}
+
+recursive-continue-on-failure with stop-on-failure
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/running/detect_recursion.robot b/atest/robot/running/detect_recursion.robot
new file mode 100644
index 00000000000..cd50dc5d443
--- /dev/null
+++ b/atest/robot/running/detect_recursion.robot
@@ -0,0 +1,41 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/detect_recursion.robot
+Library GetNestingLevel.py
+Resource atest_resource.robot
+
+*** Test Cases ***
+Infinite recursion
+ Check Test Case ${TESTNAME}
+
+Infinite cyclic recursion
+ Check Test Case ${TESTNAME}
+
+Infinite recursion with Run Keyword
+ Check Test Case ${TESTNAME}
+
+Infinitely recursive for loop
+ Check Test Case ${TESTNAME}
+
+Recursion below the recursion limit is ok
+ [Documentation] Also verifies that recursion limit blown earlier doesn't affect subsequent tests
+ Check Test Case ${TESTNAME}
+
+Recursion limit is over 140 started keywords
+ ${tc} = Check Test Case Infinite recursion
+ ${level} = Get Nesting Level ${tc}
+ Should Be True 140 < ${level} < 160
+
+Recursion limit can be raised with `sys.setrecursionlimit`
+ [Setup] Should Be True sys.getrecursionlimit() == 1000
+ # Raise limit with executed tests using sitecustomize.py.
+ Create File %{TEMPDIR}/sitecustomize.py import sys; sys.setrecursionlimit(1500)
+ Set Environment Variable PYTHONPATH %{TEMPDIR}
+ # Also raise limit here to be able to process created outputs.
+ Evaluate sys.setrecursionlimit(1500)
+ Run Tests -t "Infinite recursion" running/detect_recursion.robot
+ ${tc} = Check Test Case Infinite recursion
+ ${level} = Get Nesting Level ${tc}
+ Should Be True 220 < ${level} < 240
+ [Teardown] Run Keywords
+ ... Remove File %{TEMPDIR}/sitecustomize.py AND
+ ... Evaluate sys.setrecursionlimit(1000)
diff --git a/atest/robot/running/duplicate_suite_name.robot b/atest/robot/running/duplicate_suite_name.robot
index 3eedb5d31bc..6386a65e05e 100644
--- a/atest/robot/running/duplicate_suite_name.robot
+++ b/atest/robot/running/duplicate_suite_name.robot
@@ -1,8 +1,8 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests --exclude exclude running/duplicate_suite_name
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Suites with same name shoul be executed
Should Contain Suites ${SUITE}
... Test
diff --git a/atest/robot/running/duplicate_test_name.robot b/atest/robot/running/duplicate_test_name.robot
index 56f686b4e8a..68133471a24 100644
--- a/atest/robot/running/duplicate_test_name.robot
+++ b/atest/robot/running/duplicate_test_name.robot
@@ -1,26 +1,37 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests --exclude exclude running/duplicate_test_name.robot
Resource atest_resource.robot
-*** Test Case ***
-Tests with same name should be executed
+*** Test Cases ***
+Tests with same name are executed
Should Contain Tests ${SUITE}
- ... Same Test Multiple Times
- ... Same Test Multiple Times
- ... Same Test Multiple Times
- ... Same Test With Different Case And Spaces
- ... SameTestwith Different CASE and s p a c e s
- ... Same Test In Data But Only One Executed
+ ... Duplicates
+ ... Duplicates
+ ... Duplicates
+ ... Duplicates with different case and spaces
+ ... Duplicates with different CASE ands p a c e s
+ ... Duplicates but only one executed
+ ... Test 1 Test 2 Test 3
+ ... Duplicates after resolving variables
+ ... Duplicates after resolving variables
-There should be warning when multiple tests with same name are executed
- Check Multiple Tests Log Message ${ERRORS[0]} Same Test Multiple Times
- Check Multiple Tests Log Message ${ERRORS[1]} Same Test Multiple Times
- Check Multiple Tests Log Message ${ERRORS[2]} SameTestwith Different CASE and s p a c e s
+There is warning when multiple tests with same name are executed
+ Check Multiple Tests Log Message ${ERRORS[0]} Duplicates
+ Check Multiple Tests Log Message ${ERRORS[1]} Duplicates
+ Check Multiple Tests Log Message ${ERRORS[2]} Duplicates with different CASE ands p a c e s
-There should be no warning when there are multiple tests with same name in data but only one is executed
- ${tc} = Check Test Case Same Test In Data But Only One Executed
- Check Log Message ${tc.kws[0].msgs[0]} This is executed!
- Length Should Be ${ERRORS} 3
+There is warning if names are same after resolving variables
+ Check Multiple Tests Log Message ${ERRORS[3]} Duplicates after resolving variables
+
+There is no warning when there are multiple tests with same name but only one is executed
+ Check Test Case Duplicates but only one executed
+ Length Should Be ${ERRORS} 4
+
+Original name can be same if there is variable and its value changes
+ Check Test Case Test 1
+ Check Test Case Test 2
+ Check Test Case Test 3
+ Length Should Be ${ERRORS} 4
*** Keywords ***
Check Multiple Tests Log Message
diff --git a/atest/robot/running/exit_on_failure_tag.robot b/atest/robot/running/exit_on_failure_tag.robot
new file mode 100644
index 00000000000..f95649083ca
--- /dev/null
+++ b/atest/robot/running/exit_on_failure_tag.robot
@@ -0,0 +1,17 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/exit_on_failure_tag.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Passing test with the tag has not special effect
+ Check Test Case ${TESTNAME}
+
+Failing test without the tag has no special effect
+ Check Test Case ${TESTNAME}
+
+Failing test with the tag initiates exit-on-failure
+ Check Test Case ${TESTNAME}
+
+Subsequent tests are not run
+ Check Test Case ${TESTNAME} 1
+ Check Test Case ${TESTNAME} 2
diff --git a/atest/robot/running/failures_in_teardown.robot b/atest/robot/running/failures_in_teardown.robot
index a38425dee86..175af344269 100644
--- a/atest/robot/running/failures_in_teardown.robot
+++ b/atest/robot/running/failures_in_teardown.robot
@@ -6,63 +6,83 @@ Resource atest_resource.robot
*** Test Cases ***
One Failure
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.kws[1].msgs[0]} This should be executed
+ Check Log Message ${tc.teardown[1, 0]} This should be executed
Multiple Failures
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.kws[2].msgs[0]} This should also be executed
+ Check Log Message ${tc.teardown[2, 0]} This should also be executed
Failure When Setting Variables
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.kws[0].msgs[0]} \${ret} = None
- Check Log Message ${tc.teardown.kws[0].msgs[1]} Return values is None FAIL
+ Check Log Message ${tc.teardown[0, 0]} \${ret} = None
+ Check Log Message ${tc.teardown[0, 1]} Return values is None FAIL
Failure In For Loop
Check Test Case ${TESTNAME}
Execution Continues After Test Timeout
${tc} = Check Test Case ${TESTNAME}
- Should Be True ${tc.elapsedtime} >= 300
+ Elapsed Time Should Be Valid ${tc.elapsed_time} minimum=0.3
Execution Stops After Keyword Timeout
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.teardown.kws} 2
- Should Be Equal ${tc.teardown.kws[-1].status} NOT RUN
+ Length Should Be ${tc.teardown.body} 2
+ Should Be Equal ${tc.teardown[-1].status} NOT RUN
-Execution Continues After Keyword Timeout Occurs In Executed Keyword
+Execution continues if executed keyword fails for keyword timeout
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.teardown.body} 2
- Length Should Be ${tc.teardown.body[0].body} 2
- Should Be Equal ${tc.teardown.body[0].body[0].status} FAIL
- Should Be Equal ${tc.teardown.body[0].body[1].status} NOT RUN
- Should Be Equal ${tc.teardown.body[0].status} FAIL
- Should Be Equal ${tc.teardown.body[1].status} FAIL
+ Length Should Be ${tc.teardown.body} 2
+ Should Be Equal ${tc.teardown.body[0].status} FAIL
+ Should Be Equal ${tc.teardown.body[1].status} FAIL
+ Length Should Be ${tc.teardown.body[0].body} 2
+ Should Be Equal ${tc.teardown[0, 0].status} FAIL
+ Check Log Message ${tc.teardown}[0, 0, 0] Keyword timeout 42 milliseconds exceeded. FAIL
+ Should Be Equal ${tc.teardown[0, 1].status} NOT RUN
+ Length Should Be ${tc.teardown.body[1].body} 1
+ Check Log Message ${tc.teardown}[1, 0] This should be executed FAIL
+
+Execution stops after keyword timeout if keyword uses WUKS
+ ${tc} = Check Test Case ${TESTNAME}
+ Length Should Be ${tc.teardown.body} 2
+ Should Be Equal ${tc.teardown.body[0].status} FAIL
+ Should Be Equal ${tc.teardown.body[1].status} NOT RUN
+ Length Should Be ${tc.teardown.body[0].body} 2
+ Should Be Equal ${tc.teardown[0, 0].status} FAIL
+ Should Be Equal ${tc.teardown[0, 1].status} FAIL
+ Length Should Be ${tc.teardown[0, 0].body} 2
+ Should Be Equal ${tc.teardown[0, 0, 0].status} PASS
+ Should Be Equal ${tc.teardown[0, 0, 1].status} FAIL
+ Check Log Message ${tc.teardown}[0, 0, 1, 0] Failing! FAIL
+ Length Should Be ${tc.teardown[0, 1].body} 2
+ Should Be Equal ${tc.teardown[0, 1, 0].status} FAIL
+ Check Log Message ${tc.teardown}[0, 1, 0, 0] Keyword timeout 100 milliseconds exceeded. FAIL
+ Should Be Equal ${tc.teardown[0, 1, 1].status} NOT RUN
Execution Continues If Variable Does Not Exist
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.teardown.kws} 3
+ Length Should Be ${tc.teardown.body} 3
Execution Continues After Keyword Errors
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.teardown.kws} 3
+ Length Should Be ${tc.teardown.body} 3
Execution Stops After Syntax Error
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.teardown.kws} 2
- Should Be Equal ${tc.teardown.kws[-1].status} NOT RUN
+ Length Should Be ${tc.teardown.body} 2
+ Should Be Equal ${tc.teardown[-1].status} NOT RUN
Fatal Error
${tc} = Check Test Case ${TESTNAME} 1
- Length Should Be ${tc.teardown.kws} 2
- Should Be Equal ${tc.teardown.kws[-1].status} NOT RUN
- Check Test Case ${TESTNAME} 2
+ Length Should Be ${tc.teardown.body} 2
+ Should Be Equal ${tc.teardown[-1].status} NOT RUN
+ Check Test Case ${TESTNAME} 2
Suite Teardown Is Executed Fully
${td} = Set Variable ${SUITE.teardown}
- Check Log Message ${td.kws[0].msgs[0]} Suite Message 1 FAIL
- Check Log Message ${td.kws[1].msgs[0]} Suite Message 2 (with âˆÃ¶n ÄßÇïï ۤ) FAIL
- Check Log Message ${td.kws[2].msgs[0]} Variable '\${it is ok not to exist}' not found. FAIL
- Check Log Message ${td.kws[3].msgs[0]} This should be executed
+ Check Log Message ${td[0, 0]} Suite Message 1 FAIL
+ Check Log Message ${td[1, 0]} Suite Message 2 (with âˆÃ¶n ÄßÇïï ۤ) FAIL
+ Check Log Message ${td[2, 0]} Variable '\${it is ok not to exist}' not found. FAIL
+ Check Log Message ${td[3, 0]} This should be executed
${msg} = Catenate SEPARATOR=\n\n
... Suite teardown failed:\nSeveral failures occurred:
... 1) Suite Message 1
@@ -73,5 +93,5 @@ Suite Teardown Is Executed Fully
Suite Teardown Should Stop At Fatal Error
Run Tests ${EMPTY} running/fatal_error_in_suite_teardown.robot
${ts} = Get Test Suite fatal error in suite teardown
- Length Should Be ${ts.teardown.kws} 2
- Should Be Equal ${ts.teardown.kws[-1].status} NOT RUN
+ Length Should Be ${ts.teardown.body} 2
+ Should Be Equal ${ts.teardown[-1].status} NOT RUN
diff --git a/atest/robot/running/fatal_exception.robot b/atest/robot/running/fatal_exception.robot
index 7166f538ad2..6c3898b42df 100644
--- a/atest/robot/running/fatal_exception.robot
+++ b/atest/robot/running/fatal_exception.robot
@@ -5,7 +5,7 @@ Resource atest_resource.robot
Exit From Python Keyword
Run Tests ${EMPTY} running/fatal_exception/01__python_library_kw.robot
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.msgs[0]} This should be executed
+ Check Log Message ${tc.teardown[0]} This should be executed
Check Test Case Test That Should Not Be Run 1
robot.api.FatalError
@@ -42,7 +42,7 @@ Multiple Suite Aware Exiting From Suite Setup
Run Tests ${EMPTY} running/fatal_exception_suite_setup/
Check Test Case Test That Should Not Be Run 1
${ts1} = Get Test Suite Suite Setup
- Should End With ${ts1.teardown.msgs[0].message} Tearing down 1
+ Should End With ${ts1.teardown[0].message} Tearing down 1
Check Test Case Test That Should Not Be Run 2.1
Check Test Case Test That Should Not Be Run 2.2
${ts2} = Get Test Suite Irrelevant
diff --git a/atest/robot/running/flatten.robot b/atest/robot/running/flatten.robot
new file mode 100644
index 00000000000..dd3ab863fd9
--- /dev/null
+++ b/atest/robot/running/flatten.robot
@@ -0,0 +1,51 @@
+*** Settings ***
+Suite Setup Run Tests --loglevel trace --listener flatten_listener.Listener running/flatten.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+A single user keyword
+ ${tc}= User keyword content should be flattened 1
+ Check Log Message ${tc[0, 0]} From the main kw
+
+Nested UK
+ ${tc}= User keyword content should be flattened 2
+ Check Log Message ${tc[0, 0]} arg
+ Check Log Message ${tc[0, 1]} from nested kw
+
+Loops and stuff
+ ${tc}= User keyword content should be flattened 13
+ Check Log Message ${tc[0, 0]} inside for 0
+ Check Log Message ${tc[0, 1]} inside for 1
+ Check Log Message ${tc[0, 2]} inside for 2
+ Check Log Message ${tc[0, 3]} inside while 0
+ Check Log Message ${tc[0, 4]} \${LIMIT} = 1
+ Check Log Message ${tc[0, 5]} inside while 1
+ Check Log Message ${tc[0, 6]} \${LIMIT} = 2
+ Check Log Message ${tc[0, 7]} inside while 2
+ Check Log Message ${tc[0, 8]} \${LIMIT} = 3
+ Check Log Message ${tc[0, 9]} inside if
+ Check Log Message ${tc[0, 10]} fail inside try FAIL
+ Check Log Message ${tc[0, 11]} Traceback (most recent call last):* DEBUG pattern=True
+ Check Log Message ${tc[0, 12]} inside except
+
+Recursion
+ User keyword content should be flattened 8
+
+Listener methods start and end keyword are called
+ Stderr Should Be Empty
+
+Log levels
+ Run Tests ${EMPTY} running/flatten.robot
+ ${tc}= User keyword content should be flattened 4
+ Check Log Message ${tc[0, 0]} INFO 1
+ Check Log Message ${tc[0, 1]} Log level changed from INFO to DEBUG. DEBUG
+ Check Log Message ${tc[0, 2]} INFO 2
+ Check Log Message ${tc[0, 3]} DEBUG 2 level=DEBUG
+
+*** Keywords ***
+User keyword content should be flattened
+ [Arguments] ${expected_message_count}=0
+ ${tc}= Check Test Case ${TESTNAME}
+ Length Should Be ${tc[0].body} ${expected_message_count}
+ Length Should Be ${tc[0].messages} ${expected_message_count}
+ RETURN ${tc}
diff --git a/atest/robot/running/for/break_and_continue.robot b/atest/robot/running/for/break_and_continue.robot
index 262fdc5bf8d..e79998042f0 100644
--- a/atest/robot/running/for/break_and_continue.robot
+++ b/atest/robot/running/for/break_and_continue.robot
@@ -4,60 +4,56 @@ Resource for.resource
Test Template Test and all keywords should have passed
*** Test Cases ***
-With CONTINUE
+CONTINUE
allow not run=True
-With CONTINUE inside IF
- [Template] None
- ${tc}= Check test case ${TEST NAME}
- Should be FOR loop ${tc.body[0]} 5 FAIL IN RANGE
+CONTINUE inside IF
+ allow not run=True allowed failure=Oh no, got 4
-With CONTINUE inside TRY
+CONTINUE inside TRY
allow not run=True
-With CONTINUE inside EXCEPT and TRY-ELSE
- allow not run=True
+CONTINUE inside EXCEPT and TRY-ELSE
+ allow not run=True allowed failure=4 == 4
-With BREAK
+BREAK
allow not run=True
-With BREAK inside IF
+BREAK inside IF
allow not run=True
-With BREAK inside TRY
+BREAK inside TRY
allow not run=True
-With BREAK inside EXCEPT
- allow not run=True
+BREAK inside EXCEPT
+ allow not run=True allowed failure=This is excepted!
-With BREAK inside TRY-ELSE
+BREAK inside TRY-ELSE
allow not run=True
-With CONTINUE in UK
+CONTINUE in UK
allow not run=True
-With CONTINUE inside IF in UK
- [Template] None
- ${tc}= Check test case ${TEST NAME}
- Should be FOR loop ${tc.body[0].body[0]} 5 FAIL IN RANGE
+CONTINUE inside IF in UK
+ allow not run=True allowed failure=Oh no, got 4
-With CONTINUE inside TRY in UK
+CONTINUE inside TRY in UK
allow not run=True
-With CONTINUE inside EXCEPT and TRY-ELSE in UK
- allow not run=True
+CONTINUE inside EXCEPT and TRY-ELSE in UK
+ allow not run=True allowed failure=4 == 4
-With BREAK in UK
+BREAK in UK
allow not run=True
-With BREAK inside IF in UK
+BREAK inside IF in UK
allow not run=True
-With BREAK inside TRY in UK
+BREAK inside TRY in UK
allow not run=True
-With BREAK inside EXCEPT in UK
- allow not run=True
+BREAK inside EXCEPT in UK
+ allow not run=True allowed failure=This is excepted!
-With BREAK inside TRY-ELSE in UK
+BREAK inside TRY-ELSE in UK
allow not run=True
diff --git a/atest/robot/running/for/continue_for_loop.robot b/atest/robot/running/for/continue_for_loop.robot
index 5f50a6bd23e..59ab08e67b4 100644
--- a/atest/robot/running/for/continue_for_loop.robot
+++ b/atest/robot/running/for/continue_for_loop.robot
@@ -26,8 +26,8 @@ Continue For Loop In User Keyword Without For Loop Should Fail
Continue For Loop Keyword Should Log Info
${tc} = Check Test Case Simple Continue For Loop
- Should Be Equal ${tc.kws[0].kws[0].kws[0].name} BuiltIn.Continue For Loop
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Continuing for loop from the next iteration.
+ Should Be Equal ${tc[0, 0, 0].full_name} BuiltIn.Continue For Loop
+ Check Log Message ${tc[0, 0, 0, 0]} Continuing for loop from the next iteration.
Continue For Loop In Test Teardown
Test And All Keywords Should Have Passed
diff --git a/atest/robot/running/for/exit_for_loop.robot b/atest/robot/running/for/exit_for_loop.robot
index 00d3062c9de..aff02d26484 100644
--- a/atest/robot/running/for/exit_for_loop.robot
+++ b/atest/robot/running/for/exit_for_loop.robot
@@ -29,8 +29,8 @@ Exit For Loop In User Keyword Without For Loop Should Fail
Exit For Loop Keyword Should Log Info
${tc} = Check Test Case Simple Exit For Loop
- Should Be Equal ${tc.kws[0].kws[0].kws[0].name} BuiltIn.Exit For Loop
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Exiting for loop altogether.
+ Should Be Equal ${tc[0, 0, 0].full_name} BuiltIn.Exit For Loop
+ Check Log Message ${tc[0, 0, 0, 0]} Exiting for loop altogether.
Exit For Loop In Test Teardown
Test And All Keywords Should Have Passed
diff --git a/atest/robot/running/for/for.resource b/atest/robot/running/for/for.resource
index 258045e7995..9b29093eda6 100644
--- a/atest/robot/running/for/for.resource
+++ b/atest/robot/running/for/for.resource
@@ -5,33 +5,40 @@ Resource atest_resource.robot
Check test and get loop
[Arguments] ${test name} ${loop index}=0
${tc} = Check Test Case ${test name}
- [Return] ${tc.kws}[${loop index}]
+ RETURN ${tc.body}[${loop index}]
Check test and failed loop
- [Arguments] ${test name} ${type}=FOR ${loop index}=0
+ [Arguments] ${test name} ${type}=FOR ${loop index}=0 &{config}
${loop} = Check test and get loop ${test name} ${loop index}
- Run Keyword Should Be ${type} loop ${loop} 0 FAIL
+ Length Should Be ${loop.body} 2
+ Should Be Equal ${loop[0].type} ITERATION
+ Should Be Equal ${loop[1].type} MESSAGE
+ Run Keyword Should Be ${type} loop ${loop} 1 FAIL &{config}
Should be FOR loop
[Arguments] ${loop} ${iterations} ${status}=PASS ${flavor}=IN
- Should Be Equal ${loop.type} FOR
- Should Be Equal ${loop.flavor} ${flavor}
- Length Should Be ${loop.kws} ${iterations}
- Should Be Equal ${loop.status} ${status}
+ ... ${start}=${None} ${mode}=${None} ${fill}=${None}
+ Should Be Equal ${loop.type} FOR
+ Should Be Equal ${loop.flavor} ${flavor}
+ Should Be Equal ${loop.start} ${start}
+ Should Be Equal ${loop.mode} ${mode}
+ Should Be Equal ${loop.fill} ${fill}
+ Length Should Be ${loop.non_messages} ${iterations}
+ Should Be Equal ${loop.status} ${status}
Should be IN RANGE loop
[Arguments] ${loop} ${iterations} ${status}=PASS
- Should Be FOR Loop ${loop} ${iterations} ${status} flavor=IN RANGE
+ Should Be FOR Loop ${loop} ${iterations} ${status} IN RANGE
Should be IN ZIP loop
- [Arguments] ${loop} ${iterations} ${status}=PASS
- Should Be FOR Loop ${loop} ${iterations} ${status} flavor=IN ZIP
+ [Arguments] ${loop} ${iterations} ${status}=PASS ${mode}=${None} ${fill}=${None}
+ Should Be FOR Loop ${loop} ${iterations} ${status} IN ZIP mode=${mode} fill=${fill}
Should be IN ENUMERATE loop
- [Arguments] ${loop} ${iterations} ${status}=PASS
- Should Be FOR Loop ${loop} ${iterations} ${status} flavor=IN ENUMERATE
+ [Arguments] ${loop} ${iterations} ${status}=PASS ${start}=${None}
+ Should Be FOR Loop ${loop} ${iterations} ${status} IN ENUMERATE start=${start}
Should be FOR iteration
- [Arguments] ${iteration} &{variables}
+ [Arguments] ${iteration} &{assign}
Should Be Equal ${iteration.type} ITERATION
- Should Be Equal ${iteration.variables} ${variables}
+ Should Be Equal ${iteration.assign} ${assign}
diff --git a/atest/robot/running/for/for.robot b/atest/robot/running/for/for.robot
index 4551f2f371f..93e7769b44b 100644
--- a/atest/robot/running/for/for.robot
+++ b/atest/robot/running/for/for.robot
@@ -1,28 +1,28 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} running/for/for.robot
+Suite Setup Run Tests --log log-tests-also-string-reprs.html running/for/for.robot
+Suite Teardown File Should Exist ${OUTDIR}/log-tests-also-string-reprs.html
Resource for.resource
*** Test Cases ***
Simple loop
- ${tc} = Check test case ${TEST NAME}
- ${loop} = Set variable ${tc.body[1]}
- Check log message ${tc.body[0].msgs[0]} Not yet in FOR
- Should be FOR loop ${loop} 2
- Should be FOR iteration ${loop.body[0]} \${var}=one
- Check log message ${loop.body[0].body[0].msgs[0]} var: one
- Should be FOR iteration ${loop.body[1]} \${var}=two
- Check log message ${loop.body[1].body[0].msgs[0]} var: two
- Check log message ${tc.body[2].body[0]} Not in FOR anymore
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Not yet in FOR
+ Should be FOR loop ${tc[1]} 2
+ Should be FOR iteration ${tc[1, 0]} \${var}=one
+ Check Log Message ${tc[1, 0, 0, 0]} var: one
+ Should be FOR iteration ${tc[1, 1]} \${var}=two
+ Check Log Message ${tc[1, 1, 0, 0]} var: two
+ Check Log Message ${tc[2, 0]} Not in FOR anymore
Variables in values
${loop} = Check test and get loop ${TEST NAME}
- Should be FOR loop ${loop} 6
- "Variables in values" helper ${loop.kws[0]} 1
- "Variables in values" helper ${loop.kws[1]} 2
- "Variables in values" helper ${loop.kws[2]} 3
- "Variables in values" helper ${loop.kws[3]} 4
- "Variables in values" helper ${loop.kws[4]} 5
- "Variables in values" helper ${loop.kws[5]} 6
+ Should be FOR loop ${loop} 6
+ "Variables in values" helper ${loop[0]} 1
+ "Variables in values" helper ${loop[1]} 2
+ "Variables in values" helper ${loop[2]} 3
+ "Variables in values" helper ${loop[3]} 4
+ "Variables in values" helper ${loop[4]} 5
+ "Variables in values" helper ${loop[5]} 6
Indentation is not required
${loop} = Check test and get loop ${TEST NAME} 1
@@ -30,203 +30,203 @@ Indentation is not required
Values on multiple rows
${loop} = Check test and get loop ${TEST NAME}
- Should be FOR loop ${loop} 10
- Check log message ${loop.kws[0].kws[0].msgs[0]} 1
+ Should be FOR loop ${loop} 10
+ Check Log Message ${loop[0, 0, 0]} 1
FOR ${i} IN RANGE 10
- Check log message ${loop.kws[${i}].kws[0].msgs[0]} ${{str($i + 1)}}
+ Check Log Message ${loop[${i}, 0, 0]} ${{str($i + 1)}}
END
# Sanity check
- Check log message ${loop.kws[0].kws[0].msgs[0]} 1
- Check log message ${loop.kws[4].kws[0].msgs[0]} 5
- Check log message ${loop.kws[9].kws[0].msgs[0]} 10
+ Check Log Message ${loop[0, 0, 0]} 1
+ Check Log Message ${loop[4, 0, 0]} 5
+ Check Log Message ${loop[9, 0, 0]} 10
Keyword arguments on multiple rows
${loop} = Check test and get loop ${TEST NAME}
- Should be FOR loop ${loop} 2
- Check log message ${loop.kws[0].kws[1].msgs[0]} 1 2 3 4 5 6 7 one
- Check log message ${loop.kws[1].kws[1].msgs[0]} 1 2 3 4 5 6 7 two
+ Should be FOR loop ${loop} 2
+ Check Log Message ${loop[0, 1, 0]} 1 2 3 4 5 6 7 one
+ Check Log Message ${loop[1, 1, 0]} 1 2 3 4 5 6 7 two
Multiple loops in a test
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 2
- Check log message ${tc.kws[0].kws[0].kws[0].msgs[0]} In first loop with "foo"
- Check log message ${tc.kws[0].kws[1].kws[0].msgs[0]} In first loop with "bar"
- Should be FOR loop ${tc.kws[1]} 1
- Check kw "My UK 2" ${tc.kws[1].kws[0].kws[0]} Hello, world!
- Check log message ${tc.kws[2].msgs[0]} Outside loop
- Should be FOR loop ${tc.kws[3]} 2
- Check log message ${tc.kws[3].kws[0].kws[0].msgs[0]} Third loop
- Check log message ${tc.kws[3].kws[0].kws[2].msgs[0]} Value: a
- Check log message ${tc.kws[3].kws[1].kws[0].msgs[0]} Third loop
- Check log message ${tc.kws[3].kws[1].kws[2].msgs[0]} Value: b
- Check log message ${tc.kws[4].msgs[0]} The End
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 2
+ Check Log Message ${tc[0, 0, 0, 0]} In first loop with "foo"
+ Check Log Message ${tc[0, 1, 0, 0]} In first loop with "bar"
+ Should be FOR loop ${tc[1]} 1
+ Check kw "My UK 2" ${tc[1, 0, 0]} Hello, world!
+ Check Log Message ${tc[2, 0]} Outside loop
+ Should be FOR loop ${tc[3]} 2
+ Check Log Message ${tc[3, 0, 0, 0]} Third loop
+ Check Log Message ${tc[3, 0, 2, 0]} Value: a
+ Check Log Message ${tc[3, 1, 0, 0]} Third loop
+ Check Log Message ${tc[3, 1, 2, 0]} Value: b
+ Check Log Message ${tc[4, 0]} The End
Nested loop syntax
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 3
- Should be FOR loop ${tc.kws[0].kws[0].kws[1]} 3
- Check log message ${tc.kws[0].kws[0].kws[0].msgs[0]} 1 in
- Check log message ${tc.kws[0].kws[0].kws[1].kws[0].kws[0].msgs[0]} values 1 a
- Check log message ${tc.kws[0].kws[0].kws[1].kws[1].kws[0].msgs[0]} values 1 b
- Check log message ${tc.kws[0].kws[0].kws[1].kws[2].kws[0].msgs[0]} values 1 c
- Check log message ${tc.kws[0].kws[0].kws[2].msgs[0]} 1 out
- Check log message ${tc.kws[0].kws[1].kws[0].msgs[0]} 2 in
- Check log message ${tc.kws[0].kws[1].kws[1].kws[0].kws[0].msgs[0]} values 2 a
- Check log message ${tc.kws[0].kws[1].kws[1].kws[1].kws[0].msgs[0]} values 2 b
- Check log message ${tc.kws[0].kws[1].kws[1].kws[2].kws[0].msgs[0]} values 2 c
- Check log message ${tc.kws[0].kws[1].kws[2].msgs[0]} 2 out
- Check log message ${tc.kws[0].kws[2].kws[0].msgs[0]} 3 in
- Check log message ${tc.kws[0].kws[2].kws[1].kws[0].kws[0].msgs[0]} values 3 a
- Check log message ${tc.kws[0].kws[2].kws[1].kws[1].kws[0].msgs[0]} values 3 b
- Check log message ${tc.kws[0].kws[2].kws[1].kws[2].kws[0].msgs[0]} values 3 c
- Check log message ${tc.kws[0].kws[2].kws[2].msgs[0]} 3 out
- Check log message ${tc.kws[1].msgs[0]} The End
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 3
+ Should be FOR loop ${tc[0, 0, 1]} 3
+ Check Log Message ${tc[0, 0, 0, 0]} 1 in
+ Check Log Message ${tc[0, 0, 1, 0, 0, 0]} values 1 a
+ Check Log Message ${tc[0, 0, 1, 1, 0, 0]} values 1 b
+ Check Log Message ${tc[0, 0, 1, 2, 0, 0]} values 1 c
+ Check Log Message ${tc[0, 0, 2, 0]} 1 out
+ Check Log Message ${tc[0, 1, 0, 0]} 2 in
+ Check Log Message ${tc[0, 1, 1, 0, 0, 0]} values 2 a
+ Check Log Message ${tc[0, 1, 1, 1, 0, 0]} values 2 b
+ Check Log Message ${tc[0, 1, 1, 2, 0, 0]} values 2 c
+ Check Log Message ${tc[0, 1, 2, 0]} 2 out
+ Check Log Message ${tc[0, 2, 0, 0]} 3 in
+ Check Log Message ${tc[0, 2, 1, 0, 0, 0]} values 3 a
+ Check Log Message ${tc[0, 2, 1, 1, 0, 0]} values 3 b
+ Check Log Message ${tc[0, 2, 1, 2, 0, 0]} values 3 c
+ Check Log Message ${tc[0, 2, 2, 0]} 3 out
+ Check Log Message ${tc[1, 0]} The End
Multiple loops in a loop
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Deeply nested loops
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Settings after FOR
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 1
- Check log message ${tc.teardown.msgs[0]} Teardown was found and eXecuted.
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 1
+ Check Log Message ${tc.teardown[0]} Teardown was found and eXecuted.
Looping over empty list variable is OK
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 1 NOT RUN
- Should be FOR iteration ${tc.body[0].body[0]} \${var}=
- Check keyword data ${tc.body[0].body[0].body[0]} BuiltIn.Fail args=Not executed status=NOT RUN
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 1 NOT RUN
+ Should be FOR iteration ${tc[0, 0]} \${var}=
+ Check keyword data ${tc[0, 0, 0]} BuiltIn.Fail args=Not executed status=NOT RUN
Other iterables
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[2]} 10
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[2]} 10
Failure inside FOR
${loop} = Check test and get loop ${TEST NAME} 1
- Should be FOR loop ${loop} 1 FAIL
- Check log message ${loop.kws[0].kws[0].msgs[0]} Hello before failing kw
- Should be equal ${loop.kws[0].kws[0].status} PASS
- Check log message ${loop.kws[0].kws[1].msgs[0]} Here we fail! FAIL
- Should be equal ${loop.kws[0].kws[1].status} FAIL
- Should be equal ${loop.kws[0].kws[2].status} NOT RUN
- Should be equal ${loop.kws[0].status} FAIL
- Length should be ${loop.kws[0].kws} 3
+ Should be FOR loop ${loop} 1 FAIL
+ Check Log Message ${loop[0, 0, 0]} Hello before failing kw
+ Should Be Equal ${loop[0, 0].status} PASS
+ Check Log Message ${loop[0, 1, 0]} Here we fail! FAIL
+ Should Be Equal ${loop[0, 1].status} FAIL
+ Should Be Equal ${loop[0, 2].status} NOT RUN
+ Should Be Equal ${loop[0].status} FAIL
+ Length Should Be ${loop[0].body} 3
${loop} = Check test and get loop ${TEST NAME} 2
- Should be FOR loop ${loop} 4 FAIL
- Check log message ${loop.kws[0].kws[0].msgs[0]} Before Check
- Check log message ${loop.kws[0].kws[2].msgs[0]} After Check
- Length should be ${loop.kws[0].kws} 3
- Should be equal ${loop.kws[0].status} PASS
- Should be equal ${loop.kws[1].status} PASS
- Should be equal ${loop.kws[2].status} PASS
- Check log message ${loop.kws[3].kws[0].msgs[0]} Before Check
- Check log message ${loop.kws[3].kws[1].msgs[0]} Failure with 4 FAIL
- Should be equal ${loop.kws[3].kws[2].status} NOT RUN
- Length should be ${loop.kws[3].kws} 3
- Should be equal ${loop.kws[3].status} FAIL
+ Should be FOR loop ${loop} 4 FAIL
+ Check Log Message ${loop[0, 0, 0]} Before Check
+ Check Log Message ${loop[0, 2, 0]} After Check
+ Length Should Be ${loop[0].body} 3
+ Should Be Equal ${loop[0].status} PASS
+ Should Be Equal ${loop[1].status} PASS
+ Should Be Equal ${loop[2].status} PASS
+ Check Log Message ${loop[3, 0, 0]} Before Check
+ Check Log Message ${loop[3, 1, 0]} Failure with <4> FAIL
+ Should Be Equal ${loop[3, 2].status} NOT RUN
+ Length Should Be ${loop[3].body} 3
+ Should Be Equal ${loop[3].status} FAIL
Loop with user keywords
${loop} = Check test and get loop ${TEST NAME}
Should be FOR loop ${loop} 2
- Check kw "My UK" ${loop.kws[0].kws[0]}
- Check kw "My UK 2" ${loop.kws[0].kws[1]} foo
- Check kw "My UK" ${loop.kws[1].kws[0]}
- Check kw "My UK 2" ${loop.kws[1].kws[1]} bar
+ Check kw "My UK" ${loop[0, 0]}
+ Check kw "My UK 2" ${loop[0, 1]} foo
+ Check kw "My UK" ${loop[1, 0]}
+ Check kw "My UK 2" ${loop[1, 1]} bar
Loop with failures in user keywords
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 2 FAIL
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 2 FAIL
Loop in user keyword
- ${tc} = Check test case ${TEST NAME}
- Check kw "For In UK" ${tc.kws[0]}
- Check kw "For In UK with Args" ${tc.kws[1]} 4 one
+ ${tc} = Check Test Case ${TEST NAME}
+ Check kw "For In UK" ${tc[0]}
+ Check kw "For In UK with Args" ${tc[1]} 4 one
Keyword with loop calling other keywords with loops
- ${tc} = Check test case ${TEST NAME}
- Check kw "Nested For In UK" ${tc.kws[0]} foo
+ ${tc} = Check Test Case ${TEST NAME}
+ Check kw "Nested For In UK" ${tc[0]} foo
Test with loop calling keywords with loops
${loop} = Check test and get loop ${TEST NAME} 1
- Should be FOR loop ${loop} 1 FAIL
- Check kw "For In UK" ${loop.kws[0].kws[0]}
- Check kw "For In UK with Args" ${loop.kws[0].kws[1]} 2 one
- Check kw "Nested For In UK" ${loop.kws[0].kws[2]} one
+ Should be FOR loop ${loop} 1 FAIL
+ Check kw "For In UK" ${loop[0, 0]}
+ Check kw "For In UK with Args" ${loop[0, 1]} 2 one
+ Check kw "Nested For In UK" ${loop[0, 2]} one
Loop variables is available after loop
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Assign inside loop
${loop} = Check test and get loop ${TEST NAME}
Should be FOR loop ${loop} 2
- Check log message ${loop.kws[0].kws[0].msgs[0]} \${v1} = v1
- Check log message ${loop.kws[0].kws[1].msgs[0]} \${v2} = v2
- Check log message ${loop.kws[0].kws[1].msgs[1]} \${v3} = vY
- Check log message ${loop.kws[0].kws[2].msgs[0]} \@{list} = [ v1 | v2 | vY | Y ]
- Check log message ${loop.kws[1].kws[0].msgs[0]} \${v1} = v1
- Check log message ${loop.kws[1].kws[1].msgs[0]} \${v2} = v2
- Check log message ${loop.kws[1].kws[1].msgs[1]} \${v3} = vZ
- Check log message ${loop.kws[1].kws[2].msgs[0]} \@{list} = [ v1 | v2 | vZ | Z ]
+ Check Log Message ${loop[0, 0, 0]} \${v1} = v1
+ Check Log Message ${loop[0, 1, 0]} \${v2} = v2
+ Check Log Message ${loop[0, 1, 1]} \${v3} = vY
+ Check Log Message ${loop[0, 2, 0]} \@{list} = [ v1 | v2 | vY | Y ]
+ Check Log Message ${loop[1, 0, 0]} \${v1} = v1
+ Check Log Message ${loop[1, 1, 0]} \${v2} = v2
+ Check Log Message ${loop[1, 1, 1]} \${v3} = vZ
+ Check Log Message ${loop[1, 2, 0]} \@{list} = [ v1 | v2 | vZ | Z ]
Invalid assign inside loop
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.kws[0]} 1 FAIL
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR loop ${tc[0]} 1 FAIL
Loop with non-existing keyword
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Loop with non-existing variable
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Loop value with non-existing variable
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Multiple loop variables
${tc} = Check Test Case ${TEST NAME}
- ${loop} = Set Variable ${tc.body[0]}
- Should be FOR loop ${loop} 4
- Should be FOR iteration ${loop.body[0]} \${x}=1 \${y}=a
- Check log message ${loop.body[0].body[0].msgs[0]} 1a
- Should be FOR iteration ${loop.body[1]} \${x}=2 \${y}=b
- Check log message ${loop.body[1].body[0].msgs[0]} 2b
- Should be FOR iteration ${loop.body[2]} \${x}=3 \${y}=c
- Check log message ${loop.body[2].body[0].msgs[0]} 3c
- Should be FOR iteration ${loop.body[3]} \${x}=4 \${y}=d
- Check log message ${loop.body[3].body[0].msgs[0]} 4d
- ${loop} = Set Variable ${tc.body[2]}
- Should be FOR loop ${loop} 2
- Should be FOR iteration ${loop.body[0]} \${a}=1 \${b}=2 \${c}=3 \${d}=4 \${e}=5
- Should be FOR iteration ${loop.body[1]} \${a}=1 \${b}=2 \${c}=3 \${d}=4 \${e}=5
+ ${loop} = Set Variable ${tc[0]}
+ Should be FOR loop ${loop} 4
+ Should be FOR iteration ${loop[0]} \${x}=1 \${y}=a
+ Check Log Message ${loop[0, 0, 0]} 1a
+ Should be FOR iteration ${loop[1]} \${x}=2 \${y}=b
+ Check Log Message ${loop[1, 0, 0]} 2b
+ Should be FOR iteration ${loop[2]} \${x}=3 \${y}=c
+ Check Log Message ${loop[2, 0, 0]} 3c
+ Should be FOR iteration ${loop[3]} \${x}=4 \${y}=d
+ Check Log Message ${loop[3, 0, 0]} 4d
+ ${loop} = Set Variable ${tc[2]}
+ Should be FOR loop ${loop} 2
+ Should be FOR iteration ${loop[0]} \${a}=1 \${b}=2 \${c}=3 \${d}=4 \${e}=5
+ Should be FOR iteration ${loop[1]} \${a}=1 \${b}=2 \${c}=3 \${d}=4 \${e}=5
Wrong number of loop variables
Check test and failed loop ${TEST NAME} 1
Check test and failed loop ${TEST NAME} 2
Cut long iteration variable values
- ${tc} = Check test case ${TEST NAME}
- ${loop} = Set Variable ${tc.body[6]}
+ ${tc} = Check Test Case ${TEST NAME}
+ ${loop} = Set Variable ${tc[6]}
${exp10} = Set Variable 0123456789
${exp100} = Evaluate "${exp10}" * 10
${exp200} = Evaluate "${exp10}" * 20
${exp200+} = Set Variable ${exp200}...
- Should be FOR loop ${loop} 6
- Should be FOR iteration ${loop.body[0]} \${var}=${exp10}
- Should be FOR iteration ${loop.body[1]} \${var}=${exp100}
- Should be FOR iteration ${loop.body[2]} \${var}=${exp200}
- Should be FOR iteration ${loop.body[3]} \${var}=${exp200+}
- Should be FOR iteration ${loop.body[4]} \${var}=${exp200+}
- Should be FOR iteration ${loop.body[5]} \${var}=${exp200+}
- ${loop} = Set Variable ${tc.body[7]}
- Should be FOR loop ${loop} 2
- Should be FOR iteration ${loop.body[0]} \${var1}=${exp10} \${var2}=${exp100} \${var3}=${exp200}
- Should be FOR iteration ${loop.body[1]} \${var1}=${exp200+} \${var2}=${exp200+} \${var3}=${exp200+}
+ Should be FOR loop ${loop} 6
+ Should be FOR iteration ${loop[0]} \${var}=${exp10}
+ Should be FOR iteration ${loop[1]} \${var}=${exp100}
+ Should be FOR iteration ${loop[2]} \${var}=${exp200}
+ Should be FOR iteration ${loop[3]} \${var}=${exp200+}
+ Should be FOR iteration ${loop[4]} \${var}=${exp200+}
+ Should be FOR iteration ${loop[5]} \${var}=${exp200+}
+ ${loop} = Set Variable ${tc[7]}
+ Should be FOR loop ${loop} 2
+ Should be FOR iteration ${loop[0]} \${var1}=${exp10} \${var2}=${exp100} \${var3}=${exp200}
+ Should be FOR iteration ${loop[1]} \${var1}=${exp200+} \${var2}=${exp200+} \${var3}=${exp200+}
Characters that are illegal in XML
- ${tc} = Check test case ${TEST NAME}
- Should be FOR iteration ${tc.body[0].body[0]} \${var}=illegal:
- Should be FOR iteration ${tc.body[0].body[1]} \${var}=more:
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be FOR iteration ${tc[0, 0]} \${var}=illegal:
+ Should be FOR iteration ${tc[0, 1]} \${var}=more:
Old :FOR syntax is not supported
Check Test Case ${TESTNAME}
@@ -235,12 +235,12 @@ Escaping with backslash is not supported
Check Test Case ${TESTNAME}
FOR is case and space sensitive
- Check test case ${TEST NAME} 1
- Check test case ${TEST NAME} 2
+ Check Test Case ${TEST NAME} 1
+ Check Test Case ${TEST NAME} 2
Invalid END usage
- Check test case ${TEST NAME} 1
- Check test case ${TEST NAME} 2
+ Check Test Case ${TEST NAME} 1
+ Check Test Case ${TEST NAME} 2
Empty body
Check test and failed loop ${TEST NAME}
@@ -252,11 +252,10 @@ Invalid END
Check test and failed loop ${TEST NAME}
No loop values
- ${tc} = Check test case ${TEST NAME}
- Should be FOR loop ${tc.body[0]} 0 FAIL
+ Check test and failed loop ${TEST NAME}
No loop variables
- Check Test Case ${TESTNAME}
+ Check test and failed loop ${TEST NAME}
Invalid loop variable
Check test and failed loop ${TEST NAME} 1
@@ -267,13 +266,13 @@ Invalid loop variable
Check test and failed loop ${TEST NAME} 6
Invalid separator
- Check test case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Separator is case- and space-sensitive
- Check test case ${TEST NAME} 1
- Check test case ${TEST NAME} 2
- Check test case ${TEST NAME} 3
- Check test case ${TEST NAME} 4
+ Check Test Case ${TEST NAME} 1
+ Check Test Case ${TEST NAME} 2
+ Check Test Case ${TEST NAME} 3
+ Check Test Case ${TEST NAME} 4
FOR without any paramenters
Check Test Case ${TESTNAME}
@@ -284,10 +283,10 @@ Syntax error in nested loop
Unexecuted
${tc} = Check Test Case ${TESTNAME}
- Should be FOR loop ${tc.body[1].body[0].body[0]} 1 NOT RUN
- Should be FOR iteration ${tc.body[1].body[0].body[0].body[0]} \${x}= \${y}=
- Should be FOR loop ${tc.body[5]} 1 NOT RUN
- Should be FOR iteration ${tc.body[5].body[0]} \${x}= \${y}=
+ Should be FOR loop ${tc[1, 0, 0]} 1 NOT RUN
+ Should be FOR iteration ${tc[1, 0, 0, 0]} \${x}= \${y}=
+ Should be FOR loop ${tc[5]} 1 NOT RUN
+ Should be FOR iteration ${tc[5, 0]} \${x}= \${y}=
Header at the end of file
Check Test Case ${TESTNAME}
@@ -295,49 +294,49 @@ Header at the end of file
*** Keywords ***
"Variables in values" helper
[Arguments] ${kw} ${num}
- Check log message ${kw.kws[0].msgs[0]} ${num}
- Check log message ${kw.kws[1].msgs[0]} Hello from for loop
- Should be equal ${kw.kws[2].name} BuiltIn.No Operation
+ Check Log Message ${kw[0, 0]} ${num}
+ Check Log Message ${kw[1, 0]} Hello from for loop
+ Should Be Equal ${kw[2].full_name} BuiltIn.No Operation
Check kw "My UK"
[Arguments] ${kw}
- Should be equal ${kw.name} My UK
- Should be equal ${kw.kws[0].name} BuiltIn.No Operation
- Check log message ${kw.kws[1].msgs[0]} We are in My UK
+ Should Be Equal ${kw.full_name} My UK
+ Should Be Equal ${kw[0].full_name} BuiltIn.No Operation
+ Check Log Message ${kw[1, 0]} We are in My UK
Check kw "My UK 2"
[Arguments] ${kw} ${arg}
- Should be equal ${kw.name} My UK 2
- Check kw "My UK" ${kw.kws[0]}
- Check log message ${kw.kws[1].msgs[0]} My UK 2 got argument "${arg}"
- Check kw "My UK" ${kw.kws[2]}
+ Should Be Equal ${kw.full_name} My UK 2
+ Check kw "My UK" ${kw[0]}
+ Check Log Message ${kw[1, 0]} My UK 2 got argument "${arg}"
+ Check kw "My UK" ${kw[2]}
Check kw "For In UK"
[Arguments] ${kw}
- Should be equal ${kw.name} For In UK
- Check log message ${kw.kws[0].msgs[0]} Not for yet
- Should be FOR loop ${kw.kws[1]} 2
- Check log message ${kw.kws[1].kws[0].kws[0].msgs[0]} This is for with 1
- Check kw "My UK" ${kw.kws[1].kws[0].kws[1]}
- Check log message ${kw.kws[1].kws[1].kws[0].msgs[0]} This is for with 2
- Check kw "My UK" ${kw.kws[1].kws[1].kws[1]}
- Check log message ${kw.kws[2].msgs[0]} Not for anymore
+ Should Be Equal ${kw.full_name} For In UK
+ Check Log Message ${kw[0, 0]} Not for yet
+ Should be FOR loop ${kw[1]} 2
+ Check Log Message ${kw[1, 0, 0, 0]} This is for with 1
+ Check kw "My UK" ${kw[1, 0, 1]}
+ Check Log Message ${kw[1, 1, 0, 0]} This is for with 2
+ Check kw "My UK" ${kw[1, 1, 1]}
+ Check Log Message ${kw[2, 0]} Not for anymore
Check kw "For In UK With Args"
[Arguments] ${kw} ${arg_count} ${first_arg}
- Should be equal ${kw.name} For In UK With Args
- Should be FOR loop ${kw.kws[0]} ${arg_count}
- Check kw "My UK 2" ${kw.kws[0].kws[0].kws[0]} ${first_arg}
- Should be FOR loop ${kw.kws[2]} 1
- Check log message ${kw.kws[2].kws[0].kws[0].msgs[0]} This for loop is executed only once
+ Should Be Equal ${kw.full_name} For In UK With Args
+ Should be FOR loop ${kw[0]} ${arg_count}
+ Check kw "My UK 2" ${kw[0, 0, 0]} ${first_arg}
+ Should be FOR loop ${kw[2]} 1
+ Check Log Message ${kw[2, 0, 0, 0]} This for loop is executed only once
Check kw "Nested For In UK"
[Arguments] ${kw} ${first_arg}
- Should be FOR loop ${kw.kws[0]} 1 FAIL
- Check kw "For In UK" ${kw.kws[0].kws[0].kws[0]}
- ${nested2} = Set Variable ${kw.kws[0].kws[0].kws[1]}
- Should be equal ${nested2.name} Nested For In UK 2
- Should be FOR loop ${nested2.kws[0]} 2
- Check kw "For In UK" ${nested2.kws[0].kws[0].kws[0]}
- Check log message ${nested2.kws[0].kws[0].kws[1].msgs[0]} Got arg: ${first_arg}
- Check log message ${nested2.kws[1].msgs[0]} This ought to be enough FAIL
+ Should be FOR loop ${kw[0]} 1 FAIL
+ Check kw "For In UK" ${kw[0, 0, 0]}
+ ${nested2} = Set Variable ${kw[0, 0, 1]}
+ Should Be Equal ${nested2.full_name} Nested For In UK 2
+ Should be FOR loop ${nested2[0]} 2
+ Check kw "For In UK" ${nested2[0, 0, 0]}
+ Check Log Message ${nested2[0, 0, 1, 0]} Got arg: ${first_arg}
+ Check Log Message ${nested2[1, 0]} This ought to be enough FAIL
diff --git a/atest/robot/running/for/for_dict_iteration.robot b/atest/robot/running/for/for_dict_iteration.robot
index ceb0c5caf45..a8b840726fc 100644
--- a/atest/robot/running/for/for_dict_iteration.robot
+++ b/atest/robot/running/for/for_dict_iteration.robot
@@ -43,7 +43,7 @@ FOR IN ENUMERATE loop with three variables
FOR IN ENUMERATE loop with start
${loop} = Check test and get loop ${TESTNAME}
- Should be IN ENUMERATE loop ${loop} 3
+ Should be IN ENUMERATE loop ${loop} 3 start=42
FOR IN ENUMERATE loop with more than three variables is invalid
Check test and failed loop ${TESTNAME} IN ENUMERATE
@@ -72,14 +72,14 @@ Equal sign in variable
... FOR loop iteration over values that are all in 'name=value' format like 'a=1' is deprecated.
... In the future this syntax will mean iterating over names and values separately like when iterating over '\&{dict} variables.
... Escape at least one of the values like 'a\\=1' to use normal FOR loop iteration and to disable this warning.
- Check Log Message ${tc.body[0].msgs[0]} ${message} WARN
- Check Log Message ${ERRORS}[0] ${message} WARN
+ Check Log Message ${tc[0, 0]} ${message} WARN
+ Check Log Message ${ERRORS}[0] ${message} WARN
${message} = Catenate
... FOR loop iteration over values that are all in 'name=value' format like 'x==1' is deprecated.
... In the future this syntax will mean iterating over names and values separately like when iterating over '\&{dict} variables.
... Escape at least one of the values like 'x\\==1' to use normal FOR loop iteration and to disable this warning.
- Check Log Message ${tc.body[2].msgs[0]} ${message} WARN
- Check Log Message ${ERRORS}[1] ${message} WARN
+ Check Log Message ${tc[2, 0]} ${message} WARN
+ Check Log Message ${ERRORS}[1] ${message} WARN
Non-string keys
Check Test Case ${TESTNAME}
diff --git a/atest/robot/running/for/for_in_enumerate.robot b/atest/robot/running/for/for_in_enumerate.robot
index a47d2a809d0..67ddc3c3134 100644
--- a/atest/robot/running/for/for_in_enumerate.robot
+++ b/atest/robot/running/for/for_in_enumerate.robot
@@ -21,7 +21,7 @@ Values from list variable
Start
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ENUMERATE loop ${loop} 5
+ Should be IN ENUMERATE loop ${loop} 5 start=1
Should be FOR iteration ${loop.body[0]} \${index}=1 \${item}=1
Should be FOR iteration ${loop.body[1]} \${index}=2 \${item}=2
Should be FOR iteration ${loop.body[2]} \${index}=3 \${item}=3
@@ -33,12 +33,14 @@ Escape start
Should be IN ENUMERATE loop ${loop} 2
Invalid start
- ${loop} = Check test and get loop ${TEST NAME}
- Should be IN ENUMERATE loop ${loop} 0 status=FAIL
+ Check test and failed loop ${TEST NAME} IN ENUMERATE start=invalid
Invalid variable in start
+ Check test and failed loop ${TEST NAME} IN ENUMERATE start=\${invalid}
+
+Start multiple times
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ENUMERATE loop ${loop} 0 status=FAIL
+ Should be IN ENUMERATE loop ${loop} 1 start=2
Index and two items
${loop} = Check test and get loop ${TEST NAME} 1
@@ -66,4 +68,4 @@ No values
Check test and failed loop ${TEST NAME} IN ENUMERATE
No values with start
- Check test and failed loop ${TEST NAME} IN ENUMERATE
+ Check test and failed loop ${TEST NAME} IN ENUMERATE start=0
diff --git a/atest/robot/running/for/for_in_range.robot b/atest/robot/running/for/for_in_range.robot
index 9c3f2c12a7a..0defe65d78d 100644
--- a/atest/robot/running/for/for_in_range.robot
+++ b/atest/robot/running/for/for_in_range.robot
@@ -5,65 +5,65 @@ Resource for.resource
*** Test Cases ***
Only stop
${loop} = Check test and get loop ${TEST NAME}
- Should be IN RANGE loop ${loop} 100
- Should be FOR iteration ${loop.body[0]} \${i}=0
- Check log message ${loop.body[0].body[1].msgs[0]} i: 0
- Should be FOR iteration ${loop.body[1]} \${i}=1
- Check log message ${loop.body[1].body[1].msgs[0]} i: 1
- Should be FOR iteration ${loop.body[42]} \${i}=42
- Check log message ${loop.body[42].body[1].msgs[0]} i: 42
- Should be FOR iteration ${loop.body[-1]} \${i}=99
- Check log message ${loop.body[-1].body[1].msgs[0]} i: 99
+ Should be IN RANGE loop ${loop} 100
+ Should be FOR iteration ${loop[0]} \${i}=0
+ Check log message ${loop[0, 1, 0]} i: 0
+ Should be FOR iteration ${loop[1]} \${i}=1
+ Check log message ${loop[1, 1, 0]} i: 1
+ Should be FOR iteration ${loop[42]} \${i}=42
+ Check log message ${loop[42, 1, 0]} i: 42
+ Should be FOR iteration ${loop[-1]} \${i}=99
+ Check log message ${loop[-1, 1, 0]} i: 99
Start and stop
- ${loop} = Check test and get loop ${TEST NAME}
- Should be IN RANGE loop ${loop} 4
+ ${loop} = Check test and get loop ${TEST NAME}
+ Should be IN RANGE loop ${loop} 4
Start, stop and step
- ${loop} = Check test and get loop ${TEST NAME}
- Should be IN RANGE loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${item}=10
- Should be FOR iteration ${loop.body[1]} \${item}=7
- Should be FOR iteration ${loop.body[2]} \${item}=4
+ ${loop} = Check test and get loop ${TEST NAME}
+ Should be IN RANGE loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${item}=10
+ Should be FOR iteration ${loop[1]} \${item}=7
+ Should be FOR iteration ${loop[2]} \${item}=4
Float stop
- ${loop} = Check test and get loop ${TEST NAME} 1
- Should be IN RANGE loop ${loop} 4
- Should be FOR iteration ${loop.body[0]} \${item}=0.0
- Should be FOR iteration ${loop.body[1]} \${item}=1.0
- Should be FOR iteration ${loop.body[2]} \${item}=2.0
- Should be FOR iteration ${loop.body[3]} \${item}=3.0
- ${loop} = Check test and get loop ${TEST NAME} 2
- Should be IN RANGE loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${item}=0.0
- Should be FOR iteration ${loop.body[1]} \${item}=1.0
- Should be FOR iteration ${loop.body[2]} \${item}=2.0
+ ${loop} = Check test and get loop ${TEST NAME} 1
+ Should be IN RANGE loop ${loop} 4
+ Should be FOR iteration ${loop[0]} \${item}=0.0
+ Should be FOR iteration ${loop[1]} \${item}=1.0
+ Should be FOR iteration ${loop[2]} \${item}=2.0
+ Should be FOR iteration ${loop[3]} \${item}=3.0
+ ${loop} = Check test and get loop ${TEST NAME} 2
+ Should be IN RANGE loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${item}=0.0
+ Should be FOR iteration ${loop[1]} \${item}=1.0
+ Should be FOR iteration ${loop[2]} \${item}=2.0
Float start and stop
- ${loop} = Check test and get loop ${TEST NAME} 1
- Should be IN RANGE loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${item}=-1.5
- Should be FOR iteration ${loop.body[1]} \${item}=-0.5
- Should be FOR iteration ${loop.body[2]} \${item}=0.5
- ${loop} = Check test and get loop ${TEST NAME} 2 0
- Should be IN RANGE loop ${loop} 4
- Should be FOR iteration ${loop.body[0]} \${item}=-1.5
- Should be FOR iteration ${loop.body[1]} \${item}=-0.5
- Should be FOR iteration ${loop.body[2]} \${item}=0.5
- Should be FOR iteration ${loop.body[3]} \${item}=1.5
+ ${loop} = Check test and get loop ${TEST NAME} 1
+ Should be IN RANGE loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${item}=-1.5
+ Should be FOR iteration ${loop[1]} \${item}=-0.5
+ Should be FOR iteration ${loop[2]} \${item}=0.5
+ ${loop} = Check test and get loop ${TEST NAME} 2 0
+ Should be IN RANGE loop ${loop} 4
+ Should be FOR iteration ${loop[0]} \${item}=-1.5
+ Should be FOR iteration ${loop[1]} \${item}=-0.5
+ Should be FOR iteration ${loop[2]} \${item}=0.5
+ Should be FOR iteration ${loop[3]} \${item}=1.5
Float start, stop and step
- ${loop} = Check test and get loop ${TEST NAME}
- Should be IN RANGE loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${item}=10.99
- Should be FOR iteration ${loop.body[1]} \${item}=7.95
- Should be FOR iteration ${loop.body[2]} \${item}=4.91
+ ${loop} = Check test and get loop ${TEST NAME}
+ Should be IN RANGE loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${item}=10.99
+ Should be FOR iteration ${loop[1]} \${item}=7.95
+ Should be FOR iteration ${loop[2]} \${item}=4.91
Variables in arguments
- ${loop} = Check test and get loop ${TEST NAME} 0
- Should be IN RANGE loop ${loop} 2
- ${loop} = Check test and get loop ${TEST NAME} 2
- Should be IN RANGE loop ${loop} 1
+ ${loop} = Check test and get loop ${TEST NAME} 0
+ Should be IN RANGE loop ${loop} 2
+ ${loop} = Check test and get loop ${TEST NAME} 2
+ Should be IN RANGE loop ${loop} 1
Calculations
Check test case ${TEST NAME}
@@ -72,15 +72,15 @@ Calculations with floats
Check test case ${TEST NAME}
Multiple variables
- ${loop} = Check test and get loop ${TEST NAME} 0
- Should be IN RANGE loop ${loop} 1
- Should be FOR iteration ${loop.body[0]} \${a}=0 \${b}=1 \${c}=2 \${d}=3 \${e}=4
- ${loop} = Check test and get loop ${TEST NAME} 2
- Should be IN RANGE loop ${loop} 4
- Should be FOR iteration ${loop.body[0]} \${i}=-1 \${j}=0 \${k}=1
- Should be FOR iteration ${loop.body[1]} \${i}=2 \${j}=3 \${k}=4
- Should be FOR iteration ${loop.body[2]} \${i}=5 \${j}=6 \${k}=7
- Should be FOR iteration ${loop.body[3]} \${i}=8 \${j}=9 \${k}=10
+ ${loop} = Check test and get loop ${TEST NAME} 0
+ Should be IN RANGE loop ${loop} 1
+ Should be FOR iteration ${loop[0]} \${a}=0 \${b}=1 \${c}=2 \${d}=3 \${e}=4
+ ${loop} = Check test and get loop ${TEST NAME} 2
+ Should be IN RANGE loop ${loop} 4
+ Should be FOR iteration ${loop[0]} \${i}=-1 \${j}=0 \${k}=1
+ Should be FOR iteration ${loop[1]} \${i}=2 \${j}=3 \${k}=4
+ Should be FOR iteration ${loop[2]} \${i}=5 \${j}=6 \${k}=7
+ Should be FOR iteration ${loop[3]} \${i}=8 \${j}=9 \${k}=10
Too many arguments
Check test and failed loop ${TEST NAME} IN RANGE
diff --git a/atest/robot/running/for/for_in_zip.robot b/atest/robot/running/for/for_in_zip.robot
index b512c9a9a21..987e080ff40 100644
--- a/atest/robot/running/for/for_in_zip.robot
+++ b/atest/robot/running/for/for_in_zip.robot
@@ -5,70 +5,122 @@ Resource for.resource
*** Test Cases ***
Two variables and lists
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a \${y}=x
- Should be FOR iteration ${loop.body[1]} \${x}=b \${y}=y
- Should be FOR iteration ${loop.body[2]} \${x}=c \${y}=z
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=a \${y}=x
+ Should be FOR iteration ${loop[1]} \${x}=b \${y}=y
+ Should be FOR iteration ${loop[2]} \${x}=c \${y}=z
-Uneven lists
+Uneven lists cause deprecation warning by default
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a \${y}=1
- Should be FOR iteration ${loop.body[1]} \${x}=b \${y}=2
- Should be FOR iteration ${loop.body[2]} \${x}=c \${y}=3
+ Should be IN ZIP loop ${loop} 3
+ Check Log Message ${loop[0]}
+ ... FOR IN ZIP default mode will be changed from SHORTEST to STRICT in Robot Framework 8.0. Use 'mode=SHORTEST' to keep using the SHORTEST mode. If the mode is not changed, execution will fail like this in the future: FOR IN ZIP items must have equal lengths in the STRICT mode, but lengths are 3 and 5. WARN
+ Should be FOR iteration ${loop[1]} \${x}=a \${y}=1
+ Should be FOR iteration ${loop[2]} \${x}=b \${y}=2
+ Should be FOR iteration ${loop[3]} \${x}=c \${y}=3
Three variables and lists
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a \${y}=x \${z}=1
- Should be FOR iteration ${loop.body[1]} \${x}=b \${y}=y \${z}=2
- Should be FOR iteration ${loop.body[2]} \${x}=c \${y}=z \${z}=3
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=a \${y}=x \${z}=1
+ Should be FOR iteration ${loop[1]} \${x}=b \${y}=y \${z}=2
+ Should be FOR iteration ${loop[2]} \${x}=c \${y}=z \${z}=3
Six variables and lists
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a \${y}=x \${z}=1 \${å}=1 \${ä}=x \${ö}=a
- Should be FOR iteration ${loop.body[1]} \${x}=b \${y}=y \${z}=2 \${å}=2 \${ä}=y \${ö}=b
- Should be FOR iteration ${loop.body[2]} \${x}=c \${y}=z \${z}=3 \${å}=3 \${ä}=z \${ö}=c
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=a \${y}=x \${z}=1 \${å}=1 \${ä}=x \${ö}=a
+ Should be FOR iteration ${loop[1]} \${x}=b \${y}=y \${z}=2 \${å}=2 \${ä}=y \${ö}=b
+ Should be FOR iteration ${loop[2]} \${x}=c \${y}=z \${z}=3 \${å}=3 \${ä}=z \${ö}=c
One variable and list
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a
- Should be FOR iteration ${loop.body[1]} \${x}=b
- Should be FOR iteration ${loop.body[2]} \${x}=c
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=a
+ Should be FOR iteration ${loop[1]} \${x}=b
+ Should be FOR iteration ${loop[2]} \${x}=c
One variable and two lists
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=('a', 'x')
- Should be FOR iteration ${loop.body[1]} \${x}=('b', 'y')
- Should be FOR iteration ${loop.body[2]} \${x}=('c', 'z')
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=('a', 'x')
+ Should be FOR iteration ${loop[1]} \${x}=('b', 'y')
+ Should be FOR iteration ${loop[2]} \${x}=('c', 'z')
One variable and six lists
${loop} = Check test and get loop ${TEST NAME}
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=('a', 'x', '1', '1', 'x', 'a')
- Should be FOR iteration ${loop.body[1]} \${x}=('b', 'y', '2', '2', 'y', 'b')
- Should be FOR iteration ${loop.body[2]} \${x}=('c', 'z', '3', '3', 'z', 'c')
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=('a', 'x', 1, 1, 'x', 'a')
+ Should be FOR iteration ${loop[1]} \${x}=('b', 'y', 2, 2, 'y', 'b')
+ Should be FOR iteration ${loop[2]} \${x}=('c', 'z', 3, 3, 'z', 'c')
Other iterables
Check Test Case ${TEST NAME}
List variable containing iterables
- ${loop} = Check test and get loop ${TEST NAME} 2
- Should be IN ZIP loop ${loop} 3
- Should be FOR iteration ${loop.body[0]} \${x}=a \${y}=x \${z}=f
- Should be FOR iteration ${loop.body[1]} \${x}=b \${y}=y \${z}=o
- Should be FOR iteration ${loop.body[2]} \${x}=c \${y}=z \${z}=o
+ ${loop} = Check test and get loop ${TEST NAME} 1
+ Should be IN ZIP loop ${loop} 3
+ Should be FOR iteration ${loop[0]} \${x}=a \${y}=x \${z}=f
+ Should be FOR iteration ${loop[1]} \${x}=b \${y}=y \${z}=o
+ Should be FOR iteration ${loop[2]} \${x}=c \${y}=z \${z}=o
List variable with iterables can be empty
${tc} = Check Test Case ${TEST NAME}
- Should be IN ZIP loop ${tc.body[0]} 1 NOT RUN
- Should be FOR iteration ${tc.body[0].body[0]} \${x}=
- Should be IN ZIP loop ${tc.body[1]} 1 NOT RUN
- Should be FOR iteration ${tc.body[1].body[0]} \${x}= \${y}= \${z}=
- Check Log Message ${tc.body[2].msgs[0]} Executed!
+ Should be IN ZIP loop ${tc[0]} 1 NOT RUN
+ Should be FOR iteration ${tc[0, 0]} \${x}=
+ Should be IN ZIP loop ${tc[1]} 1 NOT RUN
+ Should be FOR iteration ${tc[1, 0]} \${x}= \${y}= \${z}=
+ Check Log Message ${tc[2, 0]} Executed!
+
+Strict mode
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 3 PASS mode=STRICT
+ Should be IN ZIP loop ${tc[2]} 1 FAIL mode=strict
+
+Strict mode requires items to have length
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=STRICT
+
+Shortest mode
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 3 PASS mode=SHORTEST fill=ignored
+ Should be IN ZIP loop ${tc[3]} 3 PASS mode=\${{'shortest'}}
+
+Shortest mode supports infinite iterators
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 3 PASS mode=SHORTEST
+
+Longest mode
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 3 PASS mode=LONGEST
+ Should be IN ZIP loop ${tc[3]} 5 PASS mode=LoNgEsT
+
+Longest mode with custom fill value
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 5 PASS mode=longest fill=?
+ Should be IN ZIP loop ${tc[3]} 3 PASS mode=longest fill=\${0}
+
+Invalid mode
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=bad
+
+Invalid mode from variable
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=\${{'bad'}}
+
+Config more than once
+ ${tc} = Check Test Case ${TEST NAME} 1
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=shortest
+ ${tc} = Check Test Case ${TEST NAME} 2
+ Should be IN ZIP loop ${tc[0]} 1 FAIL fill=z
+
+Non-existing variable in mode
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=\${bad} fill=\${ignored}
+
+Non-existing variable in fill value
+ ${tc} = Check Test Case ${TEST NAME}
+ Should be IN ZIP loop ${tc[0]} 1 FAIL mode=longest fill=\${bad}
Not iterable value
Check test and failed loop ${TEST NAME} IN ZIP
diff --git a/atest/robot/running/group/group.robot b/atest/robot/running/group/group.robot
new file mode 100644
index 00000000000..f579f090cf5
--- /dev/null
+++ b/atest/robot/running/group/group.robot
@@ -0,0 +1,42 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/group/group.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Basics
+ ${tc}= Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP name=1st group children=2
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Log args=Inside group
+ Check Body Item Data ${tc[0, 1]} type=KEYWORD name=Log args=Still inside
+ Check Body Item Data ${tc[1]} type=GROUP name=second children=1
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD name=Log args=Inside second group
+ Check Body Item Data ${tc[2]} type=KEYWORD name=Log args=After
+
+Failing
+ ${tc}= Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP name=Fails children=2 status=FAIL message=Failing inside GROUP!
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Fail children=1 status=FAIL message=Failing inside GROUP!
+ Check Body Item Data ${tc[0, 1]} type=KEYWORD name=Fail children=0 status=NOT RUN
+ Check Body Item Data ${tc[1]} type=GROUP name=Not run children=1 status=NOT RUN
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD name=Fail children=0 status=NOT RUN
+
+Anonymous
+ ${tc}= Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP name=${EMPTY} children=1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Log args=Inside unnamed group
+
+Variable in name
+ ${tc}= Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP name=Test is named: ${TEST NAME} children=1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Log args=\${TEST_NAME}
+ Check Log Message ${tc[0, 0, 0]} ${TEST NAME}
+ Check Body Item Data ${tc[1]} type=GROUP name=42 children=1
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD name=Log args=Should be 42
+
+In user keyword
+ ${tc}= Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=KEYWORD name=Keyword children=4
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Log args=Before
+ Check Body Item Data ${tc[0, 1]} type=GROUP name=First children=2
+ Check Body Item Data ${tc[0, 2]} type=GROUP name=Second children=1
+ Check Body Item Data ${tc[0, 3]} type=KEYWORD name=Log args=After
diff --git a/atest/robot/running/group/invalid_group.robot b/atest/robot/running/group/invalid_group.robot
new file mode 100644
index 00000000000..f6d415cdaf9
--- /dev/null
+++ b/atest/robot/running/group/invalid_group.robot
@@ -0,0 +1,44 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/group/invalid_group.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+END missing
+ ${tc} = Check Test Case ${TESTNAME}
+ Length Should Be ${tc.body} 1
+ Check Body Item Data ${tc[0]} GROUP status=FAIL children=2 message=GROUP must have closing END.
+ Check Body Item Data ${tc[0, 0]} KEYWORD status=NOT RUN children=0 name=Fail args=Not run
+ Check Body Item Data ${tc[0, 1]} MESSAGE level=FAIL message=GROUP must have closing END.
+
+Empty
+ ${tc} Check Test Case ${TESTNAME}
+ Length Should Be ${tc.body} 2
+ Check Body Item Data ${tc[0]} GROUP status=FAIL children=1 message=GROUP cannot be empty.
+ Check Body Item Data ${tc[0, 0]} MESSAGE level=FAIL message=GROUP cannot be empty.
+ Check Body Item Data ${tc[1]} KEYWORD status=NOT RUN children=0 name=Log args=Outside
+
+Multiple parameters
+ ${tc} Check Test Case ${TESTNAME}
+ Length Should Be ${tc.body} 2
+ Check Body Item Data ${tc[0]} GROUP status=FAIL children=2 message=GROUP accepts only one argument as name, got 3 arguments 'Too', 'many' and 'values'.
+ Check Body Item Data ${tc[0, 0]} KEYWORD status=NOT RUN children=0 name=Fail args=Not run
+ Check Body Item Data ${tc[0, 1]} MESSAGE level=FAIL message=GROUP accepts only one argument as name, got 3 arguments 'Too', 'many' and 'values'.
+ Check Body Item Data ${tc[1]} KEYWORD status=NOT RUN children=0 name=Log args=Last Keyword
+
+Non-existing variable in name
+ ${tc} Check Test Case ${TESTNAME}
+ Length Should Be ${tc.body} 2
+ Check Body Item Data ${tc[0]} GROUP status=FAIL children=2 message=Variable '\${non_existing_var}' not found. name=\${non_existing_var} in name
+ Check Body Item Data ${tc[0, 0]} KEYWORD status=NOT RUN children=0 name=Fail args=Not run
+ Check Body Item Data ${tc[0, 1]} MESSAGE level=FAIL message=Variable '\${non_existing_var}' not found.
+ Check Body Item Data ${tc[1]} KEYWORD status=NOT RUN children=0 name=Log args=Last Keyword
+
+Invalid data is not reported after failures
+ ${tc} Check Test Case ${TESTNAME}
+ Length Should Be ${tc.body} 4
+ Check Body Item Data ${tc[0]} KEYWORD status=FAIL children=1 name=Fail args=Something bad happened! message=Something bad happened!
+ Check Body Item Data ${tc[1]} GROUP status=NOT RUN children=1 name=\${non_existing_non_executed_variable_is_ok}
+ Check Body Item Data ${tc[1, 0]} KEYWORD status=NOT RUN children=0 name=Fail args=Not run
+ Check Body Item Data ${tc[2]} GROUP status=NOT RUN children=0 name=Empty non-executed GROUP is ok
+ Check Body Item Data ${tc[3]} GROUP status=NOT RUN children=1 name=Even missing END is ok
+ Check Body Item Data ${tc[3, 0]} KEYWORD status=NOT RUN children=0 name=Fail args=Not run
diff --git a/atest/robot/running/group/nesting_group.robot b/atest/robot/running/group/nesting_group.robot
new file mode 100644
index 00000000000..1d612e0c189
--- /dev/null
+++ b/atest/robot/running/group/nesting_group.robot
@@ -0,0 +1,51 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/group/nesting_group.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Nested
+ ${tc} Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP name=
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD name=Set Variable
+ Check Body Item Data ${tc[0, 1]} type=GROUP name=This Is A Named Group
+ Check Body Item Data ${tc[0, 1, 0]} type=KEYWORD name=Should Be Equal
+
+With other control structures
+ ${tc} Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=IF/ELSE ROOT
+ Check Body Item Data ${tc[0, 0]} type=IF condition=True children=2
+ Check Body Item Data ${tc[0, 0, 0]} type=GROUP name=Hello children=1
+ Check Body Item Data ${tc[0, 0, 0, 0]} type=VAR name=\${i}
+ Check Body Item Data ${tc[0, 0, 1]} type=GROUP name=With WHILE children=2
+ Check Body Item Data ${tc[0, 0, 1, 0]} type=WHILE condition=$i < 2 children=2
+ Check Body Item Data ${tc[0, 0, 1, 0, 0]} type=ITERATION
+ Check Body Item Data ${tc[0, 0, 1, 0, 0, 0]} type=GROUP name=Group1 Inside WHILE (0) children=1
+ Check Body Item Data ${tc[0, 0, 1, 0, 0, 0, 0]} type=KEYWORD name=Log args=\${i}
+ Check Body Item Data ${tc[0, 0, 1, 0, 0, 1]} type=GROUP name=Group2 Inside WHILE children=1
+ Check Body Item Data ${tc[0, 0, 1, 0, 0, 1, 0]} type=VAR name=\${i} value=\${i + 1}
+ Check Body Item Data ${tc[0, 0, 1, 0, 1]} type=ITERATION
+ Check Body Item Data ${tc[0, 0, 1, 0, 1, 0]} type=GROUP name=Group1 Inside WHILE (1) children=1
+ Check Body Item Data ${tc[0, 0, 1, 0, 1, 0, 0]} type=KEYWORD name=Log args=\${i}
+ Check Body Item Data ${tc[0, 0, 1, 0, 1, 1]} type=GROUP name=Group2 Inside WHILE children=1
+ Check Body Item Data ${tc[0, 0, 1, 0, 1, 1, 0]} type=VAR name=\${i} value=\${i + 1}
+ Check Body Item Data ${tc[0, 0, 1, 1]} type=IF/ELSE ROOT
+ Check Body Item Data ${tc[0, 0, 1, 1, 0]} type=IF status=NOT RUN condition=$i != 2 children=1
+ Check Body Item Data ${tc[0, 0, 1, 1, 0, 0]} type=KEYWORD status=NOT RUN name=Fail args=Shall be logged but NOT RUN
+
+In non-executed branch
+ ${tc} Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=VAR name=\${var} value=value
+ Check Body Item Data ${tc[1]} type=IF/ELSE ROOT
+ Check Body Item Data ${tc[1, 0]} type=IF condition=True children=1
+ Check Body Item Data ${tc[1, 0, 0]} type=GROUP name=GROUP in IF children=2
+ Check Body Item Data ${tc[1, 0, 0, 0]} type=KEYWORD name=Should Be Equal
+ Check Body Item Data ${tc[1, 0, 0, 1]} type=IF/ELSE ROOT
+ Check Body Item Data ${tc[1, 0, 0, 1, 0]} type=IF status=PASS children=1 condition=True
+ Check Body Item Data ${tc[1, 0, 0, 1, 0, 0]} type=KEYWORD status=PASS name=Log args=IF in GROUP
+ Check Body Item Data ${tc[1, 0, 0, 1, 1]} type=ELSE status=NOT RUN
+ Check Body Item Data ${tc[1, 0, 0, 1, 1, 0]} type=GROUP status=NOT RUN children=1 name=GROUP in ELSE
+ Check Body Item Data ${tc[1, 0, 0, 1, 1, 0, 0]} type=KEYWORD status=NOT RUN name=Fail args=Shall be logged but NOT RUN
+ Check Body Item Data ${tc[1, 1]} type=ELSE IF status=NOT RUN
+ Check Body Item Data ${tc[1, 1, 0]} type=GROUP status=NOT RUN children=1 name=\${non_existing_variable_is_fine_here}
+ Check Body Item Data ${tc[1, 2]} type=ELSE status=NOT RUN
+ Check Body Item Data ${tc[1, 2, 0]} type=GROUP status=NOT RUN children=0 name=Even empty GROUP is allowed
diff --git a/atest/robot/running/group/templates.robot b/atest/robot/running/group/templates.robot
new file mode 100644
index 00000000000..b42966b2524
--- /dev/null
+++ b/atest/robot/running/group/templates.robot
@@ -0,0 +1,69 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/group/templates.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Pass
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=PASS children=1 name=1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 1.1
+ Check Body Item Data ${tc[1]} type=GROUP status=PASS children=2 name=2
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 2.1
+ Check Body Item Data ${tc[1, 1]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 2.2
+
+Pass and fail
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=PASS children=1 name=1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 1.1
+ Check Body Item Data ${tc[1]} type=GROUP status=FAIL children=2 name=2 message=2.1
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 2.1 message=2.1
+ Check Body Item Data ${tc[1, 1]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 2.2
+ Check Body Item Data ${tc[2]} type=GROUP status=PASS children=1 name=3
+ Check Body Item Data ${tc[2, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 3.1
+
+Fail multiple times
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=FAIL children=1 name=1 message=1.1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 1.1 message=1.1
+ Check Body Item Data ${tc[1]} type=GROUP status=FAIL children=3 name=2 message=Several failures occurred:\n\n1) 2.1\n\n2) 2.3
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 2.1 message=2.1
+ Check Body Item Data ${tc[1, 1]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 2.2
+ Check Body Item Data ${tc[1, 2]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 2.3 message=2.3
+ Check Body Item Data ${tc[2]} type=GROUP status=PASS children=1 name=3
+ Check Body Item Data ${tc[2, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 3.1
+ Check Body Item Data ${tc[3]} type=GROUP status=FAIL children=1 name=4 message=4.1
+ Check Body Item Data ${tc[3, 0]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 4.1 message=4.1
+
+Pass and skip
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=SKIP children=1 name=1 message=1.1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 1.1 message=1.1
+ Check Body Item Data ${tc[1]} type=GROUP status=PASS children=1 name=2
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 2.1
+ Check Body Item Data ${tc[2]} type=GROUP status=PASS children=2 name=3
+ Check Body Item Data ${tc[2, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 3.1 message=3.1
+ Check Body Item Data ${tc[2, 1]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 3.2
+
+Pass, fail and skip
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=FAIL children=3 name=1 message=1.1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=FAIL children=1 name=Run Keyword args=Fail, 1.1 message=1.1
+ Check Body Item Data ${tc[0, 1]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 1.2 message=1.2
+ Check Body Item Data ${tc[0, 2]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 1.3
+ Check Body Item Data ${tc[1]} type=GROUP status=SKIP children=1 name=2 message=2.1
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 2.1 message=2.1
+ Check Body Item Data ${tc[2]} type=GROUP status=PASS children=1 name=3
+ Check Body Item Data ${tc[2, 0]} type=KEYWORD status=PASS children=1 name=Run Keyword args=Log, 3.1
+
+Skip all
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=SKIP children=2 name=1 message=All iterations skipped.
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 1.1 message=1.1
+ Check Body Item Data ${tc[0, 1]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 1.2 message=1.2
+ Check Body Item Data ${tc[1]} type=GROUP status=SKIP children=1 name=2 message=2.1
+ Check Body Item Data ${tc[1, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 2.1 message=2.1
+
+Just one that is skipped
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Body Item Data ${tc[0]} type=GROUP status=SKIP children=1 name=1 message=1.1
+ Check Body Item Data ${tc[0, 0]} type=KEYWORD status=SKIP children=1 name=Run Keyword args=Skip, 1.1 message=1.1
diff --git a/atest/robot/running/html_error_message.robot b/atest/robot/running/html_error_message.robot
index 007d5a3cd04..9ff087a0d82 100644
--- a/atest/robot/running/html_error_message.robot
+++ b/atest/robot/running/html_error_message.robot
@@ -9,15 +9,15 @@ ${FAILURE} Robot Framework
*** Test Cases ***
Set Test Message
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\n${MESSAGE} html=True
+ Check Log Message ${tc[0, 0]} Set test message to:\n${MESSAGE} html=True
HTML failure
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} ${FAILURE} FAIL html=True
+ Check Log Message ${tc[0, 0]} ${FAILURE} FAIL html=True
HTML failure with non-generic exception
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} ValueError: Invalid value FAIL html=True
+ Check Log Message ${tc[0, 0]} ValueError: Invalid value FAIL html=True
HTML failure in setup
Check Test Case ${TESTNAME}
@@ -30,8 +30,8 @@ Normal failure in body and HTML failure in teardown
HTML failure in body and normal failure teardown
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Should be HTML FAIL html=True
- Check Log Message ${tc.teardown.msgs[0]} Should NOT be HTML FAIL html=False
+ Check Log Message ${tc[0, 0]} Should be HTML FAIL html=True
+ Check Log Message ${tc.teardown[0]} Should NOT be HTML FAIL html=False
HTML failure in body and in teardown
Check Test Case ${TESTNAME}
diff --git a/atest/robot/running/if/complex_if.robot b/atest/robot/running/if/complex_if.robot
index 49afc29aaca..1e4662b1f12 100644
--- a/atest/robot/running/if/complex_if.robot
+++ b/atest/robot/running/if/complex_if.robot
@@ -14,7 +14,7 @@ If inside for loop
Setting after if
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.msgs[0]} Teardown was found and executed.
+ Check Log Message ${tc.teardown[0]} Teardown was found and executed.
For loop inside if
Check Test Case ${TESTNAME}
@@ -24,23 +24,23 @@ For loop inside for loop
Direct Boolean condition
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].body[0].status} PASS
+ Should Be Equal ${tc[0].status} PASS
+ Should Be Equal ${tc[0, 0].status} PASS
+ Should Be Equal ${tc[0, 0, 0].status} PASS
Direct Boolean condition false
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].status} NOT RUN
- Should Be Equal ${tc.body[0].body[0].body[0].status} NOT RUN
+ Should Be Equal ${tc[0].status} PASS
+ Should Be Equal ${tc[0, 0].status} NOT RUN
+ Should Be Equal ${tc[0, 0, 0].status} NOT RUN
Nesting insanity
Check Test Case ${TESTNAME}
Recursive If
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].kws[0].status} PASS
- Should Be Equal ${tc.kws[0].kws[0].kws[0].kws[0].status} PASS
+ Should Be Equal ${tc[0, 0].status} PASS
+ Should Be Equal ${tc[0, 0, 0, 0].status} PASS
If creating variable
Check Test Case ${TESTNAME}
diff --git a/atest/robot/running/if/if_else.robot b/atest/robot/running/if/if_else.robot
index e4b489659bf..6331aeb4dfc 100644
--- a/atest/robot/running/if/if_else.robot
+++ b/atest/robot/running/if/if_else.robot
@@ -38,3 +38,10 @@ If failing in keyword
If failing in else keyword
Check Test Case ${TESTNAME}
+
+Expression evaluation time is included in elapsed time
+ ${tc} = Check Test Case ${TESTNAME}
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.2
+ Elapsed Time Should Be Valid ${tc[0, 0].elapsed_time} minimum=0.1
+ Elapsed Time Should Be Valid ${tc[0, 1].elapsed_time} minimum=0.1
+ Elapsed Time Should Be Valid ${tc[0, 2].elapsed_time} maximum=1.0
diff --git a/atest/robot/running/if/inline_if_else.robot b/atest/robot/running/if/inline_if_else.robot
index 216fb0124a6..d3a5a346db5 100644
--- a/atest/robot/running/if/inline_if_else.robot
+++ b/atest/robot/running/if/inline_if_else.robot
@@ -22,10 +22,10 @@ Not executed after failure
Not executed after failure with assignment
[Template] NONE
${tc} = Check Test Case ${TEST NAME}
- Check IF/ELSE Status NOT RUN NOT RUN root=${tc.body[1]} run=False
- Check IF/ELSE Status NOT RUN NOT RUN root=${tc.body[2]} run=False
- Check Keyword Data ${tc.body[1].body[0].body[0]} Not run assign=\${x} status=NOT RUN
- Check Keyword Data ${tc.body[2].body[0].body[0]} Not run assign=\${x}, \@{y} status=NOT RUN
+ Check IF/ELSE Status NOT RUN NOT RUN root=${tc[1]} run=False
+ Check IF/ELSE Status NOT RUN NOT RUN root=${tc[2]} run=False
+ Check Keyword Data ${tc[1, 0, 0]} Not run assign=\${x} status=NOT RUN
+ Check Keyword Data ${tc[2, 0, 0]} Not run assign=\${x}, \@{y} status=NOT RUN
ELSE IF not executed
NOT RUN NOT RUN PASS index=0
@@ -48,6 +48,11 @@ Assign
NOT RUN PASS NOT RUN index=1
NOT RUN NOT RUN PASS index=2
+Assign with item
+ PASS NOT RUN NOT RUN index=0
+ NOT RUN PASS NOT RUN index=1
+ NOT RUN NOT RUN PASS index=2
+
Multi assign
PASS NOT RUN index=0
FAIL NOT RUN index=4
@@ -59,6 +64,9 @@ List assign
Dict assign
NOT RUN PASS
+Assign based on another variable
+ PASS NOT RUN index=1
+
Assign without ELSE
PASS NOT RUN index=0
NOT RUN PASS NOT RUN index=2
@@ -71,20 +79,20 @@ Assign when no branch is run
Inside FOR
[Template] NONE
${tc} = Check Test Case ${TEST NAME}
- Check IF/ELSE Status NOT RUN PASS root=${tc.body[0].body[0].body[0]}
- Check IF/ELSE Status NOT RUN PASS root=${tc.body[0].body[1].body[0]}
- Check IF/ELSE Status FAIL NOT RUN root=${tc.body[0].body[2].body[0]}
+ Check IF/ELSE Status NOT RUN PASS root=${tc[0, 0, 0]}
+ Check IF/ELSE Status NOT RUN PASS root=${tc[0, 1, 0]}
+ Check IF/ELSE Status FAIL NOT RUN root=${tc[0, 2, 0]}
Inside normal IF
[Template] NONE
${tc} = Check Test Case ${TEST NAME}
- Check IF/ELSE Status NOT RUN PASS root=${tc.body[0].body[0].body[1]}
- Check IF/ELSE Status NOT RUN NOT RUN root=${tc.body[0].body[1].body[0]} run=False
+ Check IF/ELSE Status NOT RUN PASS root=${tc[0, 0, 1]}
+ Check IF/ELSE Status NOT RUN NOT RUN root=${tc[0, 1, 0]} run=False
In keyword
[Template] NONE
${tc} = Check Test Case ${TEST NAME}
- Check IF/ELSE Status PASS NOT RUN root=${tc.body[0].body[0]}
- Check IF/ELSE Status NOT RUN PASS NOT RUN root=${tc.body[0].body[1]}
+ Check IF/ELSE Status PASS NOT RUN root=${tc[0, 0]}
+ Check IF/ELSE Status NOT RUN PASS NOT RUN root=${tc[0, 1]}
Check IF/ELSE Status NOT RUN NOT RUN NOT RUN FAIL
- ... NOT RUN NOT RUN NOT RUN root=${tc.body[0].body[2]}
+ ... NOT RUN NOT RUN NOT RUN root=${tc[0, 2]}
diff --git a/atest/robot/running/if/invalid_if.robot b/atest/robot/running/if/invalid_if.robot
index a720be8347d..714a7b4eb80 100644
--- a/atest/robot/running/if/invalid_if.robot
+++ b/atest/robot/running/if/invalid_if.robot
@@ -16,12 +16,24 @@ IF with invalid condition
IF with invalid condition with ELSE
FAIL NOT RUN
-IF condition with non-existing variable
+IF condition with non-existing ${variable}
+ FAIL NOT RUN
+
+IF condition with non-existing $variable
FAIL NOT RUN
ELSE IF with invalid condition
NOT RUN NOT RUN FAIL NOT RUN NOT RUN
+Recommend $var syntax if invalid condition contains ${var}
+ FAIL index=1
+
+$var recommendation with multiple variables
+ FAIL index=1
+
+Remove quotes around variable in $var recommendation
+ FAIL index=2
+
IF without END
FAIL
@@ -38,7 +50,7 @@ ELSE IF without condition
ELSE IF with multiple conditions
[Template] NONE
${tc} = Branch statuses should be FAIL NOT RUN NOT RUN
- Should Be Equal ${tc.body[0].body[1].condition} \${False}, ooops, \${True}
+ Should Be Equal ${tc[0, 1].condition} \${False}, ooops, \${True}
ELSE with condition
FAIL NOT RUN
@@ -58,19 +70,59 @@ ELSE after ELSE
ELSE IF after ELSE
FAIL NOT RUN NOT RUN
+Dangling ELSE
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE inside FOR
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE inside WHILE
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE IF
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE IF inside FOR
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE IF inside WHILE
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Dangling ELSE IF inside TRY
+ [Template] Check Test Case
+ ${TEST NAME}
+
Invalid IF inside FOR
FAIL
Multiple errors
FAIL NOT RUN NOT RUN NOT RUN NOT RUN
+Invalid data causes syntax error
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Invalid condition causes normal error
+ [Template] Check Test Case
+ ${TEST NAME}
+
+Non-existing variable in condition causes normal error
+ [Template] Check Test Case
+ ${TEST NAME}
+
*** Keywords ***
Branch statuses should be
- [Arguments] @{statuses}
+ [Arguments] @{statuses} ${index}=0
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].status} FAIL
- FOR ${branch} ${status} IN ZIP ${tc.body[0].body} ${statuses}
+ ${if} = Set Variable ${tc.body}[${index}]
+ Should Be Equal ${if.status} FAIL
+ FOR ${branch} ${status} IN ZIP ${if.body} ${statuses} mode=STRICT
Should Be Equal ${branch.status} ${status}
END
- Should Be Equal ${{len($tc.body[0].body)}} ${{len($statuses)}}
RETURN ${tc}
diff --git a/atest/robot/running/if/invalid_inline_if.robot b/atest/robot/running/if/invalid_inline_if.robot
index 4609f4f9d88..5a7ba2c0ac0 100644
--- a/atest/robot/running/if/invalid_inline_if.robot
+++ b/atest/robot/running/if/invalid_inline_if.robot
@@ -65,10 +65,11 @@ Unnecessary END
Invalid END after inline header
[Template] NONE
${tc} = Check Test Case ${TEST NAME}
- Check IF/ELSE Status PASS root=${tc.body[0]}
- Check Log Message ${tc.body[0].body[0].body[0].body[0]} Executed inside inline IF
- Check Log Message ${tc.body[1].body[0]} Executed outside IF
- Check Keyword Data ${tc.body[2]} Reserved.End status=FAIL
+ Check IF/ELSE Status PASS root=${tc[0]}
+ Check Log Message ${tc[0, 0, 0, 0]} Executed inside inline IF
+ Check Log Message ${tc[1, 0]} Executed outside IF
+ Should Be Equal ${tc[2].type} ERROR
+ Should Be Equal ${tc[2].status} FAIL
Assign in IF branch
FAIL
@@ -103,7 +104,12 @@ Assign when ELSE IF branch is empty
Assign when ELSE branch is empty
FAIL NOT RUN
-Assign with RETURN
+Control structures are allowed
[Template] NONE
${tc} = Check Test Case ${TESTNAME}
- Check IF/ELSE Status FAIL NOT RUN root=${tc.body[0].body[0]}
+ Check IF/ELSE Status NOT RUN PASS root=${tc[0, 0]}
+
+Control structures are not allowed with assignment
+ [Template] NONE
+ ${tc} = Check Test Case ${TESTNAME}
+ Check IF/ELSE Status FAIL NOT RUN root=${tc[0, 0]}
diff --git a/atest/robot/running/invalid_break_and_continue.robot b/atest/robot/running/invalid_break_and_continue.robot
index 6aeafe8493d..6730a116b6a 100644
--- a/atest/robot/running/invalid_break_and_continue.robot
+++ b/atest/robot/running/invalid_break_and_continue.robot
@@ -26,11 +26,11 @@ CONTINUE in TRY-ELSE
CONTINUE with argument in FOR
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.body[0].body[0].body[1].body[0]} CONTINUE does not accept arguments, got 'should not work'. FAIL
+ Check Log Message ${tc[0, 0, 1, 0]} CONTINUE does not accept arguments, got 'should not work'. FAIL
CONTINUE with argument in WHILE
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.body[0].body[0].body[1].body[0]} CONTINUE does not accept arguments, got 'should', 'not' and 'work'. FAIL
+ Check Log Message ${tc[0, 0, 1, 0]} CONTINUE does not accept arguments, got 'should', 'not' and 'work'. FAIL
BREAK in test case
Check Test Case ${TESTNAME}
@@ -55,8 +55,8 @@ BREAK in TRY-ELSE
BREAK with argument in FOR
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.body[0].body[0].body[1].body[0]} BREAK does not accept arguments, got 'should not work'. FAIL
+ Check Log Message ${tc[0, 0, 1, 0]} BREAK does not accept arguments, got 'should not work'. FAIL
BREAK with argument in WHILE
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.body[0].body[0].body[1].body[0]} BREAK does not accept arguments, got 'should', 'not' and 'work'. FAIL
+ Check Log Message ${tc[0, 0, 1, 0]} BREAK does not accept arguments, got 'should', 'not' and 'work'. FAIL
diff --git a/atest/robot/running/long_error_messages.robot b/atest/robot/running/long_error_messages.robot
index 3f1187be2f2..abef7c57b16 100644
--- a/atest/robot/running/long_error_messages.robot
+++ b/atest/robot/running/long_error_messages.robot
@@ -42,21 +42,21 @@ Has Been Cut
Should Contain ${test.message} ${EXPLANATION}
Should Match Non Empty Regexp ${test.message} ${eol_dots}
Should Match Non Empty Regexp ${test.message} ${bol_dots}
- Error Message In Log Should Not Have Been Cut ${test.kws}
- [Return] ${test}
+ Error Message In Log Should Not Have Been Cut ${test}
+ RETURN ${test}
Error Message In Log Should Not Have Been Cut
- [Arguments] ${kws}
- @{keywords} = Set Variable ${kws}
- FOR ${kw} IN @{keywords}
- Run Keyword If ${kw.msgs}
- ... Should Not Contain ${kw.msgs[-1].message} ${EXPLANATION}
- Error Message In Log Should Not Have Been Cut ${kw.kws}
+ [Arguments] ${item}
+ FOR ${child} IN @{item.non_messages}
+ FOR ${msg} IN @{child.messages}
+ Should Not Contain ${msg.message} ${EXPLANATION}
+ END
+ Error Message In Log Should Not Have Been Cut ${child}
END
Should Match Non Empty Regexp
[Arguments] ${message} ${pattern}
- Run Keyword If $pattern
+ IF $pattern
... Should Match Regexp ${message} ${pattern}
Has Not Been Cut
diff --git a/atest/robot/running/non_ascii_bytes.robot b/atest/robot/running/non_ascii_bytes.robot
index 18b726cd5c2..b84792d1a6e 100644
--- a/atest/robot/running/non_ascii_bytes.robot
+++ b/atest/robot/running/non_ascii_bytes.robot
@@ -8,26 +8,26 @@ Variables ${DATADIR}/running/expbytevalues.py
*** Test Cases ***
In Message
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} ${exp_log_msg}
+ Check Log Message ${tc[0, 0]} ${exp_log_msg}
In Multiline Message
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} ${exp_log_multiline_msg}
+ Check Log Message ${tc[0, 0]} ${exp_log_multiline_msg}
In Return Value
[Documentation] Return value is not altered by the framework and thus it
... contains the exact same bytes that the keyword returned.
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} \${retval} = ${exp_return_msg}
+ Check Log Message ${tc[0, 0]} \${retval} = ${exp_return_msg}
In Exception
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} ${exp_error_msg} FAIL
+ Check Log Message ${tc[0, 0]} ${exp_error_msg} FAIL
In Exception In Setup
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.setup.msgs[0]} ${exp_error_msg} FAIL
+ Check Log Message ${tc.setup[0]} ${exp_error_msg} FAIL
In Exception In Teardown
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.msgs[0]} ${exp_error_msg} FAIL
+ Check Log Message ${tc.teardown[0]} ${exp_error_msg} FAIL
diff --git a/atest/robot/running/pass_execution.robot b/atest/robot/running/pass_execution.robot
index 2fa03944982..4bea02d7167 100644
--- a/atest/robot/running/pass_execution.robot
+++ b/atest/robot/running/pass_execution.robot
@@ -1,9 +1,9 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} running/pass_execution.robot
-Resource atest_resource.robot
+Suite Setup Run Tests ${EMPTY} running/pass_execution.robot
+Resource atest_resource.robot
*** Variables ***
-${PREFIX}= Execution passed with message:\n
+${PREFIX}= Execution passed with message:\n
*** Test Cases ***
Message is required
@@ -11,11 +11,11 @@ Message is required
With message
${tc}= Check Test Tags ${TESTNAME} force1 force2
- Check Log Message ${tc.kws[0].msgs[0]} ${PREFIX}My message
+ Check Log Message ${tc[0, 0]} ${PREFIX}My message
With HTML message
${tc}= Check Test Tags ${TESTNAME} force1 force2
- Check Log Message ${tc.kws[0].msgs[0]} ${PREFIX}Message HTML
+ Check Log Message ${tc[0, 0]} ${PREFIX}Message HTML
Empty message is not allowed
Check Test Case ${TESTNAME}
@@ -40,17 +40,17 @@ Used in template keyword
Used in for loop
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} ${PREFIX}Message with 'foo'
+ Check Log Message ${tc[0, 0, 0, 0]} ${PREFIX}Message with 'foo'
Used in setup
${tc} = Check Test Case ${TESTNAME}
- Keyword Should Have Been Executed ${tc.kws[0]}
+ Keyword Should Have Been Executed ${tc[0]}
Keyword Should Have Been Executed ${tc.teardown}
Used in teardown
${tc}= Check Test Case ${TESTNAME}
Should Be Equal ${tc.teardown.status} PASS
- Check Log Message ${tc.teardown.kws[0].msgs[0]} ${PREFIX}This message is used.
+ Check Log Message ${tc.teardown[0, 0]} ${PREFIX}This message is used.
Before failing teardown
Check Test Case ${TESTNAME}
@@ -60,14 +60,14 @@ After continuable failure
After continuable failure in user keyword
${tc}= Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].status} FAIL
+ Should Be Equal ${tc[0].status} FAIL
After continuable failure in FOR loop
${tc}= Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].status} FAIL
- Should Be Equal ${tc.kws[0].kws[0].status} FAIL
- Should Be Equal ${tc.kws[0].kws[0].kws[0].status} FAIL
- Should Be Equal ${tc.kws[0].kws[0].kws[1].status} PASS
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0, 0].status} FAIL
+ Should Be Equal ${tc[0, 0, 0].status} FAIL
+ Should Be Equal ${tc[0, 0, 1].status} PASS
After continuable failure and before failing teardown
Check Test Case ${TESTNAME}
@@ -86,57 +86,57 @@ After continuable failure in keyword teardown
Remove one tag
${tc}= Check Test Tags ${TESTNAME} force2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force1'.
- Check Log Message ${tc.kws[0].msgs[1]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Removed tag 'force1'.
+ Check Log Message ${tc[0, 1]} ${PREFIX}Message
Remove multiple tags
${tc}= Check Test Tags ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Removed tags 'force1' and 'force2'.
- Check Log Message ${tc.kws[0].msgs[1]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Removed tags 'force1' and 'force2'.
+ Check Log Message ${tc[0, 1]} ${PREFIX}Message
Remove tags with pattern
${tc}= Check Test Tags ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force?'.
- Check Log Message ${tc.kws[0].msgs[1]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Removed tag 'force?'.
+ Check Log Message ${tc[0, 1]} ${PREFIX}Message
Set one tag
${tc}= Check Test Tags ${TESTNAME} force1 force2 tag
- Check Log Message ${tc.kws[0].msgs[0]} Set tag 'tag'.
- Check Log Message ${tc.kws[0].msgs[1]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Set tag 'tag'.
+ Check Log Message ${tc[0, 1]} ${PREFIX}Message
Set multiple tags
${tc}= Check Test Tags ${TESTNAME} force1 force2 tag1 tag2
- Check Log Message ${tc.kws[0].msgs[0]} Set tags 'tag1' and 'tag2'.
- Check Log Message ${tc.kws[0].msgs[1]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Set tags 'tag1' and 'tag2'.
+ Check Log Message ${tc[0, 1]} ${PREFIX}Message
Set and remove tags
${tc}= Check Test Tags ${TESTNAME} tag1 tag2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force?'.
- Check Log Message ${tc.kws[0].msgs[1]} Set tags 'tag1' and 'tag2'.
- Check Log Message ${tc.kws[0].msgs[2]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Removed tag 'force?'.
+ Check Log Message ${tc[0, 1]} Set tags 'tag1' and 'tag2'.
+ Check Log Message ${tc[0, 2]} ${PREFIX}Message
Set tags are not removed
${tc}= Check Test Tags ${TESTNAME} force1 force2 tag1 tag2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'tag?'.
- Check Log Message ${tc.kws[0].msgs[1]} Set tags 'tag1' and 'tag2'.
- Check Log Message ${tc.kws[0].msgs[2]} ${PREFIX}Message
+ Check Log Message ${tc[0, 0]} Removed tag 'tag?'.
+ Check Log Message ${tc[0, 1]} Set tags 'tag1' and 'tag2'.
+ Check Log Message ${tc[0, 2]} ${PREFIX}Message
Set tags in teardown
${tc}= Check Test Tags ${TESTNAME} tag1 tag2
- Check Log Message ${tc.teardown.msgs[0]} Removed tag 'force?'.
- Check Log Message ${tc.teardown.msgs[1]} Set tags 'tag1' and 'tag2'.
- Check Log Message ${tc.teardown.msgs[2]} ${PREFIX}Message
+ Check Log Message ${tc.teardown[0]} Removed tag 'force?'.
+ Check Log Message ${tc.teardown[1]} Set tags 'tag1' and 'tag2'.
+ Check Log Message ${tc.teardown[2]} ${PREFIX}Message
Pass Execution If when condition is true
Check Test Case ${TESTNAME}
Pass Execution If when condition is false
${tc} = Check Test Case ${TESTNAME}
- Keyword Should Have Been Executed ${tc.kws[1]}
+ Keyword Should Have Been Executed ${tc[1]}
Pass Execution If resolves variables only condition is true
${tc} = Check Test Case ${TESTNAME}
- Keyword Should Have Been Executed ${tc.kws[1]}
+ Keyword Should Have Been Executed ${tc[1]}
Pass Execution If with multiple variables
Check Test Tags ${TESTNAME} force1 force2 my tags
diff --git a/atest/robot/running/prevent_recursion.robot b/atest/robot/running/prevent_recursion.robot
deleted file mode 100644
index 8641c4e476d..00000000000
--- a/atest/robot/running/prevent_recursion.robot
+++ /dev/null
@@ -1,21 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests ${EMPTY} running/prevent_recursion.robot
-Resource atest_resource.robot
-
-*** Test Cases ***
-Infinite recursion
- Check Test Case ${TESTNAME}
-
-Infinite cyclic recursion
- Check Test Case ${TESTNAME}
-
-Infinite recursion with Run Keyword
- Check Test Case ${TESTNAME}
-
-Infinitely recursive for loop
- Check Test Case ${TESTNAME}
-
-Recursion below the recursion limit is ok
- [Documentation] Also verifies that recursion limit blown earlier doesn't affect subsequent tests
- Check Test Case ${TESTNAME}
-
diff --git a/atest/robot/running/return.robot b/atest/robot/running/return.robot
index 6937411cab8..a94de10b833 100644
--- a/atest/robot/running/return.robot
+++ b/atest/robot/running/return.robot
@@ -5,42 +5,51 @@ Resource atest_resource.robot
*** Test Cases ***
Simple
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].body[1].type} RETURN
- Should Be Equal ${tc.body[0].body[1].status} PASS
- Should Be Equal ${tc.body[0].body[2].status} NOT RUN
+ Should Be Equal ${tc[0, 1].type} RETURN
+ Should Be Equal ${tc[0, 1].values} ${{()}}
+ Should Be Equal ${tc[0, 1].status} PASS
+ Should Be Equal ${tc[0, 1].message} ${EMPTY}
+ Should Be Equal ${tc[0, 2].status} NOT RUN
+ Should Be Equal ${tc[0].message} ${EMPTY}
Return value
- Check Test Case ${TESTNAME}
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc[0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0].values} ${{('value',)}}
Return value as variable
- Check Test Case ${TESTNAME}
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc[0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0].values} ${{('\${42}',)}}
Return multiple values
- Check Test Case ${TESTNAME}
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc[0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0].values} ${{('first', '\${2}', 'third')}}
In nested keyword
Check Test Case ${TESTNAME}
In IF
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].body[0].body[0].body[0].type} RETURN
- Should Be Equal ${tc.body[0].body[0].body[0].body[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].body[0].body[1].status} NOT RUN
- Should Be Equal ${tc.body[0].body[1].status} NOT RUN
- Should Be Equal ${tc.body[2].body[0].body[1].body[0].type} RETURN
- Should Be Equal ${tc.body[2].body[0].body[1].body[0].status} PASS
- Should Be Equal ${tc.body[2].body[0].body[1].body[1].status} NOT RUN
- Should Be Equal ${tc.body[2].body[1].status} NOT RUN
+ Should Be Equal ${tc[0, 0, 0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0, 0, 0].status} PASS
+ Should Be Equal ${tc[0, 0, 0, 1].status} NOT RUN
+ Should Be Equal ${tc[0, 1].status} NOT RUN
+ Should Be Equal ${tc[2, 0, 1, 0].type} RETURN
+ Should Be Equal ${tc[2, 0, 1, 0].status} PASS
+ Should Be Equal ${tc[2, 0, 1, 1].status} NOT RUN
+ Should Be Equal ${tc[2, 1].status} NOT RUN
In inline IF
Check Test Case ${TESTNAME}
In FOR
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].body[0].body[0].body[0].type} RETURN
- Should Be Equal ${tc.body[0].body[0].body[0].body[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].body[0].body[1].status} NOT RUN
- Should Be Equal ${tc.body[0].body[1].status} NOT RUN
+ Should Be Equal ${tc[0, 0, 0, 0].type} RETURN
+ Should Be Equal ${tc[0, 0, 0, 0].status} PASS
+ Should Be Equal ${tc[0, 0, 0, 1].status} NOT RUN
+ Should Be Equal ${tc[0, 1].status} NOT RUN
In nested FOR/IF structure
Check Test Case ${TESTNAME}
diff --git a/atest/robot/running/return_from_keyword.robot b/atest/robot/running/return_from_keyword.robot
index 4c9c2fa72b6..34b905cfa3c 100644
--- a/atest/robot/running/return_from_keyword.robot
+++ b/atest/robot/running/return_from_keyword.robot
@@ -56,5 +56,5 @@ Return From Keyword If does not evaluate bogus arguments if condition is untrue
Logs Info
${tc} = Check Test Case Without Return Value
- Check Log Message ${tc.kws[0].kws[0].msgs[0]}
+ Check Log Message ${tc[0, 0, 0]}
... Returning from the enclosing user keyword.
diff --git a/atest/robot/running/setup_and_teardown_using_embedded_arguments.robot b/atest/robot/running/setup_and_teardown_using_embedded_arguments.robot
new file mode 100644
index 00000000000..04fa1b5d44e
--- /dev/null
+++ b/atest/robot/running/setup_and_teardown_using_embedded_arguments.robot
@@ -0,0 +1,46 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/setup_and_teardown_using_embedded_arguments.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Suite setup and teardown
+ Should Be Equal ${SUITE.setup.name} Embedded "arg"
+ Should Be Equal ${SUITE.teardown.name} Object \${LIST}
+
+Test setup and teardown
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc.setup.name} Embedded "arg"
+ Should Be Equal ${tc.teardown.name} Embedded "arg"
+
+Keyword setup and teardown
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc[0].setup.name} Embedded "arg"
+ Should Be Equal ${tc[0].teardown.name} Embedded "arg"
+
+Argument as variable
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc.setup.name} Embedded "\${ARG}"
+ Should Be Equal ${tc[0].setup.name} Embedded "\${ARG}"
+ Should Be Equal ${tc[0].teardown.name} Embedded "\${ARG}"
+ Should Be Equal ${tc.teardown.name} Embedded "\${ARG}"
+
+Argument as non-string variable
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc.setup.name} Object \${LIST}
+ Should Be Equal ${tc[0].setup.name} Object \${LIST}
+ Should Be Equal ${tc[0].teardown.name} Object \${LIST}
+ Should Be Equal ${tc.teardown.name} Object \${LIST}
+
+Argument matching only after replacing variables
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc.setup.name} Embedded "arg"
+ Should Be Equal ${tc[0].setup.name} Embedded "arg"
+ Should Be Equal ${tc[0].teardown.name} Embedded "arg"
+ Should Be Equal ${tc.teardown.name} Embedded "arg"
+
+Exact match after replacing variables has higher precedence
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc.setup.name} Embedded not, exact match instead
+ Should Be Equal ${tc[0].setup.name} Embedded not, exact match instead
+ Should Be Equal ${tc[0].teardown.name} Embedded not, exact match instead
+ Should Be Equal ${tc.teardown.name} Embedded not, exact match instead
diff --git a/atest/robot/running/skip.robot b/atest/robot/running/skip.robot
index e6f8726acf1..1af592e235f 100644
--- a/atest/robot/running/skip.robot
+++ b/atest/robot/running/skip.robot
@@ -44,7 +44,7 @@ Skip in Teardown After Failure In Body
Teardown is executed after skip
${tc} = Check Test Case ${TEST NAME}
- Check log message ${tc.teardown.msgs[0]} Teardown is executed!
+ Check log message ${tc.teardown[0]} Teardown is executed!
Fail in Teardown After Skip In Body
Check Test Case ${TEST NAME}
@@ -91,6 +91,10 @@ Skip In Suite Teardown After Fail In Setup
Skip In Directory Suite Teardown
Check Test Case ${TEST NAME}
+Tests have correct status if suite has nothing to run and directory suite setup uses skip
+ Check Test Case `robot:skip` with skip in directory suite setup
+ Check Test Case `--skip` with skip in directory suite setup
+
Skip with Run Keyword and Ignore Error
Check Test Case ${TEST NAME}
@@ -106,24 +110,58 @@ Skip with Wait Until Keyword Succeeds
Skipped with --skip
Check Test Case ${TEST NAME}
-Skipped when test is tagged with robot:skip
+Skipped with --skip when tag uses variable
+ Check Test Case ${TEST NAME}
+
+Skipped with robot:skip
+ Check Test Case ${TEST NAME}
+
+Skipped with robot:skip when tag uses variable
Check Test Case ${TEST NAME}
Skipped with --SkipOnFailure
Check Test Case ${TEST NAME}
-Skipped with --SkipOnFailure when Failure in Test Setup
+Skipped with --SkipOnFailure when tag uses variable
Check Test Case ${TEST NAME}
-Skipped with --SkipOnFailure when Failure in Test Teardown
+Skipped with --SkipOnFailure when failure in setup
Check Test Case ${TEST NAME}
-Skipped with --SkipOnFailure when Set Tags Used in Teardown
- Check Test Case Skipped with --SkipOnFailure when Set Tags Used in Teardown
+Skipped with --SkipOnFailure when failure in teardown
+ Check Test Case ${TEST NAME}
-Skipped although test fails since test is tagged with robot:skip-on-failure
+Skipped with --SkipOnFailure when Set Tags used in teardown
Check Test Case ${TEST NAME}
-Using Skip Does Not Affect Passing And Failing Tests
- Check Test Case Passing Test
- Check Test Case Failing Test
+Skipped with robot:skip-on-failure
+ Check Test Case ${TEST NAME}
+
+Skipped with robot:skip-on-failure when tag uses variable
+ Check Test Case ${TEST NAME}
+
+Skipping does not affect passing and failing tests
+ Check Test Case Passing
+ Check Test Case Failing
+
+Suite setup and teardown are not run if all tests are unconditionally skipped or excluded
+ ${suite} = Get Test Suite All Skipped
+ Should Be True not ($suite.setup or $suite.teardown)
+ Should Be True not ($suite.suites[0].setup or $suite.suites[0].teardown)
+ Check Test Case Skip using robot:skip
+ Check Test Case Skip using --skip
+ Length Should Be ${suite.suites[0].tests} 2
+
+--skip and --skip-on-failure used multiple times
+ Run Tests --skip skip-this --skip no-match --SkipOnFailure skip-on-failure --skip-on-failure xxx running/skip/skip.robot
+ Check Test Case Skipped with --skip
+ ... message=Test skipped using 'no-match' and 'skip-this' tags.
+ Check Test Case Skipped with --SkipOnFailure
+ ... message=Failed test skipped using 'skip-on-failure' and 'xxx' tags.\n\nOriginal failure:\nOoops, we fail!
+
+--skip and --skip-on-failure with patterns
+ Run Tests --skip skip-t*s --skip no-match --SkipOnFailure xxxORskip-on-failure running/skip/skip.robot
+ Check Test Case Skipped with --skip
+ ... message=Test skipped using 'no-match' and 'skip-t*s' tag patterns.
+ Check Test Case Skipped with --SkipOnFailure
+ ... message=Failed test skipped using 'xxx OR skip-on-failure' tag pattern.\n\nOriginal failure:\nOoops, we fail!
diff --git a/atest/robot/running/skip_in_rpa_mode.robot b/atest/robot/running/skip_in_rpa_mode.robot
index e5370328d05..6da7ef27bfd 100644
--- a/atest/robot/running/skip_in_rpa_mode.robot
+++ b/atest/robot/running/skip_in_rpa_mode.robot
@@ -1,5 +1,5 @@
*** Settings ***
-Suite Setup Run Tests --rpa --skip skip-this --SkipOnFailure skip-on-failure --variable test_or_task:Task running/skip/
+Suite Setup Run Tests --rpa --skip skip-this --SkipOnFailure skip-on-failure --variable test_or_task:task running/skip/
Resource atest_resource.robot
*** Test Cases ***
@@ -8,4 +8,3 @@ Skipped with --skip
Skipped with --SkipOnFailure
Check Test Case ${TEST NAME}
-
diff --git a/atest/robot/running/skip_with_template.robot b/atest/robot/running/skip_with_template.robot
new file mode 100644
index 00000000000..a642c665146
--- /dev/null
+++ b/atest/robot/running/skip_with_template.robot
@@ -0,0 +1,71 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/skip_with_template.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+SKIP + PASS -> PASS
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} SKIP Skipped
+ Status Should Be ${tc[1]} PASS
+
+FAIL + ANY -> FAIL
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} PASS
+ Status Should Be ${tc[1]} SKIP Skipped
+ Status Should Be ${tc[2]} PASS
+ Status Should Be ${tc[3]} FAIL Failed
+ Status Should Be ${tc[4]} SKIP Skipped
+
+Only SKIP -> SKIP
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} SKIP Skipped
+ Status Should Be ${tc[1]} SKIP Skipped
+
+IF w/ SKIP + PASS -> PASS
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} PASS
+ Status Should Be ${tc[1]} SKIP Skipped
+ Status Should Be ${tc[2]} PASS
+
+IF w/ FAIL + ANY -> FAIL
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} FAIL Failed
+ Status Should Be ${tc[1]} SKIP Skipped
+ Status Should Be ${tc[2]} PASS
+
+IF w/ only SKIP -> SKIP
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} SKIP All iterations skipped.
+ Status Should Be ${tc[1]} SKIP Skip 3
+ Status Should Be ${tc[2]} SKIP Skip 4
+
+FOR w/ SKIP + PASS -> PASS
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} PASS
+ Status Should Be ${tc[1]} SKIP just once
+ Status Should Be ${tc[2]} PASS
+
+FOR w/ FAIL + ANY -> FAIL
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} FAIL Several failures occurred:\n\n1) a\n\n2) b
+ Status Should Be ${tc[1]} SKIP just once
+ Status Should Be ${tc[2]} PASS
+
+FOR w/ only SKIP -> SKIP
+ ${tc} = Check Test Case ${TEST NAME}
+ Status Should Be ${tc[0]} SKIP All iterations skipped.
+ Status Should Be ${tc[1]} SKIP just once
+
+Messages in test body are ignored
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0]} Hello 'Messages in test body are ignored', says listener!
+ Check Log Message ${tc[1, 0, 0]} Library listener adds messages to body of this test.
+ Check Log Message ${tc[2, 0, 0]} This iteration is skipped! SKIP
+ Check Log Message ${tc[3, 0, 0]} This iteration passes!
+ Check Log Message ${tc[4]} Bye 'Messages in test body are ignored', says listener!
+
+*** Keywords ***
+Status Should Be
+ [Arguments] ${item} ${status} ${message}=
+ Should Be Equal ${item.status} ${status}
+ Should Be Equal ${item.message} ${message}
diff --git a/atest/robot/running/steps_after_failure.robot b/atest/robot/running/steps_after_failure.robot
index 30a1de2dc96..602f40d3001 100644
--- a/atest/robot/running/steps_after_failure.robot
+++ b/atest/robot/running/steps_after_failure.robot
@@ -5,143 +5,159 @@ Resource atest_resource.robot
*** Test Cases ***
Library keyword after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[2:]} 5
- Check Log Message ${tc.teardown.msgs[0]} This is run
+ Should Not Be Run ${tc[2:]} 5
+ Check Log Message ${tc.teardown[0]} This is run
User keyword after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[1:]}
Non-existing keyword after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[1:]}
Invalid keyword usage after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[1:]}
Assignment after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]} 4
- Check Keyword Data ${tc.body[1]} Not run assign=\${x} status=NOT RUN
- Check Keyword Data ${tc.body[2]} Not run assign=\${x} status=NOT RUN
- Check Keyword Data ${tc.body[3]} Not run assign=\${x}, \${y} status=NOT RUN
- Check Keyword Data ${tc.body[4]} Not run assign=\${x}, \${y} status=NOT RUN
+ Should Not Be Run ${tc[1:]} 4
+ Check Keyword Data ${tc[1]} Not run assign=\${x} status=NOT RUN
+ Check Keyword Data ${tc[2]} Not run assign=\${x} status=NOT RUN
+ Check Keyword Data ${tc[3]} Not run assign=\${x}, \${y} status=NOT RUN
+ Check Keyword Data ${tc[4]} Not run assign=\${x}, \${y} status=NOT RUN
IF after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Should Not Be Run ${tc.body[1].body[0].body}
- Should Not Be Run ${tc.body[1].body[1].body}
- Check Keyword Data ${tc.body[1].body[1].body[0]}
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[1, 0].body}
+ Should Not Be Run ${tc[1, 1].body}
+ Check Keyword Data ${tc[1, 1, 0]}
+ ... BuiltIn.Fail assign=\${x} args=This should not be run status=NOT RUN
+
+GROUP after failure
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[1].body} 2
+ Check Keyword Data ${tc[1, 1]}
... BuiltIn.Fail assign=\${x} args=This should not be run status=NOT RUN
FOR after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Should Not Be Run ${tc.body[1].body}
- Should Not Be Run ${tc.body[1].body[0].body} 2
- Check Keyword Data ${tc.body[1].body[0].body[1]}
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[1].body}
+ Should Not Be Run ${tc[1, 0].body} 2
+ Check Keyword Data ${tc[1, 0, 1]}
... BuiltIn.Fail assign=\${x} args=This should not be run either status=NOT RUN
TRY after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Should Not Be Run ${tc.body[1].body} 4
- FOR ${step} IN @{tc.body[1].body}
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[1].body} 4
+ FOR ${step} IN @{tc[1].body}
Should Not Be Run ${step.body}
END
WHILE after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]} 3
- Should Not Be Run ${tc.body[1].body}
- Should Not Be Run ${tc.body[1].body[0].body} 3
- Should Not Be Run ${tc.body[2].body}
- Should Not Be Run ${tc.body[2].body[0].body} 2
- Should Not Be Run ${tc.body[3].body}
- Should Not Be Run ${tc.body[3].body[0].body} 1
+ Should Not Be Run ${tc[1:]} 3
+ Should Not Be Run ${tc[1].body}
+ Should Not Be Run ${tc[1, 0].body} 3
+ Should Not Be Run ${tc[2].body}
+ Should Not Be Run ${tc[2, 0].body} 2
+ Should Not Be Run ${tc[3].body}
+ Should Not Be Run ${tc[3, 0].body} 1
RETURN after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Should Not Be Run ${tc.body[0].body[1:]} 2
- Should Be Equal ${tc.body[0].body[1].type} RETURN
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[0][1:]} 2
+ Should Be Equal ${tc[0, 1].type} RETURN
BREAK and CONTINUE after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]} 1
- Should Not Be Run ${tc.body[0].body[0].body[1:]} 2
- Should Not Be Run ${tc.body[1].body}
- Should Not Be Run ${tc.body[1].body[0].body} 2
+ Should Not Be Run ${tc[1:]} 1
+ Should Not Be Run ${tc[0, 0][1:]} 2
+ Should Not Be Run ${tc[1].body}
+ Should Not Be Run ${tc[1, 0].body} 2
Nested control structure after failure
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]} 2
- Should Be Equal ${tc.body[1].type} FOR
- Should Not Be Run ${tc.body[1].body} 1
- Should Be Equal ${tc.body[1].body[0].type} ITERATION
- Should Not Be Run ${tc.body[1].body[0].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].type} IF/ELSE ROOT
- Should Not Be Run ${tc.body[1].body[0].body[0].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].type} IF
- Should Not Be Run ${tc.body[1].body[0].body[0].body[0].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[0].type} FOR
- Should Not Be Run ${tc.body[1].body[0].body[0].body[0].body[0].body} 1
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[0].body[0].type} ITERATION
- Should Not Be Run ${tc.body[1].body[0].body[0].body[0].body[0].body[0].body} 3
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[0].body[0].body[0].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[0].body[0].body[1].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[0].body[0].body[2].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[0].body[1].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].type} ELSE
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[0].type} WHILE
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body[0].body} 1
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[0].body[0].type} ITERATION
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body[0].body[0].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[0].body[0].body[0].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[0].body[0].body[1].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[1].type} TRY/EXCEPT ROOT
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body[1].body} 2
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[1].body[0].type} TRY
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body[1].body[0].body} 1
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[1].body[0].body[0].type} KEYWORD
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[1].body[1].type} EXCEPT
- Should Not Be Run ${tc.body[1].body[0].body[0].body[1].body[1].body[1].body} 1
- Should Be Equal ${tc.body[1].body[0].body[0].body[1].body[1].body[1].body[0].type} BREAK
- Should Be Equal ${tc.body[1].body[0].body[1].type} KEYWORD
- Should Be Equal ${tc.body[2].type} KEYWORD
+ Should Not Be Run ${tc[1:]} 2
+ Should Be Equal ${tc[1].type} FOR
+ Should Not Be Run ${tc[1].body} 1
+ Should Be Equal ${tc[1, 0].type} ITERATION
+ Should Not Be Run ${tc[1, 0].body} 2
+ Should Be Equal ${tc[1, 0, 0].type} IF/ELSE ROOT
+ Should Not Be Run ${tc[1, 0, 0].body} 2
+ Should Be Equal ${tc[1, 0, 0, 0].type} IF
+ Should Not Be Run ${tc[1, 0, 0, 0].body} 2
+ Should Be Equal ${tc[1, 0, 0, 0, 0].type} FOR
+ Should Not Be Run ${tc[1, 0, 0, 0, 0].body} 1
+ Should Be Equal ${tc[1, 0, 0, 0, 0, 0].type} ITERATION
+ Should Not Be Run ${tc[1, 0, 0, 0, 0, 0].body} 2
+ Should Be Equal ${tc[1, 0, 0, 0, 0, 0, 0].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 0, 0, 0, 1].type} GROUP
+ Should Not Be Run ${tc[1, 0, 0, 0, 0, 0, 1].body} 2
+ Should Be Equal ${tc[1, 0, 0, 0, 0, 0, 1, 0].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 0, 0, 0, 1, 1].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 0, 1].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 1].type} ELSE
+ Should Not Be Run ${tc[1, 0, 0, 1].body} 2
+ Should Be Equal ${tc[1, 0, 0, 1, 0].type} WHILE
+ Should Not Be Run ${tc[1, 0, 0, 1, 0].body} 1
+ Should Be Equal ${tc[1, 0, 0, 1, 0, 0].type} ITERATION
+ Should Not Be Run ${tc[1, 0, 0, 1, 0, 0].body} 2
+ Should Be Equal ${tc[1, 0, 0, 1, 0, 0, 0].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 1, 0, 0, 1].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 1, 1].type} TRY/EXCEPT ROOT
+ Should Not Be Run ${tc[1, 0, 0, 1, 1].body} 2
+ Should Be Equal ${tc[1, 0, 0, 1, 1, 0].type} TRY
+ Should Not Be Run ${tc[1, 0, 0, 1, 1, 0].body} 1
+ Should Be Equal ${tc[1, 0, 0, 1, 1, 0, 0].type} KEYWORD
+ Should Be Equal ${tc[1, 0, 0, 1, 1, 1].type} EXCEPT
+ Should Not Be Run ${tc[1, 0, 0, 1, 1, 1].body} 1
+ Should Be Equal ${tc[1, 0, 0, 1, 1, 1, 0].type} BREAK
+ Should Be Equal ${tc[1, 0, 1].type} KEYWORD
+ Should Be Equal ${tc[2].type} KEYWORD
Failure in user keyword
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Should Not Be Run ${tc.body[0].body[1:]} 2
+ Should Not Be Run ${tc[1:]}
+ Should Not Be Run ${tc[0][1:]} 2
Failure in IF branch
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[0].body[0].body[1:]}
- Should Not Be Run ${tc.body[0].body[1].body}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[0, 0][1:]}
+ Should Not Be Run ${tc[0, 1].body}
+ Should Not Be Run ${tc[1:]}
Failure in ELSE IF branch
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[0].body[0].body}
- Should Not Be Run ${tc.body[0].body[1].body[1:]}
- Should Not Be Run ${tc.body[0].body[2].body}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[0, 0].body}
+ Should Not Be Run ${tc[0, 1][1:]}
+ Should Not Be Run ${tc[0, 2].body}
+ Should Not Be Run ${tc[1:]}
Failure in ELSE branch
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[0].body[0].body}
- Should Not Be Run ${tc.body[0].body[1].body[1:]}
- Should Not Be Run ${tc.body[1:]}
+ Should Not Be Run ${tc[0, 0].body}
+ Should Not Be Run ${tc[0, 1][1:]}
+ Should Not Be Run ${tc[1:]}
+
+Failure in GROUP
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Not Be Run ${tc[0, 0][1:]}
+ Should Not Be Run ${tc[0][1:]} 2
+ Should Not Be Run ${tc[0, 2].body}
+ Should Not Be Run ${tc[1:]}
Failure in FOR iteration
${tc} = Check Test Case ${TESTNAME}
- Should Not Be Run ${tc.body[1:]}
- Length Should Be ${tc.body[0].body} 1
- Should Not Be Run ${tc.body[0].body[0].body[1:]}
+ Should Not Be Run ${tc[1:]}
+ Length Should Be ${tc[0].body} 1
+ Should Not Be Run ${tc[0, 0][1:]}
*** Keywords ***
Should Not Be Run
diff --git a/atest/robot/running/stopping_with_signal.robot b/atest/robot/running/stopping_with_signal.robot
index a1a70c1d154..fe79715a963 100644
--- a/atest/robot/running/stopping_with_signal.robot
+++ b/atest/robot/running/stopping_with_signal.robot
@@ -59,8 +59,8 @@ One Signal Should Stop Test Execution Gracefully And Test Case And Suite Teardow
Start And Send Signal with_teardown.robot One SIGINT
Check Test Cases Have Failed Correctly
${tc} = Get Test Case Test
- Check Log Message ${tc.teardown.msgs[0]} Logging Test Case Teardown
- Check Log Message ${SUITE.teardown.kws[0].msgs[0]} Logging Suite Teardown
+ Check Log Message ${tc.teardown[0]} Logging Test Case Teardown
+ Check Log Message ${SUITE.teardown[0, 0]} Logging Suite Teardown
Skip Teardowns After Stopping Gracefully
Start And Send Signal with_teardown.robot One SIGINT 0s --SkipTeardownOnExit
@@ -69,6 +69,43 @@ Skip Teardowns After Stopping Gracefully
Teardown Should Not Be Defined ${tc}
Teardown Should Not Be Defined ${SUITE}
+SIGINT Signal Should Stop Async Test Execution Gracefully
+ Start And Send Signal async_stop.robot One SIGINT 5
+ Check Test Cases Have Failed Correctly
+ ${tc} = Get Test Case Test
+ Length Should Be ${tc[1].body} 1
+ Check Log Message ${tc[1, 0]} Start Sleep
+ Length Should Be ${SUITE.teardown.body} 0
+
+Two SIGINT Signals Should Stop Async Test Execution Forcefully
+ Start And Send Signal async_stop.robot Two SIGINTs 5
+ Check Tests Have Been Forced To Shutdown
+
+SIGTERM Signal Should Stop Async Test Execution Gracefully
+ [Tags] no-windows
+ Start And Send Signal async_stop.robot One SIGTERM 5
+ Check Test Cases Have Failed Correctly
+ ${tc} = Get Test Case Test
+ Length Should Be ${tc[1].body} 1
+ Check Log Message ${tc[1, 0]} Start Sleep
+ Length Should Be ${SUITE.teardown.body} 0
+
+Two SIGTERM Signals Should Stop Async Test Execution Forcefully
+ [Tags] no-windows
+ Start And Send Signal async_stop.robot Two SIGTERMs 5
+ Check Tests Have Been Forced To Shutdown
+
+Signal handler is reset after execution
+ [Tags] no-windows
+ ${result} = Run Process
+ ... @{INTERPRETER.interpreter}
+ ... ${DATADIR}/running/stopping_with_signal/test_signalhandler_is_reset.py
+ ... stderr=STDOUT
+ ... env:PYTHONPATH=${INTERPRETER.src_dir}
+ Log ${result.stdout}
+ Should Contain X Times ${result.stdout} Execution terminated by signal count=1
+ Should Be Equal ${result.rc} ${0}
+
*** Keywords ***
Start And Send Signal
[Arguments] ${datasource} ${signals} ${sleep}=0s @{extra options}
diff --git a/atest/robot/running/test_case_status.robot b/atest/robot/running/test_case_status.robot
index 842747f7f03..3336db55058 100644
--- a/atest/robot/running/test_case_status.robot
+++ b/atest/robot/running/test_case_status.robot
@@ -1,11 +1,11 @@
-*** Setting ***
+*** Settings ***
Documentation Tests for setting test case status correctly when test passes
... and when a failure or error occurs. Also includes test cases
... for running test setup and teardown in different situations.
Suite Setup Run Tests ${EMPTY} running/test_case_status.robot
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Test Passes
Check Test Case ${TEST NAME}
@@ -41,12 +41,10 @@ Test Setup And Teardown Pass
Check Test Case ${TEST NAME}
Test Teardown is Run When Setup Fails
- ${test} Check Test Case ${TEST NAME}
- ${td} = Set Variable ${test.teardown}
- Should Not Be Equal ${td} ${None} Teardown not run No values
- Length Should Be ${td.msgs} 1
- Check Log Message ${td.msgs[0]} Hello from teardown!
- Length Should Be ${td.kws} 0
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Not Be Equal ${tc.teardown} ${None} Teardown not run values=False
+ Length Should Be ${tc.teardown.body} 1
+ Check Log Message ${tc.teardown[0]} Hello from teardown!
Test Setup And Teardown Fails
Check Test Case ${TEST NAME}
diff --git a/atest/robot/running/test_template.robot b/atest/robot/running/test_template.robot
index c6306bc90d2..ba2a2e22941 100644
--- a/atest/robot/running/test_template.robot
+++ b/atest/robot/running/test_template.robot
@@ -59,32 +59,32 @@ Invalid FOR
Template With IF
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].status} PASS
- Should Be Equal ${tc.body[0].body[0].type} IF
- Should Be Equal ${tc.body[0].body[0].status} NOT RUN
- Should Be Equal ${tc.body[0].body[1].type} ELSE IF
- Should Be Equal ${tc.body[0].body[1].status} NOT RUN
- Should Be Equal ${tc.body[0].body[2].type} ELSE
- Should Be Equal ${tc.body[0].body[2].status} PASS
+ Should Be Equal ${tc[0].status} PASS
+ Should Be Equal ${tc[0, 0].type} IF
+ Should Be Equal ${tc[0, 0].status} NOT RUN
+ Should Be Equal ${tc[0, 1].type} ELSE IF
+ Should Be Equal ${tc[0, 1].status} NOT RUN
+ Should Be Equal ${tc[0, 2].type} ELSE
+ Should Be Equal ${tc[0, 2].status} PASS
Template With IF Failing
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].status} FAIL
- Should Be Equal ${tc.body[0].body[0].type} IF
- Should Be Equal ${tc.body[0].body[0].status} FAIL
- Should Be Equal ${tc.body[1].status} FAIL
- Should Be Equal ${tc.body[1].body[0].type} IF
- Should Be Equal ${tc.body[1].body[0].status} NOT RUN
- Should Be Equal ${tc.body[1].body[1].type} ELSE IF
- Should Be Equal ${tc.body[1].body[1].status} FAIL
- Should Be Equal ${tc.body[1].body[2].type} ELSE
- Should Be Equal ${tc.body[1].body[2].status} NOT RUN
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0, 0].type} IF
+ Should Be Equal ${tc[0, 0].status} FAIL
+ Should Be Equal ${tc[1].status} FAIL
+ Should Be Equal ${tc[1, 0].type} IF
+ Should Be Equal ${tc[1, 0].status} NOT RUN
+ Should Be Equal ${tc[1, 1].type} ELSE IF
+ Should Be Equal ${tc[1, 1].status} FAIL
+ Should Be Equal ${tc[1, 2].type} ELSE
+ Should Be Equal ${tc[1, 2].status} NOT RUN
Invalid IF
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].status} FAIL
- Should Be Equal ${tc.body[0].body[0].type} IF
- Should Be Equal ${tc.body[0].body[0].status} FAIL
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0, 0].type} IF
+ Should Be Equal ${tc[0, 0].status} FAIL
FOR and IF
Check Test Case ${TESTNAME}
@@ -116,7 +116,7 @@ Templated test with for loop continues after keyword timeout
Templated test ends after syntax errors
Check Test Case ${TESTNAME}
-Templated test continues after variable error
+Templated test continues after non-syntax errors
Check Test Case ${TESTNAME}
Templates and fatal errors
diff --git a/atest/robot/running/test_template_with_embeded_args.robot b/atest/robot/running/test_template_with_embeded_args.robot
index 680406bce21..65b3d427abe 100644
--- a/atest/robot/running/test_template_with_embeded_args.robot
+++ b/atest/robot/running/test_template_with_embeded_args.robot
@@ -5,39 +5,39 @@ Resource atest_resource.robot
*** Test Cases ***
Matching arguments
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of 1 + 1 should be 2
- Keyword should be ${tc.kws[1]} The result of 1 + 2 should be 3
- Keyword should be ${tc.kws[2]} The result of 1 + 3 should be 5
+ Keyword should be ${tc[0]} The result of 1 + 1 should be 2
+ Keyword should be ${tc[1]} The result of 1 + 2 should be 3
+ Keyword should be ${tc[2]} The result of 1 + 3 should be 5
Argument names do not need to be same as in definition
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of 1 + 1 should be 2
- Keyword should be ${tc.kws[1]} The result of 1 + 2 should be 3
- Keyword should be ${tc.kws[2]} The result of 1 + 3 should be 5
+ Keyword should be ${tc[0]} The result of 1 + 1 should be 2
+ Keyword should be ${tc[1]} The result of 1 + 2 should be 3
+ Keyword should be ${tc[2]} The result of 1 + 3 should be 5
Some arguments can be hard-coded
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of 1 + 1 should be 3
- Keyword should be ${tc.kws[1]} The result of 1 + 2 should be 3
- Keyword should be ${tc.kws[2]} The result of 1 + 3 should be 3
+ Keyword should be ${tc[0]} The result of 1 + 1 should be 3
+ Keyword should be ${tc[1]} The result of 1 + 2 should be 3
+ Keyword should be ${tc[2]} The result of 1 + 3 should be 3
Can have different arguments than definition
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of 38 + 3 + 1 should be 42
- Keyword should be ${tc.kws[1]} The non-existing of 666 should be 42
+ Keyword should be ${tc[0]} The result of 38 + 3 + 1 should be 42
+ Keyword should be ${tc[1]} The non-existing of 666 should be 42
Can use variables
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of \${1} + \${2} should be \${3}
+ Keyword should be ${tc[0]} The result of \${1} + \${2} should be \${3}
Cannot have more arguments than variables
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of \${calc} should be 3
+ Keyword should be ${tc[0]} The result of \${calc} should be 3
... 1 + 2 extra
Cannot have less arguments than variables
${tc} = Check Test Case ${TESTNAME}
- Keyword should be ${tc.kws[0]} The result of \${calc} should be \${extra}
+ Keyword should be ${tc[0]} The result of \${calc} should be \${extra}
... 1 + 2
*** Keywords ***
diff --git a/atest/robot/running/timeouts.robot b/atest/robot/running/timeouts.robot
index 6a0b6edbb57..28089a9d1cb 100644
--- a/atest/robot/running/timeouts.robot
+++ b/atest/robot/running/timeouts.robot
@@ -16,14 +16,14 @@ Timeouted Test Passes
Timeouted Test Fails Before Timeout
Check Test Case Failing Before Timeout
-Show Correct Trace Back When Failing Before Timeout
+Show Correct Traceback When Failing Before Timeout
${tc} = Check Test Case ${TEST NAME}
${expected} = Catenate SEPARATOR=\n
... Traceback (most recent call last):
... ${SPACE*2}File "*", line *, in exception
... ${SPACE*4}raise exception(msg)
... RuntimeError: Failure before timeout
- Check Log Message ${tc.kws[0].msgs[-1]} ${expected} pattern=yes level=DEBUG
+ Check Log Message ${tc[0, -1]} ${expected} DEBUG pattern=True traceback=True
Timeouted Test Timeouts
Check Test Case Sleeping And Timeouting
@@ -33,7 +33,6 @@ Total Time Too Long
Check Test Case ${TEST NAME} 1
Check Test Case ${TEST NAME} 2
Check Test Case ${TEST NAME} 3
- Check Test Case ${TEST NAME} 4
Timout Defined For One Test
Check Test Case ${TEST NAME}
@@ -63,17 +62,17 @@ Test Timeouts When Also Keywords Are Timeouted
Keyword Timeout From Variable
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].timeout} 1 millisecond
+ Should Be Equal ${tc[0].timeout} 10 milliseconds
Keyword Timeout From Argument
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].timeout} 1 second
- Should Be Equal ${tc.kws[1].timeout} 2 milliseconds
+ Should Be Equal ${tc[0].timeout} 1 second
+ Should Be Equal ${tc[1].timeout} 11 milliseconds
Embedded Arguments Timeout From Argument
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].timeout} 1 second
- Should Be Equal ${tc.kws[1].timeout} 3 milliseconds
+ Should Be Equal ${tc[0].timeout} 1 second
+ Should Be Equal ${tc[1].timeout} 12 milliseconds
Local Variables Are Not Visible In Child Keyword Timeout
Check Test Case ${TEST NAME}
@@ -88,9 +87,9 @@ Test Timeout During Setup
Teardown After Test Timeout
[Documentation] Test that teardown is executed after a test has timed out
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.msgs[0]} Teardown executed
+ Check Log Message ${tc.teardown[0]} Teardown executed
${tc} = Check Test Case Teardown With Sleep After Test Timeout
- Check Log Message ${tc.teardown.kws[1].msgs[0]} Teardown executed
+ Check Log Message ${tc.teardown[1, 0]} Teardown executed
Failing Teardown After Test Timeout
Check Test Case ${TEST NAME}
@@ -98,7 +97,7 @@ Failing Teardown After Test Timeout
Test Timeout During Teardown
[Documentation] Test timeout should not interrupt teardown but test should be failed afterwards
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.kws[1].msgs[0]} Teardown executed
+ Check Log Message ${tc.teardown[1, 0]} Teardown executed
Timeouted Setup Passes
Check Test Case ${TEST NAME}
@@ -112,6 +111,30 @@ Timeouted Teardown Passes
Timeouted Teardown Timeouts
Check Test Case ${TEST NAME}
+Keyword teardown after test timeout
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0].teardown.status} PASS
+ Check Log Message ${tc[0].teardown[0, 0]} I'm a teardown keyword
+
+Keyword teardown after keyword timeout
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0].teardown.status} PASS
+ Check Log Message ${tc[0].teardown[0, 0]} I'm a teardown keyword
+
+Keyword teardown fails due to total time
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0].teardown.status} PASS
+ Check Log Message ${tc[0].teardown[0, 0]} I'm a teardown keyword
+
+Keyword teardown fails for own timeout
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0].teardown.status} FAIL
+ Check Log Message ${tc[0].teardown[0, 0]} Keyword timeout 14 milliseconds active. 0.??? seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[0].teardown[0, 1]} I'm a teardown keyword
+
+Keyword in teardown fails for timeout
+ Check Test Case ${TEST NAME}
+
Timeouted UK Using Non Timeouted UK
Check Test Case ${TEST NAME}
@@ -133,8 +156,8 @@ Keyword Timeout Should Not Be Active For Run Keyword Variants But To Keywords Th
Logging With Timeouts
[Documentation] Testing that logging works with timeouts
${tc} = Check Test Case Timeouted Keyword Passes
- Check Log Message ${tc.kws[0].msgs[1]} Testing logging in timeouted test
- Check Log Message ${tc.kws[1].kws[0].msgs[1]} Testing logging in timeouted keyword
+ Check Log Message ${tc[0, 1]} Testing logging in timeouted test
+ Check Log Message ${tc[1, 0, 1]} Testing logging in timeouted keyword
Timeouted Keyword Called With Wrong Number of Arguments
Check Test Case ${TEST NAME}
@@ -144,31 +167,31 @@ Timeouted Keyword Called With Wrong Number of Arguments with Run Keyword
Test Timeout Logging
${tc} = Check Test Case Passing
- Timeout should have been active ${tc.kws[0]} 1 second 1
+ Timeout should have been active ${tc[0]} 10 seconds 1
${tc} = Check Test Case Failing Before Timeout
- Timeout should have been active ${tc.kws[0]} 2 seconds 3
+ Timeout should have been active ${tc[0]} 2 seconds 3
${tc} = Check Test Case Sleeping And Timeouting
- Timeout should have been active ${tc.kws[0]} 1 second 2 exceeded=True
+ Timeout should have been active ${tc[0]} 5 milliseconds 2 exceeded=True
Keyword Timeout Logging
${tc} = Check Test Case Timeouted Keyword Passes
- Keyword timeout should have been active ${tc.kws[1].kws[0]} 5 seconds 2
+ Keyword timeout should have been active ${tc[1, 0]} 5 seconds 2
${tc} = Check Test Case Timeouted Keyword Fails Before Timeout
- Keyword timeout should have been active ${tc.kws[0].kws[0]} 2 hours 30 minutes 3
+ Keyword timeout should have been active ${tc[0, 0]} 2 hours 30 minutes 3
${tc} = Check Test Case Timeouted Keyword Timeouts
- Keyword timeout should have been active ${tc.kws[0].kws[0]} 99 milliseconds 2 exceeded=True
+ Keyword timeout should have been active ${tc[0, 0]} 11 milliseconds 2 exceeded=True
Zero timeout is ignored
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.timeout} 0 seconds
- Should Be Equal ${tc.kws[0].timeout} 0 seconds
- Should Be True ${tc.kws[0].elapsedtime} > 99
+ Should Be Equal ${tc.timeout} ${None}
+ Should Be Equal ${tc[0].timeout} ${None}
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.01
Negative timeout is ignored
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].timeout} - 1 second
- Should Be Equal ${tc.kws[0].timeout} - 1 second
- Should Be True ${tc.kws[0].elapsedtime} > 99
+ Should Be Equal ${tc.timeout} ${None}
+ Should Be Equal ${tc[0].timeout} ${None}
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.01
Invalid test timeout
Check Test Case ${TEST NAME}
@@ -179,10 +202,9 @@ Invalid keyword timeout
*** Keywords ***
Timeout should have been active
[Arguments] ${kw} ${timeout} ${msg count} ${exceeded}=False ${type}=Test
- Check Log Message ${kw.msgs[0]} ${type} timeout ${timeout} active. * left. DEBUG pattern=True
- Length Should Be ${kw.msgs} ${msg count}
- Run Keyword If ${exceeded}
- ... Timeout should have exceeded ${kw} ${timeout} ${type}
+ Check Log Message ${kw[0]} ${type} timeout ${timeout} active. *.??? seconds left. DEBUG pattern=True
+ Length Should Be ${kw.body} ${msg count}
+ IF ${exceeded} Timeout should have exceeded ${kw} ${timeout} ${type}
Keyword timeout should have been active
[Arguments] ${kw} ${timeout} ${msg count} ${exceeded}=False
@@ -190,4 +212,4 @@ Keyword timeout should have been active
Timeout should have exceeded
[Arguments] ${kw} ${timeout} ${type}=Test
- Check Log Message ${kw.msgs[1]} ${type} timeout ${timeout} exceeded. FAIL
+ Check Log Message ${kw[1]} ${type} timeout ${timeout} exceeded. FAIL
diff --git a/atest/robot/running/timeouts_with_custom_messages.robot b/atest/robot/running/timeouts_with_custom_messages.robot
index 46127b1ae28..4f21b34fb55 100644
--- a/atest/robot/running/timeouts_with_custom_messages.robot
+++ b/atest/robot/running/timeouts_with_custom_messages.robot
@@ -9,19 +9,15 @@ Default Test Timeout Message
Test Timeout Message
Check Test Case ${TEST NAME}
- Using more than one value with timeout should error 1 9 2
Test Timeout Message In Multiple Columns
Check Test Case ${TEST NAME}
- Using more than one value with timeout should error 2 13 7
Keyword Timeout Message
Check Test Case ${TEST NAME}
- Using more than one value with timeout should error 3 26 2
Keyword Timeout Message In Multiple Columns
Check Test Case ${TEST NAME}
- Using more than one value with timeout should error 4 30 7
*** Keywords ***
Using more than one value with timeout should error
diff --git a/atest/robot/running/try_except/except_behaviour.robot b/atest/robot/running/try_except/except_behaviour.robot
index 74a8adcce74..1ede85342a5 100644
--- a/atest/robot/running/try_except/except_behaviour.robot
+++ b/atest/robot/running/try_except/except_behaviour.robot
@@ -5,19 +5,19 @@ Test Template Verify try except and block statuses
*** Test Cases ***
Equals is the default matcher
- FAIL PASS
+ FAIL PASS pattern_types=[None]
Equals with whitespace
FAIL PASS
Glob matcher
- FAIL NOT RUN PASS
+ FAIL NOT RUN PASS pattern_types=['GloB', 'gloB']
Startswith matcher
- FAIL PASS
+ FAIL PASS pattern_types=['start']
Regexp matcher
- FAIL NOT RUN PASS
+ FAIL NOT RUN PASS pattern_types=['REGEXP', 'REGEXP']
Regexp escapes
FAIL PASS
@@ -35,16 +35,22 @@ Non-string pattern
FAIL NOT RUN NOT RUN NOT RUN NOT RUN
Variable in pattern type
- FAIL PASS
+ FAIL PASS pattern_types=['\${regexp}']
Invalid variable in pattern type
- FAIL FAIL PASS
+ FAIL FAIL PASS pattern_types=['\${does not exist}']
Invalid pattern type
- FAIL FAIL
+ FAIL NOT RUN NOT RUN pattern_types=['glob', 'invalid']
+
+Invalid pattern type from variable
+ FAIL FAIL pattern_types=["\${{'invalid'}}"]
Non-string pattern type
- FAIL FAIL
+ FAIL FAIL pattern_types=['\${42}']
+
+Pattern type multiple times
+ FAIL PASS NOT RUN pattern_types=['start']
Pattern type without patterns
FAIL PASS
@@ -53,7 +59,7 @@ Skip cannot be caught
SKIP NOT RUN PASS tc_status=SKIP
Return cannot be caught
- PASS NOT RUN PASS path=body[0].body[0]
+ PASS NOT RUN PASS path=body[0].body[0]
AS gets the message
FAIL PASS
diff --git a/atest/robot/running/try_except/invalid_try_except.robot b/atest/robot/running/try_except/invalid_try_except.robot
index e69a824b577..45ad4c198fb 100644
--- a/atest/robot/running/try_except/invalid_try_except.robot
+++ b/atest/robot/running/try_except/invalid_try_except.robot
@@ -81,3 +81,10 @@ CONTINUE in FINALLY
RETURN in FINALLY
TRY:PASS FINALLY:FAIL path=body[0].body[0]
+
+Invalid TRY/EXCEPT causes syntax error that cannot be caught
+ TRY:FAIL EXCEPT:NOT RUN ELSE:NOT RUN
+
+Dangling FINALLY
+ [Template] Check Test Case
+ ${TEST NAME}
diff --git a/atest/robot/running/try_except/try_except.robot b/atest/robot/running/try_except/try_except.robot
index aca14fc3d85..8d074cd6446 100644
--- a/atest/robot/running/try_except/try_except.robot
+++ b/atest/robot/running/try_except/try_except.robot
@@ -35,21 +35,21 @@ Default except pattern
FAIL PASS
Syntax errors cannot be caught
- FAIL
+ FAIL NOT RUN NOT RUN
Finally block executed when no failures
[Template] None
${tc}= Verify try except and block statuses PASS NOT RUN PASS PASS
- Check Log Message ${tc.body[0].body[0].body[0].msgs[0]} all good
- Check Log Message ${tc.body[0].body[2].body[0].msgs[0]} in the else
- Check Log Message ${tc.body[0].body[3].body[0].msgs[0]} Hello from finally!
+ Check Log Message ${tc[0, 0, 0, 0]} all good
+ Check Log Message ${tc[0, 2, 0, 0]} in the else
+ Check Log Message ${tc[0, 3, 0, 0]} Hello from finally!
Finally block executed after catch
[Template] None
${tc}= Verify try except and block statuses FAIL PASS PASS
- Check Log Message ${tc.body[0].body[0].body[0].msgs[0]} all not good FAIL
- Check Log Message ${tc.body[0].body[1].body[0].msgs[0]} we are safe now
- Check Log Message ${tc.body[0].body[2].body[0].msgs[0]} Hello from finally!
+ Check Log Message ${tc[0, 0, 0, 0]} all not good FAIL
+ Check Log Message ${tc[0, 1, 0, 0]} we are safe now
+ Check Log Message ${tc[0, 2, 0, 0]} Hello from finally!
Finally block executed after failure in except
FAIL FAIL NOT RUN PASS
diff --git a/atest/robot/running/try_except/try_except_resource.robot b/atest/robot/running/try_except/try_except_resource.robot
index 6f557b433e4..af65fc06c0d 100644
--- a/atest/robot/running/try_except/try_except_resource.robot
+++ b/atest/robot/running/try_except/try_except_resource.robot
@@ -1,12 +1,12 @@
*** Settings ***
Resource atest_resource.robot
-Library Collections
*** Keywords ***
Verify try except and block statuses
- [Arguments] @{types_and_statuses} ${tc_status}= ${path}=body[0]
+ [Arguments] @{types_and_statuses} ${tc_status}= ${path}=body[0] ${pattern_types}=[]
${tc}= Check test status @{{[s.split(':')[-1] for s in $types_and_statuses]}} tc_status=${tc_status}
Block statuses should be ${tc.${path}} @{types_and_statuses}
+ Pattern types should be ${tc.${path}} ${pattern_types}
RETURN ${tc}
Check Test Status
@@ -34,3 +34,11 @@ Block statuses should be
Should Be Equal ${block.status} ${type_and_status}
END
END
+
+Pattern types should be
+ [Arguments] ${try_except} ${pattern_types}
+ @{pattern_types} = Evaluate ${pattern_types}
+ FOR ${except} ${expected} IN ZIP ${try_except.body[1:]} ${pattern_types} mode=shortest
+ Should Be Equal ${except.type} EXCEPT
+ Should Be Equal ${except.pattern_type} ${expected}
+ END
diff --git a/atest/robot/running/while/break_and_continue.robot b/atest/robot/running/while/break_and_continue.robot
index 8fb4aac3eb5..bc932d39d12 100644
--- a/atest/robot/running/while/break_and_continue.robot
+++ b/atest/robot/running/while/break_and_continue.robot
@@ -1,7 +1,7 @@
*** Settings ***
Resource while.resource
Suite Setup Run Tests ${EMPTY} running/while/break_and_continue.robot
-Test Template Check while loop
+Test Template Check WHILE loop
*** Test Cases ***
With CONTINUE
@@ -31,6 +31,24 @@ With BREAK inside EXCEPT
With BREAK inside TRY-ELSE
PASS 1
+BREAK with continuable failures
+ FAIL 1
+
+CONTINUE with continuable failures
+ FAIL 2
+
+Invalid BREAK
+ FAIL 1
+
+Invalid CONTINUE
+ FAIL 1
+
+Invalid BREAK not executed
+ PASS 1
+
+Invalid CONTINUE not executed
+ NOT RUN 1
+
With CONTINUE in UK
PASS 5 body[0].body[0]
diff --git a/atest/robot/running/while/invalid_while.robot b/atest/robot/running/while/invalid_while.robot
index c6687e9b247..e2526405943 100644
--- a/atest/robot/running/while/invalid_while.robot
+++ b/atest/robot/running/while/invalid_while.robot
@@ -1,23 +1,61 @@
*** Settings ***
Resource while.resource
-Suite Setup Run Tests ${EMPTY} running/while/invalid_while.robot
+Suite Setup Run Tests --log test_result_model_as_well running/while/invalid_while.robot
*** Test Cases ***
-No condition
- Check Test Case ${TESTNAME}
-
Multiple conditions
- ${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].condition} Too, many, !
+ ${tc} = Check Invalid WHILE Test Case
+ Should Be Equal ${tc[0].condition} Too, many, conditions, !
Invalid condition
- Check Test Case ${TESTNAME}
+ Check Invalid WHILE Test Case
+
+Non-existing ${variable} in condition
+ Check Invalid WHILE Test Case
-Non-existing variable in condition
- Check Test Case ${TESTNAME}
+Non-existing $variable in condition
+ Check Invalid WHILE Test Case
+
+Recommend $var syntax if invalid condition contains ${var}
+ Check Test Case ${TEST NAME}
+
+Invalid condition on second round
+ Check Test Case ${TEST NAME}
No body
- Check Test Case ${TESTNAME}
+ Check Invalid WHILE Test Case body=False
No END
- Check Test Case ${TESTNAME}
+ Check Invalid WHILE Test Case
+
+Invalid data causes syntax error
+ Check Test Case ${TEST NAME}
+
+Invalid condition causes normal error
+ Check Test Case ${TEST NAME}
+
+Non-existing variable in condition causes normal error
+ Check Test Case ${TEST NAME}
+
+Templatest are not supported
+ ${tc} = Check Test Case ${TEST NAME}
+ Should Be Equal ${tc[0].type} WHILE
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0, 0].type} ITERATION
+ Should Be Equal ${tc[0, 0].status} NOT RUN
+ Check Keyword Data ${tc[0, 0, 0]} ${EMPTY} args=1 status=NOT RUN
+ Check Keyword Data ${tc[0, 0, 1]} ${EMPTY} args=2 status=NOT RUN
+
+*** Keywords ***
+Check Invalid WHILE Test Case
+ [Arguments] ${body}=True
+ ${tc} = Check Test Case ${TESTNAME}
+ Should Be Equal ${tc[0].type} WHILE
+ Should Be Equal ${tc[0].status} FAIL
+ Should Be Equal ${tc[0, 0].type} ITERATION
+ Should Be Equal ${tc[0, 0].status} NOT RUN
+ IF ${body}
+ Should Be Equal ${tc[0, 0, 0].full_name} BuiltIn.Fail
+ Should Be Equal ${tc[0, 0, 0].status} NOT RUN
+ END
+ RETURN ${tc}
diff --git a/atest/robot/running/while/nested_while.robot b/atest/robot/running/while/nested_while.robot
index 96e08c15726..e745c002619 100644
--- a/atest/robot/running/while/nested_while.robot
+++ b/atest/robot/running/while/nested_while.robot
@@ -5,24 +5,24 @@ Suite Setup Run Tests ${EMPTY} running/while/nested_while.robot
*** Test Cases ***
Inside FOR
${tc}= Check test case ${TEST NAME}
- Check loop attributes ${tc.body[0].body[0].body[0]} PASS 4
- Check loop attributes ${tc.body[0].body[1].body[0]} PASS 3
- Check loop attributes ${tc.body[0].body[2].body[0]} PASS 2
- Length should be ${tc.body[0].body} 3
+ Check loop attributes ${tc[0, 0, 0]} PASS 4
+ Check loop attributes ${tc[0, 1, 0]} PASS 3
+ Check loop attributes ${tc[0, 2, 0]} PASS 2
+ Length should be ${tc[0].body} 3
Failing inside FOR
${tc}= Check test case ${TEST NAME}
- Check loop attributes ${tc.body[0].body[0].body[0]} FAIL 2
- Length should be ${tc.body[0].body} 1
+ Check loop attributes ${tc[0, 0, 0]} FAIL 2
+ Length should be ${tc[0].body} 1
Inside IF
${tc}= Check test case ${TEST NAME}
- Check loop attributes ${tc.body[0].body[0].body[1]} PASS 4
+ Check loop attributes ${tc[0, 0, 1]} PASS 4
In suite setup
${suite}= Get Test Suite Nested While
- Check loop attributes ${suite.setup.body[1]} PASS 4
+ Check loop attributes ${suite.setup[1]} PASS 4
In suite teardown
${suite}= Get Test Suite Nested While
- Check loop attributes ${suite.teardown.body[1]} PASS 4
+ Check loop attributes ${suite.teardown[1]} PASS 4
diff --git a/atest/robot/running/while/on_limit.robot b/atest/robot/running/while/on_limit.robot
new file mode 100644
index 00000000000..91415d27cb9
--- /dev/null
+++ b/atest/robot/running/while/on_limit.robot
@@ -0,0 +1,59 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} running/while/on_limit.robot
+Resource while.resource
+
+*** Test Cases ***
+On limit pass with time limit defined
+ Check WHILE Loop PASS not known
+
+On limit pass with iteration limit defined
+ Check WHILE loop PASS 5
+
+On limit fail
+ Check WHILE Loop FAIL 5
+
+On limit pass with failures in loop
+ Check WHILE Loop FAIL 1
+
+On limit pass with continuable failure
+ Check WHILE Loop FAIL 2
+
+On limit fail with continuable failure
+ Check WHILE Loop FAIL 2
+
+Invalid on_limit
+ Check WHILE Loop FAIL 1 not_run=True
+
+Invalid on_limit from variable
+ Check WHILE Loop FAIL 1 not_run=True
+
+On limit without limit
+ Check WHILE Loop FAIL 1 not_run=True
+
+On limit with invalid variable
+ Check WHILE Loop FAIL 1 not_run=True
+
+On limit message
+ Check WHILE Loop FAIL 11
+
+On limit message without limit
+ Check WHILE Loop FAIL 10000
+
+On limit message from variable
+ Check WHILE Loop FAIL 5
+
+Part of on limit message from variable
+ Check WHILE Loop FAIL 5
+
+On limit message is not used if limit is not hit
+ Check WHILE Loop PASS 2
+
+Nested while on limit message
+ Check WHILE Loop FAIL 1 path=body[0]
+ Check WHILE Loop FAIL 5 path=body[0].body[0].body[0]
+
+On limit message before limit
+ Check WHILE Loop FAIL 5
+
+On limit message with invalid variable
+ Check WHILE Loop FAIL 1 not_run=True
diff --git a/atest/robot/running/while/while.resource b/atest/robot/running/while/while.resource
index 4ee25df6dc0..392399f1bb6 100644
--- a/atest/robot/running/while/while.resource
+++ b/atest/robot/running/while/while.resource
@@ -1,17 +1,21 @@
*** Settings ***
-Resource atest_resource.robot
-
+Resource atest_resource.robot
*** Keywords ***
-Check while loop
- [Arguments] ${status} ${iterations} ${path}=body[0]
- ${tc}= Check test case ${TEST NAME}
- ${loop}= Check loop attributes ${tc.${path}} ${status} ${iterations}
+Check WHILE loop
+ [Arguments] ${status} ${iterations} ${path}=body[0] ${not_run}=False
+ ${tc}= Check Test Case ${TEST NAME}
+ ${loop}= Check Loop Attributes ${tc.${path}} ${status} ${iterations}
+ IF ${not_run}
+ Should Be Equal ${loop.body[0].status} NOT RUN
+ END
RETURN ${loop}
-Check loop attributes
+Check Loop Attributes
[Arguments] ${loop} ${status} ${iterations}
- Should be equal ${loop.type} WHILE
- Should be equal ${loop.status} ${status}
- Length Should Be ${loop.kws} ${iterations}
+ Should Be Equal ${loop.type} WHILE
+ Should Be Equal ${loop.status} ${status}
+ IF '${iterations}' != 'not known'
+ Length Should Be ${loop.non_messages} ${iterations}
+ END
RETURN ${loop}
diff --git a/atest/robot/running/while/while.robot b/atest/robot/running/while/while.robot
index 91ff24732f1..76580a70e04 100644
--- a/atest/robot/running/while/while.robot
+++ b/atest/robot/running/while/while.robot
@@ -5,7 +5,7 @@ Suite Setup Run Tests ${EMPTY} running/while/while.robot
*** Test Cases ***
Loop executed once
${loop}= Check While Loop PASS 1
- Check Log Message ${loop.body[0].body[0].msgs[0]} 1
+ Check Log Message ${loop[0, 0, 0]} 1
Loop executed multiple times
Check While Loop PASS 5
@@ -17,12 +17,24 @@ Loop not executed
Should Be Equal ${item.status} NOT RUN
END
+No Condition
+ Check While Loop PASS 5
+
Execution fails on the first loop
Check While Loop FAIL 1
Execution fails after some loops
Check While Loop FAIL 3
+Continuable failure in loop
+ Check While Loop FAIL 3
+
+Normal failure after continuable failure in loop
+ Check While Loop FAIL 2
+
+Normal failure outside loop after continuable failures in loop
+ Check While Loop FAIL 2
+
Loop in loop
Check While Loop PASS 5
Check While Loop PASS 3 path=body[0].body[0].body[2]
@@ -35,3 +47,8 @@ Loop fails in keyword
With RETURN
Check While Loop PASS 1 path=body[0].body[0]
+
+Condition evaluation time is included in elapsed time
+ ${loop} = Check WHILE loop PASS 1
+ Elapsed Time Should Be Valid ${loop.elapsed_time} minimum=0.2
+ Elapsed Time Should Be Valid ${loop.body[0].elapsed_time} minimum=0.1
diff --git a/atest/robot/running/while/while_limit.robot b/atest/robot/running/while/while_limit.robot
index e1d29da9799..22185673eee 100644
--- a/atest/robot/running/while/while_limit.robot
+++ b/atest/robot/running/while/while_limit.robot
@@ -4,40 +4,63 @@ Resource while.resource
*** Test Cases ***
Default limit is 10000 iterations
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL 10000
Limit with iteration count
- Check while loop FAIL 5
+ Check WHILE Loop FAIL 5
-Limit with iteration count with spaces
- ${tc}= Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].limit} 3 0
+Iteration count with 'times' suffix
+ Check WHILE Loop FAIL 3
-Limit with iteration count with underscore
- ${tc}= Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].limit} 1_0
+Iteration count with 'x' suffix
+ Check WHILE Loop FAIL 4
+
+Iteration count normalization
+ ${loop}= Check WHILE Loop PASS 1 body[0]
+ Should Be Equal ${loop.limit} 1_000
+ ${loop}= Check WHILE Loop FAIL 30 body[1]
+ Should Be Equal ${loop.limit} 3 0 T i m e S
Limit as timestr
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL not known
Limit from variable
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL 11
Part of limit from variable
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL not known
Limit can be disabled
- Check Test Case ${TESTNAME}
+ Check WHILE Loop PASS 10041
+
+No condition with limit
+ Check WHILE Loop FAIL 2
+
+Limit exceeds in teardown
+ Check WHILE Loop FAIL not known teardown.body[0]
+
+Limit exceeds after failures in teardown
+ Check WHILE Loop FAIL 2 teardown.body[0]
+
+Continue after limit in teardown
+ Check WHILE Loop PASS not known teardown.body[0]
Invalid limit invalid suffix
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL 1 not_run=True
Invalid limit invalid value
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL 1 not_run=True
Invalid limit mistyped prefix
- Check Test Case ${TESTNAME}
+ Check WHILE Loop FAIL 1 not_run=True
+
+Limit with non-existing variable
+ Check WHILE Loop FAIL 1 not_run=True
+
+Limit used multiple times
+ ${loop}= Check WHILE Loop FAIL 1 not_run=True
+ Should Be Equal ${loop.limit} 2
Invalid values after limit
- ${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.body[0].condition} $variable < 2, limit=-1x, invalid, values
+ ${loop}= Check WHILE Loop FAIL 1 not_run=True
+ Should Be Equal ${loop.condition} $variable < 2, limit=2, invalid
diff --git a/atest/robot/standard_libraries/builtin/builtin_propertys.robot b/atest/robot/standard_libraries/builtin/builtin_propertys.robot
new file mode 100644
index 00000000000..623baaf6a52
--- /dev/null
+++ b/atest/robot/standard_libraries/builtin/builtin_propertys.robot
@@ -0,0 +1,11 @@
+*** Settings ***
+Resource atest_resource.robot
+
+*** Test Cases ***
+Normal run
+ Run Tests ${EMPTY} standard_libraries/builtin/builtin_propertys.robot
+ Check Test Case Test propertys
+
+Dry-run
+ Run Tests --dryrun --variable DRYRUN:True standard_libraries/builtin/builtin_propertys.robot
+ Check Test Case Test propertys
diff --git a/atest/robot/standard_libraries/builtin/call_method.robot b/atest/robot/standard_libraries/builtin/call_method.robot
index e6980cf031a..8e34ce4d981 100644
--- a/atest/robot/standard_libraries/builtin/call_method.robot
+++ b/atest/robot/standard_libraries/builtin/call_method.robot
@@ -1,25 +1,35 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/call_method.robot
+Suite Setup Run Tests --loglevel DEBUG standard_libraries/builtin/call_method.robot
Resource atest_resource.robot
*** Test Cases ***
Call Method
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Call Method Returns
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Called Method Fails
- Check Test Case ${TEST NAME}
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Calling method 'my_method' failed: Expected failure FAIL
+ ${error} = Catenate SEPARATOR=\n
+ ... RuntimeError: Expected failure
+ ...
+ ... The above exception was the direct cause of the following exception:
+ ...
+ ... RuntimeError: Calling method 'my_method' failed: Expected failure
+ Traceback Should Be ${tc[0, 1]}
+ ... standard_libraries/builtin/objects_for_call_method.py my_method raise RuntimeError("Expected failure")
+ ... error=${error}
Call Method With Kwargs
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Equals in non-kwargs must be escaped
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Call Method From Module
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
Call Non Existing Method
- Check Test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/builtin/converter.robot b/atest/robot/standard_libraries/builtin/converter.robot
index 632e676d759..074da92b23f 100644
--- a/atest/robot/standard_libraries/builtin/converter.robot
+++ b/atest/robot/standard_libraries/builtin/converter.robot
@@ -5,7 +5,7 @@ Resource atest_resource.robot
*** Test Cases ***
Convert To Integer
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0]}
Convert To Integer With Base
Check Test Case ${TEST NAME}
@@ -18,19 +18,19 @@ Convert To Integer With Embedded Base
Convert To Binary
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0]}
Convert To Octal
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0]}
Convert To Hex
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0]}
Convert To Number
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0]}
Convert To Number With Precision
Check Test Case ${TEST NAME}
@@ -40,11 +40,17 @@ Numeric conversions with long types
Convert To String
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0, 0]} str
+ Verify argument type message ${tc[0, 2, 0, 0]} int
+
+Convert To String NFC normalizes
+ ${tc}= Check Test Case ${TEST NAME}
+ Verify argument type message ${tc[0, 0]} str
Convert To Boolean
${tc}= Check Test Case ${TEST NAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0, 0, 0]} str
+ Verify argument type message ${tc[0, 6, 0, 0]} int
Create List
Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/builtin/count.robot b/atest/robot/standard_libraries/builtin/count.robot
index 91acc6c8fe5..7667f1951d8 100644
--- a/atest/robot/standard_libraries/builtin/count.robot
+++ b/atest/robot/standard_libraries/builtin/count.robot
@@ -6,24 +6,24 @@ Resource builtin_resource.robot
Get Count
[Documentation] Tested also by Should Contain X Times keyword that uses this intenally.
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Item found from container 2 times.
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} Item found from container 2 times.
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} Item found from container 1 time.
- Check Log Message ${tc.kws[3].kws[0].msgs[0]} Item found from container 1 time.
- Check Log Message ${tc.kws[4].kws[0].msgs[0]} Item found from container 50 times.
- Check Log Message ${tc.kws[5].kws[0].msgs[0]} Item found from container 0 times.
+ Check Log Message ${tc[0, 0, 0]} Item found from container 2 times.
+ Check Log Message ${tc[1, 0, 0]} Item found from container 2 times.
+ Check Log Message ${tc[2, 0, 0]} Item found from container 1 time.
+ Check Log Message ${tc[3, 0, 0]} Item found from container 1 time.
+ Check Log Message ${tc[4, 0, 0]} Item found from container 50 times.
+ Check Log Message ${tc[5, 0, 0]} Item found from container 0 times.
Should Contain X Times with strings
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Item found from container 2 times.
- Check Log Message ${tc.kws[1].msgs[0]} Item found from container 1 time.
- Check Log Message ${tc.kws[3].msgs[0]} Item found from container 0 times.
+ Check Log Message ${tc[0, 0]} Item found from container 2 times.
+ Check Log Message ${tc[1, 0]} Item found from container 1 time.
+ Check Log Message ${tc[3, 0]} Item found from container 0 times.
Should Contain X Times with containers
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Item found from container 1 time.
- Check Log Message ${tc.kws[1].msgs[0]} Item found from container 2 times.
- Check Log Message ${tc.kws[3].msgs[0]} Item found from container 0 times.
+ Check Log Message ${tc[0, 0]} Item found from container 1 time.
+ Check Log Message ${tc[1, 0]} Item found from container 2 times.
+ Check Log Message ${tc[3, 0]} Item found from container 0 times.
Should Contain X Times failing
Check test case ${TESTNAME}
@@ -46,6 +46,12 @@ Should Contain X Times and do not collapse spaces
Should Contain X Times and collapse spaces
Check test case ${TESTNAME}
+Should Contain X Times with recursive normalization
+ Check test case ${TESTNAME}
+
+Should Contain X Times with bytes auto conversion
+ Check test case ${TESTNAME}
+
Should Contain X Times with invalid item
Check test case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/evaluate.robot b/atest/robot/standard_libraries/builtin/evaluate.robot
index d43a7f03d7d..4bf13404ed3 100644
--- a/atest/robot/standard_libraries/builtin/evaluate.robot
+++ b/atest/robot/standard_libraries/builtin/evaluate.robot
@@ -9,6 +9,9 @@ Resource atest_resource.robot
Evaluate
Check Test Case ${TESTNAME}
+Custom additions to builtins are supported
+ Check Test Case ${TESTNAME}
+
Modules are imported automatically
Check Test Case ${TESTNAME}
@@ -36,6 +39,9 @@ Explicit modules can override builtins
Explicit modules used in lambda
Check Test Case ${TESTNAME}
+Evaluation namespace is mutable
+ Check Test Case ${TESTNAME}
+
Custom namespace
Check Test Case ${TESTNAME}
@@ -102,11 +108,17 @@ Invalid $ usage
Evaluate Empty
Check Test Case ${TESTNAME}
-Evaluate Nonstring
+Evaluate Non-string
Check Test Case ${TESTNAME}
Evaluate doesn't see module globals
Check Test Case ${TESTNAME}
+Automatic variables are seen in expression part of comprehensions only with Python 3.12+
+ Check Test Case ${TESTNAME}
+
+Automatic variables are not seen inside lambdas
+ Check Test Case ${TESTNAME}
+
Evaluation errors can be caught
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/fail.robot b/atest/robot/standard_libraries/builtin/fail.robot
index 5076fb2fe28..c78ede1bbe6 100644
--- a/atest/robot/standard_libraries/builtin/fail.robot
+++ b/atest/robot/standard_libraries/builtin/fail.robot
@@ -5,45 +5,51 @@ Resource atest_resource.robot
*** Test Cases ***
Fail
${tc}= Check Test Tags ${TESTNAME} force1 force2
- Length Should Be ${tc.kws[0].msgs} 1
+ Length Should Be ${tc[0].body} 1
-Fail With Message
+Fail with message
${tc}= Check Test Tags ${TESTNAME} force1 force2
- Length Should Be ${tc.kws[0].msgs} 1
+ Length Should Be ${tc[0].body} 1
+
+Fail with non-string message
+ Check Test Case ${TESTNAME}
+
+Fail with non-true message having non-empty string representation
+ Check Test Case ${TESTNAME}
Set one tag
${tc}= Check Test Tags ${TESTNAME} force1 force2 tag
- Length Should Be ${tc.kws[0].msgs} 2
- Check Log Message ${tc.kws[0].msgs[0]} Set tag 'tag'.
+ Length Should Be ${tc[0].body} 2
+ Check Log Message ${tc[0, 0]} Set tag 'tag'.
Set multiple tags
${tc}= Check Test Tags ${TESTNAME} force1 force2 tag1 tag2
- Length Should Be ${tc.kws[0].msgs} 2
- Check Log Message ${tc.kws[0].msgs[0]} Set tags 'tag1' and 'tag2'.
+ Length Should Be ${tc[0].body} 2
+ Check Log Message ${tc[0, 0]} Set tags 'tag1' and 'tag2'.
Remove one tag
${tc}= Check Test Tags ${TESTNAME} force2
- Length Should Be ${tc.kws[0].msgs} 2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force1'.
+ Length Should Be ${tc[0].body} 2
+ Check Log Message ${tc[0, 0]} Removed tag 'force1'.
Remove multiple tags
${tc}= Check Test Tags ${TESTNAME}
- Length Should Be ${tc.kws[0].msgs} 2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tags 'force1' and 'force2'.
+ Length Should Be ${tc[0].body} 2
+ Check Log Message ${tc[0, 0]} Removed tags 'force1' and 'force2'.
Remove multiple tags with pattern
${tc}= Check Test Tags ${TESTNAME}
- Length Should Be ${tc.kws[0].msgs} 2
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force?'.
+ Length Should Be ${tc[0].body} 2
+ Check Log Message ${tc[0, 0]} Removed tag 'force?'.
Set and remove tags
${tc}= Check Test Tags ${TESTNAME} force2 tag1 tag2
- Length Should Be ${tc.kws[0].msgs} 3
- Check Log Message ${tc.kws[0].msgs[0]} Removed tags 'force1' and 'nonEx'.
- Check Log Message ${tc.kws[0].msgs[1]} Set tags 'tag1' and 'tag2'.
+ Length Should Be ${tc[0].body} 3
+ Check Log Message ${tc[0, 0]} Removed tags 'force1' and 'nonEx'.
+ Check Log Message ${tc[0, 1]} Set tags 'tag1' and 'tag2'.
Set tags should not be removed
${tc}= Check Test Tags ${TESTNAME} fii foo
- Length Should Be ${tc.kws[0].msgs} 3
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'f*'.
- Check Log Message ${tc.kws[0].msgs[1]} Set tags 'foo' and 'fii'.
+ Length Should Be ${tc[0].body} 3
+ Check Log Message ${tc[0, 0]} Removed tag 'f*'.
+ Check Log Message ${tc[0, 1]} Set tags 'foo' and 'fii'.
diff --git a/atest/robot/standard_libraries/builtin/fatal_error.robot b/atest/robot/standard_libraries/builtin/fatal_error.robot
index a840ddb8f20..009dcd947f3 100644
--- a/atest/robot/standard_libraries/builtin/fatal_error.robot
+++ b/atest/robot/standard_libraries/builtin/fatal_error.robot
@@ -10,4 +10,4 @@ Subsequent tests are not executed after `Fatal Error` keyword has been used
Check Test Case ${TESTNAME}
Suite teardown is executed after `Fatal Error` keyword
- Check Log Message ${SUITE.teardown.msgs[0]} AssertionError FAIL
+ Check Log Message ${SUITE.teardown[0]} AssertionError FAIL
diff --git a/atest/robot/standard_libraries/builtin/keyword_should_exist.robot b/atest/robot/standard_libraries/builtin/keyword_should_exist.robot
index 481c5491150..e751828b6fe 100644
--- a/atest/robot/standard_libraries/builtin/keyword_should_exist.robot
+++ b/atest/robot/standard_libraries/builtin/keyword_should_exist.robot
@@ -3,7 +3,6 @@ Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/keyword_should_e
Resource atest_resource.robot
*** Test Cases ***
-
Library keyword exists with short name
Check Test Case ${TESTNAME}
@@ -31,6 +30,9 @@ Keyword does not exist
Keyword does not exist with custom message
Check Test Case ${TESTNAME}
+Recommendations not shown if keyword does not exist
+ Check Test Case ${TESTNAME}
+
Duplicate keywords
Check Test Case ${TESTNAME}
@@ -45,4 +47,3 @@ Empty keyword name
Non-string keyword name
Check Test Case ${TESTNAME}
-
diff --git a/atest/robot/standard_libraries/builtin/length.robot b/atest/robot/standard_libraries/builtin/length.robot
index ce90b08a30c..dd140f810b7 100644
--- a/atest/robot/standard_libraries/builtin/length.robot
+++ b/atest/robot/standard_libraries/builtin/length.robot
@@ -5,19 +5,19 @@ Resource builtin_resource.robot
*** Test Cases ***
Get Length
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Length is 0
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} Length is 1
- Check Log Message ${tc.kws[2].kws[0].msgs[0]} Length is 2
- Check Log Message ${tc.kws[3].kws[0].msgs[0]} Length is 3
- Check Log Message ${tc.kws[4].kws[0].msgs[0]} Length is 11
- Check Log Message ${tc.kws[5].kws[0].msgs[0]} Length is 0
+ Check Log Message ${tc[0, 0, 0]} Length is 0.
+ Check Log Message ${tc[1, 0, 0]} Length is 1.
+ Check Log Message ${tc[2, 0, 0]} Length is 2.
+ Check Log Message ${tc[3, 0, 0]} Length is 3.
+ Check Log Message ${tc[4, 0, 0]} Length is 11.
+ Check Log Message ${tc[5, 0, 0]} Length is 0.
Length Should Be
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[-1].msgs[0]} Length is 2
- Check Log Message ${tc.kws[-1].msgs[1]} Length of '*' should be 3 but is 2. FAIL pattern=yep
- Check Log Message ${tc.kws[-1].msgs[2]} Traceback* DEBUG pattern=yep
- Length Should Be ${tc.kws[-1].msgs} 3
+ Check Log Message ${tc[-1, 0]} Length is 2.
+ Check Log Message ${tc[-1, 1]} Length of '*' should be 3 but is 2. FAIL pattern=yep
+ Check Log Message ${tc[-1, 2]} Traceback* DEBUG pattern=yep
+ Length Should Be ${tc[-1].body} 3
Length Should Be with custom message
Check Test Case ${TESTNAME}
@@ -26,25 +26,43 @@ Length Should Be with invalid length
Check Test Case ${TESTNAME}
Should Be Empty
- Check test case ${TESTNAME} 1
- Check test case ${TESTNAME} 2
- Check test case ${TESTNAME} 3
+ Check Test Case ${TESTNAME} 1
+ Check Test Case ${TESTNAME} 2
+ Check Test Case ${TESTNAME} 3
Should Be Empty with custom message
- Check test case ${TESTNAME}
+ Check Test Case ${TESTNAME}
Should Not Be Empty
- Check test case ${TESTNAME} 1
- Check test case ${TESTNAME} 2
+ Check Test Case ${TESTNAME} 1
+ Check Test Case ${TESTNAME} 2
Should Not Be Empty with custom message
- Check test case ${TESTNAME}
+ Check Test Case ${TESTNAME}
+
+Getting length with `length` method is deprecated
+ ${tc} = Check Test Case ${TESTNAME}
+ Check custom length deprecation ${tc[0, 0]} item.length() 40
+ Check custom length deprecation ${tc[1]} item.length() 40
+ Check custom length deprecation ${tc[2]} item.length() 40
+ Check custom length deprecation ${tc[3]} item.length() 40
-Getting length with `length` method
- Check test case ${TESTNAME}
+Getting length with `size` method is deprecated
+ ${tc} = Check Test Case ${TESTNAME}
+ Check custom length deprecation ${tc[0, 0]} item.size() 41
+ Check custom length deprecation ${tc[1]} item.size() 41
+ Check custom length deprecation ${tc[2]} item.size() 41
+ Check custom length deprecation ${tc[3]} item.size() 41
-Getting length with `size` method
- Check test case ${TESTNAME}
+Getting length with `length` attribute is deprecated
+ ${tc} = Check Test Case ${TESTNAME}
+ Check custom length deprecation ${tc[0, 0]} item.length 42
+ Check custom length deprecation ${tc[1]} item.length 42
+ Check custom length deprecation ${tc[2]} item.length 42
+ Check custom length deprecation ${tc[3]} item.length 42
-Getting length with `length` attribute
- Check test case ${TESTNAME}
+*** Keywords ***
+Check custom length deprecation
+ [Arguments] ${kw} ${deprecated} ${length}
+ Check Log Message ${kw[0]} Using '${deprecated}' for getting object length is deprecated. Only 'len(obj)' will be supported in the future. WARN
+ Check Log Message ${kw[1]} Length is ${length}.
diff --git a/atest/robot/standard_libraries/builtin/listener_printing_start_end_kw.py b/atest/robot/standard_libraries/builtin/listener_printing_start_end_kw.py
index 9a91451a5bc..a4431f0123e 100644
--- a/atest/robot/standard_libraries/builtin/listener_printing_start_end_kw.py
+++ b/atest/robot/standard_libraries/builtin/listener_printing_start_end_kw.py
@@ -1,14 +1,13 @@
import sys
-
ROBOT_LISTENER_API_VERSION = 2
def start_keyword(name, attrs):
- sys.stdout.write('start keyword %s\n' % name)
- sys.stderr.write('start keyword %s\n' % name)
+ sys.stdout.write(f"start keyword {name}\n")
+ sys.stderr.write(f"start keyword {name}\n")
def end_keyword(name, attrs):
- sys.stdout.write('end keyword %s\n' % name)
- sys.stderr.write('end keyword %s\n' % name)
+ sys.stdout.write(f"end keyword {name}\n")
+ sys.stderr.write(f"end keyword {name}\n")
diff --git a/atest/robot/standard_libraries/builtin/listener_using_builtin.py b/atest/robot/standard_libraries/builtin/listener_using_builtin.py
index 07b83c0001c..22fe1ba767d 100644
--- a/atest/robot/standard_libraries/builtin/listener_using_builtin.py
+++ b/atest/robot/standard_libraries/builtin/listener_using_builtin.py
@@ -5,5 +5,5 @@
def start_keyword(*args):
- if BIN.get_variables()['${TESTNAME}'] == 'Listener Using BuiltIn':
- BIN.set_test_variable('${SET BY LISTENER}', 'quux')
+ if BIN.get_variables()["${TESTNAME}"] == "Listener Using BuiltIn":
+ BIN.set_test_variable("${SET BY LISTENER}", "quux")
diff --git a/atest/robot/standard_libraries/builtin/log.robot b/atest/robot/standard_libraries/builtin/log.robot
index 10ae859f4f1..8b0207dde7f 100644
--- a/atest/robot/standard_libraries/builtin/log.robot
+++ b/atest/robot/standard_libraries/builtin/log.robot
@@ -8,182 +8,199 @@ ${HTML} Robot Framework
*** Test Cases ***
Log
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Hello, world!
- Check Log Message ${tc.kws[1].msgs[0]} 42
- Check Log Message ${tc.kws[2].msgs[0]} None
- Check Log Message ${tc.kws[3].msgs[0]} String presentation of MyObject
+ Check Log Message ${tc[0, 0]} Hello, world!
+ Check Log Message ${tc[1, 0]} 42
+ Check Log Message ${tc[2, 0]} None
+ Check Log Message ${tc[3, 0]} String presentation of MyObject
Log with different levels
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[1]} Log says: Hello from tests! INFO
- Check Log Message ${tc.kws[1].msgs[1]} Trace level TRACE
- Check Log Message ${tc.kws[2].msgs[1]} Debug level DEBUG
- Check Log Message ${tc.kws[3].msgs[1]} Info level INFO
- Check Log Message ${tc.kws[4].msgs[1]} Warn level WARN
- Check Log Message ${tc.kws[5].msgs[1]} Error level ERROR
- Check Log Message ${ERRORS[0]} Warn level WARN
- Check Log Message ${ERRORS[1]} Error level ERROR
- Length Should Be ${ERRORS} 4 # Two deprecation warnings from `repr`.
+ Check Log Message ${tc[0, 1]} Log says: Hello from tests! INFO
+ Check Log Message ${tc[1, 1]} Trace level TRACE
+ Check Log Message ${tc[2, 1]} Debug level DEBUG
+ Check Log Message ${tc[3, 1]} Info level INFO
+ Check Log Message ${tc[4, 1]} Warn level WARN
+ Check Log Message ${tc[5, 1]} Error level ERROR
+ Check Log Message ${ERRORS[0]} Warn level WARN
+ Check Log Message ${ERRORS[1]} Error level ERROR
Invalid log level failure is catchable
Check Test Case ${TEST NAME}
HTML is escaped by default
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} not bold
- Check Log Message ${tc.kws[1].msgs[0]} ${HTML}
+ Check Log Message ${tc[0, 0]} not bold
+ Check Log Message ${tc[1, 0]} ${HTML}
HTML pseudo level
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} bold html=True
- Check Log Message ${tc.kws[1].msgs[0]} ${HTML} html=True
+ Check Log Message ${tc[0, 0]} bold html=True
+ Check Log Message ${tc[1, 0]} ${HTML} html=True
Explicit HTML
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} bold html=True
- Check Log Message ${tc.kws[1].msgs[0]} ${HTML} DEBUG html=True
- Check Log Message ${tc.kws[2].msgs[0]} ${HTML} DEBUG
+ Check Log Message ${tc[0, 0]} bold html=True
+ Check Log Message ${tc[1, 0]} ${HTML} DEBUG html=True
+ Check Log Message ${tc[2, 0]} ${HTML} DEBUG
FAIL is not valid log level
Check Test Case ${TEST NAME}
Log also to console
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Hello, console!
- Check Log Message ${tc.kws[1].msgs[0]} ${HTML} DEBUG html=True
+ Check Log Message ${tc[0, 0]} Hello, console!
+ Check Log Message ${tc[1, 0]} ${HTML} DEBUG html=True
Stdout Should Contain Hello, console!\n
Stdout Should Contain ${HTML}\n
+Disable logging to console
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} WARN but no console WARN
+ Check Log Message ${tc[1, 0]} ERROR but no console ERROR
+ Check Log Message ${ERRORS[2]} WARN but no console WARN
+ Check Log Message ${ERRORS[3]} ERROR but no console ERROR
+ Stdout Should Not Contain no console
+ Stderr Should Not Contain no console
+
+CONSOLE pseudo level
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Hello, info and console!
+ Stdout Should Contain Hello, info and console!\n
+
repr=True
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} The 'repr' argument of 'BuiltIn.Log' is deprecated. Use 'formatter=repr' instead. WARN
- Check Log Message ${tc.kws[0].msgs[1]} Nothing special here
- Check Log Message ${tc.kws[1].msgs[0]} The 'repr' argument of 'BuiltIn.Log' is deprecated. Use 'formatter=repr' instead. WARN
- Check Log Message ${tc.kws[1].msgs[1]} 'Hyvää yötä ☃!'
+ Check Log Message ${tc[0, 0]} The 'repr' argument of 'BuiltIn.Log' is deprecated. Use 'formatter=repr' instead. WARN
+ Check Log Message ${tc[0, 1]} Nothing special here
+ Check Log Message ${tc[1, 0]} The 'repr' argument of 'BuiltIn.Log' is deprecated. Use 'formatter=repr' instead. WARN
+ Check Log Message ${tc[1, 1]} 'Hyvää yötä ☃!'
formatter=repr
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} 'Nothing special here'
- Check Log Message ${tc.kws[1].msgs[0]} 'Hyvää yötä ☃!'
- Check Log Message ${tc.kws[2].msgs[0]} 42 DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} b'\\x00abc\\xff (formatter=repr)'
- Check Log Message ${tc.kws[6].msgs[0]} 'hyvä'
+ Check Log Message ${tc[0, 0]} 'Nothing special here'
+ Check Log Message ${tc[1, 0]} 'Hyvää yötä ☃!'
+ Check Log Message ${tc[2, 0]} 42 DEBUG
+ Check Log Message ${tc[4, 0]} b'\\x00abc\\xff (formatter=repr)'
+ Check Log Message ${tc[6, 0]} 'hyvä'
Stdout Should Contain b'\\x00abc\\xff (formatter=repr)'
formatter=ascii
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} 'Nothing special here'
- Check Log Message ${tc.kws[1].msgs[0]} 'Hyv\\xe4\\xe4 y\\xf6t\\xe4 \\u2603!'
- Check Log Message ${tc.kws[2].msgs[0]} 42 DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} b'\\x00abc\\xff (formatter=ascii)'
- Check Log Message ${tc.kws[6].msgs[0]} 'hyva\\u0308'
+ Check Log Message ${tc[0, 0]} 'Nothing special here'
+ Check Log Message ${tc[1, 0]} 'Hyv\\xe4\\xe4 y\\xf6t\\xe4 \\u2603!'
+ Check Log Message ${tc[2, 0]} 42 DEBUG
+ Check Log Message ${tc[4, 0]} b'\\x00abc\\xff (formatter=ascii)'
+ Check Log Message ${tc[6, 0]} 'hyva\\u0308'
Stdout Should Contain b'\\x00abc\\xff (formatter=ascii)'
formatter=str
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Nothing special here
- Check Log Message ${tc.kws[1].msgs[0]} Hyvää yötä ☃!
- Check Log Message ${tc.kws[2].msgs[0]} 42 DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} abc\\xff (formatter=str)
- Check Log Message ${tc.kws[6].msgs[0]} hyvä
- Stdout Should Contain abc\\xff (formatter=str)
+ Check Log Message ${tc[0, 0]} Nothing special here
+ Check Log Message ${tc[1, 0]} Hyvää yötä ☃!
+ Check Log Message ${tc[2, 0]} 42 DEBUG
+ Check Log Message ${tc[4, 0]} abc\xff (formatter=str)
+ Check Log Message ${tc[6, 0]} hyvä
+ Stdout Should Contain abc\xff (formatter=str)
formatter=repr pretty prints
${tc} = Check Test Case ${TEST NAME}
${long string} = Evaluate ' '.join(['Robot Framework'] * 1000)
- ${small dict} = Set Variable {3: b'items', 'a': 'sorted', 'small': 'dict'}
+ ${small dict} = Set Variable {'small': 'dict', 3: b'items', 'NOT': 'sorted'}
${small list} = Set Variable ['small', b'list', 'not sorted', 4]
- Check Log Message ${tc.kws[1].msgs[0]} '${long string}'
- Check Log Message ${tc.kws[3].msgs[0]} ${small dict}
- Check Log Message ${tc.kws[5].msgs[0]} {'big': 'dict',\n\ 'list': [1, 2, 3],\n\ 'long': '${long string}',\n\ 'nested': ${small dict}}
- Check Log Message ${tc.kws[7].msgs[0]} ${small list}
- Check Log Message ${tc.kws[9].msgs[0]} ['big',\n\ 'list',\n\ '${long string}',\n\ b'${long string}',\n\ ['nested', ('tuple', 2)],\n\ ${small dict}]
- Check Log Message ${tc.kws[11].msgs[0]} ['hyvä', b'hyv\\xe4', {'☃': b'\\x00\\xff'}]
+ Check Log Message ${tc[1, 0]} '${long string}'
+ Check Log Message ${tc[3, 0]} ${small dict}
+ Check Log Message ${tc[5, 0]} {'big': 'dict',\n 'long': '${long string}',\n 'nested': ${small dict},\n 'list': [1, 2, 3],\n 'sorted': False}
+ Check Log Message ${tc[7, 0]} ${small list}
+ Check Log Message ${tc[9, 0]} ['big',\n 'list',\n '${long string}',\n b'${long string}',\n ['nested', ('tuple', 2)],\n ${small dict}]
+ Check Log Message ${tc[11, 0]} ['hyvä', b'hyv\\xe4', {'☃': b'\\x00\\xff'}]
Stdout Should Contain ${small dict}
Stdout Should Contain ${small list}
formatter=len
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} 20
- Check Log Message ${tc.kws[1].msgs[0]} 13 DEBUG
- Check Log Message ${tc.kws[3].msgs[0]} 21
- Check Log Message ${tc.kws[5].msgs[0]} 5
+ Check Log Message ${tc[0, 0]} 20
+ Check Log Message ${tc[1, 0]} 13 DEBUG
+ Check Log Message ${tc[3, 0]} 21
+ Check Log Message ${tc[5, 0]} 5
formatter=type
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} str
- Check Log Message ${tc.kws[1].msgs[0]} str
- Check Log Message ${tc.kws[2].msgs[0]} int DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} bytes
- Check Log Message ${tc.kws[6].msgs[0]} datetime
+ Check Log Message ${tc[0, 0]} str
+ Check Log Message ${tc[1, 0]} str
+ Check Log Message ${tc[2, 0]} int DEBUG
+ Check Log Message ${tc[4, 0]} bytes
+ Check Log Message ${tc[6, 0]} datetime
formatter=invalid
Check Test Case ${TEST NAME}
Log callable
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} *objects_for_call_method.MyObject* pattern=yes
- Check Log Message ${tc.kws[2].msgs[0]} at *> pattern=yes
+ Check Log Message ${tc[0, 0]} *objects_for_call_method.MyObject* pattern=yes
+ Check Log Message ${tc[2, 0]} at *> pattern=yes
Log Many
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Log Many says:
- Check Log Message ${tc.kws[0].msgs[1]} 1
- Check Log Message ${tc.kws[0].msgs[2]} 2
- Check Log Message ${tc.kws[0].msgs[3]} 3
- Check Log Message ${tc.kws[0].msgs[4]} String presentation of MyObject
- Check Log Message ${tc.kws[1].msgs[0]} Log Many says: Hi!!
- Check Log Message ${tc.kws[2].msgs[0]} 1
- Check Log Message ${tc.kws[2].msgs[1]} 2
- Check Log Message ${tc.kws[2].msgs[2]} 3
- Check Log Message ${tc.kws[2].msgs[3]} String presentation of MyObject
- Should Be Empty ${tc.kws[3].msgs}
- Should Be Empty ${tc.kws[4].msgs}
- Check Log Message ${tc.kws[5].msgs[0]} --
- Check Log Message ${tc.kws[5].msgs[1]} -[]-
- Check Log Message ${tc.kws[5].msgs[2]} -{}-
- Check Log Message ${tc.kws[6].msgs[0]} 1
- Check Log Message ${tc.kws[6].msgs[1]} 2
+ Check Log Message ${tc[0, 0]} Log Many says:
+ Check Log Message ${tc[0, 1]} 1
+ Check Log Message ${tc[0, 2]} 2
+ Check Log Message ${tc[0, 3]} 3
+ Check Log Message ${tc[0, 4]} String presentation of MyObject
+ Check Log Message ${tc[1, 0]} Log Many says: Hi!!
+ Check Log Message ${tc[2, 0]} 1
+ Check Log Message ${tc[2, 1]} 2
+ Check Log Message ${tc[2, 2]} 3
+ Check Log Message ${tc[2, 3]} String presentation of MyObject
+ Should Be Empty ${tc[3].body}
+ Should Be Empty ${tc[4].body}
+ Check Log Message ${tc[5, 0]} preserve
+ Check Log Message ${tc[5, 1]} ${EMPTY}
+ Check Log Message ${tc[5, 2]} empty
+ Check Log Message ${tc[5, 3]} ${EMPTY}
+ Check Log Message ${tc[6, 0]} --
+ Check Log Message ${tc[6, 1]} -[]-
+ Check Log Message ${tc[6, 2]} -{}-
+ Check Log Message ${tc[7, 0]} 1
+ Check Log Message ${tc[7, 1]} 2
Log Many with named and dict arguments
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} a=1
- Check Log Message ${tc.kws[0].msgs[1]} b=2
- Check Log Message ${tc.kws[0].msgs[2]} 3=c
- Check Log Message ${tc.kws[0].msgs[3]} obj=String presentation of MyObject
- Check Log Message ${tc.kws[1].msgs[0]} a=1
- Check Log Message ${tc.kws[1].msgs[1]} b=2
- Check Log Message ${tc.kws[1].msgs[2]} 3=c
- Check Log Message ${tc.kws[1].msgs[3]} obj=String presentation of MyObject
- Check Log Message ${tc.kws[2].msgs[0]} a=1
- Check Log Message ${tc.kws[2].msgs[1]} b=2
- Check Log Message ${tc.kws[2].msgs[2]} 3=c
- Check Log Message ${tc.kws[2].msgs[3]} obj=String presentation of MyObject
- Check Log Message ${tc.kws[2].msgs[4]} b=no override
- Check Log Message ${tc.kws[2].msgs[5]} 3=three
+ Check Log Message ${tc[0, 0]} a=1
+ Check Log Message ${tc[0, 1]} b=2
+ Check Log Message ${tc[0, 2]} 3=c
+ Check Log Message ${tc[0, 3]} obj=String presentation of MyObject
+ Check Log Message ${tc[1, 0]} a=1
+ Check Log Message ${tc[1, 1]} b=2
+ Check Log Message ${tc[1, 2]} 3=c
+ Check Log Message ${tc[1, 3]} obj=String presentation of MyObject
+ Check Log Message ${tc[2, 0]} a=1
+ Check Log Message ${tc[2, 1]} b=2
+ Check Log Message ${tc[2, 2]} 3=c
+ Check Log Message ${tc[2, 3]} obj=String presentation of MyObject
+ Check Log Message ${tc[2, 4]} b=no override
+ Check Log Message ${tc[2, 5]} 3=three
Log Many with positional, named and dict arguments
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} 1
- Check Log Message ${tc.kws[0].msgs[1]} 2
- Check Log Message ${tc.kws[0].msgs[2]} three=3
- Check Log Message ${tc.kws[0].msgs[3]} 4=four
- Check Log Message ${tc.kws[1].msgs[0]} 1
- Check Log Message ${tc.kws[1].msgs[1]} 2
- Check Log Message ${tc.kws[1].msgs[2]} 3
- Check Log Message ${tc.kws[1].msgs[3]} String presentation of MyObject
- Check Log Message ${tc.kws[1].msgs[4]} a=1
- Check Log Message ${tc.kws[1].msgs[5]} b=2
- Check Log Message ${tc.kws[1].msgs[6]} 3=c
- Check Log Message ${tc.kws[1].msgs[7]} obj=String presentation of MyObject
- Check Log Message ${tc.kws[1].msgs[8]} 1
- Check Log Message ${tc.kws[1].msgs[9]} 2
- Check Log Message ${tc.kws[1].msgs[10]} 3
- Check Log Message ${tc.kws[1].msgs[11]} String presentation of MyObject
- Check Log Message ${tc.kws[1].msgs[12]} a=1
- Check Log Message ${tc.kws[1].msgs[13]} b=2
- Check Log Message ${tc.kws[1].msgs[14]} 3=c
- Check Log Message ${tc.kws[1].msgs[15]} obj=String presentation of MyObject
+ Check Log Message ${tc[0, 0]} 1
+ Check Log Message ${tc[0, 1]} 2
+ Check Log Message ${tc[0, 2]} three=3
+ Check Log Message ${tc[0, 3]} 4=four
+ Check Log Message ${tc[1, 0]} 1
+ Check Log Message ${tc[1, 1]} 2
+ Check Log Message ${tc[1, 2]} 3
+ Check Log Message ${tc[1, 3]} String presentation of MyObject
+ Check Log Message ${tc[1, 4]} a=1
+ Check Log Message ${tc[1, 5]} b=2
+ Check Log Message ${tc[1, 6]} 3=c
+ Check Log Message ${tc[1, 7]} obj=String presentation of MyObject
+ Check Log Message ${tc[1, 8]} 1
+ Check Log Message ${tc[1, 9]} 2
+ Check Log Message ${tc[1, 10]} 3
+ Check Log Message ${tc[1, 11]} String presentation of MyObject
+ Check Log Message ${tc[1, 12]} a=1
+ Check Log Message ${tc[1, 13]} b=2
+ Check Log Message ${tc[1, 14]} 3=c
+ Check Log Message ${tc[1, 15]} obj=String presentation of MyObject
Log Many with non-existing variable
Check Test Case ${TEST NAME}
@@ -197,7 +214,7 @@ Log Many with dict variable containing non-dict
Log To Console
${tc} = Check Test Case ${TEST NAME}
FOR ${i} IN RANGE 4
- Should Be Empty ${tc.kws[${i}].msgs}
+ Should Be Empty ${tc[${i}].body}
END
Stdout Should Contain stdout äö w/ newline\n
Stdout Should Contain stdout äö w/o new......line äö
diff --git a/atest/robot/standard_libraries/builtin/log_variables.robot b/atest/robot/standard_libraries/builtin/log_variables.robot
index 5da8636f347..3d58d5affbb 100644
--- a/atest/robot/standard_libraries/builtin/log_variables.robot
+++ b/atest/robot/standard_libraries/builtin/log_variables.robot
@@ -5,7 +5,7 @@ Resource atest_resource.robot
*** Test Cases ***
Log Variables In Suite Setup
- Set Test Variable ${KW} ${SUITE.setup.body[7]}
+ Set Test Variable ${KW} ${SUITE.setup[7]}
Set Test Variable ${INDEX} ${0}
Check Variable Message \${/} = * pattern=yes
Check Variable Message \${:} = ${:}
@@ -15,14 +15,16 @@ Log Variables In Suite Setup
Check Variable Message \${cli_var_3} = CLI3
Check Variable Message \${DEBUG_FILE} = NONE
Check Variable Message \&{DICT} = { key=value | two=2 }
+ Check Variable Message \${ENDLESS} = repeat('RF')
Check Variable Message \${EXECDIR} = * pattern=yes
Check Variable Message \${False} = * pattern=yes
+ Check Variable Message \${ITERABLE} = at 0x*> pattern=yes
Check Variable Message \@{LIST} = [ Hello | world ]
Check Variable Message \${LOG_FILE} = NONE
Check Variable Message \${LOG_LEVEL} = INFO
Check Variable Message \${None} = None
Check Variable Message \${null} = None
- Check Variable Message \&{OPTIONS} = { include=[] | exclude=[] | skip=[] | skip_on_failure=[] }
+ Check Variable Message \&{OPTIONS} = { rpa=False | include=[] | exclude=[] | skip=[] | skip_on_failure=[] | console_width=78 }
Check Variable Message \${OUTPUT_DIR} = * pattern=yes
Check Variable Message \${OUTPUT_FILE} = * pattern=yes
Check Variable Message \${PREV_TEST_MESSAGE} =
@@ -42,11 +44,11 @@ Log Variables In Suite Setup
Check Variable Message \${SUITE_SOURCE} = * pattern=yes
Check Variable Message \${TEMPDIR} = * pattern=yes
Check Variable Message \${True} = * pattern=yes
- Should Be Equal As Integers ${kw.message_count} 35 Wrong total message count
+ Length Should Be ${kw.messages} 37
Log Variables In Test
${test} = Check Test Case Log Variables
- Set Test Variable ${KW} ${test.body[0]}
+ Set Test Variable ${KW} ${test[0]}
Set Test Variable ${INDEX} ${1}
Check Variable Message \${/} = * pattern=yes
Check Variable Message \${:} = ${:}
@@ -56,14 +58,16 @@ Log Variables In Test
Check Variable Message \${cli_var_3} = CLI3
Check Variable Message \${DEBUG_FILE} = NONE
Check Variable Message \&{DICT} = { key=value | two=2 }
+ Check Variable Message \${ENDLESS} = repeat('RF')
Check Variable Message \${EXECDIR} = * pattern=yes
Check Variable Message \${False} = * pattern=yes
+ Check Variable Message \${ITERABLE} = at 0x*> pattern=yes
Check Variable Message \@{LIST} = [ Hello | world ]
Check Variable Message \${LOG_FILE} = NONE
Check Variable Message \${LOG_LEVEL} = TRACE
Check Variable Message \${None} = None
Check Variable Message \${null} = None
- Check Variable Message \&{OPTIONS} = { include=[] | exclude=[] | skip=[] | skip_on_failure=[] }
+ Check Variable Message \&{OPTIONS} = { rpa=False | include=[] | exclude=[] | skip=[] | skip_on_failure=[] | console_width=78 }
Check Variable Message \${OUTPUT_DIR} = * pattern=yes
Check Variable Message \${OUTPUT_FILE} = * pattern=yes
Check Variable Message \${PREV_TEST_MESSAGE} =
@@ -85,11 +89,11 @@ Log Variables In Test
Check Variable Message \${TEST_NAME} = Log Variables
Check Variable Message \@{TEST_TAGS} = [ ]
Check Variable Message \${True} = * pattern=yes
- Should Be Equal As Integers ${kw.message_count} 39 Wrong total message count
+ Length Should Be ${kw.messages} 41
Log Variables After Setting New Variables
${test} = Check Test Case Log Variables
- Set Test Variable ${KW} ${test.body[4]}
+ Set Test Variable ${KW} ${test[4]}
Set Test Variable ${INDEX} ${1}
Check Variable Message \${/} = * DEBUG pattern=yes
Check Variable Message \${:} = ${:} DEBUG
@@ -99,16 +103,18 @@ Log Variables After Setting New Variables
Check Variable Message \${cli_var_3} = CLI3 DEBUG
Check Variable Message \${DEBUG_FILE} = NONE DEBUG
Check Variable Message \&{DICT} = { key=value | two=2 } DEBUG
+ Check Variable Message \${ENDLESS} = repeat('RF') DEBUG
Check Variable Message \${EXECDIR} = * DEBUG pattern=yes
Check Variable Message \${False} = * DEBUG pattern=yes
Check Variable Message \@{int_list_1} = [ 0 | 1 | 2 | 3 ] DEBUG
Check Variable Message \@{int_list_2} = [ 0 | 1 | 2 | 3 ] DEBUG
+ Check Variable Message \${ITERABLE} = at 0x*> DEBUG pattern=yes
Check Variable Message \@{LIST} = [ Hello | world ] DEBUG
Check Variable Message \${LOG_FILE} = NONE DEBUG
Check Variable Message \${LOG_LEVEL} = TRACE DEBUG
Check Variable Message \${None} = None DEBUG
Check Variable Message \${null} = None DEBUG
- Check Variable Message \&{OPTIONS} = { include=[] | exclude=[] | skip=[] | skip_on_failure=[] } DEBUG
+ Check Variable Message \&{OPTIONS} = { rpa=False | include=[] | exclude=[] | skip=[] | skip_on_failure=[] | console_width=78 } DEBUG
Check Variable Message \${OUTPUT_DIR} = * DEBUG pattern=yes
Check Variable Message \${OUTPUT_FILE} = * DEBUG pattern=yes
Check Variable Message \${PREV_TEST_MESSAGE} = DEBUG
@@ -131,11 +137,11 @@ Log Variables After Setting New Variables
Check Variable Message \@{TEST_TAGS} = [ ] DEBUG
Check Variable Message \${True} = * DEBUG pattern=yes
Check Variable Message \${var} = Hello DEBUG
- Should Be Equal As Integers ${kw.message_count} 42 Wrong total message count
+ Length Should Be ${kw.messages} 44
Log Variables In User Keyword
${test} = Check Test Case Log Variables
- Set Test Variable ${KW} ${test.body[5].body[2]}
+ Set Test Variable ${KW} ${test[5, 2]}
Set Test Variable ${INDEX} ${1}
Check Variable Message \${/} = * pattern=yes
Check Variable Message \${:} = ${:}
@@ -145,14 +151,16 @@ Log Variables In User Keyword
Check Variable Message \${cli_var_3} = CLI3
Check Variable Message \${DEBUG_FILE} = NONE
Check Variable Message \&{DICT} = { key=value | two=2 }
+ Check Variable Message \${ENDLESS} = repeat('RF')
Check Variable Message \${EXECDIR} = * pattern=yes
Check Variable Message \${False} = * pattern=yes
+ Check Variable Message \${ITERABLE} = at 0x*> pattern=yes
Check Variable Message \@{LIST} = [ Hello | world ]
Check Variable Message \${LOG_FILE} = NONE
Check Variable Message \${LOG_LEVEL} = TRACE
Check Variable Message \${None} = None
Check Variable Message \${null} = None
- Check Variable Message \&{OPTIONS} = { include=[] | exclude=[] | skip=[] | skip_on_failure=[] }
+ Check Variable Message \&{OPTIONS} = { rpa=False | include=[] | exclude=[] | skip=[] | skip_on_failure=[] | console_width=78 }
Check Variable Message \${OUTPUT_DIR} = * pattern=yes
Check Variable Message \${OUTPUT_FILE} = * pattern=yes
Check Variable Message \${PREV_TEST_MESSAGE} =
@@ -175,7 +183,7 @@ Log Variables In User Keyword
Check Variable Message \@{TEST_TAGS} = [ ]
Check Variable Message \${True} = * pattern=yes
Check Variable Message \${ukvar} = Value of an uk variable
- Should Be Equal As Integers ${kw.message_count} 40 Wrong total message count
+ Length Should Be ${kw.messages} 42
List and dict variables failing during iteration
Check Test Case ${TEST NAME}
@@ -183,5 +191,5 @@ List and dict variables failing during iteration
*** Keywords ***
Check Variable Message
[Arguments] ${expected} ${level}=INFO ${pattern}=
- Check Log Message ${KW.msgs[${INDEX}]} ${expected} ${level} pattern=${pattern}
+ Check Log Message ${KW[${INDEX}]} ${expected} ${level} pattern=${pattern}
Set Test Variable ${INDEX} ${INDEX + 1}
diff --git a/atest/robot/standard_libraries/builtin/misc.robot b/atest/robot/standard_libraries/builtin/misc.robot
index 38994c9afac..a7af9cba20c 100644
--- a/atest/robot/standard_libraries/builtin/misc.robot
+++ b/atest/robot/standard_libraries/builtin/misc.robot
@@ -11,9 +11,9 @@ Catenate
Comment
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.kws[0].msgs}
- Should Be Empty ${tc.kws[1].msgs}
- Should Be Empty ${tc.kws[2].msgs}
+ Should Be Empty ${tc[0].body}
+ Should Be Empty ${tc[1].body}
+ Should Be Empty ${tc[2].body}
Regexp Escape
Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/builtin/reload_library.robot b/atest/robot/standard_libraries/builtin/reload_library.robot
index 25cb84aad6a..97bf6e4d58e 100644
--- a/atest/robot/standard_libraries/builtin/reload_library.robot
+++ b/atest/robot/standard_libraries/builtin/reload_library.robot
@@ -5,12 +5,12 @@ Resource atest_resource.robot
*** Test Cases ***
Reload and add keyword
${tc}= Check Test Case ${TESTNAME}
- Check log message ${tc.kws[2].msgs[0]} Reloaded library Reloadable with 7 keywords.
+ Check log message ${tc[2, 0]} Reloaded library Reloadable with 7 keywords.
Reloading changes args
${tc}= Check Test Case ${TESTNAME}
- Should be equal ${tc.kws[0].doc} Doc for original 1 with args arg
- Should be equal ${tc.kws[3].doc} Doc for original 1 with args arg1, arg2
+ Should be equal ${tc[0].doc} Doc for original 1 with args arg
+ Should be equal ${tc[3].doc} Doc for original 1 with args arg1, arg2
Reloading can remove a keyword
Check Test Case ${TESTNAME}
@@ -32,8 +32,8 @@ Reloading None fails
Static library
${tc}= Check Test Case ${TESTNAME}
- Should be equal ${tc.kws[2].doc} This doc for static
+ Should be equal ${tc[2].doc} This doc for static
Module library
${tc}= Check Test Case ${TESTNAME}
- Should be equal ${tc.kws[3].doc} This doc for module
+ Should be equal ${tc[3].doc} This doc for module
diff --git a/atest/robot/standard_libraries/builtin/reload_with_name.robot b/atest/robot/standard_libraries/builtin/reload_with_name.robot
index 7b04683ff74..dcabc6ea7f6 100644
--- a/atest/robot/standard_libraries/builtin/reload_with_name.robot
+++ b/atest/robot/standard_libraries/builtin/reload_with_name.robot
@@ -5,7 +5,7 @@ Resource atest_resource.robot
*** Test Cases ***
Reload with name
${tc}= Check Test Case ${TESTNAME}
- Check log message ${tc.kws[1].msgs[0]} Reloaded library foo with 7 keywords.
+ Check log message ${tc[1, 0]} Reloaded library foo with 7 keywords.
Reload with instance
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/repeat_keyword.robot b/atest/robot/standard_libraries/builtin/repeat_keyword.robot
index c745e9c1b9d..b5076ebd262 100644
--- a/atest/robot/standard_libraries/builtin/repeat_keyword.robot
+++ b/atest/robot/standard_libraries/builtin/repeat_keyword.robot
@@ -5,27 +5,27 @@ Resource atest_resource.robot
*** Test Cases ***
Times As String
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages ${tc.kws[0]} 2 Hello, repeating world!
+ Check Repeated Messages ${tc[0]} 2 Hello, repeating world!
Times As Integer
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages ${tc.kws[0]} 42 This works too!!
+ Check Repeated Messages ${tc[0]} 42 This works too!!
Times With 'times' Postfix
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages ${tc.kws[0]} 3 This is done 3 times
- Check Repeated Messages ${tc.kws[1]} 2 Case and space insensitive
+ Check Repeated Messages ${tc[0]} 3 This is done 3 times
+ Check Repeated Messages ${tc[1]} 2 Case and space insensitive
Times With 'x' Postfix
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages ${tc.kws[0]} 10 Close to old repeating syntax
- Check Repeated Messages ${tc.kws[1]} 1 Case and space
+ Check Repeated Messages ${tc[0]} 10 Close to old repeating syntax
+ Check Repeated Messages ${tc[1]} 1 Case and space
Zero And Negative Times
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages ${tc.kws[0]} 0
- Check Repeated Messages ${tc.kws[2]} 0
- Check Repeated Messages ${tc.kws[3]} 0
+ Check Repeated Messages ${tc[0]} 0 name=This is not executed
+ Check Repeated Messages ${tc[1]} 0 name=\${nonex}
+ Check Repeated Messages ${tc[2]} 0 name=This is not executed
Invalid Times
Check Test Case Invalid Times 1
@@ -33,16 +33,20 @@ Invalid Times
Repeat Keyword With Time String
${tc} = Check Test Case ${TEST NAME}
- Check Repeated Messages With Time ${tc.kws[0]} This is done for 00:00:00.003
- Check Repeated Messages With Time ${tc.kws[1]} This is done for 3 milliseconds
- Check Repeated Messages With Time ${tc.kws[2]} This is done for 3ms
+ Check Repeated Messages With Time ${tc[0]} This is done for 00:00:00.003
+ Check Repeated Messages With Time ${tc[1]} This is done for 3 milliseconds
+ Check Repeated Messages With Time ${tc[2]} This is done for 3ms
+
+Repeat Keyword With `timedelta`
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Repeated Messages With Time ${tc[0]} This is done for `timedelta(milliseconds=3)`
Repeat Keyword Arguments As Variables
${tc} = Check Test Case ${TEST_NAME}
- Check Repeated Keyword Name ${tc.kws[1]} 2 BuiltIn.Should Be Equal
- Check Repeated Keyword Name ${tc.kws[3]} 42 BuiltIn.Should Be Equal
- Check Repeated Keyword Name ${tc.kws[5]} 10 BuiltIn.No Operation
- Check Repeated Keyword Name ${tc.kws[7]} 1 BuiltIn.Should Be Equal
+ Check Repeated Keyword Name ${tc[1]} 2 BuiltIn.Should Be Equal
+ Check Repeated Keyword Name ${tc[3]} 42 BuiltIn.Should Be Equal
+ Check Repeated Keyword Name ${tc[5]} 10 BuiltIn.No Operation
+ Check Repeated Keyword Name ${tc[7]} 1 BuiltIn.Should Be Equal
Repeated Keyword As Non-existing Variable
Check Test Case ${TEST_NAME}
@@ -56,44 +60,52 @@ Repeated Keyword Failing
Repeat Keyword With Continuable Failure
${tc} = Check Test Case ${TEST_NAME}
- Length Should Be ${tc.kws[0].kws} 3
+ Length Should Be ${tc[0].body} 6
+ Length Should Be ${tc[0].messages} 3
Repeat Keyword With Failure After Continuable Failure
${tc} = Check Test Case ${TEST_NAME}
- Length Should Be ${tc.kws[0].kws} 2
+ Length Should Be ${tc[0].body} 4
+ Length Should Be ${tc[0].messages} 2
Repeat Keyword With Pass Execution
${tc} = Check Test Case ${TEST_NAME}
- Length Should Be ${tc.kws[0].kws} 1
+ Length Should Be ${tc[0].body} 2
+ Length Should Be ${tc[0].messages} 1
Repeat Keyword With Pass Execution After Continuable Failure
${tc} = Check Test Case ${TEST_NAME}
- Length Should Be ${tc.kws[0].kws} 2
+ Length Should Be ${tc[0].body} 4
+ Length Should Be ${tc[0].messages} 2
*** Keywords ***
Check Repeated Messages
- [Arguments] ${kw} ${count} ${msg}=${None}
- Should Be Equal As Integers ${kw.kw_count} ${count}
- FOR ${i} IN RANGE ${count}
- Check Log Message ${kw.msgs[${i}]} Repeating keyword, round ${i+1}/${count}.
- Check Log Message ${kw.kws[${i}].msgs[0]} ${msg}
+ [Arguments] ${kw} ${rounds} ${msg}= ${name}=
+ IF ${rounds} == 0
+ Length Should Be ${kw.body} 1
+ Check Log Message ${kw[0]} Keyword '${name}' repeated zero times.
+ ELSE
+ Length Should Be ${kw.body} ${{int($rounds) * 2}}
+ Length Should Be ${kw.messages} ${rounds}
+ END
+ FOR ${i} IN RANGE ${rounds}
+ Check Log Message ${kw[${i * 2}]} Repeating keyword, round ${i+1}/${rounds}.
+ Check Log Message ${kw[${i * 2 + 1}, 0]} ${msg}
END
- Run Keyword If ${count} == 0 Check Log Message ${kw.msgs[0]} Keyword 'This is not executed' repeated zero times.
- Run Keyword If ${count} != 0 Should Be Equal As Integers ${kw.msg_count} ${count}
Check Repeated Messages With Time
[Arguments] ${kw} ${msg}=${None}
- Should Be True ${kw.kw_count} > 0
- FOR ${i} IN RANGE ${kw.kw_count}
- Check Log Message ${kw.msgs[${i}]}
+ Should Be True len($kw.body) / 2 == len($kw.messages) and len($kw.body) > 0
+ FOR ${i} IN RANGE ${{len($kw.messages)}}
+ Check Log Message ${kw[${i * 2}]}
... Repeating keyword, round ${i+1}, *remaining. pattern=yes
- Check Log Message ${kw.kws[${i}].msgs[0]} ${msg}
+ Check Log Message ${kw[${i * 2 + 1}, 0]} ${msg}
END
- Should Be Equal As Integers ${kw.msg_count} ${kw.kw_count}
+ Should Be Equal ${{len($kw.messages) * 2}} ${{len($kw.body)}}
Check Repeated Keyword Name
[Arguments] ${kw} ${count} ${name}=${None}
- Should Be Equal As Integers ${kw.kw_count} ${count}
- FOR ${i} IN RANGE ${count}
- Should Be Equal ${kw.kws[${i}].name} ${name}
+ Should Be True len($kw.body) / 2 == len($kw.messages) == ${count}
+ FOR ${i} IN RANGE 1 ${count} * 2 2
+ Should Be Equal ${kw[${i}].full_name} ${name}
END
diff --git a/atest/robot/standard_libraries/builtin/replace_variables.robot b/atest/robot/standard_libraries/builtin/replace_variables.robot
index 713bc7ff491..96c56e64235 100644
--- a/atest/robot/standard_libraries/builtin/replace_variables.robot
+++ b/atest/robot/standard_libraries/builtin/replace_variables.robot
@@ -1,8 +1,8 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/replace_variables.robot
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Replace Variables
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword.robot b/atest/robot/standard_libraries/builtin/run_keyword.robot
index 574fdaa98e6..b002afd32b2 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword.robot
@@ -4,52 +4,92 @@ Resource atest_resource.robot
*** Test Cases ***
Run Keyword
- ${tc} = Check test Case ${TEST NAME}
- Check Run Keyword ${tc.kws[0]} BuiltIn.Log This is logged with Run Keyword
- Check Keyword Data ${tc.kws[1].kws[0]} BuiltIn.No Operation
- Check Run Keyword ${tc.kws[2]} BuiltIn.Log Many 1 2 3 4 5
- Check Run Keyword ${tc.kws[4]} BuiltIn.Log Run keyword with variable: Log
- Check Run Keyword ${tc.kws[6]} BuiltIn.Log Many one two
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword ${tc[0]} BuiltIn.Log This is logged with Run Keyword
+ Check Keyword Data ${tc[1, 0]} BuiltIn.No Operation
+ Check Run Keyword ${tc[2]} BuiltIn.Log Many 1 2 3 4 5
+ Check Run Keyword ${tc[4]} BuiltIn.Log Run keyword with variable: Log
+ Check Run Keyword ${tc[6]} BuiltIn.Log Many one two
Run Keyword Returning Value
- ${tc} = Check test Case ${TEST NAME}
- Check Keyword Data ${tc.kws[0]} BuiltIn.Run Keyword \${ret} Set Variable, hello world
- Check Keyword Data ${tc.kws[0].kws[0]} BuiltIn.Set Variable args=hello world
- Check Keyword Data ${tc.kws[2]} BuiltIn.Run Keyword \${ret} Evaluate, 1+2
- Check Keyword Data ${tc.kws[2].kws[0]} BuiltIn.Evaluate args=1+2
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Keyword Data ${tc[0]} BuiltIn.Run Keyword \${ret} Set Variable, hello world
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Set Variable args=hello world
+ Check Keyword Data ${tc[2]} BuiltIn.Run Keyword \${ret} Evaluate, 1+2
+ Check Keyword Data ${tc[2, 0]} BuiltIn.Evaluate args=1+2
Run Keyword With Arguments That Needs To Be Escaped
- ${tc} = Check test Case ${TEST NAME}
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} c:\\temp\\foo
- Check Log Message ${tc.kws[1].kws[0].msgs[1]} \${notvar}
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[1, 0, 0]} c:\\temp\\foo
+ Check Log Message ${tc[1, 0, 1]} \${notvar}
Escaping Arguments From Opened List Variable
- ${tc} = Check test Case ${TEST NAME}
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} message=foo
- Check Log Message ${tc.kws[3].kws[0].msgs[0]} 42
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[1, 0, 0]} message=foo
+ Check Log Message ${tc[3, 0, 0]} 42
Run Keyword With UK
- ${tc} = Check test Case ${TEST NAME}
- Check Run Keyword In UK ${tc.kws[0]} BuiltIn.Log Using UK
- Check Run Keyword In UK ${tc.kws[1]} BuiltIn.Log Many yksi kaksi
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword In UK ${tc[0]} BuiltIn.Log Using UK
+ Check Run Keyword In UK ${tc[1]} BuiltIn.Log Many yksi kaksi
Run Keyword In Multiple Levels And With UK
- Check test Case ${TEST NAME}
+ Check Test Case ${TEST NAME}
+
+With keyword accepting embedded arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "arg" arg
+
+With library keyword accepting embedded arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "arg" in library arg
+
+With keyword accepting embedded arguments as variables
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "\${VARIABLE}" value
+ Check Run Keyword With Embedded Args ${tc[1]} Embedded "\${1}" 1
+
+With library keyword accepting embedded arguments as variables
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "\${VARIABLE}" in library value
+ Check Run Keyword With Embedded Args ${tc[1]} Embedded "\${1}" in library 1
+
+With keyword accepting embedded arguments as variables containing objects
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "\${OBJECT}" Robot
+ Check Run Keyword With Embedded Args ${tc[1]} Embedded object "\${OBJECT}" Robot
+
+With library keyword accepting embedded arguments as variables containing objects
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[0]} Embedded "\${OBJECT}" in library Robot
+ Check Run Keyword With Embedded Args ${tc[1]} Embedded object "\${OBJECT}" in library Robot
-Run Keyword In For Loop
- ${tc} = Check test Case ${TEST NAME}
- Check Run Keyword ${tc.kws[0].kws[0].kws[0]} BuiltIn.Log hello from for loop
- Check Run Keyword In UK ${tc.kws[0].kws[2].kws[0]} BuiltIn.Log hei maailma
- Check Run Keyword ${tc.kws[1].kws[0].kws[0]} BuiltIn.Log hello from second for loop
+Embedded arguments matching only after replacing variables
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword With Embedded Args ${tc[1]} Embedded "arg" arg
+ Check Run Keyword With Embedded Args ${tc[2]} Embedded "arg" in library arg
+
+Exact match after replacing variables has higher precedence than embedded arguments
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword ${tc[1]} Embedded "not"
+ Check Log Message ${tc[1][0][0][0]} Nothing embedded in this user keyword!
+ Check Run Keyword ${tc[2]} embedded_args.Embedded "not" in library
+ Check Log Message ${tc[2][0][0]} Nothing embedded in this library keyword!
+
+Run Keyword In FOR Loop
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Run Keyword ${tc[0, 0, 0]} BuiltIn.Log hello from for loop
+ Check Run Keyword In UK ${tc[0, 2, 0]} BuiltIn.Log hei maailma
+ Check Run Keyword ${tc[1, 0, 0]} BuiltIn.Log hello from second for loop
Run Keyword With Test Timeout
Check Test Case ${TEST NAME} Passing
${tc} = Check Test Case ${TEST NAME} Exceeded
- Check Run Keyword ${tc.kws[0]} BuiltIn.Log Before Timeout
+ Check Run Keyword ${tc[0]} BuiltIn.Log Before Timeout
Run Keyword With KW Timeout
- Check test Case ${TEST NAME} Passing
- Check test Case ${TEST NAME} Exceeded
+ Check Test Case ${TEST NAME} Passing
+ Check Test Case ${TEST NAME} Exceeded
Run Keyword With Invalid Keyword Name
Check Test Case ${TEST NAME}
@@ -69,15 +109,27 @@ Stdout and stderr are not captured when running Run Keyword
*** Keywords ***
Check Run Keyword
- [Arguments] ${kw} ${subkw_name} @{msgs}
- Should Be Equal ${kw.name} BuiltIn.Run Keyword
- Should Be Equal ${kw.kws[0].name} ${subkw_name}
+ [Arguments] ${kw} ${name} @{msgs}
+ Should Be Equal ${kw.full_name} BuiltIn.Run Keyword
+ Should Be Equal ${kw[0].full_name} ${name}
FOR ${index} ${msg} IN ENUMERATE @{msgs}
- Check Log Message ${kw.kws[0].msgs[${index}]} ${msg}
+ Check Log Message ${kw[0, ${index}]} ${msg}
END
Check Run Keyword In Uk
[Arguments] ${kw} ${subkw_name} @{msgs}
- Should Be Equal ${kw.name} BuiltIn.Run Keyword
- Should Be Equal ${kw.kws[0].name} My UK
- Check Run Keyword ${kw.kws[0].kws[0]} ${subkw_name} @{msgs}
+ Should Be Equal ${kw.full_name} BuiltIn.Run Keyword
+ Should Be Equal ${kw[0].full_name} My UK
+ Check Run Keyword ${kw[0, 0]} ${subkw_name} @{msgs}
+
+Check Run Keyword With Embedded Args
+ [Arguments] ${kw} ${subkw_name} ${msg}
+ Should Be Equal ${kw.full_name} BuiltIn.Run Keyword
+ IF ${subkw_name.endswith('library')}
+ Should Be Equal ${kw[0].full_name} embedded_args.${subkw_name}
+ Check Log Message ${kw[0, 0]} ${msg}
+ ELSE
+ Should Be Equal ${kw[0].full_name} ${subkw_name}
+ Should Be Equal ${kw[0, 0].full_name} BuiltIn.Log
+ Check Log Message ${kw[0, 0, 0]} ${msg}
+ END
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_and_continue_on_failure.robot b/atest/robot/standard_libraries/builtin/run_keyword_and_continue_on_failure.robot
index 3f83802c905..2af70af225d 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_and_continue_on_failure.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_and_continue_on_failure.robot
@@ -5,16 +5,16 @@ Resource atest_resource.robot
*** Test Cases ***
Run Keyword And Continue On Failure
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Expected Failure FAIL
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} Expected Failure 2 FAIL
- Check Log Message ${tc.kws[2].msgs[0]} This should be executed
+ Check Log Message ${tc[0, 0, 0]} Expected Failure FAIL
+ Check Log Message ${tc[1, 0, 0]} Expected Failure 2 FAIL
+ Check Log Message ${tc[2, 0]} This should be executed
Run Keyword And Continue On Failure In For Loop
Check Test Case ${TESTNAME}
Run User keyword And Continue On Failure
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} This should be executed
+ Check Log Message ${tc[1, 0]} This should be executed
Run Keyword And Continue On Failure With For Loops
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_and_return.robot b/atest/robot/standard_libraries/builtin/run_keyword_and_return.robot
index b0fbeccc939..9e345446a7f 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_and_return.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_and_return.robot
@@ -5,15 +5,15 @@ Resource atest_resource.robot
*** Test Cases ***
Return one value
${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.kws[0].kws[0].msgs[0]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[0, 0, 1]} Returning from the enclosing user keyword.
Return multiple values
Check Test Case ${TESTNAME}
Return nothing
${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.kws[0].kws[0].kws[0].msgs[0]} No return value
- Check log message ${tc.kws[0].kws[0].msgs[0]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[0, 0, 0, 0]} No return value
+ Check Log Message ${tc[0, 0, 1]} Returning from the enclosing user keyword.
Nested usage
Check Test Case ${TESTNAME}
@@ -23,13 +23,13 @@ Keyword fails
Inside Run Keyword variants
${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.kws[2].kws[0].kws[0].msgs[0]} First keyword
- Check log message ${tc.kws[2].kws[0].kws[2].msgs[0]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[2, 0, 0, 0]} First keyword
+ Check Log Message ${tc[2, 0, 2, 1]} Returning from the enclosing user keyword.
Using Run Keyword variants
${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.kws[2].kws[0].kws[0].kws[1].msgs[0]} Second keyword
- Check log message ${tc.kws[2].kws[0].kws[0].kws[2].msgs[0]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[2, 0, 0, 1, 0]} Second keyword
+ Check Log Message ${tc[2, 0, 0, 2, 1]} Returning from the enclosing user keyword.
Outside user keyword
Check Test Case ${TESTNAME}
@@ -42,9 +42,9 @@ Return strings that needs to be escaped
Run Keyword And Return If
${tc} = Check Test Case ${TESTNAME}
- Check log message ${tc.kws[0].kws[1].msgs[0]} Returning from the enclosing user keyword.
- Check log message ${tc.kws[2].kws[1].msgs[0]} Returning from the enclosing user keyword.
- Check log message ${tc.kws[4].kws[0].kws[2].kws[0].msgs[0]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[0, 1, 1]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[2, 1, 1]} Returning from the enclosing user keyword.
+ Check Log Message ${tc[4, 0, 2, 0, 1]} Returning from the enclosing user keyword.
Run Keyword And Return If can have non-existing keywords and variables if condition is not true
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_and_warn_on_failure.robot b/atest/robot/standard_libraries/builtin/run_keyword_and_warn_on_failure.robot
index 721feb89810..442c10ac1c5 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_and_warn_on_failure.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_and_warn_on_failure.robot
@@ -5,16 +5,16 @@ Resource atest_resource.robot
*** Test Cases ***
Run Keyword And Warn On Failure
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Executing keyword 'FAIL' failed:\nExpected Warn WARN
+ Check Log Message ${tc[0, 1]} Executing keyword 'FAIL' failed:\nExpected Warn WARN
Run Keyword And Warn On Failure For Keyword Teardown
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]}
+ Check Log Message ${tc[0, 1]}
... Executing keyword 'Failing Keyword Teardown' failed:\nKeyword teardown failed:\nExpected WARN
Run User keyword And Warn On Failure
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]}
+ Check Log Message ${tc[0, 1]}
... Executing keyword 'Exception In User Defined Keyword' failed:\nExpected Warn In User Keyword WARN
Run Keyword And Warn On Failure With Syntax Error
@@ -22,7 +22,7 @@ Run Keyword And Warn On Failure With Syntax Error
Run Keyword And Warn On Failure With Failure On Test Teardown
${tc}= Check Test Case ${TESTNAME}
- Check Log Message ${tc.teardown.msgs[0]}
+ Check Log Message ${tc.teardown[1]}
... Executing keyword 'Should Be Equal' failed:\nx != y WARN
Run Keyword And Warn On Failure With Timeout
@@ -30,5 +30,5 @@ Run Keyword And Warn On Failure With Timeout
Run Keyword And Warn On Failure On Suite Teardown
${suite} = Get Test Suite Run Keyword And Warn On Failure
- Check Log Message ${suite.teardown.msgs[0]}
+ Check Log Message ${suite.teardown[1]}
... Executing keyword 'Fail' failed:\nExpected Warn From Suite Teardown WARN
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_based_on_suite_stats.robot b/atest/robot/standard_libraries/builtin/run_keyword_based_on_suite_stats.robot
index 749b766674d..0ac6326e777 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_based_on_suite_stats.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_based_on_suite_stats.robot
@@ -1,13 +1,13 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keyword_based_on_suite_stats
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Run Keyword If All Tests Passed
${suite} = Get Test Suite Run Keyword If All Tests Passed When All Pass
Should Be Equal As Integers ${suite.statistics.failed} 0
- Should Be Equal ${suite.teardown.kws[0].name} My Teardown
- Check Log Message ${suite.teardown.kws[0].kws[0].msgs[0]} Suite teardown message
+ Should Be Equal ${suite.teardown[0].name} My Teardown
+ Check Log Message ${suite.teardown[0, 0, 0]} Suite teardown message
Run Keyword If All Tests Passed Can't be Used In Test
Check Test Case Run Keyword If All Tests Passed Can't be Used In Test
@@ -18,8 +18,8 @@ Run Keyword If All tests Passed Is not Executed When Any Test Fails
Run Keyword If Any Tests Failed
${suite} = Get Test Suite Run Keyword If Any Tests Failed When Test Fails
Should Be Equal As Integers ${suite.statistics.failed} 1
- Should Be Equal ${suite.teardown.kws[0].name} My Teardown
- Check Log Message ${suite.teardown.kws[0].kws[0].msgs[0]} Suite teardown message
+ Should Be Equal ${suite.teardown[0].name} My Teardown
+ Check Log Message ${suite.teardown[0, 0, 0]} Suite teardown message
Run Keyword If Any Tests Failed Can't be Used In Test
Check Test Case Run Keyword If Any Tests Failed Can't be Used In Test
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_if_test_passed_failed.robot b/atest/robot/standard_libraries/builtin/run_keyword_if_test_passed_failed.robot
index 08d0f4e6100..b635c2444c6 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_if_test_passed_failed.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_if_test_passed_failed.robot
@@ -1,16 +1,16 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keyword_if_test_passed_failed
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Run Keyword If Test Failed when test fails
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.teardown.body[0].name} BuiltIn.Log
- Check Log Message ${tc.teardown.body[0].msgs[0]} Hello from teardown!
+ Should Be Equal ${tc.teardown[0].full_name} BuiltIn.Log
+ Check Log Message ${tc.teardown[0, 0]} Hello from teardown!
Run Keyword If Test Failed in user keyword when test fails
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.body[1].body[0].msgs[0]} Apparently test failed! FAIL
+ Check Log Message ${tc.teardown[1, 0, 0]} Apparently test failed! FAIL
Run Keyword If Test Failed when test passes
${tc} = Check Test Case ${TEST NAME}
@@ -18,7 +18,7 @@ Run Keyword If Test Failed when test passes
Run Keyword If Test Failed in user keyword when test passes
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.teardown.body[1].body}
+ Should Be Empty ${tc.teardown[1].body}
Run Keyword If Test Failed when test is skipped
${tc} = Check Test Case ${TEST NAME}
@@ -26,35 +26,35 @@ Run Keyword If Test Failed when test is skipped
Run Keyword If Test Failed in user keyword when test is skipped
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.teardown.body[1].body}
+ Should Be Empty ${tc.teardown[1].body}
Run Keyword If Test Failed Can't Be Used In Setup
${tc} = Check Test Case ${TEST NAME}
Length Should Be ${tc.setup.body} 1
- Check Log Message ${tc.setup.body[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
+ Check Log Message ${tc.setup[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
Run Keyword If Test Failed Can't Be Used in Test
Check Test Case ${TEST NAME}
Run Keyword If Test Failed Uses User Keyword
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.kws[0].kws[0].msgs[0]} Teardown message
+ Check Log Message ${tc.teardown[0, 0, 0]} Teardown message
Run Keyword If Test Failed Fails
Check Test Case ${TEST NAME}
Run Keyword If test Failed Can't Be Used In Suite Setup or Teardown
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${SUITE.suites[0].setup.msgs[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
- Check Log Message ${SUITE.suites[0].teardown.msgs[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
+ Check Log Message ${SUITE.suites[0].setup[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
+ Check Log Message ${SUITE.suites[0].teardown[0]} Keyword 'Run Keyword If Test Failed' can only be used in test teardown. FAIL
Run Keyword If Test Passed when test passes
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.body[0].msgs[0]} Teardown of passing test
+ Check Log Message ${tc.teardown[0, 0]} Teardown of passing test
Run Keyword If Test Passed in user keyword when test passes
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.body[1].body[0].msgs[0]} Apparently test passed! FAIL
+ Check Log Message ${tc.teardown[1, 0, 0]} Apparently test passed! FAIL
Run Keyword If Test Passed when test fails
${tc} = Check Test Case ${TEST NAME}
@@ -62,7 +62,7 @@ Run Keyword If Test Passed when test fails
Run Keyword If Test Passed in user keyword when test fails
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.teardown.body[1].body}
+ Should Be Empty ${tc.teardown[1].body}
Run Keyword If Test Passed when test is skipped
${tc} = Check Test Case ${TEST NAME}
@@ -70,7 +70,7 @@ Run Keyword If Test Passed when test is skipped
Run Keyword If Test Passed in user keyword when test is skipped
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.teardown.body[1].body}
+ Should Be Empty ${tc.teardown[1].body}
Run Keyword If Test Passed Can't Be used In Setup
Check Test Case ${TEST NAME}
@@ -80,8 +80,8 @@ Run Keyword If Test Passed Can't Be used In Test
Run Keyword If Test Passes Uses User Keyword
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.teardown.kws[0].kws[0].msgs[0]} Teardown message
- Check Keyword Data ${tc.teardown.kws[0].kws[0]} BuiltIn.Log args=\${message}
+ Check Log Message ${tc.teardown[0, 0, 0]} Teardown message
+ Check Keyword Data ${tc.teardown[0, 0]} BuiltIn.Log args=\${message}
Run Keyword If Test Passed Fails
Check Test Case ${TEST NAME}
@@ -94,27 +94,27 @@ Run Keyword If Test Failed When Teardown Fails
Run Keyword If Test Passed/Failed With Earlier Ignored Failures
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.teardown.kws[0].kws[0].status} FAIL
- Should Be Equal ${tc.teardown.kws[0].status} PASS
- Should Be Equal ${tc.teardown.kws[1].kws[0].status} FAIL
- Should Be Equal ${tc.teardown.kws[1].status} PASS
- Should Be Equal ${tc.teardown.status} PASS
+ Should Be Equal ${tc.teardown[0, 0].status} FAIL
+ Should Be Equal ${tc.teardown[0].status} PASS
+ Should Be Equal ${tc.teardown[1, 0].status} FAIL
+ Should Be Equal ${tc.teardown[1].status} PASS
+ Should Be Equal ${tc.teardown.status} PASS
Run Keyword If Test Passed/Failed after skip in teardown
${tc} = Check Test Case ${TEST NAME}
- Should Be Empty ${tc.teardown.body[1].body}
- Should Be Empty ${tc.teardown.body[2].body}
+ Should Be Empty ${tc.teardown[1].body}
+ Should Be Empty ${tc.teardown[2].body}
Continuable Failure In Teardown
Check Test Case ${TEST NAME}
Run Keyword If test Passed Can't Be Used In Suite Setup or Teardown
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${SUITE.suites[2].setup.msgs[0]} Keyword 'Run Keyword If Test Passed' can only be used in test teardown. FAIL
- Check Log Message ${SUITE.suites[2].teardown.msgs[0]} Keyword 'Run Keyword If Test Passed' can only be used in test teardown. FAIL
+ Check Log Message ${SUITE.suites[2].setup[0]} Keyword 'Run Keyword If Test Passed' can only be used in test teardown. FAIL
+ Check Log Message ${SUITE.suites[2].teardown[0]} Keyword 'Run Keyword If Test Passed' can only be used in test teardown. FAIL
Variable Values Should Not Be Visible As Keyword's Arguments
${tc} = Check Test Case Run Keyword If Test Failed Uses User Keyword
- Check Keyword Data ${tc.teardown} BuiltIn.Run Keyword If Test Failed args=Teardown UK, \${TEARDOWN MESSAGE} type=TEARDOWN
- Check Keyword Data ${tc.teardown.kws[0]} Teardown UK args=\${TEARDOWN MESSAGE}
- Check Keyword Data ${tc.teardown.kws[0].kws[0]} BuiltIn.Log args=\${message}
+ Check Keyword Data ${tc.teardown} BuiltIn.Run Keyword If Test Failed args=Teardown UK, \${TEARDOWN MESSAGE} type=TEARDOWN
+ Check Keyword Data ${tc.teardown[0]} Teardown UK args=\${TEARDOWN MESSAGE}
+ Check Keyword Data ${tc.teardown[0, 0]} BuiltIn.Log args=\${message}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_if_unless.robot b/atest/robot/standard_libraries/builtin/run_keyword_if_unless.robot
index cd6869316a6..5141a284b7e 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_if_unless.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_if_unless.robot
@@ -1,28 +1,28 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keyword_if_unless.robot
Resource atest_resource.robot
-*** Variable ***
+*** Variables ***
${EXECUTED} This is executed
-*** Test Case ***
+*** Test Cases ***
Run Keyword If With True Expression
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[0].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[0, 0, 0]} ${EXECUTED}
Run Keyword If With False Expression
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal As Integers ${tc.body[0].keyword_count} 0
+ Should Be Empty ${tc[0].body}
Run Keyword In User Keyword
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[0].body[0].body[0].msgs[0]} ${EXECUTED}
- Should Be Equal As Integers ${tc.body[1].body[0].keyword_count} 0
+ Check Log Message ${tc[0, 0, 0, 0]} ${EXECUTED}
+ Should Be Empty ${tc[1, 0].body}
Run Keyword With ELSE
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[1].body[0].msgs[0]} ${EXECUTED}
- Check Log Message ${tc.body[3].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[1, 0, 0]} ${EXECUTED}
+ Check Log Message ${tc[3, 0, 0]} ${EXECUTED}
Keyword Name in ELSE as variable
Check Test Case ${TEST NAME}
@@ -45,18 +45,18 @@ Only first ELSE is significant
Run Keyword With ELSE IF
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[1].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[1, 0, 0]} ${EXECUTED}
Run Keyword with ELSE IF and ELSE
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[0].body[0].msgs[0]} ${EXECUTED}
- Check Log Message ${tc.body[1].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[0, 0, 0]} ${EXECUTED}
+ Check Log Message ${tc[1, 0, 0]} ${EXECUTED}
Run Keyword with multiple ELSE IF
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[0].body[0].msgs[0]} ${EXECUTED}
- Check Log Message ${tc.body[1].body[0].msgs[0]} ${EXECUTED}
- Check Log Message ${tc.body[2].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[0, 0, 0]} ${EXECUTED}
+ Check Log Message ${tc[1, 0, 0]} ${EXECUTED}
+ Check Log Message ${tc[2, 0, 0]} ${EXECUTED}
Keyword Name in ELSE IF as variable
Check Test Case ${TEST NAME}
@@ -79,53 +79,53 @@ ELSE IF without keyword is invalid
ELSE before ELSE IF is ignored
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.body[0].body[0].msgs[0]} ${EXECUTED}
+ Check Log Message ${tc[0, 0, 0]} ${EXECUTED}
ELSE and ELSE IF inside list arguments should be escaped
Check Test Case ${TEST NAME}
ELSE and ELSE IF must be upper case
${tc} = Check Test Case ${TEST NAME}
- Test ELSE (IF) Escaping ${tc.body[0].body[0]} else
- Test ELSE (IF) Escaping ${tc.body[1].body[0]} ELSE iF
+ Test ELSE (IF) Escaping ${tc[0, 0]} else
+ Test ELSE (IF) Escaping ${tc[1, 0]} ELSE iF
ELSE and ELSE IF must be whitespace sensitive
${tc} = Check Test Case ${TEST NAME}
- Test ELSE (IF) Escaping ${tc.body[0].body[0]} EL SE
- Test ELSE (IF) Escaping ${tc.body[1].body[0]} ELSEIF
+ Test ELSE (IF) Escaping ${tc[0, 0]} EL SE
+ Test ELSE (IF) Escaping ${tc[1, 0]} ELSEIF
Run Keyword With Escaped ELSE and ELSE IF
${tc} = Check Test Case ${TEST NAME}
- Test ELSE (IF) Escaping ${tc.body[0].body[0]} ELSE
- Test ELSE (IF) Escaping ${tc.body[1].body[0]} ELSE IF
+ Test ELSE (IF) Escaping ${tc[0, 0]} ELSE
+ Test ELSE (IF) Escaping ${tc[1, 0]} ELSE IF
Run Keyword With ELSE and ELSE IF from Variable
${tc} = Check Test Case ${TEST NAME}
- Test ELSE (IF) Escaping ${tc.body[0].body[0]} ELSE
- Test ELSE (IF) Escaping ${tc.body[1].body[0]} ELSE
- Test ELSE (IF) Escaping ${tc.body[2].body[0]} ELSE IF
- Test ELSE (IF) Escaping ${tc.body[3].body[0]} ELSE IF
+ Test ELSE (IF) Escaping ${tc[0, 0]} ELSE
+ Test ELSE (IF) Escaping ${tc[1, 0]} ELSE
+ Test ELSE (IF) Escaping ${tc[2, 0]} ELSE IF
+ Test ELSE (IF) Escaping ${tc[3, 0]} ELSE IF
Run Keyword Unless With False Expression
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${ERRORS[0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
- Check Log Message ${tc.body[1].body[0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
- Check Log Message ${tc.body[1].body[1].msgs[0]} ${EXECUTED}
+ Check Log Message ${ERRORS[0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
+ Check Log Message ${tc[1, 0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
+ Check Log Message ${tc[1, 1, 0]} ${EXECUTED}
Run Keyword Unless With True Expression
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${ERRORS[1]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
- Check Log Message ${tc.body[0].body[0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
- Length Should Be ${tc.body[0].body} 1
+ Check Log Message ${ERRORS[1]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
+ Check Log Message ${tc[0, 0]} Keyword 'BuiltIn.Run Keyword Unless' is deprecated. WARN
+ Length Should Be ${tc[0].body} 1
Variable Values Should Not Be Visible As Keyword's Arguments
${tc} = Check Test Case Run Keyword In User Keyword
- Check Keyword Data ${tc.body[0].body[0]} BuiltIn.Run Keyword If args='\${status}' == 'PASS', Log, \${message}
- Check Keyword Data ${tc.body[0].body[0].body[0]} BuiltIn.Log args=\${message}
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Run Keyword If args='\${status}' == 'PASS', Log, \${message}
+ Check Keyword Data ${tc[0, 0, 0]} BuiltIn.Log args=\${message}
*** Keywords ***
Test ELSE (IF) Escaping
[Arguments] ${kw} ${else (if)}
- Length Should Be ${kw.msgs} 2
- Check Log Message ${kw.msgs[0]} ${else (if)}
- Check Log Message ${kw.msgs[1]} ${EXECUTED}
+ Length Should Be ${kw.body} 2
+ Check Log Message ${kw[0]} ${else (if)}
+ Check Log Message ${kw[1]} ${EXECUTED}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_variants_registering.robot b/atest/robot/standard_libraries/builtin/run_keyword_variants_registering.robot
index 33e6bb7845e..4a253a71d71 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_variants_registering.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_variants_registering.robot
@@ -1,9 +1,9 @@
-*** Setting ***
+*** Settings ***
Documentation Tests for registering own run keyword variant
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keyword_variants_registering.robot
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Not registered Keyword Fails With Content That Should Not Be Evaluated Twice
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_variants_variable_handling.robot b/atest/robot/standard_libraries/builtin/run_keyword_variants_variable_handling.robot
index dd277e90c6b..632d23d74a1 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_variants_variable_handling.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_variants_variable_handling.robot
@@ -1,19 +1,28 @@
-*** Setting ***
+*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keyword_variants_variable_handling.robot
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Variable Values Should Not Be Visible As Keyword's Arguments
${tc} = Check Test Case ${TEST NAME}
- Check Keyword Data ${tc.kws[0]} BuiltIn.Run Keyword args=My UK, Log, \${OBJECT}
- Check Keyword Data ${tc.kws[0].kws[0]} My UK args=Log, \${OBJECT}
- Check Keyword Data ${tc.kws[0].kws[0].kws[0]} BuiltIn.Run Keyword args=\${name}, \@{args}
- Check Keyword Data ${tc.kws[0].kws[0].kws[0].kws[0]} BuiltIn.Log args=\@{args}
+ Check Keyword Data ${tc[0]} BuiltIn.Run Keyword args=My UK, Log, \${OBJECT}
+ Check Keyword Data ${tc[0, 0]} My UK args=Log, \${OBJECT}
+ Check Keyword Data ${tc[0, 0, 0]} BuiltIn.Run Keyword args=\${name}, \@{args}
+ Check Keyword Data ${tc[0, 0, 0, 0]} BuiltIn.Log args=\@{args}
+ Check Log Message ${tc[0, 0, 0, 0, 0]} Robot
+ Check Keyword Data ${tc[0, 0, 1, 0]} BuiltIn.Log args=\${args}[0]
+ Check Log Message ${tc[0, 0, 1, 0, 0]} Robot
Run Keyword When Keyword and Arguments Are in List Variable
${tc} = Check Test Case ${TEST NAME}
- Check Keyword Data ${tc.kws[0].kws[0]} \\Log Many args=c:\\\\temp\\\\foo, \\\${notvar}
- Check Keyword Data ${tc.kws[1].kws[0]} \\Log Many args=\\\${notvar}
+ Check Keyword Data ${tc[0, 0]} \\Log Many args=c:\\\\temp\\\\foo, \\\${notvar}
+ Check Keyword Data ${tc[1, 0]} \\Log Many args=\\\${notvar}
+
+Run Keyword With Empty List Variable
+ Check Test Case ${TEST NAME}
+
+Run Keyword With Multiple Empty List Variables
+ Check Test Case ${TEST NAME}
Run Keyword If When Arguments are In Multiple List
${tc} = Check Test Case ${TEST NAME}
@@ -45,10 +54,10 @@ Run Keyword If With List And One Argument That needs to Be Processed
${tc} = Check Test Case ${TEST NAME}
Check Keyword Arguments And Messages ${tc}
-*** Keyword ***
+*** Keywords ***
Check Keyword Arguments And Messages
[Arguments] ${tc}
- Check Keyword Data ${tc.kws[0].kws[0]} \\Log Many args=\@{ARGS}
- Check Keyword Data ${tc.kws[0].kws[0].kws[0]} BuiltIn.Log Many args=\@{args}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} c:\\temp\\foo
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[1]} \${notvar}
+ Check Keyword Data ${tc[0, 0]} \\Log Many args=\@{ARGS}
+ Check Keyword Data ${tc[0, 0, 0]} BuiltIn.Log Many args=\@{args}
+ Check Log Message ${tc[0, 0, 0, 0]} c:\\temp\\foo
+ Check Log Message ${tc[0, 0, 0, 1]} \${notvar}
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_variants_with_escaping_control_arguments.robot b/atest/robot/standard_libraries/builtin/run_keyword_variants_with_escaping_control_arguments.robot
index bf6a2754738..6c55e2821a3 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_variants_with_escaping_control_arguments.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_variants_with_escaping_control_arguments.robot
@@ -5,32 +5,32 @@ Resource atest_resource.robot
*** Test Cases ***
Run Keyword with Run Keywords with Arguments Inside List variable should escape AND
${tc}= Test Should Have Correct Keywords BuiltIn.Run Keywords
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].msgs[0]} log message
+ Check Log Message ${tc[0, 0, 0, 0, 0]} log message
Run Keyword with Run Keywords and Arguments Inside List variable should escape AND
${tc}= Test Should Have Correct Keywords BuiltIn.Run Keywords
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].msgs[0]} log message
+ Check Log Message ${tc[0, 0, 0, 0, 0]} log message
Run Keyword If with Run Keywords With Arguments Inside List variable should escape AND
${tc}= Test Should Have Correct Keywords BuiltIn.Run Keywords
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].msgs[0]} log message
+ Check Log Message ${tc[0, 0, 0, 0, 0]} log message
Run Keyword If with Run Keywords And Arguments Inside List variable should escape AND
${tc}= Test Should Have Correct Keywords BuiltIn.Run Keyword
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].kws[0].msgs[0]} log message
+ Check Log Message ${tc[0, 0, 0, 0, 0, 0]} log message
Run Keywords With Run Keyword If should not escape ELSE and ELSE IF
${tc}= Test Should Have Correct Keywords
... BuiltIn.Run Keyword If BuiltIn.Log BuiltIn.Run Keyword If
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} log message
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} that
+ Check Log Message ${tc[0, 0, 0, 0]} log message
+ Check Log Message ${tc[0, 1, 0]} that
Run Keywords With Run Keyword If In List Variable Should Escape ELSE and ELSE IF From List Variable
${tc}= Test Should Have Correct Keywords
... BuiltIn.Run Keyword If BuiltIn.Log BuiltIn.Run Keyword If
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} that
+ Check Log Message ${tc[0, 1, 0]} that
Run Keywords With Run Keyword If With Arguments From List Variable should escape ELSE and ELSE IF From List Variable
${tc}= Test Should Have Correct Keywords
... BuiltIn.Run Keyword If BuiltIn.Log BuiltIn.Run Keyword If
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} that
+ Check Log Message ${tc[0, 1, 0]} that
diff --git a/atest/robot/standard_libraries/builtin/run_keyword_with_errors.robot b/atest/robot/standard_libraries/builtin/run_keyword_with_errors.robot
index f3924a1d034..987f3a69384 100644
--- a/atest/robot/standard_libraries/builtin/run_keyword_with_errors.robot
+++ b/atest/robot/standard_libraries/builtin/run_keyword_with_errors.robot
@@ -5,13 +5,13 @@ Resource atest_resource.robot
*** Test Cases ***
Ignore Error When Keyword Passes
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} My message
+ Check Log Message ${tc[0, 0, 0]} My message
Ignore Error When Keyword Fails
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} My error message FAIL
- Should Be Equal ${tc.kws[0].kws[0].status} FAIL
- Should Be Equal ${tc.kws[0].status} PASS
+ Should Be Equal ${tc[0].status} PASS
+ Should Be Equal ${tc[0, 0].status} FAIL
+ Check Log Message ${tc[0, 0, 0]} My error message FAIL
Ignore Error Returns When Keyword Passes
Check Test Case ${TEST NAME}
@@ -21,30 +21,32 @@ Ignore Error Returns When Keyword Fails
Ignore Error With User Keyword When Keywords Pass
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Hello world
- Check Keyword Data ${tc.kws[0].kws[0].kws[2]} BuiltIn.Evaluate \${ret} 1+2
+ Check Log Message ${tc[0, 0, 0, 0]} Hello world
+ Check Keyword Data ${tc[0, 0, 2]} BuiltIn.Evaluate \${ret} 1+2
Ignore Error With User Keyword When Keyword Fails
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].msgs[0]} Hello world
- Check Log Message ${tc.kws[0].kws[0].kws[1].msgs[0]} Expected failure in UK FAIL
- Length Should Be ${tc.kws[0].kws[0].kws} 3
- Should Be Equal ${tc.kws[0].kws[0].kws[-1].status} NOT RUN
+ Check Log Message ${tc[0, 0, 0, 0, 0]} Hello world
+ Check Log Message ${tc[0, 0, 1, 0]} Expected failure in UK FAIL
+ Length Should Be ${tc[0, 0].body} 3
+ Should Be Equal ${tc[0, 0, -1].status} NOT RUN
Ignore Error With Arguments That Needs To Be Escaped
Check Test Case ${TEST NAME}
Ignore Error When Timeout Occurs
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].status} FAIL Run Keyword And Ignore Error captured timeout even though it should not no values
+ Should Be Equal ${tc[0].status} FAIL
+ ... Run Keyword And Ignore Error captured timeout even though it should not
+ ... values=False
Ignore Error When Timeout Occurs In UK
Check Test Case ${TEST NAME}
-Ignore Error When Syntax Error At Parsing Time
+Ignore Error Cannot Catch Syntax Errors
Check Test Case ${TEST NAME}
-Ignore Error When Syntax Error At Run Time
+Ignore Error Can Catch Non-Syntax Errors
Check Test Case ${TEST NAME}
Ignore Error When Syntax Error In Setting Variables
@@ -75,9 +77,9 @@ Ignore Error With "Passing" Exceptions
Expect Error When Error Occurs
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} My error message FAIL
- Should Be Equal ${tc.kws[0].kws[0].status} FAIL
- Should Be Equal ${tc.kws[0].status} PASS
+ Should Be Equal ${tc[0].status} PASS
+ Should Be Equal ${tc[0, 0].status} FAIL
+ Check Log Message ${tc[0, 0, 0]} My error message FAIL
Expect Error When Different Error Occurs
Check Test Case ${TEST NAME}
@@ -97,32 +99,34 @@ Expected Error Should Be Returned
Expect Error With User Keyword When Keywords Pass
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Hello world
- Check Keyword Data ${tc.kws[0].kws[0].kws[2]} BuiltIn.Evaluate \${ret} 1+2
+ Check Log Message ${tc[0, 0, 0, 0]} Hello world
+ Check Keyword Data ${tc[0, 0, 2]} BuiltIn.Evaluate \${ret} 1+2
Expect Error With User Keyword When Keyword Fails
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].kws[0].msgs[0]} Hello world
- Check Log Message ${tc.kws[0].kws[0].kws[1].msgs[0]} Expected failure in UK FAIL
- Length Should Be ${tc.kws[0].kws[0].kws} 3
- Should Be Equal ${tc.kws[0].kws[0].kws[-1].status} NOT RUN
+ Check Log Message ${tc[0, 0, 0, 0, 0]} Hello world
+ Check Log Message ${tc[0, 0, 1, 0]} Expected failure in UK FAIL
+ Length Should Be ${tc[0, 0].body} 3
+ Should Be Equal ${tc[0, 0, -1].status} NOT RUN
Expect Error With Arguments That Needs To Be Escaped
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[1].kws[0].msgs[0]} c:\\temp\\foo\\not_new_line
- Check Log Message ${tc.kws[1].kws[0].msgs[1]} \${notvar}
+ Check Log Message ${tc[1, 0, 0]} c:\\temp\\foo\\not_new_line
+ Check Log Message ${tc[1, 0, 1]} \${notvar}
Expect Error When Timeout Occurs
${tc} = Check Test Case ${TEST NAME}
- Should Be Equal ${tc.kws[0].status} FAIL Run Keyword And Expect Error captured timeout even though it should not no values
+ Should Be Equal ${tc[0].status} FAIL
+ ... Run Keyword And Expect Error captured timeout even though it should not
+ ... values=False
Expect Error When Timeout Occurs In UK
Check Test Case ${TEST NAME}
-Expect Error When Syntax Error At Parsing Time
+Expect Error Cannot Catch Syntax Errors
Check Test Case ${TEST NAME}
-Expect Error When Syntax Error At Run Time
+Expect Error Can Catch Non-Syntax Errors
Check Test Case ${TEST NAME}
Expect Error When Syntax Error In Setting Variables
@@ -171,4 +175,4 @@ Expect Error With "Passing" Exceptions
Variable Values Should Not Be Visible As Keyword's Arguments
${tc} = Check Test Case Ignore Error With Arguments That Needs To be Escaped
- Check Keyword Data ${tc.kws[3].kws[0]} BuiltIn.Create List args=\@{NEEDS ESCAPING}
+ Check Keyword Data ${tc[3, 0]} BuiltIn.Create List args=\@{NEEDS ESCAPING}
diff --git a/atest/robot/standard_libraries/builtin/run_keywords.robot b/atest/robot/standard_libraries/builtin/run_keywords.robot
index 39049cea76d..e245b9146e7 100644
--- a/atest/robot/standard_libraries/builtin/run_keywords.robot
+++ b/atest/robot/standard_libraries/builtin/run_keywords.robot
@@ -1,4 +1,6 @@
*** Settings ***
+Documentation Testing Run Keywords when used without AND. Tests with AND are in
+... run_keywords_with_arguments.robot.
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keywords.robot
Resource atest_resource.robot
@@ -6,12 +8,32 @@ Resource atest_resource.robot
Passing keywords
${tc} = Test Should Have Correct Keywords
... BuiltIn.No Operation Passing BuiltIn.Log Variables
- Check Log Message ${tc.kws[0].kws[1].kws[0].msgs[0]} Hello, world!
+ Check Log Message ${tc[0, 1, 0, 0]} Hello, world!
Failing keyword
Test Should Have Correct Keywords
... Passing Failing
+Embedded arguments
+ ${tc} = Test Should Have Correct Keywords
+ ... Embedded "arg" Embedded "\${1}" Embedded object "\${OBJECT}"
+ Check Log Message ${tc[0, 0, 0, 0]} arg
+ Check Log Message ${tc[0, 1, 0, 0]} 1
+ Check Log Message ${tc[0, 2, 0, 0]} Robot
+
+Embedded arguments with library keywords
+ ${tc} = Test Should Have Correct Keywords
+ ... embedded_args.Embedded "arg" in library
+ ... embedded_args.Embedded "\${1}" in library
+ ... embedded_args.Embedded object "\${OBJECT}" in library
+ Check Log Message ${tc[0, 0, 0]} arg
+ Check Log Message ${tc[0, 1, 0]} 1
+ Check Log Message ${tc[0, 2, 0]} Robot
+
+Keywords names needing escaping
+ Test Should Have Correct Keywords
+ ... Needs \\escaping \\\${notvar}
+
Continuable failures
Test Should Have Correct Keywords
... Continuable failure Multiple continuables Failing
@@ -21,9 +43,14 @@ Keywords as variables
... BuiltIn.No Operation Passing BuiltIn.No Operation
... Passing BuiltIn.Log Variables Failing
+Keywords names needing escaping as variable
+ Test Should Have Correct Keywords
+ ... Needs \\escaping \\\${notvar} Needs \\escaping \\\${notvar}
+ ... kw_index=1
+
Non-existing variable as keyword name
- ${tc} = Check Test Case ${TESTNAME}
- Should Be Empty ${tc.kws[0].kws}
+ Test Should Have Correct Keywords
+ ... Passing
Non-existing variable inside executed keyword
Test Should Have Correct Keywords
@@ -43,6 +70,9 @@ In test setup
In test teardown
Check Test Case ${TESTNAME}
+In test teardown with non-existing variable in keyword name
+ Check Test Case ${TESTNAME}
+
In test teardown with ExecutionPassed exception
Check Test Case ${TESTNAME}
@@ -50,7 +80,7 @@ In test teardown with ExecutionPassed exception after continuable failure
Check Test Case ${TESTNAME}
In suite setup
- Check Log Message ${SUITE.setup.kws[0].kws[0].msgs[0]} Hello, world!
+ Check Log Message ${SUITE.setup[0, 0, 0]} Hello, world!
Should Contain Keywords ${SUITE.setup} Passing BuiltIn.No Operation
In suite teardown
diff --git a/atest/robot/standard_libraries/builtin/run_keywords_with_arguments.robot b/atest/robot/standard_libraries/builtin/run_keywords_with_arguments.robot
index 4a4d98780d7..4e792da98bf 100644
--- a/atest/robot/standard_libraries/builtin/run_keywords_with_arguments.robot
+++ b/atest/robot/standard_libraries/builtin/run_keywords_with_arguments.robot
@@ -1,50 +1,52 @@
*** Settings ***
+Documentation Testing Run Keywords when used with AND. Tests without AND are in
+... run_keywords.robot.
Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/run_keywords_with_arguments.robot
Resource atest_resource.robot
*** Test Cases ***
With arguments
${tc}= Test Should Have Correct Keywords BuiltIn.Should Be Equal BuiltIn.No Operation BuiltIn.Log Many BuiltIn.Should Be Equal
- Check Log Message ${tc.kws[0].kws[2].msgs[1]} 1
+ Check Log Message ${tc[0, 2, 1]} 1
Should fail with failing keyword
Test Should Have Correct Keywords BuiltIn.No Operation BuiltIn.Should Be Equal
Should support keywords and arguments from variables
${tc}= Test Should Have Correct Keywords BuiltIn.Should Be Equal BuiltIn.No Operation BuiltIn.Log Many BuiltIn.Should Be Equal As Integers
- Check Log Message ${tc.kws[0].kws[2].msgs[0]} hello
- Check Log Message ${tc.kws[0].kws[2].msgs[1]} 1
- Check Log Message ${tc.kws[0].kws[2].msgs[2]} 2
- Check Log Message ${tc.kws[0].kws[2].msgs[3]} 3
+ Check Log Message ${tc[0, 2, 0]} hello
+ Check Log Message ${tc[0, 2, 1]} 1
+ Check Log Message ${tc[0, 2, 2]} 2
+ Check Log Message ${tc[0, 2, 3]} 3
AND must be upper case
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} and
+ Check Log Message ${tc[0, 0, 1]} and
AND must be whitespace sensitive
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} A ND
+ Check Log Message ${tc[0, 0, 1]} A ND
Escaped AND
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} AND
+ Check Log Message ${tc[0, 0, 1]} AND
AND from Variable
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} AND
+ Check Log Message ${tc[0, 0, 1]} AND
AND in List Variable
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} AND
+ Check Log Message ${tc[0, 0, 1]} AND
Escapes in List Variable should be handled correctly
${tc}= Test Should Have Correct Keywords BuiltIn.Log Many no kw
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} 1
- Check Log Message ${tc.kws[0].kws[0].msgs[1]} AND
- Check Log Message ${tc.kws[0].kws[0].msgs[2]} 2
- Check Log Message ${tc.kws[0].kws[0].msgs[3]} Log Many
- Check Log Message ${tc.kws[0].kws[0].msgs[4]} x\${escaped}
- Check Log Message ${tc.kws[0].kws[0].msgs[5]} c:\\temp
+ Check Log Message ${tc[0, 0, 0]} 1
+ Check Log Message ${tc[0, 0, 1]} AND
+ Check Log Message ${tc[0, 0, 2]} 2
+ Check Log Message ${tc[0, 0, 3]} Log Many
+ Check Log Message ${tc[0, 0, 4]} x\${escaped}
+ Check Log Message ${tc[0, 0, 5]} c:\\temp
AND as last argument should raise an error
Test Should Have Correct Keywords BuiltIn.Log Many BuiltIn.No Operation
@@ -54,3 +56,15 @@ Consecutive AND's
AND as first argument should raise an error
Check Test Case ${TESTNAME}
+
+Keywords names needing escaping
+ Test Should Have Correct Keywords
+ ... Needs \\escaping \\\${notvar} Needs \\escaping \\\${notvar}
+
+Keywords names needing escaping as variable
+ Test Should Have Correct Keywords
+ ... Needs \\escaping \\\${notvar} Needs \\escaping \\\${notvar}
+ ... kw_index=1
+
+In test teardown with non-existing variable in keyword name
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/set_documentation.robot b/atest/robot/standard_libraries/builtin/set_documentation.robot
index d155f09b210..bbe36cbe526 100644
--- a/atest/robot/standard_libraries/builtin/set_documentation.robot
+++ b/atest/robot/standard_libraries/builtin/set_documentation.robot
@@ -5,35 +5,40 @@ Resource atest_resource.robot
*** Test Cases ***
Set test documentation
${tc} = Check Test Doc ${TESTNAME} This has been set!\nTo several lines.
- Check Log Message ${tc.kws[0].msgs[0]} Set test documentation to:\nThis has been set!\nTo several lines.
+ Check Log Message ${tc[0, 0]} Set test documentation to:\nThis has been set!\nTo several lines.
Replace test documentation
${tc} = Check Test Doc ${TESTNAME} New doc
- Check Log Message ${tc.kws[0].msgs[0]} Set test documentation to:\nNew doc
+ Check Log Message ${tc[0, 0]} Set test documentation to:\nNew doc
Append to test documentation
- ${tc} = Check Test Doc ${TESTNAME} Original doc is continued \n\ntwice!
- Check Log Message ${tc.kws[0].msgs[0]} Set test documentation to:\nOriginal doc is continued
- Check Log Message ${tc.kws[2].msgs[0]} Set test documentation to:\nOriginal doc is continued \n\ntwice!
+ ${tc} = Check Test Doc ${TESTNAME} Original doc is continued \n\ntwice! thrice!!
+ Check Log Message ${tc[0, 0]} Set test documentation to:\nOriginal doc is continued
+ Check Log Message ${tc[2, 0]} Set test documentation to:\nOriginal doc is continued \n\ntwice!
+ Check Log Message ${tc[4, 0]} Set test documentation to:\nOriginal doc is continued \n\ntwice! thrice
+ Check Log Message ${tc[6, 0]} Set test documentation to:\nOriginal doc is continued \n\ntwice! thrice!
+ Check Log Message ${tc[8, 0]} Set test documentation to:\nOriginal doc is continued \n\ntwice! thrice!!
Set suite documentation
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set suite documentation to:\nNew suite doc
+ Check Log Message ${tc[0, 0]} Set suite documentation to:\nNew suite doc
Check Test Case ${TESTNAME} 2
Should Start With ${SUITE.suites[0].doc} New suite doc
Append to suite documentation
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set suite documentation to:\nNew suite doc is continued
+ Check Log Message ${tc[0, 0]} Set suite documentation to:\nNew suite doc is continued
${tc} = Check Test Case ${TESTNAME} 2
- Check Log Message ${tc.kws[1].msgs[0]} Set suite documentation to:\nNew suite doc is continued \n\ntwice!
- Should Be Equal ${SUITE.suites[0].doc} New suite doc is continued \n\ntwice!
+ Check Log Message ${tc[1, 0]} Set suite documentation to:\nNew suite doc is continued \n\ntwice!
+ Check Log Message ${tc[3, 0]} Set suite documentation to:\nNew suite doc is continued \n\ntwice!,thrice
+ Check Log Message ${tc[5, 0]} Set suite documentation to:\nNew suite doc is continued \n\ntwice!,thrice?1
+ Should Be Equal ${SUITE.suites[0].doc} New suite doc is continued \n\ntwice!,thrice?1
Set init file suite docs
Should Be Equal ${SUITE.doc} Init file doc. Concatenated in setup. Appended in test.
- Check Log Message ${SUITE.setup.msgs[0]} Set suite documentation to:\nInit file doc. Concatenated in setup.
+ Check Log Message ${SUITE.setup[0]} Set suite documentation to:\nInit file doc. Concatenated in setup.
Set top level suite documentation
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set suite documentation to:\nInit file doc. Concatenated in setup. Appended in test.
+ Check Log Message ${tc[0, 0]} Set suite documentation to:\nInit file doc. Concatenated in setup. Appended in test.
diff --git a/atest/robot/standard_libraries/builtin/set_library_search_order.robot b/atest/robot/standard_libraries/builtin/set_library_search_order.robot
index 6bc2e12bf8e..f7b692bbc7c 100644
--- a/atest/robot/standard_libraries/builtin/set_library_search_order.robot
+++ b/atest/robot/standard_libraries/builtin/set_library_search_order.robot
@@ -39,3 +39,8 @@ Library Search Order Is Space Insensitive
Library Search Order Is Case Insensitive
Check Test Case ${TEST NAME}
+Search Order Controlled Match Containing Embedded Arguments Wins Over Exact Match
+ Check Test Case ${TEST NAME}
+
+Best Search Order Controlled Match Wins In Library
+ Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/builtin/set_log_level.robot b/atest/robot/standard_libraries/builtin/set_log_level.robot
index 709679cc2c3..621e617125c 100644
--- a/atest/robot/standard_libraries/builtin/set_log_level.robot
+++ b/atest/robot/standard_libraries/builtin/set_log_level.robot
@@ -5,24 +5,36 @@ Resource atest_resource.robot
*** Test Cases ***
Set Log Level
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Log level changed from INFO to TRACE.
- Check Log Message ${tc.kws[1].msgs[1]} This is logged TRACE
- Check Log Message ${tc.kws[2].msgs[1]} This is logged DEBUG
- Check Log Message ${tc.kws[3].msgs[1]} This is logged INFO
- Should Be Empty ${tc.kws[6].msgs}
- Check Log Message ${tc.kws[7].msgs[0]} This is logged DEBUG
- Check Log Message ${tc.kws[8].msgs[0]} This is logged INFO
- Should Be Empty ${tc.kws[10].msgs}
- Should Be Empty ${tc.kws[11].msgs}
- Check Log Message ${tc.kws[12].msgs[0]} This is logged INFO
- Should Be Empty ${tc.kws[15].msgs}
- Check Log Message ${tc.kws[16].msgs[0]} This is logged ERROR
- Should Be Empty ${tc.kws[18].msgs}
- Should Be Empty ${tc.kws[19].msgs}
+ Check Log Message ${tc[0, 0]} Log level changed from INFO to TRACE. DEBUG
+ Check Log Message ${tc[1, 1]} This is logged TRACE
+ Check Log Message ${tc[2, 1]} This is logged DEBUG
+ Check Log Message ${tc[3, 1]} This is logged INFO
+ Check Log Message ${tc[4, 1]} Log level changed from TRACE to DEBUG. DEBUG
+ Should Be Empty ${tc[6].body}
+ Check Log Message ${tc[7, 0]} This is logged DEBUG
+ Check Log Message ${tc[8, 0]} This is logged INFO
+ Should Be Empty ${tc[9].body}
+ Should Be Empty ${tc[10].body}
+ Should Be Empty ${tc[11].body}
+ Check Log Message ${tc[12, 0]} This is logged INFO
+ Should Be Empty ${tc[15].body}
+ Check Log Message ${tc[16, 0]} This is logged ERROR
+ Should Be Empty ${tc[17].body}
+ Should Be Empty ${tc[18].body}
+ Should Be Empty ${tc[19].body}
Invalid Log Level Failure Is Catchable
Check Test Case ${TESTNAME}
+Reset Log Level
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]} Log level changed from INFO to DEBUG. DEBUG
+ Check Log Message ${tc[1, 0]} This is logged INFO
+ Check Log Message ${tc[2, 0]} This is logged DEBUG
+ Should Be Empty ${tc[3].body}
+ Check Log Message ${tc[4, 0]} This is logged INFO
+ Should Be Empty ${tc[5].body}
+
Log Level Goes To HTML
File Should Contain ${OUTDIR}${/}set_log_level_log.html KW Info to log
File Should Contain ${OUTDIR}${/}set_log_level_log.html KW Trace to log
diff --git a/atest/robot/standard_libraries/builtin/set_resource_search_order.robot b/atest/robot/standard_libraries/builtin/set_resource_search_order.robot
index d162ecd82b5..1d0a1bbd403 100644
--- a/atest/robot/standard_libraries/builtin/set_resource_search_order.robot
+++ b/atest/robot/standard_libraries/builtin/set_resource_search_order.robot
@@ -38,3 +38,9 @@ Resource Search Order Is Case Insensitive
Default Resource Order Should Be Suite Specific
Check Test Case ${TEST NAME}
+
+Search Order Controlled Match Containing Embedded Arguments Wins Over Exact Match
+ Check Test Case ${TEST NAME}
+
+Best Search Order Controlled Match Wins In Resource
+ Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/builtin/set_suite_metadata.robot b/atest/robot/standard_libraries/builtin/set_suite_metadata.robot
index 5170c9f8c06..36ca3731efc 100644
--- a/atest/robot/standard_libraries/builtin/set_suite_metadata.robot
+++ b/atest/robot/standard_libraries/builtin/set_suite_metadata.robot
@@ -5,49 +5,62 @@ Resource atest_resource.robot
*** Test Cases ***
Set new value
Metadata should have value New metadata Set in test
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]}
... Set suite metadata 'New metadata' to value 'Set in test'.
Override existing value
Metadata should have value Initial New value
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]}
... Set suite metadata 'Initial' to value 'New value'.
Names are case and space insensitive
Metadata should have value My Name final value
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[1].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[1, 0]}
... Set suite metadata 'MYname' to value 'final value'.
Append to value
Metadata should have value To Append Original is continued \n\ntwice!
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]}
... Set suite metadata 'To Append' to value 'Original'.
- Check log message ${tc.kws[2].msgs[0]}
+ Check Log Message ${tc[2, 0]}
... Set suite metadata 'toappend' to value 'Original is continued'.
- Check log message ${tc.kws[4].msgs[0]}
+ Check Log Message ${tc[4, 0]}
... Set suite metadata 'TOAPPEND' to value 'Original is continued \n\ntwice!'.
+ Check Log Message ${tc[6, 0]}
+ ... Set suite metadata 'Version' to value '1.0'.
+ Check Log Message ${tc[8, 0]}
+ ... Set suite metadata 'version' to value '1.0/2.0'.
+ Check Log Message ${tc[10, 0]}
+ ... Set suite metadata 'ver sion' to value '1.0/2.0/3.0'.
Set top-level suite metadata
Metadata should have value New metadata Metadata for top level suite top=yes
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]}
... Set suite metadata 'New metadata' to value 'Metadata for'.
- Check log message ${tc.kws[1].msgs[0]}
+ Check Log Message ${tc[1, 0]}
... Set suite metadata 'newmetadata' to value 'Metadata for top level suite'.
+ Metadata should have value Separator 2top**level top=yes
+ Check Log Message ${tc[3, 0]}
+ ... Set suite metadata 'Separator' to value '2'.
+ Check Log Message ${tc[4, 0]}
+ ... Set suite metadata 'Separator' to value '2top'.
+ Check Log Message ${tc[5, 0]}
+ ... Set suite metadata 'Separator' to value '2top**level'.
Non-ASCII and non-string names and values
- ${tc} = Check test case ${TESTNAME}
- Check log message ${tc.kws[0].msgs[0]}
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0]}
... Set suite metadata '42' to value '1'.
- Check log message ${tc.kws[2].msgs[0]}
+ Check Log Message ${tc[2, 0]}
... Set suite metadata '42' to value '1 päivä'.
Modifying \${SUITE METADATA} has no effect also after setting metadata
- Check test case ${TESTNAME}
+ Check Test Case ${TESTNAME}
Metadata should have value Cannot be set otherwise
Set in suite setup
diff --git a/atest/robot/standard_libraries/builtin/set_test_message.robot b/atest/robot/standard_libraries/builtin/set_test_message.robot
index 28882ff74d7..bb79583aa1e 100644
--- a/atest/robot/standard_libraries/builtin/set_test_message.robot
+++ b/atest/robot/standard_libraries/builtin/set_test_message.robot
@@ -6,42 +6,44 @@ Resource atest_resource.robot
*** Test Cases ***
Set Message To Successful Test
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy Test
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy Test
Reset Message
Check Test Case ${TEST NAME}
Append To Message
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy
- Check Log Message ${tc.kws[1].msgs[0]} Set test message to:\nMy & its continuation <>
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy
+ Check Log Message ${tc[1, 0]} Set test message to:\nMy & its continuation <>
+ Check Log Message ${tc[2, 0]} Set test message to:\nMy & its continuation <>1
+ Check Log Message ${tc[3, 0]} Set test message to:\nMy & its continuation <>1,\n2
Set Non-ASCII Message
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nHyvää yötä
+ Check Log Message ${tc[0, 0]} Set test message to:\nHyvää yötä
Set Multiline Message
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\n1\n2\n3
+ Check Log Message ${tc[0, 0]} Set test message to:\n1\n2\n3
Set HTML Message
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy HTML message html=True
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy HTML message html=True
Append HTML to non-HTML
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy non-HTML & html=False
- Check Log Message ${tc.kws[1].msgs[0]} Set test message to:\nMy non-HTML <message> & its HTML continuation html=True
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy non-HTML & html=False
+ Check Log Message ${tc[1, 0]} Set test message to:\nMy non-HTML <message> & its HTML continuation html=True
Append non-HTML to HTML
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy HTML message html=True
- Check Log Message ${tc.kws[1].msgs[0]} Set test message to:\nMy HTML message & its non-HTML <continuation> html=True
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy HTML message html=True
+ Check Log Message ${tc[1, 0]} Set test message to:\nMy HTML message & its non-HTML <continuation> html=True
Append HTML to HTML
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Set test message to:\nMy HTML message html=True
- Check Log Message ${tc.kws[1].msgs[0]} Set test message to:\nMy HTML message & its HTML continuation html=True
+ Check Log Message ${tc[0, 0]} Set test message to:\nMy HTML message html=True
+ Check Log Message ${tc[1, 0]} Set test message to:\nMy HTML message & its HTML continuation html=True
Set Non-String Message
Check Test Case ${TEST NAME}
@@ -87,3 +89,18 @@ Not Allowed In Suite Setup or Teardown
... Also suite teardown failed:
... 'Set Test Message' keyword cannot be used in suite setup or teardown.
Should Be Equal ${SUITE.suites[1].message} ${error}
+
+Append HTML to non-HTML with separator
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Set test message to:\nA non HTML html=False
+ Check Log Message ${tc[1, 0]} Set test message to:\nA non HTML <message>&its HTML continuation html=True
+
+Append non-HTML to HTML with separator
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Set test message to:\nA HTML message html=True
+ Check Log Message ${tc[1, 0]} Set test message to:\nA HTML message<\br>its non-HTML <continuation> html=True
+
+Append HTML to HTML with separator
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Set test message to:\nA HTML message html=True
+ Check Log Message ${tc[1, 0]} Set test message to:\nA HTML message && its HTML continuation html=True
diff --git a/atest/robot/standard_libraries/builtin/set_variable_if.robot b/atest/robot/standard_libraries/builtin/set_variable_if.robot
index 622fd25d053..c49447cb33e 100644
--- a/atest/robot/standard_libraries/builtin/set_variable_if.robot
+++ b/atest/robot/standard_libraries/builtin/set_variable_if.robot
@@ -46,3 +46,5 @@ With List Variables In Expressions And Values
With List Variables Containing Escaped Values
Check Test Case ${TESTNAME}
+Lot of conditions
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/setting_variables.robot b/atest/robot/standard_libraries/builtin/setting_variables.robot
index c889df6f63f..18aa6b8d2b0 100644
--- a/atest/robot/standard_libraries/builtin/setting_variables.robot
+++ b/atest/robot/standard_libraries/builtin/setting_variables.robot
@@ -1,30 +1,30 @@
-*** Setting ***
+*** Settings ***
Documentation Tests for set variable and set test/suite/global variable keywords
Suite Setup Run Tests
... --variable cli_var_1:CLI1 --variable cli_var_2:CLI2 --variable cli_var_3:CLI3
... standard_libraries/builtin/setting_variables
Resource atest_resource.robot
-*** Test Case ***
+*** Test Cases ***
Set Variable
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} \${var} = Hello
+ Check Log Message ${tc[0, 0]} \${var} = Hello
Set Variable With More Or Less Than One Value
Check Test Case ${TESTNAME}
Set Local Variable - Scalars
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} \${scalar} = Hello world
+ Check Log Message ${tc[1, 0]} \${scalar} = Hello world
Set Local Variable - Lists
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[3].msgs[0]} \@{list} = [ One | Two | Three ]
- Check Log Message ${tc.kws[6].msgs[0]} \@{list} = [ 1 | 2 | 3 ]
+ Check Log Message ${tc[3, 0]} \@{list} = [ One | Two | Three ]
+ Check Log Message ${tc[6, 0]} \@{list} = [ 1 | 2 | 3 ]
Set Local Variable - Dicts
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[4].msgs[0]} \&{DICT} = { a=1 | 2=b }
+ Check Log Message ${tc[4, 0]} \&{DICT} = { a=1 | 2=b }
Set Local Variables Overrides Test Variables
Check Test Case ${TESTNAME}
@@ -56,7 +56,7 @@ Set Test Variable Needing Escaping
Set Test Variable Affect Subsequent Keywords
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].doc} Makes a variable available everywhere within the scope of the current test.
+ Should Be Equal ${tc[0].doc} Makes a variable available everywhere within the scope of the current test.
Set Test Variable In User Keyword
Check Test Case ${TESTNAME}
@@ -67,12 +67,18 @@ Set Test Variable Not Affecting Other Tests
Test Variables Set In One Suite Are Not Available In Another
Check Test Case ${TESTNAME}
-Set Test Variable cannot be used in suite setup or teardown
+Test variables set on suite level is not seen in tests
+ Check Test Case ${TESTNAME}
+
+Test variable set on suite level does not hide existing suite variable
+ Check Test Case ${TESTNAME}
+
+Test variable set on suite level can be overridden as suite variable
Check Test Case ${TESTNAME}
Set Task Variable as alias for Set Test Variable
${tc} = Check Test Case ${TESTNAME}
- Should Be Equal ${tc.kws[0].doc} Makes a variable available everywhere within the scope of the current task.
+ Should Be Equal ${tc[0].doc} Makes a variable available everywhere within the scope of the current task.
Set Suite Variable
Check Test Case ${TESTNAME} 1
@@ -174,7 +180,7 @@ Setting scalar global variable with list value is not possible
Check Test Case ${TEST NAME} 1
Check Test Case ${TEST NAME} 2
-*** Keyword ***
+*** Keywords ***
Check Suite Teardown Passed
${suite} = Get Test Suite Variables
Should Be Equal ${suite.teardown.status} PASS
diff --git a/atest/robot/standard_libraries/builtin/should_be_equal.robot b/atest/robot/standard_libraries/builtin/should_be_equal.robot
index 30f8f35dd31..e7b43a6fd3f 100644
--- a/atest/robot/standard_libraries/builtin/should_be_equal.robot
+++ b/atest/robot/standard_libraries/builtin/should_be_equal.robot
@@ -5,11 +5,11 @@ Resource builtin_resource.robot
*** Test Cases ***
Basics
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
- Verify argument type message ${tc.kws[1].msgs[0]}
- Verify argument type message ${tc.kws[2].msgs[0]} float int
- Verify argument type message ${tc.kws[3].msgs[0]} bytes bytes
- Verify argument type message ${tc.kws[4].msgs[0]}
+ Verify argument type message ${tc[0, 0]}
+ Verify argument type message ${tc[1, 0]}
+ Verify argument type message ${tc[2, 0]} float int
+ Verify argument type message ${tc[3, 0]} bytes bytes
+ Verify argument type message ${tc[4, 0]}
Case-insensitive
Check Test Case ${TESTNAME}
@@ -29,19 +29,30 @@ Do not collapse spaces
Collapse spaces
Check Test Case ${TESTNAME}
+Normalization with bytes
+ Check Test Case ${TESTNAME}
+
+Auto conversion with bytes
+ Check Test Case ${TESTNAME}
+
Fails with values
Check test case ${TESTNAME}
Fails without values
Check test case ${TESTNAME}
+NO VALUES is deprecated
+ ${tc} = Check test case ${TESTNAME}
+ Check Log Message ${tc[0, 1]} Using 'NO VALUES' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[1, 1]} Using 'no values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+
Multiline comparison uses diff
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
+ Check Log Message ${tc[0, 1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
Multiline comparison with custom message
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
+ Check Log Message ${tc[0, 1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
Multiline comparison requires both multiline
Check test case ${TESTNAME}
@@ -57,17 +68,18 @@ formatter=repr/ascii with non-ASCII characters
formatter=repr with multiline
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
+ Check Log Message ${tc[0, 1]} foo\nbar\ndar\n\n!=\n\nfoo\nbar\ngar\n\ndar
formatter=repr with multiline and different line endings
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[1]} 1\n2\n3\n\n!=\n\n1\n2\n3
- Check Log Message ${tc.kws[1].msgs[1]} 1\n2\n3\n\n!=\n\n1\n2\n3
+ Check Log Message ${tc[0, 1]} 1\n2\n3\n\n!=\n\n1\n2\n3
+ Check Log Message ${tc[1, 1]} 1\n2\n3\n\n!=\n\n1\n2\n3
formatter=repr/ascii with multiline and non-ASCII characters
${tc} = Check test case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[1]} Å\nÄ\n\Ö\n\n!=\n\nÅ\nÄ\n\Ö
- Check Log Message ${tc.kws[1].msgs[1]} Å\nÄ\n\Ö\n\n!=\n\nÅ\nÄ\n\Ö
+ Check Log Message ${tc[0, 1]} Å\nÄ\n\Ö\n\n!=\n\nÅ\nA\u0308\n\Ö
+ Check Log Message ${tc[1, 1]} Å\nÄ\n\Ö\n\n!=\n\nÅ\nA\u0308\n\Ö
+ Check Log Message ${tc[2, 1]} Å\nÄ\n\Ö\n\n!=\n\nÅ\nA\u0308\n\Ö
Invalid formatter
Check test case ${TESTNAME}
@@ -80,22 +92,33 @@ Dictionaries of different type with same items pass
Bytes containing non-ascii characters
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} bytes bytes
- Verify argument type message ${tc.kws[1].msgs[0]} bytes bytes
+ Verify argument type message ${tc[0, 0]} bytes bytes
+ Verify argument type message ${tc[1, 0]} bytes bytes
Unicode and bytes with non-ascii characters
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} bytes str
+ Verify argument type message ${tc[0, 0]} bytes str
Types info is added if string representations are same
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} str int
+ Verify argument type message ${tc[0, 0]} str int
Should Not Be Equal
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} str str
- Verify argument type message ${tc.kws[1].msgs[0]} str int
- Verify argument type message ${tc.kws[2].msgs[0]} str str
+ Verify argument type message ${tc[0, 0]} str str
+ Verify argument type message ${tc[1, 0]} str int
+ Verify argument type message ${tc[2, 0]} str str
+
+Should Not Be Equal with custom message
+ Check Test Case ${TESTNAME}
+
+Should Not Be Equal with custom message without values
+ Check Test Case ${TESTNAME}
+
+Should Not Be Equal with deprecated NO VALUES
+ ${tc} = Check test case ${TESTNAME}
+ Check Log Message ${tc[0, 1]} Using 'no values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[1, 1]} Using 'NO VALUES' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
Should Not Be Equal case-insensitive
Check Test Case ${TESTNAME}
@@ -115,8 +138,14 @@ Should Not Be Equal and do not collapse spaces
Should Not Be Equal and collapse spaces
Check Test Case ${TESTNAME}
+Should Not Be Equal with bytes normalization
+ Check Test Case ${TESTNAME}
+
+Should Not Be Equal with bytes auto conversion
+ Check Test Case ${TESTNAME}
+
Should Not Be Equal with bytes containing non-ascii characters
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} bytes bytes
- Verify argument type message ${tc.kws[1].msgs[0]} bytes str
- Verify argument type message ${tc.kws[2].msgs[0]} bytes bytes
+ Verify argument type message ${tc[0, 0]} bytes bytes
+ Verify argument type message ${tc[1, 0]} bytes str
+ Verify argument type message ${tc[2, 0]} bytes bytes
diff --git a/atest/robot/standard_libraries/builtin/should_be_equal_as_xxx.robot b/atest/robot/standard_libraries/builtin/should_be_equal_as_xxx.robot
index 15d42822d4e..c571788cffc 100644
--- a/atest/robot/standard_libraries/builtin/should_be_equal_as_xxx.robot
+++ b/atest/robot/standard_libraries/builtin/should_be_equal_as_xxx.robot
@@ -5,35 +5,35 @@ Resource builtin_resource.robot
*** Test Cases ***
Should Be Equal As Integers
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0]}
Should Be Equal As Integers with base
Check test case ${TESTNAME}
Should Not Be Equal As Integers
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0]}
Should Not Be Equal As Integers with base
Check test case ${TESTNAME}
Should Be Equal As Numbers
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0]}
Should Be Equal As Numbers with precision
Check test case ${TESTNAME}
Should Not Be Equal As Numbers
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]}
+ Verify argument type message ${tc[0, 0]}
Should Not Be Equal As Numbers with precision
Check test case ${TESTNAME}
Should Be Equal As Strings
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} int
+ Verify argument type message ${tc[0, 0]} int
Should Be Equal As Strings does NFC normalization
Check test case ${TESTNAME}
@@ -70,7 +70,7 @@ Should Be Equal As Strings repr multiline
Should Not Be Equal As Strings
${tc}= Check test case ${TESTNAME}
- Verify argument type message ${tc.kws[0].msgs[0]} str float
+ Verify argument type message ${tc[0, 0]} str float
Should Not Be Equal As Strings case-insensitive
Check test case ${TESTNAME}
diff --git a/atest/robot/cli/dryrun/reserved.robot b/atest/robot/standard_libraries/builtin/should_be_equal_type_conversion.robot
similarity index 50%
rename from atest/robot/cli/dryrun/reserved.robot
rename to atest/robot/standard_libraries/builtin/should_be_equal_type_conversion.robot
index 30f74ad484f..752d7ad340b 100644
--- a/atest/robot/cli/dryrun/reserved.robot
+++ b/atest/robot/standard_libraries/builtin/should_be_equal_type_conversion.robot
@@ -1,40 +1,37 @@
*** Settings ***
-Suite Setup Run Tests --dryrun cli/dryrun/reserved.robot
+Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/should_be_equal_type_conversion.robot
Resource atest_resource.robot
*** Test Cases ***
-For
+Convert second argument using `type`
Check Test Case ${TESTNAME}
-Valid END after For
+Automatic `type`
Check Test Case ${TESTNAME}
-If
+Automatic `type` doesn't handle nested types
Check Test Case ${TESTNAME}
-Else If
+First argument must match `type`
Check Test Case ${TESTNAME}
-Else
+Conversion fails with `type`
Check Test Case ${TESTNAME}
-Else inside valid IF
+Invalid type with `type`
Check Test Case ${TESTNAME}
-Else If inside valid IF
+Convert both arguments using `types`
Check Test Case ${TESTNAME}
-End
+Conversion fails with `types`
Check Test Case ${TESTNAME}
-End after valid FOR header
+Invalid type with `types`
Check Test Case ${TESTNAME}
-End after valid If header
+Cannot use both `type` and `types`
Check Test Case ${TESTNAME}
-Reserved inside FOR
- Check Test Case ${TESTNAME}
-
-Reserved inside IF
+Automatic type doesn't work with `types`
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/should_be_true.robot b/atest/robot/standard_libraries/builtin/should_be_true.robot
index 7563d773542..e870ab99437 100644
--- a/atest/robot/standard_libraries/builtin/should_be_true.robot
+++ b/atest/robot/standard_libraries/builtin/should_be_true.robot
@@ -26,3 +26,6 @@ Should (Not) Be True automatically imports modules
Should (Not) Be True is evaluated with robot's variables
Check test case ${TESTNAME}
+
+Should (Not) Be True uses non-strings directly
+ Check test case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/should_contain.robot b/atest/robot/standard_libraries/builtin/should_contain.robot
index 148c1dc50ba..e5f5264e77d 100644
--- a/atest/robot/standard_libraries/builtin/should_contain.robot
+++ b/atest/robot/standard_libraries/builtin/should_contain.robot
@@ -27,6 +27,12 @@ Should Contain and do not collapse spaces
Should Contain and collapse spaces
Check Test Case ${TESTNAME}
+Should Contain with recursive normalization
+ Check Test Case ${TESTNAME}
+
+Should Contain with bytes auto conversion
+ Check Test Case ${TESTNAME}
+
Should Not Contain
Check test case ${TESTNAME}
@@ -50,3 +56,6 @@ Should Not Contain and do not collapse spaces
Should Not Contain and collapse spaces
Check Test Case ${TESTNAME}
+
+Should Not Contain with bytes auto conversion
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/should_contain_any.robot b/atest/robot/standard_libraries/builtin/should_contain_any.robot
index cea0645b887..4eeabe64426 100644
--- a/atest/robot/standard_libraries/builtin/should_contain_any.robot
+++ b/atest/robot/standard_libraries/builtin/should_contain_any.robot
@@ -9,9 +9,6 @@ Should Contain Any
Should Contain Any failing
Check test case ${TESTNAME}
-Should Contain Any without items fails
- Check test case ${TESTNAME}
-
Should Contain Any case-insensitive
Check test case ${TESTNAME}
@@ -30,6 +27,15 @@ Should Contain Any and do not collapse spaces
Should Contain Any and collapse spaces
Check test case ${TESTNAME}
+Should Contain Any with recursive normalization
+ Check test case ${TESTNAME}
+
+Should Contain Any with bytes auto conversion
+ Check test case ${TESTNAME}
+
+Should Contain Any without items fails
+ Check test case ${TESTNAME}
+
Should Contain Any with invalid configuration
Check test case ${TESTNAME}
@@ -39,9 +45,6 @@ Should Not Contain Any
Should Not Contain Any failing
Check test case ${TESTNAME}
-Should Not Contain Any without items fails
- Check test case ${TESTNAME}
-
Should Not Contain Any case-insensitive
Check test case ${TESTNAME}
@@ -60,5 +63,11 @@ Should Not Contain Any and do not collapse spaces
Should Not Contain Any and collapse spaces
Check test case ${TESTNAME}
+Should Not Contain Any with bytes auto conversion
+ Check test case ${TESTNAME}
+
+Should Not Contain Any without items fails
+ Check test case ${TESTNAME}
+
Should Not Contain Any with invalid configuration
Check test case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/should_match.robot b/atest/robot/standard_libraries/builtin/should_match.robot
index 9614035c6a8..d0a668ad9ee 100644
--- a/atest/robot/standard_libraries/builtin/should_match.robot
+++ b/atest/robot/standard_libraries/builtin/should_match.robot
@@ -12,7 +12,7 @@ Should Match with extra trailing newline
Should Match case-insensitive
Check test case ${TESTNAME}
-Should Match does not work with bytes
+ Should Match with bytes
Check test case ${TESTNAME}
Should Not Match
@@ -21,14 +21,26 @@ Should Not Match
Should Not Match case-insensitive
Check test case ${TESTNAME}
+ Should Not Match with bytes
+ Check test case ${TESTNAME}
+
Should Match Regexp
Check test case ${TESTNAME}
Should Match Regexp returns match and groups
Check test case ${TESTNAME}
-Should Match Regexp with bytes containing non-ascii characters
+Should Match Regexp with bytes
+ Check test case ${TESTNAME}
+
+Should Match Regexp with bytes autoconversion
Check test case ${TESTNAME}
Should Not Match Regexp
Check test case ${TESTNAME}
+
+Should Not Match Regexp with bytes
+ Check test case ${TESTNAME}
+
+Should Not Match Regexp with bytes auto conversion
+ Check test case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/should_xxx_with.robot b/atest/robot/standard_libraries/builtin/should_xxx_with.robot
index 6779a109dca..5d4e022a208 100644
--- a/atest/robot/standard_libraries/builtin/should_xxx_with.robot
+++ b/atest/robot/standard_libraries/builtin/should_xxx_with.robot
@@ -6,10 +6,10 @@ Resource builtin_resource.robot
Should Start With
Check test case ${TESTNAME}
-Should Start With case-insensitive
+Should Start With without values
Check test case ${TESTNAME}
-Should Start With without values
+Should Start With case-insensitive
Check test case ${TESTNAME}
Should Start With without leading spaces
@@ -27,9 +27,18 @@ Should Start With and do not collapse spaces
Should Start With and collapse spaces
Check test case ${TESTNAME}
+Should Start With with bytes normalization
+ Check test case ${TESTNAME}
+
+Should Start With with bytes auto conversion
+ Check test case ${TESTNAME}
+
Should Not Start With
Check test case ${TESTNAME}
+Should Not Start With without values
+ Check test case ${TESTNAME}
+
Should Not Start With case-insensitive
Check test case ${TESTNAME}
@@ -48,9 +57,18 @@ Should Not Start With and do not collapse spaces
Should Not Start With and collapse spaces
Check test case ${TESTNAME}
+Should Not Start With with bytes normalization
+ Check test case ${TESTNAME}
+
+Should Not Start With with bytes conversion
+ Check test case ${TESTNAME}
+
Should End With
Check test case ${TESTNAME}
+Should End With without values
+ Check test case ${TESTNAME}
+
Should End With case-insensitive
Check test case ${TESTNAME}
@@ -69,7 +87,10 @@ Should End With and do not collapse spaces
Should End With and collapse spaces
Check test case ${TESTNAME}
-Should End With without values
+Should End With with bytes normalization
+ Check test case ${TESTNAME}
+
+Should End With with bytes auto conversion
Check test case ${TESTNAME}
Should Not End With
@@ -92,3 +113,16 @@ Should Not End With and do not collapse spaces
Should Not End With and collapse spaces
Check test case ${TESTNAME}
+
+Should Not End With with bytes normalization
+ Check test case ${TESTNAME}
+
+Should Not End With with bytes conversion
+ Check test case ${TESTNAME}
+
+NO VALUES is deprecated
+ ${tc} = Check test case ${TESTNAME}
+ Check Log Message ${tc[0, 0]} Using 'NO VALUES' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[1, 0]} Using 'no values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[2, 0]} Using 'No values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[3, 0]} Using 'No Values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
diff --git a/atest/robot/standard_libraries/builtin/sleep.robot b/atest/robot/standard_libraries/builtin/sleep.robot
index fbfc2b8a254..454392bdafa 100644
--- a/atest/robot/standard_libraries/builtin/sleep.robot
+++ b/atest/robot/standard_libraries/builtin/sleep.robot
@@ -5,24 +5,23 @@ Resource atest_resource.robot
*** Test Cases ***
Sleep
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} Slept 1 second 111 milliseconds
- Check Log Message ${tc.kws[3].msgs[0]} Slept 1 second 234 milliseconds
- Check Log Message ${tc.kws[5].msgs[0]} Slept 1 second 112 milliseconds
+ Check Log Message ${tc[1, 0]} Slept 1 second 111 milliseconds.
+ Check Log Message ${tc[3, 0]} Slept 1 second 234 milliseconds.
+ Check Log Message ${tc[5, 0]} Slept 1 second 112 milliseconds.
Sleep With Negative Time
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[1].msgs[0]} Slept 0 seconds
- Check Log Message ${tc.kws[2].msgs[0]} Slept 0 seconds
+ Check Log Message ${tc[1, 0]} Slept 0 seconds.
+ Check Log Message ${tc[2, 0]} Slept 0 seconds.
Sleep With Reason
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Slept 42 milliseconds
- Check Log Message ${tc.kws[0].msgs[1]} No good reason
+ Check Log Message ${tc[0, 0]} Slept 42 milliseconds.
+ Check Log Message ${tc[0, 1]} No good reason
Invalid Time Does Not Cause Uncatchable Error
Check Test Case ${TESTNAME}
Can Stop Sleep With Timeout
${tc}= Check Test Case ${TESTNAME}
- Should Be True ${tc.elapsedtime} < 10000
-
+ Elapsed Time Should Be Valid ${tc.elapsed_time} maximum=10
diff --git a/atest/robot/standard_libraries/builtin/tags.robot b/atest/robot/standard_libraries/builtin/tags.robot
index b3b5792ae69..0a4bf8eca0e 100644
--- a/atest/robot/standard_libraries/builtin/tags.robot
+++ b/atest/robot/standard_libraries/builtin/tags.robot
@@ -1,61 +1,61 @@
*** Settings ***
-Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/tags
-Resource atest_resource.robot
+Suite Setup Run Tests ${EMPTY} standard_libraries/builtin/tags
+Resource atest_resource.robot
*** Variables ***
-@{SUITE_TAGS} default force force-init set set-init
+@{SUITE_TAGS} default force force-init set set-init
*** Test Cases ***
Set And Remove Tags In Suite Level
- Should Have Only Suite Tags Set And Remove Tags In Suite Level
+ Should Have Only Suite Tags Set And Remove Tags In Suite Level
Set No Tags
- Should Have Only Suite Tags Set No Tags
+ Should Have Only Suite Tags Set No Tags
Set One Tag
- ${tc} = Tags Should Have Been Added Set One Tag one
- Check Log Message ${tc.kws[0].msgs[0]} Set tag 'one'.
+ ${tc} = Tags Should Have Been Added Set One Tag one
+ Check Log Message ${tc[0, 0]} Set tag 'one'.
Set Multiple Tags
- ${tc} = Tags Should Have Been Added Set Multiple Tags 1 2 3 HELLO Some spaces here
- Check Log Message ${tc.kws[0].msgs[0]} Set tags '1', '2' and '3'.
- Check Log Message ${tc.kws[1].msgs[0]} Set tags 'HELLO', '' and 'Some spaces here'.
+ ${tc} = Tags Should Have Been Added Set Multiple Tags 1 2 3 HELLO Some spaces here
+ Check Log Message ${tc[0, 0]} Set tags '1', '2' and '3'.
+ Check Log Message ${tc[1, 0]} Set tags 'HELLO', '' and 'Some spaces here'.
Tags Set In One Test Are Not Visible To Others
- Should Have Only Suite Tags Tags Set In One Test Are Not Visible To Others
+ Should Have Only Suite Tags Tags Set In One Test Are Not Visible To Others
Remove No Tags
- Should Have Only Suite Tags Remove No Tags
+ Should Have Only Suite Tags Remove No Tags
Remove One Tag
- ${tc} = Tags Should Have Been Removed Remove One Tag force
- Check Log Message ${tc.kws[0].msgs[0]} Removed tag 'force'.
+ ${tc} = Tags Should Have Been Removed Remove One Tag force
+ Check Log Message ${tc[0, 0]} Removed tag 'force'.
Remove Non-Existing Tag
- Should Have Only Suite Tags Remove Non-Existing Tag
+ Should Have Only Suite Tags Remove Non-Existing Tag
Remove Multiple Tags
- ${tc} = Tags Should Have Been Removed Remove Multiple Tags default set set-init
- Check Log Message ${tc.kws[0].msgs[0]} Removed tags 'default', 'SET' and 'non-existing'.
- Check Log Message ${tc.kws[1].msgs[0]} Removed tags '' and 'set-init'.
+ ${tc} = Tags Should Have Been Removed Remove Multiple Tags default set set-init
+ Check Log Message ${tc[0, 0]} Removed tags 'default', 'SET' and 'non-existing'.
+ Check Log Message ${tc[1, 0]} Removed tags '' and 'set-init'.
Remove Tags With Pattern
- Check Test Tags Remove Tags With Pattern
+ Check Test Tags Remove Tags With Pattern
Tags Removed In One Test Are Not Removed From Others
- Should Have Only Suite Tags Tags Removed In One Test Are Not Removed From Others
+ Should Have Only Suite Tags Tags Removed In One Test Are Not Removed From Others
Set And Remove Tags In A User Keyword
- Check Test Tags Set And Remove Tags In A User Keyword tc uk uk2
+ Check Test Tags Set And Remove Tags In A User Keyword tc uk uk2
Set Tags In Test Setup
- Check Test Tags Set Tags In Test Setup set-init setup tag
+ Check Test Tags Set Tags In Test Setup set-init setup tag
Set Tags In Test Teardown
- Check Test Tags Set Tags In Test Teardown set-init teardown
+ Check Test Tags Set Tags In Test Teardown set-init teardown
Using Set And Remove Tags In Suite Teardown Fails
- Should Be Equal ${SUITE.suites[1].message} Suite teardown failed:\n'Set Tags' cannot be used in suite teardown.
+ Should Be Equal ${SUITE.suites[1].message} Suite teardown failed:\n'Set Tags' cannot be used in suite teardown.
Modifying ${TEST TAGS} after setting them has no affect on tags test has
Check Test Tags ${TEST NAME} force-init set-init new
@@ -65,19 +65,19 @@ Modifying ${TEST TAGS} after removing them has no affect on tags test has
*** Keywords ***
Should Have Only Suite Tags
- [Arguments] ${testname}
- Check Test Tags ${testname} @{SUITE_TAGS}
+ [Arguments] ${testname}
+ Check Test Tags ${testname} @{SUITE_TAGS}
Tags Should Have Been Added
- [Arguments] ${testname} @{added}
- @{tags} = Create List @{SUITE_TAGS} @{added}
- Sort List ${tags}
- ${tc} = Check Test Tags ${testname} @{tags}
- [Return] ${tc}
+ [Arguments] ${testname} @{added}
+ @{tags} = Create List @{SUITE_TAGS} @{added}
+ Sort List ${tags}
+ ${tc} = Check Test Tags ${testname} @{tags}
+ RETURN ${tc}
Tags Should Have Been Removed
- [Arguments] ${testname} @{removed}
- @{tags} = Copy List ${SUITE_TAGS}
- Remove Values From List ${tags} @{removed}
- ${tc} = Check Test Tags ${testname} @{tags}
- [Return] ${tc}
+ [Arguments] ${testname} @{removed}
+ @{tags} = Copy List ${SUITE_TAGS}
+ Remove Values From List ${tags} @{removed}
+ ${tc} = Check Test Tags ${testname} @{tags}
+ RETURN ${tc}
diff --git a/atest/robot/standard_libraries/builtin/used_in_custom_libs_and_listeners.robot b/atest/robot/standard_libraries/builtin/used_in_custom_libs_and_listeners.robot
index 8c2293677cf..3eaeb68e554 100644
--- a/atest/robot/standard_libraries/builtin/used_in_custom_libs_and_listeners.robot
+++ b/atest/robot/standard_libraries/builtin/used_in_custom_libs_and_listeners.robot
@@ -1,38 +1,71 @@
*** Settings ***
-Documentation These tests mainly verify that using BuiltIn externally does not cause importing problems as in
-... https://github.com/robotframework/robotframework/issues/654.
-... There are separate tests for creating and registering Run Keyword variants.
-Suite Setup Run Tests --listener ${CURDIR}/listener_using_builtin.py standard_libraries/builtin/used_in_custom_libs_and_listeners.robot
+Suite Setup Run Tests
+... --listener ${CURDIR}/listener_using_builtin.py
+... standard_libraries/builtin/used_in_custom_libs_and_listeners.robot
Resource atest_resource.robot
*** Test Cases ***
Keywords Using BuiltIn
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Log level changed from INFO to DEBUG.
- Check Log Message ${tc.kws[0].msgs[1]} Hello, debug world! DEBUG
+ Check Log Message ${tc[0, 0]} Log level changed from NONE to DEBUG. DEBUG
+ Check Log Message ${tc[0, 1]} Hello, debug world! DEBUG
+ Length should be ${tc[0].messages} 2
+
+Named argument syntax
+ Check Test Case ${TESTNAME}
Listener Using BuiltIn
Check Test Case ${TESTNAME}
-Use 'Run Keyword' with non-Unicode values
+Use 'Run Keyword' with non-string values
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} 42
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} \\xff
+ Check Log Message ${tc[0, 0, 0]} 42
+ Check Log Message ${tc[0, 1, 0]} \xff
+
+Use dictionary returned by 'Get Variables' with non-string keys
+ Check Test Case ${TESTNAME}
Use BuiltIn keywords with timeouts
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
- Check Log Message ${tc.kws[0].msgs[1]} Log level changed from INFO to DEBUG.
- Check Log Message ${tc.kws[0].msgs[2]} Hello, debug world! DEBUG
- Check Log Message ${tc.kws[3].kws[0].msgs[0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
- Check Log Message ${tc.kws[3].kws[0].msgs[1]} 42
- Check Log Message ${tc.kws[3].kws[1].msgs[0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
- Check Log Message ${tc.kws[3].kws[1].msgs[1]} \\xff
+ Check Log Message ${tc[0, 0]} Log level changed from NONE to DEBUG. DEBUG
+ Check Log Message ${tc[0, 1]} Hello, debug world! DEBUG
+ Length should be ${tc[0].messages} 2
+ Check Log Message ${tc[3, 0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[3, 1, 0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[3, 1, 1]} 42
+ Check Log Message ${tc[3, 2, 0]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[3, 2, 1]} \xff
User keyword used via 'Run Keyword'
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} This is x-911-zzz
+ Check Log Message ${tc[0, 0]} Before
+ Check Log Message ${tc[0, 1, 0, 0]} This is x-911-zzz
+ Check Log Message ${tc[0, 2]} After
User keyword used via 'Run Keyword' with timeout and trace level
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[1]} This is x-911-zzz
+ Check Log Message ${tc[0, 0]} Arguments: [ \ ] level=TRACE
+ Check Log Message ${tc[0, 1]} Test timeout 1 day active. * seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[0, 2]} Before
+ Check Log Message ${tc[0, 3, 0]} Arguments: [ \${x}='This is x' | \${y}=911 | \${z}='zzz' ] level=TRACE
+ Check Log Message ${tc[0, 3, 1, 0]} Arguments: [ 'This is x-911-zzz' ] level=TRACE
+ Check Log Message ${tc[0, 3, 1, 1]} Keyword timeout 1 hour active. * seconds left. level=DEBUG pattern=True
+ Check Log Message ${tc[0, 3, 1, 2]} This is x-911-zzz
+ Check Log Message ${tc[0, 3, 1, 3]} Return: None level=TRACE
+ Check Log Message ${tc[0, 3, 2]} Return: None level=TRACE
+ Check Log Message ${tc[0, 4]} After
+ Check Log Message ${tc[0, 5]} Return: None level=TRACE
+
+Recursive 'Run Keyword' usage
+ ${tc} = Check Test Case ${TESTNAME}
+ Check Log Message ${tc[0, 0, 0]} 1
+ Check Log Message ${tc[0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0]} 10
+
+Recursive 'Run Keyword' usage with timeout
+ Check Test Case ${TESTNAME}
+
+Timeout when running keyword that logs huge message
+ Check Test Case ${TESTNAME}
+
+Timeout in parent keyword after running keyword
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot b/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot
index 6fb39ca708b..da2e5d8b791 100644
--- a/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot
+++ b/atest/robot/standard_libraries/builtin/wait_until_keyword_succeeds.robot
@@ -6,20 +6,20 @@ Resource atest_resource.robot
Fail Because Timeout exceeded
${tc} = Check Test Case ${TESTNAME}
# Cannot test exactly how many times kw is run because it depends on interpreter speed.
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Still 2 times to fail! FAIL
- Should Be True len($tc.kws[0].kws) < 4
+ Check Log Message ${tc[0, 0, 0]} Still 2 times to fail! FAIL
+ Should Be True len($tc[0].non_messages) < 4
Pass with first Try
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Used to test that variable name, not value, is shown in arguments
- Length Should Be ${tc.kws[0].kws} 1
+ Check Log Message ${tc[0, 0, 0]} Used to test that variable name, not value, is shown in arguments
+ Length Should Be ${tc[0].body} 1
Pass With Some Medium Try
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].msgs[0]} Still 2 times to fail! FAIL
- Check Log Message ${tc.kws[0].kws[1].msgs[0]} Still 1 times to fail! FAIL
- Check Log Message ${tc.kws[0].kws[2].msgs[0]} Still 0 times to fail! FAIL
- Length Should Be ${tc.kws[0].kws} 4
+ Check Log Message ${tc[0, 0, 0]} Still 2 times to fail! FAIL
+ Check Log Message ${tc[0, 1, 0]} Still 1 times to fail! FAIL
+ Check Log Message ${tc[0, 2, 0]} Still 0 times to fail! FAIL
+ Length Should Be ${tc[0].body} 4
Pass With Last Possible Try
Check Test Case ${TESTNAME}
@@ -69,51 +69,57 @@ Retry count must be positive
Check Test Case ${TESTNAME} 1
Check Test Case ${TESTNAME} 2
-Invalid Number Of Arguments Inside Wait Until Keyword Succeeds
+No retry after syntax error
Check Test Case ${TESTNAME}
-Invalid Keyword Inside Wait Until Keyword Succeeds
+No retry if keyword name is not string
Check Test Case ${TESTNAME}
-Keyword Not Found Inside Wait Until Keyword Succeeds
+Retry if keyword is not found
Check Test Case ${TESTNAME}
-Fail With Nonexisting Variable Inside Wait Until Keyword Succeeds
+Retry if wrong number of arguments
+ Check Test Case ${TESTNAME}
+
+Retry if variable is not found
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Variable '\${nonexisting}' not found. FAIL
- Check Log Message ${tc.kws[0].kws[1].kws[0].msgs[0]} Variable '\${nonexisting}' not found. FAIL
- Check Log Message ${tc.kws[0].kws[2].kws[0].msgs[0]} Variable '\${nonexisting}' not found. FAIL
- Length Should Be ${tc.kws[0].kws} 3
+ Check Log Message ${tc[0, 0, 0, 0]} Variable '\${nonexisting}' not found. FAIL
+ Check Log Message ${tc[0, 1, 0, 0]} Variable '\${nonexisting}' not found. FAIL
+ Check Log Message ${tc[0, 2, 0, 0]} Variable '\${nonexisting}' not found. FAIL
+ Length Should Be ${tc[0].non_messages} 3
Pass With Initially Nonexisting Variable Inside Wait Until Keyword Succeeds
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].kws[0].kws[0].msgs[0]} Variable '\${created after accessing first time}' not found. FAIL
- Check Log Message ${tc.kws[0].kws[1].kws[0].msgs[0]} created in keyword teardown
- Length Should Be ${tc.kws[0].kws} 2
+ Check Log Message ${tc[0, 0, 0, 0]} Variable '\${created after accessing first time}' not found. FAIL
+ Check Log Message ${tc[0, 1, 0, 0]} created in keyword teardown
+ Length Should Be ${tc[0].body} 2
Variable Values Should Not Be Visible In Keyword Arguments
${tc} = Check Test Case Pass With First Try
- Check Keyword Data ${tc.kws[0].kws[0]} BuiltIn.Log args=\${HELLO}
+ Check Keyword Data ${tc[0, 0]} BuiltIn.Log args=\${HELLO}
Strict retry interval
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.body[0].kws} 4
- Should Be True 300 <= ${tc.body[0].elapsedtime} < 900
+ Length Should Be ${tc[0].body} 4
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.3 maximum=0.9
Fail with strict retry interval
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.body[0].kws} 3
- Should Be True 200 <= ${tc.body[0].elapsedtime} < 600
+ Length Should Be ${tc[0].non_messages} 3
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.2 maximum=0.6
Strict retry interval violation
${tc} = Check Test Case ${TESTNAME}
- Length Should Be ${tc.body[0].kws} 4
- Should Be True 400 <= ${tc.body[0].elapsedtime} < 1200
+ Length Should Be ${tc[0].non_messages} 4
+ Elapsed Time Should Be Valid ${tc[0].elapsed_time} minimum=0.4 maximum=1.2
FOR ${index} IN 1 3 5 7
- Check Log Message ${tc.body[0].body[${index}]}
+ Check Log Message ${tc[0, ${index}]}
... Keyword execution time ??? milliseconds is longer than retry interval 100 milliseconds.
... WARN pattern=True
END
Strict and invalid retry interval
Check Test Case ${TESTNAME}
+
+Keyword name as variable
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/collections/dictionaries_should_be_equal.robot b/atest/robot/standard_libraries/collections/dictionaries_should_be_equal.robot
new file mode 100644
index 00000000000..6ac9f3cbbb9
--- /dev/null
+++ b/atest/robot/standard_libraries/collections/dictionaries_should_be_equal.robot
@@ -0,0 +1,77 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} standard_libraries/collections/dictionaries_should_be_equal.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Comparison with itself
+ Check Test Case ${TESTNAME}
+
+Keys in different order
+ Check Test Case ${TESTNAME}
+
+Different dictionary types
+ Check Test Case ${TESTNAME}
+
+First dictionary missing keys
+ Check Test Case ${TESTNAME}
+
+Second dictionary missing keys
+ Check Test Case ${TESTNAME}
+
+Both dictionaries missing keys
+ Check Test Case ${TESTNAME}
+
+Missing keys and custom error message
+ Check Test Case ${TESTNAME}
+
+Missing keys and custom error message with values
+ Check Test Case ${TESTNAME}
+
+Different values
+ Check Test Case ${TESTNAME}
+
+Different values and custom error message
+ Check Test Case ${TESTNAME}
+
+Different values and custom error message with values
+ Check Test Case ${TESTNAME}
+
+NO VALUES is deprecated
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Using 'No values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+
+`ignore_keys`
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` with non-string keys
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` recursive
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` with missing keys
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` with wrong values
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` as string must be valid expression
+ Check Test Case ${TESTNAME}
+
+`ignore_keys` must be list
+ Check Test Case ${TESTNAME}
+
+`ignore_case`
+ Check Test Case ${TESTNAME}
+
+`ignore_case` with ´ignore_keys`
+ Check Test Case ${TESTNAME}
+
+`ignore_case` when normalized keys have conflict
+ Check Test Case ${TESTNAME}
+
+`ignore_value_order` set to True
+ Check Test Case ${TESTNAME}
+
+`ignore_value_order` set to False and dictionaries have lists in different order
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/collections/dictionary.robot b/atest/robot/standard_libraries/collections/dictionary.robot
index c49cd0f96da..4ada7baea98 100644
--- a/atest/robot/standard_libraries/collections/dictionary.robot
+++ b/atest/robot/standard_libraries/collections/dictionary.robot
@@ -4,7 +4,10 @@ Suite Setup Run Tests --loglevel debug standard_libraries/collection
Resource atest_resource.robot
*** Test Cases ***
-Convert To Dictionary
+Convert To Dictionary with mappings
+ Check Test Case ${TEST NAME}
+
+Convert To Dictionary with list of tuples
Check Test Case ${TEST NAME}
Set To Dictionary
@@ -16,15 +19,24 @@ Set To Dictionary With wrong number of arguments
Set To Dictionary With **kwargs
Check Test Case ${TEST NAME}
+Set To Dictionary with immutable
+ Check Test Case ${TEST NAME}
+
Remove From Dictionary
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Removed item with key 'b' and value '2'.
- Check Log Message ${tc.kws[0].msgs[1]} Key 'x' not found.
- Check Log Message ${tc.kws[0].msgs[2]} Key '2' not found.
+ Check Log Message ${tc[0, 0]} Removed item with key 'b' and value '2'.
+ Check Log Message ${tc[0, 1]} Key 'x' not found.
+ Check Log Message ${tc[0, 2]} Key '2' not found.
+
+Remove From Dictionary with immutable
+ Check Test Case ${TEST NAME}
Keep In Dictionary
Check Test Case ${TEST NAME}
+Keep In Dictionary with immutable
+ Check Test Case ${TEST NAME}
+
Copy Dictionary
Check Test Case ${TEST NAME}
@@ -62,94 +74,7 @@ Get From Dictionary With Invalid Key
Check Test Case ${TEST NAME} 1
Check Test Case ${TEST NAME} 2
-Dictionary Should Contain Key
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Key With Missing Key
- Check Test Case ${TEST NAME} 1
- Check Test Case ${TEST NAME} 2
-
-Dictionary Should Contain Item
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Item With Missing Key
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Item With Wrong Value
- Check Test Case ${TEST NAME}
-
-Dictionary Should Not Contain Key
- Check Test Case ${TEST NAME}
-
-Dictionary Should Not Contain Key With Existing Key
- Check Test Case ${TEST NAME}
-
-Dictionary Should (Not) Contain Key Does Not Require `has_key`
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Value
- Check Test Case ${TEST NAME}
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Value With Missing Value
- Check Test Case ${TEST NAME} 1
- Check Test Case ${TEST NAME} 2
-
-Dictionary Should Not Contain Value
- Check Test Case ${TEST NAME}
-
-Dictionary Should Not Contain Value With Existing Value
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal
- Check Test Case ${TEST NAME}
-
-Dictionaries Of Different Type Should Be Equal
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Equal With First Dictionary Missing Keys
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Equal With Second Dictionary Missing Keys
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Equal With Both Dictionaries Missing Keys
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal With Different Keys And Own Error Message
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal With Different Keys And Own And Default Error Messages
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal With Different Values
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal With Different Values And Own Error Message
- Check Test Case ${TEST NAME}
-
-Dictionaries Should Be Equal With Different Values And Own And Default Error Messages
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Missing Keys
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Missing Keys And Own Error Message
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Missing Keys And Own And Default Error Message
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Different Value
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Different Value And Own Error Message
- Check Test Case ${TEST NAME}
-
-Dictionary Should Contain Sub Dictionary With Different Value And Own And Default Error Message
+Get From Dictionary With Default
Check Test Case ${TEST NAME}
Log Dictionary With Different Log Levels
@@ -159,17 +84,18 @@ Log Dictionary With Different Log Levels
... a: 1
... b: 2
... c:
- Check Log Message ${tc.kws[0].msgs[0]} ${expected} INFO
- Should Be Empty ${tc.kws[1].msgs}
- Check Log Message ${tc.kws[2].msgs[0]} ${expected} WARN
- Check Log Message ${tc.kws[3].msgs[0]} ${expected} DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} ${expected} INFO
+ Check Log Message ${tc[0, 0]} ${expected} INFO
+ Should Be Empty ${tc[1].body}
+ Check Log Message ${tc[2, 0]} ${expected} WARN
+ Check Log Message ${tc[3, 0]} ${expected} DEBUG
+ Check Log Message ${tc[4, 0]} ${expected} INFO
Log Dictionary With Different Dictionaries
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} Dictionary is empty.
- Check Log Message ${tc.kws[1].msgs[0]} Dictionary has one item:\na: 1
- Check Log Message ${tc.kws[3].msgs[0]} Dictionary size is 3 and it contains following items:\nTrue: xxx\nfoo: []\n(1, 2, 3): 3.14
+ Check Log Message ${tc[0, 0]} Dictionary is empty.
+ Check Log Message ${tc[1, 0]} Dictionary has one item:\na: 1
+ Check Log Message ${tc[3, 0]} Dictionary size is 3 and it contains following items:\nTrue: xxx\nfoo: []\n(1, 2, 3): 3.14
+ Check Log Message ${tc[4, 0]} Dictionary size is 2 and it contains following items:\na: 1\nb: 2
Pop From Dictionary Without Default
Check Test Case ${TEST NAME}
@@ -177,5 +103,11 @@ Pop From Dictionary Without Default
Pop From Dictionary With Default
Check Test Case ${TEST NAME}
+Pop From Dictionary with immutable
+ Check Test Case ${TEST NAME}
+
Check invalid dictionary argument errors
Check Test Case ${TEST NAME}
+
+Bytes normalization
+ Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/collections/dictionary_should_contain.robot b/atest/robot/standard_libraries/collections/dictionary_should_contain.robot
new file mode 100644
index 00000000000..cab543351be
--- /dev/null
+++ b/atest/robot/standard_libraries/collections/dictionary_should_contain.robot
@@ -0,0 +1,107 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} standard_libraries/collections/dictionary_should_contain.robot
+Resource atest_resource.robot
+
+*** Test Cases ***
+Should contain key
+ Check Test Case ${TESTNAME}
+
+Should contain key with custom message
+ Check Test Case ${TESTNAME}
+
+Should contain key with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+Should not contain key
+ Check Test Case ${TESTNAME}
+
+Should not contain key with custom message
+ Check Test Case ${TESTNAME}
+
+Should not contain key with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+Should contain value
+ Check Test Case ${TESTNAME}
+
+Should contain value with custom message
+ Check Test Case ${TESTNAME}
+
+Should contain value with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+Should not contain value
+ Check Test Case ${TESTNAME}
+
+Should not contain value with custom message
+ Check Test Case ${TESTNAME}
+
+Should not contain value with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+Should contain item
+ Check Test Case ${TESTNAME}
+
+Should contain item with missing key
+ Check Test Case ${TESTNAME}
+
+Should contain item with missing key and custom message
+ Check Test Case ${TESTNAME}
+
+Should contain item with wrong value
+ Check Test Case ${TESTNAME}
+
+Should contain item with wrong value and custom message
+ Check Test Case ${TESTNAME}
+
+Should contain item with values looking same but having different types
+ Check Test Case ${TESTNAME}
+
+Should contain item with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+Should contain item with `ignore_case=key`
+ Check Test Case ${TESTNAME}
+
+Should contain item with `ignore_case=value`
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with missing keys
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with missing keys and custom error message
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with missing keys and custom error message containig values
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with wrong value
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with wrong value and custom error message
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with wrong value and custom error message containing values
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with deprecated NO VALUES
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0]} Using 'NO VALUES' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+
+Should contain sub dictionary with `ignore_case`
+ Check Test Case ${TESTNAME}
+
+`ignore_case` when normalized keys have conflict
+ Check Test Case ${TESTNAME}
+
+`has_key` is not required
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with `ignore_value_order`
+ Check Test Case ${TESTNAME}
+
+Should contain sub dictionary with `ignore_value_order` set to False when dictionaries have lists in different order
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/collections/list.robot b/atest/robot/standard_libraries/collections/list.robot
index 510e2d05fd2..184d9f68016 100644
--- a/atest/robot/standard_libraries/collections/list.robot
+++ b/atest/robot/standard_libraries/collections/list.robot
@@ -13,22 +13,16 @@ Convert To List With Invalid Type
Append To List
Check Test Case ${TEST NAME}
-Insert Into List With String Index
+Append To List with immutable
Check Test Case ${TEST NAME}
-Insert Into List With Int Index
+Insert Into List
Check Test Case ${TEST NAME}
-Insert Into List With Index Over Lists Size
+Insert Into List with immutable
Check Test Case ${TEST NAME}
-Insert Into List With Index Negative Index
- Check Test Case ${TEST NAME}
-
-Insert Into List With Index Under Lists Size
- Check Test Case ${TEST NAME}
-
-Insert Into List With Invalid Index
+Insert Into List with invalid index
Check Test Case ${TEST NAME}
Combine Lists
@@ -37,51 +31,48 @@ Combine Lists
Set List Value
Check Test Case ${TEST NAME}
-Set List Value Index Out Of List
+Set List Value with immutable
Check Test Case ${TEST NAME}
-Set List Value With Invalid Index
+Set List Value with invalid index
Check Test Case ${TEST NAME}
Remove Values From List
Check Test Case ${TEST NAME}
-Remove Non Existing Values From List
+Remove Values From List with immutable
Check Test Case ${TEST NAME}
Remove From List
Check Test Case ${TEST NAME}
-Remove From List Index Out Of List
+Remove From List with immutable
Check Test Case ${TEST NAME}
-Remove From List With Invalid Index
+Remove From List with invalid index
Check Test Case ${TEST NAME}
Remove Duplicates
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} 0 duplicates removed.
- Check Log Message ${tc.kws[2].msgs[0]} 3 duplicates removed.
+ Check Log Message ${tc[0, 0, 0, 0]} 0 duplicates removed.
+ Check Log Message ${tc[1, 0, 0, 0]} 3 duplicates removed.
Count Values In List
Check Test Case ${TEST NAME}
-Count Values In List With Invalid Start Index
- Check Test Case ${TEST NAME}
-
-Count Values In List With Invalid Stop Index
+Count Values In List with invalid index
Check Test Case ${TEST NAME}
Get Index From List
Check Test Case ${TEST NAME}
-Get Index From List With Non Existing Value
- Check Test Case ${TEST NAME}
-
-Get Index From List With Invalid Start Index
- Check Test Case ${TEST NAME}
+Get Index From List with empty string as start index is deprecated
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0, 0, 0]}
+ ... Using an empty string as a start index with the 'Get Index From List' keyword is deprecated. Use '0' instead.
+ ... WARN
-Get Index From List With Invalid Stop Index
+Get Index From List with invalid index
Check Test Case ${TEST NAME}
Copy List
@@ -93,34 +84,37 @@ Shallow Copy List
Deep Copy List
Check Test Case ${TEST NAME}
-Reserve List
+Reverse List
Check Test Case ${TEST NAME}
-Sort List
+Reverse List with immutable
Check Test Case ${TEST NAME}
-Sorting Unsortable List Fails
+Sort List
Check Test Case ${TEST NAME}
-Get From List
+Sort List with immutable
Check Test Case ${TEST NAME}
-Get From List With Invalid Index
+Sorting Unsortable List Fails
Check Test Case ${TEST NAME}
-Get From List Out Of List Index
+Get From List
Check Test Case ${TEST NAME}
-Get Slice From List
+Get From List with invalid index
Check Test Case ${TEST NAME}
-Get Slice From List With Invalid Start Index
+Get Slice From List
Check Test Case ${TEST NAME}
-Get Slice From List With Invalid Stop Index
- Check Test Case ${TEST NAME}
+Get Slice From List with empty string as start index is deprecated
+ ${tc} = Check Test Case ${TEST NAME}
+ Check Log Message ${tc[0, 0, 0, 0]}
+ ... Using an empty string as a start index with the 'Get Slice From List' keyword is deprecated. Use '0' instead.
+ ... WARN
-Get Slice From List With Out Of List Index
+Get Slice From List with invalid index
Check Test Case ${TEST NAME}
List Should Contain Value
@@ -149,26 +143,23 @@ List Should Not Contain Duplicates Is Case And Space Sensitive
List Should Not Contain Duplicates With One Duplicate
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[1].msgs[0]} 'item' found 2 times.
+ Check Log Message ${tc[1, 0]} 'item' found 2 times.
List Should Not Contain Duplicates With Multiple Duplicates
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[1].msgs[0]} '2' found 2 times.
- Check Log Message ${tc.kws[1].msgs[1]} 'None' found 2 times.
- Check Log Message ${tc.kws[1].msgs[2]} '4' found 4 times.
- Check Log Message ${tc.kws[1].msgs[3]} '[1, 2, 3]' found 2 times.
- Check Log Message ${tc.kws[1].msgs[4]} '[]' found 10 times.
+ Check Log Message ${tc[1, 0]} '2' found 2 times.
+ Check Log Message ${tc[1, 1]} 'None' found 2 times.
+ Check Log Message ${tc[1, 2]} '4' found 4 times.
+ Check Log Message ${tc[1, 3]} '[1, 2, 3]' found 2 times.
+ Check Log Message ${tc[1, 4]} '[]' found 10 times.
List Should Not Contain Duplicates With Custom Error Message
${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[2].msgs[0]} '42' found 42 times.
+ Check Log Message ${tc[1, 0]} '6' found 7 times.
Lists Should Be Equal
Check Test Case ${TEST NAME}
-List and Tuple should be equal
- Check Test Case ${TEST NAME}
-
Lists Should Be equal With Different Lengths
Check Test Case ${TEST NAME}
@@ -202,37 +193,43 @@ Lists Should Be Equal With Named Indices As Dictionary With Too Few Values
Lists Should Be Equal Ignore Order
Check Test Case ${TEST NAME}
+Ignore Order Is Recursive
+ Check Test Case ${TEST NAME}
+
List Should Contain Sub List
Check Test Case ${TEST NAME}
List Should Contain Sub List With Missing Values
Check Test Case ${TEST NAME}
+List Should Contain Sub List When The Only Missing Value Is Empty String
+ Check Test Case ${TEST NAME}
+
List Should Contain Sub List With Missing Values And Own Error Message
Check Test Case ${TEST NAME}
List Should Contain Sub List With Missing Values And Own and Default Error Messages
Check Test Case ${TEST NAME}
-Log List With Different Log Levels
+'NO VALUES' is deprecated
${tc} = Check Test Case ${TEST NAME}
- ${expected} = Catenate SEPARATOR=\n
+ Check Log Message ${tc[0, 0]} Using 'NO VALUES' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+ Check Log Message ${tc[1, 0]} Using 'no values' for disabling the 'values' argument is deprecated. Use 'values=False' instead. WARN
+
+Log List
+ ${tc} = Check Test Case ${TEST NAME}
+ VAR ${three items}
... List length is 3 and it contains following items:
... 0: 11
... 1: 12
... 2: 13
- Check Log Message ${tc.kws[0].msgs[0]} ${expected} INFO
- Variable Should Not Exist ${tc.kws[1].msgs[0]}
- Check Log Message ${tc.kws[2].msgs[0]} ${expected} WARN
- Check Log Message ${tc.kws[3].msgs[0]} ${expected} DEBUG
- Check Log Message ${tc.kws[4].msgs[0]} ${expected} INFO
-
-Log List With Different Lists
- ${tc} = Check Test Case ${TEST NAME}
- Check Log Message ${tc.kws[0].msgs[0]} List is empty. INFO
- Check Log Message ${tc.kws[1].msgs[0]} List has one item:\n1
- Check Log Message ${tc.kws[4].msgs[0]} List has one item:\n(1, 2, 3)
- Check Log Message ${tc.kws[6].msgs[0]} List length is 2 and it contains following items:\n0: (1, 2, 3)\n1: 3.12
+ ... separator=\n
+ Check Log Message ${tc[0, 0]} List is empty. INFO
+ Check Log Message ${tc[1, 0]} ${three items} INFO
+ Check Log Message ${tc[2, 0]} ${three items} INFO
+ Should Be Empty ${tc[3].body}
+ Check Log Message ${tc[4, 0]} ${three items} WARN
+ Check Log Message ${tc[5, 0]} ${three items} DEBUG
Count Matches In List Case Insensitive
Check Test Case ${TEST NAME}
@@ -327,5 +324,29 @@ List Should Not Contain Value, Value Found and Own Error Message Regexp
List Should Not Contain Value, Value Found and Own Error Message Glob
Check Test Case ${TEST NAME}
-Check List Error
+Lists Should Be Equal With Ignore Case
+ Check Test Case ${TEST NAME}
+
+List Should Contain Value With Ignore Case
+ Check Test Case ${TEST NAME}
+
+List Should Not Contain Value With Ignore Case Does Contain Value
+ Check Test Case ${TEST NAME}
+
+List Should Contain Sub List With Ignore Case
+ Check Test Case ${TEST NAME}
+
+List Should Not Contain Duplicates With Ignore Case
+ Check Test Case ${TEST NAME}
+
+List Should Contain Value With Ignore Case And Nested List and Dictionary
+ Check Test Case ${TEST NAME}
+
+Lists Should be equal with Ignore Case and Order
+ Check Test Case ${TEST NAME}
+
+Validate argument conversion errors
+ Check Test Case ${TEST NAME}
+
+Bytes normalization
Check Test Case ${TEST NAME}
diff --git a/atest/robot/standard_libraries/datetime/convert_date_input_format.robot b/atest/robot/standard_libraries/datetime/convert_date_input_format.robot
index 95639489caf..a226ff6794a 100644
--- a/atest/robot/standard_libraries/datetime/convert_date_input_format.robot
+++ b/atest/robot/standard_libraries/datetime/convert_date_input_format.robot
@@ -18,6 +18,9 @@ Epoch
Datetime object
Check Test Case ${TESTNAME}
+Date object
+ Check Test Case ${TESTNAME}
+
Pad zeroes to missing values
Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/datetime/convert_date_result_format.robot b/atest/robot/standard_libraries/datetime/convert_date_result_format.robot
index e3d5cc8f706..4771ca72642 100644
--- a/atest/robot/standard_libraries/datetime/convert_date_result_format.robot
+++ b/atest/robot/standard_libraries/datetime/convert_date_result_format.robot
@@ -23,6 +23,3 @@ Should exclude milliseconds
Epoch time is float regardless are millis included or not
Check Test Case ${TESTNAME}
-
-Formatted with %f in middle
- Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/dialogs/dialogs.robot b/atest/robot/standard_libraries/dialogs/dialogs.robot
index edbdfdb4e36..bb049c007e6 100644
--- a/atest/robot/standard_libraries/dialogs/dialogs.robot
+++ b/atest/robot/standard_libraries/dialogs/dialogs.robot
@@ -1,6 +1,6 @@
*** Settings ***
Suite Setup Run Tests ${EMPTY} standard_libraries/dialogs/dialogs.robot
-Force Tags manual no-ci
+Test Tags manual no-ci
Resource atest_resource.robot
*** Test Cases ***
@@ -40,9 +40,27 @@ Get Value From User Cancelled
Get Value From User Exited
Check Test Case ${TESTNAME}
+Get Value From User Shortcuts
+ Check Test Case ${TESTNAME}
+
Get Selection From User
Check Test Case ${TESTNAME}
+Get Selection From User When Default Value Provided by Index
+ Check Test Case ${TESTNAME}
+
+Get Selection From User When Default Value Provided by String
+ Check Test Case ${TESTNAME}
+
+Get Selection From User When Default Value Is Integer
+ Check Test Case ${TESTNAME}
+
+Get Selection From User When Default Value Index Is Out of Bounds
+ Check Test Case ${TESTNAME}
+
+Get Selection From User When Default Value Cannot Be Found
+ Check Test Case ${TESTNAME}
+
Get Selection From User Cancelled
Check Test Case ${TESTNAME}
@@ -63,3 +81,9 @@ Get Selections From User Exited
Multiple dialogs in a row
Check Test Case ${TESTNAME}
+
+Garbage Collection In Thread Should Not Cause Problems
+ Check Test Case ${TESTNAME}
+
+Timeout can close dialog
+ Check Test Case ${TESTNAME}
diff --git a/atest/robot/standard_libraries/easter.robot b/atest/robot/standard_libraries/easter.robot
index 7876de7afb4..cf8097982c5 100644
--- a/atest/robot/standard_libraries/easter.robot
+++ b/atest/robot/standard_libraries/easter.robot
@@ -8,6 +8,6 @@ Not None Shall Not Pass
None Shall Pass
${tc} = Check Test Case ${TESTNAME}
- Check Log Message ${tc.kws[0].msgs[0]}
+ Check Log Message ${tc[0, 0]}
... ',
- html=True
+ "allowfullscreen>"
+ "",
+ html=True,
)
diff --git a/src/robot/libraries/OperatingSystem.py b/src/robot/libraries/OperatingSystem.py
index e2d0b70862f..9714c8ddc72 100644
--- a/src/robot/libraries/OperatingSystem.py
+++ b/src/robot/libraries/OperatingSystem.py
@@ -14,24 +14,26 @@
# limitations under the License.
import fnmatch
-import re
import glob
import os
+import re
import shutil
import tempfile
import time
+from datetime import datetime, timedelta
+from typing import NoReturn, Sequence
-from robot.version import get_version
from robot.api import logger
-from robot.api.deco import keyword
-from robot.utils import (abspath, ConnectionCache, console_decode, del_env_var,
- get_env_var, get_env_vars, get_time, is_truthy,
- is_string, normpath, parse_time, plural_or_not,
- safe_str, secs_to_timestamp, secs_to_timestr, seq2str,
- set_env_var, timestr_to_secs, CONSOLE_ENCODING, WINDOWS)
+from robot.api.types import Secret
+from robot.utils import (
+ abspath, ConnectionCache, console_decode, CONSOLE_ENCODING, del_env_var,
+ get_env_var, get_env_vars, get_time, parse_time, plural_or_not as s, PY_VERSION,
+ safe_str, secs_to_timestr, seq2str, set_env_var, WINDOWS
+)
+from robot.version import get_version
__version__ = get_version()
-PROCESSES = ConnectionCache('No active processes.')
+PROCESSES = ConnectionCache("No active processes.")
class OperatingSystem:
@@ -67,7 +69,7 @@ class OperatingSystem:
= Pattern matching =
- Many keywords accepts arguments as either _glob_ or _regular expression_ patterns.
+ Many keywords accept arguments as either _glob_ or _regular expression_ patterns.
== Glob patterns ==
@@ -107,26 +109,14 @@ class OperatingSystem:
operating system dependent, but typically e.g. ``~/robot`` is expanded to
``C:\Users\\robot`` on Windows and ``/home//robot`` on Unixes.
- = Boolean arguments =
-
- Some keywords accept arguments that are handled as Boolean values true or
- false. If such an argument is given as a string, it is considered false if
- it is an empty string or equal to ``FALSE``, ``NONE``, ``NO``, ``OFF`` or
- ``0``, case-insensitively. Other strings are considered true regardless
- their value, and other argument types are tested using the same
- [http://docs.python.org/library/stdtypes.html#truth|rules as in Python].
+ = pathlib.Path support =
- True examples:
- | `Remove Directory` | ${path} | recursive=True | # Strings are generally true. |
- | `Remove Directory` | ${path} | recursive=yes | # Same as the above. |
- | `Remove Directory` | ${path} | recursive=${TRUE} | # Python ``True`` is true. |
- | `Remove Directory` | ${path} | recursive=${42} | # Numbers other than 0 are true. |
+ Starting from Robot Framework 6.0, arguments representing paths can be given
+ as [https://docs.python.org/3/library/pathlib.html|pathlib.Path] instances
+ in addition to strings.
- False examples:
- | `Remove Directory` | ${path} | recursive=False | # String ``false`` is false. |
- | `Remove Directory` | ${path} | recursive=no | # Also string ``no`` is false. |
- | `Remove Directory` | ${path} | recursive=${EMPTY} | # Empty string is false. |
- | `Remove Directory` | ${path} | recursive=${FALSE} | # Python ``False`` is false. |
+ For backwards compatibility reasons, all keywords returning paths return them
+ as strings.
= Example =
@@ -142,13 +132,18 @@ class OperatingSystem:
| `File Should Exist` ${PATH}
| `Copy File` ${PATH} ~/file.txt
"""
- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+ ROBOT_LIBRARY_SCOPE = "GLOBAL"
ROBOT_LIBRARY_VERSION = __version__
- def run(self, command):
- """Runs the given command in the system and returns the output.
+ def run(self, command: str) -> str:
+ """_This keyword is considered deprecated. Use the
+ [http://robotframework.org/robotframework/latest/libraries/Process.html|
+ Process] library instead._
+
+ Runs the given command in the system and returns the output.
- The execution status of the command *is not checked* by this
+ The execution status of the command _is not checked_ by this
keyword, and it must be done separately based on the returned
output. If the execution return code is needed, either `Run
And Return RC` or `Run And Return RC And Output` can be used.
@@ -175,22 +170,21 @@ def run(self, command):
| ${stdout} = | Run | /opt/script.sh 2>/tmp/stderr.txt |
| Should Be Equal | ${stdout} | TEST PASSED |
| File Should Be Empty | /tmp/stderr.txt |
-
- *TIP:* `Run Process` keyword provided by the
- [http://robotframework.org/robotframework/latest/libraries/Process.html|
- Process library] supports better process configuration and is generally
- recommended as a replacement for this keyword.
"""
return self._run(command)[1]
- def run_and_return_rc(self, command):
- """Runs the given command in the system and returns the return code.
+ def run_and_return_rc(self, command: str) -> int:
+ """_This keyword is considered deprecated. Use the
+ [http://robotframework.org/robotframework/latest/libraries/Process.html|
+ Process] library instead._
- The return code (RC) is returned as a positive integer in
+ Runs the given command in the system and returns the return code (RC).
+
+ The return code is returned as a positive integer in
range from 0 to 255 as returned by the executed command. On
some operating systems (notable Windows) original return codes
can be something else, but this keyword always maps them to
- the 0-255 range. Since the RC is an integer, it must be
+ the 0-255 range. Since the return code is an integer, it must be
checked e.g. with the keyword `Should Be Equal As Integers`
instead of `Should Be Equal` (both are built-in keywords).
@@ -202,18 +196,16 @@ def run_and_return_rc(self, command):
See `Run` and `Run And Return RC And Output` if you need to get the
output of the executed command.
-
- *TIP:* `Run Process` keyword provided by the
- [http://robotframework.org/robotframework/latest/libraries/Process.html|
- Process library] supports better process configuration and is generally
- recommended as a replacement for this keyword.
"""
return self._run(command)[0]
- def run_and_return_rc_and_output(self, command):
- """Runs the given command in the system and returns the RC and output.
+ def run_and_return_rc_and_output(self, command: str) -> "tuple[int, str]":
+ """_This keyword is considered deprecated. Use the
+ [http://robotframework.org/robotframework/latest/libraries/Process.html|
+ Process] library instead._
- The return code (RC) is returned similarly as with `Run And Return RC`
+ Runs the given command in the system and returns the return code (RC)
+ and output. The return code is returned similarly as with `Run And Return RC`
and the output similarly as with `Run`.
Examples:
@@ -224,22 +216,22 @@ def run_and_return_rc_and_output(self, command):
| Should Be True | ${rc} > 42 |
| Should Be Equal | ${stdout} | TEST PASSED |
| File Should Be Empty | /tmp/stderr.txt |
-
- *TIP:* `Run Process` keyword provided by the
- [http://robotframework.org/robotframework/latest/libraries/Process.html|
- Process library] supports better process configuration and is generally
- recommended as a replacement for this keyword.
"""
return self._run(command)
- def _run(self, command):
+ def _run(self, command: str) -> "tuple[int, str]":
process = _Process(command)
- self._info("Running command '%s'." % process)
+ self._info(f"Running command '{process}'.")
stdout = process.read()
rc = process.close()
return rc, stdout
- def get_file(self, path, encoding='UTF-8', encoding_errors='strict'):
+ def get_file(
+ self,
+ path: str,
+ encoding: str = "UTF-8",
+ encoding_errors: str = "strict",
+ ) -> str:
"""Returns the contents of a specified file.
This keyword reads the specified file and returns the contents.
@@ -273,14 +265,16 @@ def get_file(self, path, encoding='UTF-8', encoding_errors='strict'):
# depend on these semantics. Best solution would probably be making
# `newline` configurable.
# FIXME: Make `newline` configurable or at least submit an issue about that.
- with open(path, encoding=encoding, errors=encoding_errors, newline='') as f:
- return f.read().replace('\r\n', '\n')
+ with open(path, encoding=encoding, errors=encoding_errors, newline="") as f:
+ return f.read().replace("\r\n", "\n")
- def _map_encoding(self, encoding):
- return {'SYSTEM': None,
- 'CONSOLE': CONSOLE_ENCODING}.get(encoding.upper(), encoding)
+ def _map_encoding(self, encoding: str) -> "str | None":
+ return {
+ "SYSTEM": "locale" if PY_VERSION > (3, 10) else None,
+ "CONSOLE": CONSOLE_ENCODING,
+ }.get(encoding.upper(), encoding)
- def get_binary_file(self, path):
+ def get_binary_file(self, path: str) -> bytes:
"""Returns the contents of a specified file.
This keyword reads the specified file and returns the contents as is.
@@ -288,11 +282,17 @@ def get_binary_file(self, path):
"""
path = self._absnorm(path)
self._link("Getting file '%s'.", path)
- with open(path, 'rb') as f:
+ with open(path, "rb") as f:
return f.read()
- def grep_file(self, path, pattern, encoding='UTF-8', encoding_errors='strict',
- regexp=False):
+ def grep_file(
+ self,
+ path: str,
+ pattern: str,
+ encoding: str = "UTF-8",
+ encoding_errors: str = "strict",
+ regexp: bool = False,
+ ) -> str:
r"""Returns the lines of the specified file that match the ``pattern``.
This keyword reads a file from the file system using the defined
@@ -329,7 +329,7 @@ def grep_file(self, path, pattern, encoding='UTF-8', encoding_errors='strict',
"""
path = self._absnorm(path)
if not regexp:
- pattern = fnmatch.translate(f'{pattern}*')
+ pattern = fnmatch.translate(f"{pattern}*")
reobj = re.compile(pattern)
encoding = self._map_encoding(encoding)
lines = []
@@ -338,13 +338,18 @@ def grep_file(self, path, pattern, encoding='UTF-8', encoding_errors='strict',
with open(path, encoding=encoding, errors=encoding_errors) as file:
for line in file:
total_lines += 1
- line = line.rstrip('\r\n')
+ line = line.rstrip("\r\n")
if reobj.search(line):
lines.append(line)
- self._info('%d out of %d lines matched' % (len(lines), total_lines))
- return '\n'.join(lines)
-
- def log_file(self, path, encoding='UTF-8', encoding_errors='strict'):
+ self._info(f"{len(lines)} out of {total_lines} lines matched.")
+ return "\n".join(lines)
+
+ def log_file(
+ self,
+ path: str,
+ encoding: str = "UTF-8",
+ encoding_errors: str = "strict",
+ ) -> str:
"""Wrapper for `Get File` that also logs the returned file.
The file is logged with the INFO level. If you want something else,
@@ -360,7 +365,7 @@ def log_file(self, path, encoding='UTF-8', encoding_errors='strict'):
# File and directory existence
- def should_exist(self, path, msg=None):
+ def should_exist(self, path: str, msg: "str | None" = None):
"""Fails unless the given path (file or directory) exists.
The path can be given as an exact path or as a glob pattern.
@@ -370,10 +375,10 @@ def should_exist(self, path, msg=None):
"""
path = self._absnorm(path)
if not self._glob(path):
- self._fail(msg, "Path '%s' does not exist." % path)
+ self._fail(msg, f"Path '{path}' does not exist.")
self._link("Path '%s' exists.", path)
- def should_not_exist(self, path, msg=None):
+ def should_not_exist(self, path: str, msg: "str | None" = None):
"""Fails if the given path (file or directory) exists.
The path can be given as an exact path or as a glob pattern.
@@ -384,21 +389,21 @@ def should_not_exist(self, path, msg=None):
path = self._absnorm(path)
matches = self._glob(path)
if matches:
- self._fail(msg, self._get_matches_error('Path', path, matches))
+ self._fail(msg, self._get_matches_error("Path", path, matches))
self._link("Path '%s' does not exist.", path)
- def _glob(self, path):
+ def _glob(self, path: str) -> "list[str]":
return glob.glob(path) if not os.path.exists(path) else [path]
- def _get_matches_error(self, what, path, matches):
+ def _get_matches_error(self, kind: str, path: str, matches: "list[str]") -> str:
if not self._is_glob_path(path):
- return "%s '%s' exists." % (what, path)
- return "%s '%s' matches %s." % (what, path, seq2str(sorted(matches)))
+ return f"{kind} '{path}' exists."
+ return f"{kind} '{path}' matches {seq2str(sorted(matches))}."
- def _is_glob_path(self, path):
- return '*' in path or '?' in path or ('[' in path and ']' in path)
+ def _is_glob_path(self, path: str) -> bool:
+ return "*" in path or "?" in path or ("[" in path and "]" in path)
- def file_should_exist(self, path, msg=None):
+ def file_should_exist(self, path: str, msg: "str | None" = None):
"""Fails unless the given ``path`` points to an existing file.
The path can be given as an exact path or as a glob pattern.
@@ -409,10 +414,10 @@ def file_should_exist(self, path, msg=None):
path = self._absnorm(path)
matches = [p for p in self._glob(path) if os.path.isfile(p)]
if not matches:
- self._fail(msg, "File '%s' does not exist." % path)
+ self._fail(msg, f"File '{path}' does not exist.")
self._link("File '%s' exists.", path)
- def file_should_not_exist(self, path, msg=None):
+ def file_should_not_exist(self, path: str, msg: "str | None" = None):
"""Fails if the given path points to an existing file.
The path can be given as an exact path or as a glob pattern.
@@ -423,10 +428,10 @@ def file_should_not_exist(self, path, msg=None):
path = self._absnorm(path)
matches = [p for p in self._glob(path) if os.path.isfile(p)]
if matches:
- self._fail(msg, self._get_matches_error('File', path, matches))
+ self._fail(msg, self._get_matches_error("File", path, matches))
self._link("File '%s' does not exist.", path)
- def directory_should_exist(self, path, msg=None):
+ def directory_should_exist(self, path: str, msg: "str | None" = None):
"""Fails unless the given path points to an existing directory.
The path can be given as an exact path or as a glob pattern.
@@ -437,10 +442,10 @@ def directory_should_exist(self, path, msg=None):
path = self._absnorm(path)
matches = [p for p in self._glob(path) if os.path.isdir(p)]
if not matches:
- self._fail(msg, "Directory '%s' does not exist." % path)
+ self._fail(msg, f"Directory '{path}' does not exist.")
self._link("Directory '%s' exists.", path)
- def directory_should_not_exist(self, path, msg=None):
+ def directory_should_not_exist(self, path: str, msg: "str | None" = None):
"""Fails if the given path points to an existing file.
The path can be given as an exact path or as a glob pattern.
@@ -451,12 +456,16 @@ def directory_should_not_exist(self, path, msg=None):
path = self._absnorm(path)
matches = [p for p in self._glob(path) if os.path.isdir(p)]
if matches:
- self._fail(msg, self._get_matches_error('Directory', path, matches))
+ self._fail(msg, self._get_matches_error("Directory", path, matches))
self._link("Directory '%s' does not exist.", path)
# Waiting file/dir to appear/disappear
- def wait_until_removed(self, path, timeout='1 minute'):
+ def wait_until_removed(
+ self,
+ path: str,
+ timeout: "timedelta | None" = timedelta(minutes=1),
+ ):
"""Waits until the given file or directory is removed.
The path can be given as an exact path or as a glob pattern.
@@ -464,25 +473,30 @@ def wait_until_removed(self, path, timeout='1 minute'):
If the path is a pattern, the keyword waits until all matching
items are removed.
- The optional ``timeout`` can be used to control the maximum time of
- waiting. The timeout is given as a timeout string, e.g. in a format
- ``15 seconds``, ``1min 10s`` or just ``10``. The time string format is
- described in an appendix of Robot Framework User Guide.
+ Waits for 1 minute by default, but that can be changed by using the
+ ``timeout`` argument. Using a negative value or ``None`` disables the timeout.
- If the timeout is negative, the keyword is never timed-out. The keyword
- returns immediately, if the path does not exist in the first place.
+ Examples:
+ | Wait Until Removed | ${path} |
+ | Wait Until Removed | ${path} | 10 seconds |
+ | Wait Until Removed | ${path} | timeout=None |
+
+ Disabling timeout using ``None`` is new in Robot Framework 7.4.
"""
path = self._absnorm(path)
- timeout = timestr_to_secs(timeout)
+ timeout = timeout.total_seconds() if timeout else -1
maxtime = time.time() + timeout
while self._glob(path):
if timeout >= 0 and time.time() > maxtime:
- self._fail("'%s' was not removed in %s."
- % (path, secs_to_timestr(timeout)))
+ self._fail(f"'{path}' was not removed in {secs_to_timestr(timeout)}.")
time.sleep(0.1)
self._link("'%s' was removed.", path)
- def wait_until_created(self, path, timeout='1 minute'):
+ def wait_until_created(
+ self,
+ path: str,
+ timeout: "timedelta | None" = timedelta(minutes=1),
+ ):
"""Waits until the given file or directory is created.
The path can be given as an exact path or as a glob pattern.
@@ -490,27 +504,29 @@ def wait_until_created(self, path, timeout='1 minute'):
If the path is a pattern, the keyword returns when an item matching
it is created.
- The optional ``timeout`` can be used to control the maximum time of
- waiting. The timeout is given as a timeout string, e.g. in a format
- ``15 seconds``, ``1min 10s`` or just ``10``. The time string format is
- described in an appendix of Robot Framework User Guide.
+ Waits for 1 minute by default, but that can be changed by using
+ the ``timeout`` argument. Using a negative value or ``None`` disables
+ the timeout.
- If the timeout is negative, the keyword is never timed-out. The keyword
- returns immediately, if the path already exists.
+ Examples:
+ | Wait Until Created | ${path} |
+ | Wait Until Created | ${path} | 10 seconds |
+ | Wait Until Created | ${path} | timeout=None |
+
+ Disabling timeout using ``None`` is new in Robot Framework 7.4.
"""
path = self._absnorm(path)
- timeout = timestr_to_secs(timeout)
+ timeout = timeout.total_seconds() if timeout else -1
maxtime = time.time() + timeout
while not self._glob(path):
if timeout >= 0 and time.time() > maxtime:
- self._fail("'%s' was not created in %s."
- % (path, secs_to_timestr(timeout)))
+ self._fail(f"'{path}' was not created in {secs_to_timestr(timeout)}.")
time.sleep(0.1)
self._link("'%s' was created.", path)
# Dir/file empty
- def directory_should_be_empty(self, path, msg=None):
+ def directory_should_be_empty(self, path: str, msg: "str | None" = None):
"""Fails unless the specified directory is empty.
The default error message can be overridden with the ``msg`` argument.
@@ -518,11 +534,11 @@ def directory_should_be_empty(self, path, msg=None):
path = self._absnorm(path)
items = self._list_dir(path)
if items:
- self._fail(msg, "Directory '%s' is not empty. Contents: %s."
- % (path, seq2str(items, lastsep=', ')))
+ contents = seq2str(items, lastsep=", ")
+ self._fail(msg, f"Directory '{path}' is not empty. Contents: {contents}.")
self._link("Directory '%s' is empty.", path)
- def directory_should_not_be_empty(self, path, msg=None):
+ def directory_should_not_be_empty(self, path: str, msg: "str | None" = None):
"""Fails if the specified directory is empty.
The default error message can be overridden with the ``msg`` argument.
@@ -530,40 +546,43 @@ def directory_should_not_be_empty(self, path, msg=None):
path = self._absnorm(path)
items = self._list_dir(path)
if not items:
- self._fail(msg, "Directory '%s' is empty." % path)
- self._link("Directory '%%s' contains %d item%s."
- % (len(items), plural_or_not(items)), path)
+ self._fail(msg, f"Directory '{path}' is empty.")
+ self._link(f"Directory '%s' contains {len(items)} item{s(items)}.", path)
- def file_should_be_empty(self, path, msg=None):
+ def file_should_be_empty(self, path: str, msg: "str | None" = None):
"""Fails unless the specified file is empty.
The default error message can be overridden with the ``msg`` argument.
"""
path = self._absnorm(path)
if not os.path.isfile(path):
- self._error("File '%s' does not exist." % path)
+ self._error(f"File '{path}' does not exist.")
size = os.stat(path).st_size
if size > 0:
- self._fail(msg,
- "File '%s' is not empty. Size: %d bytes." % (path, size))
+ self._fail(msg, f"File '{path}' is not empty. Size: {size} byte{s(size)}.")
self._link("File '%s' is empty.", path)
- def file_should_not_be_empty(self, path, msg=None):
+ def file_should_not_be_empty(self, path: str, msg: "str | None" = None):
"""Fails if the specified file is empty.
The default error message can be overridden with the ``msg`` argument.
"""
path = self._absnorm(path)
if not os.path.isfile(path):
- self._error("File '%s' does not exist." % path)
+ self._error(f"File '{path}' does not exist.")
size = os.stat(path).st_size
if size == 0:
- self._fail(msg, "File '%s' is empty." % path)
- self._link("File '%%s' contains %d bytes." % size, path)
+ self._fail(msg, f"File '{path}' is empty.")
+ self._link(f"File '%s' contains {size} bytes.", path)
# Creating and removing files and directory
- def create_file(self, path, content='', encoding='UTF-8'):
+ def create_file(
+ self,
+ path: str,
+ content: "str | Secret" = "",
+ encoding: str = "UTF-8",
+ ):
"""Creates a file with the given content and encoding.
If the directory where the file is created does not exist, it is
@@ -586,10 +605,18 @@ def create_file(self, path, content='', encoding='UTF-8'):
`File Should Not Exist` can be used to avoid overwriting existing
files.
"""
+ if isinstance(content, Secret):
+ content = content.value
path = self._write_to_file(path, content, encoding)
self._link("Created file '%s'.", path)
- def _write_to_file(self, path, content, encoding=None, mode='w'):
+ def _write_to_file(
+ self,
+ path: str,
+ content: "str | bytes",
+ encoding: "str | None" = None,
+ mode: str = "w",
+ ) -> str:
path = self._absnorm(path)
parent = os.path.dirname(path)
if not os.path.exists(parent):
@@ -600,7 +627,7 @@ def _write_to_file(self, path, content, encoding=None, mode='w'):
f.write(content)
return path
- def create_binary_file(self, path, content):
+ def create_binary_file(self, path: str, content: bytes):
r"""Creates a binary file with the given content.
If content is given as a Unicode string, it is first converted to bytes
@@ -621,12 +648,15 @@ def create_binary_file(self, path, content):
encoding. `File Should Not Exist` can be used to avoid overwriting
existing files.
"""
- if is_string(content):
- content = bytes(ord(c) for c in content)
- path = self._write_to_file(path, content, mode='wb')
+ path = self._write_to_file(path, content, mode="wb")
self._link("Created binary file '%s'.", path)
- def append_to_file(self, path, content, encoding='UTF-8'):
+ def append_to_file(
+ self,
+ path: str,
+ content: "str | Secret" = "",
+ encoding: str = "UTF-8",
+ ):
"""Appends the given content to the specified file.
If the file exists, the given text is written to its end. If the file
@@ -636,10 +666,12 @@ def append_to_file(self, path, content, encoding='UTF-8'):
exactly like `Create File`. See its documentation for more details
about the usage.
"""
- path = self._write_to_file(path, content, encoding, mode='a')
+ if isinstance(content, Secret):
+ content = content.value
+ path = self._write_to_file(path, content, encoding, mode="a")
self._link("Appended to file '%s'.", path)
- def remove_file(self, path):
+ def remove_file(self, path: str):
"""Removes a file with the given path.
Passes if the file does not exist, but fails if the path does
@@ -655,11 +687,11 @@ def remove_file(self, path):
self._link("File '%s' does not exist.", path)
for match in matches:
if not os.path.isfile(match):
- self._error("Path '%s' is not a file." % match)
+ self._error(f"Path '{path}' is not a file.")
os.remove(match)
self._link("Removed file '%s'.", match)
- def remove_files(self, *paths):
+ def remove_files(self, *paths: str):
"""Uses `Remove File` to remove multiple files one-by-one.
Example:
@@ -668,10 +700,10 @@ def remove_files(self, *paths):
for path in paths:
self.remove_file(path)
- def empty_directory(self, path):
+ def empty_directory(self, path: str):
"""Deletes all the content from the given directory.
- Deletes both files and sub-directories, but the specified directory
+ Deletes both files and subdirectories, but the specified directory
itself if not removed. Use `Remove Directory` if you want to remove
the whole directory.
"""
@@ -683,28 +715,28 @@ def empty_directory(self, path):
os.remove(item)
self._link("Emptied directory '%s'.", path)
- def create_directory(self, path):
+ def create_directory(self, path: str):
"""Creates the specified directory.
- Also possible intermediate directories are created. Passes if the
+ Possible intermediate directories are created as well. Passes if the
directory already exists, but fails if the path exists and is not
a directory.
"""
path = self._absnorm(path)
if os.path.isdir(path):
- self._link("Directory '%s' already exists.", path )
+ self._link("Directory '%s' already exists.", path)
elif os.path.exists(path):
- self._error("Path '%s' is not a directory." % path)
+ self._error(f"Path '{path}' is not a directory.")
else:
os.makedirs(path)
self._link("Created directory '%s'.", path)
- def remove_directory(self, path, recursive=False):
+ def remove_directory(self, path: str, recursive: bool = False):
"""Removes the directory pointed to by the given ``path``.
- If the second argument ``recursive`` is given a true value (see
- `Boolean arguments`), the directory is removed recursively. Otherwise
- removing fails if the directory is not empty.
+ If the second argument ``recursive`` is given a true value, the
+ directory is removed recursively. Otherwise, removing fails if
+ the directory is not empty.
If the directory pointed to by the ``path`` does not exist, the keyword
passes, but it fails, if the ``path`` points to a file.
@@ -712,20 +744,19 @@ def remove_directory(self, path, recursive=False):
path = self._absnorm(path)
if not os.path.exists(path):
self._link("Directory '%s' does not exist.", path)
- elif not os.path.isdir(path):
- self._error("Path '%s' is not a directory." % path)
+ return
+ if not os.path.isdir(path):
+ self._error(f"Path '{path}' is not a directory.")
+ if recursive:
+ shutil.rmtree(path)
else:
- if is_truthy(recursive):
- shutil.rmtree(path)
- else:
- self.directory_should_be_empty(
- path, "Directory '%s' is not empty." % path)
- os.rmdir(path)
- self._link("Removed directory '%s'.", path)
+ self.directory_should_be_empty(path, f"Directory '{path}' is not empty.")
+ os.rmdir(path)
+ self._link("Removed directory '%s'.", path)
# Moving and copying files and directories
- def copy_file(self, source, destination):
+ def copy_file(self, source: str, destination: str) -> str:
r"""Copies the source file into the destination.
Source must be a path to an existing file or a glob pattern (see
@@ -739,12 +770,12 @@ def copy_file(self, source, destination):
copied into it. A possible file with the same name as the source is
overwritten.
- 3) If the destination does not exist and it ends with a path
+ 3) If the destination does not exist, and it ends with a path
separator (``/`` or ``\``), it is considered a directory. That
directory is created and a source file copied into it.
Possible missing intermediate directories are also created.
- 4) If the destination does not exist and it does not end with a path
+ 4) If the destination does not exist, and it does not end with a path
separator, it is considered a file. If the path to the file does not
exist, it is created.
@@ -752,59 +783,60 @@ def copy_file(self, source, destination):
See also `Copy Files`, `Move File`, and `Move Files`.
"""
- source, destination = \
- self._prepare_copy_and_move_file(source, destination)
+ source, destination = self._prepare_copy_file(source, destination)
if not self._are_source_and_destination_same_file(source, destination):
- source, destination = self._atomic_copy(source, destination)
+ self._atomic_copy(source, destination)
self._link("Copied file from '%s' to '%s'.", source, destination)
return destination
- def _prepare_copy_and_move_file(self, source, destination):
- source = self._normalize_copy_and_move_source(source)
- destination = self._normalize_copy_and_move_destination(destination)
- if os.path.isdir(destination):
- destination = os.path.join(destination, os.path.basename(source))
- return source, destination
+ def _prepare_copy_file(self, source: str, dest: str) -> "tuple[str, str]":
+ source = self._normalize_source(source)
+ dest = self._normalize_destination(dest)
+ if os.path.isdir(dest):
+ dest = os.path.join(dest, os.path.basename(source))
+ return source, dest
- def _normalize_copy_and_move_source(self, source):
+ def _normalize_source(self, source: str) -> str:
source = self._absnorm(source)
sources = self._glob(source)
if len(sources) > 1:
- self._error("Multiple matches with source pattern '%s'." % source)
+ self._error(f"Multiple matches with source pattern '{source}'.")
if sources:
source = sources[0]
if not os.path.exists(source):
- self._error("Source file '%s' does not exist." % source)
+ self._error(f"Source file '{source}' does not exist.")
if not os.path.isfile(source):
- self._error("Source file '%s' is not a regular file." % source)
+ self._error(f"Source file '{source}' is not a regular file.")
return source
- def _normalize_copy_and_move_destination(self, destination):
- is_dir = os.path.isdir(destination) or destination.endswith(('/', '\\'))
- destination = self._absnorm(destination)
- directory = destination if is_dir else os.path.dirname(destination)
+ def _normalize_destination(self, dest: str) -> str:
+ is_dir = os.path.isdir(dest) or dest.endswith(("/", "\\"))
+ dest = self._absnorm(dest)
+ directory = dest if is_dir else os.path.dirname(dest)
self._ensure_destination_directory_exists(directory)
- return destination
+ return dest
- def _ensure_destination_directory_exists(self, path):
+ def _ensure_destination_directory_exists(self, path: str):
if not os.path.exists(path):
os.makedirs(path)
elif not os.path.isdir(path):
- self._error("Destination '%s' exists and is not a directory." % path)
-
- def _are_source_and_destination_same_file(self, source, destination):
- if self._force_normalize(source) == self._force_normalize(destination):
- self._link("Source '%s' and destination '%s' point to the same "
- "file.", source, destination)
+ self._error(f"Destination '{path}' exists and is not a directory.")
+
+ def _are_source_and_destination_same_file(self, source: str, dest: str) -> bool:
+ if (
+ os.path.exists(source)
+ and os.path.exists(dest)
+ and os.path.samefile(source, dest)
+ ):
+ self._link(
+ "Source '%s' and destination '%s' point to the same file.",
+ source,
+ dest,
+ )
return True
return False
- def _force_normalize(self, path):
- # TODO: Should normalize_path also support link normalization?
- # TODO: Should we handle dos paths like 'exampl~1.txt'?
- return os.path.realpath(normpath(path, case_normalize=True))
-
- def _atomic_copy(self, source, destination):
+ def _atomic_copy(self, source: str, dest: str):
"""Copy file atomically (or at least try to).
This method tries to ensure that a file copy operation will not fail
@@ -819,37 +851,35 @@ def _atomic_copy(self, source, destination):
See also https://github.com/robotframework/robotframework/issues/1502
"""
- temp_directory = tempfile.mkdtemp(dir=os.path.dirname(destination))
+ temp_directory = tempfile.mkdtemp(dir=os.path.dirname(dest))
temp_file = os.path.join(temp_directory, os.path.basename(source))
try:
shutil.copy(source, temp_file)
- if os.path.exists(destination):
- os.remove(destination)
- shutil.move(temp_file, destination)
+ if os.path.exists(dest):
+ os.remove(dest)
+ shutil.move(temp_file, dest)
finally:
shutil.rmtree(temp_directory)
- return source, destination
- def move_file(self, source, destination):
+ def move_file(self, source: str, destination: str) -> str:
"""Moves the source file into the destination.
Arguments have exactly same semantics as with `Copy File` keyword.
Destination file path is returned.
If the source and destination are on the same filesystem, rename
- operation is used. Otherwise file is copied to the destination
+ operation is used. Otherwise, file is copied to the destination
filesystem and then removed from the original filesystem.
See also `Move Files`, `Copy File`, and `Copy Files`.
"""
- source, destination = \
- self._prepare_copy_and_move_file(source, destination)
+ source, destination = self._prepare_copy_file(source, destination)
if not self._are_source_and_destination_same_file(destination, source):
shutil.move(source, destination)
self._link("Moved file from '%s' to '%s'.", source, destination)
return destination
- def copy_files(self, *sources_and_destination):
+ def copy_files(self, *sources_and_destination: str):
"""Copies specified files to the target directory.
Source files can be given as exact paths and as glob patterns (see
@@ -865,57 +895,55 @@ def copy_files(self, *sources_and_destination):
See also `Copy File`, `Move File`, and `Move Files`.
"""
- sources, destination \
- = self._prepare_copy_and_move_files(sources_and_destination)
+ sources, dest = self._prepare_copy_files(sources_and_destination)
for source in sources:
- self.copy_file(source, destination)
+ self.copy_file(source, dest)
- def _prepare_copy_and_move_files(self, items):
+ def _prepare_copy_files(self, items: Sequence[str]) -> "tuple[list[str], str]":
if len(items) < 2:
- self._error('Must contain destination and at least one source.')
+ self._error("Must contain destination and at least one source.")
sources = self._glob_files(items[:-1])
destination = self._absnorm(items[-1])
self._ensure_destination_directory_exists(destination)
return sources, destination
- def _glob_files(self, patterns):
+ def _glob_files(self, patterns: Sequence[str]) -> "list[str]":
files = []
for pattern in patterns:
files.extend(self._glob(self._absnorm(pattern)))
return files
- def move_files(self, *sources_and_destination):
+ def move_files(self, *sources_and_destination: str):
"""Moves specified files to the target directory.
Arguments have exactly same semantics as with `Copy Files` keyword.
See also `Move File`, `Copy File`, and `Copy Files`.
"""
- sources, destination \
- = self._prepare_copy_and_move_files(sources_and_destination)
+ sources, dest = self._prepare_copy_files(sources_and_destination)
for source in sources:
- self.move_file(source, destination)
+ self.move_file(source, dest)
def copy_directory(self, source, destination):
"""Copies the source directory into the destination.
- If the destination exists, the source is copied under it. Otherwise
+ If the destination exists, the source is copied under it. Otherwise,
the destination directory and the possible missing intermediate
directories are created.
"""
- source, destination = self._prepare_copy_and_move_directory(source, destination)
+ source, destination = self._prepare_copy_dir(source, destination)
shutil.copytree(source, destination)
self._link("Copied directory from '%s' to '%s'.", source, destination)
- def _prepare_copy_and_move_directory(self, source, destination):
+ def _prepare_copy_dir(self, source: str, destination: str) -> "tuple[str, str]":
source = self._absnorm(source)
destination = self._absnorm(destination)
if not os.path.exists(source):
- self._error("Source '%s' does not exist." % source)
+ self._error(f"Source '{source}' does not exist.")
if not os.path.isdir(source):
- self._error("Source '%s' is not a directory." % source)
+ self._error(f"Source '{source}' is not a directory.")
if os.path.exists(destination) and not os.path.isdir(destination):
- self._error("Destination '%s' is not a directory." % destination)
+ self._error(f"Destination '{destination}' is not a directory.")
if os.path.exists(destination):
base = os.path.basename(source)
destination = os.path.join(destination, base)
@@ -925,22 +953,20 @@ def _prepare_copy_and_move_directory(self, source, destination):
os.makedirs(parent)
return source, destination
- def move_directory(self, source, destination):
+ def move_directory(self, source: str, destination: str):
"""Moves the source directory into a destination.
Uses `Copy Directory` keyword internally, and ``source`` and
``destination`` arguments have exactly same semantics as with
that keyword.
"""
- source, destination \
- = self._prepare_copy_and_move_directory(source, destination)
+ source, destination = self._prepare_copy_dir(source, destination)
shutil.move(source, destination)
self._link("Moved directory from '%s' to '%s'.", source, destination)
# Environment Variables
- @keyword(types=None)
- def get_environment_variable(self, name, default=None):
+ def get_environment_variable(self, name: str, default: "str | None" = None) -> str:
"""Returns the value of an environment variable with the given name.
If no environment variable is found, returns possible default value.
@@ -954,20 +980,33 @@ def get_environment_variable(self, name, default=None):
"""
value = get_env_var(name, default)
if value is None:
- self._error("Environment variable '%s' does not exist." % name)
+ self._error(f"Environment variable '{name}' does not exist.")
return value
- def set_environment_variable(self, name, value):
+ def set_environment_variable(self, name: str, value: "str | Secret"):
"""Sets an environment variable to a specified value.
Values are converted to strings automatically. Set variables are
automatically encoded using the system encoding.
"""
- set_env_var(name, value)
- self._info("Environment variable '%s' set to value '%s'."
- % (name, value))
+ if isinstance(value, Secret):
+ value = value.value
+ secret = True
+ else:
+ secret = False
+ self._set_environment_variable(name, value, secret)
- def append_to_environment_variable(self, name, *values, **config):
+ def _set_environment_variable(self, name: str, value: str, secret: bool = False):
+ set_env_var(name, value)
+ set_to = "a secret value" if secret else f"value '{value}'"
+ self._info(f"Environment variable '{name}' set to {set_to}.")
+
+ def append_to_environment_variable(
+ self,
+ name: str,
+ *values: "str | Secret",
+ separator: str = os.pathsep,
+ ):
"""Appends given ``values`` to environment variable ``name``.
If the environment variable already exists, values are added after it,
@@ -975,8 +1014,7 @@ def append_to_environment_variable(self, name, *values, **config):
Values are, by default, joined together using the operating system
path separator (``;`` on Windows, ``:`` elsewhere). This can be changed
- by giving a separator after the values like ``separator=value``. No
- other configuration parameters are accepted.
+ by giving a separator after the values like ``separator=value``.
Examples (assuming ``NAME`` and ``NAME2`` do not exist initially):
| Append To Environment Variable | NAME | first | |
@@ -988,18 +1026,17 @@ def append_to_environment_variable(self, name, *values, **config):
| Append To Environment Variable | NAME2 | second | separator=- |
| Should Be Equal | %{NAME2} | first-second |
"""
- sentinel = object()
- initial = self.get_environment_variable(name, sentinel)
- if initial is not sentinel:
- values = (initial,) + values
- separator = config.pop('separator', os.pathsep)
- if config:
- config = ['='.join(i) for i in sorted(config.items())]
- self._error('Configuration %s not accepted.'
- % seq2str(config, lastsep=' or '))
- self.set_environment_variable(name, separator.join(values))
-
- def remove_environment_variable(self, *names):
+ initial = get_env_var(name)
+ if initial:
+ values = (initial, *values)
+ if any(isinstance(v, Secret) for v in values):
+ values = [v.value if isinstance(v, Secret) else v for v in values]
+ secret = True
+ else:
+ secret = False
+ self._set_environment_variable(name, separator.join(values), secret)
+
+ def remove_environment_variable(self, *names: str):
"""Deletes the specified environment variable.
Does nothing if the environment variable is not set.
@@ -1010,32 +1047,41 @@ def remove_environment_variable(self, *names):
for name in names:
value = del_env_var(name)
if value:
- self._info("Environment variable '%s' deleted." % name)
+ self._info(f"Environment variable '{name}' deleted.")
else:
- self._info("Environment variable '%s' does not exist." % name)
+ self._info(f"Environment variable '{name}' does not exist.")
- def environment_variable_should_be_set(self, name, msg=None):
+ def environment_variable_should_be_set(self, name: str, msg: "str | None" = None):
"""Fails if the specified environment variable is not set.
+ Environment variable is considered not to be set if it does not exist
+ or if its value is an empty string.
+
The default error message can be overridden with the ``msg`` argument.
"""
value = get_env_var(name)
if not value:
- self._fail(msg, "Environment variable '%s' is not set." % name)
- self._info("Environment variable '%s' is set to '%s'." % (name, value))
-
- def environment_variable_should_not_be_set(self, name, msg=None):
+ self._fail(msg, f"Environment variable '{name}' is not set.")
+ self._info(f"Environment variable '{name}' is set to '{value}'.")
+
+ def environment_variable_should_not_be_set(
+ self,
+ name: str,
+ msg: "str | None" = None,
+ ):
"""Fails if the specified environment variable is set.
+ Environment variable is considered not to be set if it does not exist
+ or if its value is an empty string.
+
The default error message can be overridden with the ``msg`` argument.
"""
value = get_env_var(name)
if value:
- self._fail(msg, "Environment variable '%s' is set to '%s'."
- % (name, value))
- self._info("Environment variable '%s' is not set." % name)
+ self._fail(msg, f"Environment variable '{name}' is set to '{value}'.")
+ self._info(f"Environment variable '{name}' is not set.")
- def get_environment_variables(self):
+ def get_environment_variables(self) -> "dict[str, str]":
"""Returns currently available environment variables as a dictionary.
Both keys and values are decoded to Unicode using the system encoding.
@@ -1044,7 +1090,9 @@ def get_environment_variables(self):
"""
return get_env_vars()
- def log_environment_variables(self, level='INFO'):
+ def log_environment_variables(
+ self, level: logger.LogLevel = "INFO"
+ ) -> "dict[str, str]":
"""Logs all environment variables using the given log level.
Environment variables are also returned the same way as with
@@ -1052,12 +1100,12 @@ def log_environment_variables(self, level='INFO'):
"""
variables = get_env_vars()
for name in sorted(variables, key=lambda item: item.lower()):
- self._log('%s = %s' % (name, variables[name]), level)
+ self._log(f"{name} = {variables[name]}", level)
return variables
# Path
- def join_path(self, base, *parts):
+ def join_path(self, base: str, *parts: str) -> str:
"""Joins the given path part(s) to the given base path.
The path separator (``/`` or ``\\``) is inserted when needed and
@@ -1077,11 +1125,9 @@ def join_path(self, base, *parts):
- ${p4} = '/path'
- ${p5} = '/my/path2'
"""
- base = base.replace('/', os.sep)
- parts = [p.replace('/', os.sep) for p in parts]
return self.normalize_path(os.path.join(base, *parts))
- def join_paths(self, base, *paths):
+ def join_paths(self, base: str, *paths: str) -> "list[str]":
"""Joins given paths with base and returns resulted paths.
See `Join Path` for more information.
@@ -1097,14 +1143,15 @@ def join_paths(self, base, *paths):
"""
return [self.join_path(base, path) for path in paths]
- def normalize_path(self, path, case_normalize=False):
+ def normalize_path(self, path: str, case_normalize=False) -> str:
"""Normalizes the given path.
- Collapses redundant separators and up-level references.
- Converts ``/`` to ``\\`` on Windows.
- Replaces initial ``~`` or ``~user`` by that user's home directory.
- - If ``case_normalize`` is given a true value (see `Boolean arguments`)
- on Windows, converts the path to all lowercase.
+ - If ``case_normalize`` is given a true value on Windows, converts
+ the path to all lowercase.
+ - Converts ``pathlib.Path`` instances to ``str``.
Examples:
| ${path1} = | Normalize Path | abc/ |
@@ -1120,16 +1167,16 @@ def normalize_path(self, path, case_normalize=False):
On Windows result would use ``\\`` instead of ``/`` and home directory
would be different.
"""
- path = os.path.normpath(os.path.expanduser(path.replace('/', os.sep)))
+ path = os.path.normpath(os.path.expanduser(path))
# os.path.normcase doesn't normalize on OSX which also, by default,
# has case-insensitive file system. Our robot.utils.normpath would
# do that, but it's not certain would that, or other things that the
# utility do, desirable.
if case_normalize:
path = os.path.normcase(path)
- return path or '.'
+ return path or "."
- def split_path(self, path):
+ def split_path(self, path: str) -> "tuple[str, str]":
"""Splits the given path from the last path separator (``/`` or ``\\``).
The given path is first normalized (e.g. a possible trailing
@@ -1148,7 +1195,7 @@ def split_path(self, path):
"""
return os.path.split(self.normalize_path(path))
- def split_extension(self, path):
+ def split_extension(self, path: str) -> "tuple[str, str]":
"""Splits the extension from the given path.
The given path is first normalized (e.g. possible trailing
@@ -1176,16 +1223,16 @@ def split_extension(self, path):
"""
path = self.normalize_path(path)
basename = os.path.basename(path)
- if basename.startswith('.' * basename.count('.')):
- return path, ''
- if path.endswith('.'):
- path2 = path.rstrip('.')
- trailing_dots = '.' * (len(path) - len(path2))
+ if basename.startswith("." * basename.count(".")):
+ return path, ""
+ if path.endswith("."):
+ path2 = path.rstrip(".")
+ trailing_dots = "." * (len(path) - len(path2))
path = path2
else:
- trailing_dots = ''
+ trailing_dots = ""
basepath, extension = os.path.splitext(path)
- if extension.startswith('.'):
+ if extension.startswith("."):
extension = extension[1:]
if extension:
extension += trailing_dots
@@ -1195,7 +1242,11 @@ def split_extension(self, path):
# Misc
- def get_modified_time(self, path, format='timestamp'):
+ def get_modified_time(
+ self,
+ path: str,
+ format: str = "timestamp",
+ ) -> "int | str | list[str]":
"""Returns the last modification time of a file or directory.
How time is returned is determined based on the given ``format``
@@ -1232,12 +1283,12 @@ def get_modified_time(self, path, format='timestamp'):
"""
path = self._absnorm(path)
if not os.path.exists(path):
- self._error("Path '%s' does not exist." % path)
+ self._error(f"Path '{path}' does not exist.")
mtime = get_time(format, os.stat(path).st_mtime)
- self._link("Last modified time of '%%s' is %s." % mtime, path)
+ self._link(f"Last modified time of '%s' is {mtime}.", path)
return mtime
- def set_modified_time(self, path, mtime):
+ def set_modified_time(self, path: str, mtime: "int | str"):
"""Sets the file modification and access times.
Changes the modification and access times of the given file to
@@ -1276,25 +1327,29 @@ def set_modified_time(self, path, mtime):
mtime = parse_time(mtime)
path = self._absnorm(path)
if not os.path.exists(path):
- self._error("File '%s' does not exist." % path)
+ self._error(f"File '{path}' does not exist.")
if not os.path.isfile(path):
- self._error("Path '%s' is not a regular file." % path)
+ self._error(f"Path '{path}' is not a regular file.")
os.utime(path, (mtime, mtime))
- time.sleep(0.1) # Give os some time to really set these times
- tstamp = secs_to_timestamp(mtime, seps=('-', ' ', ':'))
- self._link("Set modified time of '%%s' to %s." % tstamp, path)
+ time.sleep(0.1) # Give OS some time to really set these times.
+ tstamp = datetime.fromtimestamp(mtime).isoformat(" ", timespec="seconds")
+ self._link(f"Set modified time of '%s' to {tstamp}.", path)
- def get_file_size(self, path):
+ def get_file_size(self, path: str) -> int:
"""Returns and logs file size as an integer in bytes."""
path = self._absnorm(path)
if not os.path.isfile(path):
- self._error("File '%s' does not exist." % path)
+ self._error(f"File '{path}' does not exist.")
size = os.stat(path).st_size
- plural = plural_or_not(size)
- self._link("Size of file '%%s' is %d byte%s." % (size, plural), path)
+ self._link(f"Size of file '%s' is {size} byte{s(size)}.", path)
return size
- def list_directory(self, path, pattern=None, absolute=False):
+ def list_directory(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
"""Returns and logs items in a directory, optionally filtered with ``pattern``.
File and directory names are returned in case-sensitive alphabetical
@@ -1305,7 +1360,7 @@ def list_directory(self, path, pattern=None, absolute=False):
File and directory names are returned relative to the given path
(e.g. ``'file.txt'``) by default. If you want them be returned in
absolute format (e.g. ``'/home/robot/file.txt'``), give the ``absolute``
- argument a true value (see `Boolean arguments`).
+ argument a true value.
If ``pattern`` is given, only items matching it are returned. The pattern
is considered to be a _glob pattern_ and the full syntax is explained in
@@ -1318,26 +1373,33 @@ def list_directory(self, path, pattern=None, absolute=False):
| ${count} = | Count Files In Directory | ${CURDIR} | ??? |
"""
items = self._list_dir(path, pattern, absolute)
- self._info('%d item%s:\n%s' % (len(items), plural_or_not(items),
- '\n'.join(items)))
+ self._info(f"{len(items)} item{s(items)}:\n" + "\n".join(items))
return items
- def list_files_in_directory(self, path, pattern=None, absolute=False):
+ def list_files_in_directory(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
"""Wrapper for `List Directory` that returns only files."""
files = self._list_files_in_dir(path, pattern, absolute)
- self._info('%d file%s:\n%s' % (len(files), plural_or_not(files),
- '\n'.join(files)))
+ self._info(f"{len(files)} file{s(files)}:\n" + "\n".join(files))
return files
- def list_directories_in_directory(self, path, pattern=None, absolute=False):
+ def list_directories_in_directory(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
"""Wrapper for `List Directory` that returns only directories."""
dirs = self._list_dirs_in_dir(path, pattern, absolute)
- self._info('%d director%s:\n%s' % (len(dirs),
- 'y' if len(dirs) == 1 else 'ies',
- '\n'.join(dirs)))
+ label = "directory" if len(dirs) == 1 else "directories"
+ self._info(f"{len(dirs)} {label}:\n" + "\n".join(dirs))
return dirs
- def count_items_in_directory(self, path, pattern=None):
+ def count_items_in_directory(self, path: str, pattern: "str | None" = None) -> int:
"""Returns and logs the number of all items in the given directory.
The argument ``pattern`` has the same semantics as with `List Directory`
@@ -1345,47 +1407,73 @@ def count_items_in_directory(self, path, pattern=None):
with the built-in keyword `Should Be Equal As Integers`.
"""
count = len(self._list_dir(path, pattern))
- self._info("%s item%s." % (count, plural_or_not(count)))
+ self._info(f"{count} item{s(count)}.")
return count
- def count_files_in_directory(self, path, pattern=None):
+ def count_files_in_directory(self, path: str, pattern: "str | None" = None) -> int:
"""Wrapper for `Count Items In Directory` returning only file count."""
count = len(self._list_files_in_dir(path, pattern))
- self._info("%s file%s." % (count, plural_or_not(count)))
+ self._info(f"{count} file{s(count)}.")
return count
- def count_directories_in_directory(self, path, pattern=None):
+ def count_directories_in_directory(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ ) -> int:
"""Wrapper for `Count Items In Directory` returning only directory count."""
count = len(self._list_dirs_in_dir(path, pattern))
- self._info("%s director%s." % (count, 'y' if count == 1 else 'ies'))
+ label = "directory" if count == 1 else "directories"
+ self._info(f"{count} {label}.")
return count
- def _list_dir(self, path, pattern=None, absolute=False):
+ def _list_dir(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
path = self._absnorm(path)
self._link("Listing contents of directory '%s'.", path)
if not os.path.isdir(path):
- self._error("Directory '%s' does not exist." % path)
- # result is already unicode but safe_str also handles NFC normalization
+ self._error(f"Directory '{path}' does not exist.")
+ # Result is already a string, but safe_str also handles NFC normalization.
items = sorted(safe_str(item) for item in os.listdir(path))
if pattern:
items = [i for i in items if fnmatch.fnmatchcase(i, pattern)]
- if is_truthy(absolute):
+ if absolute:
path = os.path.normpath(path)
items = [os.path.join(path, item) for item in items]
return items
- def _list_files_in_dir(self, path, pattern=None, absolute=False):
- return [item for item in self._list_dir(path, pattern, absolute)
- if os.path.isfile(os.path.join(path, item))]
-
- def _list_dirs_in_dir(self, path, pattern=None, absolute=False):
- return [item for item in self._list_dir(path, pattern, absolute)
- if os.path.isdir(os.path.join(path, item))]
-
- def touch(self, path):
+ def _list_files_in_dir(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
+ return [
+ item
+ for item in self._list_dir(path, pattern, absolute)
+ if os.path.isfile(os.path.join(path, item))
+ ]
+
+ def _list_dirs_in_dir(
+ self,
+ path: str,
+ pattern: "str | None" = None,
+ absolute: bool = False,
+ ) -> "list[str]":
+ return [
+ item
+ for item in self._list_dir(path, pattern, absolute)
+ if os.path.isdir(os.path.join(path, item))
+ ]
+
+ def touch(self, path: str):
"""Emulates the UNIX touch command.
- Creates a file, if it does not exist. Otherwise changes its access and
+ Creates a file, if it does not exist. Otherwise, changes its access and
modification times to the current time.
Fails if used with the directories or the parent directory of the given
@@ -1393,38 +1481,39 @@ def touch(self, path):
"""
path = self._absnorm(path)
if os.path.isdir(path):
- self._error("Cannot touch '%s' because it is a directory." % path)
+ self._error(f"Cannot touch '{path}' because it is a directory.")
if not os.path.exists(os.path.dirname(path)):
- self._error("Cannot touch '%s' because its parent directory does "
- "not exist." % path)
+ self._error(
+ f"Cannot touch '{path}' because its parent directory does not exist."
+ )
if os.path.exists(path):
mtime = round(time.time())
os.utime(path, (mtime, mtime))
self._link("Touched existing file '%s'.", path)
else:
- open(path, 'w').close()
+ open(path, "w", encoding="ASCII").close()
self._link("Touched new file '%s'.", path)
- def _absnorm(self, path):
+ def _absnorm(self, path: str) -> str:
return abspath(self.normalize_path(path))
- def _fail(self, *messages):
+ def _fail(self, *messages: str) -> NoReturn:
raise AssertionError(next(msg for msg in messages if msg))
- def _error(self, msg):
+ def _error(self, msg: str) -> NoReturn:
raise RuntimeError(msg)
- def _info(self, msg):
- self._log(msg, 'INFO')
+ def _info(self, msg: str):
+ self._log(msg, "INFO")
- def _link(self, msg, *paths):
- paths = tuple('%s' % (p, p) for p in paths)
- self._log(msg % paths, 'HTML')
+ def _link(self, msg: str, *paths: str):
+ paths = tuple(f'{p}' for p in paths)
+ self._log(msg % paths, "HTML")
- def _warn(self, msg):
- self._log(msg, 'WARN')
+ def _warn(self, msg: str):
+ self._log(msg, "WARN")
- def _log(self, msg, level):
+ def _log(self, msg: str, level: logger.LogLevel):
logger.write(msg, level)
@@ -1457,16 +1546,16 @@ def close(self):
return rc >> 8
def _process_command(self, command):
- if '>' not in command:
- if command.endswith('&'):
- command = command[:-1] + ' 2>&1 &'
+ if ">" not in command:
+ if command.endswith("&"):
+ command = command[:-1] + " 2>&1 &"
else:
- command += ' 2>&1'
+ command += " 2>&1"
return command
def _process_output(self, output):
- if '\r\n' in output:
- output = output.replace('\r\n', '\n')
- if output.endswith('\n'):
+ if "\r\n" in output:
+ output = output.replace("\r\n", "\n")
+ if output.endswith("\n"):
output = output[:-1]
return console_decode(output)
diff --git a/src/robot/libraries/Process.py b/src/robot/libraries/Process.py
index 07c74b221d0..d0e0d1c2b9a 100644
--- a/src/robot/libraries/Process.py
+++ b/src/robot/libraries/Process.py
@@ -14,36 +14,365 @@
# limitations under the License.
import os
+import signal as signal_module
import subprocess
+import sys
import time
-from tempfile import TemporaryFile
-import signal as signal_module
+from collections.abc import Sequence
+from datetime import timedelta
+from io import IOBase
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+from typing import Literal, Union
-from robot.utils import (abspath, cmdline2list, ConnectionCache, console_decode,
- console_encode, is_list_like, is_string, is_truthy,
- NormalizedDict, secs_to_timestr, system_decode,
- system_encode, timestr_to_secs, WINDOWS)
-from robot.version import get_version
from robot.api import logger
+from robot.api.deco import library
+from robot.api.types import Secret
+from robot.errors import TimeoutExceeded
+from robot.utils import (
+ cmdline2list, ConnectionCache, console_decode, console_encode, NormalizedDict,
+ secs_to_timestr, system_decode, system_encode, WINDOWS
+)
+from robot.version import get_version
+
+LOCALE_ENCODING = "locale" if sys.version_info >= (3, 10) else None
+Handle = Union[subprocess.Popen, "str", None]
+Stdin = Union[str, Secret, Path, int, IOBase, None]
+OnTimeout = Literal["continue", "terminate", "kill"]
+
+
+class ProcessResult:
+ """An object containing process execution results in its attributes.
+
+ | = Attribute = | = Explanation = |
+ | rc | Return code of the process as an integer. |
+ | stdout | Contents of the standard output stream. |
+ | stderr | Contents of the standard error stream. |
+ | stdout_path | Path where stdout was redirected or ``None`` if not redirected. |
+ | stderr_path | Path where stderr was redirected or ``None`` if not redirected. |
+
+ Example:
+ | ${result} = | `Run Process` | program |
+ | `Should Be Equal ` | ${result.rc} | 0 | type=int |
+ | `Should Match` | ${result.stdout} | Some t?xt* |
+ | `Should Be Empty` | ${result.stderr} | |
+ | ${stdout} = | `Get File` | ${result.stdout_path} |
+ | `Should Be Equal` | ${stdout} | ${result.stdout} |
+ | `File Should Be Empty` | ${result.stderr_path} | |
+
+ Notice that in ``stdout`` and ``stderr`` content possible trailing newline
+ is removed and ``\\r\\n`` converted to ``\\n`` automatically. If you
+ need to see the original process output, redirect it to a file using
+ `process configuration` and read it from there.
+ """
+
+ def __init__(
+ self,
+ process,
+ stdout,
+ stderr,
+ stdin=None,
+ rc=None,
+ output_encoding=None,
+ ):
+ self._process = process
+ self.stdout_path = self._get_path(stdout)
+ self.stderr_path = self._get_path(stderr)
+ self.rc = rc
+ self._output_encoding = output_encoding
+ self._stdout = None
+ self._stderr = None
+ self._custom_streams = [
+ stream
+ for stream in (stdout, stderr, stdin)
+ if self._is_custom_stream(stream)
+ ]
+
+ def _get_path(self, stream):
+ return stream.name if self._is_custom_stream(stream) else None
+
+ def _is_custom_stream(self, stream):
+ return stream not in (subprocess.PIPE, subprocess.STDOUT, None)
+
+ @property
+ def stdout(self):
+ if self._stdout is None:
+ self._read_stdout()
+ return self._stdout
+
+ @stdout.setter
+ def stdout(self, stdout):
+ self._stdout = self._format_output(stdout)
+
+ @property
+ def stderr(self):
+ if self._stderr is None:
+ self._read_stderr()
+ return self._stderr
+
+ @stderr.setter
+ def stderr(self, stderr):
+ self._stderr = self._format_output(stderr)
+
+ def _read_stdout(self):
+ self._stdout = self._read_stream(self.stdout_path, self._process.stdout)
+
+ def _read_stderr(self):
+ self._stderr = self._read_stream(self.stderr_path, self._process.stderr)
+
+ def _read_stream(self, stream_path, stream):
+ if stream_path:
+ stream = open(stream_path, "rb")
+ elif not self._is_open(stream):
+ return ""
+ try:
+ content = stream.read()
+ except IOError:
+ content = ""
+ finally:
+ if stream_path:
+ stream.close()
+ return self._format_output(content)
+
+ def _is_open(self, stream):
+ return stream and not stream.closed
+
+ def _format_output(self, output):
+ if output is None:
+ return None
+ output = console_decode(output, self._output_encoding)
+ output = output.replace("\r\n", "\n")
+ if output.endswith("\n"):
+ output = output[:-1]
+ return output
+
+ def close_streams(self):
+ standard_streams = self._get_and_read_standard_streams(self._process)
+ for stream in standard_streams + self._custom_streams:
+ if self._is_open(stream):
+ stream.close()
+
+ def _get_and_read_standard_streams(self, process):
+ stdin, stdout, stderr = process.stdin, process.stdout, process.stderr
+ if self._is_open(stdout):
+ self._read_stdout()
+ if self._is_open(stderr):
+ self._read_stderr()
+ return [stdin, stdout, stderr]
+
+ def __str__(self):
+ return f""
+
+
+class ProcessConfiguration:
+
+ def __init__(
+ self,
+ cwd=None,
+ shell=False,
+ stdout=None,
+ stderr=None,
+ stdin=None,
+ output_encoding="CONSOLE",
+ alias=None,
+ env=None,
+ **env_extra,
+ ):
+ self.cwd = os.path.normpath(cwd) if cwd else os.path.abspath(".")
+ self.shell = shell
+ self.alias = alias
+ self.output_encoding = output_encoding
+ self.stdout_stream = self._new_stream(stdout)
+ self.stderr_stream = self._get_stderr(stderr, stdout, self.stdout_stream)
+ self.stdin_stream = self._get_stdin(stdin)
+ self.secret_env_keys = []
+ self.env = self._construct_env(env, env_extra)
+
+ def _new_stream(self, name):
+ if name == "DEVNULL":
+ return open(os.devnull, "w", encoding=LOCALE_ENCODING)
+ if name:
+ path = os.path.normpath(os.path.join(self.cwd, name))
+ return open(path, "w", encoding=LOCALE_ENCODING)
+ return subprocess.PIPE
+
+ def _get_stderr(self, stderr, stdout, stdout_stream):
+ if stderr and stderr in ["STDOUT", stdout]:
+ if stdout_stream != subprocess.PIPE:
+ return stdout_stream
+ return subprocess.STDOUT
+ return self._new_stream(stderr)
+
+ def _get_stdin(self, stdin):
+ if isinstance(stdin, Path):
+ stdin = str(stdin)
+ elif isinstance(stdin, Secret):
+ stdin = stdin.value
+ elif not isinstance(stdin, str):
+ return stdin
+ elif stdin.upper() == "NONE":
+ return None
+ elif stdin == "PIPE":
+ return subprocess.PIPE
+ path = os.path.normpath(os.path.join(self.cwd, stdin))
+ if os.path.isfile(path):
+ return open(path, encoding=LOCALE_ENCODING)
+ stdin_file = NamedTemporaryFile(prefix="stdin-")
+ stdin_file.write(console_encode(stdin, self.output_encoding, force=True))
+ stdin_file.seek(0)
+ return stdin_file
+
+ def _construct_env(self, env, extra):
+ env = self._get_initial_env(env, extra)
+ if env is None:
+ return None
+ if WINDOWS:
+ env = NormalizedDict(env, spaceless=False)
+ self._add_to_env(env, extra)
+ if WINDOWS:
+ env = {key.upper(): env[key] for key in env}
+ return env
+
+ def _get_initial_env(self, env, extra):
+ if env:
+ result = {}
+ for name, value in env.items():
+ name = system_encode(name)
+ if isinstance(value, Secret):
+ result[name] = system_encode(value.value)
+ self.secret_env_keys.append(name)
+ else:
+ result[name] = system_encode(value)
+ return result
+ if extra:
+ return os.environ.copy()
+ return None
+
+ def _add_to_env(self, env, extra):
+ for name, value in extra.items():
+ if not name.startswith("env:"):
+ raise RuntimeError(
+ f"Keyword argument '{name}' is not supported by this keyword."
+ )
+ name = system_encode(name[4:])
+ if isinstance(value, Secret):
+ env[name] = system_encode(value.value)
+ self.secret_env_keys.append(name)
+ else:
+ env[name] = system_encode(value)
+ def get_command(self, command, arguments):
+ command = [system_encode(item) for item in (command, *arguments)]
+ if not self.shell:
+ return command
+ if arguments:
+ return subprocess.list2cmdline(command)
+ return command[0]
+
+ @property
+ def popen_config(self):
+ config = {
+ "stdout": self.stdout_stream,
+ "stderr": self.stderr_stream,
+ "stdin": self.stdin_stream,
+ "shell": self.shell,
+ "cwd": self.cwd,
+ "env": self.env,
+ }
+ self._add_process_group_config(config)
+ return config
+ def _add_process_group_config(self, config):
+ if hasattr(os, "setsid"):
+ config["start_new_session"] = True
+ if hasattr(subprocess, "CREATE_NEW_PROCESS_GROUP"):
+ config["creationflags"] = subprocess.CREATE_NEW_PROCESS_GROUP
+
+ @property
+ def result_config(self):
+ return {
+ "stdout": self.stdout_stream,
+ "stderr": self.stderr_stream,
+ "stdin": self.stdin_stream,
+ "output_encoding": self.output_encoding,
+ }
+
+ def __str__(self):
+ if self.secret_env_keys:
+ secret_env = dict.fromkeys(self.secret_env_keys, str(Secret("")))
+ env = {**self.env, **secret_env}
+ else:
+ env = self.env
+ return f"""\
+cwd: {self.cwd}
+shell: {self.shell}
+stdout: {self._stream_name(self.stdout_stream)}
+stderr: {self._stream_name(self.stderr_stream)}
+stdin: {self._stream_name(self.stdin_stream)}
+alias: {self.alias}
+env: {env}"""
+
+ def _stream_name(self, stream):
+ if hasattr(stream, "name"):
+ return stream.name
+ return {
+ subprocess.PIPE: "PIPE",
+ subprocess.STDOUT: "STDOUT",
+ None: "None",
+ }.get(stream, stream)
+
+
+# Dummy argument converter for providing type documentation to Popen.
+def _popen_documentation(value):
+ """[https://docs.python.org/library/subprocess.html#popen-objects|subprocess.Popen] object.
+
+ Returned by `Start Process`. Can be used as a ``handle`` with keywords
+ like `Wait For Process` when working with multiple concurrent processes.
+ Attributes like ``pid`` and ``stdin`` can also be accessed directly.
+
+ Examples:
+ | ${process} = | `Start Process` | ${command} |
+ | `Log` | PID: ${process.pid} |
+ | # Oher keywords |
+ | ${result} = | `Terminate Process` | ${process} |
+ """
+ return value
+
+
+@library(
+ converters={
+ ProcessResult: lambda value: value,
+ subprocess.Popen: _popen_documentation,
+ },
+ auto_keywords=True,
+)
class Process:
"""Robot Framework library for running processes.
- This library utilizes Python's
- [http://docs.python.org/library/subprocess.html|subprocess]
- module and its
- [http://docs.python.org/library/subprocess.html#popen-constructor|Popen]
- class.
-
The library has following main usages:
- Running processes in system and waiting for their completion using
- `Run Process` keyword.
- - Starting processes on background using `Start Process`.
+ the `Run Process` keyword.
+ - Starting processes on background using the `Start Process` keyword.
- Waiting started process to complete using `Wait For Process` or
stopping them with `Terminate Process` or `Terminate All Processes`.
+ This library provides various benefits over using ``Run`` and other similar
+ keywords in the
+ [http://robotframework.org/robotframework/latest/libraries/OperatingSystem.html|
+ OperatingSystem] library:
+
+ - Better `process configuration`.
+ - Convenient `result object` with all result information (rc, stdout, stderr).
+ - Support for background processes, process termination, sending signals
+ and so on.
+
+ This library utilizes Python's
+ [http://docs.python.org/library/subprocess.html|subprocess]
+ module and its
+ [http://docs.python.org/library/subprocess.html#popen-constructor|Popen]
+ class.
+
== Table of contents ==
%TOC%
@@ -72,31 +401,30 @@ class Process:
= Process configuration =
`Run Process` and `Start Process` keywords can be configured using
- optional ``**configuration`` keyword arguments. Configuration arguments
- must be given after other arguments passed to these keywords and must
- use syntax like ``name=value``. Available configuration arguments are
- listed below and discussed further in sections afterwards.
-
- | = Name = | = Explanation = |
- | shell | Specifies whether to run the command in shell or not. |
- | cwd | Specifies the working directory. |
- | env | Specifies environment variables given to the process. |
- | env: | Overrides the named environment variable(s) only. |
- | stdout | Path of a file where to write standard output. |
- | stderr | Path of a file where to write standard error. |
- | stdin | Configure process standard input. New in RF 4.1.2. |
- | output_encoding | Encoding to use when reading command outputs. |
- | alias | Alias given to the process. |
-
- Note that because ``**configuration`` is passed using ``name=value`` syntax,
- possible equal signs in other arguments passed to `Run Process` and
- `Start Process` must be escaped with a backslash like ``name\\=value``.
+ optional configuration arguments. These arguments must be given
+ after other arguments passed to these keywords and must use the
+ ``name=value`` syntax. Available configuration arguments are
+ listed below and discussed further in the subsequent sections.
+
+ | = Name = | = Explanation = |
+ | shell | Specify whether to run the command in a shell or not. |
+ | cwd | Specify the working directory. |
+ | env | Specify environment variables given to the process. |
+ | **env_extra | Override named environment variables using ``env:=`` syntax. |
+ | stdout | Path to a file where to write standard output. |
+ | stderr | Path to a file where to write standard error. |
+ | stdin | Configure process standard input. New in RF 4.1.2. |
+ | output_encoding | Encoding to use when reading command outputs. |
+ | alias | A custom name given to the process. |
+
+ Note that possible equal signs in other arguments passed to `Run Process`
+ and `Start Process` must be escaped with a backslash like ``name\\=value``.
See `Run Process` for an example.
== Running processes in shell ==
The ``shell`` argument specifies whether to run the process in a shell or
- not. By default shell is not used, which means that shell specific commands,
+ not. By default, shell is not used, which means that shell specific commands,
like ``copy`` and ``dir`` on Windows, are not available. You can, however,
run shell scripts and batch files without using a shell.
@@ -129,8 +457,8 @@ class Process:
== Environment variables ==
- By default the child process will get a copy of the parent process's
- environment variables. The ``env`` argument can be used to give the
+ The child process will get a copy of the parent process's environment
+ variables by default. The ``env`` argument can be used to give the
child a custom environment as a Python dictionary. If there is a need
to specify only certain environment variable, it is possible to use the
``env:=`` format to set or override only that named variables.
@@ -143,36 +471,35 @@ class Process:
== Standard output and error streams ==
- By default processes are run so that their standard output and standard
- error streams are kept in the memory. This works fine normally,
- but if there is a lot of output, the output buffers may get full and
- the program can hang.
+ By default, processes are run so that their standard output and standard
+ error streams are kept in the memory. This typically works fine, but there
+ can be problems if the amount of output is large or unlimited. Prior to
+ Robot Framework 7.3 the limit was smaller than nowadays and reaching it
+ caused a deadlock.
- To avoid the above mentioned problems, it is possible to use ``stdout``
+ To avoid the above-mentioned problems, it is possible to use ``stdout``
and ``stderr`` arguments to specify files on the file system where to
- redirect the outputs. This can also be useful if other processes or
- other keywords need to read or manipulate the outputs somehow.
+ redirect the output. This can also be useful if other processes or
+ other keywords need to read or manipulate the output somehow.
Given ``stdout`` and ``stderr`` paths are relative to the `current working
directory`. Forward slashes in the given paths are automatically converted
to backslashes on Windows.
- As a special feature, it is possible to redirect the standard error to
- the standard output by using ``stderr=STDOUT``.
-
Regardless are outputs redirected to files or not, they are accessible
through the `result object` returned when the process ends. Commands are
expected to write outputs using the console encoding, but `output encoding`
can be configured using the ``output_encoding`` argument if needed.
- If you are not interested in outputs at all, you can explicitly ignore them
- by using a special value ``DEVNULL`` both with ``stdout`` and ``stderr``. For
+ As a special feature, it is possible to redirect the standard error to
+ the standard output by using ``stderr=STDOUT``.
+
+ If you are not interested in output at all, you can explicitly ignore it by
+ using a special value ``DEVNULL`` both with ``stdout`` and ``stderr``. For
example, ``stdout=DEVNULL`` is the same as redirecting output on console
with ``> /dev/null`` on UNIX-like operating systems or ``> NUL`` on Windows.
- This way the process will not hang even if there would be a lot of output,
- but naturally output is not available after execution either.
-
- Support for the special value ``DEVNULL`` is new in Robot Framework 3.2.
+ This way even a huge amount of output cannot cause problems, but naturally
+ the output is not available after execution either.
Examples:
| ${result} = | `Run Process` | program | stdout=${TEMPDIR}/stdout.txt | stderr=${TEMPDIR}/stderr.txt |
@@ -182,7 +509,7 @@ class Process:
| ${result} = | `Run Process` | program | stdout=DEVNULL | stderr=DEVNULL |
Note that the created output files are not automatically removed after
- the test run. The user is responsible to remove them if needed.
+ execution. The user is responsible to remove them if needed.
== Standard input stream ==
@@ -191,25 +518,23 @@ class Process:
explained in the table below.
| = Value = | = Explanation = |
- | String ``PIPE`` | Make stdin a pipe that can be written to. This is the default. |
- | String ``NONE`` | Inherit stdin from the parent process. This value is case-insensitive. |
+ | String ``NONE`` | Inherit stdin from the parent process. This is the default. |
+ | String ``PIPE`` | Make stdin a pipe that can be written to. |
| Path to a file | Open the specified file and use it as the stdin. |
| Any other string | Create a temporary file with the text as its content and use it as the stdin. |
| Any non-string value | Used as-is. Could be a file descriptor, stdout of another process, etc. |
- Values ``PIPE`` and ``NONE`` are internally mapped directly to
+ Values ``PIPE`` and ``NONE`` are case-insensitive and internally mapped to
``subprocess.PIPE`` and ``None``, respectively, when calling
[https://docs.python.org/3/library/subprocess.html#subprocess.Popen|subprocess.Popen].
- The default behavior may change from ``PIPE`` to ``NONE`` in future
- releases. If you depend on the ``PIPE`` behavior, it is a good idea to use
- it explicitly.
Examples:
- | `Run Process` | command | stdin=NONE |
+ | `Run Process` | command | stdin=PIPE |
| `Run Process` | command | stdin=${CURDIR}/stdin.txt |
| `Run Process` | command | stdin=Stdin as text. |
- The support to configure ``stdin`` is new in Robot Framework 4.1.2.
+ The support to configure ``stdin`` is new in Robot Framework 4.1.2. Its default
+ value used to be ``PIPE`` until Robot Framework 7.0.
== Output encoding ==
@@ -244,7 +569,7 @@ class Process:
= Active process =
The library keeps record which of the started processes is currently active.
- By default it is the latest process started with `Start Process`,
+ By default, it is the latest process started with `Start Process`,
but `Switch Process` can be used to activate a different process. Using
`Run Process` does not affect the active process.
@@ -270,35 +595,17 @@ class Process:
Example:
| ${result} = | `Run Process` | program |
- | `Should Be Equal As Integers` | ${result.rc} | 0 |
+ | `Should Be Equal ` | ${result.rc} | 0 | type=int |
| `Should Match` | ${result.stdout} | Some t?xt* |
| `Should Be Empty` | ${result.stderr} | |
| ${stdout} = | `Get File` | ${result.stdout_path} |
| `Should Be Equal` | ${stdout} | ${result.stdout} |
| `File Should Be Empty` | ${result.stderr_path} | |
- = Boolean arguments =
-
- Some keywords accept arguments that are handled as Boolean values true or
- false. If such an argument is given as a string, it is considered false if
- it is an empty string or equal to ``FALSE``, ``NONE``, ``NO``, ``OFF`` or
- ``0``, case-insensitively. Other strings are considered true regardless
- their value, and other argument types are tested using the same
- [http://docs.python.org/library/stdtypes.html#truth|rules as in Python].
-
- True examples:
- | `Terminate Process` | kill=True | # Strings are generally true. |
- | `Terminate Process` | kill=yes | # Same as the above. |
- | `Terminate Process` | kill=${TRUE} | # Python ``True`` is true. |
- | `Terminate Process` | kill=${42} | # Numbers other than 0 are true. |
-
- False examples:
- | `Terminate Process` | kill=False | # String ``false`` is false. |
- | `Terminate Process` | kill=no | # Also string ``no`` is false. |
- | `Terminate Process` | kill=${EMPTY} | # Empty string is false. |
- | `Terminate Process` | kill=${FALSE} | # Python ``False`` is false. |
-
- Considering ``OFF`` and ``0`` false is new in Robot Framework 3.1.
+ Notice that in ``stdout`` and ``stderr`` content possible trailing newline
+ is removed and ``\\r\\n`` converted to ``\\n`` automatically. If you
+ need to see the original process output, redirect it to a file using
+ `process configuration` and read it from there.
= Example =
@@ -316,64 +623,112 @@ class Process:
| ${result} = `Wait For Process` First
| `Should Be Equal As Integers` ${result.rc} 0
"""
- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+ ROBOT_LIBRARY_SCOPE = "GLOBAL"
ROBOT_LIBRARY_VERSION = get_version()
TERMINATE_TIMEOUT = 30
KILL_TIMEOUT = 10
def __init__(self):
- self._processes = ConnectionCache('No active process.')
- self._results = {}
-
- def run_process(self, command, *arguments, **configuration):
+ self._processes = ConnectionCache[subprocess.Popen]("No active process.")
+ self._results: dict[subprocess.Popen, ProcessResult] = {}
+
+ def run_process(
+ self,
+ command: str,
+ *arguments: "str | Secret",
+ cwd: "str | None" = None,
+ shell: bool = False,
+ stdout: "str | None" = None,
+ stderr: "str | None" = None,
+ stdin: Stdin = None,
+ output_encoding: str = "CONSOLE",
+ alias: "str | None" = None,
+ timeout: "timedelta | None" = None,
+ on_timeout: OnTimeout = "terminate",
+ env: "dict[str, str | Secret] | None" = None,
+ **env_extra: "str | Secret",
+ ) -> ProcessResult:
"""Runs a process and waits for it to complete.
- ``command`` and ``*arguments`` specify the command to execute and
+ ``command`` and ``arguments`` specify the command to execute and
arguments passed to it. See `Specifying command and arguments` for
more details.
- ``**configuration`` contains additional configuration related to
- starting processes and waiting for them to finish. See `Process
- configuration` for more details about configuration related to starting
- processes. Configuration related to waiting for processes consists of
- ``timeout`` and ``on_timeout`` arguments that have same semantics as
- with `Wait For Process` keyword. By default there is no timeout, and
- if timeout is defined the default action on timeout is ``terminate``.
+ The started process can be configured using ``cwd``, ``shell``, ``stdout``,
+ ``stderr``, ``stdin``, ``output_encoding``, ``alias``, ``env`` and
+ ``env_extra`` parameters that are documented in the `Process configuration`
+ section.
+
+ Configuration related to waiting for processes consists of ``timeout``
+ and ``on_timeout`` parameters that have same semantics than with the
+ `Wait For Process` keyword.
+
+ Process outputs are, by default, written into in-memory buffers.
+ This typically works fine, but there can be problems if the amount of
+ output is large or unlimited. To avoid such problems, outputs can be
+ redirected to files using the ``stdout`` and ``stderr`` configuration
+ parameters. For more information see the `Standard output and error streams`
+ section.
Returns a `result object` containing information about the execution.
- Note that possible equal signs in ``*arguments`` must be escaped
- with a backslash (e.g. ``name\\=value``) to avoid them to be passed in
- as ``**configuration``.
+ Note that possible equal signs in ``command`` and ``arguments`` must
+ be escaped with a backslash (e.g. ``name\\=value``).
Examples:
| ${result} = | Run Process | python | -c | print('Hello, world!') |
| Should Be Equal | ${result.stdout} | Hello, world! |
- | ${result} = | Run Process | ${command} | stderr=STDOUT | timeout=10s |
+ | ${result} = | Run Process | ${command} | stdout=${CURDIR}/stdout.txt | stderr=STDOUT |
| ${result} = | Run Process | ${command} | timeout=1min | on_timeout=continue |
| ${result} = | Run Process | java -Dname\\=value Example | shell=True | cwd=${EXAMPLE} |
This keyword does not change the `active process`.
"""
current = self._processes.current
- timeout = configuration.pop('timeout', None)
- on_timeout = configuration.pop('on_timeout', 'terminate')
try:
- handle = self.start_process(command, *arguments, **configuration)
+ handle = self.start_process(
+ command,
+ *arguments,
+ cwd=cwd,
+ shell=shell,
+ stdout=stdout,
+ stderr=stderr,
+ stdin=stdin,
+ output_encoding=output_encoding,
+ alias=alias,
+ env=env,
+ **env_extra,
+ )
return self.wait_for_process(handle, timeout, on_timeout)
finally:
self._processes.current = current
- def start_process(self, command, *arguments, **configuration):
+ def start_process(
+ self,
+ command: str,
+ *arguments: "str | Secret",
+ cwd: "str | None" = None,
+ shell: bool = False,
+ stdout: "str | None" = None,
+ stderr: "str | None" = None,
+ stdin: Stdin = None,
+ output_encoding: str = "CONSOLE",
+ alias: "str | None" = None,
+ env: "dict[str, str | Secret] | None" = None,
+ **env_extra: "str | Secret",
+ ) -> subprocess.Popen:
"""Starts a new process on background.
- See `Specifying command and arguments` and `Process configuration`
+ See `Specifying command and arguments` and `Process configuration` sections
for more information about the arguments, and `Run Process` keyword
- for related examples.
+ for related examples. This includes information about redirecting
+ process outputs to avoid process handing due to output buffers getting
+ full.
Makes the started process new `active process`. Returns the created
- [https://docs.python.org/3/library/subprocess.html#popen-constructor |
- subprocess.Popen] object which can be be used later to active this
+ [https://docs.python.org/3/library/subprocess.html#popen-objects |
+ subprocess.Popen] object which can be used later to activate this
process. ``Popen`` attributes like ``pid`` can also be accessed directly.
Processes are started so that they create a new process group. This
@@ -381,7 +736,7 @@ def start_process(self, command, *arguments, **configuration):
Examples:
- Start process and wait for it to end later using alias:
+ Start process and wait for it to end later using an alias:
| `Start Process` | ${command} | alias=example |
| # Other keywords |
| ${result} = | `Wait For Process` | example |
@@ -402,21 +757,37 @@ def start_process(self, command, *arguments, **configuration):
Earlier versions returned a generic handle and getting the process object
required using `Get Process Object` separately.
"""
- conf = ProcessConfiguration(**configuration)
- command = conf.get_command(command, list(arguments))
- self._log_start(command, conf)
- process = subprocess.Popen(command, **conf.popen_config)
- self._results[process] = ExecutionResult(process, **conf.result_config)
- self._processes.register(process, alias=conf.alias)
+ config = ProcessConfiguration(
+ cwd=cwd,
+ shell=shell,
+ stdout=stdout,
+ stderr=stderr,
+ stdin=stdin,
+ output_encoding=output_encoding,
+ alias=alias,
+ env=env,
+ **env_extra,
+ )
+ actual_arguments = []
+ logged_arguments = []
+ for arg in arguments:
+ actual_arguments.append(arg.value if isinstance(arg, Secret) else arg)
+ logged_arguments.append(str(arg))
+ self._log_start(config.get_command(command, logged_arguments), config)
+ process = subprocess.Popen(
+ config.get_command(command, actual_arguments), **config.popen_config
+ )
+ self._results[process] = ProcessResult(process, **config.result_config)
+ self._processes.register(process, alias=config.alias)
return self._processes.current
- def _log_start(self, command, config):
- if is_list_like(command):
- command = self.join_command_line(command)
- logger.info('Starting process:\n%s' % system_decode(command))
- logger.debug('Process configuration:\n%s' % config)
+ def _log_start(self, command: "str | list[str]", config: ProcessConfiguration):
+ if isinstance(command, list):
+ command = self.join_command_line(*command)
+ logger.info(f"Starting process:\n{system_decode(command)}")
+ logger.debug(f"Process configuration:\n{config}")
- def is_process_running(self, handle=None):
+ def is_process_running(self, handle: Handle = None) -> bool:
"""Checks is the process running or not.
If ``handle`` is not given, uses the current `active process`.
@@ -425,8 +796,11 @@ def is_process_running(self, handle=None):
"""
return self._processes[handle].poll() is None
- def process_should_be_running(self, handle=None,
- error_message='Process is not running.'):
+ def process_should_be_running(
+ self,
+ handle: Handle = None,
+ error_message: str = "Process is not running.",
+ ):
"""Verifies that the process is running.
If ``handle`` is not given, uses the current `active process`.
@@ -436,8 +810,11 @@ def process_should_be_running(self, handle=None,
if not self.is_process_running(handle):
raise AssertionError(error_message)
- def process_should_be_stopped(self, handle=None,
- error_message='Process is running.'):
+ def process_should_be_stopped(
+ self,
+ handle: Handle = None,
+ error_message: str = "Process is running.",
+ ):
"""Verifies that the process is not running.
If ``handle`` is not given, uses the current `active process`.
@@ -447,7 +824,12 @@ def process_should_be_stopped(self, handle=None,
if self.is_process_running(handle):
raise AssertionError(error_message)
- def wait_for_process(self, handle=None, timeout=None, on_timeout='continue'):
+ def wait_for_process(
+ self,
+ handle: Handle = None,
+ timeout: "timedelta | None" = None,
+ on_timeout: OnTimeout = "continue",
+ ) -> "ProcessResult | None":
"""Waits for the process to complete or to reach the given timeout.
The process to wait for must have been started earlier with
@@ -459,8 +841,7 @@ def wait_for_process(self, handle=None, timeout=None, on_timeout='continue'):
[http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format|
various time formats] supported by Robot Framework, for example, ``42``,
``42 s``, or ``1 minute 30 seconds``. The timeout is ignored if it is
- Python ``None`` (default), string ``NONE`` (case-insensitively), zero,
- or negative.
+ ``None`` (default), zero or negative.
``on_timeout`` defines what to do if the timeout occurs. Possible values
and corresponding actions are explained in the table below. Notice
@@ -474,7 +855,7 @@ def wait_for_process(self, handle=None, timeout=None, on_timeout='continue'):
See `Terminate Process` keyword for more details how processes are
terminated and killed.
- If the process ends before the timeout or it is terminated or killed,
+ If the process ends before the timeout, or it is terminated or killed,
this keyword returns a `result object` containing information about
the execution. If the process is left running, Python ``None`` is
returned instead.
@@ -493,123 +874,146 @@ def wait_for_process(self, handle=None, timeout=None, on_timeout='continue'):
| Process Should Be Stopped | | |
| Should Be Equal As Integers | ${result.rc} | -9 |
- Ignoring timeout if it is string ``NONE``, zero, or negative is new
- in Robot Framework 3.2.
+ Note: If Robot Framework's test or keyword timeout is exceeded while
+ this keyword is waiting for the process to end, the process is killed
+ to avoid leaving it running on the background. This is new in Robot
+ Framework 7.3.
"""
process = self._processes[handle]
- logger.info('Waiting for process to complete.')
- timeout = self._get_timeout(timeout)
- if timeout > 0:
- if not self._process_is_stopped(process, timeout):
- logger.info('Process did not complete in %s.'
- % secs_to_timestr(timeout))
- return self._manage_process_timeout(handle, on_timeout.lower())
+ logger.info("Waiting for process to complete.")
+ timeout = timeout.total_seconds() if timeout else -1
+ if timeout > 0 and not self._process_is_stopped(process, timeout):
+ logger.info(f"Process did not complete in {secs_to_timestr(timeout)}.")
+ return self._manage_process_timeout(handle, on_timeout.lower())
return self._wait(process)
- def _get_timeout(self, timeout):
- if (is_string(timeout) and timeout.upper() == 'NONE') or not timeout:
- return -1
- return timestr_to_secs(timeout)
-
- def _manage_process_timeout(self, handle, on_timeout):
- if on_timeout == 'terminate':
+ def _manage_process_timeout(
+ self,
+ handle: subprocess.Popen,
+ on_timeout: str,
+ ) -> "ProcessResult | None":
+ if on_timeout == "terminate":
return self.terminate_process(handle)
- elif on_timeout == 'kill':
+ if on_timeout == "kill":
return self.terminate_process(handle, kill=True)
- else:
- logger.info('Leaving process intact.')
- return None
+ logger.info("Leaving process intact.")
+ return None
- def _wait(self, process):
+ def _wait(self, process: subprocess.Popen) -> ProcessResult:
result = self._results[process]
- result.rc = process.wait() or 0
+ # Popen.communicate() does not like closed stdin/stdout/stderr PIPEs.
+ # Due to us using a timeout, we only need to care about stdin.
+ # https://github.com/python/cpython/issues/131064
+ if process.stdin and process.stdin.closed:
+ process.stdin = None
+ # Timeout is used with communicate() to support Robot's timeouts.
+ while True:
+ try:
+ result.stdout, result.stderr = process.communicate(timeout=0.1)
+ except subprocess.TimeoutExpired:
+ continue
+ except TimeoutExceeded:
+ logger.info("Timeout exceeded.")
+ self._kill(process)
+ raise
+ else:
+ break
+ result.rc = process.returncode
result.close_streams()
- logger.info('Process completed.')
+ logger.info("Process completed.")
return result
- def terminate_process(self, handle=None, kill=False):
+ def terminate_process(
+ self,
+ handle: Handle = None,
+ kill: bool = False,
+ ) -> ProcessResult:
"""Stops the process gracefully or forcefully.
If ``handle`` is not given, uses the current `active process`.
- By default first tries to stop the process gracefully. If the process
- does not stop in 30 seconds, or ``kill`` argument is given a true value,
- (see `Boolean arguments`) kills the process forcefully. Stops also all
- the child processes of the originally started process.
+ By default, first tries to stop the process gracefully. If the process
+ does not stop in 30 seconds, or the ``kill`` argument is given a true
+ value, kills the process forcefully. Stops also all the child processes
+ of the originally started process.
Waits for the process to stop after terminating it. Returns a `result
object` containing information about the execution similarly as `Wait
For Process`.
On Unix-like machines graceful termination is done using ``TERM (15)``
- signal and killing using ``KILL (9)``. Use `Send Signal To Process`
+ signal and forceful kill using ``KILL (9)``. Use `Send Signal To Process`
instead if you just want to send either of these signals without
waiting for the process to stop.
On Windows graceful termination is done using ``CTRL_BREAK_EVENT``
- event and killing using Win32 API function ``TerminateProcess()``.
+ event and forceful kill using Win32 API function ``TerminateProcess()``.
+ In this case forceful kill only stops the main process, not possible
+ child processes.
Examples:
| ${result} = | Terminate Process | |
| Should Be Equal As Integers | ${result.rc} | -15 | # On Unixes |
| Terminate Process | myproc | kill=true |
-
- Limitations:
- - On Windows forceful kill only stops the main process, not possible
- child processes.
"""
process = self._processes[handle]
- if not hasattr(process, 'terminate'):
- raise RuntimeError('Terminating processes is not supported '
- 'by this Python version.')
- terminator = self._kill if is_truthy(kill) else self._terminate
+ if not hasattr(process, "terminate"):
+ raise RuntimeError(
+ "Terminating processes is not supported by this Python version."
+ )
+ terminator = self._kill if kill else self._terminate
try:
terminator(process)
except OSError:
if not self._process_is_stopped(process, self.KILL_TIMEOUT):
raise
- logger.debug('Ignored OSError because process was stopped.')
+ logger.debug("Ignored OSError because process was stopped.")
return self._wait(process)
- def _kill(self, process):
- logger.info('Forcefully killing process.')
- if hasattr(os, 'killpg'):
+ def _kill(self, process: subprocess.Popen):
+ logger.info("Forcefully killing process.")
+ if hasattr(os, "killpg"):
os.killpg(process.pid, signal_module.SIGKILL)
else:
process.kill()
if not self._process_is_stopped(process, self.KILL_TIMEOUT):
- raise RuntimeError('Failed to kill process.')
+ raise RuntimeError("Failed to kill process.")
- def _terminate(self, process):
- logger.info('Gracefully terminating process.')
+ def _terminate(self, process: subprocess.Popen):
+ logger.info("Gracefully terminating process.")
# Sends signal to the whole process group both on POSIX and on Windows
# if supported by the interpreter.
- if hasattr(os, 'killpg'):
+ if hasattr(os, "killpg"):
os.killpg(process.pid, signal_module.SIGTERM)
- elif hasattr(signal_module, 'CTRL_BREAK_EVENT'):
+ elif hasattr(signal_module, "CTRL_BREAK_EVENT"):
process.send_signal(signal_module.CTRL_BREAK_EVENT)
else:
process.terminate()
if not self._process_is_stopped(process, self.TERMINATE_TIMEOUT):
- logger.info('Graceful termination failed.')
+ logger.info("Graceful termination failed.")
self._kill(process)
- def terminate_all_processes(self, kill=False):
+ def terminate_all_processes(self, kill: bool = False):
"""Terminates all still running processes started by this library.
This keyword can be used in suite teardown or elsewhere to make
sure that all processes are stopped,
- By default tries to terminate processes gracefully, but can be
+ Tries to terminate processes gracefully by default, but can be
configured to forcefully kill them immediately. See `Terminate Process`
that this keyword uses internally for more details.
"""
- for handle in range(1, len(self._processes) + 1):
- if self.is_process_running(handle):
- self.terminate_process(handle, kill=kill)
+ for process in self._processes:
+ if self.is_process_running(process):
+ self.terminate_process(process, kill=kill)
self.__init__()
- def send_signal_to_process(self, signal, handle=None, group=False):
+ def send_signal_to_process(
+ self,
+ signal: "int | str",
+ handle: Handle = None,
+ group: bool = False,
+ ):
"""Sends the given ``signal`` to the specified process.
If ``handle`` is not given, uses the current `active process`.
@@ -628,41 +1032,43 @@ def send_signal_to_process(self, signal, handle=None, group=False):
existing signals on your system, see the Unix man pages related to
signal handling (typically ``man signal`` or ``man 7 signal``).
- By default sends the signal only to the parent process, not to possible
+ By default, sends the signal only to the parent process, not to possible
child processes started by it. Notice that when `running processes in
- shell`, the shell is the parent process and it depends on the system
+ shell`, the shell is the parent process, and it depends on the system
does the shell propagate the signal to the actual started process.
- To send the signal to the whole process group, ``group`` argument can
- be set to any true value (see `Boolean arguments`).
+ To send the signal to the whole process group, give the ``group``
+ argument a true value.
"""
- if os.sep == '\\':
- raise RuntimeError('This keyword does not work on Windows.')
+ if os.sep == "\\":
+ raise RuntimeError("This keyword does not work on Windows.")
process = self._processes[handle]
signum = self._get_signal_number(signal)
- logger.info('Sending signal %s (%d).' % (signal, signum))
- if is_truthy(group) and hasattr(os, 'killpg'):
+ logger.info(f"Sending signal {signal} ({signum}).")
+ if group and hasattr(os, "killpg"):
os.killpg(process.pid, signum)
- elif hasattr(process, 'send_signal'):
+ elif hasattr(process, "send_signal"):
process.send_signal(signum)
else:
- raise RuntimeError('Sending signals is not supported '
- 'by this Python version.')
+ raise RuntimeError(
+ "Sending signals is not supported by this Python version."
+ )
- def _get_signal_number(self, int_or_name):
+ def _get_signal_number(self, int_or_name: "int | str") -> int:
try:
return int(int_or_name)
except ValueError:
return self._convert_signal_name_to_number(int_or_name)
- def _convert_signal_name_to_number(self, name):
+ def _convert_signal_name_to_number(self, name: str) -> int:
try:
- return getattr(signal_module,
- name if name.startswith('SIG') else 'SIG' + name)
+ return getattr(
+ signal_module, name if name.startswith("SIG") else "SIG" + name
+ )
except AttributeError:
- raise RuntimeError("Unsupported signal '%s'." % name)
+ raise RuntimeError(f"Unsupported signal '{name}'.")
- def get_process_id(self, handle=None):
+ def get_process_id(self, handle: Handle = None) -> int:
"""Returns the process ID (pid) of the process as an integer.
If ``handle`` is not given, uses the current `active process`.
@@ -673,7 +1079,7 @@ def get_process_id(self, handle=None):
"""
return self._processes[handle].pid
- def get_process_object(self, handle=None):
+ def get_process_object(self, handle: Handle = None) -> subprocess.Popen:
"""Return the underlying ``subprocess.Popen`` object.
If ``handle`` is not given, uses the current `active process`.
@@ -684,8 +1090,15 @@ def get_process_object(self, handle=None):
"""
return self._processes[handle]
- def get_process_result(self, handle=None, rc=False, stdout=False,
- stderr=False, stdout_path=False, stderr_path=False):
+ def get_process_result(
+ self,
+ handle: Handle = None,
+ rc: bool = False,
+ stdout: bool = False,
+ stderr: bool = False,
+ stdout_path: bool = False,
+ stderr_path: bool = False,
+ ) -> "ProcessResult | int | str | tuple[int | str, ...]":
"""Returns the specified `result object` or some of its attributes.
The given ``handle`` specifies the process whose results should be
@@ -701,8 +1114,6 @@ def get_process_result(self, handle=None, rc=False, stdout=False,
are given any true value, only the specified attributes of the
`result object` are returned. These attributes are always returned
in the same order as arguments are specified in the keyword signature.
- See `Boolean arguments` section for more details about true and false
- values.
Examples:
| Run Process | python | -c | print('Hello, world!') | alias=myproc |
@@ -727,23 +1138,29 @@ def get_process_result(self, handle=None, rc=False, stdout=False,
"""
result = self._results[self._processes[handle]]
if result.rc is None:
- raise RuntimeError('Getting results of unfinished processes '
- 'is not supported.')
- attributes = self._get_result_attributes(result, rc, stdout, stderr,
- stdout_path, stderr_path)
+ raise RuntimeError(
+ "Getting results of unfinished processes is not supported."
+ )
+ attributes = self._get_result_attributes(
+ result, rc, stdout, stderr, stdout_path, stderr_path
+ )
if not attributes:
return result
- elif len(attributes) == 1:
+ if len(attributes) == 1:
return attributes[0]
return attributes
def _get_result_attributes(self, result, *includes):
- attributes = (result.rc, result.stdout, result.stderr,
- result.stdout_path, result.stderr_path)
- includes = (is_truthy(incl) for incl in includes)
+ attributes = (
+ result.rc,
+ result.stdout,
+ result.stderr,
+ result.stdout_path,
+ result.stderr_path,
+ )
return tuple(attr for attr, incl in zip(attributes, includes) if incl)
- def switch_process(self, handle):
+ def switch_process(self, handle: Handle):
"""Makes the specified process the current `active process`.
The handle can be an identifier returned by `Start Process` or
@@ -758,257 +1175,52 @@ def switch_process(self, handle):
"""
self._processes.switch(handle)
- def _process_is_stopped(self, process, timeout):
+ def _process_is_stopped(self, process: subprocess.Popen, timeout: float) -> bool:
stopped = lambda: process.poll() is not None
max_time = time.time() + timeout
while time.time() <= max_time and not stopped():
time.sleep(min(0.1, timeout))
return stopped()
- def split_command_line(self, args, escaping=False):
+ def split_command_line(self, command: str, escaping: bool = False) -> "list[str]":
"""Splits command line string into a list of arguments.
String is split from spaces, but argument surrounded in quotes may
- contain spaces in them. If ``escaping`` is given a true value, then
- backslash is treated as an escape character. It can escape unquoted
- spaces, quotes inside quotes, and so on, but it also requires using
- double backslashes when using Windows paths.
+ contain spaces in them.
+
+ If ``escaping`` is given a true value, then backslash is treated as
+ an escape character. It can escape unquoted spaces, quotes inside
+ quotes, and so on, but it also requires doubling backslashes
+ in Windows paths and elsewhere.
Examples:
| @{cmd} = | Split Command Line | --option "value with spaces" |
| Should Be True | $cmd == ['--option', 'value with spaces'] |
"""
- return cmdline2list(args, escaping=escaping)
+ return cmdline2list(command, escaping=escaping)
- def join_command_line(self, *args):
+ def join_command_line(self, *command: "Sequence[str] | str") -> str:
"""Joins arguments into one command line string.
In resulting command line string arguments are delimited with a space,
arguments containing spaces are surrounded with quotes, and possible
quotes are escaped with a backslash.
- If this keyword is given only one argument and that is a list like
- object, then the values of that list are joined instead.
-
- Example:
- | ${cmd} = | Join Command Line | --option | value with spaces |
- | Should Be Equal | ${cmd} | --option "value with spaces" |
- """
- if len(args) == 1 and is_list_like(args[0]):
- args = args[0]
- return subprocess.list2cmdline(args)
-
-
-class ExecutionResult:
-
- def __init__(self, process, stdout, stderr, stdin=None, rc=None,
- output_encoding=None):
- self._process = process
- self.stdout_path = self._get_path(stdout)
- self.stderr_path = self._get_path(stderr)
- self.rc = rc
- self._output_encoding = output_encoding
- self._stdout = None
- self._stderr = None
- self._custom_streams = [stream for stream in (stdout, stderr, stdin)
- if self._is_custom_stream(stream)]
-
- def _get_path(self, stream):
- return stream.name if self._is_custom_stream(stream) else None
-
- def _is_custom_stream(self, stream):
- return stream not in (subprocess.PIPE, subprocess.STDOUT, None)
-
- @property
- def stdout(self):
- if self._stdout is None:
- self._read_stdout()
- return self._stdout
-
- @property
- def stderr(self):
- if self._stderr is None:
- self._read_stderr()
- return self._stderr
-
- def _read_stdout(self):
- self._stdout = self._read_stream(self.stdout_path, self._process.stdout)
-
- def _read_stderr(self):
- self._stderr = self._read_stream(self.stderr_path, self._process.stderr)
-
- def _read_stream(self, stream_path, stream):
- if stream_path:
- stream = open(stream_path, 'rb')
- elif not self._is_open(stream):
- return ''
- try:
- content = stream.read()
- except IOError:
- content = ''
- finally:
- if stream_path:
- stream.close()
- return self._format_output(content)
-
- def _is_open(self, stream):
- return stream and not stream.closed
-
- def _format_output(self, output):
- output = console_decode(output, self._output_encoding)
- output = output.replace('\r\n', '\n')
- if output.endswith('\n'):
- output = output[:-1]
- return output
-
- def close_streams(self):
- standard_streams = self._get_and_read_standard_streams(self._process)
- for stream in standard_streams + self._custom_streams:
- if self._is_open(stream):
- stream.close()
-
- def _get_and_read_standard_streams(self, process):
- stdin, stdout, stderr = process.stdin, process.stdout, process.stderr
- if stdout:
- self._read_stdout()
- if stderr:
- self._read_stderr()
- return [stdin, stdout, stderr]
-
- def __str__(self):
- return '' % self.rc
-
-
-class ProcessConfiguration:
-
- def __init__(self, cwd=None, shell=False, stdout=None, stderr=None, stdin='PIPE',
- output_encoding='CONSOLE', alias=None, env=None, **rest):
- self.cwd = self._get_cwd(cwd)
- self.shell = is_truthy(shell)
- self.alias = alias
- self.output_encoding = output_encoding
- self.stdout_stream = self._new_stream(stdout)
- self.stderr_stream = self._get_stderr(stderr, stdout, self.stdout_stream)
- self.stdin_stream = self._get_stdin(stdin)
- self.env = self._construct_env(env, rest)
-
- def _get_cwd(self, cwd):
- if cwd:
- return cwd.replace('/', os.sep)
- return abspath('.')
-
- def _new_stream(self, name):
- if name == 'DEVNULL':
- return open(os.devnull, 'w')
- if name:
- path = os.path.normpath(os.path.join(self.cwd, name))
- return open(path, 'w')
- return subprocess.PIPE
-
- def _get_stderr(self, stderr, stdout, stdout_stream):
- if stderr and stderr in ['STDOUT', stdout]:
- if stdout_stream != subprocess.PIPE:
- return stdout_stream
- return subprocess.STDOUT
- return self._new_stream(stderr)
-
- def _get_stdin(self, stdin):
- if not is_string(stdin):
- return stdin
- if stdin.upper() == 'NONE':
- return None
- if stdin == 'PIPE':
- return subprocess.PIPE
- path = os.path.normpath(os.path.join(self.cwd, stdin))
- if os.path.isfile(path):
- return open(path)
- stdin_file = TemporaryFile()
- if is_string(stdin):
- stdin = console_encode(stdin, self.output_encoding, force=True)
- stdin_file.write(stdin)
- stdin_file.seek(0)
- return stdin_file
-
- def _construct_env(self, env, extra):
- env = self._get_initial_env(env, extra)
- if env is None:
- return None
- if WINDOWS:
- env = NormalizedDict(env, spaceless=False)
- self._add_to_env(env, extra)
- if WINDOWS:
- env = dict((key.upper(), env[key]) for key in env)
- return env
-
- def _get_initial_env(self, env, extra):
- if env:
- return dict((system_encode(k), system_encode(env[k])) for k in env)
- if extra:
- return os.environ.copy()
- return None
+ Command to join can be given as individual arguments or as a list.
- def _add_to_env(self, env, extra):
- for key in extra:
- if not key.startswith('env:'):
- raise RuntimeError("Keyword argument '%s' is not supported by "
- "this keyword." % key)
- env[system_encode(key[4:])] = system_encode(extra[key])
+ Giving command as individual arguments:
+ | ${cmd} = | Join Command Line | --option | value with spaces |
+ | Should Be Equal | ${cmd} | --option "value with spaces" |
- def get_command(self, command, arguments):
- command = [system_encode(item) for item in [command] + arguments]
- if not self.shell:
- return command
- if arguments:
- return subprocess.list2cmdline(command)
- return command[0]
-
- @property
- def popen_config(self):
- config = {'stdout': self.stdout_stream,
- 'stderr': self.stderr_stream,
- 'stdin': self.stdin_stream,
- 'shell': self.shell,
- 'cwd': self.cwd,
- 'env': self.env}
- # Close file descriptors regardless the Python version:
- # https://github.com/robotframework/robotframework/issues/2794
- if not WINDOWS:
- config['close_fds'] = True
- self._add_process_group_config(config)
- return config
-
- def _add_process_group_config(self, config):
- if hasattr(os, 'setsid'):
- config['preexec_fn'] = os.setsid
- if hasattr(subprocess, 'CREATE_NEW_PROCESS_GROUP'):
- config['creationflags'] = subprocess.CREATE_NEW_PROCESS_GROUP
-
- @property
- def result_config(self):
- return {'stdout': self.stdout_stream,
- 'stderr': self.stderr_stream,
- 'stdin': self.stdin_stream,
- 'output_encoding': self.output_encoding}
-
- def __str__(self):
- return """\
-cwd: %s
-shell: %s
-stdout: %s
-stderr: %s
-stdin: %s
-alias: %s
-env: %s""" % (self.cwd,
- self.shell,
- self._stream_name(self.stdout_stream),
- self._stream_name(self.stderr_stream),
- self._stream_name(self.stdin_stream),
- self.alias,
- self.env)
-
- def _stream_name(self, stream):
- if hasattr(stream, 'name'):
- return stream.name
- return {subprocess.PIPE: 'PIPE',
- subprocess.STDOUT: 'STDOUT',
- None: 'None'}.get(stream, stream)
+ Giving command as a list:
+ | VAR | @{arguments} | --option | value with spaces |
+ | ${cmd} = | Join Command Line | ${arguments} |
+ | Should Be Equal | ${cmd} | --option "value with spaces" |
+ """
+ parts = []
+ for part in command:
+ if isinstance(part, str):
+ parts.append(part)
+ else:
+ parts.extend(part)
+ return subprocess.list2cmdline(parts)
diff --git a/src/robot/libraries/Remote.py b/src/robot/libraries/Remote.py
index 945b6e526b6..ea2bb4c7a7e 100644
--- a/src/robot/libraries/Remote.py
+++ b/src/robot/libraries/Remote.py
@@ -13,24 +13,23 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from contextlib import contextmanager
-
import http.client
import re
import socket
import sys
import xmlrpc.client
+from contextlib import contextmanager
+from datetime import date, datetime, timedelta
from xml.parsers.expat import ExpatError
from robot.errors import RemoteError
-from robot.utils import (DotDict, is_bytes, is_dict_like, is_list_like, is_number,
- is_string, safe_str, timestr_to_secs)
+from robot.utils import DotDict, is_dict_like, is_list_like, safe_str, timestr_to_secs
class Remote:
- ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
+ ROBOT_LIBRARY_SCOPE = "TEST SUITE"
- def __init__(self, uri='http://127.0.0.1:8270', timeout=None):
+ def __init__(self, uri="http://127.0.0.1:8270", timeout=None):
"""Connects to a remote server at ``uri``.
Optional ``timeout`` can be used to specify a timeout to wait when
@@ -43,8 +42,8 @@ def __init__(self, uri='http://127.0.0.1:8270', timeout=None):
a timeout that is shorter than keyword execution time will interrupt
the keyword.
"""
- if '://' not in uri:
- uri = 'http://' + uri
+ if "://" not in uri:
+ uri = "http://" + uri
if timeout:
timeout = timestr_to_secs(timeout)
self._uri = uri
@@ -54,13 +53,17 @@ def __init__(self, uri='http://127.0.0.1:8270', timeout=None):
def get_keyword_names(self):
if self._is_lib_info_available():
- return [name for name in self._lib_info
- if not (name[:2] == '__' and name[-2:] == '__')]
+ return [
+ name
+ for name in self._lib_info
+ if not (name[:2] == "__" and name[-2:] == "__")
+ ]
try:
return self._client.get_keyword_names()
except TypeError as error:
- raise RuntimeError('Connecting remote server at %s failed: %s'
- % (self._uri, error))
+ raise RuntimeError(
+ f"Connecting remote server at {self._uri} failed: {error}"
+ )
def _is_lib_info_available(self):
if not self._lib_info_initialized:
@@ -72,8 +75,12 @@ def _is_lib_info_available(self):
return self._lib_info is not None
def get_keyword_arguments(self, name):
- return self._get_kw_info(name, 'args', self._client.get_keyword_arguments,
- default=['*args'])
+ return self._get_kw_info(
+ name,
+ "args",
+ self._client.get_keyword_arguments,
+ default=["*args"],
+ )
def _get_kw_info(self, kw, info, getter, default=None):
if self._is_lib_info_available():
@@ -84,14 +91,26 @@ def _get_kw_info(self, kw, info, getter, default=None):
return default
def get_keyword_types(self, name):
- return self._get_kw_info(name, 'types', self._client.get_keyword_types,
- default=())
+ return self._get_kw_info(
+ name,
+ "types",
+ self._client.get_keyword_types,
+ default=(),
+ )
def get_keyword_tags(self, name):
- return self._get_kw_info(name, 'tags', self._client.get_keyword_tags)
+ return self._get_kw_info(
+ name,
+ "tags",
+ self._client.get_keyword_tags,
+ )
def get_keyword_documentation(self, name):
- return self._get_kw_info(name, 'doc', self._client.get_keyword_documentation)
+ return self._get_kw_info(
+ name,
+ "doc",
+ self._client.get_keyword_documentation,
+ )
def run_keyword(self, name, args, kwargs):
coercer = ArgumentCoercer()
@@ -99,55 +118,60 @@ def run_keyword(self, name, args, kwargs):
kwargs = coercer.coerce(kwargs)
result = RemoteResult(self._client.run_keyword(name, args, kwargs))
sys.stdout.write(result.output)
- if result.status != 'PASS':
- raise RemoteError(result.error, result.traceback, result.fatal,
- result.continuable)
+ if result.status != "PASS":
+ raise RemoteError(
+ result.error,
+ result.traceback,
+ result.fatal,
+ result.continuable,
+ )
return result.return_
class ArgumentCoercer:
- binary = re.compile('[\x00-\x08\x0B\x0C\x0E-\x1F]')
- non_ascii = re.compile('[\x80-\xff]')
+ binary = re.compile("[\x00-\x08\x0b\x0c\x0e-\x1f]")
def coerce(self, argument):
- for handles, handler in [(is_string, self._handle_string),
- (is_bytes, self._handle_bytes),
- (is_number, self._pass_through),
- (is_dict_like, self._coerce_dict),
- (is_list_like, self._coerce_list),
- (lambda arg: True, self._to_string)]:
+ for handles, handler in [
+ ((str,), self._handle_string),
+ ((int, float, bytes, bytearray, datetime), self._pass_through),
+ ((date,), self._handle_date),
+ ((timedelta,), self._handle_timedelta),
+ (is_dict_like, self._coerce_dict),
+ (is_list_like, self._coerce_list),
+ ]:
+ if isinstance(handles, tuple):
+ handles = lambda arg, types=handles: isinstance(arg, types)
if handles(argument):
return handler(argument)
+ return self._to_string(argument)
def _handle_string(self, arg):
- if self._string_contains_binary(arg):
+ if self.binary.search(arg):
return self._handle_binary_in_string(arg)
return arg
- def _string_contains_binary(self, arg):
- return (self.binary.search(arg) or
- is_bytes(arg) and self.non_ascii.search(arg))
-
def _handle_binary_in_string(self, arg):
try:
- if not is_bytes(arg):
- # Map Unicode code points to bytes directly
- arg = arg.encode('latin-1')
+ # Map Unicode code points to bytes directly
+ return arg.encode("latin-1")
except UnicodeError:
- raise ValueError('Cannot represent %r as binary.' % arg)
- return xmlrpc.client.Binary(arg)
-
- def _handle_bytes(self, arg):
- return xmlrpc.client.Binary(arg)
+ raise ValueError(f"Cannot represent {arg!r} as binary.")
def _pass_through(self, arg):
return arg
+ def _handle_date(self, arg):
+ return datetime(arg.year, arg.month, arg.day)
+
+ def _handle_timedelta(self, arg):
+ return arg.total_seconds()
+
def _coerce_list(self, arg):
return [self.coerce(item) for item in arg]
def _coerce_dict(self, arg):
- return dict((self._to_key(key), self.coerce(arg[key])) for key in arg)
+ return {self._to_key(key): self.coerce(arg[key]) for key in arg}
def _to_key(self, item):
item = self._to_string(item)
@@ -155,34 +179,32 @@ def _to_key(self, item):
return item
def _to_string(self, item):
- item = safe_str(item) if item is not None else ''
+ item = safe_str(item) if item is not None else ""
return self._handle_string(item)
def _validate_key(self, key):
- if isinstance(key, xmlrpc.client.Binary):
- raise ValueError('Dictionary keys cannot be binary. Got %r.' % (key.data,))
+ if isinstance(key, bytes):
+ raise ValueError(f"Dictionary keys cannot be binary. Got {key!r}.")
class RemoteResult:
def __init__(self, result):
- if not (is_dict_like(result) and 'status' in result):
- raise RuntimeError('Invalid remote result dictionary: %s' % result)
- self.status = result['status']
- self.output = safe_str(self._get(result, 'output'))
- self.return_ = self._get(result, 'return')
- self.error = safe_str(self._get(result, 'error'))
- self.traceback = safe_str(self._get(result, 'traceback'))
- self.fatal = bool(self._get(result, 'fatal', False))
- self.continuable = bool(self._get(result, 'continuable', False))
-
- def _get(self, result, key, default=''):
+ if not (is_dict_like(result) and "status" in result):
+ raise RuntimeError(f"Invalid remote result dictionary: {result!r}")
+ self.status = result["status"]
+ self.output = safe_str(self._get(result, "output"))
+ self.return_ = self._get(result, "return")
+ self.error = safe_str(self._get(result, "error"))
+ self.traceback = safe_str(self._get(result, "traceback"))
+ self.fatal = bool(self._get(result, "fatal", False))
+ self.continuable = bool(self._get(result, "continuable", False))
+
+ def _get(self, result, key, default=""):
value = result.get(key, default)
return self._convert(value)
def _convert(self, value):
- if isinstance(value, xmlrpc.client.Binary):
- return bytes(value.data)
if is_dict_like(value):
return DotDict((k, self._convert(v)) for k, v in value.items())
if is_list_like(value):
@@ -199,18 +221,22 @@ def __init__(self, uri, timeout=None):
@property
@contextmanager
def _server(self):
- if self.uri.startswith('https://'):
+ if self.uri.startswith("https://"):
transport = TimeoutHTTPSTransport(timeout=self.timeout)
else:
transport = TimeoutHTTPTransport(timeout=self.timeout)
- server = xmlrpc.client.ServerProxy(self.uri, encoding='UTF-8',
- transport=transport)
+ server = xmlrpc.client.ServerProxy(
+ self.uri,
+ encoding="UTF-8",
+ use_builtin_types=True,
+ transport=transport,
+ )
try:
yield server
except (socket.error, xmlrpc.client.Error) as err:
raise TypeError(err)
finally:
- server('close')()
+ server("close")()
def get_library_information(self):
with self._server as server:
@@ -244,26 +270,24 @@ def run_keyword(self, name, args, kwargs):
except xmlrpc.client.Fault as err:
message = err.faultString
except socket.error as err:
- message = 'Connection to remote server broken: %s' % err
+ message = f"Connection to remote server broken: {err}"
except ExpatError as err:
- message = ('Processing XML-RPC return value failed. '
- 'Most often this happens when the return value '
- 'contains characters that are not valid in XML. '
- 'Original error was: ExpatError: %s' % err)
+ message = (
+ f"Processing XML-RPC return value failed. Most often this happens "
+ f"when the return value contains characters that are not valid in "
+ f"XML. Original error was: ExpatError: {err}"
+ )
raise RuntimeError(message)
# Custom XML-RPC timeouts based on
# http://stackoverflow.com/questions/2425799/timeout-for-xmlrpclib-client-requests
-
class TimeoutHTTPTransport(xmlrpc.client.Transport):
_connection_class = http.client.HTTPConnection
- def __init__(self, use_datetime=0, timeout=None):
- xmlrpc.client.Transport.__init__(self, use_datetime)
- if not timeout:
- timeout = socket._GLOBAL_DEFAULT_TIMEOUT
- self.timeout = timeout
+ def __init__(self, timeout=None):
+ super().__init__(use_builtin_types=True)
+ self.timeout = timeout or socket._GLOBAL_DEFAULT_TIMEOUT
def make_connection(self, host):
if self._connection and host == self._connection[0]:
diff --git a/src/robot/libraries/Reserved.py b/src/robot/libraries/Reserved.py
deleted file mode 100644
index d619b387367..00000000000
--- a/src/robot/libraries/Reserved.py
+++ /dev/null
@@ -1,48 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from robot.running import RUN_KW_REGISTER
-
-
-RESERVED_KEYWORDS = ['for', 'while', 'break', 'continue', 'end',
- 'if', 'else', 'elif', 'else if', 'return']
-
-
-class Reserved:
- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
-
- def __init__(self):
- for kw in RESERVED_KEYWORDS:
- self._add_reserved(kw)
-
- def _add_reserved(self, kw):
- RUN_KW_REGISTER.register_run_keyword('Reserved', kw,
- args_to_process=0,
- deprecation_warning=False)
- self.__dict__[kw] = lambda *args, **kwargs: self._run_reserved(kw)
-
- def _run_reserved(self, kw):
- error = "'%s' is a reserved keyword." % kw.title()
- if kw in ('for', 'end', 'if', 'else', 'else if'):
- error += " It must be an upper case '%s'" % kw.upper()
- if kw in ('else', 'else if'):
- error += " and follow an opening 'IF'"
- if kw == 'end':
- error += " when used as a marker to close a block."
- else:
- error += " when used as a marker."
- if kw == 'elif':
- error += " The marker to use with 'IF' is 'ELSE IF'."
- raise Exception(error)
diff --git a/src/robot/libraries/Screenshot.py b/src/robot/libraries/Screenshot.py
index c3f87edd01b..b98b7a819a2 100644
--- a/src/robot/libraries/Screenshot.py
+++ b/src/robot/libraries/Screenshot.py
@@ -16,6 +16,7 @@
import os
import subprocess
import sys
+from pathlib import Path
try:
import wx
@@ -32,8 +33,8 @@
from robot.api import logger
from robot.libraries.BuiltIn import BuiltIn
-from robot.version import get_version
from robot.utils import abspath, get_error_message, get_link_path
+from robot.version import get_version
class Screenshot:
@@ -83,10 +84,14 @@ class Screenshot:
quality, using GIFs and video capturing.
"""
- ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
+ ROBOT_LIBRARY_SCOPE = "TEST SUITE"
ROBOT_LIBRARY_VERSION = get_version()
- def __init__(self, screenshot_directory=None, screenshot_module=None):
+ def __init__(
+ self,
+ screenshot_directory: "Path | None" = None,
+ screenshot_module: "str | None" = None,
+ ):
"""Configure where screenshots are saved.
If ``screenshot_directory`` is not given, screenshots are saved into
@@ -107,24 +112,22 @@ def __init__(self, screenshot_directory=None, screenshot_module=None):
self._given_screenshot_dir = self._norm_path(screenshot_directory)
self._screenshot_taker = ScreenshotTaker(screenshot_module)
- def _norm_path(self, path):
- if not path:
- return path
- return os.path.normpath(path.replace('/', os.sep))
+ def _norm_path(self, path: "Path | str | None") -> "str | None":
+ return os.path.normpath(path) if path else None
@property
- def _screenshot_dir(self):
+ def _screenshot_dir(self) -> str:
return self._given_screenshot_dir or self._log_dir
@property
- def _log_dir(self):
+ def _log_dir(self) -> str:
variables = BuiltIn().get_variables()
- outdir = variables['${OUTPUTDIR}']
- log = variables['${LOGFILE}']
- log = os.path.dirname(log) if log != 'NONE' else '.'
- return self._norm_path(os.path.join(outdir, log))
+ outdir = variables["${OUTPUTDIR}"]
+ log = variables["${LOGFILE}"]
+ log = os.path.dirname(log) if log != "NONE" else "."
+ return os.path.normpath(os.path.join(outdir, log))
- def set_screenshot_directory(self, path):
+ def set_screenshot_directory(self, path: Path) -> str:
"""Sets the directory where screenshots are saved.
It is possible to use ``/`` as a path separator in all operating
@@ -134,12 +137,12 @@ def set_screenshot_directory(self, path):
"""
path = self._norm_path(path)
if not os.path.isdir(path):
- raise RuntimeError("Directory '%s' does not exist." % path)
+ raise RuntimeError(f"Directory '{path}' does not exist.")
old = self._screenshot_dir
self._given_screenshot_dir = path
return old
- def take_screenshot(self, name="screenshot", width="800px"):
+ def take_screenshot(self, name: str = "screenshot", width: str = "800px") -> str:
"""Takes a screenshot in JPEG format and embeds it into the log file.
Name of the file where the screenshot is stored is derived from the
@@ -168,7 +171,7 @@ def take_screenshot(self, name="screenshot", width="800px"):
self._embed_screenshot(path, width)
return path
- def take_screenshot_without_embedding(self, name="screenshot"):
+ def take_screenshot_without_embedding(self, name: str = "screenshot") -> str:
"""Takes a screenshot and links it from the log file.
This keyword is otherwise identical to `Take Screenshot` but the saved
@@ -179,133 +182,147 @@ def take_screenshot_without_embedding(self, name="screenshot"):
self._link_screenshot(path)
return path
- def _save_screenshot(self, basename, directory=None):
- path = self._get_screenshot_path(basename, directory)
+ def _save_screenshot(self, name):
+ path = self._get_screenshot_path(name.replace("/", os.sep))
return self._screenshot_to_file(path)
def _screenshot_to_file(self, path):
path = self._validate_screenshot_path(path)
- logger.debug('Using %s module/tool for taking screenshot.'
- % self._screenshot_taker.module)
+ module = self._screenshot_taker.module
+ logger.debug(f"Using {module} module/tool for taking screenshot.")
try:
self._screenshot_taker(path)
- except:
- logger.warn('Taking screenshot failed: %s\n'
- 'Make sure tests are run with a physical or virtual '
- 'display.' % get_error_message())
+ except Exception:
+ logger.warn(
+ f"Taking screenshot failed: {get_error_message()}\n"
+ f"Make sure tests are run with a physical or virtual display."
+ )
return path
def _validate_screenshot_path(self, path):
path = abspath(self._norm_path(path))
- if not os.path.exists(os.path.dirname(path)):
- raise RuntimeError("Directory '%s' where to save the screenshot "
- "does not exist" % os.path.dirname(path))
+ dire = os.path.dirname(path)
+ if not os.path.exists(dire):
+ raise RuntimeError(
+ f"Directory '{dire}' where to save the screenshot does not exist."
+ )
return path
- def _get_screenshot_path(self, basename, directory):
- directory = self._norm_path(directory) if directory else self._screenshot_dir
- if basename.lower().endswith(('.jpg', '.jpeg')):
- return os.path.join(directory, basename)
+ def _get_screenshot_path(self, basename):
+ if basename.lower().endswith((".jpg", ".jpeg")):
+ return os.path.join(self._screenshot_dir, basename)
index = 0
while True:
index += 1
- path = os.path.join(directory, "%s_%d.jpg" % (basename, index))
+ path = os.path.join(self._screenshot_dir, f"{basename}_{index}.jpg")
if not os.path.exists(path):
return path
def _embed_screenshot(self, path, width):
link = get_link_path(path, self._log_dir)
- logger.info(''
- % (link, link, width), html=True)
+ logger.info(
+ f'',
+ html=True,
+ )
def _link_screenshot(self, path):
link = get_link_path(path, self._log_dir)
- logger.info("Screenshot saved to '%s'."
- % (link, path), html=True)
+ logger.info(
+ f"Screenshot saved to '{path}'.",
+ html=True,
+ )
class ScreenshotTaker:
def __init__(self, module_name=None):
self._screenshot = self._get_screenshot_taker(module_name)
- self.module = self._screenshot.__name__.split('_')[1]
+ self.module = self._screenshot.__name__.split("_")[1]
self._wx_app_reference = None
def __call__(self, path):
self._screenshot(path)
def __bool__(self):
- return self.module != 'no'
+ return self.module != "no"
def test(self, path=None):
if not self:
print("Cannot take screenshots.")
return False
- print("Using '%s' to take screenshot." % self.module)
+ print(f"Using '{self.module}' to take screenshot.")
if not path:
print("Not taking test screenshot.")
return True
- print("Taking test screenshot to '%s'." % path)
+ print(f"Taking test screenshot to '{path}'.")
try:
self(path)
- except:
- print("Failed: %s" % get_error_message())
+ except Exception:
+ print(f"Failed: {get_error_message()}")
return False
else:
print("Success!")
return True
def _get_screenshot_taker(self, module_name=None):
- if sys.platform == 'darwin':
+ if sys.platform == "darwin":
return self._osx_screenshot
if module_name:
return self._get_named_screenshot_taker(module_name.lower())
return self._get_default_screenshot_taker()
def _get_named_screenshot_taker(self, name):
- screenshot_takers = {'wxpython': (wx, self._wx_screenshot),
- 'pygtk': (gdk, self._gtk_screenshot),
- 'pil': (ImageGrab, self._pil_screenshot),
- 'scrot': (self._scrot, self._scrot_screenshot)}
+ screenshot_takers = {
+ "wxpython": (wx, self._wx_screenshot),
+ "pygtk": (gdk, self._gtk_screenshot),
+ "pil": (ImageGrab, self._pil_screenshot),
+ "scrot": (self._scrot, self._scrot_screenshot),
+ }
if name not in screenshot_takers:
- raise RuntimeError("Invalid screenshot module or tool '%s'." % name)
+ raise RuntimeError(f"Invalid screenshot module or tool '{name}'.")
supported, screenshot_taker = screenshot_takers[name]
if not supported:
- raise RuntimeError("Screenshot module or tool '%s' not installed."
- % name)
+ raise RuntimeError(f"Screenshot module or tool '{name}' not installed.")
return screenshot_taker
def _get_default_screenshot_taker(self):
- for module, screenshot_taker in [(wx, self._wx_screenshot),
- (gdk, self._gtk_screenshot),
- (ImageGrab, self._pil_screenshot),
- (self._scrot, self._scrot_screenshot),
- (True, self._no_screenshot)]:
+ for module, screenshot_taker in [
+ (wx, self._wx_screenshot),
+ (gdk, self._gtk_screenshot),
+ (ImageGrab, self._pil_screenshot),
+ (self._scrot, self._scrot_screenshot),
+ (True, self._no_screenshot),
+ ]:
if module:
return screenshot_taker
def _osx_screenshot(self, path):
- if self._call('screencapture', '-t', 'jpg', path) != 0:
+ if self._call("screencapture", "-t", "jpg", path) != 0:
raise RuntimeError("Using 'screencapture' failed.")
def _call(self, *command):
try:
- return subprocess.call(command, stdout=subprocess.PIPE,
- stderr=subprocess.STDOUT)
+ return subprocess.call(
+ command,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.STDOUT,
+ )
except OSError:
return -1
@property
def _scrot(self):
- return os.sep == '/' and self._call('scrot', '--version') == 0
+ return os.sep == "/" and self._call("scrot", "--version") == 0
def _scrot_screenshot(self, path):
- if not path.endswith(('.jpg', '.jpeg')):
- raise RuntimeError("Scrot requires extension to be '.jpg' or "
- "'.jpeg', got '%s'." % os.path.splitext(path)[1])
+ if not path.endswith((".jpg", ".jpeg")):
+ ext = os.path.splitext(path)[1]
+ raise RuntimeError(
+ f"Scrot requires extension to be '.jpg' or '.jpeg', got '{ext}'."
+ )
if os.path.exists(path):
os.remove(path)
- if self._call('scrot', '--silent', path) != 0:
+ if self._call("scrot", "--silent", path) != 0:
raise RuntimeError("Using 'scrot' failed.")
def _wx_screenshot(self, path):
@@ -313,7 +330,7 @@ def _wx_screenshot(self, path):
self._wx_app_reference = wx.App(False)
context = wx.ScreenDC()
width, height = context.GetSize()
- if wx.__version__ >= '4':
+ if wx.__version__ >= "4":
bitmap = wx.Bitmap(width, height, -1)
else:
bitmap = wx.EmptyBitmap(width, height, -1)
@@ -326,27 +343,30 @@ def _wx_screenshot(self, path):
def _gtk_screenshot(self, path):
window = gdk.get_default_root_window()
if not window:
- raise RuntimeError('Taking screenshot failed.')
+ raise RuntimeError("Taking screenshot failed.")
width, height = window.get_size()
pb = gdk.Pixbuf(gdk.COLORSPACE_RGB, False, 8, width, height)
- pb = pb.get_from_drawable(window, window.get_colormap(),
- 0, 0, 0, 0, width, height)
+ pb = pb.get_from_drawable(
+ window, window.get_colormap(), 0, 0, 0, 0, width, height
+ )
if not pb:
- raise RuntimeError('Taking screenshot failed.')
- pb.save(path, 'jpeg')
+ raise RuntimeError("Taking screenshot failed.")
+ pb.save(path, "jpeg")
def _pil_screenshot(self, path):
- ImageGrab.grab().save(path, 'JPEG')
+ ImageGrab.grab().save(path, "JPEG")
def _no_screenshot(self, path):
- raise RuntimeError('Taking screenshots is not supported on this platform '
- 'by default. See library documentation for details.')
+ raise RuntimeError(
+ "Taking screenshots is not supported on this platform "
+ "by default. See library documentation for details."
+ )
if __name__ == "__main__":
if len(sys.argv) not in [2, 3]:
- sys.exit("Usage: %s |test [wxpython|pygtk|pil|scrot]"
- % os.path.basename(sys.argv[0]))
- path = sys.argv[1] if sys.argv[1] != 'test' else None
+ prog = os.path.basename(sys.argv[0])
+ sys.exit(f"Usage: {prog} |test [wxpython|pygtk|pil|scrot]")
+ path = sys.argv[1] if sys.argv[1] != "test" else None
module = sys.argv[2] if len(sys.argv) > 2 else None
ScreenshotTaker(module).test(path)
diff --git a/src/robot/libraries/String.py b/src/robot/libraries/String.py
index 79be6ffcd13..5ade0f2a5e1 100644
--- a/src/robot/libraries/String.py
+++ b/src/robot/libraries/String.py
@@ -18,13 +18,23 @@
from fnmatch import fnmatchcase
from random import randint
from string import ascii_lowercase, ascii_uppercase, digits
-
+from typing import Callable, Literal
from robot.api import logger
-from robot.api.deco import keyword
-from robot.utils import FileReader, is_bytes, is_string, is_truthy, safe_str, type_name
+from robot.utils import FileReader, parse_re_flags, plural_or_not as s, type_name
from robot.version import get_version
+from .normalizer import Normalizer
+
+MARKERS = {
+ "[LOWER]": ascii_lowercase,
+ "[UPPER]": ascii_uppercase,
+ "[LETTERS]": ascii_lowercase + ascii_uppercase,
+ "[NUMBERS]": digits,
+ "[ARABIC]": "".join(chr(c) for c in range(0x0600, 0x0700)),
+ "[POLISH]": ascii_lowercase + ascii_uppercase + "ąćęłńóśźżĄĆĘÅŃÓŚŹŻ",
+}
+
class String:
"""A library for string manipulation and verification.
@@ -33,9 +43,12 @@ class String:
strings (e.g. `Replace String Using Regexp`, `Split To Lines`) and
verifying their contents (e.g. `Should Be String`).
- Following keywords from ``BuiltIn`` library can also be used with strings:
+ In addition to strings, most of the keywords work also with bytes.
+ Bytes support was heavily enhanced in Robot Framework 7.4.
+
+ Following keywords from ``BuiltIn`` library can also be used with strings
+ and bytes:
- - `Catenate`
- `Get Length`
- `Length Should Be`
- `Should (Not) Be Empty`
@@ -47,10 +60,11 @@ class String:
- `Convert To String`
- `Convert To Bytes`
"""
- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+ ROBOT_LIBRARY_SCOPE = "GLOBAL"
ROBOT_LIBRARY_VERSION = get_version()
- def convert_to_lower_case(self, string):
+ def convert_to_lower_case(self, string: "str | bytes") -> "str | bytes":
"""Converts string to lower case.
Uses Python's standard
@@ -62,10 +76,12 @@ def convert_to_lower_case(self, string):
| ${str2} = | Convert To Lower Case | 1A2c3D |
| Should Be Equal | ${str1} | abc |
| Should Be Equal | ${str2} | 1a2c3d |
+
+ If this keyword is used with bytes, only ASCII characters are lower cased.
"""
return string.lower()
- def convert_to_upper_case(self, string):
+ def convert_to_upper_case(self, string: "str | bytes") -> "str | bytes":
"""Converts string to upper case.
Uses Python's standard
@@ -77,11 +93,16 @@ def convert_to_upper_case(self, string):
| ${str2} = | Convert To Upper Case | 1a2C3d |
| Should Be Equal | ${str1} | ABC |
| Should Be Equal | ${str2} | 1A2C3D |
+
+ If this keyword is used with bytes, only ASCII characters are upper cased.
"""
return string.upper()
- @keyword(types=None)
- def convert_to_title_case(self, string, exclude=None):
+ def convert_to_title_case(
+ self,
+ string: "str | bytes",
+ exclude: "str | bytes | list[str | bytes] | None" = None,
+ ) -> "str | bytes":
"""Converts string to title case.
Uses the following algorithm:
@@ -119,29 +140,45 @@ def convert_to_title_case(self, string, exclude=None):
apostrophes. It would, for example, convert "it's an OK iPhone"
to "It'S An Ok Iphone".
- New in Robot Framework 3.2.
+ If this keyword is used with bytes, only ASCII characters are title cased.
+ Bytes support is new in Robot Framework 7.4.
"""
- if not is_string(string):
- raise TypeError('This keyword works only with Unicode strings.')
- if is_string(exclude):
- exclude = [e.strip() for e in exclude.split(',')]
+ if isinstance(exclude, str):
+ exclude = [e.strip() for e in exclude.split(",")]
+ elif isinstance(exclude, bytes):
+ exclude = [e.strip() for e in exclude.split(b",")]
elif not exclude:
exclude = []
- exclude = [re.compile('^%s$' % e) for e in exclude]
+ if isinstance(string, bytes):
+ exclude = [
+ e.encode("latin-1") if isinstance(e, str) else e for e in exclude
+ ]
+ split, join = rb"(\s+)", b""
+ else:
+ split, join = r"(\s+)", ""
+ exclude = [re.compile(e) for e in exclude]
def title(word):
- if any(e.match(word) for e in exclude) or not word.islower():
+ if any(e.fullmatch(word) for e in exclude) or not word.islower():
return word
- for index, char in enumerate(word):
+ for i, char in enumerate(word):
+ if isinstance(char, int): # iterating bytes
+ char = bytes([char])
if char.isalpha():
- return word[:index] + word[index].title() + word[index+1:]
+ j = i + 1
+ return word[:i] + word[i:j].title() + word[j:]
return word
- tokens = re.split(r'(\s+)', string, flags=re.UNICODE)
- return ''.join(title(token) for token in tokens)
+ tokens = re.split(split, string)
+ return join.join(title(t) if i % 2 == 0 else t for i, t in enumerate(tokens))
- def encode_string_to_bytes(self, string, encoding, errors='strict'):
- """Encodes the given Unicode ``string`` to bytes using the given ``encoding``.
+ def encode_string_to_bytes(
+ self,
+ string: str,
+ encoding: str,
+ errors: str = "strict",
+ ) -> bytes:
+ """Encodes the given ``string`` to bytes using the given ``encoding``.
``errors`` argument controls what to do if encoding some characters fails.
All values accepted by ``encode`` method in Python are valid, but in
@@ -158,13 +195,18 @@ def encode_string_to_bytes(self, string, encoding, errors='strict'):
Use `Convert To Bytes` in ``BuiltIn`` if you want to create bytes based
on character or integer sequences. Use `Decode Bytes To String` if you
- need to convert byte strings to Unicode strings and `Convert To String`
- in ``BuiltIn`` if you need to convert arbitrary objects to Unicode.
+ need to convert bytes to strings and `Convert To String`
+ in ``BuiltIn`` if you need to convert arbitrary objects to strings.
"""
return bytes(string.encode(encoding, errors))
- def decode_bytes_to_string(self, bytes, encoding, errors='strict'):
- """Decodes the given ``bytes`` to a Unicode string using the given ``encoding``.
+ def decode_bytes_to_string(
+ self,
+ bytes: bytes,
+ encoding: str,
+ errors: str = "strict",
+ ) -> str:
+ """Decodes the given ``bytes`` to a string using the given ``encoding``.
``errors`` argument controls what to do if decoding some bytes fails.
All values accepted by ``decode`` method in Python are valid, but in
@@ -179,15 +221,19 @@ def decode_bytes_to_string(self, bytes, encoding, errors='strict'):
| ${string} = | Decode Bytes To String | ${bytes} | UTF-8 |
| ${string} = | Decode Bytes To String | ${bytes} | ASCII | errors=ignore |
- Use `Encode String To Bytes` if you need to convert Unicode strings to
- byte strings, and `Convert To String` in ``BuiltIn`` if you need to
- convert arbitrary objects to Unicode strings.
+ Use `Encode String To Bytes` if you need to convert strings to bytes,
+ and `Convert To String` in ``BuiltIn`` if you need to
+ convert arbitrary objects to strings.
"""
- if is_string(bytes):
- raise TypeError('Cannot decode strings.')
return bytes.decode(encoding, errors)
- def format_string(self, template, *positional, **named):
+ def format_string(
+ self,
+ template: "str | bytes",
+ /,
+ *positional: object,
+ **named: object,
+ ) -> "str | bytes":
"""Formats a ``template`` using the given ``positional`` and ``named`` arguments.
The template can be either be a string or an absolute path to
@@ -209,23 +255,51 @@ def format_string(self, template, *positional, **named):
| ${yy} = | Format String | {0:{width}{base}} | ${42} | base=X | width=10 |
| ${zz} = | Format String | ${CURDIR}/template.txt | positional | named=value |
- New in Robot Framework 3.1.
+ Prior to Robot Framework 7.1, possible equal signs in the template string
+ needed to be escaped with a backslash like ``x\\={}`.
+
+ Support for bytes is new in Robot Framework 7.4.
"""
if os.path.isabs(template) and os.path.isfile(template):
- template = template.replace('/', os.sep)
- logger.info('Reading template from file %s.'
- % (template, template), html=True)
+ template = template.replace("/", os.sep)
+ logger.info(
+ f'Reading template from file {template}.',
+ html=True,
+ )
with FileReader(template) as reader:
template = reader.read()
- return template.format(*positional, **named)
+ if isinstance(template, bytes):
+ template = self._bytes_to_string(template)
+ positional = [self._bytes_to_string(p) for p in positional]
+ named = {n: self._bytes_to_string(named[n]) for n in named}
+ return_bytes = True
+ else:
+ return_bytes = False
+ result = template.format(*positional, **named)
+ if return_bytes:
+ return self._ensure_bytes(result)
+ return result
+
+ def _bytes_to_string(self, value: object) -> object:
+ return value.decode("latin-1") if isinstance(value, bytes) else value
+
+ def _ensure_bytes(self, value: "str | bytes | None") -> "bytes | None":
+ if isinstance(value, bytes) or value is None:
+ return value
+ return value.encode("latin-1")
- def get_line_count(self, string):
+ def get_line_count(self, string: "str | bytes") -> int:
"""Returns and logs the number of lines in the given string."""
count = len(string.splitlines())
- logger.info('%d lines' % count)
+ logger.info(f"{count} lines.")
return count
- def split_to_lines(self, string, start=0, end=None):
+ def split_to_lines(
+ self,
+ string: "str | bytes",
+ start: "int | Literal[''] | None" = 0,
+ end: "int | Literal[''] | None" = None,
+ ) -> "list[str] | list[bytes]":
"""Splits the given string to lines.
It is possible to get only a selection of lines from ``start``
@@ -237,25 +311,25 @@ def split_to_lines(self, string, start=0, end=None):
returned lines is automatically logged.
Examples:
- | @{lines} = | Split To Lines | ${manylines} | | |
- | @{ignore first} = | Split To Lines | ${manylines} | 1 | |
- | @{ignore last} = | Split To Lines | ${manylines} | | -1 |
- | @{5th to 10th} = | Split To Lines | ${manylines} | 4 | 10 |
- | @{first two} = | Split To Lines | ${manylines} | | 1 |
- | @{last two} = | Split To Lines | ${manylines} | -2 | |
+ | @{lines} = | Split To Lines | ${manylines} | |
+ | @{ignore first} = | Split To Lines | ${manylines} | 1 |
+ | @{ignore last} = | Split To Lines | ${manylines} | end=-1 |
+ | @{5th to 10th} = | Split To Lines | ${manylines} | 4 | 10 |
+ | @{first two} = | Split To Lines | ${manylines} | end=1 |
+ | @{last two} = | Split To Lines | ${manylines} | -2 |
Use `Get Line` if you only need to get a single line.
"""
- start = self._convert_to_index(start, 'start')
- end = self._convert_to_index(end, 'end')
+ start = self._deprecate_empty_string("start", start, 0)
+ end = self._deprecate_empty_string("end", end, 0)
lines = string.splitlines()[start:end]
- logger.info('%d lines returned' % len(lines))
+ logger.info(f"{len(lines)} line{s(lines)} returned.")
return lines
- def get_line(self, string, line_number):
+ def get_line(self, string: "str | bytes", line_number: int) -> "str | bytes":
"""Returns the specified line from the given ``string``.
- Line numbering starts from 0 and it is possible to use
+ Line numbering starts from 0, and it is possible to use
negative indices to refer to lines from the end. The line is
returned without the newline character.
@@ -265,41 +339,57 @@ def get_line(self, string, line_number):
Use `Split To Lines` if all lines are needed.
"""
- line_number = self._convert_to_integer(line_number, 'line_number')
return string.splitlines()[line_number]
- def get_lines_containing_string(self, string, pattern, case_insensitive=False):
+ def get_lines_containing_string(
+ self,
+ string: "str | bytes",
+ pattern: "str | bytes",
+ case_insensitive: "bool | None" = None,
+ ignore_case: bool = False,
+ ) -> "str | bytes":
"""Returns lines of the given ``string`` that contain the ``pattern``.
The ``pattern`` is always considered to be a normal string, not a glob
or regexp pattern. A line matches if the ``pattern`` is found anywhere
on it.
- The match is case-sensitive by default, but giving ``case_insensitive``
- a true value makes it case-insensitive. The value is considered true
- if it is a non-empty string that is not equal to ``false``, ``none`` or
- ``no``. If the value is not a string, its truth value is got directly
- in Python.
+ The match is case-sensitive by default, but that can be changed by
+ giving ``ignore_case`` a true value. This option is new in Robot
+ Framework 7.0, but with older versions it is possible to use the
+ nowadays deprecated ``case_insensitive`` argument.
- Lines are returned as one string catenated back together with
- newlines. Possible trailing newline is never returned. The
- number of matching lines is automatically logged.
+ Lines are returned as a string with lines joined together with
+ a newline. Possible trailing newline is never returned. The number
+ of matching lines is automatically logged.
Examples:
| ${lines} = | Get Lines Containing String | ${result} | An example |
- | ${ret} = | Get Lines Containing String | ${ret} | FAIL | case-insensitive |
+ | ${ret} = | Get Lines Containing String | ${ret} | FAIL | ignore_case=True |
See `Get Lines Matching Pattern` and `Get Lines Matching Regexp`
if you need more complex pattern matching.
- """
- if is_truthy(case_insensitive):
- pattern = pattern.lower()
- contains = lambda line: pattern in line.lower()
- else:
- contains = lambda line: pattern in line
- return self._get_matching_lines(string, contains)
- def get_lines_matching_pattern(self, string, pattern, case_insensitive=False):
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well.
+
+ Bytes support is new in Robot Framework 7.4.
+ """
+ if isinstance(string, bytes):
+ pattern = self._ensure_bytes(pattern)
+ if case_insensitive is not None:
+ ignore_case = case_insensitive
+ normalize = Normalizer(ignore_case=ignore_case).normalize
+ pattern = normalize(pattern)
+ return self._get_matching_lines(string, lambda line: pattern in normalize(line))
+
+ def get_lines_matching_pattern(
+ self,
+ string: "str | bytes",
+ pattern: "str | bytes",
+ case_insensitive: "bool | None" = None,
+ ignore_case: bool = False,
+ ) -> "str | bytes":
"""Returns lines of the given ``string`` that match the ``pattern``.
The ``pattern`` is a _glob pattern_ where:
@@ -310,50 +400,63 @@ def get_lines_matching_pattern(self, string, pattern, case_insensitive=False):
A line matches only if it matches the ``pattern`` fully.
- The match is case-sensitive by default, but giving ``case_insensitive``
- a true value makes it case-insensitive. The value is considered true
- if it is a non-empty string that is not equal to ``false``, ``none`` or
- ``no``. If the value is not a string, its truth value is got directly
- in Python.
+ The match is case-sensitive by default, but that can be changed by
+ giving ``ignore_case`` a true value. This option is new in Robot
+ Framework 7.0, but with older versions it is possible to use the
+ nowadays deprecated ``case_insensitive`` argument.
- Lines are returned as one string catenated back together with
- newlines. Possible trailing newline is never returned. The
- number of matching lines is automatically logged.
+ Lines are returned as a string with lines joined together with
+ a newline. Possible trailing newline is never returned. The number
+ of matching lines is automatically logged.
Examples:
| ${lines} = | Get Lines Matching Pattern | ${result} | Wild???? example |
- | ${ret} = | Get Lines Matching Pattern | ${ret} | FAIL: * | case_insensitive=true |
+ | ${ret} = | Get Lines Matching Pattern | ${ret} | FAIL: * | ignore_case=True |
See `Get Lines Matching Regexp` if you need more complex
patterns and `Get Lines Containing String` if searching
literal strings is enough.
- """
- if is_truthy(case_insensitive):
- pattern = pattern.lower()
- matches = lambda line: fnmatchcase(line.lower(), pattern)
- else:
- matches = lambda line: fnmatchcase(line, pattern)
- return self._get_matching_lines(string, matches)
- def get_lines_matching_regexp(self, string, pattern, partial_match=False):
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well.
+
+ Bytes support is new in Robot Framework 7.4.
+ """
+ if isinstance(string, bytes):
+ pattern = self._ensure_bytes(pattern)
+ if case_insensitive is not None:
+ ignore_case = case_insensitive
+ normalize = Normalizer(ignore_case=ignore_case).normalize
+ pattern = normalize(pattern)
+ return self._get_matching_lines(
+ string,
+ lambda line: fnmatchcase(normalize(line), pattern),
+ )
+
+ def get_lines_matching_regexp(
+ self,
+ string: "str | bytes",
+ pattern: "str | bytes",
+ partial_match: bool = False,
+ flags: "str | None" = None,
+ ) -> "str | bytes":
"""Returns lines of the given ``string`` that match the regexp ``pattern``.
See `BuiltIn.Should Match Regexp` for more information about
Python regular expression syntax in general and how to use it
in Robot Framework data in particular.
- By default lines match only if they match the pattern fully, but
+ Lines match only if they match the pattern fully by default, but
partial matching can be enabled by giving the ``partial_match``
- argument a true value. The value is considered true
- if it is a non-empty string that is not equal to ``false``, ``none`` or
- ``no``. If the value is not a string, its truth value is got directly
- in Python.
+ argument a true value.
If the pattern is empty, it matches only empty lines by default.
When partial matching is enabled, empty pattern matches all lines.
- Notice that to make the match case-insensitive, you need to prefix
- the pattern with case-insensitive flag ``(?i)``.
+ Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
+ ``re.VERBOSE``) can be given using the ``flags`` argument (e.g.
+ ``flags=IGNORECASE | VERBOSE``) or embedded to the pattern (e.g.
+ ``(?ix)pattern``).
Lines are returned as one string concatenated back together with
newlines. Possible trailing newline is never returned. The
@@ -363,22 +466,39 @@ def get_lines_matching_regexp(self, string, pattern, partial_match=False):
| ${lines} = | Get Lines Matching Regexp | ${result} | Reg\\\\w{3} example |
| ${lines} = | Get Lines Matching Regexp | ${result} | Reg\\\\w{3} example | partial_match=true |
| ${ret} = | Get Lines Matching Regexp | ${ret} | (?i)FAIL: .* |
+ | ${ret} = | Get Lines Matching Regexp | ${ret} | FAIL: .* | flags=IGNORECASE |
- See `Get Lines Matching Pattern` and `Get Lines Containing
- String` if you do not need full regular expression powers (and
- complexity).
- """
- if not is_truthy(partial_match):
- pattern = '^%s$' % pattern
- return self._get_matching_lines(string, re.compile(pattern).search)
+ See `Get Lines Matching Pattern` and `Get Lines Containing String` if you
+ do not need the full regular expression powers (and complexity).
- def _get_matching_lines(self, string, matches):
+ The ``flags`` argument is new in Robot Framework 6.0.
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
+ """
+ if isinstance(string, bytes):
+ pattern = self._ensure_bytes(pattern)
+ regexp = re.compile(pattern, flags=parse_re_flags(flags))
+ match = regexp.search if partial_match else regexp.fullmatch
+ return self._get_matching_lines(string, match)
+
+ def _get_matching_lines(
+ self,
+ string: "str | bytes",
+ matches: "Callable[[str | bytes], bool | re.Match[str] | None]",
+ ) -> "str | bytes":
lines = string.splitlines()
matching = [line for line in lines if matches(line)]
- logger.info('%d out of %d lines matched' % (len(matching), len(lines)))
- return '\n'.join(matching)
-
- def get_regexp_matches(self, string, pattern, *groups):
+ logger.info(f"{len(matching)} out of {len(lines)} lines matched.")
+ return ("\n" if isinstance(string, str) else b"\n").join(matching)
+
+ def get_regexp_matches(
+ self,
+ string: "str | bytes",
+ pattern: "str | bytes",
+ *groups: "int | str",
+ flags: "str | None" = None,
+ ) -> "list[str] | list[tuple[str, ...]] | list[bytes] | list[tuple[bytes, ...]]":
"""Returns a list of all non-overlapping matches in the given string.
``string`` is the string to find matches from and ``pattern`` is the
@@ -392,9 +512,15 @@ def get_regexp_matches(self, string, pattern, *groups):
individual group contents. All groups can be given as indexes (starting
from 1) and named groups also as names.
+ Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
+ ``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
+ ``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
+ ``(?im)pattern``).
+
Examples:
| ${no match} = | Get Regexp Matches | the string | xxx |
| ${matches} = | Get Regexp Matches | the string | t.. |
+ | ${matches} = | Get Regexp Matches | the string | T.. | flags=IGNORECASE |
| ${one group} = | Get Regexp Matches | the string | t(..) | 1 |
| ${named group} = | Get Regexp Matches | the string | t(?P..) | name |
| ${two groups} = | Get Regexp Matches | the string | t(.)(.) | 1 | 2 |
@@ -404,18 +530,31 @@ def get_regexp_matches(self, string, pattern, *groups):
| ${one group} = ['he', 'ri']
| ${named group} = ['he', 'ri']
| ${two groups} = [('h', 'e'), ('r', 'i')]
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
+
+ The ``flags`` argument is new in Robot Framework 6.0.
"""
- regexp = re.compile(pattern)
+ if isinstance(string, bytes):
+ pattern = self._ensure_bytes(pattern)
+ regexp = re.compile(pattern, flags=parse_re_flags(flags))
groups = [self._parse_group(g) for g in groups]
return [m.group(*groups) for m in regexp.finditer(string)]
- def _parse_group(self, group):
+ def _parse_group(self, group: "str | int") -> "str | int":
try:
return int(group)
except ValueError:
return group
- def replace_string(self, string, search_for, replace_with, count=-1):
+ def replace_string(
+ self,
+ string: "str | bytes",
+ search_for: "str | bytes",
+ replace_with: "str | bytes",
+ count: int = -1,
+ ) -> "str | bytes":
"""Replaces ``search_for`` in the given ``string`` with ``replace_with``.
``search_for`` is used as a literal string. See `Replace String
@@ -435,11 +574,23 @@ def replace_string(self, string, search_for, replace_with, count=-1):
| Should Be Equal | ${str} | Hello, tellus! | | |
| ${str} = | Replace String | Hello, world! | l | ${EMPTY} | count=1 |
| Should Be Equal | ${str} | Helo, world! | | |
+
+ If the first argument is bytes, the following two arguments are automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
"""
- count = self._convert_to_integer(count, 'count')
+ if isinstance(string, bytes):
+ search_for = self._ensure_bytes(search_for)
+ replace_with = self._ensure_bytes(replace_with)
return string.replace(search_for, replace_with, count)
- def replace_string_using_regexp(self, string, pattern, replace_with, count=-1):
+ def replace_string_using_regexp(
+ self,
+ string: "str | bytes",
+ pattern: "str | bytes",
+ replace_with: "str | bytes",
+ count: int = -1,
+ flags: "str | None" = None,
+ ) -> "str | bytes":
"""Replaces ``pattern`` in the given ``string`` with ``replace_with``.
This keyword is otherwise identical to `Replace String`, but
@@ -448,19 +599,41 @@ def replace_string_using_regexp(self, string, pattern, replace_with, count=-1):
information about Python regular expression syntax in general
and how to use it in Robot Framework data in particular.
+ Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
+ ``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
+ ``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
+ ``(?im)pattern``).
+
If you need to just remove a string see `Remove String Using Regexp`.
Examples:
| ${str} = | Replace String Using Regexp | ${str} | 20\\\\d\\\\d-\\\\d\\\\d-\\\\d\\\\d | |
| ${str} = | Replace String Using Regexp | ${str} | (Hello|Hi) | ${EMPTY} | count=1 |
+
+ If the first argument is bytes, the following two arguments are automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
+
+ The ``flags`` argument is new in Robot Framework 6.0.
"""
- count = self._convert_to_integer(count, 'count')
# re.sub handles 0 and negative counts differently than string.replace
if count == 0:
return string
- return re.sub(pattern, replace_with, string, max(count, 0))
-
- def remove_string(self, string, *removables):
+ if isinstance(string, bytes):
+ pattern = self._ensure_bytes(pattern)
+ replace_with = self._ensure_bytes(replace_with)
+ return re.sub(
+ pattern,
+ replace_with,
+ string,
+ count=max(count, 0),
+ flags=parse_re_flags(flags),
+ )
+
+ def remove_string(
+ self,
+ string: "str | bytes",
+ *removables: "str | bytes",
+ ) -> "str | bytes":
"""Removes all ``removables`` from the given ``string``.
``removables`` are used as literal strings. Each removable will be
@@ -479,12 +652,22 @@ def remove_string(self, string, *removables):
| Should Be Equal | ${str} | Robot Frame |
| ${str} = | Remove String | Robot Framework | o | bt |
| Should Be Equal | ${str} | R Framewrk |
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well.
+
+ Bytes support is new in Robot Framework 7.4.
"""
for removable in removables:
- string = self.replace_string(string, removable, '')
+ string = self.replace_string(string, removable, "")
return string
- def remove_string_using_regexp(self, string, *patterns):
+ def remove_string_using_regexp(
+ self,
+ string: "str | bytes",
+ *patterns: "str | bytes",
+ flags: "str | None" = None,
+ ) -> "str | bytes":
"""Removes ``patterns`` from the given ``string``.
This keyword is otherwise identical to `Remove String`, but
@@ -493,13 +676,28 @@ def remove_string_using_regexp(self, string, *patterns):
about the regular expression syntax. That keyword can also be
used if there is a need to remove only a certain number of
occurrences.
+
+ Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
+ ``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
+ ``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
+ ``(?im)pattern``).
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well.
+
+ The ``flags`` argument is new in Robot Framework 6.0.
+ Bytes support is new in Robot Framework 7.4.
"""
for pattern in patterns:
- string = self.replace_string_using_regexp(string, pattern, '')
+ string = self.replace_string_using_regexp(string, pattern, "", flags=flags)
return string
- @keyword(types=None)
- def split_string(self, string, separator=None, max_split=-1):
+ def split_string(
+ self,
+ string: "str | bytes",
+ separator: "str | bytes | None" = None,
+ max_split: int = -1,
+ ) -> "list[str] | list[bytes]":
"""Splits the ``string`` using ``separator`` as a delimiter string.
If a ``separator`` is not given, any whitespace string is a
@@ -518,14 +716,21 @@ def split_string(self, string, separator=None, max_split=-1):
See `Split String From Right` if you want to start splitting
from right, and `Fetch From Left` and `Fetch From Right` if
you only want to get first/last part of the string.
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
"""
- if separator == '':
- separator = None
- max_split = self._convert_to_integer(max_split, 'max_split')
+ separator = self._deprecate_empty_string("separator", separator, None)
+ if isinstance(string, bytes) and separator is not None:
+ separator = self._ensure_bytes(separator)
return string.split(separator, max_split)
- @keyword(types=None)
- def split_string_from_right(self, string, separator=None, max_split=-1):
+ def split_string_from_right(
+ self,
+ string: "str | bytes",
+ separator: "str | bytes | None" = None,
+ max_split: int = -1,
+ ) -> "list[str] | list[bytes]":
"""Splits the ``string`` using ``separator`` starting from right.
Same as `Split String`, but splitting is started from right. This has
@@ -534,41 +739,71 @@ def split_string_from_right(self, string, separator=None, max_split=-1):
Examples:
| ${first} | ${rest} = | Split String | ${string} | - | 1 |
| ${rest} | ${last} = | Split String From Right | ${string} | - | 1 |
+
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
"""
- if separator == '':
- separator = None
- max_split = self._convert_to_integer(max_split, 'max_split')
+ separator = self._deprecate_empty_string("separator", separator, None)
+ if isinstance(string, bytes) and separator is not None:
+ separator = self._ensure_bytes(separator)
return string.rsplit(separator, max_split)
- def split_string_to_characters(self, string):
+ def split_string_to_characters(
+ self,
+ string: "str | bytes",
+ ) -> "list[str] | list[bytes]":
"""Splits the given ``string`` to characters.
Example:
| @{characters} = | Split String To Characters | ${string} |
+
+ Bytes support is new in Robot Framework 7.4.
"""
+ if isinstance(string, bytes):
+ return [bytes([o]) for o in string]
return list(string)
- def fetch_from_left(self, string, marker):
+ def fetch_from_left(
+ self,
+ string: "str | bytes",
+ marker: "str | bytes",
+ ) -> "str | bytes":
"""Returns contents of the ``string`` before the first occurrence of ``marker``.
If the ``marker`` is not found, whole string is returned.
- See also `Fetch From Right`, `Split String` and `Split String
- From Right`.
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
+
+ See also `Fetch From Right`, `Split String` and `Split String From Right`.
"""
+ if isinstance(string, bytes):
+ marker = self._ensure_bytes(marker)
return string.split(marker)[0]
- def fetch_from_right(self, string, marker):
+ def fetch_from_right(
+ self,
+ string: "str | bytes",
+ marker: "str | bytes",
+ ) -> "str | bytes":
"""Returns contents of the ``string`` after the last occurrence of ``marker``.
If the ``marker`` is not found, whole string is returned.
- See also `Fetch From Left`, `Split String` and `Split String
- From Right`.
+ If the first argument is bytes, the second argument is automatically
+ converted to bytes as well. This is new in Robot Framework 7.4.
+
+ See also `Fetch From Left`, `Split String` and `Split String From Right`.
"""
+ if isinstance(string, bytes):
+ marker = self._ensure_bytes(marker)
return string.split(marker)[-1]
- def generate_random_string(self, length=8, chars='[LETTERS][NUMBERS]'):
+ def generate_random_string(
+ self,
+ length: "int | str" = 8,
+ chars: str = "[LETTERS][NUMBERS]",
+ ) -> str:
"""Generates a string with a desired ``length`` from the given ``chars``.
``length`` can be given as a number, a string representation of a number,
@@ -585,6 +820,8 @@ def generate_random_string(self, length=8, chars='[LETTERS][NUMBERS]'):
| ``[UPPER]`` | Uppercase ASCII characters from ``A`` to ``Z``. |
| ``[LETTERS]`` | Lowercase and uppercase ASCII characters. |
| ``[NUMBERS]`` | Numbers from 0 to 9. |
+ | ``[ARABIC]`` | Arabic characters from U+0600 to U+06FF (inclusive). |
+ | ``[POLISH]`` | ASCII characters and Polish diacritical signs. |
Examples:
| ${ret} = | Generate Random String |
@@ -594,24 +831,36 @@ def generate_random_string(self, length=8, chars='[LETTERS][NUMBERS]'):
| ${rnd} = | Generate Random String | 5-10 | # Generates a string 5 to 10 characters long |
Giving ``length`` as a range of values is new in Robot Framework 5.0.
+ Support for markers ``[POLISH]`` and ``[ARABIC]`` is new in Robot Framework 7.4.
"""
- if length == '':
- length = 8
- if isinstance(length, str) and re.match(r'^\d+-\d+$', length):
- min_length, max_length = length.split('-')
- length = randint(self._convert_to_integer(min_length, "length"),
- self._convert_to_integer(max_length, "length"))
+ length = self._deprecate_empty_string("length", length, 8)
+ if isinstance(length, str) and re.match(r"^\d+-\d+$", length):
+ min_length, max_length = length.split("-")
+ length = randint(
+ self._length_to_int(min_length),
+ self._length_to_int(max_length),
+ )
else:
- length = self._convert_to_integer(length, 'length')
- for name, value in [('[LOWER]', ascii_lowercase),
- ('[UPPER]', ascii_uppercase),
- ('[LETTERS]', ascii_lowercase + ascii_uppercase),
- ('[NUMBERS]', digits)]:
+ length = self._length_to_int(length)
+ for name, value in MARKERS.items():
chars = chars.replace(name, value)
maxi = len(chars) - 1
- return ''.join(chars[randint(0, maxi)] for _ in range(length))
+ return "".join(chars[randint(0, maxi)] for _ in range(length))
- def get_substring(self, string, start, end=None):
+ def _length_to_int(self, value: "int | str") -> int:
+ try:
+ return int(value)
+ except ValueError:
+ raise ValueError(
+ f"Cannot convert 'length' argument {value!r} to an integer."
+ )
+
+ def get_substring(
+ self,
+ string: "str | bytes",
+ start: "int | Literal[''] | None" = 0,
+ end: "int | Literal[''] | None" = None,
+ ) -> "str | bytes":
"""Returns a substring from ``start`` index to ``end`` index.
The ``start`` index is inclusive and ``end`` is exclusive.
@@ -620,17 +869,23 @@ def get_substring(self, string, start, end=None):
Examples:
| ${ignore first} = | Get Substring | ${string} | 1 | |
- | ${ignore last} = | Get Substring | ${string} | | -1 |
+ | ${ignore last} = | Get Substring | ${string} | 0 | -1 |
| ${5th to 10th} = | Get Substring | ${string} | 4 | 10 |
- | ${first two} = | Get Substring | ${string} | | 1 |
+ | ${first two} = | Get Substring | ${string} | 0 | 1 |
| ${last two} = | Get Substring | ${string} | -2 | |
+
+ Default value with ``start`` is new in Robot Framework 7.4.
"""
- start = self._convert_to_index(start, 'start')
- end = self._convert_to_index(end, 'end')
+ start = self._deprecate_empty_string("start", start, 0)
+ end = self._deprecate_empty_string("end", end, 0)
return string[start:end]
- @keyword(types=None)
- def strip_string(self, string, mode='both', characters=None):
+ def strip_string(
+ self,
+ string: "str | bytes",
+ mode: Literal["left", "right", "both", "none"] = "both",
+ characters: "str | bytes | None" = None,
+ ) -> "str | bytes":
"""Remove leading and/or trailing whitespaces from the given string.
``mode`` is either ``left`` to remove leading characters, ``right`` to
@@ -650,52 +905,57 @@ def strip_string(self, string, mode='both', characters=None):
| Should Be Equal | ${stripped} | Hello${SPACE} | |
| ${stripped}= | Strip String | aabaHelloeee | characters=abe |
| Should Be Equal | ${stripped} | Hello | |
+
+ If the first argument is bytes, the ``characters`` argument is automatically
+ converted to bytes as well.
+
+ Bytes support is new in Robot Framework 7.4.
"""
- try:
- method = {'BOTH': string.strip,
- 'LEFT': string.lstrip,
- 'RIGHT': string.rstrip,
- 'NONE': lambda characters: string}[mode.upper()]
- except KeyError:
- raise ValueError("Invalid mode '%s'." % mode)
+ if isinstance(string, bytes) and characters is not None:
+ characters = self._ensure_bytes(characters)
+ method = {
+ "both": string.strip,
+ "left": string.lstrip,
+ "right": string.rstrip,
+ "none": lambda chars: string,
+ }[mode.lower()]
return method(characters)
- def should_be_string(self, item, msg=None):
+ def should_be_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
- if not is_string(item):
- self._fail(msg, "'%s' is %s, not a string.", item, type_name(item))
+ if not isinstance(item, str):
+ raise AssertionError(msg or f"{item!r} is {type_name(item)}, not a string.")
- def should_not_be_string(self, item, msg=None):
+ def should_not_be_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
- if is_string(item):
- self._fail(msg, "'%s' is a string.", item)
+ if isinstance(item, str):
+ raise AssertionError(msg or f"{item!r} is a string.")
- def should_be_unicode_string(self, item, msg=None):
+ def should_be_unicode_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a Unicode string.
On Python 3 this keyword behaves exactly the same way `Should Be String`.
That keyword should be used instead and this keyword will be deprecated.
"""
- if not is_string(item):
- self._fail(msg, "'%s' is not a Unicode string.", item)
+ self.should_be_string(item, msg)
- def should_be_byte_string(self, item, msg=None):
+ def should_be_byte_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a byte string.
Use `Should Be String` if you want to verify the ``item`` is a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
- if not is_bytes(item):
- self._fail(msg, "'%s' is not a byte string.", item)
+ if not isinstance(item, bytes):
+ raise AssertionError(msg or f"{item!r} is not a byte string.")
- def should_be_lower_case(self, string, msg=None):
+ def should_be_lower_case(self, string: "str | bytes", msg: "str | None" = None):
"""Fails if the given ``string`` is not in lower case.
For example, ``'string'`` and ``'with specials!'`` would pass, and
@@ -707,9 +967,9 @@ def should_be_lower_case(self, string, msg=None):
See also `Should Be Upper Case` and `Should Be Title Case`.
"""
if not string.islower():
- self._fail(msg, "'%s' is not lower case.", string)
+ raise AssertionError(msg or f"{string!r} is not lower case.")
- def should_be_upper_case(self, string, msg=None):
+ def should_be_upper_case(self, string: "str | bytes", msg: "str | None" = None):
"""Fails if the given ``string`` is not in upper case.
For example, ``'STRING'`` and ``'WITH SPECIALS!'`` would pass, and
@@ -721,10 +981,14 @@ def should_be_upper_case(self, string, msg=None):
See also `Should Be Title Case` and `Should Be Lower Case`.
"""
if not string.isupper():
- self._fail(msg, "'%s' is not upper case.", string)
-
- @keyword(types=None)
- def should_be_title_case(self, string, msg=None, exclude=None):
+ raise AssertionError(msg or f"{string!r} is not upper case.")
+
+ def should_be_title_case(
+ self,
+ string: "str | bytes",
+ msg: "str | None" = None,
+ exclude: "str | bytes | list[str | bytes] | None" = None,
+ ):
"""Fails if given ``string`` is not title.
``string`` is a title cased string if there is at least one upper case
@@ -754,23 +1018,16 @@ def should_be_title_case(self, string, msg=None, exclude=None):
See also `Should Be Upper Case` and `Should Be Lower Case`.
"""
if string != self.convert_to_title_case(string, exclude):
- self._fail(msg, "'%s' is not title case.", string)
-
- def _convert_to_index(self, value, name):
- if value == '':
- return 0
- if value is None:
- return None
- return self._convert_to_integer(value, name)
-
- def _convert_to_integer(self, value, name):
- try:
- return int(value)
- except ValueError:
- raise ValueError("Cannot convert '%s' argument '%s' to an integer."
- % (name, value))
-
- def _fail(self, message, default_template, *items):
- if not message:
- message = default_template % tuple(safe_str(item) for item in items)
- raise AssertionError(message)
+ raise AssertionError(msg or f"{string!r} is not title case.")
+
+ def _deprecate_empty_string(
+ self, name: str, value: object, instead: object
+ ) -> object:
+ # Deprecated in RF 7.4. TODO: Remove in RF 9.
+ if value == "":
+ logger.warn(
+ f"Using an empty string as a value with argument '{name}' is "
+ f"deprecated. Use '{instead}' instead."
+ )
+ return instead
+ return value
diff --git a/src/robot/libraries/Telnet.py b/src/robot/libraries/Telnet.py
index 21c66768f03..e7b3aa882bd 100644
--- a/src/robot/libraries/Telnet.py
+++ b/src/robot/libraries/Telnet.py
@@ -13,13 +13,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from contextlib import contextmanager
import inspect
import re
import socket
import struct
import telnetlib
import time
+from contextlib import contextmanager
try:
import pyte
@@ -28,8 +28,9 @@
from robot.api import logger
from robot.api.deco import keyword
-from robot.utils import (ConnectionCache, is_bytes, is_string, is_truthy,
- secs_to_timestr, seq2str, timestr_to_secs)
+from robot.utils import (
+ ConnectionCache, is_truthy, secs_to_timestr, seq2str, timestr_to_secs
+)
from robot.version import get_version
@@ -43,6 +44,17 @@ class Telnet:
%TOC%
+ = Dependencies =
+
+ ``Telnet`` uses the ``telnetlib`` module internally. This module was
+ part of the Python standard library until Python 3.12, but with newer
+ versions the [https://pypi.org/project/telnetlib-313-and-up|telnetlib-313-and-up]
+ package needs to be installed separately.
+
+ If there is a need to do `terminal emulation`, the
+ [https://pypi.org/project/pyte|pyte] module needs to be installed. It is
+ an optional dependency and only needed with terminal emulation.
+
= Connections =
The first step of using ``Telnet`` is opening a connection with `Open
@@ -192,7 +204,7 @@ class Telnet:
= Terminal emulation =
Telnet library supports terminal
- emulation with [http://pyte.readthedocs.io|Pyte]. Terminal emulation
+ emulation with [http://pyte.readthedocs.io|pyte]. Terminal emulation
will process the output in a virtual screen. This means that ANSI escape
codes, like cursor movements, and also control characters, like
carriage returns and backspaces, have the same effect on the result as they
@@ -203,7 +215,7 @@ class Telnet:
argument a true value (see `Boolean arguments`) either in the library
initialization or with `Open Connection`.
- As Pyte approximates vt-style terminal, you may also want to set the
+ As ``pyte`` approximates vt-style terminal, you may also want to set the
terminal type as ``vt100``. We also recommend that you increase the window
size, as the terminal emulation will break all lines that are longer than
the window row length.
@@ -214,15 +226,8 @@ class Telnet:
Examples:
| `Open Connection` | lolcathost | terminal_emulation=True | terminal_type=vt100 | window_size=400x100 |
- As a prerequisite for using terminal emulation, you need to have Pyte
- installed. Due to backwards incompatible changes in Pyte, different
- Robot Framework versions support different Pyte versions:
-
- - Pyte 0.6 and newer are supported by Robot Framework 3.0.3.
- Latest Pyte version can be installed (or upgraded) with
- ``pip install --upgrade pyte``.
- - Pyte 0.5.2 and older are supported by Robot Framework 3.0.2 and earlier.
- Pyte 0.5.2 can be installed with ``pip install pyte==0.5.2``.
+ As discussed in the `Dependencies` section, ``pyte`` is an optional dependency.
+ It needs to be installed separately to be able to use terminal emulation.
= Logging =
@@ -275,16 +280,26 @@ class Telnet:
Considering string ``NONE`` false is new in Robot Framework 3.0.3 and
considering also ``OFF`` and ``0`` false is new in Robot Framework 3.1.
"""
- ROBOT_LIBRARY_SCOPE = 'SUITE'
+
+ ROBOT_LIBRARY_SCOPE = "SUITE"
ROBOT_LIBRARY_VERSION = get_version()
- def __init__(self, timeout='3 seconds', newline='CRLF',
- prompt=None, prompt_is_regexp=False,
- encoding='UTF-8', encoding_errors='ignore',
- default_log_level='INFO', window_size=None,
- environ_user=None, terminal_emulation=False,
- terminal_type=None, telnetlib_log_level='TRACE',
- connection_timeout=None):
+ def __init__(
+ self,
+ timeout="3 seconds",
+ newline="CRLF",
+ prompt=None,
+ prompt_is_regexp=False,
+ encoding="UTF-8",
+ encoding_errors="ignore",
+ default_log_level="INFO",
+ window_size=None,
+ environ_user=None,
+ terminal_emulation=False,
+ terminal_type=None,
+ telnetlib_log_level="TRACE",
+ connection_timeout=None,
+ ):
"""Telnet library can be imported with optional configuration parameters.
Configuration parameters are used as default values when new
@@ -310,7 +325,7 @@ def __init__(self, timeout='3 seconds', newline='CRLF',
"""
self._timeout = timeout or 3.0
self._set_connection_timeout(connection_timeout)
- self._newline = newline or 'CRLF'
+ self._newline = newline or "CRLF"
self._prompt = (prompt, prompt_is_regexp)
self._encoding = encoding
self._encoding_errors = encoding_errors
@@ -329,24 +344,30 @@ def get_keyword_names(self):
def _get_library_keywords(self):
if self._lib_kws is None:
- self._lib_kws = self._get_keywords(self, ['get_keyword_names'])
+ self._lib_kws = self._get_keywords(self, ["get_keyword_names"])
return self._lib_kws
def _get_keywords(self, source, excluded):
- return [name for name in dir(source)
- if self._is_keyword(name, source, excluded)]
+ return [
+ name for name in dir(source) if self._is_keyword(name, source, excluded)
+ ]
def _is_keyword(self, name, source, excluded):
- return (name not in excluded and
- not name.startswith('_') and
- name != 'get_keyword_names' and
- inspect.ismethod(getattr(source, name)))
+ return (
+ name not in excluded
+ and not name.startswith("_")
+ and name != "get_keyword_names"
+ and inspect.ismethod(getattr(source, name))
+ )
def _get_connection_keywords(self):
if self._conn_kws is None:
conn = self._get_connection()
- excluded = [name for name in dir(telnetlib.Telnet())
- if name not in ['write', 'read', 'read_until']]
+ excluded = [
+ name
+ for name in dir(telnetlib.Telnet())
+ if name not in ["write", "read", "read_until"]
+ ]
self._conn_kws = self._get_keywords(conn, excluded)
return self._conn_kws
@@ -359,13 +380,25 @@ def __getattr__(self, name):
return getattr(self._conn or self._get_connection(), name)
@keyword(types=None)
- def open_connection(self, host, alias=None, port=23, timeout=None,
- newline=None, prompt=None, prompt_is_regexp=False,
- encoding=None, encoding_errors=None,
- default_log_level=None, window_size=None,
- environ_user=None, terminal_emulation=None,
- terminal_type=None, telnetlib_log_level=None,
- connection_timeout=None):
+ def open_connection(
+ self,
+ host,
+ alias=None,
+ port=23,
+ timeout=None,
+ newline=None,
+ prompt=None,
+ prompt_is_regexp=False,
+ encoding=None,
+ encoding_errors=None,
+ default_log_level=None,
+ window_size=None,
+ environ_user=None,
+ terminal_emulation=None,
+ terminal_type=None,
+ telnetlib_log_level=None,
+ connection_timeout=None,
+ ):
"""Opens a new Telnet connection to the given host and port.
The ``timeout``, ``newline``, ``prompt``, ``prompt_is_regexp``,
@@ -383,9 +416,11 @@ def open_connection(self, host, alias=None, port=23, timeout=None,
`Close All Connections` keyword.
"""
timeout = timeout or self._timeout
- connection_timeout = (timestr_to_secs(connection_timeout)
- if connection_timeout
- else self._connection_timeout)
+ connection_timeout = (
+ timestr_to_secs(connection_timeout)
+ if connection_timeout
+ else self._connection_timeout
+ )
newline = newline or self._newline
encoding = encoding or self._encoding
encoding_errors = encoding_errors or self._encoding_errors
@@ -394,33 +429,45 @@ def open_connection(self, host, alias=None, port=23, timeout=None,
environ_user = environ_user or self._environ_user
if terminal_emulation is None:
terminal_emulation = self._terminal_emulation
+ else:
+ terminal_emulation = is_truthy(terminal_emulation)
terminal_type = terminal_type or self._terminal_type
telnetlib_log_level = telnetlib_log_level or self._telnetlib_log_level
if not prompt:
prompt, prompt_is_regexp = self._prompt
- logger.info('Opening connection to %s:%s with prompt: %s%s'
- % (host, port, prompt, ' (regexp)' if prompt_is_regexp else ''))
- self._conn = self._get_connection(host, port, timeout, newline,
- prompt, is_truthy(prompt_is_regexp),
- encoding, encoding_errors,
- default_log_level,
- window_size,
- environ_user,
- is_truthy(terminal_emulation),
- terminal_type,
- telnetlib_log_level,
- connection_timeout)
+ logger.info(
+ f"Opening connection to {host}:{port} with prompt: "
+ f"{prompt}{' (regexp)' if prompt_is_regexp else ''}"
+ )
+ self._conn = self._get_connection(
+ host,
+ port,
+ timeout,
+ newline,
+ prompt,
+ prompt_is_regexp,
+ encoding,
+ encoding_errors,
+ default_log_level,
+ window_size,
+ environ_user,
+ terminal_emulation,
+ terminal_type,
+ telnetlib_log_level,
+ connection_timeout,
+ )
return self._cache.register(self._conn, alias)
def _parse_window_size(self, window_size):
if not window_size:
return None
try:
- cols, rows = window_size.split('x', 1)
+ cols, rows = window_size.split("x", 1)
return int(cols), int(rows)
except ValueError:
- raise ValueError("Invalid window size '%s'. Should be "
- "x." % window_size)
+ raise ValueError(
+ f"Invalid window size '{window_size}'. Should be x."
+ )
def _get_connection(self, *args):
"""Can be overridden to use a custom connection."""
@@ -482,22 +529,33 @@ def close_all_connections(self):
class TelnetConnection(telnetlib.Telnet):
- NEW_ENVIRON_IS = b'\x00'
- NEW_ENVIRON_VAR = b'\x00'
- NEW_ENVIRON_VALUE = b'\x01'
+ NEW_ENVIRON_IS = b"\x00"
+ NEW_ENVIRON_VAR = b"\x00"
+ NEW_ENVIRON_VALUE = b"\x01"
INTERNAL_UPDATE_FREQUENCY = 0.03
- def __init__(self, host=None, port=23, timeout=3.0, newline='CRLF',
- prompt=None, prompt_is_regexp=False,
- encoding='UTF-8', encoding_errors='ignore',
- default_log_level='INFO', window_size=None, environ_user=None,
- terminal_emulation=False, terminal_type=None,
- telnetlib_log_level='TRACE', connection_timeout=None):
+ def __init__(
+ self,
+ host=None,
+ port=23,
+ timeout=3.0,
+ newline="CRLF",
+ prompt=None,
+ prompt_is_regexp=False,
+ encoding="UTF-8",
+ encoding_errors="ignore",
+ default_log_level="INFO",
+ window_size=None,
+ environ_user=None,
+ terminal_emulation=False,
+ terminal_type=None,
+ telnetlib_log_level="TRACE",
+ connection_timeout=None,
+ ):
if connection_timeout is None:
- telnetlib.Telnet.__init__(self, host, int(port) if port else 23)
+ super().__init__(host, int(port) if port else 23)
else:
- telnetlib.Telnet.__init__(self, host, int(port) if port else 23,
- connection_timeout)
+ super().__init__(host, int(port) if port else 23, connection_timeout)
self._set_timeout(timeout)
self._set_newline(newline)
self._set_prompt(prompt, prompt_is_regexp)
@@ -509,7 +567,7 @@ def __init__(self, host=None, port=23, timeout=3.0, newline='CRLF',
self._terminal_type = self._encode(terminal_type) if terminal_type else None
self.set_option_negotiation_callback(self._negotiate_options)
self._set_telnetlib_log_level(telnetlib_log_level)
- self._opt_responses = list()
+ self._opt_responses = []
def set_timeout(self, timeout):
"""Sets the timeout used for waiting output in the current connection.
@@ -551,14 +609,16 @@ def set_newline(self, newline):
"""
self._verify_connection()
if self._terminal_emulator:
- raise AssertionError("Newline can not be changed when terminal emulation is used.")
+ raise AssertionError(
+ "Newline can not be changed when terminal emulation is used."
+ )
old = self._newline
self._set_newline(newline)
return old
def _set_newline(self, newline):
newline = str(newline).upper()
- self._newline = newline.replace('LF', '\n').replace('CR', '\r')
+ self._newline = newline.replace("LF", "\n").replace("CR", "\r")
def set_prompt(self, prompt, prompt_is_regexp=False):
"""Sets the prompt used by `Read Until Prompt` and `Login` in the current connection.
@@ -589,7 +649,7 @@ def set_prompt(self, prompt, prompt_is_regexp=False):
return old
def _set_prompt(self, prompt, prompt_is_regexp):
- if is_truthy(prompt_is_regexp):
+ if prompt_is_regexp:
self._prompt = (re.compile(prompt), True)
else:
self._prompt = (prompt, False)
@@ -619,7 +679,9 @@ def set_encoding(self, encoding=None, errors=None):
"""
self._verify_connection()
if self._terminal_emulator:
- raise AssertionError("Encoding can not be changed when terminal emulation is used.")
+ raise AssertionError(
+ "Encoding can not be changed when terminal emulation is used."
+ )
old = self._encoding
self._set_encoding(encoding or old[0], errors or old[1])
return old
@@ -628,14 +690,14 @@ def _set_encoding(self, encoding, errors):
self._encoding = (encoding.upper(), errors)
def _encode(self, text):
- if is_bytes(text):
+ if isinstance(text, (bytes, bytearray)):
return text
- if self._encoding[0] == 'NONE':
- return text.encode('ASCII')
+ if self._encoding[0] == "NONE":
+ return text.encode("ASCII")
return text.encode(*self._encoding)
def _decode(self, bytes):
- if self._encoding[0] == 'NONE':
+ if self._encoding[0] == "NONE":
return bytes
return bytes.decode(*self._encoding)
@@ -651,10 +713,10 @@ def set_telnetlib_log_level(self, level):
return old
def _set_telnetlib_log_level(self, level):
- if level.upper() == 'NONE':
- self._telnetlib_log_level = 'NONE'
+ if level.upper() == "NONE":
+ self._telnetlib_log_level = "NONE"
elif self._is_valid_log_level(level) is False:
- raise AssertionError("Invalid log level '%s'" % level)
+ raise AssertionError(f"Invalid log level '{level}'")
self._telnetlib_log_level = level.upper()
def set_default_log_level(self, level):
@@ -673,15 +735,15 @@ def set_default_log_level(self, level):
def _set_default_log_level(self, level):
if level is None or not self._is_valid_log_level(level):
- raise AssertionError("Invalid log level '%s'" % level)
+ raise AssertionError(f"Invalid log level '{level}'")
self._default_log_level = level.upper()
def _is_valid_log_level(self, level):
if level is None:
return True
- if not is_string(level):
+ if not isinstance(level, str):
return False
- return level.upper() in ('TRACE', 'DEBUG', 'INFO', 'WARN')
+ return level.upper() in ("TRACE", "DEBUG", "INFO", "WARN")
def close_connection(self, loglevel=None):
"""Closes the current Telnet connection.
@@ -701,9 +763,15 @@ def close_connection(self, loglevel=None):
self._log(output, loglevel)
return output
- def login(self, username, password, login_prompt='login: ',
- password_prompt='Password: ', login_timeout='1 second',
- login_incorrect='Login incorrect'):
+ def login(
+ self,
+ username,
+ password,
+ login_prompt="login: ",
+ password_prompt="Password: ",
+ login_timeout="1 second",
+ login_incorrect="Login incorrect",
+ ):
"""Logs in to the Telnet server with the given user information.
This keyword reads from the connection until the ``login_prompt`` is
@@ -728,31 +796,33 @@ def login(self, username, password, login_prompt='login: ',
See `Configuration` section for more information about setting
newline, timeout, and prompt.
"""
- output = self._submit_credentials(username, password, login_prompt,
- password_prompt)
+ output = self._submit_credentials(
+ username, password, login_prompt, password_prompt
+ )
if self._prompt_is_set():
success, output2 = self._read_until_prompt()
else:
success, output2 = self._verify_login_without_prompt(
- login_timeout, login_incorrect)
+ login_timeout, login_incorrect
+ )
output += output2
self._log(output)
if not success:
- raise AssertionError('Login incorrect')
+ raise AssertionError("Login incorrect")
return output
def _submit_credentials(self, username, password, login_prompt, password_prompt):
# Using write_bare here instead of write because don't want to wait for
# newline: https://github.com/robotframework/robotframework/issues/1371
- output = self.read_until(login_prompt, 'TRACE')
+ output = self.read_until(login_prompt, "TRACE")
self.write_bare(username + self._newline)
- output += self.read_until(password_prompt, 'TRACE')
+ output += self.read_until(password_prompt, "TRACE")
self.write_bare(password + self._newline)
return output
def _verify_login_without_prompt(self, delay, incorrect):
time.sleep(timestr_to_secs(delay))
- output = self.read('TRACE')
+ output = self.read("TRACE")
success = incorrect not in output
return success, output
@@ -775,14 +845,16 @@ def write(self, text, loglevel=None):
"""
newline = self._get_newline_for(text)
if newline in text:
- raise RuntimeError("'Write' keyword cannot be used with strings "
- "containing newlines. Use 'Write Bare' instead.")
+ raise RuntimeError(
+ "'Write' keyword cannot be used with strings "
+ "containing newlines. Use 'Write Bare' instead."
+ )
self.write_bare(text + newline)
# Can't read until 'text' because long lines are cut strangely in the output
return self.read_until(self._newline, loglevel)
def _get_newline_for(self, text):
- if is_bytes(text):
+ if isinstance(text, (bytes, bytearray)):
return self._encode(self._newline)
return self._newline
@@ -793,10 +865,16 @@ def write_bare(self, text):
Use `Write` if these features are needed.
"""
self._verify_connection()
- telnetlib.Telnet.write(self, self._encode(text))
-
- def write_until_expected_output(self, text, expected, timeout,
- retry_interval, loglevel=None):
+ super().write(self._encode(text))
+
+ def write_until_expected_output(
+ self,
+ text,
+ expected,
+ timeout,
+ retry_interval,
+ loglevel=None,
+ ):
"""Writes the given ``text`` repeatedly, until ``expected`` appears in the output.
``text`` is written without appending a newline and it is consumed from
@@ -858,18 +936,18 @@ def _get_control_character(self, int_or_name):
def _convert_control_code_name_to_character(self, name):
code_names = {
- 'BRK' : telnetlib.BRK,
- 'IP' : telnetlib.IP,
- 'AO' : telnetlib.AO,
- 'AYT' : telnetlib.AYT,
- 'EC' : telnetlib.EC,
- 'EL' : telnetlib.EL,
- 'NOP' : telnetlib.NOP
+ "BRK": telnetlib.BRK,
+ "IP": telnetlib.IP,
+ "AO": telnetlib.AO,
+ "AYT": telnetlib.AYT,
+ "EC": telnetlib.EC,
+ "EL": telnetlib.EL,
+ "NOP": telnetlib.NOP,
}
try:
return code_names[name]
except KeyError:
- raise RuntimeError("Unsupported control character '%s'." % name)
+ raise RuntimeError(f"Unsupported control character '{name}'.")
def read(self, loglevel=None):
"""Reads everything that is currently available in the output.
@@ -906,7 +984,7 @@ def _read_until(self, expected):
if self._terminal_emulator:
return self._terminal_read_until(expected)
expected = self._encode(expected)
- output = telnetlib.Telnet.read_until(self, expected, self._timeout)
+ output = super().read_until(expected, self._timeout)
return output.endswith(expected), self._decode(output)
@property
@@ -919,8 +997,9 @@ def _terminal_read_until(self, expected):
if output:
return True, output
while time.time() < max_time:
- output = telnetlib.Telnet.read_until(self, self._encode(expected),
- self._terminal_frequency)
+ output = super().read_until(
+ self._encode(expected), self._terminal_frequency
+ )
self._terminal_emulator.feed(self._decode(output))
output = self._terminal_emulator.read_until(expected)
if output:
@@ -931,15 +1010,15 @@ def _read_until_regexp(self, *expected):
self._verify_connection()
if self._terminal_emulator:
return self._terminal_read_until_regexp(expected)
- expected = [self._encode(exp) if is_string(exp) else exp
- for exp in expected]
+ expected = [self._encode(e) if isinstance(e, str) else e for e in expected]
return self._telnet_read_until_regexp(expected)
def _terminal_read_until_regexp(self, expected_list):
max_time = time.time() + self._timeout
regexps_bytes = [self._to_byte_regexp(rgx) for rgx in expected_list]
- regexps_unicode = [re.compile(self._decode(rgx.pattern))
- for rgx in regexps_bytes]
+ regexps_unicode = [
+ re.compile(self._decode(rgx.pattern)) for rgx in regexps_bytes
+ ]
out = self._terminal_emulator.read_until_regexp(regexps_unicode)
if out:
return True, out
@@ -956,16 +1035,16 @@ def _telnet_read_until_regexp(self, expected_list):
try:
index, _, output = self.expect(expected, self._timeout)
except TypeError:
- index, output = -1, b''
+ index, output = -1, b""
return index != -1, self._decode(output)
def _to_byte_regexp(self, exp):
- if is_bytes(exp):
+ if isinstance(exp, (bytes, bytearray)):
return re.compile(exp)
- if is_string(exp):
+ if isinstance(exp, str):
return re.compile(self._encode(exp))
pattern = exp.pattern
- if is_bytes(pattern):
+ if isinstance(pattern, (bytes, bytearray)):
return exp
return re.compile(self._encode(pattern))
@@ -992,7 +1071,7 @@ def read_until_regexp(self, *expected):
| `Read Until Regexp` | \\\\d{4}-\\\\d{2}-\\\\d{2} | DEBUG |
"""
if not expected:
- raise RuntimeError('At least one pattern required')
+ raise RuntimeError("At least one pattern required")
if self._is_valid_log_level(expected[-1]):
loglevel = expected[-1]
expected = expected[:-1]
@@ -1001,8 +1080,7 @@ def read_until_regexp(self, *expected):
success, output = self._read_until_regexp(*expected)
self._log(output, loglevel)
if not success:
- expected = [exp if is_string(exp) else exp.pattern
- for exp in expected]
+ expected = [e if isinstance(e, str) else e.pattern for e in expected]
raise NoMatchError(expected, self._timeout, output)
return output
@@ -1025,15 +1103,16 @@ def read_until_prompt(self, loglevel=None, strip_prompt=False):
See `Logging` section for more information about log levels.
"""
if not self._prompt_is_set():
- raise RuntimeError('Prompt is not set.')
+ raise RuntimeError("Prompt is not set.")
success, output = self._read_until_prompt()
self._log(output, loglevel)
if not success:
prompt, regexp = self._prompt
- raise AssertionError("Prompt '%s' not found in %s."
- % (prompt if not regexp else prompt.pattern,
- secs_to_timestr(self._timeout)))
- if is_truthy(strip_prompt):
+ pattern = prompt.pattern if regexp else prompt
+ raise AssertionError(
+ f"Prompt '{pattern}' not found in {secs_to_timestr(self._timeout)}."
+ )
+ if strip_prompt:
output = self._strip_prompt(output)
return output
@@ -1081,7 +1160,7 @@ def _custom_timeout(self, timeout):
def _verify_connection(self):
if not self.sock:
- raise RuntimeError('No connection open')
+ raise RuntimeError("No connection open")
def _log(self, msg, level=None):
msg = msg.strip()
@@ -1095,15 +1174,16 @@ def _negotiate_options(self, sock, cmd, opt):
if cmd in (telnetlib.DO, telnetlib.DONT, telnetlib.WILL, telnetlib.WONT):
if (cmd, opt) in self._opt_responses:
return
- else:
- self._opt_responses.append((cmd, opt))
+ self._opt_responses.append((cmd, opt))
# This is supposed to turn server side echoing on and turn other options off.
if opt == telnetlib.ECHO and cmd in (telnetlib.WILL, telnetlib.WONT):
self._opt_echo_on(opt)
elif cmd == telnetlib.DO and opt == telnetlib.TTYPE and self._terminal_type:
self._opt_terminal_type(opt, self._terminal_type)
- elif cmd == telnetlib.DO and opt == telnetlib.NEW_ENVIRON and self._environ_user:
+ elif (
+ cmd == telnetlib.DO and opt == telnetlib.NEW_ENVIRON and self._environ_user
+ ):
self._opt_environ_user(opt, self._environ_user)
elif cmd == telnetlib.DO and opt == telnetlib.NAWS and self._window_size:
self._opt_window_size(opt, *self._window_size)
@@ -1115,22 +1195,41 @@ def _opt_echo_on(self, opt):
def _opt_terminal_type(self, opt, terminal_type):
self.sock.sendall(telnetlib.IAC + telnetlib.WILL + opt)
- self.sock.sendall(telnetlib.IAC + telnetlib.SB + telnetlib.TTYPE
- + self.NEW_ENVIRON_IS + terminal_type
- + telnetlib.IAC + telnetlib.SE)
+ self.sock.sendall(
+ telnetlib.IAC
+ + telnetlib.SB
+ + telnetlib.TTYPE
+ + self.NEW_ENVIRON_IS
+ + terminal_type
+ + telnetlib.IAC
+ + telnetlib.SE
+ )
def _opt_environ_user(self, opt, environ_user):
self.sock.sendall(telnetlib.IAC + telnetlib.WILL + opt)
- self.sock.sendall(telnetlib.IAC + telnetlib.SB + telnetlib.NEW_ENVIRON
- + self.NEW_ENVIRON_IS + self.NEW_ENVIRON_VAR
- + b"USER" + self.NEW_ENVIRON_VALUE + environ_user
- + telnetlib.IAC + telnetlib.SE)
+ self.sock.sendall(
+ telnetlib.IAC
+ + telnetlib.SB
+ + telnetlib.NEW_ENVIRON
+ + self.NEW_ENVIRON_IS
+ + self.NEW_ENVIRON_VAR
+ + b"USER"
+ + self.NEW_ENVIRON_VALUE
+ + environ_user
+ + telnetlib.IAC
+ + telnetlib.SE
+ )
def _opt_window_size(self, opt, window_x, window_y):
self.sock.sendall(telnetlib.IAC + telnetlib.WILL + opt)
- self.sock.sendall(telnetlib.IAC + telnetlib.SB + telnetlib.NAWS
- + struct.pack('!HH', window_x, window_y)
- + telnetlib.IAC + telnetlib.SE)
+ self.sock.sendall(
+ telnetlib.IAC
+ + telnetlib.SB
+ + telnetlib.NAWS
+ + struct.pack("!HH", window_x, window_y)
+ + telnetlib.IAC
+ + telnetlib.SE
+ )
def _opt_dont_and_wont(self, cmd, opt):
if cmd in (telnetlib.DO, telnetlib.DONT):
@@ -1140,49 +1239,49 @@ def _opt_dont_and_wont(self, cmd, opt):
def msg(self, msg, *args):
# Forward telnetlib's debug messages to log
- if self._telnetlib_log_level != 'NONE':
+ if self._telnetlib_log_level != "NONE":
logger.write(msg % args, self._telnetlib_log_level)
def _check_terminal_emulation(self, terminal_emulation):
if not terminal_emulation:
return False
if not pyte:
- raise RuntimeError("Terminal emulation requires pyte module!\n"
- "http://pypi.python.org/pypi/pyte/")
- return TerminalEmulator(window_size=self._window_size,
- newline=self._newline)
+ raise RuntimeError(
+ "Terminal emulation requires pyte module!\n"
+ "http://pypi.python.org/pypi/pyte/"
+ )
+ return TerminalEmulator(window_size=self._window_size, newline=self._newline)
class TerminalEmulator:
-
def __init__(self, window_size=None, newline="\r\n"):
self._rows, self._columns = window_size or (200, 200)
self._newline = newline
self._stream = pyte.Stream()
- self._screen = pyte.HistoryScreen(self._rows,
- self._columns,
- history=100000)
+ self._screen = pyte.HistoryScreen(self._rows, self._columns, history=100000)
self._stream.attach(self._screen)
- self._buffer = ''
- self._whitespace_after_last_feed = ''
+ self._buffer = ""
+ self._whitespace_after_last_feed = ""
@property
def current_output(self):
return self._buffer + self._dump_screen()
def _dump_screen(self):
- return self._get_history(self._screen) + \
- self._get_screen(self._screen) + \
- self._whitespace_after_last_feed
+ return (
+ self._get_history(self._screen)
+ + self._get_screen(self._screen)
+ + self._whitespace_after_last_feed
+ )
def _get_history(self, screen):
if not screen.history.top:
- return ''
+ return ""
rows = []
for row in screen.history.top:
# Newer pyte versions store row data in mappings
data = (char.data for _, char in sorted(row.items()))
- rows.append(''.join(data).rstrip())
+ rows.append("".join(data).rstrip())
return self._newline.join(rows).rstrip(self._newline) + self._newline
def _get_screen(self, screen):
@@ -1191,19 +1290,19 @@ def _get_screen(self, screen):
def feed(self, text):
self._stream.feed(text)
- self._whitespace_after_last_feed = text[len(text.rstrip()):]
+ self._whitespace_after_last_feed = text[len(text.rstrip()) :]
def read(self):
current_out = self.current_output
- self._update_buffer('')
+ self._update_buffer("")
return current_out
def read_until(self, expected):
current_out = self.current_output
exp_index = current_out.find(expected)
if exp_index != -1:
- self._update_buffer(current_out[exp_index+len(expected):])
- return current_out[:exp_index+len(expected)]
+ self._update_buffer(current_out[exp_index + len(expected) :])
+ return current_out[: exp_index + len(expected)]
return None
def read_until_regexp(self, regexp_list):
@@ -1211,13 +1310,13 @@ def read_until_regexp(self, regexp_list):
for rgx in regexp_list:
match = rgx.search(current_out)
if match:
- self._update_buffer(current_out[match.end():])
- return current_out[:match.end()]
+ self._update_buffer(current_out[match.end() :])
+ return current_out[: match.end()]
return None
def _update_buffer(self, terminal_buffer):
self._buffer = terminal_buffer
- self._whitespace_after_last_feed = ''
+ self._whitespace_after_last_feed = ""
self._screen.reset()
@@ -1228,13 +1327,15 @@ def __init__(self, expected, timeout, output=None):
self.expected = expected
self.timeout = secs_to_timestr(timeout)
self.output = output
- AssertionError.__init__(self, self._get_message())
+ super().__init__(self._get_message())
def _get_message(self):
- expected = "'%s'" % self.expected \
- if is_string(self.expected) \
- else seq2str(self.expected, lastsep=' or ')
- msg = "No match found for %s in %s." % (expected, self.timeout)
+ expected = (
+ f"'{self.expected}'"
+ if isinstance(self.expected, str)
+ else seq2str(self.expected, lastsep=" or ")
+ )
+ msg = f"No match found for {expected} in {self.timeout}."
if self.output is not None:
- msg += ' Output:\n%s' % self.output
+ msg += " Output:\n" + self.output
return msg
diff --git a/src/robot/libraries/XML.py b/src/robot/libraries/XML.py
index 6d97ef4652d..20b161b61f6 100644
--- a/src/robot/libraries/XML.py
+++ b/src/robot/libraries/XML.py
@@ -14,27 +14,86 @@
# limitations under the License.
import copy
-import os
-import pathlib
import re
+from collections.abc import Iterator
+from pathlib import Path
+from typing import Any, Callable, NoReturn, TYPE_CHECKING
+from xml.etree import ElementTree as ET
try:
from lxml import etree as lxml_etree
except ImportError:
lxml_etree = None
+else:
+ # `lxml.etree._Attrib` doesn't extend `Mapping` and thus our `is_dict_like`
+ # doesn't recognize it unless we register it ourselves. Fixed in lxml 4.9.2:
+ # https://bugs.launchpad.net/lxml/+bug/1981760
+ from collections.abc import MutableMapping
+
+ Attrib = getattr(lxml_etree, "_Attrib", None)
+ if Attrib and not isinstance(Attrib, MutableMapping):
+ MutableMapping.register(Attrib) # type: ignore
+ del Attrib, MutableMapping
from robot.api import logger
-from robot.api.deco import keyword
+from robot.api.deco import library
from robot.libraries.BuiltIn import BuiltIn
-from robot.utils import (asserts, ET, ETSource, is_bytes, is_falsy, is_string,
- is_truthy, plural_or_not as s)
+from robot.utils import asserts, ETSource, plural_or_not as s
from robot.version import get_version
-
should_be_equal = asserts.assert_equal
should_match = BuiltIn().should_match
+if TYPE_CHECKING:
+ Source = Any
+ Element = Any
+
+else:
+
+ class Source:
+ """XML source.
+
+ Can be given as a path to an XML file, as a string or bytes containing
+ XML data, or as an already parsed XML element structure.
+
+ Examples:
+ | # Give source as a path:
+ | ${xml} = `Parse XML` ${CURDIR}/example.xml
+ |
+ | # Give source as an already parsed element:
+ | ${elem} = `Get Element` ${xml} xpath=child
+ |
+ | # Give source as a string:
+ | `Elements Should Be Equal` ${elem} text
+ """
+
+ class Element:
+ """A parsed XML element.
+
+ Represented as an ElementTree
+ [https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element|Element]
+ object. Can be used as a ``source`` argument with keywords modifying
+ or validating XML elements. In addition to that, attributes like ``text``
+ can be accessed using the extended variable syntax like ``${elem.text}``
+ directly.
+
+ Examples:
+ | # Get element as a return value:
+ | ${elem} = `Parse XML` ${CURDIR}/example.xml
+ |
+ | # Use element as an argument with other keywords:
+ | ${child} = `Get Element` ${elem} expath=child
+ |
+ | # Access element attributes:
+ | `Log` ${elem.text}
+ """
+
+
+@library(
+ converters={Source: lambda value: value, Element: lambda value: value},
+ auto_keywords=True,
+)
class XML:
"""Robot Framework library for verifying and modifying XML documents.
@@ -45,7 +104,7 @@ class XML:
The library has the following main usages:
- Parsing an XML file, or a string containing XML, into an XML element
- structure and finding certain elements from it for for further analysis
+ structure and finding certain elements from it for further analysis
(e.g. `Parse XML` and `Get Element` keywords).
- Getting text or attributes of elements
(e.g. `Get Element Text` and `Get Element Attribute`).
@@ -67,10 +126,10 @@ class XML:
children and their children. Possible comments and processing instructions
in the source XML are removed.
- XML is not validated during parsing even if has a schema defined. How
+ XML is not validated during parsing even if it has a schema defined. How
possible doctype elements are handled otherwise depends on the used XML
module and on the platform. The standard ElementTree strips doctypes
- altogether but when `using lxml` they are preserved when XML is saved.
+ altogether, but when `using lxml` they are preserved when XML is saved.
The element structure returned by `Parse XML`, as well as elements
returned by keywords such as `Get Element`, can be used as the ``source``
@@ -87,8 +146,6 @@ class XML:
escaped by doubling it (``\\\\``). Using the built-in variable ``${/}``
naturally works too.
- Note: Support for XML as bytes is new in Robot Framework 3.2.
-
= Using lxml =
By default, this library uses Python's standard
@@ -160,7 +217,7 @@ class XML:
If lxml support is enabled when `importing` the library, the whole
[http://www.w3.org/TR/xpath/|xpath 1.0 standard] is supported.
- That includes everything listed below but also lot of other useful
+ That includes everything listed below but also a lot of other useful
constructs.
== Tag names ==
@@ -296,7 +353,7 @@ class XML:
= Handling XML namespaces =
ElementTree and lxml handle possible namespaces in XML documents by adding
- the namespace URI to tag names in so called Clark Notation. That is
+ the namespace URI to tag names in so-called Clark Notation. That is
inconvenient especially with xpaths, and by default this library strips
those namespaces away and moves them to ``xmlns`` attribute instead. That
can be avoided by passing ``keep_clark_notation`` argument to `Parse XML`
@@ -397,36 +454,13 @@ class XML:
If an attribute has a namespace prefix, ElementTree will replace it with
Clark Notation the same way it handles elements. Because stripping
namespaces from attributes could cause attribute conflicts, this library
- does not handle attribute namespaces at all. Thus the following example
+ does not handle attribute namespaces at all. The following example thus
works the same way regardless how namespaces are handled.
| ${root} = | `Parse XML` | |
| `Element Attribute Should Be` | ${root} | id | 1 |
| `Element Attribute Should Be` | ${root} | {http://my.ns}id | 2 |
- = Boolean arguments =
-
- Some keywords accept arguments that are handled as Boolean values true or
- false. If such an argument is given as a string, it is considered false if
- it is an empty string or equal to ``FALSE``, ``NONE``, ``NO``, ``OFF`` or
- ``0``, case-insensitively. Other strings are considered true regardless
- their value, and other argument types are tested using the same
- [http://docs.python.org/library/stdtypes.html#truth|rules as in Python].
-
- True examples:
- | `Parse XML` | ${XML} | keep_clark_notation=True | # Strings are generally true. |
- | `Parse XML` | ${XML} | keep_clark_notation=yes | # Same as the above. |
- | `Parse XML` | ${XML} | keep_clark_notation=${TRUE} | # Python ``True`` is true. |
- | `Parse XML` | ${XML} | keep_clark_notation=${42} | # Numbers other than 0 are true. |
-
- False examples:
- | `Parse XML` | ${XML} | keep_clark_notation=False | # String ``false`` is false. |
- | `Parse XML` | ${XML} | keep_clark_notation=no | # Also string ``no`` is false. |
- | `Parse XML` | ${XML} | keep_clark_notation=${EMPTY} | # Empty string is false. |
- | `Parse XML` | ${XML} | keep_clark_notation=${FALSE} | # Python ``False`` is false. |
-
- Considering ``OFF`` and ``0`` false is new in Robot Framework 3.1.
-
== Pattern matching ==
Some keywords, for example `Elements Should Match`, support so called
@@ -442,49 +476,52 @@ class XML:
Unlike with glob patterns normally, path separator characters ``/`` and
``\\`` and the newline character ``\\n`` are matches by the above
wildcards.
-
- Support for brackets like ``[abc]`` and ``[!a-z]`` is new in
- Robot Framework 3.1
"""
- ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+ ROBOT_LIBRARY_SCOPE = "GLOBAL"
ROBOT_LIBRARY_VERSION = get_version()
- _xml_declaration = re.compile('^<\?xml .*\?>')
- def __init__(self, use_lxml=False):
+ def __init__(self, use_lxml: bool = False):
"""Import library with optionally lxml mode enabled.
- By default this library uses Python's standard
+ This library uses Python's standard
[http://docs.python.org/library/xml.etree.elementtree.html|ElementTree]
- module for parsing XML. If ``use_lxml`` argument is given a true value
- (see `Boolean arguments`), the library will use [http://lxml.de|lxml]
- module instead. See `Using lxml` section for benefits provided by lxml.
+ module for parsing XML by default. If ``use_lxml`` argument is given
+ a true value, the [http://lxml.de|lxml] module is used instead.
+ See the `Using lxml` section for benefits provided by lxml.
Using lxml requires that the lxml module is installed on the system.
If lxml mode is enabled but the module is not installed, this library
- will emit a warning and revert back to using the standard ElementTree.
+ emits a warning and reverts back to using the standard ElementTree.
"""
- use_lxml = is_truthy(use_lxml)
if use_lxml and lxml_etree:
- self.etree = lxml_etree
+ self.etree = lxml_etree # type: ignore
self.modern_etree = True
self.lxml_etree = True
else:
- self.etree = ET
- self.modern_etree = ET.VERSION >= '1.3'
+ self.etree = ET # type: ignore
+ self.modern_etree = ET.VERSION >= "1.3"
self.lxml_etree = False
if use_lxml and not lxml_etree:
- logger.warn('XML library reverted to use standard ElementTree '
- 'because lxml module is not installed.')
+ logger.warn(
+ "XML library reverted to use standard ElementTree "
+ "because lxml module is not installed."
+ )
self._ns_stripper = NameSpaceStripper(self.etree, self.lxml_etree)
- def parse_xml(self, source, keep_clark_notation=False, strip_namespaces=False):
+ def parse_xml(
+ self,
+ source: Source,
+ keep_clark_notation: bool = False,
+ strip_namespaces: bool = False,
+ ) -> Element:
"""Parses the given XML file or string into an element structure.
The ``source`` can either be a path to an XML file or a string
containing XML. In both cases the XML is parsed into ElementTree
- [http://docs.python.org/library/xml.etree.elementtree.html#element-objects|element structure]
- and the root element is returned. Possible comments and processing
- instructions in the source XML are removed.
+ [https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element|Element]
+ structure. Possible comments and processing instructions in the source
+ XML are removed.
As discussed in `Handling XML namespaces` section, this keyword, by
default, removes namespace information ElementTree has added to tag
@@ -493,7 +530,7 @@ def parse_xml(self, source, keep_clark_notation=False, strip_namespaces=False):
want that to happen, or want to avoid the small overhead of going
through the element structure when your XML does not have namespaces,
you can disable this feature by giving ``keep_clark_notation`` argument
- a true value (see `Boolean arguments`).
+ a true value.
If you want to strip namespace information altogether so that it is
not included even if XML is saved, you can give a true value to
@@ -507,20 +544,21 @@ def parse_xml(self, source, keep_clark_notation=False, strip_namespaces=False):
Use `Get Element` keyword if you want to get a certain element and not
the whole structure. See `Parsing XML` section for more details and
examples.
+
+ *NOTE:* This keyword does not accept an already parsed XML element as
+ an argument. Use `Get Element` instead.
"""
- if isinstance(source, pathlib.Path):
- source = str(source)
- with ETSource(source) as source:
- tree = self.etree.parse(source)
+ with ETSource(source) as source_:
+ tree = self.etree.parse(source_)
if self.lxml_etree:
- strip = (lxml_etree.Comment, lxml_etree.ProcessingInstruction)
- lxml_etree.strip_elements(tree, *strip, **dict(with_tail=False))
+ strip = (lxml_etree.Comment, lxml_etree.ProcessingInstruction) # type: ignore
+ lxml_etree.strip_elements(tree, *strip, with_tail=False) # type: ignore
root = tree.getroot()
- if not is_truthy(keep_clark_notation):
- self._ns_stripper.strip(root, preserve=is_falsy(strip_namespaces))
+ if not keep_clark_notation:
+ self._ns_stripper.strip(root, preserve=not strip_namespaces)
return root
- def get_element(self, source, xpath='.'):
+ def get_element(self, source: Source, xpath: str = ".") -> Element:
"""Returns an element in the ``source`` matching the ``xpath``.
The ``source`` can be a path to an XML file, a string containing XML, or
@@ -551,19 +589,21 @@ def get_element(self, source, xpath='.'):
self._raise_wrong_number_of_matches(len(elements), xpath)
return elements[0]
- def _raise_wrong_number_of_matches(self, count, xpath, message=None):
+ def _raise_wrong_number_of_matches(
+ self, count: int, xpath: str, message: "str | None" = None
+ ) -> NoReturn:
if not message:
message = self._wrong_number_of_matches(count, xpath)
raise AssertionError(message)
- def _wrong_number_of_matches(self, count, xpath):
+ def _wrong_number_of_matches(self, count: int, xpath: str) -> str:
if not count:
- return "No element matching '%s' found." % xpath
+ return f"No element matching '{xpath}' found."
if count == 1:
- return "One element matching '%s' found." % xpath
- return "Multiple elements (%d) matching '%s' found." % (count, xpath)
+ return f"One element matching '{xpath}' found."
+ return f"Multiple elements ({count}) matching '{xpath}' found."
- def get_elements(self, source, xpath):
+ def get_elements(self, source: Source, xpath: str) -> "list[Element]":
"""Returns a list of elements in the ``source`` matching the ``xpath``.
The ``source`` can be a path to an XML file, a string containing XML, or
@@ -580,12 +620,12 @@ def get_elements(self, source, xpath):
| ${children} = | Get Elements | ${XML} | first/child |
| Should Be Empty | ${children} | | |
"""
- if is_string(source) or is_bytes(source) or isinstance(source, pathlib.Path):
+ if isinstance(source, (str, bytes, Path)):
source = self.parse_xml(source)
finder = ElementFinder(self.etree, self.modern_etree, self.lxml_etree)
return finder.find_all(source, xpath)
- def get_child_elements(self, source, xpath='.'):
+ def get_child_elements(self, source: Source, xpath: str = ".") -> "list[Element]":
"""Returns the child elements of the specified element as a list.
The element whose children to return is specified using ``source`` and
@@ -603,7 +643,7 @@ def get_child_elements(self, source, xpath='.'):
"""
return list(self.get_element(source, xpath))
- def get_element_count(self, source, xpath='.'):
+ def get_element_count(self, source: Source, xpath: str = ".") -> int:
"""Returns and logs how many elements the given ``xpath`` matches.
Arguments ``source`` and ``xpath`` have exactly the same semantics as
@@ -612,10 +652,15 @@ def get_element_count(self, source, xpath='.'):
See also `Element Should Exist` and `Element Should Not Exist`.
"""
count = len(self.get_elements(source, xpath))
- logger.info("%d element%s matched '%s'." % (count, s(count), xpath))
+ logger.info(f"{count} element{s(count)} matched '{xpath}'.")
return count
- def element_should_exist(self, source, xpath='.', message=None):
+ def element_should_exist(
+ self,
+ source: Source,
+ xpath: str = ".",
+ message: "str | None" = None,
+ ):
"""Verifies that one or more element match the given ``xpath``.
Arguments ``source`` and ``xpath`` have exactly the same semantics as
@@ -630,7 +675,12 @@ def element_should_exist(self, source, xpath='.', message=None):
if not count:
self._raise_wrong_number_of_matches(count, xpath, message)
- def element_should_not_exist(self, source, xpath='.', message=None):
+ def element_should_not_exist(
+ self,
+ source: Source,
+ xpath: str = ".",
+ message: "str | None" = None,
+ ):
"""Verifies that no element match the given ``xpath``.
Arguments ``source`` and ``xpath`` have exactly the same semantics as
@@ -645,7 +695,12 @@ def element_should_not_exist(self, source, xpath='.', message=None):
if count:
self._raise_wrong_number_of_matches(count, xpath, message)
- def get_element_text(self, source, xpath='.', normalize_whitespace=False):
+ def get_element_text(
+ self,
+ source: Source,
+ xpath: str = ".",
+ normalize_whitespace: bool = False,
+ ) -> str:
"""Returns all text of the element, possibly whitespace normalized.
The element whose text to return is specified using ``source`` and
@@ -657,12 +712,11 @@ def get_element_text(self, source, xpath='.', normalize_whitespace=False):
has no text, an empty string is returned. The returned text is thus not
always the same as the `text` attribute of the element.
- By default all whitespace, including newlines and indentation, inside
- the element is returned as-is. If ``normalize_whitespace`` is given
- a true value (see `Boolean arguments`), then leading and trailing
- whitespace is stripped, newlines and tabs converted to spaces, and
- multiple spaces collapsed into one. This is especially useful when
- dealing with HTML data.
+ All whitespace, including newlines and indentation, inside the element
+ is returned as-is. If ``normalize_whitespace`` is given a true value,
+ then leading and trailing whitespace is stripped, newlines and tabs
+ converted to spaces, and multiple spaces collapsed into one. This is
+ especially useful when dealing with HTML data.
Examples using ``${XML}`` structure from `Example`:
| ${text} = | Get Element Text | ${XML} | first |
@@ -677,24 +731,28 @@ def get_element_text(self, source, xpath='.', normalize_whitespace=False):
`Element Text Should Match`.
"""
element = self.get_element(source, xpath)
- text = ''.join(self._yield_texts(element))
- if is_truthy(normalize_whitespace):
+ text = "".join(self._yield_texts(element))
+ if normalize_whitespace:
text = self._normalize_whitespace(text)
return text
- def _yield_texts(self, element, top=True):
+ def _yield_texts(self, element: Element, top: bool = True) -> "Iterator[str]":
if element.text:
yield element.text
for child in element:
- for text in self._yield_texts(child, top=False):
- yield text
+ yield from self._yield_texts(child, top=False)
if element.tail and not top:
yield element.tail
- def _normalize_whitespace(self, text):
- return ' '.join(text.split())
+ def _normalize_whitespace(self, text: str) -> str:
+ return " ".join(text.split())
- def get_elements_texts(self, source, xpath, normalize_whitespace=False):
+ def get_elements_texts(
+ self,
+ source: Source,
+ xpath: str,
+ normalize_whitespace: bool = False,
+ ) -> "list[str]":
"""Returns text of all elements matching ``xpath`` as a list.
The elements whose text to return is specified using ``source`` and
@@ -711,11 +769,19 @@ def get_elements_texts(self, source, xpath, normalize_whitespace=False):
| Should Be Equal | @{texts}[0] | more text | |
| Should Be Equal | @{texts}[1] | ${EMPTY} | |
"""
- return [self.get_element_text(elem, normalize_whitespace=normalize_whitespace)
- for elem in self.get_elements(source, xpath)]
-
- def element_text_should_be(self, source, expected, xpath='.',
- normalize_whitespace=False, message=None):
+ return [
+ self.get_element_text(elem, normalize_whitespace=normalize_whitespace)
+ for elem in self.get_elements(source, xpath)
+ ]
+
+ def element_text_should_be(
+ self,
+ source: Source,
+ expected: str,
+ xpath: str = ".",
+ normalize_whitespace: bool = False,
+ message: "str | None" = None,
+ ):
"""Verifies that the text of the specified element is ``expected``.
The element whose text is verified is specified using ``source`` and
@@ -741,8 +807,14 @@ def element_text_should_be(self, source, expected, xpath='.',
text = self.get_element_text(source, xpath, normalize_whitespace)
should_be_equal(text, expected, message, values=False)
- def element_text_should_match(self, source, pattern, xpath='.',
- normalize_whitespace=False, message=None):
+ def element_text_should_match(
+ self,
+ source: Source,
+ pattern: str,
+ xpath: str = ".",
+ normalize_whitespace: bool = False,
+ message: "str | None" = None,
+ ):
"""Verifies that the text of the specified element matches ``expected``.
This keyword works exactly like `Element Text Should Be` except that
@@ -761,8 +833,13 @@ def element_text_should_match(self, source, pattern, xpath='.',
text = self.get_element_text(source, xpath, normalize_whitespace)
should_match(text, pattern, message, values=False)
- @keyword(types=None)
- def get_element_attribute(self, source, name, xpath='.', default=None):
+ def get_element_attribute(
+ self,
+ source: Source,
+ name: str,
+ xpath: str = ".",
+ default: object = None,
+ ) -> "str | object":
"""Returns the named attribute of the specified element.
The element whose attribute to return is specified using ``source`` and
@@ -784,7 +861,11 @@ def get_element_attribute(self, source, name, xpath='.', default=None):
"""
return self.get_element(source, xpath).get(name, default)
- def get_element_attributes(self, source, xpath='.'):
+ def get_element_attributes(
+ self,
+ source: Source,
+ xpath: str = ".",
+ ) -> "dict[str, str]":
"""Returns all attributes of the specified element.
The element whose attributes to return is specified using ``source`` and
@@ -804,8 +885,14 @@ def get_element_attributes(self, source, xpath='.'):
"""
return dict(self.get_element(source, xpath).attrib)
- def element_attribute_should_be(self, source, name, expected, xpath='.',
- message=None):
+ def element_attribute_should_be(
+ self,
+ source: Source,
+ name: str,
+ expected: "str | None",
+ xpath: str = ".",
+ message: "str | None" = None,
+ ):
"""Verifies that the specified attribute is ``expected``.
The element whose attribute is verified is specified using ``source``
@@ -829,8 +916,14 @@ def element_attribute_should_be(self, source, name, expected, xpath='.',
attr = self.get_element_attribute(source, name, xpath)
should_be_equal(attr, expected, message, values=False)
- def element_attribute_should_match(self, source, name, pattern, xpath='.',
- message=None):
+ def element_attribute_should_match(
+ self,
+ source: Source,
+ name: str,
+ pattern: str,
+ xpath: str = ".",
+ message: "str | None" = None,
+ ):
"""Verifies that the specified attribute matches ``expected``.
This keyword works exactly like `Element Attribute Should Be` except
@@ -847,10 +940,16 @@ def element_attribute_should_match(self, source, name, pattern, xpath='.',
"""
attr = self.get_element_attribute(source, name, xpath)
if attr is None:
- raise AssertionError("Attribute '%s' does not exist." % name)
+ raise AssertionError(f"Attribute '{name}' does not exist.")
should_match(attr, pattern, message, values=False)
- def element_should_not_have_attribute(self, source, name, xpath='.', message=None):
+ def element_should_not_have_attribute(
+ self,
+ source: Source,
+ name: str,
+ xpath: str = ".",
+ message: "str | None" = None,
+ ):
"""Verifies that the specified element does not have attribute ``name``.
The element whose attribute is verified is specified using ``source``
@@ -869,11 +968,18 @@ def element_should_not_have_attribute(self, source, name, xpath='.', message=Non
"""
attr = self.get_element_attribute(source, name, xpath)
if attr is not None:
- raise AssertionError(message or "Attribute '%s' exists and "
- "has value '%s'." % (name, attr))
-
- def elements_should_be_equal(self, source, expected, exclude_children=False,
- normalize_whitespace=False):
+ raise AssertionError(
+ message or f"Attribute '{name}' exists and has value '{attr}'."
+ )
+
+ def elements_should_be_equal(
+ self,
+ source: Source,
+ expected: Source,
+ exclude_children: bool = False,
+ normalize_whitespace: bool = False,
+ sort_children: bool = False,
+ ):
"""Verifies that the given ``source`` element is equal to ``expected``.
Both ``source`` and ``expected`` can be given as a path to an XML file,
@@ -883,12 +989,14 @@ def elements_should_be_equal(self, source, expected, exclude_children=False,
The keyword passes if the ``source`` element and ``expected`` element
are equal. This includes testing the tag names, texts, and attributes
- of the elements. By default also child elements are verified the same
+ of the elements. By default, also child elements are verified the same
way, but this can be disabled by setting ``exclude_children`` to a
- true value (see `Boolean arguments`).
+ true value. Child elements are expected to
+ be in the same order, but that can be changed by giving ``sort_children``
+ a true value. Notice that elements are sorted solely based on tag names.
All texts inside the given elements are verified, but possible text
- outside them is not. By default texts must match exactly, but setting
+ outside them is not. By default, texts must match exactly, but setting
``normalize_whitespace`` to a true value makes text verification
independent on newlines, tabs, and the amount of spaces. For more
details about handling text see `Get Element Text` keyword and
@@ -908,12 +1016,26 @@ def elements_should_be_equal(self, source, expected, exclude_children=False,
the ``.`` at the end that is the `tail` text of the ```` element.
See also `Elements Should Match`.
- """
- self._compare_elements(source, expected, should_be_equal,
- exclude_children, normalize_whitespace)
- def elements_should_match(self, source, expected, exclude_children=False,
- normalize_whitespace=False):
+ ``sort_children`` is new in Robot Framework 7.0.
+ """
+ self._compare_elements(
+ source,
+ expected,
+ should_be_equal,
+ exclude_children,
+ sort_children,
+ normalize_whitespace,
+ )
+
+ def elements_should_match(
+ self,
+ source: Source,
+ expected: Source,
+ exclude_children: bool = False,
+ normalize_whitespace: bool = False,
+ sort_children: bool = False,
+ ):
"""Verifies that the given ``source`` element matches ``expected``.
This keyword works exactly like `Elements Should Be Equal` except that
@@ -930,17 +1052,38 @@ def elements_should_match(self, source, expected, exclude_children=False,
See `Elements Should Be Equal` for more examples.
"""
- self._compare_elements(source, expected, should_match,
- exclude_children, normalize_whitespace)
-
- def _compare_elements(self, source, expected, comparator, exclude_children,
- normalize_whitespace):
- normalizer = self._normalize_whitespace \
- if is_truthy(normalize_whitespace) else None
- comparator = ElementComparator(comparator, normalizer, exclude_children)
- comparator.compare(self.get_element(source), self.get_element(expected))
-
- def set_element_tag(self, source, tag, xpath='.'):
+ self._compare_elements(
+ source,
+ expected,
+ should_match,
+ exclude_children,
+ sort_children,
+ normalize_whitespace,
+ )
+
+ def _compare_elements(
+ self,
+ source: Source,
+ expected: Source,
+ comparator: Callable[[Any, Any, str], None],
+ exclude_children: bool,
+ sort_children: bool,
+ normalize_whitespace: bool,
+ ):
+ normalizer = self._normalize_whitespace if normalize_whitespace else None
+ sorter = self._sort_children if sort_children else None
+ element_comparator = ElementComparator(
+ comparator, normalizer, sorter, exclude_children
+ )
+ element_comparator.compare(self.get_element(source), self.get_element(expected))
+
+ def _sort_children(self, element: Element):
+ tails = [child.tail for child in element]
+ element[:] = sorted(element, key=lambda child: child.tag)
+ for child, tail in zip(element, tails):
+ child.tail = tail
+
+ def set_element_tag(self, source: Source, tag: str, xpath: str = ".") -> Element:
"""Sets the tag of the specified element.
The element whose tag to set is specified using ``source`` and
@@ -962,7 +1105,7 @@ def set_element_tag(self, source, tag, xpath='.'):
self.get_element(source, xpath).tag = tag
return source
- def set_elements_tag(self, source, tag, xpath='.'):
+ def set_elements_tag(self, source: Source, tag: str, xpath: str = ".") -> Element:
"""Sets the tag of the specified elements.
Like `Set Element Tag` but sets the tag of all elements matching
@@ -973,8 +1116,13 @@ def set_elements_tag(self, source, tag, xpath='.'):
self.set_element_tag(elem, tag)
return source
- @keyword(types=None)
- def set_element_text(self, source, text=None, tail=None, xpath='.'):
+ def set_element_text(
+ self,
+ source: Source,
+ text: "str | None" = None,
+ tail: "str | None" = None,
+ xpath: str = ".",
+ ) -> Element:
"""Sets text and/or tail text of the specified element.
The element whose text to set is specified using ``source`` and
@@ -1005,8 +1153,13 @@ def set_element_text(self, source, text=None, tail=None, xpath='.'):
element.tail = tail
return source
- @keyword(types=None)
- def set_elements_text(self, source, text=None, tail=None, xpath='.'):
+ def set_elements_text(
+ self,
+ source: Source,
+ text: "str | None" = None,
+ tail: "str | None" = None,
+ xpath: str = ".",
+ ) -> Element:
"""Sets text and/or tail text of the specified elements.
Like `Set Element Text` but sets the text or tail of all elements
@@ -1017,7 +1170,13 @@ def set_elements_text(self, source, text=None, tail=None, xpath='.'):
self.set_element_text(elem, text, tail)
return source
- def set_element_attribute(self, source, name, value, xpath='.'):
+ def set_element_attribute(
+ self,
+ source: Source,
+ name: str,
+ value: str,
+ xpath: str = ".",
+ ) -> Element:
"""Sets attribute ``name`` of the specified element to ``value``.
The element whose attribute to set is specified using ``source`` and
@@ -1039,12 +1198,18 @@ def set_element_attribute(self, source, name, value, xpath='.'):
Attribute` to set an attribute of multiple elements in one call.
"""
if not name:
- raise RuntimeError('Attribute name can not be empty.')
+ raise RuntimeError("Attribute name can not be empty.")
source = self.get_element(source)
self.get_element(source, xpath).attrib[name] = value
return source
- def set_elements_attribute(self, source, name, value, xpath='.'):
+ def set_elements_attribute(
+ self,
+ source: Source,
+ name: str,
+ value: str,
+ xpath: str = ".",
+ ) -> Element:
"""Sets attribute ``name`` of the specified elements to ``value``.
Like `Set Element Attribute` but sets the attribute of all elements
@@ -1055,7 +1220,12 @@ def set_elements_attribute(self, source, name, value, xpath='.'):
self.set_element_attribute(elem, name, value)
return source
- def remove_element_attribute(self, source, name, xpath='.'):
+ def remove_element_attribute(
+ self,
+ source: Source,
+ name: str,
+ xpath: str = ".",
+ ) -> Element:
"""Removes attribute ``name`` from the specified element.
The element whose attribute to remove is specified using ``source`` and
@@ -1080,7 +1250,12 @@ def remove_element_attribute(self, source, name, xpath='.'):
attrib.pop(name)
return source
- def remove_elements_attribute(self, source, name, xpath='.'):
+ def remove_elements_attribute(
+ self,
+ source: Source,
+ name: str,
+ xpath: str = ".",
+ ) -> Element:
"""Removes attribute ``name`` from the specified elements.
Like `Remove Element Attribute` but removes the attribute of all
@@ -1091,7 +1266,7 @@ def remove_elements_attribute(self, source, name, xpath='.'):
self.remove_element_attribute(elem, name)
return source
- def remove_element_attributes(self, source, xpath='.'):
+ def remove_element_attributes(self, source: Source, xpath: str = ".") -> Element:
"""Removes all attributes from the specified element.
The element whose attributes to remove is specified using ``source`` and
@@ -1113,7 +1288,7 @@ def remove_element_attributes(self, source, xpath='.'):
self.get_element(source, xpath).attrib.clear()
return source
- def remove_elements_attributes(self, source, xpath='.'):
+ def remove_elements_attributes(self, source: Source, xpath: str = ".") -> Element:
"""Removes all attributes from the specified elements.
Like `Remove Element Attributes` but removes all attributes of all
@@ -1124,7 +1299,13 @@ def remove_elements_attributes(self, source, xpath='.'):
self.remove_element_attributes(elem)
return source
- def add_element(self, source, element, index=None, xpath='.'):
+ def add_element(
+ self,
+ source: Source,
+ element: Source,
+ index: "int | None" = None,
+ xpath: str = ".",
+ ) -> Element:
"""Adds a child element to the specified element.
The element to whom to add the new element is specified using ``source``
@@ -1160,7 +1341,12 @@ def add_element(self, source, element, index=None, xpath='.'):
parent.insert(int(index), element)
return source
- def remove_element(self, source, xpath='', remove_tail=False):
+ def remove_element(
+ self,
+ source: Source,
+ xpath: str = "",
+ remove_tail: bool = False,
+ ) -> Element:
"""Removes the element matching ``xpath`` from the ``source`` structure.
The element to remove from the ``source`` is specified with ``xpath``
@@ -1172,9 +1358,8 @@ def remove_element(self, source, xpath='', remove_tail=False):
Use `Remove Elements` to remove all matched elements.
Element's tail text is not removed by default, but that can be changed
- by giving ``remove_tail`` a true value (see `Boolean arguments`). See
- `Element attributes` section for more information about `tail` in
- general.
+ by giving ``remove_tail`` a true value. See the `Element attributes`
+ section for more information about ``tail`` in general.
Examples using ``${XML}`` structure from `Example`:
| Remove Element | ${XML} | xpath=second |
@@ -1186,7 +1371,12 @@ def remove_element(self, source, xpath='', remove_tail=False):
self._remove_element(source, self.get_element(source, xpath), remove_tail)
return source
- def remove_elements(self, source, xpath='', remove_tail=False):
+ def remove_elements(
+ self,
+ source: Source,
+ xpath: str = "",
+ remove_tail: bool = False,
+ ) -> Element:
"""Removes all elements matching ``xpath`` from the ``source`` structure.
The elements to remove from the ``source`` are specified with ``xpath``
@@ -1210,30 +1400,40 @@ def remove_elements(self, source, xpath='', remove_tail=False):
self._remove_element(source, element, remove_tail)
return source
- def _remove_element(self, root, element, remove_tail=False):
+ def _remove_element(
+ self,
+ root: Element,
+ element: Element,
+ remove_tail: bool = False,
+ ):
parent = self._find_parent(root, element)
- if not is_truthy(remove_tail):
+ if not remove_tail:
self._preserve_tail(element, parent)
parent.remove(element)
- def _find_parent(self, root, element):
+ def _find_parent(self, root: Element, element: Element) -> Element:
for parent in root.iter():
for child in parent:
if child is element:
return parent
- raise RuntimeError('Cannot remove root element.')
+ raise RuntimeError("Cannot remove root element.")
- def _preserve_tail(self, element, parent):
+ def _preserve_tail(self, element: Element, parent: Element):
if not element.tail:
return
index = list(parent).index(element)
if index == 0:
- parent.text = (parent.text or '') + element.tail
+ parent.text = (parent.text or "") + element.tail
else:
- sibling = parent[index-1]
- sibling.tail = (sibling.tail or '') + element.tail
-
- def clear_element(self, source, xpath='.', clear_tail=False):
+ sibling = parent[index - 1]
+ sibling.tail = (sibling.tail or "") + element.tail
+
+ def clear_element(
+ self,
+ source: Source,
+ xpath: str = ".",
+ clear_tail: bool = False,
+ ) -> Element:
"""Clears the contents of the specified element.
The element to clear is specified using ``source`` and ``xpath``. They
@@ -1243,9 +1443,8 @@ def clear_element(self, source, xpath='.', clear_tail=False):
Clearing the element means removing its text, attributes, and children.
Element's tail text is not removed by default, but that can be changed
- by giving ``clear_tail`` a true value (see `Boolean arguments`). See
- `Element attributes` section for more information about tail in
- general.
+ by giving ``clear_tail`` a true value. See the `Element attributes`
+ section for more information about ``tail`` in general.
Examples using ``${XML}`` structure from `Example`:
| Clear Element | ${XML} | xpath=first |
@@ -1262,17 +1461,17 @@ def clear_element(self, source, xpath='.', clear_tail=False):
element = self.get_element(source, xpath)
tail = element.tail
element.clear()
- if not is_truthy(clear_tail):
+ if not clear_tail:
element.tail = tail
return source
- def copy_element(self, source, xpath='.'):
+ def copy_element(self, source: Source, xpath: str = ".") -> Element:
"""Returns a copy of the specified element.
The element to copy is specified using ``source`` and ``xpath``. They
have exactly the same semantics as with `Get Element` keyword.
- If the copy or the original element is modified afterwards, the changes
+ If the copy or the original element is modified afterward, the changes
have no effect on the other.
Examples using ``${XML}`` structure from `Example`:
@@ -1287,27 +1486,39 @@ def copy_element(self, source, xpath='.'):
"""
return copy.deepcopy(self.get_element(source, xpath))
- def element_to_string(self, source, xpath='.', encoding=None):
+ def element_to_string(
+ self,
+ source: Source,
+ xpath: str = ".",
+ encoding: "str | None" = None,
+ ) -> "bytes | str":
"""Returns the string representation of the specified element.
The element to convert to a string is specified using ``source`` and
``xpath``. They have exactly the same semantics as with `Get Element`
keyword.
- By default the string is returned as Unicode. If ``encoding`` argument
+ The string is returned as Unicode by default. If ``encoding`` argument
is given any value, the string is returned as bytes in the specified
encoding. The resulting string never contains the XML declaration.
See also `Log Element` and `Save XML`.
"""
source = self.get_element(source, xpath)
- string = self.etree.tostring(source, encoding='UTF-8').decode('UTF-8')
- string = self._xml_declaration.sub('', string).strip()
+ if self.lxml_etree:
+ source = self._ns_stripper.unstrip(source)
+ string = self.etree.tostring(source, encoding="UTF-8").decode("UTF-8")
+ string = re.sub(r"^<\?xml .*\?>", "", string).strip()
if encoding:
string = string.encode(encoding)
return string
- def log_element(self, source, level='INFO', xpath='.'):
+ def log_element(
+ self,
+ source: Source,
+ level: logger.LogLevel = "INFO",
+ xpath: str = ".",
+ ) -> str:
"""Logs the string representation of the specified element.
The element specified with ``source`` and ``xpath`` is first converted
@@ -1320,7 +1531,12 @@ def log_element(self, source, level='INFO', xpath='.'):
logger.write(string, level)
return string
- def save_xml(self, source, path, encoding='UTF-8'):
+ def save_xml(
+ self,
+ source: Source,
+ path: Path,
+ encoding: str = "UTF-8",
+ ):
"""Saves the given element to the specified file.
The element to save is specified with ``source`` using the same
@@ -1340,27 +1556,31 @@ def save_xml(self, source, path, encoding='UTF-8'):
Use `Element To String` if you just need a string representation of
the element.
"""
- path = os.path.abspath(path.replace('/', os.sep))
+ path = path.absolute()
elem = self.get_element(source)
tree = self.etree.ElementTree(elem)
- config = {'encoding': encoding}
+ config: "dict[str, object]" = {"encoding": encoding}
if self.modern_etree:
- config['xml_declaration'] = True
+ config["xml_declaration"] = True
if self.lxml_etree:
elem = self._ns_stripper.unstrip(elem)
# https://bugs.launchpad.net/lxml/+bug/1660433
- if tree.docinfo.doctype:
- config['doctype'] = tree.docinfo.doctype
+ if tree.docinfo.doctype: # type: ignore
+ config["doctype"] = tree.docinfo.doctype # type: ignore
tree = self.etree.ElementTree(elem)
- with open(path, 'wb') as output:
- if 'doctype' in config:
- output.write(self.etree.tostring(tree, **config))
+ with open(path, "wb") as output:
+ if "doctype" in config:
+ output.write(self.etree.tostring(tree, **config)) # type: ignore
else:
- tree.write(output, **config)
- logger.info('XML saved to %s.' % (path, path),
- html=True)
-
- def evaluate_xpath(self, source, expression, context='.'):
+ tree.write(output, **config) # type: ignore
+ logger.info(f'XML saved to {path}.', html=True)
+
+ def evaluate_xpath(
+ self,
+ source: Source,
+ expression: str,
+ context: str = ".",
+ ) -> object:
"""Evaluates the given xpath expression and returns results.
The element in which context the expression is executed is specified
@@ -1384,35 +1604,46 @@ def evaluate_xpath(self, source, expression, context='.'):
"""
if not self.lxml_etree:
raise RuntimeError("'Evaluate Xpath' keyword only works in lxml mode.")
- return self.get_element(source, context).xpath(expression)
+ return self.get_element(source, context).xpath(expression) # type: ignore
class NameSpaceStripper:
- def __init__(self, etree, lxml_etree=False):
+ def __init__(self, etree, lxml_etree: bool = False):
self.etree = etree
self.lxml_tree = lxml_etree
- def strip(self, elem, preserve=True, current_ns=None, top=True):
- if elem.tag.startswith('{') and '}' in elem.tag:
- ns, elem.tag = elem.tag[1:].split('}', 1)
+ def strip(
+ self,
+ elem: Element,
+ preserve: bool = True,
+ current_ns: "str | None" = None,
+ top: bool = True,
+ ):
+ if elem.tag.startswith("{") and "}" in elem.tag:
+ ns, elem.tag = elem.tag[1:].split("}", 1)
if preserve and ns != current_ns:
- elem.attrib['xmlns'] = ns
+ elem.attrib["xmlns"] = ns
current_ns = ns
elif current_ns:
- elem.attrib['xmlns'] = ''
+ elem.attrib["xmlns"] = ""
current_ns = None
for child in elem:
self.strip(child, preserve, current_ns, top=False)
if top and not preserve and self.lxml_tree:
- self.etree.cleanup_namespaces(elem)
-
- def unstrip(self, elem, current_ns=None, copied=False):
+ self.etree.cleanup_namespaces(elem) # type: ignore
+
+ def unstrip(
+ self,
+ elem: Element,
+ current_ns: "str | None" = None,
+ copied: bool = False,
+ ) -> Element:
if not copied:
elem = copy.deepcopy(elem)
- ns = elem.attrib.pop('xmlns', current_ns)
+ ns = elem.attrib.pop("xmlns", current_ns)
if ns:
- elem.tag = '{%s}%s' % (ns, elem.tag)
+ elem.tag = f"{{{ns}}}{elem.tag}"
for child in elem:
self.unstrip(child, ns, copied=True)
return elem
@@ -1420,44 +1651,78 @@ def unstrip(self, elem, current_ns=None, copied=False):
class ElementFinder:
- def __init__(self, etree, modern=True, lxml=False):
+ def __init__(
+ self,
+ etree,
+ modern: bool = True,
+ lxml: bool = False,
+ ):
self.etree = etree
self.modern = modern
self.lxml = lxml
- def find_all(self, elem, xpath):
+ def find_all(self, elem: Element, xpath: str) -> "list[Element]":
xpath = self._get_xpath(xpath)
- if xpath == '.': # ET < 1.3 does not support '.' alone.
+ if xpath == ".": # ET < 1.3 does not support '.' alone.
return [elem]
if not self.lxml:
return elem.findall(xpath)
- finder = self.etree.ETXPath(xpath)
+ finder = self.etree.ETXPath(xpath) # type: ignore
return finder(elem)
- def _get_xpath(self, xpath):
+ def _get_xpath(self, xpath: str) -> str:
if not xpath:
- raise RuntimeError('No xpath given.')
+ raise RuntimeError("No xpath given.")
if self.modern:
return xpath
try:
return str(xpath)
except UnicodeError:
- if not xpath.replace('/', '').isalnum():
- logger.warn('XPATHs containing non-ASCII characters and '
- 'other than tag names do not always work with '
- 'Python versions prior to 2.7. Verify results '
- 'manually and consider upgrading to 2.7.')
+ if not xpath.replace("/", "").isalnum():
+ logger.warn(
+ "XPATHs containing non-ASCII characters and other than tag "
+ "names do not always work with Python versions prior to 2.7. "
+ "Verify results manually and consider upgrading to 2.7."
+ )
return xpath
-class ElementComparator:
+class Location:
- def __init__(self, comparator, normalizer=None, exclude_children=False):
- self._comparator = comparator
- self._normalizer = normalizer or (lambda text: text)
- self._exclude_children = is_truthy(exclude_children)
+ def __init__(self, path: str, is_root: bool = True):
+ self.path = path
+ self.is_not_root = not is_root
+ self.children: "dict[str, int]" = {}
- def compare(self, actual, expected, location=None):
+ def child(self, tag: str) -> "Location":
+ if tag not in self.children:
+ self.children[tag] = 1
+ else:
+ self.children[tag] += 1
+ tag += f"[{self.children[tag]}]"
+ return Location(f"{self.path}/{tag}", is_root=False)
+
+
+class ElementComparator:
+
+ def __init__(
+ self,
+ comparator: Callable[[object, object, str], None],
+ normalizer: "Callable[[str], str] | None" = None,
+ child_sorter: "Callable[[Element], None] | None" = None,
+ exclude_children: bool = False,
+ ):
+ self.comparator = comparator
+ self.normalizer = normalizer or (lambda text: text)
+ self.child_sorter = child_sorter
+ self.exclude_children = exclude_children
+
+ def compare(
+ self,
+ actual: Element,
+ expected: Element,
+ location: "Location | None" = None,
+ ):
if not location:
location = Location(actual.tag)
self._compare_tags(actual, expected, location)
@@ -1465,56 +1730,82 @@ def compare(self, actual, expected, location=None):
self._compare_texts(actual, expected, location)
if location.is_not_root:
self._compare_tails(actual, expected, location)
- if not self._exclude_children:
+ if not self.exclude_children:
self._compare_children(actual, expected, location)
- def _compare_tags(self, actual, expected, location):
- self._compare(actual.tag, expected.tag, 'Different tag name', location,
- should_be_equal)
-
- def _compare(self, actual, expected, message, location, comparator=None):
+ def _compare_tags(self, actual: Element, expected: Element, location: Location):
+ self._compare(
+ actual.tag,
+ expected.tag,
+ "Different tag name",
+ location,
+ should_be_equal,
+ )
+
+ def _compare(
+ self,
+ actual: object,
+ expected: object,
+ message: str,
+ location: Location,
+ comparator: "Callable[[object, object, str], None] | None" = None,
+ ):
if location.is_not_root:
- message = "%s at '%s'" % (message, location.path)
+ message = f"{message} at '{location.path}'"
if not comparator:
- comparator = self._comparator
+ comparator = self.comparator
comparator(actual, expected, message)
- def _compare_attributes(self, actual, expected, location):
- self._compare(sorted(actual.attrib), sorted(expected.attrib),
- 'Different attribute names', location, should_be_equal)
+ def _compare_attributes(
+ self,
+ actual: Element,
+ expected: Element,
+ location: Location,
+ ):
+ self._compare(
+ sorted(actual.attrib),
+ sorted(expected.attrib),
+ "Different attribute names",
+ location,
+ should_be_equal,
+ )
for key in actual.attrib:
- self._compare(actual.attrib[key], expected.attrib[key],
- "Different value for attribute '%s'" % key, location)
-
- def _compare_texts(self, actual, expected, location):
- self._compare(self._text(actual.text), self._text(expected.text),
- 'Different text', location)
-
- def _text(self, text):
- return self._normalizer(text or '')
-
- def _compare_tails(self, actual, expected, location):
- self._compare(self._text(actual.tail), self._text(expected.tail),
- 'Different tail text', location)
-
- def _compare_children(self, actual, expected, location):
- self._compare(len(actual), len(expected), 'Different number of child elements',
- location, should_be_equal)
+ self._compare(
+ actual.attrib[key],
+ expected.attrib[key],
+ f"Different value for attribute '{key}'",
+ location,
+ )
+
+ def _compare_texts(self, actual: Element, expected: Element, location: Location):
+ self._compare(
+ self._text(actual.text),
+ self._text(expected.text),
+ "Different text",
+ location,
+ )
+
+ def _text(self, text: str) -> str:
+ return self.normalizer(text or "")
+
+ def _compare_tails(self, actual: Element, expected: Element, location: Location):
+ self._compare(
+ self._text(actual.tail),
+ self._text(expected.tail),
+ "Different tail text",
+ location,
+ )
+
+ def _compare_children(self, actual: Element, expected: Element, location: Location):
+ self._compare(
+ len(actual),
+ len(expected),
+ "Different number of child elements",
+ location,
+ should_be_equal,
+ )
+ if self.child_sorter:
+ self.child_sorter(actual)
+ self.child_sorter(expected)
for act, exp in zip(actual, expected):
self.compare(act, exp, location.child(act.tag))
-
-
-class Location:
-
- def __init__(self, path, is_root=True):
- self.path = path
- self.is_not_root = not is_root
- self._children = {}
-
- def child(self, tag):
- if tag not in self._children:
- self._children[tag] = 1
- else:
- self._children[tag] += 1
- tag += '[%d]' % self._children[tag]
- return Location('%s/%s' % (self.path, tag), is_root=False)
diff --git a/src/robot/libraries/__init__.py b/src/robot/libraries/__init__.py
index 5ab5ed45d02..0d6d1109b1b 100644
--- a/src/robot/libraries/__init__.py
+++ b/src/robot/libraries/__init__.py
@@ -26,6 +26,19 @@
the http://robotframework.org web site.
"""
-STDLIBS = frozenset(('BuiltIn', 'Collections', 'DateTime', 'Dialogs', 'Easter',
- 'OperatingSystem', 'Process', 'Remote', 'Reserved',
- 'Screenshot', 'String', 'Telnet', 'XML'))
+STDLIBS = frozenset(
+ (
+ "BuiltIn",
+ "Collections",
+ "DateTime",
+ "Dialogs",
+ "Easter",
+ "OperatingSystem",
+ "Process",
+ "Remote",
+ "Screenshot",
+ "String",
+ "Telnet",
+ "XML",
+ )
+)
diff --git a/src/robot/libraries/dialogs_py.py b/src/robot/libraries/dialogs_py.py
index 7c0fd2cec68..464cbf44fdf 100644
--- a/src/robot/libraries/dialogs_py.py
+++ b/src/robot/libraries/dialogs_py.py
@@ -13,184 +13,245 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import sys
-from threading import current_thread
import time
-
-try:
- from Tkinter import (Button, Entry, Frame, Label, Listbox, TclError,
- Toplevel, Tk, BOTH, END, LEFT, W)
-except ImportError:
- from tkinter import (Button, Entry, Frame, Label, Listbox, TclError,
- Toplevel, Tk, BOTH, END, LEFT, W)
-
-
-class _TkDialog(Toplevel):
- _left_button = 'OK'
- _right_button = 'Cancel'
-
- def __init__(self, message, value=None, **extra):
- self._prevent_execution_with_timeouts()
- self._parent = self._get_parent()
- Toplevel.__init__(self, self._parent)
+import tkinter as tk
+from collections.abc import Sequence
+from importlib.resources import read_binary
+
+from robot.utils import WINDOWS
+
+if WINDOWS:
+ # A hack to override the default taskbar icon on Windows. See, for example:
+ # https://stackoverflow.com/questions/1551605/how-to-set-applications-taskbar-icon-in-windows-7/1552105
+ from ctypes import windll
+
+ windll.shell32.SetCurrentProcessExplicitAppUserModelID("robot.dialogs")
+
+
+class TkDialog(tk.Toplevel):
+ left_button = "OK"
+ right_button = "Cancel"
+ font = (None, 12)
+ padding = 8 if WINDOWS else 16
+ background = None # Can be used to change the dialog background.
+
+ def __init__(
+ self,
+ message: str,
+ value: "str | Sequence[str] | None" = None,
+ **config,
+ ):
+ super().__init__(self._get_root())
+ self._button_bindings = {}
self._initialize_dialog()
- self._create_body(message, value, **extra)
+ self.widget = self._create_body(message, value, **config)
self._create_buttons()
+ self._finalize_dialog()
self._result = None
+ self._closed = False
- def _prevent_execution_with_timeouts(self):
- if 'linux' not in sys.platform and current_thread().name != 'MainThread':
- raise RuntimeError('Dialogs library is not supported with '
- 'timeouts on Python on this platform.')
-
- def _get_parent(self):
- parent = Tk()
- parent.withdraw()
- return parent
+ def _get_root(self) -> tk.Tk:
+ root = tk.Tk()
+ root.withdraw()
+ icon = tk.PhotoImage(master=root, data=read_binary("robot", "logo.png"))
+ root.iconphoto(True, icon)
+ return root
def _initialize_dialog(self):
- self.title('Robot Framework')
- self.grab_set()
+ self.withdraw() # Remove from display until finalized.
+ self.title("Robot Framework")
+ self.configure(padx=self.padding, background=self.background)
self.protocol("WM_DELETE_WINDOW", self._close)
self.bind("", self._close)
- self.minsize(250, 80)
- self.geometry("+%d+%d" % self._get_center_location())
- self._bring_to_front()
-
- def grab_set(self, timeout=30):
- maxtime = time.time() + timeout
- while time.time() < maxtime:
- try:
- # Fails at least on Linux if mouse is hold down.
- return Toplevel.grab_set(self)
- except TclError:
- pass
- raise RuntimeError('Failed to open dialog in %s seconds. One possible '
- 'reason is holding down mouse button.' % timeout)
-
- def _get_center_location(self):
- x = (self.winfo_screenwidth() - self.winfo_reqwidth()) // 2
- y = (self.winfo_screenheight() - self.winfo_reqheight()) // 2
- return x, y
-
- def _bring_to_front(self):
+ if self.left_button == TkDialog.left_button:
+ self.bind("", self._left_button_clicked)
+
+ def _finalize_dialog(self):
+ self.update() # Needed to get accurate dialog size.
+ screen_width = self.winfo_screenwidth()
+ screen_height = self.winfo_screenheight()
+ min_width = screen_width // 5
+ min_height = screen_height // 8
+ width = max(self.winfo_reqwidth(), min_width)
+ height = max(self.winfo_reqheight(), min_height)
+ x = (screen_width - width) // 2
+ y = (screen_height - height) // 2
+ self.geometry(f"{width}x{height}+{x}+{y}")
self.lift()
- self.attributes('-topmost', True)
- self.after_idle(self.attributes, '-topmost', False)
-
- def _create_body(self, message, value, **extra):
- frame = Frame(self)
- Label(frame, text=message, anchor=W, justify=LEFT, wraplength=800).pack(fill=BOTH)
- selector = self._create_selector(frame, value, **extra)
- if selector:
- selector.pack(fill=BOTH)
- selector.focus_set()
- frame.pack(padx=5, pady=5, expand=1, fill=BOTH)
-
- def _create_selector(self, frame, value):
+ self.deiconify()
+ if self.widget:
+ self.widget.focus_set()
+
+ def _create_body(
+ self,
+ message: str,
+ value: "str | Sequence[str] | None",
+ **config,
+ ) -> "tk.Entry|tk.Listbox|None":
+ frame = tk.Frame(self, background=self.background)
+ max_width = self.winfo_screenwidth() // 2
+ label = tk.Label(
+ frame,
+ text=message,
+ anchor=tk.W,
+ justify=tk.LEFT,
+ wraplength=max_width,
+ pady=self.padding,
+ background=self.background,
+ font=self.font,
+ )
+ label.pack(fill=tk.BOTH)
+ widget = self._create_widget(frame, value, **config)
+ if widget:
+ widget.pack(fill=tk.BOTH, pady=self.padding)
+ frame.pack(expand=1, fill=tk.BOTH)
+ return widget
+
+ def _create_widget(self, parent, value, **config) -> "tk.Entry | tk.Listbox | None":
return None
def _create_buttons(self):
- frame = Frame(self)
- self._create_button(frame, self._left_button,
- self._left_button_clicked)
- self._create_button(frame, self._right_button,
- self._right_button_clicked)
+ frame = tk.Frame(self, pady=self.padding, background=self.background)
+ self._create_button(frame, self.left_button, self._left_button_clicked)
+ self._create_button(frame, self.right_button, self._right_button_clicked)
frame.pack()
def _create_button(self, parent, label, callback):
if label:
- button = Button(parent, text=label, width=10, command=callback)
- button.pack(side=LEFT, padx=5, pady=5)
+ button = tk.Button(
+ parent,
+ text=label,
+ command=callback,
+ width=10,
+ underline=0,
+ font=self.font,
+ )
+ button.pack(side=tk.LEFT, padx=self.padding)
+ for char in label[0].upper(), label[0].lower():
+ self.bind(char, callback)
+ self._button_bindings[char] = callback
def _left_button_clicked(self, event=None):
if self._validate_value():
self._result = self._get_value()
self._close()
- def _validate_value(self):
+ def _validate_value(self) -> bool:
return True
- def _get_value(self):
+ def _get_value(self) -> "str | list[str] | bool | None":
return None
- def _close(self, event=None):
- # self.destroy() is not enough on Linux
- self._parent.destroy()
-
def _right_button_clicked(self, event=None):
self._result = self._get_right_button_value()
self._close()
- def _get_right_button_value(self):
+ def _get_right_button_value(self) -> "str | list[str] | bool | None":
return None
- def show(self):
- self.wait_window(self)
+ def _close(self, event=None):
+ self._closed = True
+
+ def show(self) -> "str | list[str] | bool | None":
+ # Use a loop with `update()` instead of `wait_window()` to allow
+ # timeouts and signals stop execution.
+ try:
+ while not self._closed:
+ time.sleep(0.1)
+ self.update()
+ finally:
+ self.destroy()
+ self.update() # Needed on Linux to close the dialog (#1466, #4993)
return self._result
-class MessageDialog(_TkDialog):
- _right_button = None
-
+class MessageDialog(TkDialog):
+ right_button = None
-class InputDialog(_TkDialog):
- def __init__(self, message, default='', hidden=False):
- _TkDialog.__init__(self, message, default, hidden=hidden)
+class InputDialog(TkDialog):
- def _create_selector(self, parent, default, hidden):
- self._entry = Entry(parent, show='*' if hidden else '')
- self._entry.insert(0, default)
- self._entry.select_range(0, END)
- return self._entry
+ def __init__(self, message: str, default: str = "", hidden: bool = False):
+ super().__init__(message, default, hidden=hidden)
- def _get_value(self):
- return self._entry.get()
+ def _create_widget(self, parent, default, hidden=False) -> tk.Entry:
+ widget = tk.Entry(parent, show="*" if hidden else "", font=self.font)
+ widget.insert(0, default)
+ widget.select_range(0, tk.END)
+ widget.bind("", self._unbind_buttons)
+ widget.bind("", self._rebind_buttons)
+ return widget
+ def _unbind_buttons(self, event):
+ for char in self._button_bindings:
+ self.unbind(char)
-class SelectionDialog(_TkDialog):
+ def _rebind_buttons(self, event):
+ for char, callback in self._button_bindings.items():
+ self.bind(char, callback)
- def __init__(self, message, values):
- _TkDialog.__init__(self, message, values)
-
- def _create_selector(self, parent, values):
- self._listbox = Listbox(parent)
- for item in values:
- self._listbox.insert(END, item)
- self._listbox.config(width=0)
- return self._listbox
+ def _get_value(self) -> str:
+ return self.widget.get()
- def _validate_value(self):
- return bool(self._listbox.curselection())
- def _get_value(self):
- return self._listbox.get(self._listbox.curselection())
+class SelectionDialog(TkDialog):
+ def __init__(
+ self,
+ message: str,
+ values: "Sequence[str]",
+ default: "str | int | None" = None,
+ ):
+ super().__init__(message, values, default=default)
-class MultipleSelectionDialog(_TkDialog):
-
- def __init__(self, message, values):
- _TkDialog.__init__(self, message, values)
-
- def _create_selector(self, parent, values):
- self._listbox = Listbox(parent, selectmode='multiple')
+ def _create_widget(self, parent, values, default=None) -> tk.Listbox:
+ widget = tk.Listbox(parent, font=self.font)
+ for item in values:
+ widget.insert(tk.END, item)
+ if default is not None:
+ index = self._get_default_value_index(default, values)
+ widget.select_set(index)
+ widget.activate(index)
+ widget.config(width=0)
+ return widget
+
+ def _get_default_value_index(self, default, values) -> int:
+ if default in values:
+ return values.index(default)
+ try:
+ index = int(default) - 1
+ except ValueError:
+ raise ValueError(f"Invalid default value '{default}'.")
+ if index < 0 or index >= len(values):
+ raise ValueError("Default value index is out of bounds.")
+ return index
+
+ def _validate_value(self) -> bool:
+ return bool(self.widget.curselection())
+
+ def _get_value(self) -> str:
+ return self.widget.get(self.widget.curselection())
+
+
+class MultipleSelectionDialog(TkDialog):
+
+ def _create_widget(self, parent, values) -> tk.Listbox:
+ widget = tk.Listbox(parent, selectmode="multiple", font=self.font)
for item in values:
- self._listbox.insert(END, item)
- self._listbox.config(width=0)
- return self._listbox
+ widget.insert(tk.END, item)
+ widget.config(width=0)
+ return widget
- def _get_value(self):
- selected_values = [self._listbox.get(i) for i in self._listbox.curselection()]
- return selected_values
+ def _get_value(self) -> "list[str]":
+ return [self.widget.get(i) for i in self.widget.curselection()]
-class PassFailDialog(_TkDialog):
- _left_button = 'PASS'
- _right_button = 'FAIL'
+class PassFailDialog(TkDialog):
+ left_button = "PASS"
+ right_button = "FAIL"
- def _get_value(self):
+ def _get_value(self) -> bool:
return True
- def _get_right_button_value(self):
+ def _get_right_button_value(self) -> bool:
return False
diff --git a/src/robot/libraries/normalizer.py b/src/robot/libraries/normalizer.py
new file mode 100644
index 00000000000..d5ac3fd164b
--- /dev/null
+++ b/src/robot/libraries/normalizer.py
@@ -0,0 +1,144 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+from collections.abc import Mapping, Sequence
+from typing import Any, Literal, Union
+
+IgnoreCase = Union[Literal["KEY", "KEYS", "VALUE", "VALUES"], bool]
+StripSpaces = Union[Literal["LEADING", "TRAILING"], bool]
+
+
+class Normalizer:
+
+ def __init__(
+ self,
+ ignore_case: IgnoreCase = False,
+ strip_spaces: StripSpaces = False,
+ collapse_spaces: bool = False,
+ ignore_order: bool = False,
+ ignore_keys: "Sequence | None" = None,
+ ):
+ self.ignore_case = bool(ignore_case)
+ if isinstance(ignore_case, str):
+ self.ignore_key_case = ignore_case.upper() not in ("VALUE", "VALUES")
+ self.ignore_value_case = ignore_case.upper() not in ("KEY", "KEYS")
+ else:
+ self.ignore_key_case = self.ignore_value_case = self.ignore_case
+ if isinstance(strip_spaces, str):
+ self.strip_leading_spaces = strip_spaces.upper() != "TRAILING"
+ self.strip_trailing_spaces = strip_spaces.upper() != "LEADING"
+ else:
+ self.strip_leading_spaces = self.strip_trailing_spaces = bool(strip_spaces)
+ self.collapse_spaces = collapse_spaces
+ self.ignore_order = ignore_order
+ self.ignore_keys = self._parse_ignored_keys(ignore_keys)
+
+ def _parse_ignored_keys(self, ignore_keys: "Sequence | None") -> set:
+ if not ignore_keys:
+ return set()
+ return {self.normalize_key(k) for k in ignore_keys}
+
+ def normalize(self, value: Any, mapping_to_list: bool = False) -> Any:
+ if not self:
+ return value
+ if isinstance(value, str):
+ return self.normalize_string(value)
+ if isinstance(value, (bytes, bytearray)):
+ return self.normalize_bytes(value)
+ if isinstance(value, Mapping):
+ if mapping_to_list:
+ return self.normalize_list(list(value))
+ return self.normalize_dict(value)
+ if isinstance(value, Sequence):
+ return self.normalize_list(value)
+ return value
+
+ def normalize_string(self, value: str) -> str:
+ if self.ignore_case:
+ value = value.casefold()
+ if self.strip_leading_spaces:
+ value = value.lstrip()
+ if self.strip_trailing_spaces:
+ value = value.rstrip()
+ if self.collapse_spaces:
+ value = re.sub(r"\s+", " ", value)
+ return value
+
+ def normalize_bytes(self, value: "bytes | bytearray") -> "bytes | bytearray":
+ if self.ignore_case:
+ value = value.lower()
+ if self.strip_leading_spaces:
+ value = value.lstrip()
+ if self.strip_trailing_spaces:
+ value = value.rstrip()
+ if self.collapse_spaces:
+ value = re.sub(rb"\s+", b" ", value)
+ return value
+
+ def normalize_list(self, value: Sequence) -> Sequence:
+ cls = type(value)
+ value_list = [self.normalize(v) for v in value]
+ if self.ignore_order:
+ value_list = sorted(value_list)
+ return self._try_to_preserve_type(value_list, cls)
+
+ def _try_to_preserve_type(self, value: Any, cls: type) -> Any:
+ # Try to preserve original type. Most importantly, preserve tuples to
+ # allow using them as dictionary keys.
+ try:
+ return cls(value)
+ except TypeError:
+ return value
+
+ def normalize_dict(self, value: Mapping) -> Mapping:
+ cls = type(value)
+ result = {}
+ for key in value:
+ normalized = self.normalize_key(key)
+ if normalized in self.ignore_keys:
+ continue
+ if normalized in result:
+ raise AssertionError(
+ f"Dictionary {value} contains multiple keys that are normalized "
+ f"to '{normalized}'. Try normalizing only dictionary values like "
+ f"'ignore_case=values'."
+ )
+ result[normalized] = self.normalize_value(value[key])
+ return self._try_to_preserve_type(result, cls)
+
+ def normalize_key(self, key: object) -> object:
+ ignore_case, self.ignore_case = self.ignore_case, self.ignore_key_case
+ try:
+ return self.normalize(key)
+ finally:
+ self.ignore_case = ignore_case
+
+ def normalize_value(self, value: object) -> object:
+ ignore_case, self.ignore_case = self.ignore_case, self.ignore_value_case
+ try:
+ return self.normalize(value)
+ finally:
+ self.ignore_case = ignore_case
+
+ def __bool__(self) -> bool:
+ return bool(
+ self.ignore_case
+ or self.strip_leading_spaces
+ or self.strip_trailing_spaces
+ or self.collapse_spaces
+ or self.ignore_order
+ or getattr(self, "ignore_keys", False)
+ )
diff --git a/src/robot/libraries/py.typed b/src/robot/libraries/py.typed
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/src/robot/logo.png b/src/robot/logo.png
new file mode 100644
index 00000000000..346b814f4aa
Binary files /dev/null and b/src/robot/logo.png differ
diff --git a/src/robot/model/__init__.py b/src/robot/model/__init__.py
index de57774cc5f..8e1b8af6427 100644
--- a/src/robot/model/__init__.py
+++ b/src/robot/model/__init__.py
@@ -25,17 +25,42 @@
This package is considered stable.
"""
-from .body import BaseBody, Body, BodyItem, Branches
-from .configurer import SuiteConfigurer
-from .control import For, While, If, IfBranch, Try, TryBranch, Return, Continue, Break
-from .testsuite import TestSuite
-from .testcase import TestCase
-from .keyword import Keyword, Keywords
-from .message import Message, Messages
-from .modifier import ModelModifier
-from .tags import Tags, TagPattern, TagPatterns
-from .namepatterns import SuiteNamePatterns, TestNamePatterns
-from .visitor import SuiteVisitor
-from .totalstatistics import TotalStatisticsBuilder
-from .statistics import Statistics
-from .itemlist import ItemList
+from .body import (
+ BaseBody as BaseBody,
+ BaseBranches as BaseBranches,
+ BaseIterations as BaseIterations,
+ Body as Body,
+ BodyItem as BodyItem,
+)
+from .configurer import SuiteConfigurer as SuiteConfigurer
+from .control import (
+ Break as Break,
+ Continue as Continue,
+ Error as Error,
+ For as For,
+ ForIteration as ForIteration,
+ Group as Group,
+ If as If,
+ IfBranch as IfBranch,
+ Return as Return,
+ Try as Try,
+ TryBranch as TryBranch,
+ Var as Var,
+ While as While,
+ WhileIteration as WhileIteration,
+)
+from .fixture import create_fixture as create_fixture
+from .itemlist import ItemList as ItemList
+from .keyword import Keyword as Keyword
+from .message import Message as Message, MessageLevel as MessageLevel
+from .modelobject import DataDict as DataDict, ModelObject as ModelObject
+from .modifier import ModelModifier as ModelModifier
+from .statistics import Statistics as Statistics
+from .tags import TagPattern as TagPattern, TagPatterns as TagPatterns, Tags as Tags
+from .testcase import TestCase as TestCase, TestCases as TestCases
+from .testsuite import TestSuite as TestSuite, TestSuites as TestSuites
+from .totalstatistics import (
+ TotalStatistics as TotalStatistics,
+ TotalStatisticsBuilder as TotalStatisticsBuilder,
+)
+from .visitor import SuiteVisitor as SuiteVisitor
diff --git a/src/robot/model/body.py b/src/robot/model/body.py
index b51b4f9d245..612b98e67e8 100644
--- a/src/robot/model/body.py
+++ b/src/robot/model/body.py
@@ -14,91 +14,135 @@
# limitations under the License.
import re
+from typing import (
+ Any, Callable, cast, Generic, Iterable, Type, TYPE_CHECKING, TypeVar, Union
+)
+
+from robot.errors import DataError
+from robot.utils import copy_signature, KnownAtRuntime
from .itemlist import ItemList
-from .modelobject import ModelObject, full_name
+from .modelobject import DataDict, full_name, ModelObject
+
+if TYPE_CHECKING:
+ from robot.running.model import ResourceFile, UserKeyword
+
+ from .control import (
+ Break, Continue, Error, For, ForIteration, Group, If, IfBranch, Return, Try,
+ TryBranch, Var, While, WhileIteration
+ )
+ from .keyword import Keyword
+ from .message import Message
+ from .testcase import TestCase
+ from .testsuite import TestSuite
+
+
+BodyItemParent = Union[
+ "TestSuite", "TestCase", "UserKeyword", "For", "ForIteration", "If", "IfBranch",
+ "Try", "TryBranch", "While", "Group", "WhileIteration", "Keyword", "Var",
+ "Return", "Continue", "Break", "Error", None
+] # fmt: skip
+BI = TypeVar("BI", bound="BodyItem")
+KW = TypeVar("KW", bound="Keyword")
+F = TypeVar("F", bound="For")
+W = TypeVar("W", bound="While")
+G = TypeVar("G", bound="Group")
+I = TypeVar("I", bound="If") # noqa: E741
+T = TypeVar("T", bound="Try")
+V = TypeVar("V", bound="Var")
+R = TypeVar("R", bound="Return")
+C = TypeVar("C", bound="Continue")
+B = TypeVar("B", bound="Break")
+M = TypeVar("M", bound="Message")
+E = TypeVar("E", bound="Error")
+IT = TypeVar("IT", bound="IfBranch|TryBranch")
+FW = TypeVar("FW", bound="ForIteration|WhileIteration")
class BodyItem(ModelObject):
- KEYWORD = 'KEYWORD'
- SETUP = 'SETUP'
- TEARDOWN = 'TEARDOWN'
- FOR = 'FOR'
- ITERATION = 'ITERATION'
- IF_ELSE_ROOT = 'IF/ELSE ROOT'
- IF = 'IF'
- ELSE_IF = 'ELSE IF'
- ELSE = 'ELSE'
- TRY_EXCEPT_ROOT = 'TRY/EXCEPT ROOT'
- TRY = 'TRY'
- EXCEPT = 'EXCEPT'
- FINALLY = 'FINALLY'
- WHILE = 'WHILE'
- RETURN = 'RETURN'
- CONTINUE = 'CONTINUE'
- BREAK = 'BREAK'
- MESSAGE = 'MESSAGE'
- type = None
- __slots__ = ['parent']
+ body: "BaseBody"
+ __slots__ = ("parent",)
@property
- def id(self):
+ def id(self) -> "str|None":
"""Item id in format like ``s1-t3-k1``.
See :attr:`TestSuite.id ` for
more information.
+
+ ``id`` is ``None`` only in these special cases:
+
+ - Keyword uses a placeholder for ``setup`` or ``teardown`` when
+ a ``setup`` or ``teardown`` is not actually used.
+ - With :class:`~robot.model.control.If` and :class:`~robot.model.control.Try`
+ instances representing IF/TRY structure roots.
"""
- # This algorithm must match the id creation algorithm in the JavaScript side
- # or linking to warnings and errors won't work.
- if not self:
- return None
- if not self.parent:
- return 'k1'
return self._get_id(self.parent)
- def _get_id(self, parent):
+ def _get_id(self, parent: "BodyItemParent|ResourceFile") -> str:
+ if not parent:
+ return "k1"
+ # This algorithm must match the id creation algorithm in the JavaScript side
+ # or linking to warnings and errors won't work.
steps = []
- if parent.has_setup:
+ if getattr(parent, "has_setup", False):
steps.append(parent.setup)
- if hasattr(parent, 'body'):
- steps.extend(step for step in parent.body.flatten()
- if step.type != self.MESSAGE)
- if parent.has_teardown:
+ if hasattr(parent, "body"):
+ steps.extend(parent.body.flatten(messages=False))
+ if getattr(parent, "has_teardown", False):
steps.append(parent.teardown)
- return '%s-k%d' % (parent.id, steps.index(self) + 1)
-
- @property
- def has_setup(self):
- return False
+ index = steps.index(self) if self in steps else len(steps)
+ pid = parent.id # IF/TRY root id is None. Avoid calling property twice.
+ return f"{pid}-k{index + 1}" if pid else f"k{index + 1}"
- @property
- def has_teardown(self):
- return False
+ def to_dict(self) -> DataDict:
+ raise NotImplementedError
-class BaseBody(ItemList):
+class BaseBody(ItemList[BodyItem], Generic[KW, F, W, G, I, T, V, R, C, B, M, E]):
"""Base class for Body and Branches objects."""
- __slots__ = []
- # Set using 'Body.register' when these classes are created.
- keyword_class = None
- for_class = None
- if_class = None
- try_class = None
- while_class = None
- return_class = None
- continue_class = None
- break_class = None
- message_class = None
-
- def __init__(self, parent=None, items=None):
- super().__init__(BodyItem, {'parent': parent}, items)
+
+ # Set using 'BaseBody.register' when these classes are created.
+ keyword_class: Type[KW] = KnownAtRuntime
+ for_class: Type[F] = KnownAtRuntime
+ while_class: Type[W] = KnownAtRuntime
+ group_class: Type[G] = KnownAtRuntime
+ if_class: Type[I] = KnownAtRuntime
+ try_class: Type[T] = KnownAtRuntime
+ var_class: Type[V] = KnownAtRuntime
+ return_class: Type[R] = KnownAtRuntime
+ continue_class: Type[C] = KnownAtRuntime
+ break_class: Type[B] = KnownAtRuntime
+ message_class: Type[M] = KnownAtRuntime
+ error_class: Type[E] = KnownAtRuntime
+ __slots__ = ()
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ items: "Iterable[BodyItem|DataDict]" = (),
+ ):
+ super().__init__(BodyItem, {"parent": parent}, items)
+
+ def _item_from_dict(self, data: DataDict) -> BodyItem:
+ item_type = data.get("type", None)
+ if item_type is None:
+ item_class = self.keyword_class
+ elif item_type == BodyItem.IF_ELSE_ROOT:
+ item_class = self.if_class
+ elif item_type == BodyItem.TRY_EXCEPT_ROOT:
+ item_class = self.try_class
+ else:
+ item_class = getattr(self, item_type.lower() + "_class")
+ item_class = cast(Type[BodyItem], item_class)
+ return item_class.from_dict(data)
@classmethod
- def register(cls, item_class):
- name_parts = re.findall('([A-Z][a-z]+)', item_class.__name__) + ['class']
- name = '_'.join(name_parts).lower()
+ def register(cls, item_class: Type[BI]) -> Type[BI]:
+ name_parts = [*re.findall("([A-Z][a-z]+)", item_class.__name__), "class"]
+ name = "_".join(name_parts).lower()
if not hasattr(cls, name):
- raise TypeError("Cannot register '%s'." % name)
+ raise TypeError(f"Cannot register '{name}'.")
setattr(cls, name, item_class)
return item_class
@@ -109,39 +153,71 @@ def create(self):
f"Use item specific methods like 'create_keyword' instead."
)
- def create_keyword(self, *args, **kwargs):
- return self._create(self.keyword_class, 'create_keyword', args, kwargs)
-
- def _create(self, cls, name, args, kwargs):
- if cls is None:
+ def _create(
+ self,
+ cls: "Type[BI]",
+ name: str,
+ args: "tuple[Any, ...]",
+ kwargs: "dict[str, Any]",
+ ) -> BI:
+ if cls is KnownAtRuntime:
raise TypeError(f"'{full_name(self)}' object does not support '{name}'.")
- return self.append(cls(*args, **kwargs))
-
- def create_for(self, *args, **kwargs):
- return self._create(self.for_class, 'create_for', args, kwargs)
-
- def create_if(self, *args, **kwargs):
- return self._create(self.if_class, 'create_if', args, kwargs)
-
- def create_try(self, *args, **kwargs):
- return self._create(self.try_class, 'create_try', args, kwargs)
-
- def create_while(self, *args, **kwargs):
- return self._create(self.while_class, 'create_while', args, kwargs)
-
- def create_return(self, *args, **kwargs):
- return self._create(self.return_class, 'create_return', args, kwargs)
-
- def create_continue(self, *args, **kwargs):
- return self._create(self.continue_class, 'create_continue', args, kwargs)
-
- def create_break(self, *args, **kwargs):
- return self._create(self.break_class, 'create_break', args, kwargs)
-
- def create_message(self, *args, **kwargs):
- return self._create(self.message_class, 'create_message', args, kwargs)
-
- def filter(self, keywords=None, messages=None, predicate=None):
+ return self.append(cls(*args, **kwargs)) # type: ignore
+
+ @copy_signature(keyword_class)
+ def create_keyword(self, *args, **kwargs) -> keyword_class:
+ return self._create(self.keyword_class, "create_keyword", args, kwargs)
+
+ @copy_signature(for_class)
+ def create_for(self, *args, **kwargs) -> for_class:
+ return self._create(self.for_class, "create_for", args, kwargs)
+
+ @copy_signature(if_class)
+ def create_if(self, *args, **kwargs) -> if_class:
+ return self._create(self.if_class, "create_if", args, kwargs)
+
+ @copy_signature(try_class)
+ def create_try(self, *args, **kwargs) -> try_class:
+ return self._create(self.try_class, "create_try", args, kwargs)
+
+ @copy_signature(while_class)
+ def create_while(self, *args, **kwargs) -> while_class:
+ return self._create(self.while_class, "create_while", args, kwargs)
+
+ @copy_signature(group_class)
+ def create_group(self, *args, **kwargs) -> group_class:
+ return self._create(self.group_class, "create_group", args, kwargs)
+
+ @copy_signature(var_class)
+ def create_var(self, *args, **kwargs) -> var_class:
+ return self._create(self.var_class, "create_var", args, kwargs)
+
+ @copy_signature(return_class)
+ def create_return(self, *args, **kwargs) -> return_class:
+ return self._create(self.return_class, "create_return", args, kwargs)
+
+ @copy_signature(continue_class)
+ def create_continue(self, *args, **kwargs) -> continue_class:
+ return self._create(self.continue_class, "create_continue", args, kwargs)
+
+ @copy_signature(break_class)
+ def create_break(self, *args, **kwargs) -> break_class:
+ return self._create(self.break_class, "create_break", args, kwargs)
+
+ @copy_signature(message_class)
+ def create_message(self, *args, **kwargs) -> message_class:
+ return self._create(self.message_class, "create_message", args, kwargs)
+
+ @copy_signature(error_class)
+ def create_error(self, *args, **kwargs) -> error_class:
+ return self._create(self.error_class, "create_error", args, kwargs)
+
+ def filter(
+ self,
+ keywords: "bool|None" = None,
+ messages: "bool|None" = None,
+ predicate: "Callable[[T], bool]|None" = None,
+ ) -> "list[BodyItem]":
"""Filter body items based on type and/or custom predicate.
To include or exclude items based on types, give matching arguments
@@ -165,17 +241,11 @@ def filter(self, keywords=None, messages=None, predicate=None):
use ``body.filter(keywords=False``, messages=False)``. For more detailed
filtering it is possible to use ``predicate``.
"""
- if messages is not None and not self.message_class:
- raise TypeError(f"'{full_name(self)}' object does not support "
- f"filtering by 'messages'.")
- return self._filter([(self.keyword_class, keywords),
- (self.message_class, messages)], predicate)
-
- def _filter(self, types, predicate):
- include = tuple(cls for cls, activated in types if activated is True and cls)
- exclude = tuple(cls for cls, activated in types if activated is False and cls)
+ by_type = [(self.keyword_class, keywords), (self.message_class, messages)]
+ include = tuple(cls for cls, activated in by_type if activated is True and cls)
+ exclude = tuple(cls for cls, activated in by_type if activated is False and cls)
if include and exclude:
- raise ValueError('Items cannot be both included and excluded by type.')
+ raise ValueError("Items cannot be both included and excluded by type.")
items = list(self)
if include:
items = [item for item in items if isinstance(item, include)]
@@ -185,37 +255,93 @@ def _filter(self, types, predicate):
items = [item for item in items if predicate(item)]
return items
- def flatten(self):
+ def flatten(self, **filter_config) -> "list[BodyItem]":
"""Return steps so that IF and TRY structures are flattened.
Basically the IF/ELSE and TRY/EXCEPT root elements are replaced
- with their branches. This is how they are shown in log files.
+ with their branches. This is how they are shown in the log file.
+
+ ``filter_config`` can be used to filter steps using the :meth:`filter`
+ method before flattening. New in Robot Framework 7.2.
"""
roots = BodyItem.IF_ELSE_ROOT, BodyItem.TRY_EXCEPT_ROOT
- steps = []
- for item in self:
+ steps = self if not filter_config else self.filter(**filter_config)
+ flat = []
+ for item in steps:
if item.type in roots:
- steps.extend(item.body)
+ flat.extend(item.body)
else:
- steps.append(item)
- return steps
+ flat.append(item)
+ return flat
-class Body(BaseBody):
- """A list-like object representing body of a suite, a test or a keyword.
+class Body(BaseBody[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error"
+]): # fmt: skip
+ """A list-like object representing a body of a test, keyword, etc.
Body contains the keywords and other structures such as FOR loops.
"""
- pass
+ __slots__ = ()
+
+
+# BaseBranches cannot extend Generic[IT] directly with BaseBody[...].
+class BranchType(Generic[IT]):
+ __slots__ = ()
+
+
+class BaseBranches(BaseBody[KW, F, W, G, I, T, V, R, C, B, M, E], BranchType[IT]):
+ """A list-like object representing IF and TRY branches."""
-class Branches(BaseBody):
- """A list-like object representing branches IF and TRY objects contain."""
- __slots__ = ['branch_class']
+ branch_type: Type[IT] = KnownAtRuntime
+ __slots__ = ("branch_class",)
- def __init__(self, branch_class, parent=None, items=None):
+ def __init__(
+ self,
+ branch_class: Type[IT],
+ parent: BodyItemParent = None,
+ items: "Iterable[IT|DataDict]" = (),
+ ):
self.branch_class = branch_class
super().__init__(parent, items)
- def create_branch(self, *args, **kwargs):
- return self.append(self.branch_class(*args, **kwargs))
+ def _item_from_dict(self, data: DataDict) -> BodyItem:
+ try:
+ return self.branch_class.from_dict(data)
+ except DataError:
+ return super()._item_from_dict(data)
+
+ @copy_signature(branch_type)
+ def create_branch(self, *args, **kwargs) -> IT:
+ return self._create(self.branch_class, "create_branch", args, kwargs)
+
+
+# BaseIterations cannot extend Generic[IT] directly with BaseBody[...].
+class IterationType(Generic[FW]):
+ __slots__ = ()
+
+
+class BaseIterations(BaseBody[KW, F, W, G, I, T, V, R, C, B, M, E], IterationType[FW]):
+ iteration_type: Type[FW] = KnownAtRuntime
+ __slots__ = ("iteration_class",)
+
+ def __init__(
+ self,
+ iteration_class: Type[FW],
+ parent: BodyItemParent = None,
+ items: "Iterable[FW|DataDict]" = (),
+ ):
+ self.iteration_class = iteration_class
+ super().__init__(parent, items)
+
+ def _item_from_dict(self, data: DataDict) -> BodyItem:
+ # Non-iteration data is typically caused by listeners.
+ if data.get("type") != "ITERATION":
+ return super()._item_from_dict(data)
+ return self.iteration_class.from_dict(data)
+
+ @copy_signature(iteration_type)
+ def create_iteration(self, *args, **kwargs) -> FW:
+ return self._create(self.iteration_class, "iteration_class", args, kwargs)
diff --git a/src/robot/model/configurer.py b/src/robot/model/configurer.py
index 23c1c2869db..e8a639f1953 100644
--- a/src/robot/model/configurer.py
+++ b/src/robot/model/configurer.py
@@ -13,17 +13,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import seq2str
from robot.errors import DataError
+from robot.utils import seq2str
from .visitor import SuiteVisitor
class SuiteConfigurer(SuiteVisitor):
- def __init__(self, name=None, doc=None, metadata=None, set_tags=None,
- include_tags=None, exclude_tags=None, include_suites=None,
- include_tests=None, empty_suite_ok=False):
+ def __init__(
+ self,
+ name=None,
+ doc=None,
+ metadata=None,
+ set_tags=None,
+ include_tags=None,
+ exclude_tags=None,
+ include_suites=None,
+ include_tests=None,
+ empty_suite_ok=False,
+ ):
self.name = name
self.doc = doc
self.metadata = metadata
@@ -36,11 +45,11 @@ def __init__(self, name=None, doc=None, metadata=None, set_tags=None,
@property
def add_tags(self):
- return [t for t in self.set_tags if not t.startswith('-')]
+ return [t for t in self.set_tags if not t.startswith("-")]
@property
def remove_tags(self):
- return [t[1:] for t in self.set_tags if t.startswith('-')]
+ return [t[1:] for t in self.set_tags if t.startswith("-")]
def visit_suite(self, suite):
self._set_suite_attributes(suite)
@@ -57,33 +66,44 @@ def _set_suite_attributes(self, suite):
def _filter(self, suite):
name = suite.name
- suite.filter(self.include_suites, self.include_tests,
- self.include_tags, self.exclude_tags)
- if not (suite.test_count or self.empty_suite_ok):
- self._raise_no_tests_error(name, suite.rpa)
+ suite.filter(
+ self.include_suites,
+ self.include_tests,
+ self.include_tags,
+ self.exclude_tags,
+ )
+ if not (suite.has_tests or self.empty_suite_ok):
+ self._raise_no_tests_or_tasks_error(name, suite.rpa)
- def _raise_no_tests_error(self, suite, rpa=False):
- parts = ['tests' if not rpa else 'tasks',
- self._get_test_selector_msgs(),
- self._get_suite_selector_msg()]
- raise DataError("Suite '%s' contains no %s."
- % (suite, ' '.join(p for p in parts if p)))
+ def _raise_no_tests_or_tasks_error(self, name, rpa):
+ parts = [
+ {False: "tests", True: "tasks", None: "tests or tasks"}[rpa],
+ self._get_test_selector_msgs(),
+ self._get_suite_selector_msg(),
+ ]
+ raise DataError(
+ f"Suite '{name}' contains no {' '.join(p for p in parts if p)}."
+ )
def _get_test_selector_msgs(self):
parts = []
- for explanation, selector in [('matching tags', self.include_tags),
- ('not matching tags', self.exclude_tags),
- ('matching name', self.include_tests)]:
- if selector:
- parts.append(self._format_selector_msg(explanation, selector))
- return seq2str(parts, quote='')
+ for separator, explanation, selectors in [
+ (None, "matching name", self.include_tests),
+ ("and", "matching tags", self.include_tags),
+ ("and", "not matching tags", self.exclude_tags),
+ ]:
+ if selectors:
+ if parts:
+ parts.append(separator)
+ parts.append(self._format_selector_msg(explanation, selectors))
+ return " ".join(parts)
- def _format_selector_msg(self, explanation, selector):
- if len(selector) == 1 and explanation[-1] == 's':
+ def _format_selector_msg(self, explanation, selectors):
+ if len(selectors) == 1 and explanation[-1] == "s":
explanation = explanation[:-1]
- return '%s %s' % (explanation, seq2str(selector, lastsep=' or '))
+ return f"{explanation} {seq2str(selectors, lastsep=' or ')}"
def _get_suite_selector_msg(self):
if not self.include_suites:
- return ''
- return self._format_selector_msg('in suites', self.include_suites)
+ return ""
+ return self._format_selector_msg("in suites", self.include_suites)
diff --git a/src/robot/model/control.py b/src/robot/model/control.py
index ce20b859ca9..9c118f558bb 100644
--- a/src/robot/model/control.py
+++ b/src/robot/model/control.py
@@ -13,260 +13,630 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import warnings
+from collections import OrderedDict
+from typing import Any, cast, Literal, Mapping, Sequence, TYPE_CHECKING, TypeVar
+
from robot.utils import setter
-from .body import Body, BodyItem, Branches
-from .keyword import Keywords
+from .body import BaseBranches, BaseIterations, Body, BodyItem, BodyItemParent
+from .modelobject import DataDict
+from .visitor import SuiteVisitor
+
+if TYPE_CHECKING:
+ from .keyword import Keyword
+ from .message import Message
+
+
+IT = TypeVar("IT", bound="IfBranch|TryBranch")
+FW = TypeVar("FW", bound="ForIteration|WhileIteration")
+
+
+class Branches(BaseBranches[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error", IT
+]): # fmt: skip
+ __slots__ = ()
+
+
+class Iterations(BaseIterations[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error", FW
+]): # fmt: skip
+ __slots__ = ()
+
+
+class ForIteration(BodyItem):
+ """Represents one FOR loop iteration."""
+
+ type = BodyItem.ITERATION
+ body_class = Body
+ repr_args = ("assign",)
+ __slots__ = ("assign", "message", "status")
+
+ def __init__(
+ self,
+ assign: "Mapping[str, str]|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ self.assign = OrderedDict(assign or ())
+ self.parent = parent
+ self.body = ()
+
+ @property
+ def variables(self) -> "Mapping[str, str]": # TODO: Remove in RF 8.0.
+ """Deprecated since Robot Framework 7.0. Use :attr:`assign` instead."""
+ warnings.warn(
+ "'ForIteration.variables' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'ForIteration.assign' instead."
+ )
+ return self.assign
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ return self.body_class(self, body)
+
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_for_iteration(self)
+
+ @property
+ def _log_name(self):
+ return ", ".join(f"{name} = {value}" for name, value in self.assign.items())
+
+ def to_dict(self) -> DataDict:
+ return {
+ "type": self.type,
+ "assign": dict(self.assign),
+ "body": self.body.to_dicts(),
+ }
@Body.register
class For(BodyItem):
+ """Represents ``FOR`` loops."""
+
type = BodyItem.FOR
body_class = Body
- repr_args = ('variables', 'flavor', 'values')
- __slots__ = ['variables', 'flavor', 'values']
-
- def __init__(self, variables=(), flavor='IN', values=(), parent=None):
- self.variables = variables
+ repr_args = ("assign", "flavor", "values", "start", "mode", "fill")
+ __slots__ = ("assign", "flavor", "values", "start", "mode", "fill")
+
+ def __init__(
+ self,
+ assign: Sequence[str] = (),
+ flavor: Literal["IN", "IN RANGE", "IN ENUMERATE", "IN ZIP"] = "IN",
+ values: Sequence[str] = (),
+ start: "str|None" = None,
+ mode: "str|None" = None,
+ fill: "str|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ self.assign = tuple(assign)
self.flavor = flavor
- self.values = values
+ self.values = tuple(values)
+ self.start = start
+ self.mode = mode
+ self.fill = fill
self.parent = parent
- self.body = None
-
- @setter
- def body(self, body):
- return self.body_class(self, body)
+ self.body = ()
@property
- def keywords(self):
- """Deprecated since Robot Framework 4.0. Use :attr:`body` instead."""
- return Keywords(self, self.body)
+ def variables(self) -> "tuple[str, ...]": # TODO: Remove in RF 8.0.
+ """Deprecated since Robot Framework 7.0. Use :attr:`assign` instead."""
+ warnings.warn(
+ "'For.variables' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'For.assign' instead."
+ )
+ return self.assign
+
+ @variables.setter
+ def variables(self, assign: "tuple[str, ...]"):
+ warnings.warn(
+ "'For.variables' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'For.assign' instead."
+ )
+ self.assign = assign
- @keywords.setter
- def keywords(self, keywords):
- Keywords.raise_deprecation_error()
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ return self.body_class(self, body)
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_for(self)
+ def to_dict(self) -> DataDict:
+ data = {
+ "type": self.type,
+ "assign": self.assign,
+ "flavor": self.flavor,
+ "values": self.values,
+ }
+ for name, value in [
+ ("start", self.start),
+ ("mode", self.mode),
+ ("fill", self.fill),
+ ]:
+ if value is not None:
+ data[name] = value
+ data["body"] = self.body.to_dicts()
+ return data
+
def __str__(self):
- variables = ' '.join(self.variables)
- values = ' '.join(self.values)
- return 'FOR %s %s %s' % (variables, self.flavor, values)
+ parts = ["FOR", *self.assign, self.flavor, *self.values]
+ for name, value in [
+ ("start", self.start),
+ ("mode", self.mode),
+ ("fill", self.fill),
+ ]:
+ if value is not None:
+ parts.append(f"{name}={value}")
+ return " ".join(parts)
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return value is not None or name in ("assign", "flavor", "values")
+
+
+class WhileIteration(BodyItem):
+ """Represents one WHILE loop iteration."""
+
+ type = BodyItem.ITERATION
+ body_class = Body
+ __slots__ = ()
+
+ def __init__(self, parent: BodyItemParent = None):
+ self.parent = parent
+ self.body = ()
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ return self.body_class(self, body)
+
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_while_iteration(self)
+
+ def to_dict(self) -> DataDict:
+ return {"type": self.type, "body": self.body.to_dicts()}
@Body.register
class While(BodyItem):
+ """Represents ``WHILE`` loops."""
+
type = BodyItem.WHILE
body_class = Body
- repr_args = ('condition', 'limit')
- __slots__ = ['condition', 'limit']
-
- def __init__(self, condition=None, limit=None, parent=None):
+ repr_args = ("condition", "limit", "on_limit", "on_limit_message")
+ __slots__ = ("condition", "limit", "on_limit", "on_limit_message")
+
+ def __init__(
+ self,
+ condition: "str|None" = None,
+ limit: "str|None" = None,
+ on_limit: "str|None" = None,
+ on_limit_message: "str|None" = None,
+ parent: BodyItemParent = None,
+ ):
self.condition = condition
+ self.on_limit = on_limit
self.limit = limit
+ self.on_limit_message = on_limit_message
self.parent = parent
- self.body = None
+ self.body = ()
@setter
- def body(self, body):
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
return self.body_class(self, body)
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_while(self)
- def __str__(self):
- return f'WHILE {self.condition}' + (f' {self.limit}' if self.limit else '')
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return name == "condition" or value is not None
+
+ def to_dict(self) -> DataDict:
+ data: DataDict = {"type": self.type}
+ for name, value in [
+ ("condition", self.condition),
+ ("limit", self.limit),
+ ("on_limit", self.on_limit),
+ ("on_limit_message", self.on_limit_message),
+ ]:
+ if value is not None:
+ data[name] = value
+ data["body"] = self.body.to_dicts()
+ return data
+
+ def __str__(self) -> str:
+ parts = ["WHILE"]
+ if self.condition is not None:
+ parts.append(self.condition)
+ if self.limit is not None:
+ parts.append(f"limit={self.limit}")
+ if self.on_limit is not None:
+ parts.append(f"on_limit={self.on_limit}")
+ if self.on_limit_message is not None:
+ parts.append(f"on_limit_message={self.on_limit_message}")
+ return " ".join(parts)
-class IfBranch(BodyItem):
+@Body.register
+class Group(BodyItem):
+ """Represents ``GROUP``."""
+
+ type = BodyItem.GROUP
body_class = Body
- repr_args = ('type', 'condition')
- __slots__ = ['type', 'condition']
+ repr_args = ("name",)
+ __slots__ = ("name",)
+
+ def __init__(self, name: str = "", parent: BodyItemParent = None):
+ self.name = name
+ self.parent = parent
+ self.body = ()
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ return self.body_class(self, body)
+
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_group(self)
+
+ def to_dict(self) -> DataDict:
+ return {"type": self.type, "name": self.name, "body": self.body.to_dicts()}
+
+ def __str__(self) -> str:
+ parts = ["GROUP"]
+ if self.name:
+ parts.append(self.name)
+ return " ".join(parts)
- def __init__(self, type=BodyItem.IF, condition=None, parent=None):
+
+class IfBranch(BodyItem):
+ """Represents individual ``IF``, ``ELSE IF`` or ``ELSE`` branch."""
+
+ body_class = Body
+ repr_args = ("type", "condition")
+ __slots__ = ("type", "condition")
+
+ def __init__(
+ self,
+ type: str = BodyItem.IF,
+ condition: "str|None" = None,
+ parent: BodyItemParent = None,
+ ):
self.type = type
self.condition = condition
self.parent = parent
- self.body = None
+ self.body = ()
@setter
- def body(self, body):
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
return self.body_class(self, body)
@property
- def id(self):
+ def id(self) -> str:
"""Branch id omits IF/ELSE root from the parent id part."""
if not self.parent:
- return 'k1'
+ return "k1"
if not self.parent.parent:
- return 'k%d' % (self.parent.body.index(self) + 1)
+ return self._get_id(self.parent)
return self._get_id(self.parent.parent)
- def __str__(self):
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_if_branch(self)
+
+ def to_dict(self) -> DataDict:
+ data = {"type": self.type}
+ if self.condition:
+ data["condition"] = self.condition
+ data["body"] = self.body.to_dicts()
+ return data
+
+ def __str__(self) -> str:
if self.type == self.IF:
- return 'IF %s' % self.condition
+ return f"IF {self.condition}"
if self.type == self.ELSE_IF:
- return 'ELSE IF %s' % self.condition
- return 'ELSE'
-
- def visit(self, visitor):
- visitor.visit_if_branch(self)
+ return f"ELSE IF {self.condition}"
+ return "ELSE"
@Body.register
class If(BodyItem):
"""IF/ELSE structure root. Branches are stored in :attr:`body`."""
+
type = BodyItem.IF_ELSE_ROOT
branch_class = IfBranch
- branches_class = Branches
- __slots__ = ['parent']
+ branches_class = Branches[branch_class]
+ __slots__ = ()
- def __init__(self, parent=None):
+ def __init__(self, parent: BodyItemParent = None):
self.parent = parent
- self.body = None
+ self.body = ()
@setter
- def body(self, branches):
+ def body(self, branches: "Sequence[BodyItem|DataDict]") -> branches_class:
return self.branches_class(self.branch_class, self, branches)
@property
- def id(self):
+ def id(self) -> None:
"""Root IF/ELSE id is always ``None``."""
return None
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_if(self)
+ def to_dict(self) -> DataDict:
+ return {"type": self.type, "body": self.body.to_dicts()}
+
class TryBranch(BodyItem):
- body_class = Body
- repr_args = ('type', 'patterns', 'pattern_type', 'variable')
- __slots__ = ['type', 'patterns', 'pattern_type', 'variable']
+ """Represents individual ``TRY``, ``EXCEPT``, ``ELSE`` or ``FINALLY`` branch."""
- def __init__(self, type=BodyItem.TRY, patterns=(), pattern_type=None,
- variable=None, parent=None):
- if (patterns or pattern_type or variable) and type != BodyItem.EXCEPT:
- raise TypeError(f"'{type}' branches do not accept patterns or variables.")
+ body_class = Body
+ repr_args = ("type", "patterns", "pattern_type", "assign")
+ __slots__ = ("type", "patterns", "pattern_type", "assign")
+
+ def __init__(
+ self,
+ type: str = BodyItem.TRY,
+ patterns: Sequence[str] = (),
+ pattern_type: "str|None" = None,
+ assign: "str|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ if (patterns or pattern_type or assign) and type != BodyItem.EXCEPT:
+ raise TypeError(f"'{type}' branches do not accept patterns or assignment.")
self.type = type
- self.patterns = patterns
+ self.patterns = tuple(patterns)
self.pattern_type = pattern_type
- self.variable = variable
+ self.assign = assign
self.parent = parent
- self.body = None
+ self.body = ()
+
+ @property
+ def variable(self) -> "str|None": # TODO: Remove in RF 8.0.
+ """Deprecated since Robot Framework 7.0. Use :attr:`assign` instead."""
+ warnings.warn(
+ "'TryBranch.variable' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'TryBranch.assign' instead."
+ )
+ return self.assign
+
+ @variable.setter
+ def variable(self, assign: "str|None"):
+ warnings.warn(
+ "'TryBranch.variable' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'TryBranch.assign' instead."
+ )
+ self.assign = assign
@setter
- def body(self, body):
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
return self.body_class(self, body)
@property
- def id(self):
+ def id(self) -> str:
"""Branch id omits TRY/EXCEPT root from the parent id part."""
if not self.parent:
- return 'k1'
+ return "k1"
if not self.parent.parent:
- return 'k%d' % (self.parent.body.index(self) + 1)
+ return self._get_id(self.parent)
return self._get_id(self.parent.parent)
- def __str__(self):
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_try_branch(self)
+
+ def to_dict(self) -> DataDict:
+ data: DataDict = {"type": self.type}
+ if self.type == self.EXCEPT:
+ data["patterns"] = self.patterns
+ if self.pattern_type:
+ data["pattern_type"] = self.pattern_type
+ if self.assign:
+ data["assign"] = self.assign
+ data["body"] = self.body.to_dicts()
+ return data
+
+ def __str__(self) -> str:
if self.type != BodyItem.EXCEPT:
return self.type
- parts = ['EXCEPT'] + list(self.patterns)
+ parts = ["EXCEPT", *self.patterns]
if self.pattern_type:
- parts.append(f'type={self.pattern_type}')
- if self.variable:
- parts.extend(['AS', self.variable])
- return ' '.join(parts)
-
- def __repr__(self):
- repr_args = self.repr_args if self.type == BodyItem.EXCEPT else ['type']
- return self._repr(repr_args)
+ parts.append(f"type={self.pattern_type}")
+ if self.assign:
+ parts.extend(["AS", self.assign])
+ return " ".join(parts)
- def visit(self, visitor):
- visitor.visit_try_branch(self)
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return bool(value)
@Body.register
class Try(BodyItem):
"""TRY/EXCEPT structure root. Branches are stored in :attr:`body`."""
+
type = BodyItem.TRY_EXCEPT_ROOT
branch_class = TryBranch
- branches_class = Branches
- __slots__ = []
+ branches_class = Branches[branch_class]
+ __slots__ = ()
- def __init__(self, parent=None):
+ def __init__(self, parent: BodyItemParent = None):
self.parent = parent
- self.body = None
+ self.body = ()
@setter
- def body(self, branches):
+ def body(self, branches: "Sequence[TryBranch|DataDict]") -> branches_class:
return self.branches_class(self.branch_class, self, branches)
@property
- def try_branch(self):
+ def try_branch(self) -> TryBranch:
if self.body and self.body[0].type == BodyItem.TRY:
- return self.body[0]
+ return cast(TryBranch, self.body[0])
raise TypeError("No 'TRY' branch or 'TRY' branch is not first.")
@property
- def except_branches(self):
- return [branch for branch in self.body if branch.type == BodyItem.EXCEPT]
+ def except_branches(self) -> "list[TryBranch]":
+ return [
+ cast(TryBranch, branch)
+ for branch in self.body
+ if branch.type == BodyItem.EXCEPT
+ ]
@property
- def else_branch(self):
+ def else_branch(self) -> "TryBranch|None":
for branch in self.body:
if branch.type == BodyItem.ELSE:
- return branch
+ return cast(TryBranch, branch)
return None
@property
- def finally_branch(self):
+ def finally_branch(self) -> "TryBranch|None":
if self.body and self.body[-1].type == BodyItem.FINALLY:
- return self.body[-1]
+ return cast(TryBranch, self.body[-1])
return None
@property
- def id(self):
+ def id(self) -> None:
"""Root TRY/EXCEPT id is always ``None``."""
return None
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_try(self)
+ def to_dict(self) -> DataDict:
+ return {"type": self.type, "body": self.body.to_dicts()}
+
+
+@Body.register
+class Var(BodyItem):
+ """Represents ``VAR``."""
+
+ type = BodyItem.VAR
+ repr_args = ("name", "value", "scope", "separator")
+ __slots__ = ("name", "value", "scope", "separator")
+
+ def __init__(
+ self,
+ name: str = "",
+ value: "str|Sequence[str]" = (),
+ scope: "str|None" = None,
+ separator: "str|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ self.name = name
+ self.value = (value,) if isinstance(value, str) else tuple(value)
+ self.scope = scope
+ self.separator = separator
+ self.parent = parent
+
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_var(self)
+
+ def to_dict(self) -> DataDict:
+ data = {"type": self.type, "name": self.name, "value": self.value}
+ if self.scope is not None:
+ data["scope"] = self.scope
+ if self.separator is not None:
+ data["separator"] = self.separator
+ return data
+
+ def __str__(self):
+ parts = ["VAR", self.name, *self.value]
+ if self.separator is not None:
+ parts.append(f"separator={self.separator}")
+ if self.scope is not None:
+ parts.append(f"scope={self.scope}")
+ return " ".join(parts)
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return value is not None or name in ("name", "value")
+
@Body.register
class Return(BodyItem):
+ """Represents ``RETURN``."""
+
type = BodyItem.RETURN
- repr_args = ('values',)
- __slots__ = ['values']
+ repr_args = ("values",)
+ __slots__ = ("values",)
- def __init__(self, values=(), parent=None):
- self.values = values
+ def __init__(self, values: Sequence[str] = (), parent: BodyItemParent = None):
+ self.values = tuple(values)
self.parent = parent
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_return(self)
+ def to_dict(self) -> DataDict:
+ data = {"type": self.type}
+ if self.values:
+ data["values"] = self.values
+ return data
+
+ def __str__(self):
+ return " ".join(["RETURN", *self.values])
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return bool(value)
+
@Body.register
class Continue(BodyItem):
+ """Represents ``CONTINUE``."""
+
type = BodyItem.CONTINUE
- __slots__ = []
+ __slots__ = ()
- def __init__(self, parent=None):
+ def __init__(self, parent: BodyItemParent = None):
self.parent = parent
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_continue(self)
+ def to_dict(self) -> DataDict:
+ return {"type": self.type}
+
+ def __str__(self):
+ return "CONTINUE"
+
@Body.register
class Break(BodyItem):
+ """Represents ``BREAK``."""
+
type = BodyItem.BREAK
- __slots__ = []
+ __slots__ = ()
- def __init__(self, parent=None):
+ def __init__(self, parent: BodyItemParent = None):
self.parent = parent
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
visitor.visit_break(self)
+
+ def to_dict(self) -> DataDict:
+ return {"type": self.type}
+
+ def __str__(self):
+ return "BREAK"
+
+
+@Body.register
+class Error(BodyItem):
+ """Represents syntax error in data.
+
+ For example, an invalid setting like ``[Setpu]`` or ``END`` in wrong place.
+ """
+
+ type = BodyItem.ERROR
+ repr_args = ("values",)
+ __slots__ = ("values",)
+
+ def __init__(self, values: Sequence[str] = (), parent: BodyItemParent = None):
+ self.values = tuple(values)
+ self.parent = parent
+
+ def visit(self, visitor: SuiteVisitor):
+ visitor.visit_error(self)
+
+ def to_dict(self) -> DataDict:
+ return {"type": self.type, "values": self.values}
+
+ def __str__(self):
+ return " ".join(["ERROR", *self.values])
diff --git a/src/robot/model/filter.py b/src/robot/model/filter.py
index 4b81a99763a..c352a936dad 100644
--- a/src/robot/model/filter.py
+++ b/src/robot/model/filter.py
@@ -13,33 +13,45 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Sequence, TYPE_CHECKING
+
from robot.utils import setter
+from .namepatterns import NamePatterns
from .tags import TagPatterns
-from .namepatterns import SuiteNamePatterns, TestNamePatterns
from .visitor import SuiteVisitor
+if TYPE_CHECKING:
+ from .keyword import Keyword
+ from .testcase import TestCase
+ from .testsuite import TestSuite
+
class EmptySuiteRemover(SuiteVisitor):
- def __init__(self, preserve_direct_children=False):
+ def __init__(self, preserve_direct_children: bool = False):
self.preserve_direct_children = preserve_direct_children
- def end_suite(self, suite):
+ def end_suite(self, suite: "TestSuite"):
if suite.parent or not self.preserve_direct_children:
suite.suites = [s for s in suite.suites if s.test_count]
- def visit_test(self, test):
+ def visit_test(self, test: "TestCase"):
pass
- def visit_keyword(self, kw):
+ def visit_keyword(self, keyword: "Keyword"):
pass
class Filter(EmptySuiteRemover):
- def __init__(self, include_suites=None, include_tests=None,
- include_tags=None, exclude_tags=None):
+ def __init__(
+ self,
+ include_suites: "NamePatterns|Sequence[str]|None" = None,
+ include_tests: "NamePatterns|Sequence[str]|None" = None,
+ include_tags: "TagPatterns|Sequence[str]|None" = None,
+ exclude_tags: "TagPatterns|Sequence[str]|None" = None,
+ ):
super().__init__()
self.include_suites = include_suites
self.include_tests = include_tests
@@ -47,19 +59,19 @@ def __init__(self, include_suites=None, include_tests=None,
self.exclude_tags = exclude_tags
@setter
- def include_suites(self, suites):
- return self._patterns_or_none(suites, SuiteNamePatterns)
+ def include_suites(self, suites) -> "NamePatterns|None":
+ return self._patterns_or_none(suites, NamePatterns)
@setter
- def include_tests(self, tests):
- return self._patterns_or_none(tests, TestNamePatterns)
+ def include_tests(self, tests) -> "NamePatterns|None":
+ return self._patterns_or_none(tests, NamePatterns)
@setter
- def include_tags(self, tags):
+ def include_tags(self, tags) -> "TagPatterns|None":
return self._patterns_or_none(tags, TagPatterns)
@setter
- def exclude_tags(self, tags):
+ def exclude_tags(self, tags) -> "TagPatterns|None":
return self._patterns_or_none(tags, TagPatterns)
def _patterns_or_none(self, items, pattern_class):
@@ -67,44 +79,44 @@ def _patterns_or_none(self, items, pattern_class):
return items
return pattern_class(items)
- def start_suite(self, suite):
+ def start_suite(self, suite: "TestSuite"):
if not self:
return False
- if hasattr(suite, 'starttime'):
- suite.starttime = suite.endtime = None
+ if hasattr(suite, "start_time"):
+ suite.start_time = suite.end_time = suite.elapsed_time = None
if self.include_suites is not None:
- return self._filter_by_suite_name(suite)
- if self.include_tests is not None:
- suite.tests = self._filter(suite, self._included_by_test_name)
- if self.include_tags is not None:
- suite.tests = self._filter(suite, self._included_by_tags)
- if self.exclude_tags is not None:
- suite.tests = self._filter(suite, self._not_excluded_by_tags)
+ return self._filter_based_on_suite_name(suite)
+ self._filter_tests(suite)
return bool(suite.suites)
- def _filter_by_suite_name(self, suite):
- if self.include_suites.match(suite.name, suite.longname):
- suite.visit(Filter(include_tests=self.include_tests,
- include_tags=self.include_tags,
- exclude_tags=self.exclude_tags))
+ def _filter_based_on_suite_name(self, suite: "TestSuite") -> bool:
+ if self.include_suites.match(suite.name, suite.full_name):
+ suite.visit(
+ Filter(
+ include_tests=self.include_tests,
+ include_tags=self.include_tags,
+ exclude_tags=self.exclude_tags,
+ )
+ )
return False
suite.tests = []
return True
- def _filter(self, suite, filter):
- return [t for t in suite.tests if filter(t)]
-
- def _included_by_test_name(self, test):
- return self.include_tests.match(test.name, test.longname)
-
- def _included_by_tags(self, test):
- return self.include_tags.match(test.tags)
-
- def _not_excluded_by_tags(self, test):
- return not self.exclude_tags.match(test.tags)
-
- def __bool__(self):
- return bool(self.include_suites is not None or
- self.include_tests is not None or
- self.include_tags is not None or
- self.exclude_tags is not None)
+ def _filter_tests(self, suite: "TestSuite"):
+ tests = self.include_tests
+ include = self.include_tags
+ exclude = self.exclude_tags
+ if tests is not None:
+ suite.tests = [t for t in suite.tests if tests.match(t.name, t.full_name)]
+ if include is not None:
+ suite.tests = [t for t in suite.tests if include.match(t.tags)]
+ if exclude is not None:
+ suite.tests = [t for t in suite.tests if not exclude.match(t.tags)]
+
+ def __bool__(self) -> bool:
+ return bool(
+ self.include_suites is not None
+ or self.include_tests is not None
+ or self.include_tags is not None
+ or self.exclude_tags is not None
+ )
diff --git a/src/robot/model/fixture.py b/src/robot/model/fixture.py
index 32535383c94..3db848d9522 100644
--- a/src/robot/model/fixture.py
+++ b/src/robot/model/fixture.py
@@ -13,15 +13,31 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-def create_fixture(fixture, parent, type):
- # TestCase and TestSuite have 'fixture_class', Keyword doesn't.
- fixture_class = getattr(parent, 'fixture_class', parent.__class__)
+from collections.abc import Mapping
+from typing import Type, TYPE_CHECKING, TypeVar
+
+if TYPE_CHECKING:
+ from robot.model import DataDict, Keyword, TestCase, TestSuite
+ from robot.running.model import UserKeyword
+
+
+T = TypeVar("T", bound="Keyword")
+
+
+def create_fixture(
+ fixture_class: Type[T],
+ fixture: "T|DataDict|None",
+ parent: "TestCase|TestSuite|Keyword|UserKeyword",
+ fixture_type: str,
+) -> T:
+ """Create or configure a `fixture_class` instance."""
+ # If a fixture instance has been passed in update the config
+ if isinstance(fixture, fixture_class):
+ return fixture.config(parent=parent, type=fixture_type)
+ # If a Mapping has been passed in, create a fixture instance from it
+ if isinstance(fixture, Mapping):
+ return fixture_class.from_dict(fixture).config(parent=parent, type=fixture_type)
+ # If nothing has been passed in then return a new fixture instance from it
if fixture is None:
- fixture = fixture_class(None, parent=parent, type=type)
- elif isinstance(fixture, fixture_class):
- fixture.parent = parent
- fixture.type = type
- else:
- raise TypeError("Only %s objects accepted, got %s."
- % (fixture_class.__name__, fixture.__class__.__name__))
- return fixture
+ return fixture_class(None, parent=parent, type=fixture_type)
+ raise TypeError(f"Invalid fixture type '{type(fixture).__name__}'.")
diff --git a/src/robot/model/itemlist.py b/src/robot/model/itemlist.py
index b948cfaa1bb..8812b8a3a7f 100644
--- a/src/robot/model/itemlist.py
+++ b/src/robot/model/itemlist.py
@@ -13,69 +13,122 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from collections.abc import MutableSequence
from functools import total_ordering
+from typing import (
+ Any, Iterable, Iterator, MutableSequence, overload, Type, TYPE_CHECKING, TypeVar
+)
+from robot.utils import copy_signature, KnownAtRuntime
+
+from .modelobject import DataDict, full_name, ModelObject
+
+if TYPE_CHECKING:
+ from .visitor import SuiteVisitor
+
+
+T = TypeVar("T")
+Self = TypeVar("Self", bound="ItemList")
-@total_ordering
-class ItemList(MutableSequence):
- __slots__ = ['_item_class', '_common_attrs', '_items']
- def __init__(self, item_class, common_attrs=None, items=None):
+@total_ordering
+class ItemList(MutableSequence[T]):
+ """List of items of a certain enforced type.
+
+ New items can be created using the :meth:`create` method and existing items
+ added using the common list methods like :meth:`append` or :meth:`insert`.
+ In addition to the common type, items can have certain common and
+ automatically assigned attributes.
+
+ Starting from Robot Framework 6.1, items can be added as dictionaries and
+ actual items are generated based on them automatically. If the type has
+ a ``from_dict`` class method, it is used, and otherwise dictionary data is
+ passed to the type as keyword arguments.
+ """
+
+ # TypeVar T needs to be applied to a variable to be compatible with @copy_signature
+ item_type: Type[T] = KnownAtRuntime
+ __slots__ = ("_item_class", "_common_attrs", "_items")
+
+ def __init__(
+ self,
+ item_class: Type[T],
+ common_attrs: "dict[str, Any]|None" = None,
+ items: "Iterable[T|DataDict]" = (),
+ ):
self._item_class = item_class
self._common_attrs = common_attrs
- self._items = []
+ self._items: "list[T]" = []
if items:
self.extend(items)
- def create(self, *args, **kwargs):
+ @copy_signature(item_type)
+ def create(self, *args, **kwargs) -> T:
+ """Create a new item using the provided arguments."""
return self.append(self._item_class(*args, **kwargs))
- def append(self, item):
- self._check_type_and_set_attrs(item)
+ def append(self, item: "T|DataDict") -> T:
+ item = self._check_type_and_set_attrs(item)
self._items.append(item)
return item
- def _check_type_and_set_attrs(self, *items):
- common_attrs = self._common_attrs or {}
- for item in items:
- if not isinstance(item, self._item_class):
- raise TypeError("Only %s objects accepted, got %s."
- % (self._item_class.__name__,
- item.__class__.__name__))
- for attr in common_attrs:
- setattr(item, attr, common_attrs[attr])
- return items
-
- def extend(self, items):
- self._items.extend(self._check_type_and_set_attrs(*items))
-
- def insert(self, index, item):
- self._check_type_and_set_attrs(item)
+ def _check_type_and_set_attrs(self, item: "T|DataDict") -> T:
+ if not isinstance(item, self._item_class):
+ if isinstance(item, dict):
+ item = self._item_from_dict(item)
+ else:
+ raise TypeError(
+ f"Only '{self._type_name(self._item_class)}' objects accepted, "
+ f"got '{self._type_name(item)}'."
+ )
+ if self._common_attrs:
+ for attr, value in self._common_attrs.items():
+ setattr(item, attr, value)
+ return item
+
+ def _type_name(self, item: "type|object") -> str:
+ typ = item if isinstance(item, type) else type(item)
+ return full_name(typ) if issubclass(typ, ModelObject) else typ.__name__
+
+ def _item_from_dict(self, data: DataDict) -> T:
+ if hasattr(self._item_class, "from_dict"):
+ return self._item_class.from_dict(data) # type: ignore
+ return self._item_class(**data)
+
+ def extend(self, items: "Iterable[T|DataDict]"):
+ self._items.extend(self._check_type_and_set_attrs(i) for i in items)
+
+ def insert(self, index: int, item: "T|DataDict"):
+ item = self._check_type_and_set_attrs(item)
self._items.insert(index, item)
- def index(self, item, *start_and_end):
+ def index(self, item: T, *start_and_end) -> int:
return self._items.index(item, *start_and_end)
def clear(self):
self._items = []
- def visit(self, visitor):
+ def visit(self, visitor: "SuiteVisitor"):
for item in self:
- item.visit(visitor)
+ item.visit(visitor) # type: ignore
- def __iter__(self):
+ def __iter__(self) -> Iterator[T]:
index = 0
while index < len(self._items):
yield self._items[index]
index += 1
- def __getitem__(self, index):
- if not isinstance(index, slice):
- return self._items[index]
- return self._create_new_from(self._items[index])
+ @overload
+ def __getitem__(self, index: int, /) -> T: ...
+
+ @overload
+ def __getitem__(self: Self, index: slice, /) -> Self: ...
+
+ def __getitem__(self: Self, index: "int|slice", /) -> "T|Self":
+ if isinstance(index, slice):
+ return self._create_new_from(self._items[index])
+ return self._items[index]
- def _create_new_from(self, items):
+ def _create_new_from(self: Self, items: Iterable[T]) -> Self:
# Cannot pass common_attrs directly to new object because all
# subclasses don't have compatible __init__.
new = type(self)(self._item_class)
@@ -83,80 +136,103 @@ def _create_new_from(self, items):
new.extend(items)
return new
- def __setitem__(self, index, item):
+ @overload
+ def __setitem__(self, index: int, item: "T|DataDict", /): ...
+
+ @overload
+ def __setitem__(self, index: slice, items: "Iterable[T|DataDict]", /): ...
+
+ def __setitem__(
+ self, index: "int|slice", item: "T|DataDict|Iterable[T|DataDict]", /
+ ):
if isinstance(index, slice):
- self._check_type_and_set_attrs(*item)
+ self._items[index] = [self._check_type_and_set_attrs(i) for i in item]
else:
- self._check_type_and_set_attrs(item)
- self._items[index] = item
+ self._items[index] = self._check_type_and_set_attrs(item)
- def __delitem__(self, index):
+ def __delitem__(self, index: "int|slice", /):
del self._items[index]
- def __contains__(self, item):
+ def __contains__(self, item: Any, /) -> bool:
return item in self._items
- def __len__(self):
+ def __len__(self) -> int:
return len(self._items)
- def __str__(self):
- return '[%s]' % ', '.join(repr(item) for item in self)
+ def __str__(self) -> str:
+ return str(list(self))
- def __repr__(self):
- return '%s(item_class=%s, items=%s)' % (type(self).__name__,
- self._item_class.__name__,
- self._items)
+ def __repr__(self) -> str:
+ class_name = type(self).__name__
+ item_name = self._item_class.__name__
+ return f"{class_name}(item_class={item_name}, items={self._items})"
- def count(self, item):
+ def count(self, item: T) -> int:
return self._items.count(item)
- def sort(self):
- self._items.sort()
+ def sort(self, **config):
+ self._items.sort(**config)
def reverse(self):
self._items.reverse()
- def __reversed__(self):
+ def __reversed__(self) -> Iterator[T]:
index = 0
while index < len(self._items):
yield self._items[len(self._items) - index - 1]
index += 1
- def __eq__(self, other):
- return (isinstance(other, ItemList)
- and self._is_compatible(other)
- and self._items == other._items)
+ def __eq__(self, other: object) -> bool:
+ return (
+ isinstance(other, ItemList)
+ and self._is_compatible(other)
+ and self._items == other._items
+ )
- def _is_compatible(self, other):
- return (self._item_class is other._item_class
- and self._common_attrs == other._common_attrs)
+ def _is_compatible(self, other) -> bool:
+ return (
+ self._item_class is other._item_class
+ and self._common_attrs == other._common_attrs
+ )
- def __lt__(self, other):
+ def __lt__(self, other: "ItemList[T]") -> bool:
if not isinstance(other, ItemList):
- raise TypeError('Cannot order ItemList and %s' % type(other).__name__)
+ raise TypeError(f"Cannot order 'ItemList' and '{self._type_name(other)}'.")
if not self._is_compatible(other):
- raise TypeError('Cannot order incompatible ItemLists')
+ raise TypeError("Cannot order incompatible 'ItemList' objects.")
return self._items < other._items
- def __add__(self, other):
+ def __add__(self: Self, other: "ItemList[T]") -> Self:
if not isinstance(other, ItemList):
- raise TypeError('Cannot add ItemList and %s' % type(other).__name__)
+ raise TypeError(f"Cannot add 'ItemList' and '{self._type_name(other)}'.")
if not self._is_compatible(other):
- raise TypeError('Cannot add incompatible ItemLists')
+ raise TypeError("Cannot add incompatible 'ItemList' objects.")
return self._create_new_from(self._items + other._items)
- def __iadd__(self, other):
+ def __iadd__(self: Self, other: Iterable[T]) -> Self:
if isinstance(other, ItemList) and not self._is_compatible(other):
- raise TypeError('Cannot add incompatible ItemLists')
+ raise TypeError("Cannot add incompatible 'ItemList' objects.")
self.extend(other)
return self
- def __mul__(self, other):
- return self._create_new_from(self._items * other)
+ def __mul__(self: Self, count: int) -> Self:
+ return self._create_new_from(self._items * count)
- def __imul__(self, other):
- self._items *= other
+ def __imul__(self: Self, count: int) -> Self:
+ self._items *= count
return self
- def __rmul__(self, other):
- return self * other
+ def __rmul__(self: Self, count: int) -> Self:
+ return self * count
+
+ def to_dicts(self) -> "list[DataDict]":
+ """Return list of items converted to dictionaries.
+
+ Items are converted to dictionaries using the ``to_dict`` method, if
+ they have it, or the built-in ``vars()``.
+
+ New in Robot Framework 6.1.
+ """
+ if not hasattr(self._item_class, "to_dict"):
+ return [vars(item) for item in self]
+ return [item.to_dict() for item in self] # type: ignore
diff --git a/src/robot/model/keyword.py b/src/robot/model/keyword.py
index c5245e8d2c7..580fb0dabc3 100644
--- a/src/robot/model/keyword.py
+++ b/src/robot/model/keyword.py
@@ -13,14 +13,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import warnings
+from typing import Sequence, TYPE_CHECKING
-from robot.utils import setter
+from .body import Body, BodyItem, BodyItemParent
+from .modelobject import DataDict
-from .body import Body, BodyItem
-from .fixture import create_fixture
-from .itemlist import ItemList
-from .tags import Tags
+if TYPE_CHECKING:
+ from .visitor import SuiteVisitor
@Body.register
@@ -30,180 +29,46 @@ class Keyword(BodyItem):
Extended by :class:`robot.running.model.Keyword` and
:class:`robot.result.model.Keyword`.
"""
- repr_args = ('name', 'args', 'assign')
- __slots__ = ['_name', 'doc', 'args', 'assign', 'timeout', 'type', '_teardown']
- def __init__(self, name='', doc='', args=(), assign=(), tags=(),
- timeout=None, type=BodyItem.KEYWORD, parent=None):
- self._name = name
- self.doc = doc
- self.args = args
- self.assign = assign
- self.tags = tags
- self.timeout = timeout
+ repr_args = ("name", "args", "assign")
+ __slots__ = ("name", "args", "assign", "type")
+
+ def __init__(
+ self,
+ name: "str|None" = "",
+ args: Sequence[str] = (),
+ assign: Sequence[str] = (),
+ type: str = BodyItem.KEYWORD,
+ parent: BodyItemParent = None,
+ ):
+ self.name = name
+ self.args = tuple(args)
+ self.assign = tuple(assign)
self.type = type
- self._teardown = None
self.parent = parent
@property
- def name(self):
- return self._name
+ def id(self) -> "str|None":
+ if not self:
+ return None
+ return super().id
- @name.setter
- def name(self, name):
- self._name = name
-
- @property # Cannot use @setter because it would create teardowns recursively.
- def teardown(self):
- """Keyword teardown as a :class:`Keyword` object.
-
- Teardown can be modified by setting attributes directly::
-
- keyword.teardown.name = 'Example'
- keyword.teardown.args = ('First', 'Second')
-
- Alternatively the :meth:`config` method can be used to set multiple
- attributes in one call::
-
- keyword.teardown.config(name='Example', args=('First', 'Second'))
-
- The easiest way to reset the whole teardown is setting it to ``None``.
- It will automatically recreate the underlying ``Keyword`` object::
-
- keyword.teardown = None
-
- This attribute is a ``Keyword`` object also when a keyword has no teardown
- but in that case its truth value is ``False``. If there is a need to just
- check does a keyword have a teardown, using the :attr:`has_teardown`
- attribute avoids creating the ``Keyword`` object and is thus more memory
- efficient.
-
- New in Robot Framework 4.0. Earlier teardown was accessed like
- ``keyword.keywords.teardown``. :attr:`has_teardown` is new in Robot
- Framework 4.1.2.
- """
- if self._teardown is None and self:
- self._teardown = create_fixture(None, self, self.TEARDOWN)
- return self._teardown
-
- @teardown.setter
- def teardown(self, teardown):
- self._teardown = create_fixture(teardown, self, self.TEARDOWN)
-
- @property
- def has_teardown(self):
- """Check does a keyword have a teardown without creating a teardown object.
-
- A difference between using ``if kw.has_teardown:`` and ``if kw.teardown:``
- is that accessing the :attr:`teardown` attribute creates a :class:`Keyword`
- object representing a teardown even when the keyword actually does not
- have one. This typically does not matter, but with bigger suite structures
- having lot of keywords it can have a considerable effect on memory usage.
-
- New in Robot Framework 4.1.2.
- """
- return bool(self._teardown)
-
- @setter
- def tags(self, tags):
- """Keyword tags as a :class:`~.model.tags.Tags` object."""
- return Tags(tags)
-
- def visit(self, visitor):
+ def visit(self, visitor: "SuiteVisitor"):
""":mod:`Visitor interface ` entry-point."""
if self:
visitor.visit_keyword(self)
- def __bool__(self):
+ def __bool__(self) -> bool:
return self.name is not None
- def __str__(self):
- parts = list(self.assign) + [self.name] + list(self.args)
- return ' '.join(str(p) for p in parts)
-
-
-class Keywords(ItemList):
- """A list-like object representing keywords in a suite, a test or a keyword.
-
- Read-only and deprecated since Robot Framework 4.0.
- """
- __slots__ = []
- deprecation_message = (
- "'keywords' attribute is read-only and deprecated since Robot Framework 4.0. "
- "Use 'body', 'setup' or 'teardown' instead."
- )
-
- def __init__(self, parent=None, keywords=None):
- warnings.warn(self.deprecation_message, UserWarning)
- ItemList.__init__(self, object, {'parent': parent})
- if keywords:
- ItemList.extend(self, keywords)
-
- @property
- def setup(self):
- return self[0] if (self and self[0].type == 'SETUP') else None
-
- @setup.setter
- def setup(self, kw):
- self.raise_deprecation_error()
-
- def create_setup(self, *args, **kwargs):
- self.raise_deprecation_error()
-
- @property
- def teardown(self):
- return self[-1] if (self and self[-1].type == 'TEARDOWN') else None
-
- @teardown.setter
- def teardown(self, kw):
- self.raise_deprecation_error()
-
- def create_teardown(self, *args, **kwargs):
- self.raise_deprecation_error()
-
- @property
- def all(self):
- """Iterates over all keywords, including setup and teardown."""
- return self
-
- @property
- def normal(self):
- """Iterates over normal keywords, omitting setup and teardown."""
- return [kw for kw in self if kw.type not in ('SETUP', 'TEARDOWN')]
-
- def __setitem__(self, index, item):
- self.raise_deprecation_error()
-
- def create(self, *args, **kwargs):
- self.raise_deprecation_error()
-
- def append(self, item):
- self.raise_deprecation_error()
-
- def extend(self, items):
- self.raise_deprecation_error()
-
- def insert(self, index, item):
- self.raise_deprecation_error()
-
- def pop(self, *index):
- self.raise_deprecation_error()
-
- def remove(self, item):
- self.raise_deprecation_error()
-
- def clear(self):
- self.raise_deprecation_error()
-
- def __delitem__(self, index):
- self.raise_deprecation_error()
-
- def sort(self):
- self.raise_deprecation_error()
-
- def reverse(self):
- self.raise_deprecation_error()
-
- @classmethod
- def raise_deprecation_error(cls):
- raise AttributeError(cls.deprecation_message)
+ def __str__(self) -> str:
+ parts = (*self.assign, self.name, *self.args)
+ return " ".join(str(p) for p in parts)
+
+ def to_dict(self) -> DataDict:
+ data: DataDict = {"name": self.name}
+ if self.args:
+ data["args"] = self.args
+ if self.assign:
+ data["assign"] = self.assign
+ return data
diff --git a/src/robot/model/message.py b/src/robot/model/message.py
index c931223e6ef..dc40c2c0482 100644
--- a/src/robot/model/message.py
+++ b/src/robot/model/message.py
@@ -13,10 +13,14 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import html_escape
+from datetime import datetime
+from typing import Literal
+
+from robot.utils import html_escape, setter
from .body import BodyItem
-from .itemlist import ItemList
+
+MessageLevel = Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FAIL", "SKIP"]
class Message(BodyItem):
@@ -25,24 +29,31 @@ class Message(BodyItem):
Can be a log message triggered by a keyword, or a warning or an error
that occurred during parsing or test execution.
"""
+
type = BodyItem.MESSAGE
- repr_args = ('message', 'level')
- __slots__ = ['message', 'level', 'html', 'timestamp']
+ repr_args = ("message", "level")
+ __slots__ = ("message", "level", "html", "_timestamp")
- def __init__(self, message='', level='INFO', html=False, timestamp=None, parent=None):
- #: The message content as a string.
+ def __init__(
+ self,
+ message: str = "",
+ level: MessageLevel = "INFO",
+ html: bool = False,
+ timestamp: "datetime|str|None" = None,
+ parent: "BodyItem|None" = None,
+ ):
self.message = message
- #: Severity of the message. Either ``TRACE``, ``DEBUG``, ``INFO``,
- #: ``WARN``, ``ERROR``, ``FAIL`` or ``SKIP`. The last two are only used
- #: with keyword failure messages.
self.level = level
- #: ``True`` if the content is in HTML, ``False`` otherwise.
self.html = html
- #: Timestamp in format ``%Y%m%d %H:%M:%S.%f``.
self.timestamp = timestamp
- #: The object this message was triggered by.
self.parent = parent
+ @setter
+ def timestamp(self, timestamp: "datetime|str|None") -> "datetime|None":
+ if isinstance(timestamp, str):
+ return datetime.fromisoformat(timestamp)
+ return timestamp
+
@property
def html_message(self):
"""Returns the message content as HTML."""
@@ -51,19 +62,25 @@ def html_message(self):
@property
def id(self):
if not self.parent:
- return 'm1'
- return '%s-m%d' % (self.parent.id, self.parent.messages.index(self) + 1)
+ return "m1"
+ if hasattr(self.parent, "messages"):
+ messages = self.parent.messages
+ else:
+ messages = self.parent.body.filter(messages=True)
+ index = messages.index(self) if self in messages else len(messages)
+ return f"{self.parent.id}-m{index + 1}"
def visit(self, visitor):
""":mod:`Visitor interface ` entry-point."""
visitor.visit_message(self)
+ def to_dict(self):
+ data = {"message": self.message, "level": self.level}
+ if self.html:
+ data["html"] = True
+ if self.timestamp:
+ data["timestamp"] = self.timestamp.isoformat()
+ return data
+
def __str__(self):
return self.message
-
-
-class Messages(ItemList):
- __slots__ = []
-
- def __init__(self, message_class=Message, parent=None, messages=None):
- ItemList.__init__(self, message_class, {'parent': parent}, messages)
diff --git a/src/robot/model/metadata.py b/src/robot/model/metadata.py
index 9528e687390..8088f94cb45 100644
--- a/src/robot/model/metadata.py
+++ b/src/robot/model/metadata.py
@@ -13,20 +13,30 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import is_string, NormalizedDict
+from collections.abc import Iterable, Mapping
+from robot.utils import NormalizedDict
-class Metadata(NormalizedDict):
- def __init__(self, initial=None):
- super().__init__(initial, ignore='_')
+class Metadata(NormalizedDict[str]):
+ """Free suite metadata as a mapping.
- def __setitem__(self, key, value):
- if not is_string(key):
+ Keys are case, space, and underscore insensitive.
+ """
+
+ def __init__(
+ self,
+ initial: "Mapping[str, str]|Iterable[tuple[str, str]]|None" = None,
+ ):
+ super().__init__(initial, ignore="_")
+
+ def __setitem__(self, key: str, value: str):
+ if not isinstance(key, str):
key = str(key)
- if not is_string(value):
+ if not isinstance(value, str):
value = str(value)
super().__setitem__(key, value)
def __str__(self):
- return '{%s}' % ', '.join('%s: %s' % (k, self[k]) for k in self)
+ items = ", ".join(f"{key}: {self[key]}" for key in self)
+ return f"{{{items}}}"
diff --git a/src/robot/model/modelobject.py b/src/robot/model/modelobject.py
index 5fa752fc6a8..cf121f3acb8 100644
--- a/src/robot/model/modelobject.py
+++ b/src/robot/model/modelobject.py
@@ -14,15 +14,155 @@
# limitations under the License.
import copy
+from pathlib import Path
+from typing import Any, Dict, overload, TextIO, Type, TypeVar
-from robot.utils import SetterAwareType
+from robot.errors import DataError
+from robot.utils import JsonDumper, JsonLoader, SetterAwareType, type_name
+
+T = TypeVar("T", bound="ModelObject")
+DataDict = Dict[str, Any]
class ModelObject(metaclass=SetterAwareType):
+ SUITE = "SUITE"
+ TEST = "TEST"
+ TASK = TEST
+ KEYWORD = "KEYWORD"
+ SETUP = "SETUP"
+ TEARDOWN = "TEARDOWN"
+ FOR = "FOR"
+ ITERATION = "ITERATION"
+ IF_ELSE_ROOT = "IF/ELSE ROOT"
+ IF = "IF"
+ ELSE_IF = "ELSE IF"
+ ELSE = "ELSE"
+ TRY_EXCEPT_ROOT = "TRY/EXCEPT ROOT"
+ TRY = "TRY"
+ EXCEPT = "EXCEPT"
+ FINALLY = "FINALLY"
+ WHILE = "WHILE"
+ GROUP = "GROUP"
+ VAR = "VAR"
+ RETURN = "RETURN"
+ CONTINUE = "CONTINUE"
+ BREAK = "BREAK"
+ ERROR = "ERROR"
+ MESSAGE = "MESSAGE"
+ KEYWORD_TYPES = (KEYWORD, SETUP, TEARDOWN)
+ type: str
repr_args = ()
- __slots__ = []
+ __slots__ = ()
+
+ @classmethod
+ def from_dict(cls: Type[T], data: DataDict) -> T:
+ """Create this object based on data in a dictionary.
+
+ Data can be got from the :meth:`to_dict` method or created externally.
+
+ With ``robot.running`` model objects new in Robot Framework 6.1,
+ with ``robot.result`` new in Robot Framework 7.0.
+ """
+ try:
+ return cls().config(**data)
+ except (AttributeError, TypeError) as err:
+ raise DataError(
+ f"Creating '{full_name(cls)}' object from dictionary failed: {err}"
+ )
+
+ @classmethod
+ def from_json(cls: Type[T], source: "str|bytes|TextIO|Path") -> T:
+ """Create this object based on 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.
+
+ The JSON data is first converted to a Python dictionary and the object
+ created using the :meth:`from_dict` method.
+
+ Notice that the ``source`` is considered to be JSON data if it is
+ a string and contains ``{``. If you need to use ``{`` in a file system
+ path, pass it in as a ``pathlib.Path`` instance.
- def config(self, **attributes):
+ With ``robot.running`` model objects new in Robot Framework 6.1,
+ with ``robot.result`` new in Robot Framework 7.0.
+ """
+ try:
+ data = JsonLoader().load(source)
+ except (TypeError, ValueError) as err:
+ raise DataError(f"Loading JSON data failed: {err}")
+ return cls.from_dict(data)
+
+ def to_dict(self) -> DataDict:
+ """Serialize this object into a dictionary.
+
+ The object can be later restored by using the :meth:`from_dict` method.
+
+ With ``robot.running`` model objects new in Robot Framework 6.1,
+ with ``robot.result`` new in Robot Framework 7.0.
+ """
+ raise NotImplementedError
+
+ @overload
+ def to_json(
+ self,
+ file: None = None,
+ *,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> str: ...
+
+ @overload
+ def to_json(
+ self,
+ file: "TextIO|Path|str",
+ *,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> None: ...
+
+ def to_json(
+ self,
+ file: "None|TextIO|Path|str" = None,
+ *,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> "str|None":
+ """Serialize this object into JSON.
+
+ The object is first converted to a Python dictionary using the
+ :meth:`to_dict` method and then the dictionary is converted to 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.
+
+ JSON formatting can be configured using optional parameters that
+ are passed directly to the underlying json__ module. Notice that
+ the defaults differ from what ``json`` uses.
+
+ With ``robot.running`` model objects new in Robot Framework 6.1,
+ with ``robot.result`` new in Robot Framework 7.0.
+
+ __ https://docs.python.org/3/library/json.html
+ """
+ return JsonDumper(
+ ensure_ascii=ensure_ascii,
+ indent=indent,
+ separators=separators,
+ ).dump(self.to_dict(), file)
+
+ def config(self: T, **attributes) -> T:
"""Configure model object with given attributes.
``obj.config(name='Example', doc='Something')`` is equivalent to setting
@@ -30,50 +170,79 @@ def config(self, **attributes):
New in Robot Framework 4.0.
"""
- for name in attributes:
- setattr(self, name, attributes[name])
+ for name, value in attributes.items():
+ try:
+ orig = getattr(self, name)
+ except AttributeError:
+ raise AttributeError(
+ f"'{full_name(self)}' object does not have attribute '{name}'"
+ )
+ # Preserve tuples. Main motivation is converting lists with `from_json`.
+ if isinstance(orig, tuple) and not isinstance(value, tuple):
+ try:
+ value = tuple(value)
+ except TypeError:
+ raise TypeError(
+ f"'{full_name(self)}' object attribute '{name}' "
+ f"is 'tuple', got '{type_name(value)}'."
+ )
+ try:
+ setattr(self, name, value)
+ except AttributeError as err:
+ # Ignore error setting attribute if the object already has it.
+ # Avoids problems with `from_dict` with body items having
+ # un-settable `type` attribute that is needed in dict data.
+ if value != orig:
+ raise AttributeError(f"Setting attribute '{name}' failed: {err}")
return self
- def copy(self, **attributes):
- """Return shallow copy of this object.
+ def copy(self: T, **attributes) -> T:
+ """Return a shallow copy of this object.
+
+ :param attributes: Attributes to be set to the returned copy.
+ For example, ``obj.copy(name='New name')``.
- :param attributes: Attributes to be set for the returned copy
- automatically. For example, ``test.copy(name='New name')``.
+ See also :meth:`deepcopy`. The difference between ``copy`` and
+ ``deepcopy`` is the same as with the methods having same names in
+ the copy__ module.
- See also :meth:`deepcopy`. The difference between these two is the same
- as with the standard ``copy.copy`` and ``copy.deepcopy`` functions
- that these methods also use internally.
+ __ https://docs.python.org/3/library/copy.html
"""
- copied = copy.copy(self)
- for name in attributes:
- setattr(copied, name, attributes[name])
- return copied
+ return copy.copy(self).config(**attributes)
- def deepcopy(self, **attributes):
- """Return deep copy of this object.
+ def deepcopy(self: T, **attributes) -> T:
+ """Return a deep copy of this object.
- :param attributes: Attributes to be set for the returned copy
- automatically. For example, ``test.deepcopy(name='New name')``.
+ :param attributes: Attributes to be set to the returned copy.
+ For example, ``obj.deepcopy(name='New name')``.
- See also :meth:`copy`. The difference between these two is the same
- as with the standard ``copy.copy`` and ``copy.deepcopy`` functions
- that these methods also use internally.
+ See also :meth:`copy`. The difference between ``deepcopy`` and
+ ``copy`` is the same as with the methods having same names in
+ the copy__ module.
+
+ __ https://docs.python.org/3/library/copy.html
"""
- copied = copy.deepcopy(self)
- for name in attributes:
- setattr(copied, name, attributes[name])
- return copied
+ return copy.deepcopy(self).config(**attributes)
+
+ def __repr__(self) -> str:
+ args = []
+ for name in self.repr_args:
+ value = getattr(self, name)
+ if self._include_in_repr(name, value):
+ value = self._repr_format(name, value)
+ args.append(f"{name}={value}")
+ return f"{full_name(self)}({', '.join(args)})"
- def __repr__(self):
- return self._repr(self.repr_args)
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return True
- def _repr(self, repr_args):
- args = ', '.join(f'{a}={getattr(self, a)!r}' for a in repr_args)
- return f"{full_name(self)}({args})"
+ def _repr_format(self, name: str, value: Any) -> str:
+ return repr(value)
-def full_name(obj):
- parts = type(obj).__module__.split('.') + [type(obj).__name__]
- if len(parts) > 1 and parts[0] == 'robot':
+def full_name(obj_or_cls):
+ cls = obj_or_cls if isinstance(obj_or_cls, type) else type(obj_or_cls)
+ parts = [*cls.__module__.split("."), cls.__name__]
+ if len(parts) > 1 and parts[0] == "robot":
parts[2:-1] = []
- return '.'.join(parts)
+ return ".".join(parts)
diff --git a/src/robot/model/modifier.py b/src/robot/model/modifier.py
index a79a4c6a711..de17f4c5fb0 100644
--- a/src/robot/model/modifier.py
+++ b/src/robot/model/modifier.py
@@ -14,8 +14,9 @@
# limitations under the License.
from robot.errors import DataError
-from robot.utils import (get_error_details, is_string,
- split_args_from_name_or_path, type_name, Importer)
+from robot.utils import (
+ get_error_details, Importer, split_args_from_name_or_path, type_name
+)
from .visitor import SuiteVisitor
@@ -25,31 +26,31 @@ class ModelModifier(SuiteVisitor):
def __init__(self, visitors, empty_suite_ok, logger):
self._log_error = logger.error
self._empty_suite_ok = empty_suite_ok
- self._visitors = list(self._yield_visitors(visitors))
+ self._visitors = list(self._yield_visitors(visitors, logger))
def visit_suite(self, suite):
for visitor in self._visitors:
try:
suite.visit(visitor)
- except:
+ except Exception:
message, details = get_error_details()
- self._log_error("Executing model modifier '%s' failed: %s\n%s"
- % (type_name(visitor), message, details))
- if not (suite.test_count or self._empty_suite_ok):
- raise DataError("Suite '%s' contains no tests after model modifiers."
- % suite.name)
-
- def _yield_visitors(self, visitors):
- # Avoid cyclic imports. Yuck.
- from robot.output import LOGGER
-
- importer = Importer('model modifier', logger=LOGGER)
+ self._log_error(
+ f"Executing model modifier '{type_name(visitor)}' "
+ f"failed: {message}\n{details}"
+ )
+ if not (suite.has_tests or self._empty_suite_ok):
+ raise DataError(
+ f"Suite '{suite.name}' contains no tests after model modifiers."
+ )
+
+ def _yield_visitors(self, visitors, logger):
+ importer = Importer("model modifier", logger=logger)
for visitor in visitors:
- try:
- if not is_string(visitor):
- yield visitor
- else:
- name, args = split_args_from_name_or_path(visitor)
+ if isinstance(visitor, str):
+ name, args = split_args_from_name_or_path(visitor)
+ try:
yield importer.import_class_or_module(name, args)
- except DataError as err:
- self._log_error(err.message)
+ except DataError as err:
+ logger.error(err.message)
+ else:
+ yield visitor
diff --git a/src/robot/model/namepatterns.py b/src/robot/model/namepatterns.py
index 4792b5ef191..f2977e54bce 100644
--- a/src/robot/model/namepatterns.py
+++ b/src/robot/model/namepatterns.py
@@ -13,41 +13,23 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import MultiMatcher
-
-
-class NamePatterns:
-
- def __init__(self, patterns=None):
- self._matcher = MultiMatcher(patterns, ignore='_')
-
- def match(self, name, longname=None):
- return self._match(name) or longname and self._match_longname(longname)
+from typing import Iterable, Iterator, Sequence
- def _match(self, name):
- return self._matcher.match(name)
-
- def _match_longname(self, name):
- raise NotImplementedError
-
- def __bool__(self):
- return bool(self._matcher)
-
- def __iter__(self):
- return iter(self._matcher)
+from robot.utils import MultiMatcher
-class SuiteNamePatterns(NamePatterns):
+class NamePatterns(Iterable[str]):
- def _match_longname(self, name):
- while '.' in name:
- if self._match(name):
- return True
- name = name.split('.', 1)[1]
- return False
+ def __init__(self, patterns: Sequence[str] = (), ignore: Sequence[str] = "_"):
+ self.matcher = MultiMatcher(patterns, ignore)
+ def match(self, name: str, full_name: "str|None" = None) -> bool:
+ match = self.matcher.match
+ return bool(match(name) or full_name and match(full_name))
-class TestNamePatterns(NamePatterns):
+ def __bool__(self) -> bool:
+ return bool(self.matcher)
- def _match_longname(self, name):
- return self._match(name)
+ def __iter__(self) -> Iterator[str]:
+ for matcher in self.matcher:
+ yield matcher.pattern
diff --git a/src/robot/model/statistics.py b/src/robot/model/statistics.py
index 9c465ca99a1..6c6856a711d 100644
--- a/src/robot/model/statistics.py
+++ b/src/robot/model/statistics.py
@@ -13,9 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .totalstatistics import TotalStatisticsBuilder
-from .suitestatistics import SuiteStatisticsBuilder
-from .tagstatistics import TagStatisticsBuilder
+from .suitestatistics import SuiteStatistics, SuiteStatisticsBuilder
+from .tagstatistics import TagStatistics, TagStatisticsBuilder
+from .totalstatistics import TotalStatistics, TotalStatisticsBuilder
from .visitor import SuiteVisitor
@@ -25,21 +25,38 @@ class Statistics:
Accepted parameters have the same semantics as the matching command line
options.
"""
- def __init__(self, suite, suite_stat_level=-1, tag_stat_include=None,
- tag_stat_exclude=None, tag_stat_combine=None, tag_doc=None,
- tag_stat_link=None, rpa=False):
+
+ def __init__(
+ self,
+ suite,
+ suite_stat_level=-1,
+ tag_stat_include=None,
+ tag_stat_exclude=None,
+ tag_stat_combine=None,
+ tag_doc=None,
+ tag_stat_link=None,
+ rpa=False,
+ ):
total_builder = TotalStatisticsBuilder(rpa=rpa)
suite_builder = SuiteStatisticsBuilder(suite_stat_level)
- tag_builder = TagStatisticsBuilder(tag_stat_include,
- tag_stat_exclude, tag_stat_combine,
- tag_doc, tag_stat_link)
+ tag_builder = TagStatisticsBuilder(
+ tag_stat_include,
+ tag_stat_exclude,
+ tag_stat_combine,
+ tag_doc,
+ tag_stat_link,
+ )
suite.visit(StatisticsBuilder(total_builder, suite_builder, tag_builder))
- #: Instance of :class:`~robot.model.totalstatistics.TotalStatistics`.
- self.total = total_builder.stats
- #: Instance of :class:`~robot.model.suitestatistics.SuiteStatistics`.
- self.suite = suite_builder.stats
- #: Instance of :class:`~robot.model.tagstatistics.TagStatistics`.
- self.tags = tag_builder.stats
+ self.total: TotalStatistics = total_builder.stats
+ self.suite: SuiteStatistics = suite_builder.stats
+ self.tags: TagStatistics = tag_builder.stats
+
+ def to_dict(self):
+ return {
+ "total": self.total.stat.get_attributes(include_label=True),
+ "suites": [s.get_attributes(include_label=True) for s in self.suite],
+ "tags": [t.get_attributes(include_label=True) for t in self.tags],
+ }
def visit(self, visitor):
visitor.visit_statistics(self)
diff --git a/src/robot/model/stats.py b/src/robot/model/stats.py
index b4b2546df8e..47da78f2a09 100644
--- a/src/robot/model/stats.py
+++ b/src/robot/model/stats.py
@@ -13,8 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import (Sortable, elapsed_time_to_string, html_escape,
- is_string, normalize)
+from datetime import timedelta
+
+from robot.utils import elapsed_time_to_string, html_escape, normalize, Sortable
from .tags import TagPattern
@@ -31,40 +32,44 @@ def __init__(self, name):
#: or name of the tag for
#: :class:`~robot.model.tagstatistics.TagStatistics`
self.name = name
- #: Number of passed tests.
self.passed = 0
- #: Number of failed tests.
self.failed = 0
- #: Number of skipped tests.
self.skipped = 0
- #: Number of milliseconds it took to execute.
- self.elapsed = 0
- self._norm_name = normalize(name, ignore='_')
-
- def get_attributes(self, include_label=False, include_elapsed=False,
- exclude_empty=True, values_as_strings=False,
- html_escape=False):
- attrs = {'pass': self.passed, 'fail': self.failed, 'skip': self.skipped}
- attrs.update(self._get_custom_attrs())
- if include_label:
- attrs['label'] = self.name
+ self.elapsed = timedelta()
+ self._norm_name = normalize(name, ignore="_")
+
+ def get_attributes(
+ self,
+ include_label=False,
+ include_elapsed=False,
+ exclude_empty=True,
+ values_as_strings=False,
+ html_escape=False,
+ ):
+ attrs = {
+ **({"label": self.name} if include_label else {}),
+ **self._get_custom_attrs(),
+ "pass": self.passed,
+ "fail": self.failed,
+ "skip": self.skipped,
+ }
if include_elapsed:
- attrs['elapsed'] = elapsed_time_to_string(self.elapsed,
- include_millis=False)
+ attrs["elapsed"] = elapsed_time_to_string(
+ self.elapsed, include_millis=False
+ )
if exclude_empty:
- attrs = dict((k, v) for k, v in attrs.items() if v not in ('', None))
+ attrs = {k: v for k, v in attrs.items() if v not in ("", None)}
if values_as_strings:
- attrs = dict((k, str(v) if v is not None else '')
- for k, v in attrs.items())
+ attrs = {k: str(v if v is not None else "") for k, v in attrs.items()}
if html_escape:
- attrs = dict((k, self._html_escape(v)) for k, v in attrs.items())
+ attrs = {k: self._html_escape(v) for k, v in attrs.items()}
return attrs
def _get_custom_attrs(self):
return {}
def _html_escape(self, item):
- return html_escape(item) if is_string(item) else item
+ return html_escape(item) if isinstance(item, str) else item
@property
def total(self):
@@ -83,7 +88,7 @@ def _update_stats(self, test):
self.failed += 1
def _update_elapsed(self, test):
- self.elapsed += test.elapsedtime
+ self.elapsed += test.elapsed_time
@property
def _sort_key(self):
@@ -98,24 +103,23 @@ def visit(self, visitor):
class TotalStat(Stat):
"""Stores statistic values for a test run."""
- type = 'total'
+
+ type = "total"
class SuiteStat(Stat):
"""Stores statistics values for a single suite."""
- type = 'suite'
+
+ type = "suite"
def __init__(self, suite):
- Stat.__init__(self, suite.longname)
- #: Identifier of the suite, e.g. `s1-s2`.
+ super().__init__(suite.full_name)
self.id = suite.id
- #: Number of milliseconds it took to execute this suite,
- #: including sub-suites.
- self.elapsed = suite.elapsedtime
+ self.elapsed = suite.elapsed_time
self._name = suite.name
def _get_custom_attrs(self):
- return {'id': self.id, 'name': self._name}
+ return {"name": self._name, "id": self.id}
def _update_elapsed(self, test):
pass
@@ -128,10 +132,11 @@ def add_stat(self, other):
class TagStat(Stat):
"""Stores statistic values for a single tag."""
- type = 'tag'
- def __init__(self, name, doc='', links=None, combined=None):
- Stat.__init__(self, name)
+ type = "tag"
+
+ def __init__(self, name, doc="", links=None, combined=None):
+ super().__init__(name)
#: Documentation of tag as a string.
self.doc = doc
#: List of tuples in which the first value is the link URL and
@@ -143,18 +148,22 @@ def __init__(self, name, doc='', links=None, combined=None):
@property
def info(self):
"""Returns additional information of the tag statistics
- are about. Either `combined` or an empty string.
+ are about. Either `combined` or an empty string.
"""
if self.combined:
- return 'combined'
- return ''
+ return "combined"
+ return ""
def _get_custom_attrs(self):
- return {'doc': self.doc, 'links': self._get_links_as_string(),
- 'info': self.info, 'combined': self.combined}
+ return {
+ "doc": self.doc,
+ "links": self._get_links_as_string(),
+ "info": self.info,
+ "combined": self.combined,
+ }
def _get_links_as_string(self):
- return ':::'.join('%s:%s' % (title, url) for url, title in self.links)
+ return ":::".join(f"{title}:{url}" for url, title in self.links)
@property
def _sort_key(self):
@@ -163,9 +172,9 @@ def _sort_key(self):
class CombinedTagStat(TagStat):
- def __init__(self, pattern, name=None, doc='', links=None):
- TagStat.__init__(self, name or pattern, doc, links, combined=pattern)
- self.pattern = TagPattern(pattern)
+ def __init__(self, pattern, name=None, doc="", links=None):
+ super().__init__(name or pattern, doc, links, combined=pattern)
+ self.pattern = TagPattern.from_string(pattern)
def match(self, tags):
return self.pattern.match(tags)
diff --git a/src/robot/model/suitestatistics.py b/src/robot/model/suitestatistics.py
index 21f90bf67dd..667e3d90d04 100644
--- a/src/robot/model/suitestatistics.py
+++ b/src/robot/model/suitestatistics.py
@@ -13,6 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Iterator
+
from .stats import SuiteStat
@@ -20,30 +22,27 @@ class SuiteStatistics:
"""Container for suite statistics."""
def __init__(self, suite):
- #: Instance of :class:`~robot.model.stats.SuiteStat`.
self.stat = SuiteStat(suite)
- #: List of :class:`~robot.model.testsuite.TestSuite` objects.
- self.suites = []
+ self.suites: list[SuiteStatistics] = []
def visit(self, visitor):
visitor.visit_suite_statistics(self)
- def __iter__(self):
+ def __iter__(self) -> Iterator[SuiteStat]:
yield self.stat
for child in self.suites:
- for stat in child:
- yield stat
+ yield from child
class SuiteStatisticsBuilder:
def __init__(self, suite_stat_level):
self._suite_stat_level = suite_stat_level
- self._stats_stack = []
- self.stats = None
+ self._stats_stack: list[SuiteStatistics] = []
+ self.stats: SuiteStatistics | None = None
@property
- def current(self):
+ def current(self) -> "SuiteStatistics|None":
return self._stats_stack[-1] if self._stats_stack else None
def start_suite(self, suite):
diff --git a/src/robot/model/tags.py b/src/robot/model/tags.py
index eb12dfc00f1..2d9d8996f44 100644
--- a/src/robot/model/tags.py
+++ b/src/robot/model/tags.py
@@ -13,168 +13,251 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import is_string, normalize, NormalizedDict, Matcher
+from abc import ABC, abstractmethod
+from typing import Iterable, Iterator, overload, Sequence
+from robot.utils import Matcher, normalize, NormalizedDict
-class Tags:
- __slots__ = ['_tags']
- def __init__(self, tags=None):
- self._tags = self._init_tags(tags)
+class Tags(Sequence[str]):
+ __slots__ = ("_tags", "_reserved")
- def _init_tags(self, tags):
+ def __init__(self, tags: Iterable[str] = ()):
+ if isinstance(tags, Tags):
+ self._tags, self._reserved = tags._tags, tags._reserved
+ else:
+ self._tags, self._reserved = self._init_tags(tags)
+
+ def robot(self, name: str) -> bool:
+ """Check do tags contain a reserved tag in format `robot:`.
+
+ `tags.robot('')` is same as `'robot:' in tags`,
+ but the former is considerably faster.
+ """
+ return name in self._reserved
+
+ def _init_tags(self, tags) -> "tuple[tuple[str, ...], tuple[str, ...]]":
if not tags:
- return ()
- if is_string(tags):
+ return (), ()
+ if isinstance(tags, str):
tags = (tags,)
return self._normalize(tags)
def _normalize(self, tags):
- normalized = NormalizedDict([(str(t), None) for t in tags], ignore='_')
- for remove in '', 'NONE':
- if remove in normalized:
- normalized.pop(remove)
- return tuple(normalized)
-
- def add(self, tags):
- self._tags = self._normalize(tuple(self) + tuple(Tags(tags)))
-
- def remove(self, tags):
- tags = TagPatterns(tags)
- self._tags = tuple([t for t in self if not tags.match(t)])
-
- def match(self, tags):
+ nd = NormalizedDict.fromkeys([str(t) for t in tags], ignore="_")
+ if "" in nd:
+ del nd[""]
+ if "NONE" in nd:
+ del nd["NONE"]
+ reserved = [tag[6:] for tag in nd.normalized_keys if tag[:6] == "robot:"]
+ return tuple(nd), tuple(reserved)
+
+ def add(self, tags: Iterable[str], remove_negated: bool = False):
+ tags = tuple(Tags(tags))
+ if remove_negated:
+ remove = [t[1:] for t in tags if t[0] == "-"]
+ if remove:
+ self.remove(remove)
+ tags = [t for t in tags if t[0] != "-"]
+ self.__init__(tuple(self) + tuple(tags))
+
+ def remove(self, tags: Iterable[str]):
+ match = TagPatterns(tags).match
+ self.__init__([t for t in self if not match(t)])
+
+ def match(self, tags: Iterable[str]) -> bool:
return TagPatterns(tags).match(self)
- def __contains__(self, tags):
+ def __contains__(self, tags: Iterable[str]) -> bool:
return self.match(tags)
- def __len__(self):
+ def __len__(self) -> int:
return len(self._tags)
- def __iter__(self):
+ def __iter__(self) -> Iterator[str]:
return iter(self._tags)
- def __str__(self):
- return '[%s]' % ', '.join(self)
+ def __str__(self) -> str:
+ tags = ", ".join(self)
+ return f"[{tags}]"
- def __repr__(self):
+ def __repr__(self) -> str:
return repr(list(self))
- def __eq__(self, other):
+ def __eq__(self, other: object) -> bool:
+ if not isinstance(other, Iterable):
+ return False
if not isinstance(other, Tags):
other = Tags(other)
- self_normalized = [normalize(tag, ignore='_') for tag in self]
- other_normalized = [normalize(tag, ignore='_') for tag in other]
+ self_normalized = [normalize(tag, ignore="_") for tag in self]
+ other_normalized = [normalize(tag, ignore="_") for tag in other]
return sorted(self_normalized) == sorted(other_normalized)
- def __getitem__(self, index):
- item = self._tags[index]
- return item if not isinstance(index, slice) else Tags(item)
+ @overload
+ def __getitem__(self, index: int) -> str: ...
+
+ @overload
+ def __getitem__(self, index: slice) -> "Tags": ...
+
+ def __getitem__(self, index: "int|slice") -> "str|Tags":
+ if isinstance(index, slice):
+ return Tags(self._tags[index])
+ return self._tags[index]
- def __add__(self, other):
+ def __add__(self, other: Iterable[str]) -> "Tags":
return Tags(tuple(self) + tuple(Tags(other)))
-class TagPatterns:
+class TagPatterns(Sequence["TagPattern"]):
- def __init__(self, patterns):
- self._patterns = tuple(TagPattern(p) for p in Tags(patterns))
+ def __init__(self, patterns: Iterable[str] = ()):
+ self._patterns = tuple(TagPattern.from_string(p) for p in Tags(patterns))
- def match(self, tags):
- tags = tags if isinstance(tags, Tags) else Tags(tags)
+ @property
+ def is_constant(self):
+ return all(p.is_constant for p in self._patterns)
+
+ def match(self, tags: Iterable[str]) -> bool:
+ if not self._patterns:
+ return False
+ tags = normalize_tags(tags)
return any(p.match(tags) for p in self._patterns)
- def __contains__(self, tag):
+ def __contains__(self, tag: str) -> bool:
return self.match(tag)
- def __len__(self):
+ def __len__(self) -> int:
return len(self._patterns)
- def __iter__(self):
+ def __iter__(self) -> Iterator["TagPattern"]:
return iter(self._patterns)
- def __getitem__(self, index):
+ def __getitem__(self, index: int) -> "TagPattern":
return self._patterns[index]
- def __str__(self):
- return '[%s]' % ', '.join(str(pattern) for pattern in self)
-
-
-def TagPattern(pattern):
- pattern = pattern.replace(' ', '')
- if 'NOT' in pattern:
- return NotTagPattern(*pattern.split('NOT'))
- if 'OR' in pattern:
- return OrTagPattern(pattern.split('OR'))
- if 'AND' in pattern or '&' in pattern:
- return AndTagPattern(pattern.replace('&', 'AND').split('AND'))
- return SingleTagPattern(pattern)
-
-
-class SingleTagPattern:
-
- def __init__(self, pattern):
- self._matcher = Matcher(pattern, ignore='_')
-
- def match(self, tags):
+ def __str__(self) -> str:
+ patterns = ", ".join(str(pattern) for pattern in self)
+ return f"[{patterns}]"
+
+
+class TagPattern(ABC):
+ is_constant = False
+
+ @classmethod
+ def from_string(cls, pattern: str) -> "TagPattern":
+ pattern = pattern.replace(" ", "")
+ if "NOT" in pattern:
+ must_match, *must_not_match = pattern.split("NOT")
+ return NotTagPattern(must_match, must_not_match)
+ if "OR" in pattern:
+ return OrTagPattern(pattern.split("OR"))
+ if "AND" in pattern or "&" in pattern:
+ return AndTagPattern(pattern.replace("&", "AND").split("AND"))
+ return SingleTagPattern(pattern)
+
+ @abstractmethod
+ def match(self, tags: Iterable[str]) -> bool:
+ raise NotImplementedError
+
+ @abstractmethod
+ def __iter__(self) -> Iterator["TagPattern"]:
+ raise NotImplementedError
+
+ @abstractmethod
+ def __str__(self) -> str:
+ raise NotImplementedError
+
+
+class SingleTagPattern(TagPattern):
+
+ def __init__(self, pattern: str):
+ # Normalization is handled here, not in Matcher, for performance reasons.
+ # This way we can normalize tags only once.
+ self._matcher = Matcher(
+ normalize(pattern, ignore="_"),
+ caseless=False,
+ spaceless=False,
+ )
+
+ @property
+ def is_constant(self):
+ pattern = self._matcher.pattern
+ return not ("*" in pattern or "?" in pattern or "[" in pattern)
+
+ def match(self, tags: Iterable[str]) -> bool:
+ tags = normalize_tags(tags)
return self._matcher.match_any(tags)
- def __iter__(self):
+ def __iter__(self) -> Iterator["TagPattern"]:
yield self
- def __str__(self):
+ def __str__(self) -> str:
return self._matcher.pattern
- def __bool__(self):
+ def __bool__(self) -> bool:
return bool(self._matcher)
-class AndTagPattern:
+class AndTagPattern(TagPattern):
- def __init__(self, patterns):
- self._patterns = tuple(TagPattern(p) for p in patterns)
+ def __init__(self, patterns: Iterable[str]):
+ self._patterns = tuple(TagPattern.from_string(p) for p in patterns)
- def match(self, tags):
+ def match(self, tags: Iterable[str]) -> bool:
+ tags = normalize_tags(tags)
return all(p.match(tags) for p in self._patterns)
- def __iter__(self):
+ def __iter__(self) -> Iterator["TagPattern"]:
return iter(self._patterns)
- def __str__(self):
- return ' AND '.join(str(pattern) for pattern in self)
+ def __str__(self) -> str:
+ return " AND ".join(str(pattern) for pattern in self)
-class OrTagPattern:
+class OrTagPattern(TagPattern):
- def __init__(self, patterns):
- self._patterns = tuple(TagPattern(p) for p in patterns)
+ def __init__(self, patterns: Iterable[str]):
+ self._patterns = tuple(TagPattern.from_string(p) for p in patterns)
- def match(self, tags):
+ def match(self, tags: Iterable[str]) -> bool:
+ tags = normalize_tags(tags)
return any(p.match(tags) for p in self._patterns)
- def __iter__(self):
+ def __iter__(self) -> Iterator["TagPattern"]:
return iter(self._patterns)
- def __str__(self):
- return ' OR '.join(str(pattern) for pattern in self)
+ def __str__(self) -> str:
+ return " OR ".join(str(pattern) for pattern in self)
-class NotTagPattern:
+class NotTagPattern(TagPattern):
- def __init__(self, must_match, *must_not_match):
- self._first = TagPattern(must_match)
+ def __init__(self, must_match: str, must_not_match: Iterable[str]):
+ self._first = TagPattern.from_string(must_match)
self._rest = OrTagPattern(must_not_match)
- def match(self, tags):
- if not self._first:
- return not self._rest.match(tags)
- return self._first.match(tags) and not self._rest.match(tags)
+ def match(self, tags: Iterable[str]) -> bool:
+ tags = normalize_tags(tags)
+ if self._first and not self._first.match(tags):
+ return False
+ return not self._rest.match(tags)
- def __iter__(self):
+ def __iter__(self) -> Iterator["TagPattern"]:
yield self._first
- for pattern in self._rest:
- yield pattern
+ yield from self._rest
+
+ def __str__(self) -> str:
+ return " NOT ".join(str(pattern) for pattern in self).lstrip()
+
+
+def normalize_tags(tags: Iterable[str]) -> Iterable[str]:
+ """Performance optimization to normalize tags only once."""
+ if isinstance(tags, NormalizedTags):
+ return tags
+ if isinstance(tags, str):
+ tags = [tags]
+ return NormalizedTags([normalize(t, ignore="_") for t in tags])
+
- def __str__(self):
- return ' NOT '.join(str(pattern) for pattern in self).lstrip()
+class NormalizedTags(list):
+ pass
diff --git a/src/robot/model/tagsetter.py b/src/robot/model/tagsetter.py
index 08466b17a9c..730227de2f0 100644
--- a/src/robot/model/tagsetter.py
+++ b/src/robot/model/tagsetter.py
@@ -13,23 +13,34 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Sequence, TYPE_CHECKING
+
from .visitor import SuiteVisitor
+if TYPE_CHECKING:
+ from .keyword import Keyword
+ from .testcase import TestCase
+ from .testsuite import TestSuite
+
class TagSetter(SuiteVisitor):
- def __init__(self, add=None, remove=None):
+ def __init__(
+ self,
+ add: "Sequence[str]|str" = (),
+ remove: "Sequence[str]|str" = (),
+ ):
self.add = add
self.remove = remove
- def start_suite(self, suite):
+ def start_suite(self, suite: "TestSuite"):
return bool(self)
- def visit_test(self, test):
+ def visit_test(self, test: "TestCase"):
test.tags.add(self.add)
test.tags.remove(self.remove)
- def visit_keyword(self, keyword):
+ def visit_keyword(self, keyword: "Keyword"):
pass
def __bool__(self):
diff --git a/src/robot/model/tagstatistics.py b/src/robot/model/tagstatistics.py
index 483065b5e09..c5a1dce40e4 100644
--- a/src/robot/model/tagstatistics.py
+++ b/src/robot/model/tagstatistics.py
@@ -13,7 +13,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from itertools import chain
import re
from robot.utils import NormalizedDict
@@ -26,26 +25,29 @@ class TagStatistics:
"""Container for tag statistics."""
def __init__(self, combined_stats):
- #: Dictionary, where key is the name of the tag as a string and value
- #: is an instance of :class:`~robot.model.stats.TagStat`.
- self.tags = NormalizedDict(ignore='_')
- #: List of :class:`~robot.model.stats.CombinedTagStat` objects.
+ self.tags = NormalizedDict(ignore="_")
self.combined = combined_stats
def visit(self, visitor):
visitor.visit_tag_statistics(self)
def __iter__(self):
- return iter(sorted(chain(self.combined, self.tags.values())))
+ return iter(sorted([*self.combined, *self.tags.values()]))
class TagStatisticsBuilder:
- def __init__(self, included=None, excluded=None, combined=None, docs=None,
- links=None):
+ def __init__(
+ self,
+ included=None,
+ excluded=None,
+ combined=None,
+ docs=None,
+ links=None,
+ ):
self._included = TagPatterns(included)
self._excluded = TagPatterns(excluded)
- self._reserved = TagPatterns('robot:*')
+ self._reserved = TagPatterns("robot:*")
self._info = TagStatInfo(docs, links)
self.stats = TagStatistics(self._info.get_combined_stats(combined))
@@ -88,11 +90,15 @@ def get_combined_stats(self, combined=None):
def _get_combined_stat(self, pattern, name=None):
name = name or pattern
- return CombinedTagStat(pattern, name, self.get_doc(name),
- self.get_links(name))
+ return CombinedTagStat(
+ pattern,
+ name,
+ self.get_doc(name),
+ self.get_links(name),
+ )
def get_doc(self, tag):
- return ' & '.join(doc.text for doc in self._docs if doc.match(tag))
+ return " & ".join(doc.text for doc in self._docs if doc.match(tag))
def get_links(self, tag):
return [link.get_link(tag) for link in self._links if link.match(tag)]
@@ -109,12 +115,12 @@ def match(self, tag):
class TagStatLink:
- _match_pattern_tokenizer = re.compile(r'(\*|\?+)')
+ _match_pattern_tokenizer = re.compile(r"(\*|\?+)")
def __init__(self, pattern, link, title):
self._regexp = self._get_match_regexp(pattern)
self._link = link
- self._title = title.replace('_', ' ')
+ self._title = title.replace("_", " ")
def match(self, tag):
return self._regexp.match(tag) is not None
@@ -127,21 +133,23 @@ def get_link(self, tag):
return link, title
def _replace_groups(self, link, title, match):
- for index, group in enumerate(match.groups()):
- placefolder = '%%%d' % (index+1)
+ for index, group in enumerate(match.groups(), start=1):
+ placefolder = f"%{index}"
link = link.replace(placefolder, group)
title = title.replace(placefolder, group)
return link, title
def _get_match_regexp(self, pattern):
- pattern = '^%s$' % ''.join(self._yield_match_pattern(pattern))
+ pattern = "".join(self._yield_match_pattern(pattern))
return re.compile(pattern, re.IGNORECASE)
def _yield_match_pattern(self, pattern):
+ yield "^"
for token in self._match_pattern_tokenizer.split(pattern):
- if token.startswith('?'):
- yield '(%s)' % ('.'*len(token))
- elif token == '*':
- yield '(.*)'
+ if token.startswith("?"):
+ yield f"({'.' * len(token)})"
+ elif token == "*":
+ yield "(.*)"
else:
yield re.escape(token)
+ yield "$"
diff --git a/src/robot/model/testcase.py b/src/robot/model/testcase.py
index fb48a3da46f..dea00b5692e 100644
--- a/src/robot/model/testcase.py
+++ b/src/robot/model/testcase.py
@@ -13,51 +13,72 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from pathlib import Path
+from typing import Any, Generic, Sequence, Type, TYPE_CHECKING, TypeVar
+
from robot.utils import setter
-from .body import Body
+from .body import Body, BodyItem
from .fixture import create_fixture
from .itemlist import ItemList
-from .keyword import Keyword, Keywords
-from .modelobject import ModelObject
+from .keyword import Keyword
+from .modelobject import DataDict, ModelObject
from .tags import Tags
+if TYPE_CHECKING:
+ from .testsuite import TestSuite
+ from .visitor import SuiteVisitor
+
+
+TC = TypeVar("TC", bound="TestCase")
+KW = TypeVar("KW", bound="Keyword", covariant=True)
-class TestCase(ModelObject):
+
+class TestCase(ModelObject, Generic[KW]):
"""Base model for a single test case.
Extended by :class:`robot.running.model.TestCase` and
:class:`robot.result.model.TestCase`.
"""
- body_class = Body
- fixture_class = Keyword
- repr_args = ('name',)
- __slots__ = ['parent', 'name', 'doc', 'timeout', 'lineno', '_setup', '_teardown']
- def __init__(self, name='', doc='', tags=None, timeout=None, lineno=None,
- parent=None):
+ type = "TEST"
+ body_class = Body
+ # See model.TestSuite on removing the type ignore directive
+ fixture_class: Type[KW] = Keyword # type: ignore
+ repr_args = ("name",)
+ __slots__ = ("parent", "name", "doc", "timeout", "lineno", "_setup", "_teardown")
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ timeout: "str|None" = None,
+ lineno: "int|None" = None,
+ parent: "TestSuite[KW, TestCase[KW]]|None" = None,
+ ):
self.name = name
self.doc = doc
self.tags = tags
self.timeout = timeout
self.lineno = lineno
self.parent = parent
- self.body = None
- self._setup = None
- self._teardown = None
+ self.body = []
+ self._setup: "KW|None" = None
+ self._teardown: "KW|None" = None
@setter
- def body(self, body):
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
"""Test body as a :class:`~robot.model.body.Body` object."""
return self.body_class(self, body)
@setter
- def tags(self, tags):
+ def tags(self, tags: "Tags|Sequence[str]") -> Tags:
"""Test tags as a :class:`~.model.tags.Tags` object."""
return Tags(tags)
@property
- def setup(self):
+ def setup(self) -> KW:
"""Test setup as a :class:`~.model.keyword.Keyword` object.
This attribute is a ``Keyword`` object also when a test has no setup
@@ -81,16 +102,26 @@ def setup(self):
New in Robot Framework 4.0. Earlier setup was accessed like
``test.keywords.setup``.
"""
- if self._setup is None and self:
- self._setup = create_fixture(None, self, Keyword.SETUP)
+ if self._setup is None:
+ self._setup = create_fixture(
+ self.fixture_class,
+ None,
+ self,
+ Keyword.SETUP,
+ )
return self._setup
@setup.setter
- def setup(self, setup):
- self._setup = create_fixture(setup, self, Keyword.SETUP)
+ def setup(self, setup: "KW|DataDict|None"):
+ self._setup = create_fixture(
+ self.fixture_class,
+ setup,
+ self,
+ Keyword.SETUP,
+ )
@property
- def has_setup(self):
+ def has_setup(self) -> bool:
"""Check does a suite have a setup without creating a setup object.
A difference between using ``if test.has_setup:`` and ``if test.setup:``
@@ -104,21 +135,31 @@ def has_setup(self):
return bool(self._setup)
@property
- def teardown(self):
+ def teardown(self) -> KW:
"""Test teardown as a :class:`~.model.keyword.Keyword` object.
See :attr:`setup` for more information.
"""
- if self._teardown is None and self:
- self._teardown = create_fixture(None, self, Keyword.TEARDOWN)
+ if self._teardown is None:
+ self._teardown = create_fixture(
+ self.fixture_class,
+ None,
+ self,
+ Keyword.TEARDOWN,
+ )
return self._teardown
@teardown.setter
- def teardown(self, teardown):
- self._teardown = create_fixture(teardown, self, Keyword.TEARDOWN)
+ def teardown(self, teardown: "KW|DataDict|None"):
+ self._teardown = create_fixture(
+ self.fixture_class,
+ teardown,
+ self,
+ Keyword.TEARDOWN,
+ )
@property
- def has_teardown(self):
+ def has_teardown(self) -> bool:
"""Check does a test have a teardown without creating a teardown object.
See :attr:`has_setup` for more information.
@@ -128,57 +169,70 @@ def has_teardown(self):
return bool(self._teardown)
@property
- def keywords(self):
- """Deprecated since Robot Framework 4.0
-
- Use :attr:`body`, :attr:`setup` or :attr:`teardown` instead.
- """
- keywords = [self.setup] + list(self.body) + [self.teardown]
- return Keywords(self, [kw for kw in keywords if kw])
-
- @keywords.setter
- def keywords(self, keywords):
- Keywords.raise_deprecation_error()
-
- @property
- def id(self):
+ def id(self) -> str:
"""Test case id in format like ``s1-t3``.
See :attr:`TestSuite.id ` for
more information.
"""
if not self.parent:
- return 't1'
- return '%s-t%d' % (self.parent.id, self.parent.tests.index(self)+1)
+ return "t1"
+ tests = self.parent.tests
+ index = tests.index(self) if self in tests else len(tests)
+ return f"{self.parent.id}-t{index + 1}"
@property
- def longname(self):
- """Test name prefixed with the long name of the parent suite."""
+ def full_name(self) -> str:
+ """Test name prefixed with the full name of the parent suite."""
if not self.parent:
return self.name
- return '%s.%s' % (self.parent.longname, self.name)
+ return f"{self.parent.full_name}.{self.name}"
+
+ @property
+ def longname(self) -> str:
+ """Deprecated since Robot Framework 7.0. Use :attr:`full_name` instead."""
+ return self.full_name
@property
- def source(self):
+ def source(self) -> "Path|None":
return self.parent.source if self.parent is not None else None
- def visit(self, visitor):
+ def visit(self, visitor: "SuiteVisitor"):
""":mod:`Visitor interface ` entry-point."""
visitor.visit_test(self)
- def __str__(self):
- return self.name
-
-
-class TestCases(ItemList):
- __slots__ = []
-
- def __init__(self, test_class=TestCase, parent=None, tests=None):
- ItemList.__init__(self, test_class, {'parent': parent}, tests)
-
- def _check_type_and_set_attrs(self, *tests):
- tests = ItemList._check_type_and_set_attrs(self, *tests)
- for test in tests:
+ def to_dict(self) -> "dict[str, Any]":
+ data: "dict[str, Any]" = {"name": self.name}
+ if self.doc:
+ data["doc"] = self.doc
+ if self.tags:
+ data["tags"] = tuple(self.tags)
+ if self.timeout:
+ data["timeout"] = self.timeout
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.has_setup:
+ data["setup"] = self.setup.to_dict()
+ if self.has_teardown:
+ data["teardown"] = self.teardown.to_dict()
+ data["body"] = self.body.to_dicts()
+ return data
+
+
+class TestCases(ItemList[TC]):
+ __slots__ = ()
+
+ def __init__(
+ self,
+ test_class: Type[TC] = TestCase,
+ parent: "TestSuite|None" = None,
+ tests: "Sequence[TC|DataDict]" = (),
+ ):
+ super().__init__(test_class, {"parent": parent}, tests)
+
+ def _check_type_and_set_attrs(self, test):
+ test = super()._check_type_and_set_attrs(test)
+ if test.parent:
for visitor in test.parent._visitors:
test.visit(visitor)
- return tests
+ return test
diff --git a/src/robot/model/testsuite.py b/src/robot/model/testsuite.py
index c0044f15c25..be2a202a4ec 100644
--- a/src/robot/model/testsuite.py
+++ b/src/robot/model/testsuite.py
@@ -13,87 +13,258 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import setter
+from collections.abc import Mapping
+from pathlib import Path
+from typing import Any, Generic, Iterator, Sequence, Type, TypeVar
+
+from robot.errors import DataError
+from robot.utils import seq2str, setter
from .configurer import SuiteConfigurer
-from .filter import Filter, EmptySuiteRemover
+from .filter import EmptySuiteRemover, Filter
from .fixture import create_fixture
from .itemlist import ItemList
-from .keyword import Keyword, Keywords
+from .keyword import Keyword
from .metadata import Metadata
-from .modelobject import ModelObject
+from .modelobject import DataDict, ModelObject
from .tagsetter import TagSetter
from .testcase import TestCase, TestCases
+from .visitor import SuiteVisitor
+
+TS = TypeVar("TS", bound="TestSuite")
+KW = TypeVar("KW", bound=Keyword, covariant=True)
+TC = TypeVar("TC", bound=TestCase, covariant=True)
-class TestSuite(ModelObject):
+class TestSuite(ModelObject, Generic[KW, TC]):
"""Base model for single suite.
Extended by :class:`robot.running.model.TestSuite` and
:class:`robot.result.model.TestSuite`.
"""
- test_class = TestCase #: Internal usage only.
- fixture_class = Keyword #: Internal usage only.
- repr_args = ('name',)
- __slots__ = ['parent', 'source', '_name', 'doc', '_setup', '_teardown', 'rpa',
- '_my_visitors']
-
- def __init__(self, name='', doc='', metadata=None, source=None, rpa=False,
- parent=None):
+
+ type = "SUITE"
+ # FIXME: Type Ignore declarations: Typevars only accept subclasses of the bound class
+ # assigning `Type[KW]` to `Keyword` results in an error. In RF 7 the class should be
+ # made impossible to instantiate directly, and the assignments can be replaced with
+ # KnownAtRuntime
+ fixture_class: Type[KW] = Keyword # type: ignore
+ test_class: Type[TC] = TestCase # type: ignore
+
+ repr_args = ("name",)
+ __slots__ = ("parent", "_name", "doc", "_setup", "_teardown", "rpa", "_my_visitors")
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ metadata: "Mapping[str, str]|None" = None,
+ source: "Path|str|None" = None,
+ rpa: "bool|None" = False,
+ parent: "TestSuite[KW, TC]|None" = None,
+ ):
self._name = name
self.doc = doc
self.metadata = metadata
- self.source = source #: Path to the source file or directory.
- self.parent = parent #: Parent suite. ``None`` with the root suite.
- self.rpa = rpa #: ``True`` when RPA mode is enabled.
- self.suites = None
- self.tests = None
- self._setup = None
- self._teardown = None
- self._my_visitors = []
+ self.source = source
+ self.parent = parent
+ self.rpa = rpa
+ self.suites = []
+ self.tests = []
+ self._setup: "KW|None" = None
+ self._teardown: "KW|None" = None
+ self._my_visitors: "list[SuiteVisitor]" = []
+
+ @staticmethod
+ def name_from_source(source: "Path|str|None", extension: Sequence[str] = ()) -> str:
+ """Create suite name based on the given ``source``.
+
+ This method is used by Robot Framework itself when it builds suites.
+ External parsers and other tools that want to produce suites with
+ names matching names created by Robot Framework can use this method as
+ well. This method is also used if :attr:`name` is not set and someone
+ accesses it.
+
+ The algorithm is as follows:
+
+ - If the source is ``None`` or empty, return an empty string.
+ - Get the base name of the source. Read more below.
+ - Remove possible prefix separated with ``__``.
+ - Convert underscores to spaces.
+ - If the name is all lower case, title case it.
+
+ The base name of files is got by calling `Path.stem`__ that drops
+ the file extension. It typically works fine, but gives wrong result
+ if the extension has multiple parts like in ``tests.robot.zip``.
+ That problem can be avoided by giving valid file extension or extensions
+ as the optional ``extension`` argument.
+
+ Examples::
+
+ TestSuite.name_from_source(source)
+ TestSuite.name_from_source(source, extension='.robot.zip')
+ TestSuite.name_from_source(source, ('.robot', '.robot.zip'))
+
+ __ https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.stem
+ """
+ if not source:
+ return ""
+ if not isinstance(source, Path):
+ source = Path(source)
+ name = TestSuite._get_base_name(source, extension)
+ if "__" in name:
+ name = name.split("__", 1)[1] or name
+ name = name.replace("_", " ").strip()
+ return name.title() if name.islower() else name
+
+ @staticmethod
+ def _get_base_name(path: Path, extensions: Sequence[str]) -> str:
+ if path.is_dir():
+ return path.name
+ if not extensions:
+ return path.stem
+ if isinstance(extensions, str):
+ extensions = [extensions]
+ for ext in extensions:
+ ext = "." + ext.lower().lstrip(".")
+ if path.name.lower().endswith(ext):
+ return path.name[: -len(ext)]
+ valid_extensions = seq2str(extensions, lastsep=" or ")
+ raise ValueError(f"File '{path}' does not have extension {valid_extensions}.")
@property
- def _visitors(self):
+ def _visitors(self) -> "list[SuiteVisitor]":
parent_visitors = self.parent._visitors if self.parent else []
return self._my_visitors + parent_visitors
@property
- def name(self):
- """Test suite name. If not set, constructed from child suite names."""
- return self._name or ' & '.join(s.name for s in self.suites)
+ def name(self) -> str:
+ """Suite name.
+
+ If name is not set, it is constructed from source. If source is not set,
+ name is constructed from child suite names by concatenating them with
+ `` & ``. If there are no child suites, name is an empty string.
+ """
+ return (
+ self._name
+ or self.name_from_source(self.source)
+ or " & ".join(s.name for s in self.suites)
+ )
@name.setter
- def name(self, name):
+ def name(self, name: str):
self._name = name
+ @setter
+ def source(self, source: "Path|str|None") -> "Path|None":
+ return source if isinstance(source, (Path, type(None))) else Path(source)
+
+ def adjust_source(
+ self,
+ relative_to: "Path|str|None" = None,
+ root: "Path|str|None" = None,
+ ):
+ """Adjust suite source and child suite sources, recursively.
+
+ :param relative_to: Make suite source relative to the given path. Calls
+ `pathlib.Path.relative_to()`__ internally. Raises ``ValueError``
+ if creating a relative path is not possible.
+ :param root: Make given path a new root directory for the source. Raises
+ ``ValueError`` if suite source is absolute.
+
+ Adjusting the source is especially useful when moving data around as JSON::
+
+ from robot.api import TestSuite
+
+ # Create a suite, adjust source and convert to JSON.
+ suite = TestSuite.from_file_system('/path/to/data')
+ suite.adjust_source(relative_to='/path/to')
+ suite.to_json('data.rbt')
+
+ # Recreate suite elsewhere and adjust source accordingly.
+ suite = TestSuite.from_json('data.rbt')
+ suite.adjust_source(root='/new/path/to')
+
+ New in Robot Framework 6.1.
+
+ __ https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.relative_to
+ """
+ if not self.source:
+ raise ValueError("Suite has no source.")
+ if relative_to:
+ self.source = self.source.relative_to(relative_to)
+ if root:
+ if self.source.is_absolute():
+ raise ValueError(
+ f"Cannot set root for absolute source '{self.source}'."
+ )
+ self.source = root / self.source
+ for suite in self.suites:
+ suite.adjust_source(relative_to, root)
+
@property
- def longname(self):
- """Suite name prefixed with the long name of the parent suite."""
+ def full_name(self) -> str:
+ """Suite name prefixed with the full name of the possible parent suite.
+
+ Just :attr:`name` of the suite if it has no :attr:`parent`.
+ """
if not self.parent:
return self.name
- return '%s.%s' % (self.parent.longname, self.name)
+ return f"{self.parent.full_name}.{self.name}"
+
+ @property
+ def longname(self) -> str:
+ """Deprecated since Robot Framework 7.0. Use :attr:`full_name` instead."""
+ return self.full_name
@setter
- def metadata(self, metadata):
- """Free test suite metadata as a dictionary."""
+ def metadata(self, metadata: "Mapping[str, str]|None") -> Metadata:
+ """Free suite metadata as a :class:`~.metadata.Metadata` object."""
return Metadata(metadata)
+ def validate_execution_mode(self) -> "bool|None":
+ """Validate that suite execution mode is set consistently.
+
+ Raise an exception if the execution mode is not set (i.e. the :attr:`rpa`
+ attribute is ``None``) and child suites have conflicting execution modes.
+
+ The execution mode is returned. New in RF 6.1.1.
+ """
+ if self.rpa is None:
+ rpa = name = None
+ for suite in self.suites:
+ suite.validate_execution_mode()
+ if rpa is None:
+ rpa = suite.rpa
+ name = suite.full_name
+ elif rpa is not suite.rpa:
+ mode1, mode2 = ("tasks", "tests") if rpa else ("tests", "tasks")
+ raise DataError(
+ f"Conflicting execution modes: Suite '{name}' has {mode1} but "
+ f"suite '{suite.full_name}' has {mode2}. Resolve the conflict "
+ f"or use '--rpa' or '--norpa' options to set the execution "
+ f"mode explicitly."
+ )
+ self.rpa = rpa
+ return self.rpa
+
@setter
- def suites(self, suites):
- """Child suites as a :class:`~.TestSuites` object."""
- return TestSuites(self.__class__, self, suites)
+ def suites(
+ self, suites: "Sequence[TestSuite|DataDict]"
+ ) -> "TestSuites[TestSuite[KW, TC]]":
+ return TestSuites["TestSuite"](self.__class__, self, suites)
@setter
- def tests(self, tests):
- """Tests as a :class:`~.TestCases` object."""
- return TestCases(self.test_class, self, tests)
+ def tests(self, tests: "Sequence[TC|DataDict]") -> TestCases[TC]:
+ return TestCases[TC](self.test_class, self, tests)
@property
- def setup(self):
- """Suite setup as a :class:`~.model.keyword.Keyword` object.
+ def setup(self) -> KW:
+ """Suite setup.
This attribute is a ``Keyword`` object also when a suite has no setup
- but in that case its truth value is ``False``.
+ but in that case its truth value is ``False``. The preferred way to
+ check does a suite have a setup is using :attr:`has_setup`.
Setup can be modified by setting attributes directly::
@@ -113,45 +284,64 @@ def setup(self):
New in Robot Framework 4.0. Earlier setup was accessed like
``suite.keywords.setup``.
"""
- if self._setup is None and self:
- self._setup = create_fixture(None, self, Keyword.SETUP)
+ if self._setup is None:
+ self._setup = create_fixture(
+ self.fixture_class,
+ None,
+ self,
+ Keyword.SETUP,
+ )
return self._setup
@setup.setter
- def setup(self, setup):
- self._setup = create_fixture(setup, self, Keyword.SETUP)
+ def setup(self, setup: "KW|DataDict|None"):
+ self._setup = create_fixture(
+ self.fixture_class,
+ setup,
+ self,
+ Keyword.SETUP,
+ )
@property
- def has_setup(self):
+ def has_setup(self) -> bool:
"""Check does a suite have a setup without creating a setup object.
A difference between using ``if suite.has_setup:`` and ``if suite.setup:``
is that accessing the :attr:`setup` attribute creates a :class:`Keyword`
object representing the setup even when the suite actually does not have
one. This typically does not matter, but with bigger suite structures
- containing a huge about of suites it can have some effect on memory usage.
+ it can have some effect on memory usage.
New in Robot Framework 5.0.
"""
-
return bool(self._setup)
@property
- def teardown(self):
- """Suite teardown as a :class:`~.model.keyword.Keyword` object.
+ def teardown(self) -> KW:
+ """Suite teardown.
See :attr:`setup` for more information.
"""
- if self._teardown is None and self:
- self._teardown = create_fixture(None, self, Keyword.TEARDOWN)
+ if self._teardown is None:
+ self._teardown = create_fixture(
+ self.fixture_class,
+ None,
+ self,
+ Keyword.TEARDOWN,
+ )
return self._teardown
@teardown.setter
- def teardown(self, teardown):
- self._teardown = create_fixture(teardown, self, Keyword.TEARDOWN)
+ def teardown(self, teardown: "KW|DataDict|None"):
+ self._teardown = create_fixture(
+ self.fixture_class,
+ teardown,
+ self,
+ Keyword.TEARDOWN,
+ )
@property
- def has_teardown(self):
+ def has_teardown(self) -> bool:
"""Check does a suite have a teardown without creating a teardown object.
See :attr:`has_setup` for more information.
@@ -161,20 +351,7 @@ def has_teardown(self):
return bool(self._teardown)
@property
- def keywords(self):
- """Deprecated since Robot Framework 4.0
-
- Use :attr:`setup` or :attr:`teardown` instead.
- """
- keywords = [self.setup, self.teardown]
- return Keywords(self, [kw for kw in keywords if kw])
-
- @keywords.setter
- def keywords(self, keywords):
- Keywords.raise_deprecation_error()
-
- @property
- def id(self):
+ def id(self) -> str:
"""An automatically generated unique id.
The root suite has id ``s1``, its child suites have ids ``s1-s1``,
@@ -182,25 +359,41 @@ def id(self):
..., ``s1-s2-s1``, ..., and so on.
The first test in a suite has an id like ``s1-t1``, the second has an
- id ``s1-t2``, and so on. Similarly keywords in suites (setup/teardown)
+ id ``s1-t2``, and so on. Similarly, keywords in suites (setup/teardown)
and in tests get ids like ``s1-k1``, ``s1-t1-k1``, and ``s1-s4-t2-k5``.
"""
if not self.parent:
- return 's1'
- return '%s-s%d' % (self.parent.id, self.parent.suites.index(self)+1)
+ return "s1"
+ suites = self.parent.suites
+ index = suites.index(self) if self in suites else len(suites)
+ return f"{self.parent.id}-s{index + 1}"
@property
- def test_count(self):
- """Number of the tests in this suite, recursively."""
- return len(self.tests) + sum(suite.test_count for suite in self.suites)
+ def all_tests(self) -> Iterator[TestCase]:
+ """Yields all tests this suite and its child suites contain.
+
+ New in Robot Framework 6.1.
+ """
+ yield from self.tests
+ for suite in self.suites:
+ yield from suite.all_tests
@property
- def has_tests(self):
- if self.tests:
- return True
- return any(s.has_tests for s in self.suites)
+ def test_count(self) -> int:
+ """Total number of the tests in this suite and in its child suites."""
+ # This is considerably faster than `return len(list(self.all_tests))`.
+ return len(self.tests) + sum(suite.test_count for suite in self.suites)
- def set_tags(self, add=None, remove=None, persist=False):
+ @property
+ def has_tests(self) -> bool:
+ return bool(self.tests) or any(s.has_tests for s in self.suites)
+
+ def set_tags(
+ self,
+ add: Sequence[str] = (),
+ remove: Sequence[str] = (),
+ persist: bool = False,
+ ):
"""Add and/or remove specified tags to the tests in this suite.
:param add: Tags to add as a list or, if adding only one,
@@ -215,8 +408,13 @@ def set_tags(self, add=None, remove=None, persist=False):
if persist:
self._my_visitors.append(setter)
- def filter(self, included_suites=None, included_tests=None,
- included_tags=None, excluded_tags=None):
+ def filter(
+ self,
+ included_suites: "Sequence[str]|None" = None,
+ included_tests: "Sequence[str]|None" = None,
+ included_tags: "Sequence[str]|None" = None,
+ excluded_tags: "Sequence[str]|None" = None,
+ ):
"""Select test cases and remove others from this suite.
Parameters have the same semantics as ``--suite``, ``--test``,
@@ -232,8 +430,9 @@ def filter(self, included_suites=None, included_tests=None,
suite.filter(included_tests=['Test 1', '* Example'],
included_tags='priority-1')
"""
- self.visit(Filter(included_suites, included_tests,
- included_tags, excluded_tags))
+ self.visit(
+ Filter(included_suites, included_tests, included_tags, excluded_tags)
+ )
def configure(self, **options):
"""A shortcut to configure a suite using one method call.
@@ -249,25 +448,48 @@ def configure(self, **options):
one call.
"""
if self.parent is not None:
- raise ValueError("'TestSuite.configure()' can only be used with "
- "the root test suite.")
+ raise ValueError(
+ "'TestSuite.configure()' can only be used with the root test suite."
+ )
if options:
self.visit(SuiteConfigurer(**options))
- def remove_empty_suites(self, preserve_direct_children=False):
+ def remove_empty_suites(self, preserve_direct_children: bool = False):
"""Removes all child suites not containing any tests, recursively."""
self.visit(EmptySuiteRemover(preserve_direct_children))
- def visit(self, visitor):
+ def visit(self, visitor: SuiteVisitor):
""":mod:`Visitor interface ` entry-point."""
visitor.visit_suite(self)
- def __str__(self):
- return self.name
-
-
-class TestSuites(ItemList):
- __slots__ = []
-
- def __init__(self, suite_class=TestSuite, parent=None, suites=None):
- ItemList.__init__(self, suite_class, {'parent': parent}, suites)
+ def to_dict(self) -> "dict[str, Any]":
+ data: "dict[str, Any]" = {"name": self.name}
+ if self.doc:
+ data["doc"] = self.doc
+ if self.metadata:
+ data["metadata"] = dict(self.metadata)
+ if self.source:
+ data["source"] = str(self.source)
+ if self.rpa:
+ data["rpa"] = self.rpa
+ if self.has_setup:
+ data["setup"] = self.setup.to_dict()
+ if self.has_teardown:
+ data["teardown"] = self.teardown.to_dict()
+ if self.tests:
+ data["tests"] = self.tests.to_dicts()
+ if self.suites:
+ data["suites"] = self.suites.to_dicts()
+ return data
+
+
+class TestSuites(ItemList[TS]):
+ __slots__ = ()
+
+ def __init__(
+ self,
+ suite_class: Type[TS] = TestSuite,
+ parent: "TS|None" = None,
+ suites: "Sequence[TS|DataDict]" = (),
+ ):
+ super().__init__(suite_class, {"parent": parent}, suites)
diff --git a/src/robot/model/totalstatistics.py b/src/robot/model/totalstatistics.py
index 9d6762da76e..9e148a12cdf 100644
--- a/src/robot/model/totalstatistics.py
+++ b/src/robot/model/totalstatistics.py
@@ -13,7 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import test_or_task
+from collections.abc import Iterator
+
+from robot.utils import plural_or_not, test_or_task
from .stats import TotalStat
from .visitor import SuiteVisitor
@@ -22,55 +24,48 @@
class TotalStatistics:
"""Container for total statistics."""
- def __init__(self, rpa=False):
+ def __init__(self, rpa: bool = False):
#: Instance of :class:`~robot.model.stats.TotalStat` for all the tests.
- self._stat = TotalStat(test_or_task('All {Test}s', rpa))
+ self.stat = TotalStat(test_or_task("All {Test}s", rpa))
self._rpa = rpa
def visit(self, visitor):
- visitor.visit_total_statistics(self._stat)
+ visitor.visit_total_statistics(self.stat)
- def __iter__(self):
- yield self._stat
+ def __iter__(self) -> "Iterator[TotalStat]":
+ yield self.stat
@property
- def total(self):
- return self._stat.total
+ def total(self) -> int:
+ return self.stat.total
@property
- def passed(self):
- return self._stat.passed
+ def passed(self) -> int:
+ return self.stat.passed
@property
- def skipped(self):
- return self._stat.skipped
+ def skipped(self) -> int:
+ return self.stat.skipped
@property
- def failed(self):
- return self._stat.failed
+ def failed(self) -> int:
+ return self.stat.failed
def add_test(self, test):
- self._stat.add_test(test)
+ self.stat.add_test(test)
@property
- def message(self):
+ def message(self) -> str:
"""String representation of the statistics.
For example::
2 tests, 1 passed, 1 failed
"""
- # TODO: should this message be highlighted in console
- test_or_task = 'test' if not self._rpa else 'task'
- total, end, passed, failed, skipped = self._get_counts()
- template = '%d %s%s, %d passed, %d failed'
- if skipped:
- return ((template + ', %d skipped')
- % (total, test_or_task, end, passed, failed, skipped))
- return template % (total, test_or_task, end, passed, failed)
-
- def _get_counts(self):
- ending = 's' if self.total != 1 else ''
- return self.total, ending, self.passed, self.failed, self.skipped
+ kind = test_or_task("test", self._rpa) + plural_or_not(self.total)
+ msg = f"{self.total} {kind}, {self.passed} passed, {self.failed} failed"
+ if self.skipped:
+ msg += f", {self.skipped} skipped"
+ return msg
class TotalStatisticsBuilder(SuiteVisitor):
diff --git a/src/robot/model/visitor.py b/src/robot/model/visitor.py
index 21e425462ac..a046bafc129 100644
--- a/src/robot/model/visitor.py
+++ b/src/robot/model/visitor.py
@@ -21,7 +21,7 @@
the visitor methods are slightly different depending on the model they are
used with. The main differences are that on the execution side keywords do
not have child keywords nor messages, and that only the result objects have
-status related attributes like :attr:`status` and :attr:`starttime`.
+status related attributes like :attr:`status` and :attr:`start_time`.
This module contains :class:`SuiteVisitor` that implements the core logic to
visit a test suite structure, and the :mod:`~robot.result` package contains
@@ -74,8 +74,43 @@
internally by Robot Framework itself. Some good examples are
:class:`~robot.model.tagsetter.TagSetter` and
:mod:`keyword removers `.
+
+Type hints
+----------
+
+Visitor methods have type hints to give more information about the model objects
+they receive to editors. Because visitors can be used with both running and result
+models, the types that are used as type hints are base classes from the
+:mod:`robot.model` module. Actual visitor implementations can import appropriate
+types from the :mod:`robot.running` or the :mod:`robot.result` module instead.
+For example, this visitor uses the result side model objects::
+
+ from robot.api import SuiteVisitor
+ from robot.result import TestCase, TestSuite
+
+
+ class FailurePrinter(SuiteVisitor):
+
+ def start_suite(self, suite: TestSuite):
+ print(f"{suite.full_name}: {suite.statistics.failed} failed")
+
+ def visit_test(self, test: TestCase):
+ if test.failed:
+ print(f'- {test.name}: {test.message}')
+
+Type hints were added in Robot Framework 6.1. They are optional and can be
+removed altogether if they get in the way.
"""
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+ from robot.model import (
+ BodyItem, Break, Continue, Error, For, Group, If, IfBranch, Keyword, Message,
+ Return, TestCase, TestSuite, Try, TryBranch, Var, While
+ )
+ from robot.result import ForIteration, WhileIteration
+
class SuiteVisitor:
"""Abstract class to ease traversing through the suite structure.
@@ -84,7 +119,7 @@ class SuiteVisitor:
information and an example.
"""
- def visit_suite(self, suite):
+ def visit_suite(self, suite: "TestSuite"):
"""Implements traversing through suites.
Can be overridden to allow modifying the passed in ``suite`` without
@@ -100,18 +135,18 @@ def visit_suite(self, suite):
suite.teardown.visit(self)
self.end_suite(suite)
- def start_suite(self, suite):
+ def start_suite(self, suite: "TestSuite") -> "bool|None":
"""Called when a suite starts. Default implementation does nothing.
Can return explicit ``False`` to stop visiting.
"""
pass
- def end_suite(self, suite):
+ def end_suite(self, suite: "TestSuite"):
"""Called when a suite ends. Default implementation does nothing."""
pass
- def visit_test(self, test):
+ def visit_test(self, test: "TestCase"):
"""Implements traversing through tests.
Can be overridden to allow modifying the passed in ``test`` without calling
@@ -125,32 +160,43 @@ def visit_test(self, test):
test.teardown.visit(self)
self.end_test(test)
- def start_test(self, test):
+ def start_test(self, test: "TestCase") -> "bool|None":
"""Called when a test starts. Default implementation does nothing.
Can return explicit ``False`` to stop visiting.
"""
pass
- def end_test(self, test):
+ def end_test(self, test: "TestCase"):
"""Called when a test ends. Default implementation does nothing."""
pass
- def visit_keyword(self, kw):
+ def visit_keyword(self, keyword: "Keyword"):
"""Implements traversing through keywords.
Can be overridden to allow modifying the passed in ``kw`` without
calling :meth:`start_keyword` or :meth:`end_keyword` nor visiting
the body of the keyword
"""
- if self.start_keyword(kw) is not False:
- if hasattr(kw, 'body'):
- kw.body.visit(self)
- if kw.has_teardown:
- kw.teardown.visit(self)
- self.end_keyword(kw)
+ if self.start_keyword(keyword) is not False:
+ self._possible_setup(keyword)
+ self._possible_body(keyword)
+ self._possible_teardown(keyword)
+ self.end_keyword(keyword)
+
+ def _possible_setup(self, item: "BodyItem"):
+ if getattr(item, "has_setup", False):
+ item.setup.visit(self) # type: ignore
+
+ def _possible_body(self, item: "BodyItem"):
+ if hasattr(item, "body"):
+ item.body.visit(self) # type: ignore
+
+ def _possible_teardown(self, item: "BodyItem"):
+ if getattr(item, "has_teardown", False):
+ item.teardown.visit(self) # type: ignore
- def start_keyword(self, keyword):
+ def start_keyword(self, keyword: "Keyword") -> "bool|None":
"""Called when a keyword starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -159,14 +205,14 @@ def start_keyword(self, keyword):
"""
return self.start_body_item(keyword)
- def end_keyword(self, keyword):
+ def end_keyword(self, keyword: "Keyword"):
"""Called when a keyword ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(keyword)
- def visit_for(self, for_):
+ def visit_for(self, for_: "For"):
"""Implements traversing through FOR loops.
Can be overridden to allow modifying the passed in ``for_`` without
@@ -176,7 +222,7 @@ def visit_for(self, for_):
for_.body.visit(self)
self.end_for(for_)
- def start_for(self, for_):
+ def start_for(self, for_: "For") -> "bool|None":
"""Called when a FOR loop starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -185,14 +231,14 @@ def start_for(self, for_):
"""
return self.start_body_item(for_)
- def end_for(self, for_):
+ def end_for(self, for_: "For"):
"""Called when a FOR loop ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(for_)
- def visit_for_iteration(self, iteration):
+ def visit_for_iteration(self, iteration: "ForIteration"):
"""Implements traversing through single FOR loop iteration.
This is only used with the result side model because on the running side
@@ -206,7 +252,7 @@ def visit_for_iteration(self, iteration):
iteration.body.visit(self)
self.end_for_iteration(iteration)
- def start_for_iteration(self, iteration):
+ def start_for_iteration(self, iteration: "ForIteration") -> "bool|None":
"""Called when a FOR loop iteration starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -215,18 +261,19 @@ def start_for_iteration(self, iteration):
"""
return self.start_body_item(iteration)
- def end_for_iteration(self, iteration):
+ def end_for_iteration(self, iteration: "ForIteration"):
"""Called when a FOR loop iteration ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(iteration)
- def visit_if(self, if_):
+ def visit_if(self, if_: "If"):
"""Implements traversing through IF/ELSE structures.
- Notice that ``if_`` does not have any data directly. Actual IF/ELSE branches
- are in its ``body`` and visited using :meth:`visit_if_branch`.
+ Notice that ``if_`` does not have any data directly. Actual IF/ELSE
+ branches are in its ``body`` and they are visited separately using
+ :meth:`visit_if_branch`.
Can be overridden to allow modifying the passed in ``if_`` without
calling :meth:`start_if` or :meth:`end_if` nor visiting branches.
@@ -235,7 +282,7 @@ def visit_if(self, if_):
if_.body.visit(self)
self.end_if(if_)
- def start_if(self, if_):
+ def start_if(self, if_: "If") -> "bool|None":
"""Called when an IF/ELSE structure starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -244,14 +291,14 @@ def start_if(self, if_):
"""
return self.start_body_item(if_)
- def end_if(self, if_):
+ def end_if(self, if_: "If"):
"""Called when an IF/ELSE structure ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(if_)
- def visit_if_branch(self, branch):
+ def visit_if_branch(self, branch: "IfBranch"):
"""Implements traversing through single IF/ELSE branch.
Can be overridden to allow modifying the passed in ``branch`` without
@@ -261,7 +308,7 @@ def visit_if_branch(self, branch):
branch.body.visit(self)
self.end_if_branch(branch)
- def start_if_branch(self, branch):
+ def start_if_branch(self, branch: "IfBranch") -> "bool|None":
"""Called when an IF/ELSE branch starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -270,14 +317,14 @@ def start_if_branch(self, branch):
"""
return self.start_body_item(branch)
- def end_if_branch(self, branch):
+ def end_if_branch(self, branch: "IfBranch"):
"""Called when an IF/ELSE branch ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(branch)
- def visit_try(self, try_):
+ def visit_try(self, try_: "Try"):
"""Implements traversing through TRY/EXCEPT structures.
This method is used with the TRY/EXCEPT root element. Actual TRY, EXCEPT, ELSE
@@ -287,7 +334,7 @@ def visit_try(self, try_):
try_.body.visit(self)
self.end_try(try_)
- def start_try(self, try_):
+ def start_try(self, try_: "Try") -> "bool|None":
"""Called when a TRY/EXCEPT structure starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -296,20 +343,20 @@ def start_try(self, try_):
"""
return self.start_body_item(try_)
- def end_try(self, try_):
+ def end_try(self, try_: "Try"):
"""Called when a TRY/EXCEPT structure ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(try_)
- def visit_try_branch(self, branch):
+ def visit_try_branch(self, branch: "TryBranch"):
"""Visits individual TRY, EXCEPT, ELSE and FINALLY branches."""
if self.start_try_branch(branch) is not False:
branch.body.visit(self)
self.end_try_branch(branch)
- def start_try_branch(self, branch):
+ def start_try_branch(self, branch: "TryBranch") -> "bool|None":
"""Called when TRY, EXCEPT, ELSE or FINALLY branches start.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -318,14 +365,14 @@ def start_try_branch(self, branch):
"""
return self.start_body_item(branch)
- def end_try_branch(self, branch):
+ def end_try_branch(self, branch: "TryBranch"):
"""Called when TRY, EXCEPT, ELSE and FINALLY branches end.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(branch)
- def visit_while(self, while_):
+ def visit_while(self, while_: "While"):
"""Implements traversing through WHILE loops.
Can be overridden to allow modifying the passed in ``while_`` without
@@ -335,7 +382,7 @@ def visit_while(self, while_):
while_.body.visit(self)
self.end_while(while_)
- def start_while(self, while_):
+ def start_while(self, while_: "While") -> "bool|None":
"""Called when a WHILE loop starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -344,14 +391,14 @@ def start_while(self, while_):
"""
return self.start_body_item(while_)
- def end_while(self, while_):
+ def end_while(self, while_: "While"):
"""Called when a WHILE loop ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(while_)
- def visit_while_iteration(self, iteration):
+ def visit_while_iteration(self, iteration: "WhileIteration"):
"""Implements traversing through single WHILE loop iteration.
This is only used with the result side model because on the running side
@@ -365,7 +412,7 @@ def visit_while_iteration(self, iteration):
iteration.body.visit(self)
self.end_while_iteration(iteration)
- def start_while_iteration(self, iteration):
+ def start_while_iteration(self, iteration: "WhileIteration") -> "bool|None":
"""Called when a WHILE loop iteration starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -374,21 +421,68 @@ def start_while_iteration(self, iteration):
"""
return self.start_body_item(iteration)
- def end_while_iteration(self, iteration):
+ def end_while_iteration(self, iteration: "WhileIteration"):
"""Called when a WHILE loop iteration ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(iteration)
- def visit_return(self, return_):
+ def visit_group(self, group: "Group"):
+ """Visits GROUP elements.
+
+ Can be overridden to allow modifying the passed in ``group`` without
+ calling :meth:`start_group` or :meth:`end_group` nor visiting body.
+ """
+ if self.start_group(group) is not False:
+ group.body.visit(self)
+ self.end_group(group)
+
+ def start_group(self, group: "Group") -> "bool|None":
+ """Called when a GROUP element starts.
+
+ By default, calls :meth:`start_body_item` which, by default, does nothing.
+
+ Can return explicit ``False`` to stop visiting.
+ """
+ return self.start_body_item(group)
+
+ def end_group(self, group: "Group"):
+ """Called when a GROUP element ends.
+
+ By default, calls :meth:`end_body_item` which, by default, does nothing.
+ """
+ self.end_body_item(group)
+
+ def visit_var(self, var: "Var"):
+ """Visits a VAR elements."""
+ if self.start_var(var) is not False:
+ self._possible_body(var)
+ self.end_var(var)
+
+ def start_var(self, var: "Var") -> "bool|None":
+ """Called when a VAR element starts.
+
+ By default, calls :meth:`start_body_item` which, by default, does nothing.
+
+ Can return explicit ``False`` to stop visiting.
+ """
+ return self.start_body_item(var)
+
+ def end_var(self, var: "Var"):
+ """Called when a VAR element ends.
+
+ By default, calls :meth:`end_body_item` which, by default, does nothing.
+ """
+ self.end_body_item(var)
+
+ def visit_return(self, return_: "Return"):
"""Visits a RETURN elements."""
if self.start_return(return_) is not False:
- if hasattr(return_, 'body'):
- return_.body.visit(self)
+ self._possible_body(return_)
self.end_return(return_)
- def start_return(self, return_):
+ def start_return(self, return_: "Return") -> "bool|None":
"""Called when a RETURN element starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -397,21 +491,20 @@ def start_return(self, return_):
"""
return self.start_body_item(return_)
- def end_return(self, return_):
+ def end_return(self, return_: "Return"):
"""Called when a RETURN element ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(return_)
- def visit_continue(self, continue_):
+ def visit_continue(self, continue_: "Continue"):
"""Visits CONTINUE elements."""
if self.start_continue(continue_) is not False:
- if hasattr(continue_, 'body'):
- continue_.body.visit(self)
+ self._possible_body(continue_)
self.end_continue(continue_)
- def start_continue(self, continue_):
+ def start_continue(self, continue_: "Continue") -> "bool|None":
"""Called when a CONTINUE element starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -420,21 +513,20 @@ def start_continue(self, continue_):
"""
return self.start_body_item(continue_)
- def end_continue(self, continue_):
+ def end_continue(self, continue_: "Continue"):
"""Called when a CONTINUE element ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(continue_)
- def visit_break(self, break_):
+ def visit_break(self, break_: "Break"):
"""Visits BREAK elements."""
if self.start_break(break_) is not False:
- if hasattr(break_, 'body'):
- break_.body.visit(self)
+ self._possible_body(break_)
self.end_break(break_)
- def start_break(self, break_):
+ def start_break(self, break_: "Break") -> "bool|None":
"""Called when a BREAK element starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
@@ -443,39 +535,65 @@ def start_break(self, break_):
"""
return self.start_body_item(break_)
- def end_break(self, break_):
+ def end_break(self, break_: "Break"):
"""Called when a BREAK element ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
self.end_body_item(break_)
- def visit_message(self, msg):
+ def visit_error(self, error: "Error"):
+ """Visits body items resulting from invalid syntax.
+
+ Examples include syntax like ``END`` or ``ELSE`` in wrong place and
+ invalid setting like ``[Invalid]``.
+ """
+ if self.start_error(error) is not False:
+ self._possible_body(error)
+ self.end_error(error)
+
+ def start_error(self, error: "Error") -> "bool|None":
+ """Called when a ERROR element starts.
+
+ By default, calls :meth:`start_body_item` which, by default, does nothing.
+
+ Can return explicit ``False`` to stop visiting.
+ """
+ return self.start_body_item(error)
+
+ def end_error(self, error: "Error"):
+ """Called when a ERROR element ends.
+
+ By default, calls :meth:`end_body_item` which, by default, does nothing.
+ """
+ self.end_body_item(error)
+
+ def visit_message(self, message: "Message"):
"""Implements visiting messages.
Can be overridden to allow modifying the passed in ``msg`` without
calling :meth:`start_message` or :meth:`end_message`.
"""
- if self.start_message(msg) is not False:
- self.end_message(msg)
+ if self.start_message(message) is not False:
+ self.end_message(message)
- def start_message(self, msg):
+ def start_message(self, message: "Message") -> "bool|None":
"""Called when a message starts.
By default, calls :meth:`start_body_item` which, by default, does nothing.
Can return explicit ``False`` to stop visiting.
"""
- return self.start_body_item(msg)
+ return self.start_body_item(message)
- def end_message(self, msg):
+ def end_message(self, message: "Message"):
"""Called when a message ends.
By default, calls :meth:`end_body_item` which, by default, does nothing.
"""
- self.end_body_item(msg)
+ self.end_body_item(message)
- def start_body_item(self, item):
+ def start_body_item(self, item: "BodyItem") -> "bool|None":
"""Called, by default, when keywords, messages or control structures start.
More specific :meth:`start_keyword`, :meth:`start_message`, `:meth:`start_for`,
@@ -487,7 +605,7 @@ def start_body_item(self, item):
"""
pass
- def end_body_item(self, item):
+ def end_body_item(self, item: "BodyItem"):
"""Called, by default, when keywords, messages or control structures end.
More specific :meth:`end_keyword`, :meth:`end_message`, `:meth:`end_for`,
diff --git a/src/robot/output/__init__.py b/src/robot/output/__init__.py
index 7c782c864d8..a3265b6f987 100644
--- a/src/robot/output/__init__.py
+++ b/src/robot/output/__init__.py
@@ -19,7 +19,8 @@
test execution is refactored.
"""
-from .output import Output
-from .logger import LOGGER
-from .xmllogger import XmlLogger
-from .loggerhelper import LEVELS, Message
+from .logger import LOGGER as LOGGER
+from .loggerhelper import LEVELS as LEVELS, Message as Message
+from .loglevel import LogLevel as LogLevel, SettableLevel as SettableLevel
+from .output import Output as Output
+from .xmllogger import XmlLogger as XmlLogger
diff --git a/src/robot/output/console/__init__.py b/src/robot/output/console/__init__.py
index 813c58342fc..54b3a08fe48 100644
--- a/src/robot/output/console/__init__.py
+++ b/src/robot/output/console/__init__.py
@@ -20,16 +20,25 @@
from .verbose import VerboseOutput
-def ConsoleOutput(type='verbose', width=78, colors='AUTO', markers='AUTO',
- stdout=None, stderr=None):
+def ConsoleOutput(
+ type="verbose",
+ width=78,
+ colors="AUTO",
+ links="AUTO",
+ markers="AUTO",
+ stdout=None,
+ stderr=None,
+):
upper = type.upper()
- if upper == 'VERBOSE':
- return VerboseOutput(width, colors, markers, stdout, stderr)
- if upper == 'DOTTED':
- return DottedOutput(width, colors, stdout, stderr)
- if upper == 'QUIET':
+ if upper == "VERBOSE":
+ return VerboseOutput(width, colors, links, markers, stdout, stderr)
+ if upper == "DOTTED":
+ return DottedOutput(width, colors, links, stdout, stderr)
+ if upper == "QUIET":
return QuietOutput(colors, stderr)
- if upper == 'NONE':
+ if upper == "NONE":
return NoOutput()
- raise DataError("Invalid console output type '%s'. Available "
- "'VERBOSE', 'DOTTED', 'QUIET' and 'NONE'." % type)
+ raise DataError(
+ f"Invalid console output type '{type}'. Available "
+ f"'VERBOSE', 'DOTTED', 'QUIET' and 'NONE'."
+ )
diff --git a/src/robot/output/console/dotted.py b/src/robot/output/console/dotted.py
index 3a72f688326..4c10cf521e8 100644
--- a/src/robot/output/console/dotted.py
+++ b/src/robot/output/console/dotted.py
@@ -14,77 +14,82 @@
# limitations under the License.
import sys
+from typing import TYPE_CHECKING
from robot.model import SuiteVisitor
-from robot.utils import plural_or_not, secs_to_timestr
+from robot.utils import plural_or_not as s, secs_to_timestr
+from ..loggerapi import LoggerApi
from .highlighting import HighlightingStream
-
-class DottedOutput:
-
- def __init__(self, width=78, colors='AUTO', stdout=None, stderr=None):
- self._width = width
- self._stdout = HighlightingStream(stdout or sys.__stdout__, colors)
- self._stderr = HighlightingStream(stderr or sys.__stderr__, colors)
- self._markers_on_row = 0
-
- def start_suite(self, suite):
- if not suite.parent:
- self._stdout.write("Running suite '%s' with %d %s%s.\n"
- % (suite.name, suite.test_count,
- 'test' if not suite.rpa else 'task',
- plural_or_not(suite.test_count)))
- self._stdout.write('=' * self._width + '\n')
-
- def end_test(self, test):
- if self._markers_on_row == self._width:
- self._stdout.write('\n')
- self._markers_on_row = 0
- self._markers_on_row += 1
- if test.passed:
- self._stdout.write('.')
- elif test.skipped:
- self._stdout.highlight('s', 'SKIP')
- elif 'robot:exit' in test.tags:
- self._stdout.write('x')
+if TYPE_CHECKING:
+ from robot.result import TestCase, TestSuite
+
+
+class DottedOutput(LoggerApi):
+
+ def __init__(self, width=78, colors="AUTO", links="AUTO", stdout=None, stderr=None):
+ self.width = width
+ self.stdout = HighlightingStream(stdout or sys.__stdout__, colors, links)
+ self.stderr = HighlightingStream(stderr or sys.__stderr__, colors, links)
+ self.markers_on_row = 0
+
+ def start_suite(self, data, result):
+ if not data.parent:
+ count = data.test_count
+ ts = ("test" if not data.rpa else "task") + s(count)
+ self.stdout.write(f"Running suite '{result.name}' with {count} {ts}.\n")
+ self.stdout.write("=" * self.width + "\n")
+
+ def end_test(self, data, result):
+ if self.markers_on_row == self.width:
+ self.stdout.write("\n")
+ self.markers_on_row = 0
+ self.markers_on_row += 1
+ if result.passed:
+ self.stdout.write(".")
+ elif result.skipped:
+ self.stdout.highlight("s", "SKIP")
+ elif result.tags.robot("exit"):
+ self.stdout.write("x")
else:
- self._stdout.highlight('F', 'FAIL')
+ self.stdout.highlight("F", "FAIL")
- def end_suite(self, suite):
- if not suite.parent:
- self._stdout.write('\n')
- StatusReporter(self._stdout, self._width).report(suite)
- self._stdout.write('\n')
+ def end_suite(self, data, result):
+ if not data.parent:
+ self.stdout.write("\n")
+ StatusReporter(self.stdout, self.width).report(result)
+ self.stdout.write("\n")
def message(self, msg):
- if msg.level in ('WARN', 'ERROR'):
- self._stderr.error(msg.message, msg.level)
+ if msg.level in ("WARN", "ERROR") and msg.console:
+ self.stderr.error(msg.message, msg.level)
- def output_file(self, name, path):
- self._stdout.write('%-8s %s\n' % (name+':', path))
+ def result_file(self, kind, path):
+ self.stdout.result_file(kind, path)
class StatusReporter(SuiteVisitor):
def __init__(self, stream, width):
- self._stream = stream
- self._width = width
+ self.stream = stream
+ self.width = width
- def report(self, suite):
+ def report(self, suite: "TestSuite"):
suite.visit(self)
stats = suite.statistics
- self._stream.write("%s\nRun suite '%s' with %d %s%s in %s.\n\n"
- % ('=' * self._width, suite.name, stats.total,
- 'test' if not suite.rpa else 'task',
- plural_or_not(stats.total),
- secs_to_timestr(suite.elapsedtime/1000.0)))
- self._stream.highlight(suite.status + ('PED' if suite.status == 'SKIP' else 'ED'), suite.status)
- self._stream.write('\n%s\n' % stats.message)
-
- def visit_test(self, test):
- if test.failed and 'robot:exit' not in test.tags:
- self._stream.write('-' * self._width + '\n')
- self._stream.highlight('FAIL')
- self._stream.write(': %s\n%s\n' % (test.longname,
- test.message.strip()))
+ ts = ("test" if not suite.rpa else "task") + s(stats.total)
+ elapsed = secs_to_timestr(suite.elapsed_time)
+ self.stream.write(
+ f"{'=' * self.width}\nRun suite '{suite.name}' with "
+ f"{stats.total} {ts} in {elapsed}.\n\n"
+ )
+ ed = "ED" if suite.status != "SKIP" else "PED"
+ self.stream.highlight(suite.status + ed, suite.status)
+ self.stream.write(f"\n{stats.message}\n")
+
+ def visit_test(self, test: "TestCase"):
+ if test.failed and not test.tags.robot("exit"):
+ self.stream.write("-" * self.width + "\n")
+ self.stream.highlight("FAIL")
+ self.stream.write(f": {test.full_name}\n{test.message.strip()}\n")
diff --git a/src/robot/output/console/highlighting.py b/src/robot/output/console/highlighting.py
index f65055290f8..d9c7028853b 100644
--- a/src/robot/output/console/highlighting.py
+++ b/src/robot/output/console/highlighting.py
@@ -17,14 +17,28 @@
# Andre Burgaud, licensed under the MIT License, and available here:
# http://www.burgaud.com/bring-colors-to-the-windows-console-with-python/
-from contextlib import contextmanager
import errno
import os
import sys
+from contextlib import contextmanager
+
try:
- from ctypes import windll, Structure, c_short, c_ushort, byref
+ from ctypes import windll
except ImportError: # Not on Windows
windll = None
+else:
+ from ctypes import byref, c_ushort, Structure
+ from ctypes.wintypes import _COORD, DWORD, SMALL_RECT
+
+ class ConsoleScreenBufferInfo(Structure):
+ _fields_ = [
+ ("dwSize", _COORD),
+ ("dwCursorPosition", _COORD),
+ ("wAttributes", c_ushort),
+ ("srWindow", SMALL_RECT),
+ ("dwMaximumWindowSize", _COORD),
+ ]
+
from robot.errors import DataError
from robot.utils import console_encode, isatty, WINDOWS
@@ -32,21 +46,31 @@
class HighlightingStream:
- def __init__(self, stream, colors='AUTO'):
- self.stream = stream
- self._highlighter = self._get_highlighter(stream, colors)
-
- def _get_highlighter(self, stream, colors):
- options = {'AUTO': Highlighter if isatty(stream) else NoHighlighting,
- 'ON': Highlighter,
- 'OFF': NoHighlighting,
- 'ANSI': AnsiHighlighter}
+ def __init__(self, stream, colors="AUTO", links="AUTO"):
+ self.stream = stream or NullStream()
+ self._highlighter = self._get_highlighter(stream, colors, links)
+
+ def _get_highlighter(self, stream, colors, links):
+ if not stream:
+ return NoHighlighting()
+ options = {
+ "AUTO": Highlighter if isatty(stream) else NoHighlighting,
+ "ON": Highlighter,
+ "OFF": NoHighlighting,
+ "ANSI": AnsiHighlighter,
+ }
try:
highlighter = options[colors.upper()]
except KeyError:
- raise DataError("Invalid console color value '%s'. Available "
- "'AUTO', 'ON', 'OFF' and 'ANSI'." % colors)
- return highlighter(stream)
+ raise DataError(
+ f"Invalid console color value '{colors}'. "
+ f"Available 'AUTO', 'ON', 'OFF' and 'ANSI'."
+ )
+ if links.upper() not in ("AUTO", "OFF"):
+ raise DataError(
+ f"Invalid console link value '{links}. Available 'AUTO' and 'OFF'."
+ )
+ return highlighter(stream, links.upper() == "AUTO")
def write(self, text, flush=True):
self._write(console_encode(text, stream=self.stream))
@@ -62,7 +86,7 @@ def _write(self, text, retry=5):
except IOError as err:
if not (WINDOWS and err.errno == 0 and retry > 0):
raise
- self._write(text, retry-1)
+ self._write(text, retry - 1)
@property
@contextmanager
@@ -78,64 +102,91 @@ def flush(self):
self.stream.flush()
def highlight(self, text, status=None, flush=True):
- if self._must_flush_before_and_after_highlighting():
+ # Must flush before and after highlighting when using Windows APIs to make
+ # sure colors only affects the actual highlighted text.
+ if isinstance(self._highlighter, DosHighlighter):
self.flush()
flush = True
with self._highlighting(status or text):
self.write(text, flush)
- def _must_flush_before_and_after_highlighting(self):
- # Must flush on Windows before and after highlighting to make sure set
- # console colors only affect the actual highlighted text. Problems
- # only encountered with Python 3, but better to be safe than sorry.
- return WINDOWS and not isinstance(self._highlighter, NoHighlighting)
-
def error(self, message, level):
- self.write('[ ', flush=False)
+ self.write("[ ", flush=False)
self.highlight(level, flush=False)
- self.write(' ] %s\n' % message)
+ self.write(f" ] {message}\n")
@contextmanager
def _highlighting(self, status):
highlighter = self._highlighter
- start = {'PASS': highlighter.green,
- 'FAIL': highlighter.red,
- 'ERROR': highlighter.red,
- 'WARN': highlighter.yellow,
- 'SKIP': highlighter.yellow}[status]
+ start = {
+ "PASS": highlighter.green,
+ "FAIL": highlighter.red,
+ "ERROR": highlighter.red,
+ "WARN": highlighter.yellow,
+ "SKIP": highlighter.yellow,
+ }[status]
start()
try:
yield
finally:
highlighter.reset()
+ def result_file(self, kind, path):
+ path = self._highlighter.link(path) if path else "NONE"
+ self.write(f"{kind + ':':8} {path}\n")
+
-def Highlighter(stream):
- if os.sep == '/':
- return AnsiHighlighter(stream)
- return DosHighlighter(stream) if windll else NoHighlighting(stream)
+class NullStream:
+
+ def write(self, text):
+ pass
+
+ def flush(self):
+ pass
+
+
+def Highlighter(stream, links=True):
+ if os.sep == "/":
+ return AnsiHighlighter(stream, links)
+ if not windll:
+ return NoHighlighting(stream)
+ if virtual_terminal_enabled(stream):
+ return AnsiHighlighter(stream, links)
+ return DosHighlighter(stream)
class AnsiHighlighter:
- _ANSI_GREEN = '\033[32m'
- _ANSI_RED = '\033[31m'
- _ANSI_YELLOW = '\033[33m'
- _ANSI_RESET = '\033[0m'
+ GREEN = "\033[32m"
+ RED = "\033[31m"
+ YELLOW = "\033[33m"
+ RESET = "\033[0m"
- def __init__(self, stream):
+ def __init__(self, stream, links=True):
self._stream = stream
+ self._links = links
def green(self):
- self._set_color(self._ANSI_GREEN)
+ self._set_color(self.GREEN)
def red(self):
- self._set_color(self._ANSI_RED)
+ self._set_color(self.RED)
def yellow(self):
- self._set_color(self._ANSI_YELLOW)
+ self._set_color(self.YELLOW)
def reset(self):
- self._set_color(self._ANSI_RESET)
+ self._set_color(self.RESET)
+
+ def link(self, path):
+ if not self._links:
+ return path
+ try:
+ uri = path.as_uri()
+ except ValueError:
+ return path
+ # Terminal hyperlink syntax is documented here:
+ # https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+ return f"\033]8;;{uri}\033\\{path}\033]8;;\033\\"
def _set_color(self, color):
self._stream.write(color)
@@ -143,71 +194,70 @@ def _set_color(self, color):
class NoHighlighting(AnsiHighlighter):
+ def __init__(self, stream=None, links=True):
+ super().__init__(stream, links)
+
+ def link(self, path):
+ return path
+
def _set_color(self, color):
pass
class DosHighlighter:
- _FOREGROUND_GREEN = 0x2
- _FOREGROUND_RED = 0x4
- _FOREGROUND_YELLOW = 0x6
- _FOREGROUND_GREY = 0x7
- _FOREGROUND_INTENSITY = 0x8
- _BACKGROUND_MASK = 0xF0
- _STDOUT_HANDLE = -11
- _STDERR_HANDLE = -12
+ FOREGROUND_GREEN = 0x2
+ FOREGROUND_RED = 0x4
+ FOREGROUND_YELLOW = 0x6
+ FOREGROUND_GREY = 0x7
+ FOREGROUND_INTENSITY = 0x8
+ BACKGROUND_MASK = 0xF0
def __init__(self, stream):
- self._handle = self._get_std_handle(stream)
+ self._handle = get_std_handle(stream)
self._orig_colors = self._get_colors()
- self._background = self._orig_colors & self._BACKGROUND_MASK
+ self._background = self._orig_colors & self.BACKGROUND_MASK
def green(self):
- self._set_foreground_colors(self._FOREGROUND_GREEN)
+ self._set_foreground_colors(self.FOREGROUND_GREEN)
def red(self):
- self._set_foreground_colors(self._FOREGROUND_RED)
+ self._set_foreground_colors(self.FOREGROUND_RED)
def yellow(self):
- self._set_foreground_colors(self._FOREGROUND_YELLOW)
+ self._set_foreground_colors(self.FOREGROUND_YELLOW)
def reset(self):
self._set_colors(self._orig_colors)
- def _get_std_handle(self, stream):
- handle = self._STDOUT_HANDLE \
- if stream is sys.__stdout__ else self._STDERR_HANDLE
- return windll.kernel32.GetStdHandle(handle)
+ def link(self, path):
+ return path
def _get_colors(self):
- csbi = _CONSOLE_SCREEN_BUFFER_INFO()
- ok = windll.kernel32.GetConsoleScreenBufferInfo(self._handle, byref(csbi))
+ info = ConsoleScreenBufferInfo()
+ ok = windll.kernel32.GetConsoleScreenBufferInfo(self._handle, byref(info))
if not ok: # Call failed, return default console colors (gray on black)
- return self._FOREGROUND_GREY
- return csbi.wAttributes
+ return self.FOREGROUND_GREY
+ return info.wAttributes
def _set_foreground_colors(self, colors):
- self._set_colors(colors | self._FOREGROUND_INTENSITY | self._background)
+ self._set_colors(colors | self.FOREGROUND_INTENSITY | self._background)
def _set_colors(self, colors):
windll.kernel32.SetConsoleTextAttribute(self._handle, colors)
-if windll:
-
- class _COORD(Structure):
- _fields_ = [("X", c_short),
- ("Y", c_short)]
+def get_std_handle(stream):
+ handle = -11 if stream is sys.__stdout__ else -12
+ return windll.kernel32.GetStdHandle(handle)
- class _SMALL_RECT(Structure):
- _fields_ = [("Left", c_short),
- ("Top", c_short),
- ("Right", c_short),
- ("Bottom", c_short)]
- class _CONSOLE_SCREEN_BUFFER_INFO(Structure):
- _fields_ = [("dwSize", _COORD),
- ("dwCursorPosition", _COORD),
- ("wAttributes", c_ushort),
- ("srWindow", _SMALL_RECT),
- ("dwMaximumWindowSize", _COORD)]
+def virtual_terminal_enabled(stream):
+ handle = get_std_handle(stream)
+ enable_vt = 0x0004
+ mode = DWORD()
+ if not windll.kernel32.GetConsoleMode(handle, byref(mode)):
+ return False # Calling GetConsoleMode failed.
+ if mode.value & enable_vt:
+ return True # VT already enabled.
+ # Try to enable VT.
+ return windll.kernel32.SetConsoleMode(handle, mode.value | enable_vt) != 0
diff --git a/src/robot/output/console/quiet.py b/src/robot/output/console/quiet.py
index 00f03688d93..52f47462912 100644
--- a/src/robot/output/console/quiet.py
+++ b/src/robot/output/console/quiet.py
@@ -15,18 +15,19 @@
import sys
+from ..loggerapi import LoggerApi
from .highlighting import HighlightingStream
-class QuietOutput:
+class QuietOutput(LoggerApi):
- def __init__(self, colors='AUTO', stderr=None):
+ def __init__(self, colors="AUTO", stderr=None):
self._stderr = HighlightingStream(stderr or sys.__stderr__, colors)
def message(self, msg):
- if msg.level in ('WARN', 'ERROR'):
+ if msg.level in ("WARN", "ERROR") and msg.console:
self._stderr.error(msg.message, msg.level)
-class NoOutput:
+class NoOutput(LoggerApi):
pass
diff --git a/src/robot/output/console/verbose.py b/src/robot/output/console/verbose.py
index 39bd9b3e38f..e3ff11c2722 100644
--- a/src/robot/output/console/verbose.py
+++ b/src/robot/output/console/verbose.py
@@ -16,69 +16,83 @@
import sys
from robot.errors import DataError
-from robot.utils import (get_console_length, getshortdoc, isatty,
- pad_console_length)
+from robot.utils import get_console_length, getshortdoc, isatty, pad_console_length
+from ..loggerapi import LoggerApi
from .highlighting import HighlightingStream
-class VerboseOutput:
-
- def __init__(self, width=78, colors='AUTO', markers='AUTO', stdout=None,
- stderr=None):
- self._writer = VerboseWriter(width, colors, markers, stdout, stderr)
- self._started = False
- self._started_keywords = 0
- self._running_test = False
-
- def start_suite(self, suite):
- if not self._started:
- self._writer.suite_separator()
- self._started = True
- self._writer.info(suite.longname, suite.doc, start_suite=True)
- self._writer.suite_separator()
-
- def end_suite(self, suite):
- self._writer.info(suite.longname, suite.doc)
- self._writer.status(suite.status)
- self._writer.message(suite.full_message)
- self._writer.suite_separator()
-
- def start_test(self, test):
- self._writer.info(test.name, test.doc)
- self._running_test = True
-
- def end_test(self, test):
- self._writer.status(test.status, clear=True)
- self._writer.message(test.message)
- self._writer.test_separator()
- self._running_test = False
-
- def start_keyword(self, kw):
- self._started_keywords += 1
-
- def end_keyword(self, kw):
- self._started_keywords -= 1
- if self._running_test and not self._started_keywords:
- self._writer.keyword_marker(kw.status)
+class VerboseOutput(LoggerApi):
+
+ def __init__(
+ self,
+ width=78,
+ colors="AUTO",
+ links="AUTO",
+ markers="AUTO",
+ stdout=None,
+ stderr=None,
+ ):
+ self.writer = VerboseWriter(width, colors, links, markers, stdout, stderr)
+ self.started = False
+ self.started_keywords = 0
+ self.running_test = False
+
+ def start_suite(self, data, result):
+ if not self.started:
+ self.writer.suite_separator()
+ self.started = True
+ self.writer.info(data.full_name, result.doc, start_suite=True)
+ self.writer.suite_separator()
+
+ def end_suite(self, data, result):
+ self.writer.info(data.full_name, result.doc)
+ self.writer.status(result.status)
+ self.writer.message(result.full_message)
+ self.writer.suite_separator()
+
+ def start_test(self, data, result):
+ self.writer.info(result.name, result.doc)
+ self.running_test = True
+
+ def end_test(self, data, result):
+ self.writer.status(result.status, clear=True)
+ self.writer.message(result.message)
+ self.writer.test_separator()
+ self.running_test = False
+
+ def start_body_item(self, data, result):
+ self.started_keywords += 1
+
+ def end_body_item(self, data, result):
+ self.started_keywords -= 1
+ if self.running_test and not self.started_keywords:
+ self.writer.keyword_marker(result.status)
def message(self, msg):
- if msg.level in ('WARN', 'ERROR'):
- self._writer.error(msg.message, msg.level, clear=self._running_test)
+ if msg.level in ("WARN", "ERROR") and msg.console:
+ self.writer.error(msg.message, msg.level, clear=self.running_test)
- def output_file(self, name, path):
- self._writer.output(name, path)
+ def result_file(self, kind, path):
+ self.writer.result_file(kind, path)
class VerboseWriter:
- _status_length = len('| PASS |')
-
- def __init__(self, width=78, colors='AUTO', markers='AUTO', stdout=None,
- stderr=None):
- self._width = width
- self._stdout = HighlightingStream(stdout or sys.__stdout__, colors)
- self._stderr = HighlightingStream(stderr or sys.__stderr__, colors)
- self._keyword_marker = KeywordMarker(self._stdout, markers)
+ _status_length = len("| PASS |")
+
+ def __init__(
+ self,
+ width=78,
+ colors="AUTO",
+ links="AUTO",
+ markers="AUTO",
+ stdout=None,
+ stderr=None,
+ ):
+ self.width = width
+ self.stdout = HighlightingStream(stdout or sys.__stdout__, colors, links)
+ self.stderr = HighlightingStream(stderr or sys.__stderr__, colors, links)
+ self._keyword_marker = KeywordMarker(self.stdout, markers)
self._last_info = None
def info(self, name, doc, start_suite=False):
@@ -88,35 +102,35 @@ def info(self, name, doc, start_suite=False):
self._keyword_marker.reset_count()
def _write_info(self):
- self._stdout.write(self._last_info)
+ self.stdout.write(self._last_info)
def _get_info_width_and_separator(self, start_suite):
if start_suite:
- return self._width, '\n'
- return self._width - self._status_length - 1, ' '
+ return self.width, "\n"
+ return self.width - self._status_length - 1, " "
def _get_info(self, name, doc, width):
if get_console_length(name) > width:
return pad_console_length(name, width)
- doc = getshortdoc(doc, linesep=' ')
- info = '%s :: %s' % (name, doc) if doc else name
+ doc = getshortdoc(doc, linesep=" ")
+ info = f"{name} :: {doc}" if doc else name
return pad_console_length(info, width)
def suite_separator(self):
- self._fill('=')
+ self._fill("=")
def test_separator(self):
- self._fill('-')
+ self._fill("-")
def _fill(self, char):
- self._stdout.write('%s\n' % (char * self._width))
+ self.stdout.write(f"{char * self.width}\n")
def status(self, status, clear=False):
if self._should_clear_markers(clear):
self._clear_status()
- self._stdout.write('| ', flush=False)
- self._stdout.highlight(status, flush=False)
- self._stdout.write(' |\n')
+ self.stdout.write("| ", flush=False)
+ self.stdout.highlight(status, flush=False)
+ self.stdout.write(" |\n")
def _should_clear_markers(self, clear):
return clear and self._keyword_marker.marking_enabled
@@ -126,12 +140,12 @@ def _clear_status(self):
self._write_info()
def _clear_info(self):
- self._stdout.write('\r%s\r' % (' ' * self._width))
+ self.stdout.write(f"\r{' ' * self.width}\r")
self._keyword_marker.reset_count()
def message(self, message):
if message:
- self._stdout.write(message.strip() + '\n')
+ self.stdout.write(message.strip() + "\n")
def keyword_marker(self, status):
if self._keyword_marker.marker_count == self._status_length:
@@ -142,35 +156,39 @@ def keyword_marker(self, status):
def error(self, message, level, clear=False):
if self._should_clear_markers(clear):
self._clear_info()
- self._stderr.error(message, level)
+ self.stderr.error(message, level)
if self._should_clear_markers(clear):
self._write_info()
- def output(self, name, path):
- self._stdout.write('%-8s %s\n' % (name+':', path))
+ def result_file(self, kind, path):
+ self.stdout.result_file(kind, path)
class KeywordMarker:
def __init__(self, highlighter, markers):
- self._highlighter = highlighter
+ self.highlighter = highlighter
self.marking_enabled = self._marking_enabled(markers, highlighter)
self.marker_count = 0
def _marking_enabled(self, markers, highlighter):
- options = {'AUTO': isatty(highlighter.stream),
- 'ON': True,
- 'OFF': False}
+ options = {
+ "AUTO": isatty(highlighter.stream),
+ "ON": True,
+ "OFF": False,
+ }
try:
return options[markers.upper()]
except KeyError:
- raise DataError("Invalid console marker value '%s'. Available "
- "'AUTO', 'ON' and 'OFF'." % markers)
+ raise DataError(
+ f"Invalid console marker value '{markers}'. "
+ f"Available 'AUTO', 'ON' and 'OFF'."
+ )
def mark(self, status):
if self.marking_enabled:
- marker, status = ('.', 'PASS') if status != 'FAIL' else ('F', 'FAIL')
- self._highlighter.highlight(marker, status)
+ marker, status = (".", "PASS") if status != "FAIL" else ("F", "FAIL")
+ self.highlighter.highlight(marker, status)
self.marker_count += 1
def reset_count(self):
diff --git a/src/robot/output/debugfile.py b/src/robot/output/debugfile.py
index 15797786d69..f79f9f3a9f3 100644
--- a/src/robot/output/debugfile.py
+++ b/src/robot/output/debugfile.py
@@ -13,95 +13,112 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from pathlib import Path
+
from robot.errors import DataError
-from robot.utils import get_timestamp, file_writer, seq2str2
+from robot.utils import file_writer, seq2str2
from .logger import LOGGER
-from .loggerhelper import IsLogged
+from .loggerapi import LoggerApi
+from .loglevel import LogLevel
def DebugFile(path):
if not path:
- LOGGER.info('No debug file')
+ LOGGER.info("No debug file")
return None
try:
- outfile = file_writer(path, usage='debug')
+ outfile = file_writer(path, usage="debug")
except DataError as err:
LOGGER.error(err.message)
return None
else:
- LOGGER.info('Debug file: %s' % path)
+ LOGGER.info(f"Debug file: {path}")
return _DebugFileWriter(outfile)
-class _DebugFileWriter:
- _separators = {'SUITE': '=', 'TEST': '-', 'KEYWORD': '~'}
+class _DebugFileWriter(LoggerApi):
+ _separators = {"SUITE": "=", "TEST": "-", "KEYWORD": "~"}
def __init__(self, outfile):
self._indent = 0
self._kw_level = 0
self._separator_written_last = False
self._outfile = outfile
- self._is_logged = IsLogged('DEBUG')
+ self._is_logged = LogLevel("DEBUG").is_logged
- def start_suite(self, suite):
- self._separator('SUITE')
- self._start('SUITE', suite.longname)
- self._separator('SUITE')
+ def start_suite(self, data, result):
+ self._separator("SUITE")
+ self._start("SUITE", data.full_name, result.start_time)
+ self._separator("SUITE")
- def end_suite(self, suite):
- self._separator('SUITE')
- self._end('SUITE', suite.longname, suite.elapsedtime)
- self._separator('SUITE')
+ def end_suite(self, data, result):
+ self._separator("SUITE")
+ self._end("SUITE", data.full_name, result.end_time, result.elapsed_time)
+ self._separator("SUITE")
if self._indent == 0:
- LOGGER.output_file('Debug', self._outfile.name)
+ LOGGER.debug_file(Path(self._outfile.name))
self.close()
- def start_test(self, test):
- self._separator('TEST')
- self._start('TEST', test.name)
- self._separator('TEST')
+ def start_test(self, data, result):
+ self._separator("TEST")
+ self._start("TEST", result.name, result.start_time)
+ self._separator("TEST")
+
+ def end_test(self, data, result):
+ self._separator("TEST")
+ self._end("TEST", result.name, result.end_time, result.elapsed_time)
+ self._separator("TEST")
+
+ def start_keyword(self, data, result):
+ if self._kw_level == 0:
+ self._separator("KEYWORD")
+ self._start(
+ result.type, result.full_name, result.start_time, seq2str2(result.args)
+ )
+ self._kw_level += 1
- def end_test(self, test):
- self._separator('TEST')
- self._end('TEST', test.name, test.elapsedtime)
- self._separator('TEST')
+ def end_keyword(self, data, result):
+ self._end(result.type, result.full_name, result.end_time, result.elapsed_time)
+ self._kw_level -= 1
- def start_keyword(self, kw):
+ def start_body_item(self, data, result):
if self._kw_level == 0:
- self._separator('KEYWORD')
- self._start(kw.type, kw.name, kw.args)
+ self._separator("KEYWORD")
+ self._start(result.type, result._log_name, result.start_time)
self._kw_level += 1
- def end_keyword(self, kw):
- self._end(kw.type, kw.name, kw.elapsedtime)
+ def end_body_item(self, data, result):
+ self._end(result.type, result._log_name, result.end_time, result.elapsed_time)
self._kw_level -= 1
def log_message(self, msg):
- if self._is_logged(msg.level):
- self._write(msg.message, level=msg.level, timestamp=msg.timestamp)
+ if self._is_logged(msg):
+ self._write(f"{msg.timestamp} - {msg.level} - {msg.message}")
def close(self):
if not self._outfile.closed:
self._outfile.close()
- def _start(self, type_, name, args=''):
- args = ' ' + seq2str2(args)
- self._write('+%s START %s: %s%s' % ('-'*self._indent, type_, name, args))
+ def _start(self, type, name, timestamp, extra=""):
+ if extra:
+ extra = f" {extra}"
+ indent = "-" * self._indent
+ self._write(f"{timestamp} - INFO - +{indent} START {type}: {name}{extra}")
self._indent += 1
- def _end(self, type_, name, elapsed):
+ def _end(self, type, name, timestamp, elapsed):
self._indent -= 1
- self._write('+%s END %s: %s (%s)' % ('-'*self._indent, type_, name, elapsed))
+ indent = "-" * self._indent
+ elapsed = elapsed.total_seconds()
+ self._write(f"{timestamp} - INFO - +{indent} END {type}: {name} ({elapsed} s)")
def _separator(self, type_):
self._write(self._separators[type_] * 78, separator=True)
- def _write(self, text, separator=False, level='INFO', timestamp=None):
+ def _write(self, text, separator=False):
if separator and self._separator_written_last:
return
- if not separator:
- text = '%s - %s - %s' % (timestamp or get_timestamp(), level, text)
- self._outfile.write(text.rstrip() + '\n')
+ self._outfile.write(text.rstrip() + "\n")
self._outfile.flush()
self._separator_written_last = separator
diff --git a/src/robot/output/filelogger.py b/src/robot/output/filelogger.py
index c66b3675c3b..727ba38dbf2 100644
--- a/src/robot/output/filelogger.py
+++ b/src/robot/output/filelogger.py
@@ -13,46 +13,66 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from robot.errors import DataError
from robot.utils import file_writer
+from .loggerapi import LoggerApi
from .loggerhelper import AbstractLogger
+from .loglevel import LogLevel
-class FileLogger(AbstractLogger):
+class FileLogger(AbstractLogger, LoggerApi):
def __init__(self, path, level):
- super().__init__(level)
+ try:
+ self._log_level = LogLevel(level)
+ except ValueError as err:
+ raise DataError(err)
self._writer = self._get_writer(path) # unit test hook
def _get_writer(self, path):
- return file_writer(path, usage='syslog')
+ return file_writer(path, usage="syslog")
+
+ def set_level(self, level):
+ self._log_level.set(level)
def message(self, msg):
- if self._is_logged(msg.level) and not self._writer.closed:
- entry = '%s | %s | %s\n' % (msg.timestamp, msg.level.ljust(5),
- msg.message)
+ if self._log_level.is_logged(msg) and not self._writer.closed:
+ entry = f"{msg.timestamp} | {msg.level:5} | {msg.message}\n"
self._writer.write(entry)
- def start_suite(self, suite):
- self.info("Started suite '%s'." % suite.name)
+ def start_suite(self, data, result):
+ self.info(f"Started suite '{result.name}'.")
- def end_suite(self, suite):
- self.info("Ended suite '%s'." % suite.name)
+ def end_suite(self, data, result):
+ self.info(f"Ended suite '{result.name}'.")
- def start_test(self, test):
- self.info("Started test '%s'." % test.name)
+ def start_test(self, data, result):
+ self.info(f"Started test '{result.name}'.")
- def end_test(self, test):
- self.info("Ended test '%s'." % test.name)
+ def end_test(self, data, result):
+ self.info(f"Ended test '{result.name}'.")
- def start_keyword(self, kw):
- self.debug(lambda: "Started keyword '%s'." % kw.name)
+ def start_body_item(self, data, result):
+ self.debug(
+ lambda: (
+ f"Started keyword '{result.name}'."
+ if result.type in result.KEYWORD_TYPES
+ else result._log_name
+ )
+ )
- def end_keyword(self, kw):
- self.debug(lambda: "Ended keyword '%s'." % kw.name)
+ def end_body_item(self, data, result):
+ self.debug(
+ lambda: (
+ f"Ended keyword '{result.name}'."
+ if result.type in result.KEYWORD_TYPES
+ else result._log_name
+ )
+ )
- def output_file(self, name, path):
- self.info('%s: %s' % (name, path))
+ def result_file(self, kind, path):
+ self.info(f"{kind}: {path}")
def close(self):
self._writer.close()
diff --git a/src/robot/output/jsonlogger.py b/src/robot/output/jsonlogger.py
new file mode 100644
index 00000000000..b85ad1d5a76
--- /dev/null
+++ b/src/robot/output/jsonlogger.py
@@ -0,0 +1,365 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+from collections.abc import Mapping, Sequence
+from datetime import datetime
+from pathlib import Path
+from typing import TextIO
+
+from robot.version import get_full_version
+
+
+class JsonLogger:
+
+ def __init__(self, file: TextIO, rpa: bool = False):
+ self.writer = JsonWriter(file)
+ self.writer.start_dict(
+ generator=get_full_version("Robot"),
+ generated=datetime.now().isoformat(),
+ rpa=Raw(self.writer.encode(rpa)),
+ )
+ self.containers = []
+
+ def start_suite(self, suite):
+ if not self.containers:
+ name = "suite"
+ container = None
+ else:
+ name = None
+ container = "suites"
+ self._start(container, name, id=suite.id)
+
+ def end_suite(self, suite):
+ self._end(
+ name=suite.name,
+ doc=suite.doc,
+ metadata=suite.metadata,
+ source=suite.source,
+ rpa=suite.rpa,
+ **self._status(suite),
+ )
+
+ def start_test(self, test):
+ self._start("tests", id=test.id)
+
+ def end_test(self, test):
+ self._end(
+ name=test.name,
+ doc=test.doc,
+ tags=test.tags,
+ lineno=test.lineno,
+ timeout=str(test.timeout) if test.timeout else None,
+ **self._status(test),
+ )
+
+ def start_keyword(self, kw):
+ if kw.type in ("SETUP", "TEARDOWN"):
+ self._end_container()
+ name = kw.type.lower()
+ container = None
+ else:
+ name = None
+ container = "body"
+ self._start(container, name)
+
+ def end_keyword(self, kw):
+ self._end(
+ name=kw.name,
+ owner=kw.owner,
+ source_name=kw.source_name,
+ args=[str(a) for a in kw.args],
+ assign=kw.assign,
+ tags=kw.tags,
+ doc=kw.doc,
+ timeout=str(kw.timeout) if kw.timeout else None,
+ **self._status(kw),
+ )
+
+ def start_for(self, item):
+ self._start(type=item.type)
+
+ def end_for(self, item):
+ self._end(
+ flavor=item.flavor,
+ start=item.start,
+ mode=item.mode,
+ fill=UnlessNone(item.fill),
+ assign=item.assign,
+ values=item.values,
+ **self._status(item),
+ )
+
+ def start_for_iteration(self, item):
+ self._start(type=item.type)
+
+ def end_for_iteration(self, item):
+ self._end(assign=item.assign, **self._status(item))
+
+ def start_while(self, item):
+ self._start(type=item.type)
+
+ def end_while(self, item):
+ self._end(
+ condition=item.condition,
+ limit=item.limit,
+ on_limit=item.on_limit,
+ on_limit_message=item.on_limit_message,
+ **self._status(item),
+ )
+
+ def start_while_iteration(self, item):
+ self._start(type=item.type)
+
+ def end_while_iteration(self, item):
+ self._end(**self._status(item))
+
+ def start_if(self, item):
+ self._start(type=item.type)
+
+ def end_if(self, item):
+ self._end(**self._status(item))
+
+ def start_if_branch(self, item):
+ self._start(type=item.type)
+
+ def end_if_branch(self, item):
+ self._end(condition=item.condition, **self._status(item))
+
+ def start_try(self, item):
+ self._start(type=item.type)
+
+ def end_try(self, item):
+ self._end(**self._status(item))
+
+ def start_try_branch(self, item):
+ self._start(type=item.type)
+
+ def end_try_branch(self, item):
+ self._end(
+ patterns=item.patterns,
+ pattern_type=item.pattern_type,
+ assign=item.assign,
+ **self._status(item),
+ )
+
+ def start_group(self, item):
+ self._start(type=item.type)
+
+ def end_group(self, item):
+ self._end(name=item.name, **self._status(item))
+
+ def start_var(self, item):
+ self._start(type=item.type)
+
+ def end_var(self, item):
+ self._end(
+ name=item.name,
+ scope=item.scope,
+ separator=UnlessNone(item.separator),
+ value=item.value,
+ **self._status(item),
+ )
+
+ def start_return(self, item):
+ self._start(type=item.type)
+
+ def end_return(self, item):
+ self._end(values=item.values, **self._status(item))
+
+ def start_continue(self, item):
+ self._start(type=item.type)
+
+ def end_continue(self, item):
+ self._end(**self._status(item))
+
+ def start_break(self, item):
+ self._start(type=item.type)
+
+ def end_break(self, item):
+ self._end(**self._status(item))
+
+ def start_error(self, item):
+ self._start(type=item.type)
+
+ def end_error(self, item):
+ self._end(values=item.values, **self._status(item))
+
+ def message(self, msg):
+ self._dict(**msg.to_dict())
+
+ def errors(self, messages):
+ self._list("errors", [m.to_dict(include_type=False) for m in messages])
+
+ def statistics(self, stats):
+ data = stats.to_dict()
+ self._start(None, "statistics")
+ self._dict(None, "total", **data["total"])
+ self._list("suites", data["suites"])
+ self._list("tags", data["tags"])
+ self._end()
+
+ def close(self):
+ self.writer.end_dict()
+ self.writer.close()
+
+ def _status(self, item):
+ return {
+ "status": item.status,
+ "message": item.message,
+ "start_time": item.start_time.isoformat() if item.start_time else None,
+ "elapsed_time": Raw(format(item.elapsed_time.total_seconds(), "f")),
+ }
+
+ def _dict(
+ self,
+ container: "str|None" = "body",
+ name: "str|None" = None,
+ /,
+ **items,
+ ):
+ self._start(container, name, **items)
+ self._end()
+
+ def _list(self, name: "str|None", items: list):
+ self.writer.start_list(name)
+ for item in items:
+ self._dict(None, None, **item)
+ self.writer.end_list()
+
+ def _start(
+ self,
+ container: "str|None" = "body",
+ name: "str|None" = None,
+ /,
+ **items,
+ ):
+ if container:
+ self._start_container(container)
+ self.writer.start_dict(name, **items)
+ self.containers.append(None)
+
+ def _start_container(self, container):
+ if self.containers[-1] != container:
+ if self.containers[-1]:
+ self.writer.end_list()
+ self.writer.start_list(container)
+ self.containers[-1] = container
+
+ def _end(self, **items):
+ self._end_container()
+ self.containers.pop()
+ self.writer.end_dict(**items)
+
+ def _end_container(self):
+ if self.containers[-1]:
+ self.writer.end_list()
+ self.containers[-1] = None
+
+
+class JsonWriter:
+
+ def __init__(self, file):
+ self.encode = json.JSONEncoder(
+ check_circular=False,
+ separators=(",", ":"),
+ default=self._handle_custom,
+ ).encode
+ self.file = file
+ self.comma = False
+
+ def _handle_custom(self, value):
+ if isinstance(value, Path):
+ return str(value)
+ if isinstance(value, Mapping):
+ return dict(value)
+ if isinstance(value, Sequence):
+ return list(value)
+ raise TypeError(type(value).__name__)
+
+ def start_dict(self, name=None, /, **items):
+ self._start(name, "{")
+ self.items(**items)
+
+ def _start(self, name, char):
+ self._newline(newline=name is not None)
+ self._name(name)
+ self._write(char)
+ self.comma = False
+
+ def _newline(self, comma: "bool|None" = None, newline: bool = True):
+ if self.comma if comma is None else comma:
+ self._write(",")
+ if newline:
+ self._write("\n")
+
+ def _name(self, name):
+ if name:
+ self._write(f'"{name}":')
+
+ def _write(self, text):
+ self.file.write(text)
+
+ def end_dict(self, **items):
+ self.items(**items)
+ self._end("}")
+
+ def _end(self, char, newline=True):
+ self._newline(comma=False, newline=newline)
+ self._write(char)
+ self.comma = True
+
+ def start_list(self, name=None, /):
+ self._start(name, "[")
+
+ def end_list(self):
+ self._end("]", newline=False)
+
+ def items(self, **items):
+ for name, value in items.items():
+ self._item(value, name)
+
+ def _item(self, value, name=None):
+ if isinstance(value, UnlessNone) and value:
+ value = value.value
+ elif not (value or value == 0 and not isinstance(value, bool)):
+ return
+ if isinstance(value, Raw):
+ value = value.value
+ else:
+ value = self.encode(value)
+ self._newline()
+ self._name(name)
+ self._write(value)
+ self.comma = True
+
+ def close(self):
+ self._write("\n")
+ self.file.close()
+
+
+class Raw:
+
+ def __init__(self, value):
+ self.value = value
+
+
+class UnlessNone:
+
+ def __init__(self, value):
+ self.value = value
+
+ def __bool__(self):
+ return self.value is not None
diff --git a/src/robot/output/librarylogger.py b/src/robot/output/librarylogger.py
index 7de27723618..d53bc2ae83d 100644
--- a/src/robot/output/librarylogger.py
+++ b/src/robot/output/librarylogger.py
@@ -19,56 +19,56 @@
here to avoid cyclic imports.
"""
-import sys
-import threading
+from threading import current_thread
+from typing import Literal
-from robot.utils import console_encode
+from robot.utils import safe_str
from .logger import LOGGER
-from .loggerhelper import Message
+from .loggerhelper import Message, MessageLevel, PseudoLevel, write_to_console
+# This constant is used by BackgroundLogger.
+# https://github.com/robotframework/robotbackgroundlogger
+LOGGING_THREADS = ["MainThread", "RobotFrameworkTimeoutThread"]
-LOGGING_THREADS = ('MainThread', 'RobotFrameworkTimeoutThread')
-
-def write(msg, level, html=False):
- # Callable messages allow lazy logging internally, but we don't want to
- # expose this functionality publicly. See the following issue for details:
- # https://github.com/robotframework/robotframework/issues/1505
- if callable(msg):
- msg = str(msg)
- if level.upper() not in ('TRACE', 'DEBUG', 'INFO', 'HTML', 'WARN', 'ERROR'):
- raise RuntimeError("Invalid log level '%s'." % level)
- if threading.current_thread().name in LOGGING_THREADS:
- LOGGER.log_message(Message(msg, level, html))
+def write(
+ msg: object,
+ level: "MessageLevel | PseudoLevel" = "INFO",
+ html: bool = False,
+ console: "bool | None" = None,
+):
+ if not isinstance(msg, str):
+ msg = safe_str(msg)
+ if level == "FAIL":
+ raise ValueError(f"Invalid log level '{level}'.")
+ if current_thread().name in LOGGING_THREADS:
+ LOGGER.log_message(Message(msg, level, html=html, console=console))
def trace(msg, html=False):
- write(msg, 'TRACE', html)
+ write(msg, "TRACE", html)
def debug(msg, html=False):
- write(msg, 'DEBUG', html)
+ write(msg, "DEBUG", html)
-def info(msg, html=False, also_console=False):
- write(msg, 'INFO', html)
- if also_console:
- console(msg)
+def info(msg, html=False, console=False):
+ write(msg, "INFO", html, console)
def warn(msg, html=False):
- write(msg, 'WARN', html)
+ write(msg, "WARN", html)
def error(msg, html=False):
- write(msg, 'ERROR', html)
+ write(msg, "ERROR", html)
-def console(msg, newline=True, stream='stdout'):
- msg = str(msg)
- if newline:
- msg += '\n'
- stream = sys.__stdout__ if stream.lower() != 'stderr' else sys.__stderr__
- stream.write(console_encode(msg, stream=stream))
- stream.flush()
+def console(
+ msg: object,
+ newline: bool = True,
+ stream: Literal["stdout", "stderr"] = "stdout",
+):
+ write_to_console(msg, newline, stream)
diff --git a/src/robot/output/listenerarguments.py b/src/robot/output/listenerarguments.py
deleted file mode 100644
index 817bb5141e6..00000000000
--- a/src/robot/output/listenerarguments.py
+++ /dev/null
@@ -1,139 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from robot.utils import is_list_like, is_dict_like, is_string, safe_str
-
-
-class ListenerArguments:
-
- def __init__(self, arguments):
- self._arguments = arguments
- self._version2 = None
- self._version3 = None
-
- def get_arguments(self, version):
- if version == 2:
- if self._version2 is None:
- self._version2 = self._get_version2_arguments(*self._arguments)
- return self._version2
- else:
- if self._version3 is None:
- self._version3 = self._get_version3_arguments(*self._arguments)
- return self._version3
-
- def _get_version2_arguments(self, *arguments):
- return arguments
-
- def _get_version3_arguments(self, *arguments):
- return arguments
-
- @classmethod
- def by_method_name(cls, name, arguments):
- Arguments = {'start_suite': StartSuiteArguments,
- 'end_suite': EndSuiteArguments,
- 'start_test': StartTestArguments,
- 'end_test': EndTestArguments,
- 'start_keyword': StartKeywordArguments,
- 'end_keyword': EndKeywordArguments,
- 'log_message': MessageArguments,
- 'message': MessageArguments}.get(name, ListenerArguments)
- return Arguments(arguments)
-
-
-class MessageArguments(ListenerArguments):
-
- def _get_version2_arguments(self, msg):
- attributes = {'timestamp': msg.timestamp,
- 'message': msg.message,
- 'level': msg.level,
- 'html': 'yes' if msg.html else 'no'}
- return attributes,
-
- def _get_version3_arguments(self, msg):
- return msg,
-
-
-class _ListenerArgumentsFromItem(ListenerArguments):
- _attribute_names = None
-
- def _get_version2_arguments(self, item):
- attributes = dict((name, self._get_attribute_value(item, name))
- for name in self._attribute_names)
- attributes.update(self._get_extra_attributes(item))
- return item.name or '', attributes
-
- def _get_attribute_value(self, item, name):
- value = getattr(item, name)
- return self._take_copy_of_mutable_value(value)
-
- def _take_copy_of_mutable_value(self, value):
- if is_dict_like(value):
- return dict(value)
- if is_list_like(value):
- return list(value)
- return value
-
- def _get_extra_attributes(self, item):
- return {}
-
- def _get_version3_arguments(self, item):
- return item.data, item.result
-
-
-class StartSuiteArguments(_ListenerArgumentsFromItem):
- _attribute_names = ('id', 'longname', 'doc', 'metadata', 'starttime')
-
- def _get_extra_attributes(self, suite):
- return {'tests': [t.name for t in suite.tests],
- 'suites': [s.name for s in suite.suites],
- 'totaltests': suite.test_count,
- 'source': suite.source or ''}
-
-
-class EndSuiteArguments(StartSuiteArguments):
- _attribute_names = ('id', 'longname', 'doc', 'metadata', 'starttime',
- 'endtime', 'elapsedtime', 'status', 'message')
-
- def _get_extra_attributes(self, suite):
- attrs = StartSuiteArguments._get_extra_attributes(self, suite)
- attrs['statistics'] = suite.stat_message
- return attrs
-
-
-class StartTestArguments(_ListenerArgumentsFromItem):
- _attribute_names = ('id', 'longname', 'doc', 'tags', 'lineno', 'source', 'starttime')
-
- def _get_extra_attributes(self, test):
- return {'template': test.template or '',
- 'originalname': test.data.name}
-
-
-class EndTestArguments(StartTestArguments):
- _attribute_names = ('id', 'longname', 'doc', 'tags', 'lineno', 'source', 'starttime',
- 'endtime', 'elapsedtime', 'status', 'message')
-
-
-class StartKeywordArguments(_ListenerArgumentsFromItem):
- _attribute_names = ('doc', 'assign', 'tags', 'lineno', 'source', 'type', 'status',
- 'starttime')
-
- def _get_extra_attributes(self, kw):
- args = [a if is_string(a) else safe_str(a) for a in kw.args]
- return {'kwname': kw.kwname or '', 'libname': kw.libname or '', 'args': args}
-
-
-class EndKeywordArguments(StartKeywordArguments):
- _attribute_names = ('doc', 'assign', 'tags', 'lineno', 'source', 'type', 'status',
- 'starttime', 'endtime', 'elapsedtime')
diff --git a/src/robot/output/listenermethods.py b/src/robot/output/listenermethods.py
deleted file mode 100644
index 6b71830f41d..00000000000
--- a/src/robot/output/listenermethods.py
+++ /dev/null
@@ -1,113 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from robot.errors import TimeoutError
-from robot.utils import get_error_details
-
-from .listenerarguments import ListenerArguments
-from .logger import LOGGER
-
-
-class ListenerMethods:
-
- def __init__(self, method_name, listeners):
- self._methods = []
- self._method_name = method_name
- if listeners:
- self._register_methods(method_name, listeners)
-
- def _register_methods(self, method_name, listeners):
- for listener in listeners:
- method = getattr(listener, method_name)
- if method:
- self._methods.append(ListenerMethod(method, listener))
-
- def __call__(self, *args):
- if self._methods:
- args = ListenerArguments.by_method_name(self._method_name, args)
- for method in self._methods:
- method(args.get_arguments(method.version))
-
- def __bool__(self):
- return bool(self._methods)
-
-
-class LibraryListenerMethods:
-
- def __init__(self, method_name):
- self._method_stack = []
- self._method_name = method_name
-
- def new_suite_scope(self):
- self._method_stack.append([])
-
- def discard_suite_scope(self):
- self._method_stack.pop()
-
- def register(self, listeners, library):
- methods = self._method_stack[-1]
- for listener in listeners:
- method = getattr(listener, self._method_name)
- if method:
- info = ListenerMethod(method, listener, library)
- methods.append(info)
-
- def unregister(self, library):
- methods = [m for m in self._method_stack[-1] if m.library is not library]
- self._method_stack[-1] = methods
-
- def __call__(self, *args, **conf):
- methods = self._get_methods(**conf)
- if methods:
- args = ListenerArguments.by_method_name(self._method_name, args)
- for method in methods:
- method(args.get_arguments(method.version))
-
- def _get_methods(self, library=None):
- if not (self._method_stack and self._method_stack[-1]):
- return []
- methods = self._method_stack[-1]
- if library:
- return [m for m in methods if m.library is library]
- return methods
-
-
-class ListenerMethod:
- # Flag to avoid recursive listener calls.
- called = False
-
- def __init__(self, method, listener, library=None):
- self.method = method
- self.listener_name = listener.name
- self.version = listener.version
- self.library = library
-
- def __call__(self, args):
- if self.called:
- return
- try:
- ListenerMethod.called = True
- self.method(*args)
- except TimeoutError:
- # Propagate possible timeouts:
- # https://github.com/robotframework/robotframework/issues/2763
- raise
- except:
- message, details = get_error_details()
- LOGGER.error("Calling method '%s' of listener '%s' failed: %s"
- % (self.method.__name__, self.listener_name, message))
- LOGGER.info("Details:\n%s" % details)
- finally:
- ListenerMethod.called = False
diff --git a/src/robot/output/listeners.py b/src/robot/output/listeners.py
index 20d6f3b36fd..1ac2d746597 100644
--- a/src/robot/output/listeners.py
+++ b/src/robot/output/listeners.py
@@ -14,161 +14,605 @@
# limitations under the License.
import os.path
+from abc import ABC
+from pathlib import Path
+from typing import Any, Iterable
-from robot.errors import DataError
-from robot.utils import Importer, is_string, split_args_from_name_or_path, type_name
+from robot.errors import DataError, TimeoutExceeded
+from robot.model import BodyItem
+from robot.utils import (
+ get_error_details, Importer, safe_str, split_args_from_name_or_path, type_name
+)
-from .listenermethods import ListenerMethods, LibraryListenerMethods
-from .loggerhelper import AbstractLoggerProxy, IsLogged
from .logger import LOGGER
+from .loggerapi import LoggerApi
+from .loglevel import LogLevel, SettableLevel
class Listeners:
- _method_names = ('start_suite', 'end_suite', 'start_test', 'end_test',
- 'start_keyword', 'end_keyword', 'log_message', 'message',
- 'output_file', 'report_file', 'log_file', 'debug_file',
- 'xunit_file', 'library_import', 'resource_import',
- 'variables_import', 'close')
-
- def __init__(self, listeners, log_level='INFO'):
- self._is_logged = IsLogged(log_level)
- listeners = ListenerProxy.import_listeners(listeners,
- self._method_names)
- for name in self._method_names:
- method = ListenerMethods(name, listeners)
- if name.endswith(('_keyword', '_file', '_import', 'log_message')):
- name = '_' + name
- setattr(self, name, method)
-
- def set_log_level(self, level):
- self._is_logged.set_level(level)
-
- def start_keyword(self, kw):
- if kw.type not in (kw.IF_ELSE_ROOT, kw.TRY_EXCEPT_ROOT):
- self._start_keyword(kw)
-
- def end_keyword(self, kw):
- if kw.type not in (kw.IF_ELSE_ROOT, kw.TRY_EXCEPT_ROOT):
- self._end_keyword(kw)
-
- def log_message(self, msg):
- if self._is_logged(msg.level):
- self._log_message(msg)
-
- def imported(self, import_type, name, attrs):
- method = getattr(self, '_%s_import' % import_type.lower())
- method(name, attrs)
-
- def output_file(self, file_type, path):
- method = getattr(self, '_%s_file' % file_type.lower())
- method(path)
+ _listeners: "list[ListenerFacade]"
- def __bool__(self):
- return any(isinstance(method, ListenerMethods) and method
- for method in self.__dict__.values())
-
-
-class LibraryListeners:
- _method_names = ('start_suite', 'end_suite', 'start_test', 'end_test',
- 'start_keyword', 'end_keyword', 'log_message', 'message',
- 'close')
-
- def __init__(self, log_level='INFO'):
- self._is_logged = IsLogged(log_level)
- for name in self._method_names:
- method = LibraryListenerMethods(name)
- if name == 'log_message':
- name = '_' + name
- setattr(self, name, method)
-
- def register(self, listeners, library):
- listeners = ListenerProxy.import_listeners(listeners,
- self._method_names,
- prefix='_',
- raise_on_error=True)
- for method in self._listener_methods():
- method.register(listeners, library)
-
- def _listener_methods(self):
- return [method for method in self.__dict__.values()
- if isinstance(method, LibraryListenerMethods)]
+ def __init__(
+ self,
+ listeners: Iterable["str|Any"] = (),
+ log_level: "LogLevel|SettableLevel" = "INFO",
+ ):
+ if isinstance(log_level, str):
+ log_level = LogLevel(log_level)
+ self._log_level = log_level
+ self._listeners = self._import_listeners(listeners)
- def unregister(self, library, close=False):
- if close:
- self.close(library=library)
- for method in self._listener_methods():
- method.unregister(library)
+ # Must be property to allow LibraryListeners to override it.
+ @property
+ def listeners(self):
+ return self._listeners
+
+ def _import_listeners(self, listeners, library=None) -> "list[ListenerFacade]":
+ imported = []
+ for li in listeners:
+ try:
+ listener = self._import_listener(li, library)
+ except DataError as err:
+ name = li if isinstance(li, str) else type_name(li)
+ msg = f"Taking listener '{name}' into use failed: {err}"
+ if library:
+ raise DataError(msg)
+ LOGGER.error(msg)
+ else:
+ imported.append(listener)
+ return imported
+
+ def _import_listener(self, listener, library=None) -> "ListenerFacade":
+ if library and isinstance(listener, str) and listener.upper() == "SELF":
+ listener = library.instance
+ if isinstance(listener, str):
+ name, args = split_args_from_name_or_path(listener)
+ importer = Importer("listener", logger=LOGGER)
+ listener = importer.import_class_or_module(
+ os.path.normpath(name),
+ instantiate_with_args=args,
+ )
+ else:
+ # Modules have `__name__`, with others better to use `type_name`.
+ name = getattr(listener, "__name__", None) or type_name(listener)
+ if self._get_version(listener) == 2:
+ return ListenerV2Facade(listener, name, self._log_level, library)
+ return ListenerV3Facade(listener, name, self._log_level, library)
+
+ def _get_version(self, listener):
+ version = getattr(listener, "ROBOT_LISTENER_API_VERSION", 3)
+ try:
+ version = int(version)
+ if version not in (2, 3):
+ raise ValueError
+ except (ValueError, TypeError):
+ raise DataError(f"Unsupported API version '{version}'.")
+ return version
+
+ def __iter__(self):
+ return iter(self.listeners)
+
+ def __len__(self):
+ return len(self.listeners)
+
+
+class LibraryListeners(Listeners):
+ _listeners: "list[list[ListenerFacade]]"
+
+ def __init__(self, log_level: "LogLevel|str" = "INFO"):
+ super().__init__(log_level=log_level)
+
+ @property
+ def listeners(self):
+ return self._listeners[-1] if self._listeners else []
def new_suite_scope(self):
- for method in self._listener_methods():
- method.new_suite_scope()
+ self._listeners.append([])
def discard_suite_scope(self):
- for method in self._listener_methods():
- method.discard_suite_scope()
+ self._listeners.pop()
+
+ def register(self, library):
+ listeners = self._import_listeners(library.listeners, library=library)
+ self._listeners[-1].extend(listeners)
+
+ def unregister(self, library, close=False):
+ remaining = []
+ for listener in self._listeners[-1]:
+ if listener.library is not library:
+ remaining.append(listener)
+ elif close:
+ listener.close()
+ self._listeners[-1] = remaining
- def set_log_level(self, level):
- self._is_logged.set_level(level)
- def log_message(self, msg):
- if self._is_logged(msg.level):
- self._log_message(msg)
+class ListenerFacade(LoggerApi, ABC):
- def imported(self, import_type, name, attrs):
- pass
+ def __init__(self, listener, name, log_level, library=None):
+ self.listener = listener
+ self.name = name
+ self._is_logged = log_level.is_logged
+ self.library = library
+ self.priority = self._get_priority(listener)
- def output_file(self, file_type, path):
- pass
+ def _get_priority(self, listener):
+ priority = getattr(listener, "ROBOT_LISTENER_PRIORITY", 0)
+ if isinstance(priority, (int, float)):
+ return priority
+ try:
+ try:
+ return int(priority)
+ except ValueError:
+ return float(priority)
+ except (ValueError, TypeError):
+ raise DataError(f"Invalid listener priority '{priority}'.")
+ def _get_method(self, name, fallback=None):
+ for method_name in self._get_method_names(name):
+ method = getattr(self.listener, method_name, None)
+ if method:
+ return ListenerMethod(method, self.name)
+ return fallback or ListenerMethod(None, self.name)
-class ListenerProxy(AbstractLoggerProxy):
- _no_method = None
+ def _get_method_names(self, name):
+ names = [name, self._to_camelCase(name)] if "_" in name else [name]
+ if self.library is not None:
+ names += ["_" + name for name in names]
+ return names
- def __init__(self, listener, method_names, prefix=None):
- listener, name = self._import_listener(listener)
- AbstractLoggerProxy.__init__(self, listener, method_names, prefix)
- self.name = name
- self.version = self._get_version(listener)
- if self.version == 3:
- self.start_keyword = self.end_keyword = None
- self.library_import = self.resource_import = self.variables_import = None
+ def _to_camelCase(self, name):
+ first, *rest = name.split("_")
+ return "".join([first] + [part.capitalize() for part in rest])
- def _import_listener(self, listener):
- if not is_string(listener):
- # Modules have `__name__`, with others better to use `type_name`.
- name = getattr(listener, '__name__', None) or type_name(listener)
- return listener, name
- name, args = split_args_from_name_or_path(listener)
- importer = Importer('listener', logger=LOGGER)
- listener = importer.import_class_or_module(os.path.normpath(name),
- instantiate_with_args=args)
- return listener, name
- def _get_version(self, listener):
+class ListenerV3Facade(ListenerFacade):
+
+ def __init__(self, listener, name, log_level, library=None):
+ super().__init__(listener, name, log_level, library)
+ get = self._get_method
+ # Suite
+ self.start_suite = get("start_suite")
+ self.end_suite = get("end_suite")
+ # Test
+ self.start_test = get("start_test")
+ self.end_test = get("end_test")
+ # Fallbacks for body items
+ start_body_item = get("start_body_item")
+ end_body_item = get("end_body_item")
+ # Fallbacks for keywords
+ start_keyword = get("start_keyword", start_body_item)
+ end_keyword = get("end_keyword", end_body_item)
+ # Keywords
+ self.start_user_keyword = get(
+ "start_user_keyword",
+ lambda data, implementation, result: start_keyword(data, result),
+ )
+ self.end_user_keyword = get(
+ "end_user_keyword",
+ lambda data, implementation, result: end_keyword(data, result),
+ )
+ self.start_library_keyword = get(
+ "start_library_keyword",
+ lambda data, implementation, result: start_keyword(data, result),
+ )
+ self.end_library_keyword = get(
+ "end_library_keyword",
+ lambda data, implementation, result: end_keyword(data, result),
+ )
+ self.start_invalid_keyword = get(
+ "start_invalid_keyword",
+ lambda data, implementation, result: start_keyword(data, result),
+ )
+ self.end_invalid_keyword = get(
+ "end_invalid_keyword",
+ lambda data, implementation, result: end_keyword(data, result),
+ )
+ # IF
+ self.start_if = get("start_if", start_body_item)
+ self.end_if = get("end_if", end_body_item)
+ self.start_if_branch = get("start_if_branch", start_body_item)
+ self.end_if_branch = get("end_if_branch", end_body_item)
+ # TRY
+ self.start_try = get("start_try", start_body_item)
+ self.end_try = get("end_try", end_body_item)
+ self.start_try_branch = get("start_try_branch", start_body_item)
+ self.end_try_branch = get("end_try_branch", end_body_item)
+ # FOR
+ self.start_for = get("start_for", start_body_item)
+ self.end_for = get("end_for", end_body_item)
+ self.start_for_iteration = get("start_for_iteration", start_body_item)
+ self.end_for_iteration = get("end_for_iteration", end_body_item)
+ # WHILE
+ self.start_while = get("start_while", start_body_item)
+ self.end_while = get("end_while", end_body_item)
+ self.start_while_iteration = get("start_while_iteration", start_body_item)
+ self.end_while_iteration = get("end_while_iteration", end_body_item)
+ # GROUP
+ self.start_group = get("start_group", start_body_item)
+ self.end_group = get("end_group", end_body_item)
+ # VAR
+ self.start_var = get("start_var", start_body_item)
+ self.end_var = get("end_var", end_body_item)
+ # BREAK
+ self.start_break = get("start_break", start_body_item)
+ self.end_break = get("end_break", end_body_item)
+ # CONTINUE
+ self.start_continue = get("start_continue", start_body_item)
+ self.end_continue = get("end_continue", end_body_item)
+ # RETURN
+ self.start_return = get("start_return", start_body_item)
+ self.end_return = get("end_return", end_body_item)
+ # ERROR
+ self.start_error = get("start_error", start_body_item)
+ self.end_error = get("end_error", end_body_item)
+ # Messages
+ self._log_message = get("log_message")
+ self.message = get("message")
+ # Imports
+ self.library_import = get("library_import")
+ self.resource_import = get("resource_import")
+ self.variables_import = get("variables_import")
+ # Result files
+ self.output_file = get("output_file")
+ self.report_file = get("report_file")
+ self.log_file = get("log_file")
+ self.xunit_file = get("xunit_file")
+ self.debug_file = get("debug_file")
+ # Close
+ self.close = get("close")
+
+ def log_message(self, message):
+ if self._is_logged(message):
+ self._log_message(message)
+
+
+class ListenerV2Facade(ListenerFacade):
+
+ def __init__(self, listener, name, log_level, library=None):
+ super().__init__(listener, name, log_level, library)
+ get = self._get_method
+ # Suite
+ self._start_suite = get("start_suite")
+ self._end_suite = get("end_suite")
+ # Test
+ self._start_test = get("start_test")
+ self._end_test = get("end_test")
+ # Keyword and control structures
+ self._start_kw = get("start_keyword")
+ self._end_kw = get("end_keyword")
+ # Messages
+ self._log_message = get("log_message")
+ self._message = get("message")
+ # Imports
+ self._library_import = get("library_import")
+ self._resource_import = get("resource_import")
+ self._variables_import = get("variables_import")
+ # Result files
+ self._output_file = get("output_file")
+ self._report_file = get("report_file")
+ self._log_file = get("log_file")
+ self._xunit_file = get("xunit_file")
+ self._debug_file = get("debug_file")
+ # Close
+ self._close = get("close")
+
+ def start_suite(self, data, result):
+ self._start_suite(result.name, self._suite_attrs(data, result))
+
+ def end_suite(self, data, result):
+ self._end_suite(result.name, self._suite_attrs(data, result, end=True))
+
+ def start_test(self, data, result):
+ self._start_test(result.name, self._test_attrs(data, result))
+
+ def end_test(self, data, result):
+ self._end_test(result.name, self._test_attrs(data, result, end=True))
+
+ def start_keyword(self, data, result):
+ self._start_kw(result.full_name, self._keyword_attrs(data, result))
+
+ def end_keyword(self, data, result):
+ self._end_kw(result.full_name, self._keyword_attrs(data, result, end=True))
+
+ def start_for(self, data, result):
+ extra = self._for_extra_attrs(result)
+ self._start_kw(result._log_name, self._attrs(data, result, **extra))
+
+ def end_for(self, data, result):
+ extra = self._for_extra_attrs(result)
+ self._end_kw(result._log_name, self._attrs(data, result, **extra, end=True))
+
+ def _for_extra_attrs(self, result):
+ extra = {
+ "variables": list(result.assign),
+ "flavor": result.flavor or "",
+ "values": list(result.values),
+ }
+ if result.flavor == "IN ENUMERATE":
+ extra["start"] = result.start
+ elif result.flavor == "IN ZIP":
+ extra["fill"] = result.fill
+ extra["mode"] = result.mode
+ return extra
+
+ def start_for_iteration(self, data, result):
+ attrs = self._attrs(data, result, variables=dict(result.assign))
+ self._start_kw(result._log_name, attrs)
+
+ def end_for_iteration(self, data, result):
+ attrs = self._attrs(data, result, variables=dict(result.assign), end=True)
+ self._end_kw(result._log_name, attrs)
+
+ def start_while(self, data, result):
+ attrs = self._attrs(
+ data,
+ result,
+ condition=result.condition,
+ limit=result.limit,
+ on_limit=result.on_limit,
+ on_limit_message=result.on_limit_message,
+ )
+ self._start_kw(result._log_name, attrs)
+
+ def end_while(self, data, result):
+ attrs = self._attrs(
+ data,
+ result,
+ condition=result.condition,
+ limit=result.limit,
+ on_limit=result.on_limit,
+ on_limit_message=result.on_limit_message,
+ end=True,
+ )
+ self._end_kw(result._log_name, attrs)
+
+ def start_while_iteration(self, data, result):
+ self._start_kw(result._log_name, self._attrs(data, result))
+
+ def end_while_iteration(self, data, result):
+ self._end_kw(result._log_name, self._attrs(data, result, end=True))
+
+ def start_group(self, data, result):
+ self._start_kw(result._log_name, self._attrs(data, result, name=result.name))
+
+ def end_group(self, data, result):
+ attrs = self._attrs(data, result, name=result.name, end=True)
+ self._end_kw(result._log_name, attrs)
+
+ def start_if_branch(self, data, result):
+ extra = {"condition": result.condition} if result.type != result.ELSE else {}
+ self._start_kw(result._log_name, self._attrs(data, result, **extra))
+
+ def end_if_branch(self, data, result):
+ extra = {"condition": result.condition} if result.type != result.ELSE else {}
+ self._end_kw(result._log_name, self._attrs(data, result, **extra, end=True))
+
+ def start_try_branch(self, data, result):
+ extra = self._try_extra_attrs(result)
+ self._start_kw(result._log_name, self._attrs(data, result, **extra))
+
+ def end_try_branch(self, data, result):
+ extra = self._try_extra_attrs(result)
+ self._end_kw(result._log_name, self._attrs(data, result, **extra, end=True))
+
+ def _try_extra_attrs(self, result):
+ if result.type == BodyItem.EXCEPT:
+ return {
+ "patterns": list(result.patterns),
+ "pattern_type": result.pattern_type,
+ "variable": result.assign,
+ }
+ return {}
+
+ def start_return(self, data, result):
+ attrs = self._attrs(data, result, values=list(result.values))
+ self._start_kw(result._log_name, attrs)
+
+ def end_return(self, data, result):
+ attrs = self._attrs(data, result, values=list(result.values), end=True)
+ self._end_kw(result._log_name, attrs)
+
+ def start_continue(self, data, result):
+ self._start_kw(result._log_name, self._attrs(data, result))
+
+ def end_continue(self, data, result):
+ self._end_kw(result._log_name, self._attrs(data, result, end=True))
+
+ def start_break(self, data, result):
+ self._start_kw(result._log_name, self._attrs(data, result))
+
+ def end_break(self, data, result):
+ self._end_kw(result._log_name, self._attrs(data, result, end=True))
+
+ def start_error(self, data, result):
+ self._start_kw(result._log_name, self._attrs(data, result))
+
+ def end_error(self, data, result):
+ self._end_kw(result._log_name, self._attrs(data, result, end=True))
+
+ def start_var(self, data, result):
+ extra = self._var_extra_attrs(result)
+ self._start_kw(result._log_name, self._attrs(data, result, **extra))
+
+ def end_var(self, data, result):
+ extra = self._var_extra_attrs(result)
+ self._end_kw(result._log_name, self._attrs(data, result, **extra, end=True))
+
+ def _var_extra_attrs(self, result):
+ if result.name.startswith("$"):
+ value = (result.separator or " ").join(result.value)
+ else:
+ value = list(result.value)
+ return {"name": result.name, "value": value, "scope": result.scope or "LOCAL"}
+
+ def log_message(self, message):
+ if self._is_logged(message):
+ self._log_message(self._message_attributes(message))
+
+ def message(self, message):
+ self._message(self._message_attributes(message))
+
+ def library_import(self, library, importer):
+ attrs = {
+ "args": list(importer.args),
+ "originalname": library.real_name,
+ "source": str(library.source or ""),
+ "importer": str(importer.source),
+ }
+ self._library_import(library.name, attrs)
+
+ def resource_import(self, resource, importer):
+ self._resource_import(
+ resource.name,
+ {"source": str(resource.source), "importer": str(importer.source)},
+ )
+
+ def variables_import(self, attrs: dict, importer):
+ self._variables_import(
+ attrs["name"],
+ {
+ "args": list(attrs["args"]),
+ "source": str(attrs["source"]),
+ "importer": str(importer.source),
+ },
+ )
+
+ def output_file(self, path: Path):
+ self._output_file(str(path))
+
+ def report_file(self, path: Path):
+ self._report_file(str(path))
+
+ def log_file(self, path: Path):
+ self._log_file(str(path))
+
+ def xunit_file(self, path: Path):
+ self._xunit_file(str(path))
+
+ def debug_file(self, path: Path):
+ self._debug_file(str(path))
+
+ def _suite_attrs(self, data, result, end=False):
+ attrs = dict(
+ id=data.id,
+ doc=result.doc,
+ metadata=dict(result.metadata),
+ starttime=result.starttime,
+ longname=result.full_name,
+ tests=[t.name for t in data.tests],
+ suites=[s.name for s in data.suites],
+ totaltests=data.test_count,
+ source=str(data.source or ""),
+ )
+ if end:
+ attrs.update(
+ endtime=result.endtime,
+ elapsedtime=result.elapsedtime,
+ status=result.status,
+ message=result.message,
+ statistics=result.stat_message,
+ )
+ return attrs
+
+ def _test_attrs(self, data, result, end=False):
+ attrs = dict(
+ id=data.id,
+ doc=result.doc,
+ tags=list(result.tags),
+ lineno=data.lineno,
+ starttime=result.starttime,
+ longname=result.full_name,
+ source=str(data.source or ""),
+ template=data.template or "",
+ originalname=data.name,
+ )
+ if end:
+ attrs.update(
+ endtime=result.endtime,
+ elapsedtime=result.elapsedtime,
+ status=result.status,
+ message=result.message,
+ )
+ return attrs
+
+ def _keyword_attrs(self, data, result, end=False):
+ attrs = dict(
+ doc=result.doc,
+ lineno=data.lineno,
+ type=result.type,
+ status=result.status,
+ starttime=result.starttime,
+ source=str(data.source or ""),
+ kwname=result.name or "",
+ libname=result.owner or "",
+ args=[a if isinstance(a, str) else safe_str(a) for a in result.args],
+ assign=list(result.assign),
+ tags=list(result.tags),
+ )
+ if end:
+ attrs.update(
+ endtime=result.endtime,
+ elapsedtime=result.elapsedtime,
+ )
+ return attrs
+
+ def _attrs(self, data, result, end=False, **extra):
+ attrs = dict(
+ doc="",
+ lineno=data.lineno,
+ type=result.type,
+ status=result.status,
+ starttime=result.starttime,
+ source=str(data.source or ""),
+ kwname=result._log_name,
+ libname="",
+ args=[],
+ assign=[],
+ tags=[],
+ **extra,
+ )
+ if end:
+ attrs.update(
+ endtime=result.endtime,
+ elapsedtime=result.elapsedtime,
+ )
+ return attrs
+
+ def _message_attributes(self, msg):
+ # Timestamp in our legacy format.
+ ts = msg.timestamp.isoformat(" ", timespec="milliseconds").replace("-", "")
+ return {
+ "timestamp": ts,
+ "message": msg.message,
+ "level": msg.level,
+ "html": "yes" if msg.html else "no",
+ }
+
+ def close(self):
+ self._close()
+
+
+class ListenerMethod:
+
+ def __init__(self, method, name):
+ self.method = method
+ self.listener_name = name
+
+ def __call__(self, *args):
try:
- version = int(listener.ROBOT_LISTENER_API_VERSION)
- if version not in (2, 3):
- raise ValueError
- except AttributeError:
- raise DataError("Listener '%s' does not have mandatory "
- "'ROBOT_LISTENER_API_VERSION' attribute."
- % self.name)
- except (ValueError, TypeError):
- raise DataError("Listener '%s' uses unsupported API version '%s'."
- % (self.name, listener.ROBOT_LISTENER_API_VERSION))
- return version
+ if self.method is not None:
+ self.method(*args)
+ except TimeoutExceeded:
+ # Propagate possible timeouts:
+ # https://github.com/robotframework/robotframework/issues/2763
+ raise
+ except Exception:
+ message, details = get_error_details()
+ LOGGER.error(
+ f"Calling method '{self.method.__name__}' of listener "
+ f"'{self.listener_name}' failed: {message}"
+ )
+ LOGGER.info(f"Details:\n{details}")
- @classmethod
- def import_listeners(cls, listeners, method_names, prefix=None,
- raise_on_error=False):
- imported = []
- for listener in listeners:
- try:
- imported.append(cls(listener, method_names, prefix))
- except DataError as err:
- name = listener if is_string(listener) else type_name(listener)
- msg = "Taking listener '%s' into use failed: %s" % (name, err)
- if raise_on_error:
- raise DataError(msg)
- LOGGER.error(msg)
- return imported
+ def __bool__(self):
+ return self.method is not None
diff --git a/src/robot/output/logger.py b/src/robot/output/logger.py
index 4d8fe2f0633..88f45b37b51 100644
--- a/src/robot/output/logger.py
+++ b/src/robot/output/logger.py
@@ -13,17 +13,33 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from contextlib import contextmanager
import os
+from contextlib import contextmanager
from robot.errors import DataError
from .console import ConsoleOutput
from .filelogger import FileLogger
-from .loggerhelper import AbstractLogger, AbstractLoggerProxy
+from .loggerhelper import AbstractLogger, write_to_console
from .stdoutlogsplitter import StdoutLogSplitter
+def start_body_item(method):
+ def wrapper(self, *args):
+ self._log_message_parents.append(args[-1])
+ method(self, *args)
+
+ return wrapper
+
+
+def end_body_item(method):
+ def wrapper(self, *args):
+ method(self, *args)
+ self._log_message_parents.pop()
+
+ return wrapper
+
+
class Logger(AbstractLogger):
"""A global logger proxy to delegating messages to registered loggers.
@@ -31,38 +47,44 @@ class Logger(AbstractLogger):
notified. Messages are also cached and cached messages written to new
loggers when they are registered.
- NOTE: This API is likely to change in future versions.
+ NOTE: This is a private API and likely to change in the future.
"""
def __init__(self, register_console_logger=True):
- self._console_logger = None
+ self._console = None
self._syslog = None
- self._xml_logger = None
- self._listeners = None
- self._library_listeners = None
+ self._output_file = None
+ self._cli_listeners = None
+ self._lib_listeners = None
self._other_loggers = []
self._message_cache = []
- self._log_message_cache = None
- self._started_keywords = 0
+ self._log_message_parents = []
+ self._library_import_logging = 0
self._error_occurred = False
self._error_listener = None
- self._prev_log_message_handlers = []
self._enabled = 0
self._cache_only = False
if register_console_logger:
self.register_console_logger()
+ @property
+ def _std_loggers(self):
+ loggers = (self._console, self._syslog, self._output_file)
+ return [lo for lo in loggers if lo]
+
+ @property
+ def _listeners(self):
+ cli_listeners = tuple(self._cli_listeners or ())
+ lib_listeners = tuple(self._lib_listeners or ())
+ return sorted(cli_listeners + lib_listeners, key=lambda li: -li.priority)
+
@property
def start_loggers(self):
- loggers = [self._console_logger, self._syslog, self._xml_logger,
- self._listeners, self._library_listeners]
- return [logger for logger in self._other_loggers + loggers if logger]
+ return [*self._other_loggers, *self._std_loggers, *self._listeners]
@property
def end_loggers(self):
- loggers = [self._listeners, self._library_listeners,
- self._console_logger, self._syslog, self._xml_logger]
- return [logger for logger in loggers + self._other_loggers if logger]
+ return [*self._listeners, *self._std_loggers, *self._other_loggers]
def __iter__(self):
return iter(self.end_loggers)
@@ -77,15 +99,20 @@ def __exit__(self, *exc_info):
if not self._enabled:
self.close()
- def register_console_logger(self, type='verbose', width=78, colors='AUTO',
- markers='AUTO', stdout=None, stderr=None):
- logger = ConsoleOutput(type, width, colors, markers, stdout, stderr)
- self._console_logger = self._wrap_and_relay(logger)
-
- def _wrap_and_relay(self, logger):
- logger = LoggerProxy(logger)
- self._relay_cached_messages(logger)
- return logger
+ def register_console_logger(
+ self,
+ type="verbose",
+ width=78,
+ colors="AUTO",
+ links="AUTO",
+ markers="AUTO",
+ stdout=None,
+ stderr=None,
+ ):
+ self._console = ConsoleOutput(
+ type, width, colors, links, markers, stdout, stderr
+ )
+ self._relay_cached_messages(self._console)
def _relay_cached_messages(self, logger):
if self._message_cache:
@@ -93,42 +120,42 @@ def _relay_cached_messages(self, logger):
logger.message(msg)
def unregister_console_logger(self):
- self._console_logger = None
+ self._console = None
- def register_syslog(self, path=None, level='INFO'):
+ def register_syslog(self, path=None, level="INFO"):
if not path:
- path = os.environ.get('ROBOT_SYSLOG_FILE', 'NONE')
- level = os.environ.get('ROBOT_SYSLOG_LEVEL', level)
- if path.upper() == 'NONE':
+ path = os.environ.get("ROBOT_SYSLOG_FILE", "NONE")
+ level = os.environ.get("ROBOT_SYSLOG_LEVEL", level)
+ if path.upper() == "NONE":
return
try:
- syslog = FileLogger(path, level)
+ self._syslog = FileLogger(path, level)
except DataError as err:
- self.error("Opening syslog file '%s' failed: %s" % (path, err.message))
+ self.error(f"Opening syslog file '{path}' failed: {err}")
else:
- self._syslog = self._wrap_and_relay(syslog)
+ self._relay_cached_messages(self._syslog)
- def register_xml_logger(self, logger):
- self._xml_logger = self._wrap_and_relay(logger)
+ def register_output_file(self, logger):
+ self._relay_cached_messages(logger)
+ self._output_file = logger
- def unregister_xml_logger(self):
- self._xml_logger = None
+ def unregister_output_file(self):
+ self._output_file = None
def register_listeners(self, listeners, library_listeners):
- self._listeners = listeners
- self._library_listeners = library_listeners
- if listeners:
- self._relay_cached_messages(listeners)
+ self._cli_listeners = listeners
+ self._lib_listeners = library_listeners
+ for listener in listeners or ():
+ self._relay_cached_messages(listener)
def register_logger(self, *loggers):
for logger in loggers:
- logger = self._wrap_and_relay(logger)
+ self._relay_cached_messages(logger)
self._other_loggers.append(logger)
def unregister_logger(self, *loggers):
for logger in loggers:
- self._other_loggers = [proxy for proxy in self._other_loggers
- if proxy.logger is not logger]
+ self._other_loggers = [lo for lo in self._other_loggers if lo is not logger]
def disable_message_cache(self):
self._message_cache = None
@@ -145,7 +172,7 @@ def message(self, msg):
logger.message(msg)
if self._message_cache is not None:
self._message_cache.append(msg)
- if msg.level == 'ERROR':
+ if msg.level == "ERROR":
self._error_occurred = True
if self._error_listener:
self._error_listener()
@@ -159,81 +186,270 @@ def cache_only(self):
finally:
self._cache_only = False
- @property
- @contextmanager
- def delayed_logging(self):
- prev_cache = self._log_message_cache
- self._log_message_cache = []
- try:
- yield
- finally:
- messages = self._log_message_cache
- self._log_message_cache = prev_cache
- for msg in messages or ():
- self._log_message(msg, no_cache=True)
-
- def _log_message(self, msg, no_cache=False):
+ def log_message(self, msg):
"""Log messages written (mainly) by libraries."""
- if self._log_message_cache is not None and not no_cache:
- msg.resolve_delayed_message()
- self._log_message_cache.append(msg)
- return
- for logger in self:
- logger.log_message(msg)
- if msg.level in ('WARN', 'ERROR'):
+ logged = False
+ # Common case. We can log normally.
+ if self._log_message_parents and not self._library_import_logging:
+ for logger in self:
+ logger.log_message(msg)
+ if self._output_file and self._output_file.is_logged(msg):
+ self._log_message_parents[-1].body.append(msg)
+ logged = True
+ # Handle warnings and errors as well as logging to console.
+ if msg.level in ("WARN", "ERROR"):
+ self.message(msg)
+ logged = True
+ elif msg.console:
+ write_to_console(msg.message)
+ msg.console = False
+ # If not logged otherwise, log as a system message.
+ if not logged:
self.message(msg)
-
- log_message = message
def log_output(self, output):
for msg in StdoutLogSplitter(output):
self.log_message(msg)
def enable_library_import_logging(self):
- self._prev_log_message_handlers.append(self.log_message)
- self.log_message = self.message
+ self._library_import_logging += 1
def disable_library_import_logging(self):
- self.log_message = self._prev_log_message_handlers.pop()
+ self._library_import_logging -= 1
+
+ def start_suite(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_suite(data, result)
- def start_suite(self, suite):
+ def end_suite(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_suite(data, result)
+
+ def start_test(self, data, result):
+ self._log_message_parents.append(result)
+ for logger in self.start_loggers:
+ logger.start_test(data, result)
+
+ def end_test(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_test(data, result)
+ self._log_message_parents.pop()
+
+ @start_body_item
+ def start_keyword(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_keyword(data, result)
+
+ @end_body_item
+ def end_keyword(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_keyword(data, result)
+
+ @start_body_item
+ def start_user_keyword(self, data, implementation, result):
+ for logger in self.start_loggers:
+ logger.start_user_keyword(data, implementation, result)
+
+ @end_body_item
+ def end_user_keyword(self, data, implementation, result):
+ for logger in self.end_loggers:
+ logger.end_user_keyword(data, implementation, result)
+
+ @start_body_item
+ def start_library_keyword(self, data, implementation, result):
for logger in self.start_loggers:
- logger.start_suite(suite)
+ logger.start_library_keyword(data, implementation, result)
- def end_suite(self, suite):
+ @end_body_item
+ def end_library_keyword(self, data, implementation, result):
for logger in self.end_loggers:
- logger.end_suite(suite)
+ logger.end_library_keyword(data, implementation, result)
- def start_test(self, test):
+ @start_body_item
+ def start_invalid_keyword(self, data, implementation, result):
for logger in self.start_loggers:
- logger.start_test(test)
+ logger.start_invalid_keyword(data, implementation, result)
- def end_test(self, test):
+ @end_body_item
+ def end_invalid_keyword(self, data, implementation, result):
for logger in self.end_loggers:
- logger.end_test(test)
+ logger.end_invalid_keyword(data, implementation, result)
- def start_keyword(self, keyword):
- # TODO: Could _prev_log_message_handlers be used also here?
- self._started_keywords += 1
- self.log_message = self._log_message
+ @start_body_item
+ def start_for(self, data, result):
for logger in self.start_loggers:
- logger.start_keyword(keyword)
+ logger.start_for(data, result)
- def end_keyword(self, keyword):
- self._started_keywords -= 1
+ @end_body_item
+ def end_for(self, data, result):
for logger in self.end_loggers:
- logger.end_keyword(keyword)
- if not self._started_keywords:
- self.log_message = self.message
+ logger.end_for(data, result)
+
+ @start_body_item
+ def start_for_iteration(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_for_iteration(data, result)
+
+ @end_body_item
+ def end_for_iteration(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_for_iteration(data, result)
+
+ @start_body_item
+ def start_while(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_while(data, result)
+
+ @end_body_item
+ def end_while(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_while(data, result)
+
+ @start_body_item
+ def start_while_iteration(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_while_iteration(data, result)
+
+ @end_body_item
+ def end_while_iteration(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_while_iteration(data, result)
+
+ @start_body_item
+ def start_group(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_group(data, result)
- def imported(self, import_type, name, **attrs):
+ @end_body_item
+ def end_group(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_group(data, result)
+
+ @start_body_item
+ def start_if(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_if(data, result)
+
+ @end_body_item
+ def end_if(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_if(data, result)
+
+ @start_body_item
+ def start_if_branch(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_if_branch(data, result)
+
+ @end_body_item
+ def end_if_branch(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_if_branch(data, result)
+
+ @start_body_item
+ def start_try(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_try(data, result)
+
+ @end_body_item
+ def end_try(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_try(data, result)
+
+ @start_body_item
+ def start_try_branch(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_try_branch(data, result)
+
+ @end_body_item
+ def end_try_branch(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_try_branch(data, result)
+
+ @start_body_item
+ def start_var(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_var(data, result)
+
+ @end_body_item
+ def end_var(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_var(data, result)
+
+ @start_body_item
+ def start_break(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_break(data, result)
+
+ @end_body_item
+ def end_break(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_break(data, result)
+
+ @start_body_item
+ def start_continue(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_continue(data, result)
+
+ @end_body_item
+ def end_continue(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_continue(data, result)
+
+ @start_body_item
+ def start_return(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_return(data, result)
+
+ @end_body_item
+ def end_return(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_return(data, result)
+
+ @start_body_item
+ def start_error(self, data, result):
+ for logger in self.start_loggers:
+ logger.start_error(data, result)
+
+ @end_body_item
+ def end_error(self, data, result):
+ for logger in self.end_loggers:
+ logger.end_error(data, result)
+
+ def library_import(self, library, importer):
+ for logger in self:
+ logger.library_import(library, importer)
+
+ def resource_import(self, resource, importer):
+ for logger in self:
+ logger.resource_import(resource, importer)
+
+ def variables_import(self, variables, importer):
for logger in self:
- logger.imported(import_type, name, attrs)
+ logger.variables_import(variables, importer)
- def output_file(self, file_type, path):
- """Finished output, report, log, debug, or xunit file"""
+ def output_file(self, path):
for logger in self:
- logger.output_file(file_type, path)
+ logger.output_file(path)
+
+ def report_file(self, path):
+ for logger in self:
+ logger.report_file(path)
+
+ def log_file(self, path):
+ for logger in self:
+ logger.log_file(path)
+
+ def xunit_file(self, path):
+ for logger in self:
+ logger.xunit_file(path)
+
+ def debug_file(self, path):
+ for logger in self:
+ logger.debug_file(path)
+
+ def result_file(self, kind, path):
+ kind_file = getattr(self, f"{kind.lower()}_file")
+ kind_file(path)
def close(self):
for logger in self:
@@ -241,57 +457,4 @@ def close(self):
self.__init__(register_console_logger=False)
-class LoggerProxy(AbstractLoggerProxy):
- _methods = ('start_suite', 'end_suite', 'start_test', 'end_test',
- 'start_keyword', 'end_keyword', 'message', 'log_message',
- 'imported', 'output_file', 'close')
-
- _start_keyword_methods = {
- 'For': 'start_for',
- 'ForIteration': 'start_for_iteration',
- 'While': 'start_while',
- 'WhileIteration': 'start_while_iteration',
- 'If': 'start_if',
- 'IfBranch': 'start_if_branch',
- 'Try': 'start_try',
- 'TryBranch': 'start_try_branch',
- 'Return': 'start_return',
- 'Continue': 'start_continue',
- 'Break': 'start_break',
- }
- _end_keyword_methods = {
- 'For': 'end_for',
- 'ForIteration': 'end_for_iteration',
- 'While': 'end_while',
- 'WhileIteration': 'end_while_iteration',
- 'If': 'end_if',
- 'IfBranch': 'end_if_branch',
- 'Try': 'end_try',
- 'TryBranch': 'end_try_branch',
- 'Return': 'end_return',
- 'Continue': 'end_continue',
- 'Break': 'end_break',
- }
-
- def start_keyword(self, kw):
- # Dispatch start_keyword calls to more precise methods when logger
- # implements them. This horrible hack is needed because internal logger
- # knows only about keywords. It should be rewritten.
- name = self._start_keyword_methods.get(type(kw.result).__name__)
- if name and hasattr(self.logger, name):
- method = getattr(self.logger, name)
- else:
- method = self.logger.start_keyword
- method(kw)
-
- def end_keyword(self, kw):
- # See start_keyword comment for explanation of this horrible hack.
- name = self._end_keyword_methods.get(type(kw.result).__name__)
- if name and hasattr(self.logger, name):
- method = getattr(self.logger, name)
- else:
- method = self.logger.end_keyword
- method(kw)
-
-
LOGGER = Logger()
diff --git a/src/robot/output/loggerapi.py b/src/robot/output/loggerapi.py
new file mode 100644
index 00000000000..754d1151cfc
--- /dev/null
+++ b/src/robot/output/loggerapi.py
@@ -0,0 +1,271 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pathlib import Path
+from typing import Literal, TYPE_CHECKING
+
+if TYPE_CHECKING:
+ from robot import model, result, running
+
+
+class LoggerApi:
+
+ def start_suite(self, data: "running.TestSuite", result: "result.TestSuite"):
+ pass
+
+ def end_suite(self, data: "running.TestSuite", result: "result.TestSuite"):
+ pass
+
+ def start_test(self, data: "running.TestCase", result: "result.TestCase"):
+ pass
+
+ def end_test(self, data: "running.TestCase", result: "result.TestCase"):
+ pass
+
+ def start_keyword(self, data: "running.Keyword", result: "result.Keyword"):
+ self.start_body_item(data, result)
+
+ def end_keyword(self, data: "running.Keyword", result: "result.Keyword"):
+ self.end_body_item(data, result)
+
+ def start_user_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.UserKeyword",
+ result: "result.Keyword",
+ ):
+ self.start_keyword(data, result)
+
+ def end_user_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.UserKeyword",
+ result: "result.Keyword",
+ ):
+ self.end_keyword(data, result)
+
+ def start_library_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.LibraryKeyword",
+ result: "result.Keyword",
+ ):
+ self.start_keyword(data, result)
+
+ def end_library_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.LibraryKeyword",
+ result: "result.Keyword",
+ ):
+ self.end_keyword(data, result)
+
+ def start_invalid_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.KeywordImplementation",
+ result: "result.Keyword",
+ ):
+ self.start_keyword(data, result)
+
+ def end_invalid_keyword(
+ self,
+ data: "running.Keyword",
+ implementation: "running.KeywordImplementation",
+ result: "result.Keyword",
+ ):
+ self.end_keyword(data, result)
+
+ def start_for(self, data: "running.For", result: "result.For"):
+ self.start_body_item(data, result)
+
+ def end_for(self, data: "running.For", result: "result.For"):
+ self.end_body_item(data, result)
+
+ def start_for_iteration(
+ self,
+ data: "running.ForIteration",
+ result: "result.ForIteration",
+ ):
+ self.start_body_item(data, result)
+
+ def end_for_iteration(
+ self,
+ data: "running.ForIteration",
+ result: "result.ForIteration",
+ ):
+ self.end_body_item(data, result)
+
+ def start_while(self, data: "running.While", result: "result.While"):
+ self.start_body_item(data, result)
+
+ def end_while(self, data: "running.While", result: "result.While"):
+ self.end_body_item(data, result)
+
+ def start_while_iteration(
+ self,
+ data: "running.WhileIteration",
+ result: "result.WhileIteration",
+ ):
+ self.start_body_item(data, result)
+
+ def end_while_iteration(
+ self,
+ data: "running.WhileIteration",
+ result: "result.WhileIteration",
+ ):
+ self.end_body_item(data, result)
+
+ def start_group(self, data: "running.Group", result: "result.Group"):
+ self.start_body_item(data, result)
+
+ def end_group(self, data: "running.Group", result: "result.Group"):
+ self.end_body_item(data, result)
+
+ def start_if(self, data: "running.If", result: "result.If"):
+ self.start_body_item(data, result)
+
+ def end_if(self, data: "running.If", result: "result.If"):
+ self.end_body_item(data, result)
+
+ def start_if_branch(self, data: "running.IfBranch", result: "result.IfBranch"):
+ self.start_body_item(data, result)
+
+ def end_if_branch(self, data: "running.IfBranch", result: "result.IfBranch"):
+ self.end_body_item(data, result)
+
+ def start_try(self, data: "running.Try", result: "result.Try"):
+ self.start_body_item(data, result)
+
+ def end_try(self, data: "running.Try", result: "result.Try"):
+ self.end_body_item(data, result)
+
+ def start_try_branch(self, data: "running.TryBranch", result: "result.TryBranch"):
+ self.start_body_item(data, result)
+
+ def end_try_branch(self, data: "running.TryBranch", result: "result.TryBranch"):
+ self.end_body_item(data, result)
+
+ def start_var(self, data: "running.Var", result: "result.Var"):
+ self.start_body_item(data, result)
+
+ def end_var(self, data: "running.Var", result: "result.Var"):
+ self.end_body_item(data, result)
+
+ def start_break(self, data: "running.Break", result: "result.Break"):
+ self.start_body_item(data, result)
+
+ def end_break(self, data: "running.Break", result: "result.Break"):
+ self.end_body_item(data, result)
+
+ def start_continue(self, data: "running.Continue", result: "result.Continue"):
+ self.start_body_item(data, result)
+
+ def end_continue(self, data: "running.Continue", result: "result.Continue"):
+ self.end_body_item(data, result)
+
+ def start_return(self, data: "running.Return", result: "result.Return"):
+ self.start_body_item(data, result)
+
+ def end_return(self, data: "running.Return", result: "result.Return"):
+ self.end_body_item(data, result)
+
+ def start_error(self, data: "running.Error", result: "result.Error"):
+ self.start_body_item(data, result)
+
+ def end_error(self, data: "running.Error", result: "result.Error"):
+ self.end_body_item(data, result)
+
+ def start_body_item(self, data, result):
+ pass
+
+ def end_body_item(self, data, result):
+ pass
+
+ def log_message(self, message: "model.Message"):
+ pass
+
+ def message(self, message: "model.Message"):
+ pass
+
+ def output_file(self, path: Path):
+ """Called when XML output file is closed.
+
+ Calls :meth:`result_file` by default.
+ """
+ self.result_file("Output", path)
+
+ def report_file(self, path: Path):
+ """Called when report file is closed.
+
+ Calls :meth:`result_file` by default.
+ """
+ self.result_file("Report", path)
+
+ def log_file(self, path: Path):
+ """Called when log file is closed.
+
+ Calls :meth:`result_file` by default.
+ """
+ self.result_file("Log", path)
+
+ def xunit_file(self, path: Path):
+ """Called when xunit file is closed.
+
+ Calls :meth:`result_file` by default.
+ """
+ self.result_file("XUnit", path)
+
+ def debug_file(self, path: Path):
+ """Called when debug file is closed.
+
+ Calls :meth:`result_file` by default.
+ """
+ self.result_file("Debug", path)
+
+ def result_file(
+ self,
+ kind: Literal["Output", "Report", "Log", "XUnit", "Debug"],
+ path: Path,
+ ):
+ """Called when any result file is closed by default.
+
+ ``kind`` specifies the file type. This method is not called if a result
+ file specific method like :meth:`output_file` is implemented.
+ """
+ pass
+
+ def imported(self, import_type: str, name: str, attrs):
+ pass
+
+ def library_import(
+ self,
+ library: "running.TestLibrary",
+ importer: "running.Import",
+ ):
+ pass
+
+ def resource_import(
+ self,
+ resource: "running.ResourceFile",
+ importer: "running.Import",
+ ):
+ pass
+
+ def variables_import(self, attrs: dict, importer: "running.Import"):
+ pass
+
+ def close(self):
+ pass
diff --git a/src/robot/output/loggerhelper.py b/src/robot/output/loggerhelper.py
index be37bccd53a..8c198473690 100644
--- a/src/robot/output/loggerhelper.py
+++ b/src/robot/output/loggerhelper.py
@@ -13,59 +13,64 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.errors import DataError
-from robot.model import Message as BaseMessage
-from robot.utils import get_timestamp, is_string, safe_str
+import sys
+from datetime import datetime
+from typing import Callable, Literal
+from robot.model import MessageLevel
+from robot.result import Message as BaseMessage
+from robot.utils import console_encode
-LEVELS = {
- 'NONE' : 7,
- 'SKIP' : 6,
- 'FAIL' : 5,
- 'ERROR' : 4,
- 'WARN' : 3,
- 'INFO' : 2,
- 'DEBUG' : 1,
- 'TRACE' : 0,
-}
+from .loglevel import LEVELS
+PseudoLevel = Literal["HTML", "CONSOLE"]
-class AbstractLogger:
- def __init__(self, level='TRACE'):
- self._is_logged = IsLogged(level)
+def write_to_console(
+ msg: object,
+ newline: bool = True,
+ stream: Literal["stdout", "stderr"] = "stdout",
+):
+ if not isinstance(msg, str):
+ msg = str(msg)
+ if newline:
+ msg += "\n"
+ stream = sys.__stdout__ if stream.lower() != "stderr" else sys.__stderr__
+ if stream:
+ stream.write(console_encode(msg, stream=stream))
+ stream.flush()
+
- def set_level(self, level):
- return self._is_logged.set_level(level)
+class AbstractLogger:
def trace(self, msg):
- self.write(msg, 'TRACE')
+ self.write(msg, "TRACE")
def debug(self, msg):
- self.write(msg, 'DEBUG')
+ self.write(msg, "DEBUG")
def info(self, msg):
- self.write(msg, 'INFO')
+ self.write(msg, "INFO")
def warn(self, msg):
- self.write(msg, 'WARN')
+ self.write(msg, "WARN")
def fail(self, msg):
html = False
if msg.startswith("*HTML*"):
html = True
msg = msg[6:].lstrip()
- self.write(msg, 'FAIL', html)
+ self.write(msg, "FAIL", html)
def skip(self, msg):
html = False
if msg.startswith("*HTML*"):
html = True
msg = msg[6:].lstrip()
- self.write(msg, 'SKIP', html)
+ self.write(msg, "SKIP", html)
def error(self, msg):
- self.write(msg, 'ERROR')
+ self.write(msg, "ERROR")
def write(self, message, level, html=False):
self.message(Message(message, level, html))
@@ -75,94 +80,67 @@ def message(self, msg):
class Message(BaseMessage):
- __slots__ = ['_message']
-
- def __init__(self, message, level='INFO', html=False, timestamp=None):
- message = self._normalize_message(message)
- level, html = self._get_level_and_html(level, html)
- timestamp = timestamp or get_timestamp()
- super().__init__(message, level, html, timestamp)
-
- def _normalize_message(self, msg):
- if callable(msg):
- return msg
- if not is_string(msg):
- msg = safe_str(msg)
- if '\r\n' in msg:
- msg = msg.replace('\r\n', '\n')
- return msg
-
- def _get_level_and_html(self, level, html):
+ """Represents message logged during execution.
+
+ Most messages are logged by libraries. They typically log strings, but
+ possible non-string items have been converted to strings already before
+ they end up here.
+
+ In addition to strings, Robot Framework itself logs also callables to make
+ constructing messages that are not typically needed lazy. Such messages are
+ resolved when they are accessed.
+
+ Listeners can remove messages by setting the `message` attribute to `None`.
+ These messages are not written to the output.xml at all.
+
+ The ``console`` parameter controls writing the message to the console in
+ addition to the log file. By default, messages with the ``WARN`` and
+ ``ERROR`` level are logged to the console and others are not.
+ This parameter is new in Robot Framework 7.4.
+ """
+
+ __slots__ = ("_message", "console")
+
+ def __init__(
+ self,
+ message: "str|None|Callable[[], str|None]" = "",
+ level: "MessageLevel|PseudoLevel" = "INFO",
+ html: bool = False,
+ timestamp: "datetime|str|None" = None,
+ console: "bool|None" = None,
+ ):
+ level, html, console = self._get_level_html_console(level, html, console)
+ super().__init__(message, level, html, timestamp or datetime.now())
+ self.console = console
+
+ def _get_level_html_console(
+ self,
+ level: "MessageLevel | PseudoLevel",
+ html: bool,
+ console: "bool | None",
+ ) -> "tuple[MessageLevel, bool, bool]":
level = level.upper()
- if level == 'HTML':
- return 'INFO', True
- if level not in LEVELS:
- raise DataError("Invalid log level '%s'." % level)
- return level, html
+ if console is None:
+ console = level in ("WARN", "ERROR")
+ if level == "HTML":
+ return "INFO", True, console
+ if level == "CONSOLE":
+ return "INFO", html, True
+ if level in LEVELS:
+ return level, html, console
+ raise ValueError(f"Invalid log level '{level}'.")
@property
- def message(self):
+ def message(self) -> "str|None":
self.resolve_delayed_message()
return self._message
@message.setter
- def message(self, message):
+ def message(self, message: "str|None|Callable[[], str|None]"):
+ if isinstance(message, str) and "\r\n" in message:
+ message = message.replace("\r\n", "\n")
self._message = message
def resolve_delayed_message(self):
if callable(self._message):
- self._message = self._message()
-
-
-class IsLogged:
-
- def __init__(self, level):
- self.level = level.upper()
- self._int_level = self._level_to_int(level)
-
- def __call__(self, level):
- return self._level_to_int(level) >= self._int_level
-
- def set_level(self, level):
- old = self.level
- self.__init__(level)
- return old
-
- def _level_to_int(self, level):
- try:
- return LEVELS[level.upper()]
- except KeyError:
- raise DataError("Invalid log level '%s'." % level)
-
-
-class AbstractLoggerProxy:
- _methods = None
- _no_method = lambda *args: None
-
- def __init__(self, logger, method_names=None, prefix=None):
- self.logger = logger
- for name in method_names or self._methods:
- # Allow extending classes to implement some of the messages themselves.
- if hasattr(self, name):
- if hasattr(logger, name):
- continue
- target = logger
- else:
- target = self
- setattr(target, name, self._get_method(logger, name, prefix))
-
- def _get_method(self, logger, name, prefix):
- for method_name in self._get_method_names(name, prefix):
- if hasattr(logger, method_name):
- return getattr(logger, method_name)
- return self._no_method
-
- def _get_method_names(self, name, prefix):
- names = [name, self._toCamelCase(name)] if '_' in name else [name]
- if prefix:
- names += [prefix + name for name in names]
- return names
-
- def _toCamelCase(self, name):
- parts = name.split('_')
- return ''.join([parts[0]] + [part.capitalize() for part in parts[1:]])
+ self.message = self._message()
diff --git a/src/robot/output/loglevel.py b/src/robot/output/loglevel.py
new file mode 100644
index 00000000000..00bd67b7b61
--- /dev/null
+++ b/src/robot/output/loglevel.py
@@ -0,0 +1,52 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Literal, TYPE_CHECKING
+
+if TYPE_CHECKING:
+ from .loggerhelper import Message
+
+
+SettableLevel = Literal["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "NONE"]
+LEVELS = {
+ "NONE": 7,
+ "SKIP": 6,
+ "FAIL": 5,
+ "ERROR": 4,
+ "WARN": 3,
+ "INFO": 2,
+ "DEBUG": 1,
+ "TRACE": 0,
+}
+
+
+class LogLevel:
+
+ def __init__(self, level: SettableLevel):
+ self.level, self.priority = self._validate_level(level)
+
+ def is_logged(self, msg: "Message") -> bool:
+ return LEVELS[msg.level] >= self.priority and msg.message is not None
+
+ def set(self, level: SettableLevel) -> SettableLevel:
+ old = self.level
+ self.__init__(level)
+ return old
+
+ def _validate_level(self, level) -> "tuple[SettableLevel, int]":
+ upper = level.upper()
+ if upper not in LEVELS or upper in ("SKIP", "FAIL"):
+ raise ValueError(f"Invalid log level '{level}'.")
+ return upper, LEVELS[upper]
diff --git a/src/robot/output/output.py b/src/robot/output/output.py
index 88a796e1e2b..8d3e7194ebe 100644
--- a/src/robot/output/output.py
+++ b/src/robot/output/output.py
@@ -17,23 +17,33 @@
from .debugfile import DebugFile
from .listeners import LibraryListeners, Listeners
from .logger import LOGGER
+from .loggerapi import LoggerApi
from .loggerhelper import AbstractLogger
-from .xmllogger import XmlLogger
+from .loglevel import LogLevel
+from .outputfile import OutputFile
-class Output(AbstractLogger):
+class Output(AbstractLogger, LoggerApi):
def __init__(self, settings):
- AbstractLogger.__init__(self)
- self._xmllogger = XmlLogger(settings.output, settings.log_level,
- settings.rpa)
- self.listeners = Listeners(settings.listeners, settings.log_level)
- self.library_listeners = LibraryListeners(settings.log_level)
+ self.log_level = LogLevel(settings.log_level)
+ self.output_file = OutputFile(
+ settings.output,
+ self.log_level,
+ settings.rpa,
+ legacy_output=settings.legacy_output,
+ )
+ self.listeners = Listeners(settings.listeners, self.log_level)
+ self.library_listeners = LibraryListeners(self.log_level)
self._register_loggers(DebugFile(settings.debug_file))
self._settings = settings
+ @property
+ def initial_log_level(self):
+ return self._settings.log_level
+
def _register_loggers(self, debug_file):
- LOGGER.register_xml_logger(self._xmllogger)
+ LOGGER.register_output_file(self.output_file)
LOGGER.register_listeners(self.listeners or None, self.library_listeners)
if debug_file:
LOGGER.register_logger(debug_file)
@@ -41,35 +51,148 @@ def _register_loggers(self, debug_file):
def register_error_listener(self, listener):
LOGGER.register_error_listener(listener)
+ @property
+ def delayed_logging(self):
+ return self.output_file.delayed_logging
+
+ @property
+ def delayed_logging_paused(self):
+ return self.output_file.delayed_logging_paused
+
def close(self, result):
- self._xmllogger.visit_statistics(result.statistics)
- self._xmllogger.close()
- LOGGER.unregister_xml_logger()
- LOGGER.output_file('Output', self._settings['Output'])
+ self.output_file.statistics(result.statistics)
+ self.output_file.close()
+ LOGGER.unregister_output_file()
+ LOGGER.output_file(self._settings["Output"])
+
+ def start_suite(self, data, result):
+ LOGGER.start_suite(data, result)
+
+ def end_suite(self, data, result):
+ LOGGER.end_suite(data, result)
+
+ def start_test(self, data, result):
+ LOGGER.start_test(data, result)
+
+ def end_test(self, data, result):
+ LOGGER.end_test(data, result)
+
+ def start_keyword(self, data, result):
+ LOGGER.start_keyword(data, result)
+
+ def end_keyword(self, data, result):
+ LOGGER.end_keyword(data, result)
+
+ def start_user_keyword(self, data, implementation, result):
+ LOGGER.start_user_keyword(data, implementation, result)
+
+ def end_user_keyword(self, data, implementation, result):
+ LOGGER.end_user_keyword(data, implementation, result)
+
+ def start_library_keyword(self, data, implementation, result):
+ LOGGER.start_library_keyword(data, implementation, result)
+
+ def end_library_keyword(self, data, implementation, result):
+ LOGGER.end_library_keyword(data, implementation, result)
+
+ def start_invalid_keyword(self, data, implementation, result):
+ LOGGER.start_invalid_keyword(data, implementation, result)
+
+ def end_invalid_keyword(self, data, implementation, result):
+ LOGGER.end_invalid_keyword(data, implementation, result)
+
+ def start_for(self, data, result):
+ LOGGER.start_for(data, result)
+
+ def end_for(self, data, result):
+ LOGGER.end_for(data, result)
+
+ def start_for_iteration(self, data, result):
+ LOGGER.start_for_iteration(data, result)
+
+ def end_for_iteration(self, data, result):
+ LOGGER.end_for_iteration(data, result)
- def start_suite(self, suite):
- LOGGER.start_suite(suite)
+ def start_while(self, data, result):
+ LOGGER.start_while(data, result)
- def end_suite(self, suite):
- LOGGER.end_suite(suite)
+ def end_while(self, data, result):
+ LOGGER.end_while(data, result)
- def start_test(self, test):
- LOGGER.start_test(test)
+ def start_while_iteration(self, data, result):
+ LOGGER.start_while_iteration(data, result)
- def end_test(self, test):
- LOGGER.end_test(test)
+ def end_while_iteration(self, data, result):
+ LOGGER.end_while_iteration(data, result)
- def start_keyword(self, kw):
- LOGGER.start_keyword(kw)
+ def start_group(self, data, result):
+ LOGGER.start_group(data, result)
- def end_keyword(self, kw):
- LOGGER.end_keyword(kw)
+ def end_group(self, data, result):
+ LOGGER.end_group(data, result)
+
+ def start_if(self, data, result):
+ LOGGER.start_if(data, result)
+
+ def end_if(self, data, result):
+ LOGGER.end_if(data, result)
+
+ def start_if_branch(self, data, result):
+ LOGGER.start_if_branch(data, result)
+
+ def end_if_branch(self, data, result):
+ LOGGER.end_if_branch(data, result)
+
+ def start_try(self, data, result):
+ LOGGER.start_try(data, result)
+
+ def end_try(self, data, result):
+ LOGGER.end_try(data, result)
+
+ def start_try_branch(self, data, result):
+ LOGGER.start_try_branch(data, result)
+
+ def end_try_branch(self, data, result):
+ LOGGER.end_try_branch(data, result)
+
+ def start_var(self, data, result):
+ LOGGER.start_var(data, result)
+
+ def end_var(self, data, result):
+ LOGGER.end_var(data, result)
+
+ def start_break(self, data, result):
+ LOGGER.start_break(data, result)
+
+ def end_break(self, data, result):
+ LOGGER.end_break(data, result)
+
+ def start_continue(self, data, result):
+ LOGGER.start_continue(data, result)
+
+ def end_continue(self, data, result):
+ LOGGER.end_continue(data, result)
+
+ def start_return(self, data, result):
+ LOGGER.start_return(data, result)
+
+ def end_return(self, data, result):
+ LOGGER.end_return(data, result)
+
+ def start_error(self, data, result):
+ LOGGER.start_error(data, result)
+
+ def end_error(self, data, result):
+ LOGGER.end_error(data, result)
def message(self, msg):
LOGGER.log_message(msg)
+ def trace(self, msg, write_if_flat=True):
+ if write_if_flat or not self.output_file.flatten_level:
+ self.write(msg, "TRACE")
+
def set_log_level(self, level):
+ old = self.log_level.set(level)
pyloggingconf.set_level(level)
- self.listeners.set_log_level(level)
- self.library_listeners.set_log_level(level)
- return self._xmllogger.set_log_level(level)
+ return old
diff --git a/src/robot/output/outputfile.py b/src/robot/output/outputfile.py
new file mode 100644
index 00000000000..e3253c37fc3
--- /dev/null
+++ b/src/robot/output/outputfile.py
@@ -0,0 +1,212 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from contextlib import contextmanager
+from pathlib import Path
+
+from robot.errors import DataError
+from robot.utils import get_error_message
+
+from .jsonlogger import JsonLogger
+from .loggerapi import LoggerApi
+from .loglevel import LogLevel
+from .xmllogger import LegacyXmlLogger, NullLogger, XmlLogger
+
+
+class OutputFile(LoggerApi):
+
+ def __init__(
+ self,
+ path: "Path|None",
+ log_level: LogLevel,
+ rpa: bool = False,
+ legacy_output: bool = False,
+ ):
+ # `self.logger` is replaced with `NullLogger` when flattening.
+ self.logger = self.real_logger = self._get_logger(path, rpa, legacy_output)
+ self.is_logged = log_level.is_logged
+ self.flatten_level = 0
+ self.errors = []
+ self._delayed_messages = None
+
+ def _get_logger(self, path, rpa, legacy_output):
+ if not path:
+ return NullLogger()
+ try:
+ file = open(path, "w", encoding="UTF-8")
+ except Exception:
+ raise DataError(
+ f"Opening output file '{path}' failed: {get_error_message()}"
+ )
+ if path.suffix.lower() == ".json":
+ return JsonLogger(file, rpa)
+ if legacy_output:
+ return LegacyXmlLogger(file, rpa)
+ return XmlLogger(file, rpa)
+
+ @property
+ @contextmanager
+ def delayed_logging(self):
+ self._delayed_messages, previous = [], self._delayed_messages
+ try:
+ yield
+ finally:
+ self._release_delayed_messages()
+ self._delayed_messages = previous
+
+ @property
+ @contextmanager
+ def delayed_logging_paused(self):
+ self._release_delayed_messages()
+ self._delayed_messages = None
+ try:
+ yield
+ finally:
+ self._delayed_messages = []
+
+ def _release_delayed_messages(self):
+ for msg in self._delayed_messages or ():
+ self.log_message(msg, no_delay=True)
+
+ def start_suite(self, data, result):
+ self.logger.start_suite(result)
+
+ def end_suite(self, data, result):
+ self.logger.end_suite(result)
+
+ def start_test(self, data, result):
+ self.logger.start_test(result)
+
+ def end_test(self, data, result):
+ self.logger.end_test(result)
+
+ def start_keyword(self, data, result):
+ self.logger.start_keyword(result)
+ if result.tags.robot("flatten"):
+ self.flatten_level += 1
+ self.logger = NullLogger()
+
+ def end_keyword(self, data, result):
+ if self.flatten_level and result.tags.robot("flatten"):
+ self.flatten_level -= 1
+ if self.flatten_level == 0:
+ self.logger = self.real_logger
+ self.logger.end_keyword(result)
+
+ def start_for(self, data, result):
+ self.logger.start_for(result)
+
+ def end_for(self, data, result):
+ self.logger.end_for(result)
+
+ def start_for_iteration(self, data, result):
+ self.logger.start_for_iteration(result)
+
+ def end_for_iteration(self, data, result):
+ self.logger.end_for_iteration(result)
+
+ def start_while(self, data, result):
+ self.logger.start_while(result)
+
+ def end_while(self, data, result):
+ self.logger.end_while(result)
+
+ def start_while_iteration(self, data, result):
+ self.logger.start_while_iteration(result)
+
+ def end_while_iteration(self, data, result):
+ self.logger.end_while_iteration(result)
+
+ def start_if(self, data, result):
+ self.logger.start_if(result)
+
+ def end_if(self, data, result):
+ self.logger.end_if(result)
+
+ def start_if_branch(self, data, result):
+ self.logger.start_if_branch(result)
+
+ def end_if_branch(self, data, result):
+ self.logger.end_if_branch(result)
+
+ def start_try(self, data, result):
+ self.logger.start_try(result)
+
+ def end_try(self, data, result):
+ self.logger.end_try(result)
+
+ def start_try_branch(self, data, result):
+ self.logger.start_try_branch(result)
+
+ def end_try_branch(self, data, result):
+ self.logger.end_try_branch(result)
+
+ def start_group(self, data, result):
+ self.logger.start_group(result)
+
+ def end_group(self, data, result):
+ self.logger.end_group(result)
+
+ def start_var(self, data, result):
+ self.logger.start_var(result)
+
+ def end_var(self, data, result):
+ self.logger.end_var(result)
+
+ def start_break(self, data, result):
+ self.logger.start_break(result)
+
+ def end_break(self, data, result):
+ self.logger.end_break(result)
+
+ def start_continue(self, data, result):
+ self.logger.start_continue(result)
+
+ def end_continue(self, data, result):
+ self.logger.end_continue(result)
+
+ def start_return(self, data, result):
+ self.logger.start_return(result)
+
+ def end_return(self, data, result):
+ self.logger.end_return(result)
+
+ def start_error(self, data, result):
+ self.logger.start_error(result)
+
+ def end_error(self, data, result):
+ self.logger.end_error(result)
+
+ def log_message(self, message, no_delay=False):
+ if self.is_logged(message):
+ if self._delayed_messages is None or no_delay:
+ # Use the real logger also when flattening.
+ self.real_logger.message(message)
+ else:
+ # Logging is delayed when using timeouts to avoid writing to output
+ # files being interrupted. There are still problems, though:
+ # https://github.com/robotframework/robotframework/issues/5417
+ self._delayed_messages.append(message)
+
+ def message(self, message):
+ if message.level in ("WARN", "ERROR"):
+ self.errors.append(message)
+
+ def statistics(self, stats):
+ self.logger.statistics(stats)
+
+ def close(self):
+ self.logger.errors(self.errors)
+ self.logger.close()
diff --git a/src/robot/output/pyloggingconf.py b/src/robot/output/pyloggingconf.py
index fdccb16329d..b6ba0bf3128 100644
--- a/src/robot/output/pyloggingconf.py
+++ b/src/robot/output/pyloggingconf.py
@@ -13,19 +13,20 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from contextlib import contextmanager
import logging
+from contextlib import contextmanager
from robot.utils import get_error_details, safe_str
from . import librarylogger
-
-LEVELS = {'TRACE': logging.NOTSET,
- 'DEBUG': logging.DEBUG,
- 'INFO': logging.INFO,
- 'WARN': logging.WARNING,
- 'ERROR': logging.ERROR}
+LEVELS = {
+ "TRACE": logging.NOTSET,
+ "DEBUG": logging.DEBUG,
+ "INFO": logging.INFO,
+ "WARN": logging.WARNING,
+ "ERROR": logging.ERROR,
+}
@contextmanager
@@ -36,6 +37,7 @@ def robot_handler_enabled(level):
return
handler = RobotHandler()
old_raise = logging.raiseExceptions
+ old_level = root.level
root.addHandler(handler)
logging.raiseExceptions = False
set_level(level)
@@ -43,6 +45,7 @@ def robot_handler_enabled(level):
yield
finally:
root.removeHandler(handler)
+ root.setLevel(old_level)
logging.raiseExceptions = old_raise
@@ -70,10 +73,11 @@ def emit(self, record):
def _get_message(self, record):
try:
return self.format(record), None
- except:
- message = 'Failed to log following message properly: %s' \
- % safe_str(record.msg)
- error = '\n'.join(get_error_details())
+ except Exception:
+ message = (
+ f"Failed to log following message properly: {safe_str(record.msg)}"
+ )
+ error = "\n".join(get_error_details())
return message, error
def _get_logger_method(self, level):
diff --git a/src/robot/output/stdoutlogsplitter.py b/src/robot/output/stdoutlogsplitter.py
index dae95e64520..6b2f29931d2 100644
--- a/src/robot/output/stdoutlogsplitter.py
+++ b/src/robot/output/stdoutlogsplitter.py
@@ -14,8 +14,7 @@
# limitations under the License.
import re
-
-from robot.utils import format_time
+from datetime import datetime
from .loggerhelper import Message
@@ -23,10 +22,13 @@
class StdoutLogSplitter:
"""Splits messages logged through stdout (or stderr) into Message objects"""
- _split_from_levels = re.compile(r'^(?:\*'
- r'(TRACE|DEBUG|INFO|HTML|WARN|ERROR)'
- r'(:\d+(?:\.\d+)?)?' # Optional timestamp
- r'\*)', re.MULTILINE)
+ _split_from_levels = re.compile(
+ r"^(?:\*"
+ r"(TRACE|DEBUG|INFO|CONSOLE|HTML|WARN|ERROR)"
+ r"(:\d+(?:\.\d+)?)?" # Optional timestamp
+ r"\*)",
+ re.MULTILINE,
+ )
def __init__(self, output):
self._messages = list(self._get_messages(output.strip()))
@@ -34,25 +36,28 @@ def __init__(self, output):
def _get_messages(self, output):
for level, timestamp, msg in self._split_output(output):
if timestamp:
- timestamp = self._format_timestamp(timestamp[1:])
+ timestamp = datetime.fromtimestamp(float(timestamp[1:]) / 1000)
yield Message(msg.strip(), level, timestamp=timestamp)
def _split_output(self, output):
tokens = self._split_from_levels.split(output)
tokens = self._add_initial_level_and_time_if_needed(tokens)
for i in range(0, len(tokens), 3):
- yield tokens[i:i+3]
+ yield tokens[i : i + 3]
def _add_initial_level_and_time_if_needed(self, tokens):
if self._output_started_with_level(tokens):
return tokens[1:]
- return ['INFO', None] + tokens
+ return ["INFO", None, *tokens]
def _output_started_with_level(self, tokens):
- return tokens[0] == ''
-
- def _format_timestamp(self, millis):
- return format_time(float(millis)/1000, millissep='.')
+ return tokens[0] == ""
def __iter__(self):
return iter(self._messages)
+
+ def __len__(self):
+ return len(self._messages)
+
+ def __getitem__(self, item):
+ return self._messages[item]
diff --git a/src/robot/output/xmllogger.py b/src/robot/output/xmllogger.py
index d88fbb2f924..7df7ef942bb 100644
--- a/src/robot/output/xmllogger.py
+++ b/src/robot/output/xmllogger.py
@@ -13,241 +13,338 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import get_timestamp, NullMarkupWriter, safe_str, XmlWriter
-from robot.version import get_full_version
-from robot.result.visitor import ResultVisitor
+from datetime import datetime
-from .loggerhelper import IsLogged
+from robot.result import Keyword, ResultVisitor, TestCase, TestSuite
+from robot.utils import NullMarkupWriter, XmlWriter
+from robot.version import get_full_version
class XmlLogger(ResultVisitor):
+ generator = "Robot"
+
+ def __init__(self, output, rpa=False, suite_only=False):
+ self._writer = self._get_writer(output, preamble=not suite_only)
+ if not suite_only:
+ self._writer.start("robot", self._get_start_attrs(rpa))
+
+ def _get_writer(self, output, preamble=True):
+ return XmlWriter(output, usage="output", write_empty=False, preamble=preamble)
- def __init__(self, path, log_level='TRACE', rpa=False, generator='Robot'):
- self._log_message_is_logged = IsLogged(log_level)
- self._error_message_is_logged = IsLogged('WARN')
- self._writer = self._get_writer(path, rpa, generator)
- self._errors = []
-
- def _get_writer(self, path, rpa, generator):
- if not path:
- return NullMarkupWriter()
- writer = XmlWriter(path, write_empty=False, usage='output')
- writer.start('robot', {'generator': get_full_version(generator),
- 'generated': get_timestamp(),
- 'rpa': 'true' if rpa else 'false',
- 'schemaversion': '3'})
- return writer
+ def _get_start_attrs(self, rpa):
+ return {
+ "generator": get_full_version(self.generator),
+ "generated": datetime.now().isoformat(),
+ "rpa": "true" if rpa else "false",
+ "schemaversion": "5",
+ }
def close(self):
- self.start_errors()
- for msg in self._errors:
- self._write_message(msg)
- self.end_errors()
- self._writer.end('robot')
+ self._writer.end("robot")
self._writer.close()
- def set_log_level(self, level):
- return self._log_message_is_logged.set_level(level)
+ def visit_message(self, msg):
+ self._write_message(msg)
def message(self, msg):
- if self._error_message_is_logged(msg.level):
- self._errors.append(msg)
-
- def log_message(self, msg):
- if self._log_message_is_logged(msg.level):
- self._write_message(msg)
+ self._write_message(msg)
def _write_message(self, msg):
- attrs = {'timestamp': msg.timestamp or 'N/A', 'level': msg.level}
+ attrs = {
+ "time": msg.timestamp.isoformat() if msg.timestamp else None,
+ "level": msg.level,
+ }
if msg.html:
- attrs['html'] = 'true'
- self._writer.element('msg', msg.message, attrs)
+ attrs["html"] = "true"
+ self._writer.element("msg", msg.message, attrs)
def start_keyword(self, kw):
- attrs = {'name': kw.kwname, 'library': kw.libname}
- if kw.type != 'KEYWORD':
- attrs['type'] = kw.type
- if kw.sourcename:
- attrs['sourcename'] = kw.sourcename
- self._writer.start('kw', attrs)
- self._write_list('var', kw.assign)
- self._write_list('arg', [safe_str(a) for a in kw.args])
- self._write_list('tag', kw.tags)
- # Must be after tags to allow adding message when using --flattenkeywords.
- self._writer.element('doc', kw.doc)
+ self._writer.start("kw", self._get_start_keyword_attrs(kw))
+
+ def _get_start_keyword_attrs(self, kw):
+ attrs = {"name": kw.name, "owner": kw.owner}
+ if kw.type != "KEYWORD":
+ attrs["type"] = kw.type
+ if kw.source_name:
+ attrs["source_name"] = kw.source_name
+ return attrs
def end_keyword(self, kw):
+ self._write_list("var", kw.assign)
+ self._write_list("arg", [str(a) for a in kw.args])
+ self._write_list("tag", kw.tags)
+ self._writer.element("doc", kw.doc)
if kw.timeout:
- self._writer.element('timeout', attrs={'value': str(kw.timeout)})
+ self._writer.element("timeout", attrs={"value": str(kw.timeout)})
self._write_status(kw)
- self._writer.end('kw')
+ self._writer.end("kw")
def start_if(self, if_):
- self._writer.start('if')
- self._writer.element('doc', if_.doc)
+ self._writer.start("if")
def end_if(self, if_):
self._write_status(if_)
- self._writer.end('if')
+ self._writer.end("if")
def start_if_branch(self, branch):
- self._writer.start('branch', {'type': branch.type,
- 'condition': branch.condition})
- self._writer.element('doc', branch.doc)
+ attrs = {"type": branch.type, "condition": branch.condition}
+ self._writer.start("branch", attrs)
def end_if_branch(self, branch):
self._write_status(branch)
- self._writer.end('branch')
+ self._writer.end("branch")
def start_for(self, for_):
- self._writer.start('for', {'flavor': for_.flavor})
- for name in for_.variables:
- self._writer.element('var', name)
- for value in for_.values:
- self._writer.element('value', value)
- self._writer.element('doc', for_.doc)
+ attrs = {
+ "flavor": for_.flavor,
+ "start": for_.start,
+ "mode": for_.mode,
+ "fill": for_.fill,
+ }
+ self._writer.start("for", attrs)
def end_for(self, for_):
+ for name in for_.assign:
+ self._writer.element("var", name)
+ for value in for_.values:
+ self._writer.element("value", value)
self._write_status(for_)
- self._writer.end('for')
+ self._writer.end("for")
def start_for_iteration(self, iteration):
- self._writer.start('iter')
- for name, value in iteration.variables.items():
- self._writer.element('var', value, {'name': name})
- self._writer.element('doc', iteration.doc)
+ self._writer.start("iter")
def end_for_iteration(self, iteration):
+ for name, value in iteration.assign.items():
+ self._writer.element("var", value, {"name": name})
self._write_status(iteration)
- self._writer.end('iter')
+ self._writer.end("iter")
def start_try(self, root):
- self._writer.start('try')
+ self._writer.start("try")
def end_try(self, root):
self._write_status(root)
- self._writer.end('try')
+ self._writer.end("try")
def start_try_branch(self, branch):
+ attrs = {
+ "type": "EXCEPT",
+ "pattern_type": branch.pattern_type,
+ "assign": branch.assign,
+ }
if branch.type == branch.EXCEPT:
- self._writer.start('branch', attrs={
- 'type': 'EXCEPT', 'variable': branch.variable,
- 'pattern_type': branch.pattern_type
- })
- self._write_list('pattern', branch.patterns)
+ self._writer.start("branch", attrs)
+ self._write_list("pattern", branch.patterns)
else:
- self._writer.start('branch', attrs={'type': branch.type})
+ self._writer.start("branch", attrs={"type": branch.type})
def end_try_branch(self, branch):
self._write_status(branch)
- self._writer.end('branch')
+ self._writer.end("branch")
def start_while(self, while_):
- self._writer.start('while', attrs={
- 'condition': while_.condition,
- 'limit': while_.limit
- })
- self._writer.element('doc', while_.doc)
+ attrs = {
+ "condition": while_.condition,
+ "limit": while_.limit,
+ "on_limit": while_.on_limit,
+ "on_limit_message": while_.on_limit_message,
+ }
+ self._writer.start("while", attrs)
def end_while(self, while_):
self._write_status(while_)
- self._writer.end('while')
+ self._writer.end("while")
def start_while_iteration(self, iteration):
- self._writer.start('iter')
- self._writer.element('doc', iteration.doc)
+ self._writer.start("iter")
def end_while_iteration(self, iteration):
self._write_status(iteration)
- self._writer.end('iter')
+ self._writer.end("iter")
+
+ def start_group(self, group):
+ self._writer.start("group", {"name": group.name})
+
+ def end_group(self, group):
+ self._write_status(group)
+ self._writer.end("group")
+
+ def start_var(self, var):
+ attr = {"name": var.name}
+ if var.scope is not None:
+ attr["scope"] = var.scope
+ if var.separator is not None:
+ attr["separator"] = var.separator
+ self._writer.start("variable", attr, write_empty=True)
+
+ def end_var(self, var):
+ for val in var.value:
+ self._writer.element("var", val)
+ self._write_status(var)
+ self._writer.end("variable")
def start_return(self, return_):
- self._writer.start('return')
- for value in return_.values:
- self._writer.element('value', value)
+ self._writer.start("return")
def end_return(self, return_):
+ for value in return_.values:
+ self._writer.element("value", value)
self._write_status(return_)
- self._writer.end('return')
+ self._writer.end("return")
def start_continue(self, continue_):
- self._writer.start('continue')
+ self._writer.start("continue")
def end_continue(self, continue_):
self._write_status(continue_)
- self._writer.end('continue')
+ self._writer.end("continue")
def start_break(self, break_):
- self._writer.start('break')
+ self._writer.start("break")
def end_break(self, break_):
self._write_status(break_)
- self._writer.end('break')
+ self._writer.end("break")
+
+ def start_error(self, error):
+ self._writer.start("error")
+
+ def end_error(self, error):
+ for value in error.values:
+ self._writer.element("value", value)
+ self._write_status(error)
+ self._writer.end("error")
def start_test(self, test):
- self._writer.start('test', {'id': test.id, 'name': test.name,
- 'line': str(test.lineno or '')})
+ attrs = {"id": test.id, "name": test.name, "line": str(test.lineno or "")}
+ self._writer.start("test", attrs)
def end_test(self, test):
- self._writer.element('doc', test.doc)
- self._write_list('tag', test.tags)
+ self._writer.element("doc", test.doc)
+ self._write_list("tag", test.tags)
if test.timeout:
- self._writer.element('timeout', attrs={'value': str(test.timeout)})
+ self._writer.element("timeout", attrs={"value": str(test.timeout)})
self._write_status(test)
- self._writer.end('test')
+ self._writer.end("test")
def start_suite(self, suite):
- attrs = {'id': suite.id, 'name': suite.name, 'source': suite.source}
- self._writer.start('suite', attrs)
+ attrs = {"id": suite.id, "name": suite.name}
+ if suite.source:
+ attrs["source"] = str(suite.source)
+ self._writer.start("suite", attrs)
def end_suite(self, suite):
- self._writer.element('doc', suite.doc)
+ self._writer.element("doc", suite.doc)
for name, value in suite.metadata.items():
- self._writer.element('meta', value, {'name': name})
+ self._writer.element("meta", value, {"name": name})
self._write_status(suite)
- self._writer.end('suite')
+ self._writer.end("suite")
+
+ def statistics(self, stats):
+ self.visit_statistics(stats)
def start_statistics(self, stats):
- self._writer.start('statistics')
+ self._writer.start("statistics")
def end_statistics(self, stats):
- self._writer.end('statistics')
+ self._writer.end("statistics")
def start_total_statistics(self, total_stats):
- self._writer.start('total')
+ self._writer.start("total")
def end_total_statistics(self, total_stats):
- self._writer.end('total')
+ self._writer.end("total")
def start_tag_statistics(self, tag_stats):
- self._writer.start('tag')
+ self._writer.start("tag")
def end_tag_statistics(self, tag_stats):
- self._writer.end('tag')
+ self._writer.end("tag")
def start_suite_statistics(self, tag_stats):
- self._writer.start('suite')
+ self._writer.start("suite")
def end_suite_statistics(self, tag_stats):
- self._writer.end('suite')
+ self._writer.end("suite")
def visit_stat(self, stat):
- self._writer.element('stat', stat.name,
- stat.get_attributes(values_as_strings=True))
+ attrs = stat.get_attributes(values_as_strings=True)
+ self._writer.element("stat", stat.name, attrs)
+
+ def errors(self, errors):
+ self.visit_errors(errors)
- def start_errors(self, errors=None):
- self._writer.start('errors')
+ def start_errors(self, errors):
+ self._writer.start("errors")
- def end_errors(self, errors=None):
- self._writer.end('errors')
+ def end_errors(self, errors):
+ self._writer.end("errors")
def _write_list(self, tag, items):
for item in items:
self._writer.element(tag, item)
def _write_status(self, item):
- attrs = {'status': item.status, 'starttime': item.starttime or 'N/A',
- 'endtime': item.endtime or 'N/A'}
- if not (item.starttime and item.endtime):
- attrs['elapsedtime'] = str(item.elapsedtime)
- self._writer.element('status', item.message, attrs)
+ attrs = {
+ "status": item.status,
+ "start": item.start_time.isoformat() if item.start_time else None,
+ "elapsed": format(item.elapsed_time.total_seconds(), "f"),
+ }
+ self._writer.element("status", item.message, attrs)
+
+
+class LegacyXmlLogger(XmlLogger):
+
+ def _get_start_attrs(self, rpa):
+ return {
+ "generator": get_full_version(self.generator),
+ "generated": self._datetime_to_timestamp(datetime.now()),
+ "rpa": "true" if rpa else "false",
+ "schemaversion": "4",
+ }
+
+ def _datetime_to_timestamp(self, dt):
+ if dt is None:
+ return None
+ return dt.isoformat(" ", timespec="milliseconds").replace("-", "")
+
+ def _get_start_keyword_attrs(self, kw):
+ attrs = {"name": kw.kwname, "library": kw.libname}
+ if kw.type != "KEYWORD":
+ attrs["type"] = kw.type
+ if kw.source_name:
+ attrs["sourcename"] = kw.source_name
+ return attrs
+
+ def _write_status(self, item):
+ attrs = {
+ "status": item.status,
+ "starttime": self._datetime_to_timestamp(item.start_time),
+ "endtime": self._datetime_to_timestamp(item.end_time),
+ }
+ if (
+ isinstance(item, (TestSuite, TestCase))
+ or isinstance(item, Keyword)
+ and item.type == "TEARDOWN"
+ ):
+ message = item.message
+ else:
+ message = ""
+ self._writer.element("status", message, attrs)
+
+ def _write_message(self, msg):
+ ts = self._datetime_to_timestamp(msg.timestamp) if msg.timestamp else None
+ attrs = {"timestamp": ts, "level": msg.level}
+ if msg.html:
+ attrs["html"] = "true"
+ self._writer.element("msg", msg.message, attrs)
+
+
+class NullLogger(XmlLogger):
+
+ def __init__(self):
+ super().__init__(None)
+
+ def _get_writer(self, output, preamble=True):
+ return NullMarkupWriter()
diff --git a/src/robot/parsing/__init__.py b/src/robot/parsing/__init__.py
index 09589f41ab9..50dd8d29d38 100644
--- a/src/robot/parsing/__init__.py
+++ b/src/robot/parsing/__init__.py
@@ -21,7 +21,26 @@
:mod:`robot.api.parsing`.
"""
-from .lexer import get_tokens, get_resource_tokens, get_init_tokens, Token
-from .model import ModelTransformer, ModelVisitor
-from .parser import get_model, get_resource_model, get_init_model
-from .suitestructure import SuiteStructureBuilder, SuiteStructureVisitor
+from .lexer import (
+ get_init_tokens as get_init_tokens,
+ get_resource_tokens as get_resource_tokens,
+ get_tokens as get_tokens,
+ Token as Token,
+)
+from .model import (
+ File as File,
+ ModelTransformer as ModelTransformer,
+ ModelVisitor as ModelVisitor,
+)
+from .parser import (
+ get_init_model as get_init_model,
+ get_model as get_model,
+ get_resource_model as get_resource_model,
+)
+from .suitestructure import (
+ SuiteDirectory as SuiteDirectory,
+ SuiteFile as SuiteFile,
+ SuiteStructure as SuiteStructure,
+ SuiteStructureBuilder as SuiteStructureBuilder,
+ SuiteStructureVisitor as SuiteStructureVisitor,
+)
diff --git a/src/robot/parsing/lexer/__init__.py b/src/robot/parsing/lexer/__init__.py
index a9c47f0d0d5..069489df1f2 100644
--- a/src/robot/parsing/lexer/__init__.py
+++ b/src/robot/parsing/lexer/__init__.py
@@ -13,5 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .lexer import get_tokens, get_resource_tokens, get_init_tokens
-from .tokens import Token
+from .lexer import (
+ get_init_tokens as get_init_tokens,
+ get_resource_tokens as get_resource_tokens,
+ get_tokens as get_tokens,
+)
+from .tokens import StatementTokens as StatementTokens, Token as Token
diff --git a/src/robot/parsing/lexer/blocklexers.py b/src/robot/parsing/lexer/blocklexers.py
index 458bc027137..e3cf6980c7b 100644
--- a/src/robot/parsing/lexer/blocklexers.py
+++ b/src/robot/parsing/lexer/blocklexers.py
@@ -13,60 +13,61 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC
+from collections.abc import Iterator
+
from robot.utils import normalize_whitespace
-from .tokens import Token
-from .statementlexers import (Lexer,
- SettingSectionHeaderLexer, SettingLexer,
- VariableSectionHeaderLexer, VariableLexer,
- TestCaseSectionHeaderLexer,
- KeywordSectionHeaderLexer,
- CommentSectionHeaderLexer, CommentLexer,
- ErrorSectionHeaderLexer,
- TestOrKeywordSettingLexer,
- KeywordCallLexer,
- IfHeaderLexer, ElseIfHeaderLexer, ElseHeaderLexer,
- InlineIfHeaderLexer, EndLexer,
- TryHeaderLexer, ExceptHeaderLexer, FinallyHeaderLexer,
- ForHeaderLexer, WhileHeaderLexer,
- ContinueLexer, BreakLexer, ReturnLexer)
-
-
-class BlockLexer(Lexer):
-
- def __init__(self, ctx):
- """:type ctx: :class:`robot.parsing.lexer.context.FileContext`"""
+from .context import (
+ FileContext, KeywordContext, LexingContext, SuiteFileContext, TestCaseContext
+)
+from .statementlexers import (
+ BreakLexer, CommentLexer, CommentSectionHeaderLexer, ContinueLexer, ElseHeaderLexer,
+ ElseIfHeaderLexer, EndLexer, ExceptHeaderLexer, FinallyHeaderLexer, ForHeaderLexer,
+ GroupHeaderLexer, IfHeaderLexer, ImplicitCommentLexer, InlineIfHeaderLexer,
+ InvalidSectionHeaderLexer, KeywordCallLexer, KeywordSectionHeaderLexer,
+ KeywordSettingLexer, Lexer, ReturnLexer, SettingLexer, SettingSectionHeaderLexer,
+ SyntaxErrorLexer, TaskSectionHeaderLexer, TestCaseSectionHeaderLexer,
+ TestCaseSettingLexer, TryHeaderLexer, VariableLexer, VariableSectionHeaderLexer,
+ VarLexer, WhileHeaderLexer
+)
+from .tokens import StatementTokens, Token
+
+
+class BlockLexer(Lexer, ABC):
+
+ def __init__(self, ctx: LexingContext):
super().__init__(ctx)
- self.lexers = []
+ self.lexers: "list[Lexer]" = []
- def accepts_more(self, statement):
+ def accepts_more(self, statement: StatementTokens) -> bool:
return True
- def input(self, statement):
+ def input(self, statement: StatementTokens):
if self.lexers and self.lexers[-1].accepts_more(statement):
lexer = self.lexers[-1]
else:
lexer = self.lexer_for(statement)
self.lexers.append(lexer)
lexer.input(statement)
- return lexer
- def lexer_for(self, statement):
+ def lexer_for(self, statement: StatementTokens) -> Lexer:
for cls in self.lexer_classes():
lexer = cls(self.ctx)
if lexer.handles(statement):
return lexer
- raise TypeError("%s did not find lexer for statement %s."
- % (type(self).__name__, statement))
+ raise TypeError(
+ f"{type(self).__name__} does not have lexer for statement {statement}."
+ )
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return ()
def lex(self):
for lexer in self.lexers:
lexer.lex()
- def _lex_with_priority(self, priority):
+ def _lex_with_priority(self, priority: "type[Lexer]"):
for lexer in self.lexers:
if isinstance(lexer, priority):
lexer.lex()
@@ -80,199 +81,343 @@ class FileLexer(BlockLexer):
def lex(self):
self._lex_with_priority(priority=SettingSectionLexer)
- def lexer_classes(self):
- return (SettingSectionLexer, VariableSectionLexer,
- TestCaseSectionLexer, KeywordSectionLexer,
- CommentSectionLexer, ErrorSectionLexer,
- ImplicitCommentSectionLexer)
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ SettingSectionLexer,
+ VariableSectionLexer,
+ TestCaseSectionLexer,
+ TaskSectionLexer,
+ KeywordSectionLexer,
+ CommentSectionLexer,
+ InvalidSectionLexer,
+ ImplicitCommentSectionLexer,
+ )
-class SectionLexer(BlockLexer):
+class SectionLexer(BlockLexer, ABC):
+ ctx: FileContext
- def accepts_more(self, statement):
- return not statement[0].value.startswith('*')
+ def accepts_more(self, statement: StatementTokens) -> bool:
+ return not statement[0].value.startswith("*")
class SettingSectionLexer(SectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return self.ctx.setting_section(statement)
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return (SettingSectionHeaderLexer, SettingLexer)
class VariableSectionLexer(SectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return self.ctx.variable_section(statement)
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return (VariableSectionHeaderLexer, VariableLexer)
class TestCaseSectionLexer(SectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return self.ctx.test_case_section(statement)
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return (TestCaseSectionHeaderLexer, TestCaseLexer)
+class TaskSectionLexer(SectionLexer):
+
+ def handles(self, statement: StatementTokens) -> bool:
+ return self.ctx.task_section(statement)
+
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (TaskSectionHeaderLexer, TestCaseLexer)
+
+
class KeywordSectionLexer(SettingSectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return self.ctx.keyword_section(statement)
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return (KeywordSectionHeaderLexer, KeywordLexer)
class CommentSectionLexer(SectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return self.ctx.comment_section(statement)
- def lexer_classes(self):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
return (CommentSectionHeaderLexer, CommentLexer)
class ImplicitCommentSectionLexer(SectionLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return True
- def lexer_classes(self):
- return (CommentLexer,)
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (ImplicitCommentLexer,)
-class ErrorSectionLexer(SectionLexer):
+class InvalidSectionLexer(SectionLexer):
- def handles(self, statement):
- return statement and statement[0].value.startswith('*')
+ def handles(self, statement: StatementTokens) -> bool:
+ return bool(statement and statement[0].value.startswith("*"))
- def lexer_classes(self):
- return (ErrorSectionHeaderLexer, CommentLexer)
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (InvalidSectionHeaderLexer, CommentLexer)
-class TestOrKeywordLexer(BlockLexer):
- name_type = NotImplemented
+class TestOrKeywordLexer(BlockLexer, ABC):
+ name_type: str
_name_seen = False
- def accepts_more(self, statement):
+ def accepts_more(self, statement: StatementTokens) -> bool:
return not statement[0].value
- def input(self, statement):
+ def input(self, statement: StatementTokens):
self._handle_name_or_indentation(statement)
if statement:
super().input(statement)
- def _handle_name_or_indentation(self, statement):
+ def _handle_name_or_indentation(self, statement: StatementTokens):
if not self._name_seen:
- token = statement.pop(0)
- token.type = self.name_type
+ name_token = statement.pop(0)
+ name_token.type = self.name_type
if statement:
- token._add_eos_after = True
+ name_token._add_eos_after = True
self._name_seen = True
else:
while statement and not statement[0].value:
- statement.pop(0).type = None # These tokens will be ignored
-
- def lexer_classes(self):
- return (TestOrKeywordSettingLexer, BreakLexer, ContinueLexer,
- ForLexer, InlineIfLexer, IfLexer, ReturnLexer, TryLexer,
- WhileLexer, KeywordCallLexer)
+ statement.pop(0).type = None # These tokens will be ignored
class TestCaseLexer(TestOrKeywordLexer):
name_type = Token.TESTCASE_NAME
- def __init__(self, ctx):
- """:type ctx: :class:`robot.parsing.lexer.context.TestCaseFileContext`"""
+ def __init__(self, ctx: SuiteFileContext):
super().__init__(ctx.test_case_context())
- def lex(self,):
- self._lex_with_priority(priority=TestOrKeywordSettingLexer)
+ def lex(self):
+ self._lex_with_priority(priority=TestCaseSettingLexer)
+
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ TestCaseSettingLexer,
+ ForLexer,
+ InlineIfLexer,
+ IfLexer,
+ TryLexer,
+ WhileLexer,
+ GroupLexer,
+ VarLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
class KeywordLexer(TestOrKeywordLexer):
name_type = Token.KEYWORD_NAME
- def __init__(self, ctx):
+ def __init__(self, ctx: FileContext):
super().__init__(ctx.keyword_context())
-
-class NestedBlockLexer(BlockLexer):
-
- def __init__(self, ctx):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ KeywordSettingLexer,
+ ForLexer,
+ InlineIfLexer,
+ IfLexer,
+ TryLexer,
+ WhileLexer,
+ GroupLexer,
+ VarLexer,
+ ReturnLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
+
+
+class NestedBlockLexer(BlockLexer, ABC):
+ ctx: "TestCaseContext|KeywordContext"
+
+ def __init__(self, ctx: "TestCaseContext|KeywordContext"):
super().__init__(ctx)
self._block_level = 0
- def accepts_more(self, statement):
+ def accepts_more(self, statement: StatementTokens) -> bool:
return self._block_level > 0
- def input(self, statement):
- lexer = super().input(statement)
- if isinstance(lexer, (ForHeaderLexer, IfHeaderLexer, TryHeaderLexer,
- WhileHeaderLexer)):
+ def input(self, statement: StatementTokens):
+ super().input(statement)
+ lexer = self.lexers[-1]
+ block_lexers = (
+ ForHeaderLexer,
+ IfHeaderLexer,
+ TryHeaderLexer,
+ WhileHeaderLexer,
+ GroupHeaderLexer,
+ )
+ if isinstance(lexer, block_lexers):
self._block_level += 1
- if isinstance(lexer, EndLexer):
+ elif isinstance(lexer, EndLexer):
self._block_level -= 1
class ForLexer(NestedBlockLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return ForHeaderLexer(self.ctx).handles(statement)
- def lexer_classes(self):
- return (ForHeaderLexer, InlineIfLexer, IfLexer, TryLexer, WhileLexer, EndLexer,
- ReturnLexer, ContinueLexer, BreakLexer, KeywordCallLexer)
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ ForHeaderLexer,
+ InlineIfLexer,
+ IfLexer,
+ TryLexer,
+ WhileLexer,
+ EndLexer,
+ GroupLexer,
+ VarLexer,
+ ReturnLexer,
+ ContinueLexer,
+ BreakLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
class WhileLexer(NestedBlockLexer):
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return WhileHeaderLexer(self.ctx).handles(statement)
- def lexer_classes(self):
- return (WhileHeaderLexer, ForLexer, InlineIfLexer, IfLexer, TryLexer, EndLexer,
- ReturnLexer, ContinueLexer, BreakLexer, KeywordCallLexer)
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ WhileHeaderLexer,
+ ForLexer,
+ InlineIfLexer,
+ IfLexer,
+ TryLexer,
+ EndLexer,
+ GroupLexer,
+ VarLexer,
+ ReturnLexer,
+ ContinueLexer,
+ BreakLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
-class IfLexer(NestedBlockLexer):
+class TryLexer(NestedBlockLexer):
- def handles(self, statement):
- return IfHeaderLexer(self.ctx).handles(statement)
+ def handles(self, statement: StatementTokens) -> bool:
+ return TryHeaderLexer(self.ctx).handles(statement)
+
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ TryHeaderLexer,
+ ExceptHeaderLexer,
+ ElseHeaderLexer,
+ FinallyHeaderLexer,
+ ForLexer,
+ InlineIfLexer,
+ IfLexer,
+ WhileLexer,
+ EndLexer,
+ VarLexer,
+ GroupLexer,
+ ReturnLexer,
+ BreakLexer,
+ ContinueLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
+
+
+class GroupLexer(NestedBlockLexer):
+
+ def handles(self, statement: StatementTokens) -> bool:
+ return GroupHeaderLexer(self.ctx).handles(statement)
+
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ GroupHeaderLexer,
+ InlineIfLexer,
+ IfLexer,
+ ForLexer,
+ TryLexer,
+ WhileLexer,
+ EndLexer,
+ VarLexer,
+ ReturnLexer,
+ ContinueLexer,
+ BreakLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
- def lexer_classes(self):
- return (InlineIfLexer, IfHeaderLexer, ElseIfHeaderLexer, ElseHeaderLexer,
- ForLexer, TryLexer, WhileLexer, EndLexer, ReturnLexer, ContinueLexer,
- BreakLexer, KeywordCallLexer)
+class IfLexer(NestedBlockLexer):
-class InlineIfLexer(BlockLexer):
+ def handles(self, statement: StatementTokens) -> bool:
+ return IfHeaderLexer(self.ctx).handles(statement)
- def handles(self, statement):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ InlineIfLexer,
+ IfHeaderLexer,
+ ElseIfHeaderLexer,
+ ElseHeaderLexer,
+ ForLexer,
+ TryLexer,
+ WhileLexer,
+ EndLexer,
+ VarLexer,
+ GroupLexer,
+ ReturnLexer,
+ ContinueLexer,
+ BreakLexer,
+ SyntaxErrorLexer,
+ KeywordCallLexer,
+ )
+
+
+class InlineIfLexer(NestedBlockLexer):
+
+ def handles(self, statement: StatementTokens) -> bool:
if len(statement) <= 2:
return False
return InlineIfHeaderLexer(self.ctx).handles(statement)
- def accepts_more(self, statement):
+ def accepts_more(self, statement: StatementTokens) -> bool:
return False
- def lexer_classes(self):
- return (InlineIfHeaderLexer, ElseIfHeaderLexer, ElseHeaderLexer,
- ReturnLexer, ContinueLexer, BreakLexer, KeywordCallLexer)
-
- def input(self, statement):
+ def lexer_classes(self) -> "tuple[type[Lexer], ...]":
+ return (
+ InlineIfHeaderLexer,
+ ElseIfHeaderLexer,
+ ElseHeaderLexer,
+ VarLexer,
+ GroupLexer,
+ ReturnLexer,
+ ContinueLexer,
+ BreakLexer,
+ KeywordCallLexer,
+ )
+
+ def input(self, statement: StatementTokens):
for part in self._split(statement):
if part:
super().input(part)
- return self
- def _split(self, statement):
+ def _split(self, statement: StatementTokens) -> "Iterator[StatementTokens]":
current = []
expect_condition = False
for token in statement:
@@ -283,15 +428,15 @@ def _split(self, statement):
yield current
current = []
expect_condition = False
- elif token.value == 'IF':
+ elif token.value == "IF":
current.append(token)
expect_condition = True
- elif normalize_whitespace(token.value) == 'ELSE IF':
+ elif normalize_whitespace(token.value) == "ELSE IF":
token._add_eos_before = True
yield current
current = [token]
expect_condition = True
- elif token.value == 'ELSE':
+ elif token.value == "ELSE":
token._add_eos_before = True
if token is not statement[-1]:
token._add_eos_after = True
@@ -301,14 +446,3 @@ def _split(self, statement):
else:
current.append(token)
yield current
-
-
-class TryLexer(NestedBlockLexer):
-
- def handles(self, statement):
- return TryHeaderLexer(self.ctx).handles(statement)
-
- def lexer_classes(self):
- return (TryHeaderLexer, ExceptHeaderLexer, ElseHeaderLexer, FinallyHeaderLexer,
- ForLexer, InlineIfLexer, IfLexer, WhileLexer, EndLexer, ReturnLexer,
- BreakLexer, ContinueLexer, KeywordCallLexer)
diff --git a/src/robot/parsing/lexer/context.py b/src/robot/parsing/lexer/context.py
index fc37a8c7c91..acf441a6d4d 100644
--- a/src/robot/parsing/lexer/context.py
+++ b/src/robot/parsing/lexer/context.py
@@ -13,78 +13,150 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .sections import (InitFileSections, TestCaseFileSections,
- ResourceFileSections)
-from .settings import (InitFileSettings, TestCaseFileSettings,
- ResourceFileSettings, TestCaseSettings, KeywordSettings)
+from robot.conf import LanguageLike, Languages, LanguagesLike
+from robot.utils import normalize_whitespace
+
+from .settings import (
+ FileSettings, InitFileSettings, KeywordSettings, ResourceFileSettings, Settings,
+ SuiteFileSettings, TestCaseSettings
+)
+from .tokens import StatementTokens, Token
class LexingContext:
- settings_class = None
- def __init__(self, settings=None):
- self.settings = settings or self.settings_class()
+ def __init__(self, settings: Settings, languages: Languages):
+ self.settings = settings
+ self.languages = languages
- def lex_setting(self, statement):
+ def lex_setting(self, statement: StatementTokens):
self.settings.lex(statement)
class FileContext(LexingContext):
- sections_class = None
+ settings: FileSettings
+
+ def __init__(self, lang: LanguagesLike = None):
+ languages = lang if isinstance(lang, Languages) else Languages(lang)
+ settings_class: "type[FileSettings]" = type(self).__annotations__["settings"]
+ settings = settings_class(languages)
+ super().__init__(settings, languages)
+
+ def add_language(self, lang: LanguageLike):
+ self.languages.add_language(lang)
- def __init__(self, settings=None):
- LexingContext.__init__(self, settings)
- self.sections = self.sections_class()
+ def keyword_context(self) -> "KeywordContext":
+ return KeywordContext(KeywordSettings(self.settings))
- def setting_section(self, statement):
- return self.sections.setting(statement)
+ def setting_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Settings")
+
+ def variable_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Variables")
+
+ def test_case_section(self, statement: StatementTokens) -> bool:
+ return False
- def variable_section(self, statement):
- return self.sections.variable(statement)
+ def task_section(self, statement: StatementTokens) -> bool:
+ return False
- def test_case_section(self, statement):
- return self.sections.test_case(statement)
+ def keyword_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Keywords")
+
+ def comment_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Comments")
+
+ def lex_invalid_section(self, statement: StatementTokens):
+ header = statement[0]
+ header.type = Token.INVALID_HEADER
+ header.error = self._get_invalid_section_error(header.value)
+ for token in statement[1:]:
+ token.type = Token.COMMENT
+
+ def _get_invalid_section_error(self, header: str) -> str:
+ raise NotImplementedError
+
+ def _handles_section(self, statement: StatementTokens, header: str) -> bool:
+ marker = statement[0].value
+ if not marker or marker[0] != "*":
+ return False
+ normalized = self._normalize(marker)
+ if self.languages.headers.get(normalized) == header:
+ return True
+ if normalized == header[:-1]:
+ statement[0].error = (
+ f"Singular section headers like '{marker}' are deprecated. "
+ f"Use plural format like '*** {header} ***' instead."
+ )
+ return True
+ return False
- def keyword_section(self, statement):
- return self.sections.keyword(statement)
+ def _normalize(self, marker: str) -> str:
+ return normalize_whitespace(marker).strip("* ").title()
- def comment_section(self, statement):
- return self.sections.comment(statement)
- def keyword_context(self):
- return KeywordContext(settings=KeywordSettings())
+class SuiteFileContext(FileContext):
+ settings: SuiteFileSettings
- def lex_invalid_section(self, statement):
- self.sections.lex_invalid(statement)
+ def test_case_context(self) -> "TestCaseContext":
+ return TestCaseContext(TestCaseSettings(self.settings))
+ def test_case_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Test Cases")
-class TestCaseFileContext(FileContext):
- sections_class = TestCaseFileSections
- settings_class = TestCaseFileSettings
+ def task_section(self, statement: StatementTokens) -> bool:
+ return self._handles_section(statement, "Tasks")
- def test_case_context(self):
- return TestCaseContext(settings=TestCaseSettings(self.settings))
+ def _get_invalid_section_error(self, header: str) -> str:
+ return (
+ f"Unrecognized section header '{header}'. Valid sections: 'Settings', "
+ f"'Variables', 'Test Cases', 'Tasks', 'Keywords' and 'Comments'."
+ )
class ResourceFileContext(FileContext):
- sections_class = ResourceFileSections
- settings_class = ResourceFileSettings
+ settings: ResourceFileSettings
+
+ def _get_invalid_section_error(self, header: str) -> str:
+ name = self._normalize(header)
+ if self.languages.headers.get(name) in ("Test Cases", "Tasks"):
+ return f"Resource file with '{name}' section is invalid."
+ return (
+ f"Unrecognized section header '{header}'. Valid sections: "
+ f"'Settings', 'Variables', 'Keywords' and 'Comments'."
+ )
class InitFileContext(FileContext):
- sections_class = InitFileSections
- settings_class = InitFileSettings
+ settings: InitFileSettings
+
+ def _get_invalid_section_error(self, header: str) -> str:
+ name = self._normalize(header)
+ if self.languages.headers.get(name) in ("Test Cases", "Tasks"):
+ return f"'{name}' section is not allowed in suite initialization file."
+ return (
+ f"Unrecognized section header '{header}'. Valid sections: "
+ f"'Settings', 'Variables', 'Keywords' and 'Comments'."
+ )
class TestCaseContext(LexingContext):
+ settings: TestCaseSettings
+
+ def __init__(self, settings: TestCaseSettings):
+ super().__init__(settings, settings.languages)
@property
- def template_set(self):
+ def template_set(self) -> bool:
return self.settings.template_set
class KeywordContext(LexingContext):
+ settings: KeywordSettings
+
+ def __init__(self, settings: KeywordSettings):
+ super().__init__(settings, settings.languages)
@property
- def template_set(self):
+ def template_set(self) -> bool:
return False
diff --git a/src/robot/parsing/lexer/lexer.py b/src/robot/parsing/lexer/lexer.py
index 5f3717cf3b3..ee03b4a943b 100644
--- a/src/robot/parsing/lexer/lexer.py
+++ b/src/robot/parsing/lexer/lexer.py
@@ -13,18 +13,27 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from collections.abc import Iterable, Iterator
from itertools import chain
+from robot.conf import LanguagesLike
from robot.errors import DataError
-from robot.utils import get_error_message, FileReader
+from robot.utils import FileReader, get_error_message, Source
from .blocklexers import FileLexer
-from .context import InitFileContext, TestCaseFileContext, ResourceFileContext
+from .context import (
+ InitFileContext, LexingContext, ResourceFileContext, SuiteFileContext
+)
from .tokenizer import Tokenizer
-from .tokens import EOS, END, Token
+from .tokens import END, EOS, Token
-def get_tokens(source, data_only=False, tokenize_variables=False):
+def get_tokens(
+ source: Source,
+ data_only: bool = False,
+ tokenize_variables: bool = False,
+ lang: LanguagesLike = None,
+) -> "Iterator[Token]":
"""Parses the given source to tokens.
:param source: The source where to read the data. Can be a path to
@@ -38,49 +47,68 @@ def get_tokens(source, data_only=False, tokenize_variables=False):
arguments and elsewhere are tokenized. See the
:meth:`~robot.parsing.lexer.tokens.Token.tokenize_variables`
method for details.
+ :param lang: Additional languages to be supported during parsing.
+ Can be a string matching any of the supported language codes or names,
+ an initialized :class:`~robot.conf.languages.Language` subclass,
+ a list containing such strings or instances, or a
+ :class:`~robot.conf.languages.Languages` instance.
Returns a generator that yields :class:`~robot.parsing.lexer.tokens.Token`
instances.
"""
- lexer = Lexer(TestCaseFileContext(), data_only, tokenize_variables)
+ lexer = Lexer(SuiteFileContext(lang=lang), data_only, tokenize_variables)
lexer.input(source)
return lexer.get_tokens()
-def get_resource_tokens(source, data_only=False, tokenize_variables=False):
+def get_resource_tokens(
+ source: Source,
+ data_only: bool = False,
+ tokenize_variables: bool = False,
+ lang: LanguagesLike = None,
+) -> "Iterator[Token]":
"""Parses the given source to resource file tokens.
- Otherwise same as :func:`get_tokens` but the source is considered to be
+ Same as :func:`get_tokens` otherwise, but the source is considered to be
a resource file. This affects, for example, what settings are valid.
"""
- lexer = Lexer(ResourceFileContext(), data_only, tokenize_variables)
+ lexer = Lexer(ResourceFileContext(lang=lang), data_only, tokenize_variables)
lexer.input(source)
return lexer.get_tokens()
-def get_init_tokens(source, data_only=False, tokenize_variables=False):
+def get_init_tokens(
+ source: Source,
+ data_only: bool = False,
+ tokenize_variables: bool = False,
+ lang: LanguagesLike = None,
+) -> "Iterator[Token]":
"""Parses the given source to init file tokens.
- Otherwise same as :func:`get_tokens` but the source is considered to be
+ Same as :func:`get_tokens` otherwise, but the source is considered to be
a suite initialization file. This affects, for example, what settings are
valid.
"""
- lexer = Lexer(InitFileContext(), data_only, tokenize_variables)
+ lexer = Lexer(InitFileContext(lang=lang), data_only, tokenize_variables)
lexer.input(source)
return lexer.get_tokens()
class Lexer:
- def __init__(self, ctx, data_only=False, tokenize_variables=False):
+ def __init__(
+ self,
+ ctx: LexingContext,
+ data_only: bool = False,
+ tokenize_variables: bool = False,
+ ):
self.lexer = FileLexer(ctx)
self.data_only = data_only
self.tokenize_variables = tokenize_variables
- self.statements = []
+ self.statements: "list[list[Token]]" = []
- def input(self, source):
- for statement in Tokenizer().tokenize(self._read(source),
- self.data_only):
+ def input(self, source: Source):
+ for statement in Tokenizer().tokenize(self._read(source), self.data_only):
# Store all tokens but pass only data tokens to lexer.
self.statements.append(statement)
if self.data_only:
@@ -91,29 +119,30 @@ def input(self, source):
if data:
self.lexer.input(data)
- def _read(self, source):
+ def _read(self, source: Source) -> str:
try:
with FileReader(source, accept_text=True) as reader:
return reader.read()
- except:
+ except Exception:
raise DataError(get_error_message())
- def get_tokens(self):
+ def get_tokens(self) -> "Iterator[Token]":
self.lexer.lex()
- statements = self.statements
- if not self.data_only:
+ if self.data_only:
+ statements = self.statements
+ else:
statements = chain.from_iterable(
- self._split_trailing_commented_and_empty_lines(s)
- for s in statements
+ self._split_trailing_commented_and_empty_lines(stmt)
+ for stmt in self.statements
)
tokens = self._get_tokens(statements)
if self.tokenize_variables:
tokens = self._tokenize_variables(tokens)
return tokens
- def _get_tokens(self, statements):
+ def _get_tokens(self, statements: "Iterable[list[Token]]") -> "Iterator[Token]":
if self.data_only:
- ignored_types = {None, Token.COMMENT_HEADER, Token.COMMENT}
+ ignored_types = {None, Token.COMMENT}
else:
ignored_types = {None}
inline_if_type = Token.INLINE_IF
@@ -132,13 +161,17 @@ def _get_tokens(self, statements):
if token_type == inline_if_type:
inline_if = True
last = token
- if last and not last._add_eos_after:
- yield EOS.from_token(last)
- if inline_if:
- yield END.from_token(last, virtual=True)
- yield EOS.from_token(last)
-
- def _split_trailing_commented_and_empty_lines(self, statement):
+ if last:
+ if not last._add_eos_after:
+ yield EOS.from_token(last)
+ if inline_if:
+ yield END.from_token(last, virtual=True)
+ yield EOS.from_token(last)
+
+ def _split_trailing_commented_and_empty_lines(
+ self,
+ statement: "list[Token]",
+ ) -> "list[list[Token]]":
lines = self._split_to_lines(statement)
commented_or_empty = []
for line in reversed(lines):
@@ -147,11 +180,11 @@ def _split_trailing_commented_and_empty_lines(self, statement):
commented_or_empty.append(line)
if not commented_or_empty:
return [statement]
- lines = lines[:-len(commented_or_empty)]
+ lines = lines[: -len(commented_or_empty)]
statement = list(chain.from_iterable(lines))
- return [statement] + list(reversed(commented_or_empty))
+ return [statement, *reversed(commented_or_empty)]
- def _split_to_lines(self, statement):
+ def _split_to_lines(self, statement: "list[Token]") -> "list[list[Token]]":
lines = []
current = []
for token in statement:
@@ -163,7 +196,7 @@ def _split_to_lines(self, statement):
lines.append(current)
return lines
- def _is_commented_or_empty(self, line):
+ def _is_commented_or_empty(self, line: "list[Token]") -> bool:
separator_or_ignore = (Token.SEPARATOR, None)
comment_or_eol = (Token.COMMENT, Token.EOL)
for token in line:
@@ -171,7 +204,6 @@ def _is_commented_or_empty(self, line):
return token.type in comment_or_eol
return False
- def _tokenize_variables(self, tokens):
+ def _tokenize_variables(self, tokens: "Iterator[Token]") -> "Iterator[Token]":
for token in tokens:
- for t in token.tokenize_variables():
- yield t
+ yield from token.tokenize_variables()
diff --git a/src/robot/parsing/lexer/sections.py b/src/robot/parsing/lexer/sections.py
deleted file mode 100644
index 6b946f04eec..00000000000
--- a/src/robot/parsing/lexer/sections.py
+++ /dev/null
@@ -1,97 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from robot.utils import normalize_whitespace
-
-from .tokens import Token
-
-
-class Sections:
- setting_markers = ('Settings', 'Setting')
- variable_markers = ('Variables', 'Variable')
- test_case_markers = ('Test Cases', 'Test Case', 'Tasks', 'Task')
- keyword_markers = ('Keywords', 'Keyword')
- comment_markers = ('Comments', 'Comment')
-
- def setting(self, statement):
- return self._handles(statement, self.setting_markers)
-
- def variable(self, statement):
- return self._handles(statement, self.variable_markers)
-
- def test_case(self, statement):
- return False
-
- def keyword(self, statement):
- return self._handles(statement, self.keyword_markers)
-
- def comment(self, statement):
- return self._handles(statement, self.comment_markers)
-
- def _handles(self, statement, markers):
- marker = statement[0].value
- return marker.startswith('*') and self._normalize(marker) in markers
-
- def _normalize(self, marker):
- return normalize_whitespace(marker).strip('* ').title()
-
- def lex_invalid(self, statement):
- message, fatal = self._get_invalid_section_error(statement[0].value)
- statement[0].set_error(message, fatal)
- for token in statement[1:]:
- token.type = Token.COMMENT
-
- def _get_invalid_section_error(self, header):
- raise NotImplementedError
-
-
-class TestCaseFileSections(Sections):
-
- def test_case(self, statement):
- return self._handles(statement, self.test_case_markers)
-
- def _get_invalid_section_error(self, header):
- return ("Unrecognized section header '%s'. Valid sections: "
- "'Settings', 'Variables', 'Test Cases', 'Tasks', "
- "'Keywords' and 'Comments'." % header), False
-
-
-class ResourceFileSections(Sections):
-
- def _get_invalid_section_error(self, header):
- name = self._normalize(header)
- if name in self.test_case_markers:
- message = "Resource file with '%s' section is invalid." % name
- fatal = True
- else:
- message = ("Unrecognized section header '%s'. Valid sections: "
- "'Settings', 'Variables', 'Keywords' and 'Comments'."
- % header)
- fatal = False
- return message, fatal
-
-
-class InitFileSections(Sections):
-
- def _get_invalid_section_error(self, header):
- name = self._normalize(header)
- if name in self.test_case_markers:
- message = ("'%s' section is not allowed in suite initialization "
- "file." % name)
- else:
- message = ("Unrecognized section header '%s'. Valid sections: "
- "'Settings', 'Variables', 'Keywords' and 'Comments'."
- % header)
- return message, False
diff --git a/src/robot/parsing/lexer/settings.py b/src/robot/parsing/lexer/settings.py
index 4008a535b88..3660c98e1e4 100644
--- a/src/robot/parsing/lexer/settings.py
+++ b/src/robot/parsing/lexer/settings.py
@@ -13,214 +13,274 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC, abstractmethod
+
+from robot.conf import Languages
from robot.utils import normalize, normalize_whitespace, RecommendationFinder
-from .tokens import Token
+from .tokens import StatementTokens, Token
-class Settings:
- names = ()
- aliases = {}
+class Settings(ABC):
+ names: "tuple[str, ...]" = ()
+ aliases: "dict[str, str]" = {}
multi_use = (
- 'Metadata',
- 'Library',
- 'Resource',
- 'Variables'
+ "Metadata",
+ "Library",
+ "Resource",
+ "Variables",
)
single_value = (
- 'Resource',
- 'Test Timeout',
- 'Test Template',
- 'Timeout',
- 'Template'
+ "Resource",
+ "Test Timeout",
+ "Test Template",
+ "Timeout",
+ "Template",
+ "Name",
)
name_and_arguments = (
- 'Metadata',
- 'Suite Setup',
- 'Suite Teardown',
- 'Test Setup',
- 'Test Teardown',
- 'Test Template',
- 'Setup',
- 'Teardown',
- 'Template',
- 'Resource',
- 'Variables'
+ "Metadata",
+ "Suite Setup",
+ "Suite Teardown",
+ "Test Setup",
+ "Test Teardown",
+ "Test Template",
+ "Setup",
+ "Teardown",
+ "Template",
+ "Resource",
+ "Variables",
)
name_arguments_and_with_name = (
- 'Library',
- )
+ "Library",
+ ) # fmt: skip
- def __init__(self):
- self.settings = {n: None for n in self.names}
+ def __init__(self, languages: Languages):
+ self.settings: "dict[str, list[Token]|None]" = dict.fromkeys(self.names)
+ self.languages = languages
- def lex(self, statement):
- setting = statement[0]
- name = self._format_name(setting.value)
- normalized = self._normalize_name(name)
+ def lex(self, statement: StatementTokens):
+ orig = self._format_name(statement[0].value)
+ name = normalize_whitespace(orig).title()
+ name = self.languages.settings.get(name, name)
+ if name in self.aliases:
+ name = self.aliases[name]
try:
- self._validate(name, normalized, statement)
+ self._validate(orig, name, statement)
except ValueError as err:
- self._lex_error(setting, statement[1:], err.args[0])
+ self._lex_error(statement, err.args[0])
else:
- self._lex_setting(setting, statement[1:], normalized)
+ self._lex_setting(statement, name)
- def _format_name(self, name):
- return name
-
- def _normalize_name(self, name):
- name = normalize_whitespace(name).title()
- if name in self.aliases:
- return self.aliases[name]
+ def _format_name(self, name: str) -> str:
return name
- def _validate(self, name, normalized, statement):
- if normalized not in self.settings:
- message = self._get_non_existing_setting_message(name, normalized)
+ def _validate(self, orig: str, name: str, statement: StatementTokens):
+ if name not in self.settings:
+ message = self._get_non_existing_setting_message(orig, name)
raise ValueError(message)
- if self.settings[normalized] is not None and normalized not in self.multi_use:
- raise ValueError("Setting '%s' is allowed only once. "
- "Only the first value is used." % name)
- if normalized in self.single_value and len(statement) > 2:
- raise ValueError("Setting '%s' accepts only one value, got %s."
- % (name, len(statement) - 1))
-
- def _get_non_existing_setting_message(self, name, normalized):
- if normalized in TestCaseFileSettings.names:
- is_resource = isinstance(self, ResourceFileSettings)
- return "Setting '%s' is not allowed in %s file." % (
- name, 'resource' if is_resource else 'suite initialization'
+ if self.settings[name] is not None and name not in self.multi_use:
+ raise ValueError(
+ f"Setting '{orig}' is allowed only once. Only the first value is used."
)
+ if name in self.single_value and len(statement) > 2:
+ raise ValueError(
+ f"Setting '{orig}' accepts only one value, got {len(statement) - 1}."
+ )
+
+ def _get_non_existing_setting_message(self, name: str, normalized: str) -> str:
+ if self._is_valid_somewhere(normalized, Settings.__subclasses__()):
+ return self._not_valid_here(name)
return RecommendationFinder(normalize).find_and_format(
name=normalized,
candidates=tuple(self.settings) + tuple(self.aliases),
- message="Non-existing setting '%s'." % name
+ message=f"Non-existing setting '{name}'.",
)
- def _lex_error(self, setting, values, error):
- setting.set_error(error)
- for token in values:
+ def _is_valid_somewhere(self, name: str, classes: "list[type[Settings]]") -> bool:
+ for cls in classes:
+ if (
+ name in cls.names
+ or name in cls.aliases
+ or self._is_valid_somewhere(name, cls.__subclasses__())
+ ):
+ return True
+ return False
+
+ @abstractmethod
+ def _not_valid_here(self, name: str) -> str:
+ raise NotImplementedError
+
+ def _lex_error(self, statement: StatementTokens, error: str):
+ statement[0].set_error(error)
+ for token in statement[1:]:
token.type = Token.COMMENT
- def _lex_setting(self, setting, values, name):
- self.settings[name] = values
- setting.type = name.upper()
+ def _lex_setting(self, statement: StatementTokens, name: str):
+ statement[0].type = {
+ "Test Tags": Token.TEST_TAGS,
+ "Name": Token.SUITE_NAME,
+ }.get(name, name.upper())
+ self.settings[name] = values = statement[1:]
if name in self.name_and_arguments:
self._lex_name_and_arguments(values)
elif name in self.name_arguments_and_with_name:
self._lex_name_arguments_and_with_name(values)
else:
self._lex_arguments(values)
+ if name == "Return":
+ statement[0].error = (
+ "The '[Return]' setting is deprecated. "
+ "Use the 'RETURN' statement instead."
+ )
- def _lex_name_and_arguments(self, tokens):
+ def _lex_name_and_arguments(self, tokens: StatementTokens):
if tokens:
tokens[0].type = Token.NAME
- self._lex_arguments(tokens[1:])
+ self._lex_arguments(tokens[1:])
- def _lex_name_arguments_and_with_name(self, tokens):
+ def _lex_name_arguments_and_with_name(self, tokens: StatementTokens):
self._lex_name_and_arguments(tokens)
- if len(tokens) > 1 and \
- normalize_whitespace(tokens[-2].value) == 'WITH NAME':
- tokens[-2].type = Token.WITH_NAME
+ marker = tokens[-2].value if len(tokens) > 1 else None
+ if marker and normalize_whitespace(marker) in ("WITH NAME", "AS"):
+ tokens[-2].type = Token.AS
tokens[-1].type = Token.NAME
- def _lex_arguments(self, tokens):
+ def _lex_arguments(self, tokens: StatementTokens):
for token in tokens:
token.type = Token.ARGUMENT
-class TestCaseFileSettings(Settings):
+class FileSettings(Settings, ABC):
+ pass
+
+
+class SuiteFileSettings(FileSettings):
names = (
- 'Documentation',
- 'Metadata',
- 'Suite Setup',
- 'Suite Teardown',
- 'Test Setup',
- 'Test Teardown',
- 'Test Template',
- 'Test Timeout',
- 'Force Tags',
- 'Default Tags',
- 'Library',
- 'Resource',
- 'Variables'
+ "Documentation",
+ "Metadata",
+ "Name",
+ "Suite Setup",
+ "Suite Teardown",
+ "Test Setup",
+ "Test Teardown",
+ "Test Template",
+ "Test Timeout",
+ "Test Tags",
+ "Default Tags",
+ "Keyword Tags",
+ "Library",
+ "Resource",
+ "Variables",
)
aliases = {
- 'Task Setup': 'Test Setup',
- 'Task Teardown': 'Test Teardown',
- 'Task Template': 'Test Template',
- 'Task Timeout': 'Test Timeout',
+ "Force Tags": "Test Tags",
+ "Task Tags": "Test Tags",
+ "Task Setup": "Test Setup",
+ "Task Teardown": "Test Teardown",
+ "Task Template": "Test Template",
+ "Task Timeout": "Test Timeout",
}
+ def _not_valid_here(self, name: str) -> str:
+ return f"Setting '{name}' is not allowed in suite file."
+
-class InitFileSettings(Settings):
+class InitFileSettings(FileSettings):
names = (
- 'Documentation',
- 'Metadata',
- 'Suite Setup',
- 'Suite Teardown',
- 'Test Setup',
- 'Test Teardown',
- 'Test Timeout',
- 'Force Tags',
- 'Library',
- 'Resource',
- 'Variables'
+ "Documentation",
+ "Metadata",
+ "Name",
+ "Suite Setup",
+ "Suite Teardown",
+ "Test Setup",
+ "Test Teardown",
+ "Test Timeout",
+ "Test Tags",
+ "Keyword Tags",
+ "Library",
+ "Resource",
+ "Variables",
)
+ aliases = {
+ "Force Tags": "Test Tags",
+ "Task Tags": "Test Tags",
+ "Task Setup": "Test Setup",
+ "Task Teardown": "Test Teardown",
+ "Task Timeout": "Test Timeout",
+ }
+
+ def _not_valid_here(self, name: str) -> str:
+ return f"Setting '{name}' is not allowed in suite initialization file."
-class ResourceFileSettings(Settings):
+class ResourceFileSettings(FileSettings):
names = (
- 'Documentation',
- 'Library',
- 'Resource',
- 'Variables'
+ "Documentation",
+ "Keyword Tags",
+ "Library",
+ "Resource",
+ "Variables",
)
+ def _not_valid_here(self, name: str) -> str:
+ return f"Setting '{name}' is not allowed in resource file."
+
class TestCaseSettings(Settings):
names = (
- 'Documentation',
- 'Tags',
- 'Setup',
- 'Teardown',
- 'Template',
- 'Timeout'
+ "Documentation",
+ "Tags",
+ "Setup",
+ "Teardown",
+ "Template",
+ "Timeout",
)
- def __init__(self, parent):
- Settings.__init__(self)
+ def __init__(self, parent: SuiteFileSettings):
+ super().__init__(parent.languages)
self.parent = parent
- def _format_name(self, name):
+ def _format_name(self, name: str) -> str:
return name[1:-1].strip()
@property
- def template_set(self):
- template = self.settings['Template']
+ def template_set(self) -> bool:
+ template = self.settings["Template"]
if self._has_disabling_value(template):
return False
- parent_template = self.parent.settings['Test Template']
+ parent_template = self.parent.settings["Test Template"]
return self._has_value(template) or self._has_value(parent_template)
- def _has_disabling_value(self, setting):
+ def _has_disabling_value(self, setting: "StatementTokens|None") -> bool:
if setting is None:
return False
- return setting == [] or setting[0].value.upper() == 'NONE'
+ return setting == [] or setting[0].value.upper() == "NONE"
+
+ def _has_value(self, setting: "StatementTokens|None") -> bool:
+ return bool(setting and setting[0].value)
- def _has_value(self, setting):
- return setting and setting[0].value
+ def _not_valid_here(self, name: str) -> str:
+ return f"Setting '{name}' is not allowed with tests or tasks."
class KeywordSettings(Settings):
names = (
- 'Documentation',
- 'Arguments',
- 'Teardown',
- 'Timeout',
- 'Tags',
- 'Return'
+ "Documentation",
+ "Arguments",
+ "Setup",
+ "Teardown",
+ "Timeout",
+ "Tags",
+ "Return",
)
- def _format_name(self, name):
+ def __init__(self, parent: FileSettings):
+ super().__init__(parent.languages)
+ self.parent = parent
+
+ def _format_name(self, name: str) -> str:
return name[1:-1].strip()
+
+ def _not_valid_here(self, name: str) -> str:
+ return f"Setting '{name}' is not allowed with user keywords."
diff --git a/src/robot/parsing/lexer/statementlexers.py b/src/robot/parsing/lexer/statementlexers.py
index 4f81ef15525..dbeace503fb 100644
--- a/src/robot/parsing/lexer/statementlexers.py
+++ b/src/robot/parsing/lexer/statementlexers.py
@@ -13,56 +13,74 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC, abstractmethod
+
+from robot.errors import DataError
from robot.utils import normalize_whitespace
from robot.variables import is_assign
-from .tokens import Token
+from .context import FileContext, KeywordContext, LexingContext, TestCaseContext
+from .tokens import StatementTokens, Token
-class Lexer:
- """Base class for lexers."""
+class Lexer(ABC):
- def __init__(self, ctx):
+ def __init__(self, ctx: LexingContext):
self.ctx = ctx
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
return True
- def accepts_more(self, statement):
+ @abstractmethod
+ def accepts_more(self, statement: StatementTokens) -> bool:
raise NotImplementedError
- def input(self, statement):
+ @abstractmethod
+ def input(self, statement: StatementTokens):
raise NotImplementedError
+ @abstractmethod
def lex(self):
raise NotImplementedError
-class StatementLexer(Lexer):
- token_type = None
+class StatementLexer(Lexer, ABC):
+ token_type: str
- def __init__(self, ctx):
+ def __init__(self, ctx: LexingContext):
super().__init__(ctx)
- self.statement = None
+ self.statement: StatementTokens = []
- def accepts_more(self, statement):
+ def accepts_more(self, statement: StatementTokens) -> bool:
return False
- def input(self, statement):
+ def input(self, statement: StatementTokens):
self.statement = statement
+ @abstractmethod
def lex(self):
raise NotImplementedError
+ def _lex_options(self, *names: str, end_index: "int|None" = None):
+ seen = set()
+ for token in reversed(self.statement[:end_index]):
+ if "=" in token.value:
+ name = token.value.split("=")[0]
+ if name in names and name not in seen:
+ token.type = Token.OPTION
+ seen.add(name)
+ continue
+ break
+
-class SingleType(StatementLexer):
+class SingleType(StatementLexer, ABC):
def lex(self):
for token in self.statement:
token.type = self.token_type
-class TypeAndArguments(StatementLexer):
+class TypeAndArguments(StatementLexer, ABC):
def lex(self):
self.statement[0].type = self.token_type
@@ -70,10 +88,11 @@ def lex(self):
token.type = Token.ARGUMENT
-class SectionHeaderLexer(SingleType):
+class SectionHeaderLexer(SingleType, ABC):
+ ctx: FileContext
- def handles(self, statement):
- return statement[0].value.startswith('*')
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value.startswith("*")
class SettingSectionHeaderLexer(SectionHeaderLexer):
@@ -88,6 +107,10 @@ class TestCaseSectionHeaderLexer(SectionHeaderLexer):
token_type = Token.TESTCASE_HEADER
+class TaskSectionHeaderLexer(SectionHeaderLexer):
+ token_type = Token.TASK_HEADER
+
+
class KeywordSectionHeaderLexer(SectionHeaderLexer):
token_type = Token.KEYWORD_HEADER
@@ -96,7 +119,8 @@ class CommentSectionHeaderLexer(SectionHeaderLexer):
token_type = Token.COMMENT_HEADER
-class ErrorSectionHeaderLexer(SectionHeaderLexer):
+class InvalidSectionHeaderLexer(SectionHeaderLexer):
+ token_type = Token.INVALID_HEADER
def lex(self):
self.ctx.lex_invalid_section(self.statement)
@@ -106,24 +130,73 @@ class CommentLexer(SingleType):
token_type = Token.COMMENT
+class ImplicitCommentLexer(CommentLexer):
+ ctx: FileContext
+
+ def input(self, statement: StatementTokens):
+ super().input(statement)
+ if statement[0].value.lower().startswith("language:"):
+ value = " ".join(token.value for token in statement)
+ lang = value.split(":", 1)[1].strip()
+ try:
+ self.ctx.add_language(lang)
+ except DataError:
+ for token in statement:
+ token.set_error(
+ f"Invalid language configuration: Language '{lang}' "
+ f"not found nor importable as a language module."
+ )
+ else:
+ for token in statement:
+ token.type = Token.CONFIG
+
+ def lex(self):
+ for token in self.statement:
+ if not token.type:
+ token.type = self.token_type
+
+
class SettingLexer(StatementLexer):
+ ctx: FileContext
def lex(self):
self.ctx.lex_setting(self.statement)
-class TestOrKeywordSettingLexer(SettingLexer):
+class TestCaseSettingLexer(StatementLexer):
+ ctx: TestCaseContext
+
+ def lex(self):
+ self.ctx.lex_setting(self.statement)
+
+ def handles(self, statement: StatementTokens) -> bool:
+ marker = statement[0].value
+ return bool(marker and marker[0] == "[" and marker[-1] == "]")
+
+
+class KeywordSettingLexer(StatementLexer):
+ ctx: KeywordContext
+
+ def lex(self):
+ self.ctx.lex_setting(self.statement)
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
marker = statement[0].value
- return marker and marker[0] == '[' and marker[-1] == ']'
+ return bool(marker and marker[0] == "[" and marker[-1] == "]")
class VariableLexer(TypeAndArguments):
+ ctx: FileContext
token_type = Token.VARIABLE
+ def lex(self):
+ super().lex()
+ if self.statement[0].value[:1] == "$":
+ self._lex_options("separator")
+
class KeywordCallLexer(StatementLexer):
+ ctx: "TestCaseContext|KeywordContext"
def lex(self):
if self.ctx.template_set:
@@ -140,7 +213,9 @@ def _lex_as_keyword_call(self):
for token in self.statement:
if keyword_seen:
token.type = Token.ARGUMENT
- elif is_assign(token.value, allow_assign_mark=True):
+ elif is_assign(
+ token.value, allow_assign_mark=True, allow_nested=True, allow_items=True
+ ):
token.type = Token.ASSIGN
else:
token.type = Token.KEYWORD
@@ -148,39 +223,45 @@ def _lex_as_keyword_call(self):
class ForHeaderLexer(StatementLexer):
- separators = ('IN', 'IN RANGE', 'IN ENUMERATE', 'IN ZIP')
+ separators = ("IN", "IN RANGE", "IN ENUMERATE", "IN ZIP")
- def handles(self, statement):
- return statement[0].value == 'FOR'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "FOR"
def lex(self):
self.statement[0].type = Token.FOR
- separator_seen = False
+ separator = None
for token in self.statement[1:]:
- if separator_seen:
+ if separator:
token.type = Token.ARGUMENT
elif normalize_whitespace(token.value) in self.separators:
token.type = Token.FOR_SEPARATOR
- separator_seen = True
+ separator = normalize_whitespace(token.value)
else:
token.type = Token.VARIABLE
+ if separator == "IN ENUMERATE":
+ self._lex_options("start")
+ elif separator == "IN ZIP":
+ self._lex_options("mode", "fill")
class IfHeaderLexer(TypeAndArguments):
token_type = Token.IF
- def handles(self, statement):
- return statement[0].value == 'IF' and len(statement) <= 2
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "IF" and len(statement) <= 2
class InlineIfHeaderLexer(StatementLexer):
token_type = Token.INLINE_IF
- def handles(self, statement):
+ def handles(self, statement: StatementTokens) -> bool:
for token in statement:
- if token.value == 'IF':
+ if token.value == "IF":
return True
- if not is_assign(token.value, allow_assign_mark=True):
+ if not is_assign(
+ token.value, allow_assign_mark=True, allow_nested=True, allow_items=True
+ ):
return False
return False
@@ -189,7 +270,7 @@ def lex(self):
for token in self.statement:
if if_seen:
token.type = Token.ARGUMENT
- elif token.value == 'IF':
+ elif token.value == "IF":
token.type = Token.INLINE_IF
if_seen = True
else:
@@ -199,91 +280,133 @@ def lex(self):
class ElseIfHeaderLexer(TypeAndArguments):
token_type = Token.ELSE_IF
- def handles(self, statement):
- return normalize_whitespace(statement[0].value) == 'ELSE IF'
+ def handles(self, statement: StatementTokens) -> bool:
+ return normalize_whitespace(statement[0].value) == "ELSE IF"
class ElseHeaderLexer(TypeAndArguments):
token_type = Token.ELSE
- def handles(self, statement):
- return statement[0].value == 'ELSE'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "ELSE"
class TryHeaderLexer(TypeAndArguments):
token_type = Token.TRY
- def handles(self, statement):
- return statement[0].value == 'TRY'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "TRY"
class ExceptHeaderLexer(StatementLexer):
token_type = Token.EXCEPT
- def handles(self, statement):
- return statement[0].value == 'EXCEPT'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "EXCEPT"
def lex(self):
self.statement[0].type = Token.EXCEPT
- last_pattern = None
- as_seen = False
- for token in self.statement[1:]:
- if token.value == 'AS':
+ as_index: "int|None" = None
+ for index, token in enumerate(self.statement[1:], start=1):
+ if token.value == "AS":
token.type = Token.AS
- as_seen = True
- elif as_seen:
+ as_index = index
+ elif as_index:
token.type = Token.VARIABLE
else:
token.type = Token.ARGUMENT
- last_pattern = token
- if last_pattern and last_pattern.value.startswith('type='):
- last_pattern.type = Token.OPTION
+ self._lex_options("type", end_index=as_index)
class FinallyHeaderLexer(TypeAndArguments):
token_type = Token.FINALLY
- def handles(self, statement):
- return statement[0].value == 'FINALLY'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "FINALLY"
class WhileHeaderLexer(StatementLexer):
token_type = Token.WHILE
- def handles(self, statement):
- return statement[0].value == 'WHILE'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "WHILE"
def lex(self):
self.statement[0].type = Token.WHILE
for token in self.statement[1:]:
token.type = Token.ARGUMENT
- if self.statement[-1].value.startswith('limit='):
- self.statement[-1].type = Token.OPTION
+ self._lex_options("limit", "on_limit", "on_limit_message")
+
+
+class GroupHeaderLexer(TypeAndArguments):
+ token_type = Token.GROUP
+
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "GROUP"
class EndLexer(TypeAndArguments):
token_type = Token.END
- def handles(self, statement):
- return statement[0].value == 'END'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "END"
+
+
+class VarLexer(StatementLexer):
+ token_type = Token.VAR
+
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "VAR"
+
+ def lex(self):
+ self.statement[0].type = Token.VAR
+ if len(self.statement) > 1:
+ name, *values = self.statement[1:]
+ name.type = Token.VARIABLE
+ for value in values:
+ value.type = Token.ARGUMENT
+ options = ["scope", "separator"] if name.value[:1] == "$" else ["scope"]
+ self._lex_options(*options)
class ReturnLexer(TypeAndArguments):
token_type = Token.RETURN_STATEMENT
- def handles(self, statement):
- return statement[0].value == 'RETURN'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "RETURN"
class ContinueLexer(TypeAndArguments):
token_type = Token.CONTINUE
- def handles(self, statement):
- return statement[0].value == 'CONTINUE'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "CONTINUE"
class BreakLexer(TypeAndArguments):
token_type = Token.BREAK
- def handles(self, statement):
- return statement[0].value == 'BREAK'
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value == "BREAK"
+
+
+class SyntaxErrorLexer(TypeAndArguments):
+ token_type = Token.ERROR
+
+ def handles(self, statement: StatementTokens) -> bool:
+ return statement[0].value in {
+ "ELSE",
+ "ELSE IF",
+ "EXCEPT",
+ "FINALLY",
+ "BREAK",
+ "CONTINUE",
+ "RETURN",
+ "END",
+ }
+
+ def lex(self):
+ token = self.statement[0]
+ token.set_error(f"{token.value} is not allowed in this context.")
+ for t in self.statement[1:]:
+ t.type = Token.ARGUMENT
diff --git a/src/robot/parsing/lexer/tokenizer.py b/src/robot/parsing/lexer/tokenizer.py
index 1784cbec0f7..18f8f7f8fe3 100644
--- a/src/robot/parsing/lexer/tokenizer.py
+++ b/src/robot/parsing/lexer/tokenizer.py
@@ -14,16 +14,17 @@
# limitations under the License.
import re
+from collections.abc import Iterator
from .tokens import Token
class Tokenizer:
- _space_splitter = re.compile(r'(\s{2,}|\t)', re.UNICODE)
- _pipe_splitter = re.compile(r'((?:\A|\s+)\|(?:\s+|\Z))', re.UNICODE)
+ _space_splitter = re.compile(r"(\s{2,}|\t)", re.UNICODE)
+ _pipe_splitter = re.compile(r"((?:\A|\s+)\|(?:\s+|\Z))", re.UNICODE)
- def tokenize(self, data, data_only=False):
- current = []
+ def tokenize(self, data: str, data_only: bool = False) -> "Iterator[list[Token]]":
+ current: "list[Token]" = []
for lineno, line in enumerate(data.splitlines(not data_only), start=1):
tokens = self._tokenize_line(line, lineno, not data_only)
tokens, starts_new = self._cleanup_tokens(tokens, data_only)
@@ -35,12 +36,17 @@ def tokenize(self, data, data_only=False):
current.extend(tokens)
yield current
- def _tokenize_line(self, line, lineno, include_separators=True):
+ def _tokenize_line(
+ self,
+ line: str,
+ lineno: int,
+ include_separators: bool,
+ ) -> "list[Token]":
# Performance optimized code.
tokens = []
append = tokens.append
offset = 0
- if line[:1] == '|' and line[:2].strip() == '|':
+ if line[:1] == "|" and line[:2].strip() == "|":
splitter = self._split_from_pipes
else:
splitter = self._split_from_spaces
@@ -51,17 +57,17 @@ def _tokenize_line(self, line, lineno, include_separators=True):
append(Token(Token.SEPARATOR, value, lineno, offset))
offset += len(value)
if include_separators:
- trailing_whitespace = line[len(line.rstrip()):]
+ trailing_whitespace = line[len(line.rstrip()) :]
append(Token(Token.EOL, trailing_whitespace, lineno, offset))
return tokens
- def _split_from_spaces(self, line):
+ def _split_from_spaces(self, line: str) -> "Iterator[tuple[str, bool]]":
is_data = True
for value in self._space_splitter.split(line):
yield value, is_data
is_data = not is_data
- def _split_from_pipes(self, line):
+ def _split_from_pipes(self, line) -> "Iterator[tuple[str, bool]]":
splitter = self._pipe_splitter
_, separator, rest = splitter.split(line, 1)
yield separator, False
@@ -71,51 +77,60 @@ def _split_from_pipes(self, line):
yield separator, False
yield rest, True
- def _cleanup_tokens(self, tokens, data_only):
- has_data = self._handle_comments(tokens)
- continues = self._handle_continuation(tokens)
+ def _cleanup_tokens(
+ self,
+ tokens: "list[Token]",
+ data_only: bool,
+ ) -> "tuple[list[Token], bool]":
+ has_data, comments, continues = self._handle_comments_and_continuation(tokens)
self._remove_trailing_empty(tokens)
if continues:
self._remove_leading_empty(tokens)
- self._ensure_data_after_continuation(tokens)
- if data_only:
- tokens = self._remove_non_data(tokens)
- return tokens, has_data and not continues
-
- def _handle_comments(self, tokens):
+ if not has_data:
+ self._ensure_data_after_continuation(tokens)
+ starts_new = False
+ else:
+ starts_new = has_data
+ if data_only and (comments or continues):
+ tokens = [t for t in tokens if t.type is None]
+ return tokens, starts_new
+
+ def _handle_comments_and_continuation(
+ self,
+ tokens: "list[Token]",
+ ) -> "tuple[bool, bool, bool]":
+ first = True
has_data = False
- commented = False
+ comments = False
+ continues = False
for token in tokens:
if token.type is None:
- # lstrip needed to strip possible leading space from first token.
- # Other leading/trailing spaces have been consumed as separators.
- value = token.value.lstrip()
- if value and not commented:
- if value[0] == '#':
- commented = True
- else:
- has_data = True
- if commented:
+ # The first token may have a leading space. With others spaces
+ # have been consumed as separators.
+ value = token.value.lstrip() if first else token.value
+ if comments:
token.type = Token.COMMENT
- return has_data
-
- def _handle_continuation(self, tokens):
- for token in tokens:
- if token.value == '...' and token.type is None:
- token.type = Token.CONTINUATION
- return True
- elif token.value and token.type != Token.SEPARATOR:
- return False
- return False
-
- def _remove_trailing_empty(self, tokens):
+ elif value:
+ if value[0] == "#":
+ token.type = Token.COMMENT
+ comments = True
+ elif not has_data:
+ if value == "..." and not continues:
+ token.type = Token.CONTINUATION
+ continues = True
+ else:
+ has_data = True
+ first = False
+ return has_data, comments, continues
+
+ def _remove_trailing_empty(self, tokens: "list[Token]"):
for token in reversed(tokens):
if not token.value and token.type != Token.EOL:
tokens.remove(token)
elif token.type is None:
break
- def _remove_leading_empty(self, tokens):
+ def _remove_leading_empty(self, tokens: "list[Token]"):
data_or_continuation = (None, Token.CONTINUATION)
for token in list(tokens):
if not token.value:
@@ -123,16 +138,13 @@ def _remove_leading_empty(self, tokens):
elif token.type in data_or_continuation:
break
- def _ensure_data_after_continuation(self, tokens):
- if not any(t.type is None for t in tokens):
- cont = self._find_continuation(tokens)
- token = Token(lineno=cont.lineno, col_offset=cont.end_col_offset)
- tokens.insert(tokens.index(cont) + 1, token)
+ def _ensure_data_after_continuation(self, tokens: "list[Token]"):
+ cont = self._find_continuation(tokens)
+ token = Token(lineno=cont.lineno, col_offset=cont.end_col_offset)
+ tokens.insert(tokens.index(cont) + 1, token)
- def _find_continuation(self, tokens):
+ def _find_continuation(self, tokens: "list[Token]") -> Token:
for token in tokens:
if token.type == Token.CONTINUATION:
return token
-
- def _remove_non_data(self, tokens):
- return [t for t in tokens if t.type is None]
+ raise ValueError("Continuation not found.")
diff --git a/src/robot/parsing/lexer/tokens.py b/src/robot/parsing/lexer/tokens.py
index 33af52091c8..0968388f2f9 100644
--- a/src/robot/parsing/lexer/tokens.py
+++ b/src/robot/parsing/lexer/tokens.py
@@ -13,7 +13,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.variables import VariableIterator
+from collections.abc import Iterator
+from typing import List
+
+from robot.variables import VariableMatches
+
+# Type alias to ease typing elsewhere
+StatementTokens = List["Token"]
class Token:
@@ -26,92 +32,96 @@ class Token:
Token types are declared as class attributes such as :attr:`SETTING_HEADER`
and :attr:`EOL`. Values of these constants have changed slightly in Robot
- Framework 4.0 and they may change again in the future. It is thus safer
+ Framework 4.0, and they may change again in the future. It is thus safer
to use the constants, not their values, when types are needed. For example,
use ``Token(Token.EOL)`` instead of ``Token('EOL')`` and
``token.type == Token.EOL`` instead of ``token.type == 'EOL'``.
- If :attr:`value` is not given when :class:`Token` is initialized and
- :attr:`type` is :attr:`IF`, :attr:`ELSE_IF`, :attr:`ELSE`, :attr:`FOR`,
- :attr:`END`, :attr:`WITH_NAME` or :attr:`CONTINUATION`, the value is
- automatically set to the correct marker value like ``'IF'`` or ``'ELSE IF'``.
- If :attr:`type` is :attr:`EOL` in this case, the value is set to ``'\\n'``.
+ If :attr:`value` is not given and :attr:`type` is a special marker like
+ :attr:`IF` or `:attr:`EOL`, the value is set automatically.
"""
- SETTING_HEADER = 'SETTING HEADER'
- VARIABLE_HEADER = 'VARIABLE HEADER'
- TESTCASE_HEADER = 'TESTCASE HEADER'
- KEYWORD_HEADER = 'KEYWORD HEADER'
- COMMENT_HEADER = 'COMMENT HEADER'
-
- TESTCASE_NAME = 'TESTCASE NAME'
- KEYWORD_NAME = 'KEYWORD NAME'
-
- DOCUMENTATION = 'DOCUMENTATION'
- SUITE_SETUP = 'SUITE SETUP'
- SUITE_TEARDOWN = 'SUITE TEARDOWN'
- METADATA = 'METADATA'
- TEST_SETUP = 'TEST SETUP'
- TEST_TEARDOWN = 'TEST TEARDOWN'
- TEST_TEMPLATE = 'TEST TEMPLATE'
- TEST_TIMEOUT = 'TEST TIMEOUT'
- FORCE_TAGS = 'FORCE TAGS'
- DEFAULT_TAGS = 'DEFAULT TAGS'
- LIBRARY = 'LIBRARY'
- RESOURCE = 'RESOURCE'
- VARIABLES = 'VARIABLES'
- SETUP = 'SETUP'
- TEARDOWN = 'TEARDOWN'
- TEMPLATE = 'TEMPLATE'
- TIMEOUT = 'TIMEOUT'
- TAGS = 'TAGS'
- ARGUMENTS = 'ARGUMENTS'
- # Use ´RETURN_SETTING` type instead of `RETURN`. `[Return]` is deprecated and
- # `RETURN` type will be used with `RETURN` statement in the future.
- RETURN = 'RETURN'
- RETURN_SETTING = RETURN
-
- NAME = 'NAME'
- VARIABLE = 'VARIABLE'
- ARGUMENT = 'ARGUMENT'
- ASSIGN = 'ASSIGN'
- KEYWORD = 'KEYWORD'
- WITH_NAME = 'WITH NAME'
- FOR = 'FOR'
- FOR_SEPARATOR = 'FOR SEPARATOR'
- END = 'END'
- IF = 'IF'
- INLINE_IF = 'INLINE IF'
- ELSE_IF = 'ELSE IF'
- ELSE = 'ELSE'
- TRY = 'TRY'
- EXCEPT = 'EXCEPT'
- FINALLY = 'FINALLY'
- AS = 'AS'
- WHILE = 'WHILE'
- RETURN_STATEMENT = 'RETURN STATEMENT'
- CONTINUE = 'CONTINUE'
- BREAK = 'BREAK'
- OPTION = 'OPTION'
-
- SEPARATOR = 'SEPARATOR'
- COMMENT = 'COMMENT'
- CONTINUATION = 'CONTINUATION'
- EOL = 'EOL'
- EOS = 'EOS'
-
- ERROR = 'ERROR'
- FATAL_ERROR = 'FATAL ERROR'
-
- NON_DATA_TOKENS = frozenset((
+ SETTING_HEADER = "SETTING HEADER"
+ VARIABLE_HEADER = "VARIABLE HEADER"
+ TESTCASE_HEADER = "TESTCASE HEADER"
+ TASK_HEADER = "TASK HEADER"
+ KEYWORD_HEADER = "KEYWORD HEADER"
+ COMMENT_HEADER = "COMMENT HEADER"
+ INVALID_HEADER = "INVALID HEADER"
+ FATAL_INVALID_HEADER = "FATAL INVALID HEADER" # TODO: Remove in RF 8.
+
+ TESTCASE_NAME = "TESTCASE NAME"
+ KEYWORD_NAME = "KEYWORD NAME"
+ SUITE_NAME = "SUITE NAME"
+ DOCUMENTATION = "DOCUMENTATION"
+ SUITE_SETUP = "SUITE SETUP"
+ SUITE_TEARDOWN = "SUITE TEARDOWN"
+ METADATA = "METADATA"
+ TEST_SETUP = "TEST SETUP"
+ TEST_TEARDOWN = "TEST TEARDOWN"
+ TEST_TEMPLATE = "TEST TEMPLATE"
+ TEST_TIMEOUT = "TEST TIMEOUT"
+ TEST_TAGS = "TEST TAGS"
+ FORCE_TAGS = TEST_TAGS # TODO: Remove in RF 8.
+ DEFAULT_TAGS = "DEFAULT TAGS"
+ KEYWORD_TAGS = "KEYWORD TAGS"
+ LIBRARY = "LIBRARY"
+ RESOURCE = "RESOURCE"
+ VARIABLES = "VARIABLES"
+ SETUP = "SETUP"
+ TEARDOWN = "TEARDOWN"
+ TEMPLATE = "TEMPLATE"
+ TIMEOUT = "TIMEOUT"
+ TAGS = "TAGS"
+ ARGUMENTS = "ARGUMENTS"
+ RETURN = "RETURN" # TODO: Change to mean RETURN statement in RF 8.
+ RETURN_SETTING = RETURN # TODO: Remove in RF 8.
+
+ AS = "AS"
+ WITH_NAME = AS # TODO: Remove in RF 8.
+
+ NAME = "NAME"
+ VARIABLE = "VARIABLE"
+ ARGUMENT = "ARGUMENT"
+ ASSIGN = "ASSIGN"
+ KEYWORD = "KEYWORD"
+ FOR = "FOR"
+ FOR_SEPARATOR = "FOR SEPARATOR"
+ END = "END"
+ IF = "IF"
+ INLINE_IF = "INLINE IF"
+ ELSE_IF = "ELSE IF"
+ ELSE = "ELSE"
+ TRY = "TRY"
+ EXCEPT = "EXCEPT"
+ FINALLY = "FINALLY"
+ WHILE = "WHILE"
+ VAR = "VAR"
+ RETURN_STATEMENT = "RETURN STATEMENT"
+ CONTINUE = "CONTINUE"
+ BREAK = "BREAK"
+ OPTION = "OPTION"
+ GROUP = "GROUP"
+
+ SEPARATOR = "SEPARATOR"
+ COMMENT = "COMMENT"
+ CONTINUATION = "CONTINUATION"
+ CONFIG = "CONFIG"
+ EOL = "EOL"
+ EOS = "EOS"
+ ERROR = "ERROR"
+ FATAL_ERROR = "FATAL ERROR" # TODO: Remove in RF 8.
+
+ NON_DATA_TOKENS = {
SEPARATOR,
COMMENT,
CONTINUATION,
EOL,
- EOS
- ))
- SETTING_TOKENS = frozenset((
+ EOS,
+ }
+ SETTING_TOKENS = {
DOCUMENTATION,
+ SUITE_NAME,
SUITE_SETUP,
SUITE_TEARDOWN,
METADATA,
@@ -119,8 +129,9 @@ class Token:
TEST_TEARDOWN,
TEST_TEMPLATE,
TEST_TIMEOUT,
- FORCE_TAGS,
+ TEST_TAGS,
DEFAULT_TAGS,
+ KEYWORD_TAGS,
LIBRARY,
RESOURCE,
VARIABLES,
@@ -130,34 +141,65 @@ class Token:
TIMEOUT,
TAGS,
ARGUMENTS,
- RETURN
- ))
- HEADER_TOKENS = frozenset((
+ RETURN,
+ }
+ HEADER_TOKENS = {
SETTING_HEADER,
VARIABLE_HEADER,
TESTCASE_HEADER,
+ TASK_HEADER,
KEYWORD_HEADER,
- COMMENT_HEADER
- ))
- ALLOW_VARIABLES = frozenset((
+ COMMENT_HEADER,
+ INVALID_HEADER,
+ }
+ ALLOW_VARIABLES = {
NAME,
ARGUMENT,
TESTCASE_NAME,
- KEYWORD_NAME
- ))
-
- __slots__ = ['type', 'value', 'lineno', 'col_offset', 'error',
- '_add_eos_before', '_add_eos_after']
-
- def __init__(self, type=None, value=None, lineno=-1, col_offset=-1, error=None):
+ KEYWORD_NAME,
+ }
+ __slots__ = (
+ "type",
+ "value",
+ "lineno",
+ "col_offset",
+ "error",
+ "_add_eos_before",
+ "_add_eos_after",
+ )
+
+ def __init__(
+ self,
+ type: "str|None" = None,
+ value: "str|None" = None,
+ lineno: int = -1,
+ col_offset: int = -1,
+ error: "str|None" = None,
+ ):
self.type = type
if value is None:
- value = {
- Token.IF: 'IF', Token.ELSE_IF: 'ELSE IF', Token.ELSE: 'ELSE',
- Token.INLINE_IF: 'IF', Token.FOR: 'FOR', Token.END: 'END',
- Token.RETURN_STATEMENT: 'RETURN', Token.CONTINUE: 'CONTINUE', Token.BREAK: 'BREAK',
- Token.CONTINUATION: '...', Token.EOL: '\n', Token.WITH_NAME: 'WITH NAME'
- }.get(type, '')
+ defaults = {
+ Token.IF: "IF",
+ Token.INLINE_IF: "IF",
+ Token.ELSE_IF: "ELSE IF",
+ Token.ELSE: "ELSE",
+ Token.FOR: "FOR",
+ Token.WHILE: "WHILE",
+ Token.TRY: "TRY",
+ Token.EXCEPT: "EXCEPT",
+ Token.FINALLY: "FINALLY",
+ Token.END: "END",
+ Token.VAR: "VAR",
+ Token.CONTINUE: "CONTINUE",
+ Token.BREAK: "BREAK",
+ Token.RETURN_STATEMENT: "RETURN",
+ Token.CONTINUATION: "...",
+ Token.EOL: "\n",
+ Token.WITH_NAME: "AS",
+ Token.AS: "AS",
+ Token.GROUP: "GROUP",
+ }
+ value = defaults.get(type, "")
self.value = value
self.lineno = lineno
self.col_offset = col_offset
@@ -167,76 +209,78 @@ def __init__(self, type=None, value=None, lineno=-1, col_offset=-1, error=None):
self._add_eos_after = False
@property
- def end_col_offset(self):
+ def end_col_offset(self) -> int:
if self.col_offset == -1:
return -1
return self.col_offset + len(self.value)
- def set_error(self, error, fatal=False):
- self.type = Token.ERROR if not fatal else Token.FATAL_ERROR
+ def set_error(self, error: str):
+ self.type = Token.ERROR
self.error = error
- def tokenize_variables(self):
+ def tokenize_variables(self) -> "Iterator[Token]":
"""Tokenizes possible variables in token value.
Yields the token itself if the token does not allow variables (see
:attr:`Token.ALLOW_VARIABLES`) or its value does not contain
- variables. Otherwise yields variable tokens as well as tokens
+ variables. Otherwise, yields variable tokens as well as tokens
before, after, or between variables so that they have the same
type as the original token.
"""
if self.type not in Token.ALLOW_VARIABLES:
return self._tokenize_no_variables()
- variables = VariableIterator(self.value)
- if not variables:
+ matches = VariableMatches(self.value)
+ if not matches:
return self._tokenize_no_variables()
- return self._tokenize_variables(variables)
+ return self._tokenize_variables(matches)
- def _tokenize_no_variables(self):
+ def _tokenize_no_variables(self) -> "Iterator[Token]":
yield self
- def _tokenize_variables(self, variables):
+ def _tokenize_variables(self, matches) -> "Iterator[Token]":
lineno = self.lineno
col_offset = self.col_offset
- remaining = ''
- for before, variable, remaining in variables:
- if before:
- yield Token(self.type, before, lineno, col_offset)
- col_offset += len(before)
- yield Token(Token.VARIABLE, variable, lineno, col_offset)
- col_offset += len(variable)
- if remaining:
- yield Token(self.type, remaining, lineno, col_offset)
-
- def __str__(self):
+ after = ""
+ for match in matches:
+ if match.before:
+ yield Token(self.type, match.before, lineno, col_offset)
+ yield Token(Token.VARIABLE, match.match, lineno, col_offset + match.start)
+ col_offset += match.end
+ after = match.after
+ if after:
+ yield Token(self.type, after, lineno, col_offset)
+
+ def __str__(self) -> str:
return self.value
- def __repr__(self):
- type_ = self.type.replace(' ', '_') if self.type else 'None'
- error = '' if not self.error else ', %r' % self.error
- return 'Token(%s, %r, %s, %s%s)' % (type_, self.value, self.lineno,
- self.col_offset, error)
+ def __repr__(self) -> str:
+ typ = self.type.replace(" ", "_") if self.type else "None"
+ error = "" if not self.error else f", {self.error!r}"
+ return f"Token({typ}, {self.value!r}, {self.lineno}, {self.col_offset}{error})"
- def __eq__(self, other):
- return (isinstance(other, Token)
- and self.type == other.type
- and self.value == other.value
- and self.lineno == other.lineno
- and self.col_offset == other.col_offset
- and self.error == other.error)
+ def __eq__(self, other) -> bool:
+ return (
+ isinstance(other, Token)
+ and self.type == other.type
+ and self.value == other.value
+ and self.lineno == other.lineno
+ and self.col_offset == other.col_offset
+ and self.error == other.error
+ )
class EOS(Token):
"""Token representing end of a statement."""
- __slots__ = []
- def __init__(self, lineno=-1, col_offset=-1):
- Token.__init__(self, Token.EOS, '', lineno, col_offset)
+ __slots__ = ()
+
+ def __init__(self, lineno: int = -1, col_offset: int = -1):
+ super().__init__(Token.EOS, "", lineno, col_offset)
@classmethod
- def from_token(cls, token, before=False):
+ def from_token(cls, token: Token, before: bool = False) -> "EOS":
col_offset = token.col_offset if before else token.end_col_offset
- return EOS(token.lineno, col_offset)
+ return cls(token.lineno, col_offset)
class END(Token):
@@ -245,12 +289,13 @@ class END(Token):
Virtual END tokens have '' as their value, with "real" END tokens the
value is 'END'.
"""
- __slots__ = []
- def __init__(self, lineno=-1, col_offset=-1, virtual=False):
- value = 'END' if not virtual else ''
- Token.__init__(self, Token.END, value, lineno, col_offset)
+ __slots__ = ()
+
+ def __init__(self, lineno: int = -1, col_offset: int = -1, virtual: bool = False):
+ value = "END" if not virtual else ""
+ super().__init__(Token.END, value, lineno, col_offset)
@classmethod
- def from_token(cls, token, virtual=False):
- return END(token.lineno, token.end_col_offset, virtual)
+ def from_token(cls, token: Token, virtual: bool = False) -> "END":
+ return cls(token.lineno, token.end_col_offset, virtual)
diff --git a/src/robot/parsing/model/__init__.py b/src/robot/parsing/model/__init__.py
index 9993f37b3bf..57719442acf 100644
--- a/src/robot/parsing/model/__init__.py
+++ b/src/robot/parsing/model/__init__.py
@@ -13,8 +13,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .blocks import (File, SettingSection, VariableSection, TestCaseSection,
- KeywordSection, CommentSection, TestCase, Keyword, For,
- If, Try, While)
-from .statements import Statement
-from .visitor import ModelTransformer, ModelVisitor
+from .blocks import (
+ Block as Block,
+ CommentSection as CommentSection,
+ Container as Container,
+ File as File,
+ For as For,
+ Group as Group,
+ If as If,
+ ImplicitCommentSection as ImplicitCommentSection,
+ InvalidSection as InvalidSection,
+ Keyword as Keyword,
+ KeywordSection as KeywordSection,
+ NestedBlock as NestedBlock,
+ Section as Section,
+ SettingSection as SettingSection,
+ TestCase as TestCase,
+ TestCaseSection as TestCaseSection,
+ Try as Try,
+ VariableSection as VariableSection,
+ While as While,
+)
+from .statements import Config as Config, End as End, Statement as Statement
+from .visitor import ModelTransformer as ModelTransformer, ModelVisitor as ModelVisitor
diff --git a/src/robot/parsing/model/blocks.py b/src/robot/parsing/model/blocks.py
index cd307ed714c..73abb3a042d 100644
--- a/src/robot/parsing/model/blocks.py
+++ b/src/robot/parsing/model/blocks.py
@@ -13,71 +13,72 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import ast
+import warnings
+from abc import ABC
+from contextlib import contextmanager
+from pathlib import Path
+from typing import cast, Iterator, Sequence, TextIO, Union
-from robot.utils import file_writer, is_pathlike, is_string
+from robot.utils import file_writer, test_or_task
-from .statements import Comment, EmptyLine
-from .visitor import ModelVisitor
from ..lexer import Token
+from .statements import (
+ Break, Continue, ElseHeader, ElseIfHeader, End, Error, ExceptHeader, FinallyHeader,
+ ForHeader, GroupHeader, IfHeader, KeywordCall, KeywordName, Node, ReturnSetting,
+ ReturnStatement, SectionHeader, Statement, TemplateArguments, TestCaseName,
+ TryHeader, Var, WhileHeader
+)
+from .visitor import ModelVisitor
+
+Body = Sequence[Union[Statement, "Block"]]
+Errors = Sequence[str]
-class Block(ast.AST):
- _fields = ()
- _attributes = ('lineno', 'col_offset', 'end_lineno', 'end_col_offset', 'errors')
- errors = ()
+class Container(Node, ABC):
@property
- def lineno(self):
+ def lineno(self) -> int:
statement = FirstStatementFinder.find_from(self)
return statement.lineno if statement else -1
@property
- def col_offset(self):
+ def col_offset(self) -> int:
statement = FirstStatementFinder.find_from(self)
return statement.col_offset if statement else -1
@property
- def end_lineno(self):
+ def end_lineno(self) -> int:
statement = LastStatementFinder.find_from(self)
return statement.end_lineno if statement else -1
@property
- def end_col_offset(self):
+ def end_col_offset(self) -> int:
statement = LastStatementFinder.find_from(self)
return statement.end_col_offset if statement else -1
def validate_model(self):
ModelValidator().visit(self)
- def validate(self, context):
+ def validate(self, ctx: "ValidationContext"):
pass
- def _body_is_empty(self):
- for node in self.body:
- if not isinstance(node, (EmptyLine, Comment)):
- return False
- return True
-
-class HeaderAndBody(Block):
- _fields = ('header', 'body')
+class File(Container):
+ _fields = ("sections",)
+ _attributes = ("source", "languages", *Container._attributes)
- def __init__(self, header, body=None, errors=()):
- self.header = header
- self.body = body or []
- self.errors = errors
-
-
-class File(Block):
- _fields = ('sections',)
- _attributes = ('source',) + Block._attributes
-
- def __init__(self, sections=None, source=None):
- self.sections = sections or []
+ def __init__(
+ self,
+ sections: "Sequence[Section]" = (),
+ source: "Path|None" = None,
+ languages: Sequence[str] = (),
+ ):
+ super().__init__()
+ self.sections = list(sections)
self.source = source
+ self.languages = list(languages)
- def save(self, output=None):
+ def save(self, output: "Path|str|TextIO|None" = None):
"""Save model to the given ``output`` or to the original source file.
The ``output`` can be a path to a file or an already opened file
@@ -86,94 +87,161 @@ def save(self, output=None):
"""
output = output or self.source
if output is None:
- raise TypeError('Saving model requires explicit output '
- 'when original source is not path.')
+ raise TypeError(
+ "Saving model requires explicit output when original source "
+ "is not path."
+ )
ModelWriter(output).write(self)
-class Section(Block):
- _fields = ('header', 'body')
+class Block(Container, ABC):
+ _fields = ("header", "body")
- def __init__(self, header=None, body=None):
+ def __init__(
+ self,
+ header: "Statement|None",
+ body: Body = (),
+ errors: Errors = (),
+ ):
self.header = header
- self.body = body or []
+ self.body = list(body)
+ self.errors = tuple(errors)
+
+ def _body_is_empty(self):
+ # This works with tests, keywords, and blocks inside them, not with sections.
+ valid = (
+ KeywordCall,
+ TemplateArguments,
+ Var,
+ Continue,
+ Break,
+ ReturnSetting,
+ Group,
+ ReturnStatement,
+ NestedBlock,
+ Error,
+ )
+ return not any(isinstance(node, valid) for node in self.body)
+
+
+class Section(Block):
+ header: "SectionHeader|None"
class SettingSection(Section):
- pass
+ header: SectionHeader
class VariableSection(Section):
- pass
+ header: SectionHeader
+# TODO: should there be a separate TaskSection?
class TestCaseSection(Section):
+ header: SectionHeader
@property
- def tasks(self):
- return self.header.name.upper() in ('TASKS', 'TASK')
+ def tasks(self) -> bool:
+ return self.header.type == Token.TASK_HEADER
class KeywordSection(Section):
- pass
+ header: SectionHeader
class CommentSection(Section):
+ header: "SectionHeader|None"
+
+
+class ImplicitCommentSection(CommentSection):
+ header: None
+
+ def __init__(
+ self,
+ header: "Statement|None" = None,
+ body: Body = (),
+ errors: Errors = (),
+ ):
+ body = ([header] if header is not None else []) + list(body)
+ super().__init__(None, body, errors)
+
+
+class InvalidSection(Section):
pass
class TestCase(Block):
- _fields = ('header', 'body')
-
- def __init__(self, header, body=None):
- self.header = header
- self.body = body or []
+ header: TestCaseName
@property
- def name(self):
+ def name(self) -> str:
return self.header.name
+ def validate(self, ctx: "ValidationContext"):
+ if self._body_is_empty():
+ self.errors += (test_or_task("{Test} cannot be empty.", ctx.tasks),)
-class Keyword(Block):
- _fields = ('header', 'body')
- def __init__(self, header, body=None):
- self.header = header
- self.body = body or []
+class Keyword(Block):
+ header: KeywordName
@property
- def name(self):
+ def name(self) -> str:
return self.header.name
+ def validate(self, ctx: "ValidationContext"):
+ if self._body_is_empty():
+ self.errors += ("User keyword cannot be empty.",)
-class If(Block):
+
+class NestedBlock(Block):
+ _fields = ("header", "body", "end")
+
+ def __init__(
+ self,
+ header: Statement,
+ body: Body = (),
+ end: "End|None" = None,
+ errors: Errors = (),
+ ):
+ super().__init__(header, body, errors)
+ self.end = end
+
+
+class If(NestedBlock):
"""Represents IF structures in the model.
Used with IF, Inline IF, ELSE IF and ELSE nodes. The :attr:`type` attribute
specifies the type.
"""
- _fields = ('header', 'body', 'orelse', 'end')
- def __init__(self, header, body=None, orelse=None, end=None, errors=()):
- self.header = header
- self.body = body or []
+ _fields = ("header", "body", "orelse", "end")
+ header: "IfHeader|ElseIfHeader|ElseHeader"
+
+ def __init__(
+ self,
+ header: Statement,
+ body: Body = (),
+ orelse: "If|None" = None,
+ end: "End|None" = None,
+ errors: Errors = (),
+ ):
+ super().__init__(header, body, end, errors)
self.orelse = orelse
- self.end = end
- self.errors = errors
@property
- def type(self):
+ def type(self) -> str:
return self.header.type
@property
- def condition(self):
+ def condition(self) -> "str|None":
return self.header.condition
@property
- def assign(self):
+ def assign(self) -> "tuple[str, ...]":
return self.header.assign
- def validate(self, context):
+ def validate(self, ctx: "ValidationContext"):
self._validate_body()
if self.type == Token.IF:
self._validate_structure()
@@ -184,8 +252,8 @@ def validate(self, context):
def _validate_body(self):
if self._body_is_empty():
- type = self.type if self.type != Token.INLINE_IF else 'IF'
- self.errors += (f'{type} branch cannot be empty.',)
+ type = self.type if self.type != Token.INLINE_IF else "IF"
+ self.errors += (f"{type} branch cannot be empty.",)
def _validate_structure(self):
orelse = self.orelse
@@ -193,9 +261,9 @@ def _validate_structure(self):
while orelse:
if else_seen:
if orelse.type == Token.ELSE:
- error = 'Only one ELSE allowed.'
+ error = "Only one ELSE allowed."
else:
- error = 'ELSE IF not allowed after ELSE.'
+ error = "ELSE IF not allowed after ELSE."
if error not in self.errors:
self.errors += (error,)
else_seen = else_seen or orelse.type == Token.ELSE
@@ -203,87 +271,116 @@ def _validate_structure(self):
def _validate_end(self):
if not self.end:
- self.errors += ('IF must have closing END.',)
+ self.errors += ("IF must have closing END.",)
def _validate_inline_if(self):
branch = self
assign = branch.assign
while branch:
if branch.body:
- item = branch.body[0]
+ item = cast(Statement, branch.body[0])
if assign and item.type != Token.KEYWORD:
- self.errors += ('Inline IF with assignment can only contain '
- 'keyword calls.',)
- if getattr(item, 'assign', None):
- self.errors += ('Inline IF branches cannot contain assignments.',)
+ self.errors += (
+ "Inline IF with assignment can only contain keyword calls.",
+ )
+ if getattr(item, "assign", None):
+ self.errors += ("Inline IF branches cannot contain assignments.",)
if item.type == Token.INLINE_IF:
- self.errors += ('Inline IF cannot be nested.',)
+ self.errors += ("Inline IF cannot be nested.",)
branch = branch.orelse
-class For(Block):
- _fields = ('header', 'body', 'end')
+class For(NestedBlock):
+ header: ForHeader
- def __init__(self, header, body=None, end=None, errors=()):
- self.header = header
- self.body = body or []
- self.end = end
- self.errors = errors
+ @property
+ def assign(self) -> "tuple[str, ...]":
+ return self.header.assign
@property
- def variables(self):
- return self.header.variables
+ def variables(self) -> "tuple[str, ...]": # TODO: Remove in RF 8.0.
+ warnings.warn(
+ "'For.variables' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'For.assign' instead."
+ )
+ return self.assign
@property
- def values(self):
+ def values(self) -> "tuple[str, ...]":
return self.header.values
@property
- def flavor(self):
+ def flavor(self) -> "str|None":
return self.header.flavor
- def validate(self, context):
- if self._body_is_empty():
- self.errors += ('FOR loop cannot be empty.',)
- if not self.end:
- self.errors += ('FOR loop must have closing END.',)
+ @property
+ def start(self) -> "str|None":
+ return self.header.start
+ @property
+ def mode(self) -> "str|None":
+ return self.header.mode
-class Try(Block):
- _fields = ('header', 'body', 'next', 'end')
+ @property
+ def fill(self) -> "str|None":
+ return self.header.fill
- def __init__(self, header, body=None, next=None, end=None, errors=()):
- self.header = header
- self.body = body or []
+ def validate(self, ctx: "ValidationContext"):
+ if self._body_is_empty():
+ self.errors += ("FOR loop cannot be empty.",)
+ if not self.end:
+ self.errors += ("FOR loop must have closing END.",)
+
+
+class Try(NestedBlock):
+ _fields = ("header", "body", "next", "end")
+ header: "TryHeader|ExceptHeader|ElseHeader|FinallyHeader"
+
+ def __init__(
+ self,
+ header: Statement,
+ body: Body = (),
+ next: "Try|None" = None,
+ end: "End|None" = None,
+ errors: Errors = (),
+ ):
+ super().__init__(header, body, end, errors)
self.next = next
- self.end = end
- self.errors = errors
@property
- def type(self):
+ def type(self) -> str:
return self.header.type
@property
- def patterns(self):
- return getattr(self.header, 'patterns', ())
+ def patterns(self) -> "tuple[str, ...]":
+ return getattr(self.header, "patterns", ())
@property
- def pattern_type(self):
- return getattr(self.header, 'pattern_type', None)
+ def pattern_type(self) -> "str|None":
+ return getattr(self.header, "pattern_type", None)
@property
- def variable(self):
- return getattr(self.header, 'variable', None)
+ def assign(self) -> "str|None":
+ return getattr(self.header, "assign", None)
- def validate(self, context):
+ @property
+ def variable(self) -> "str|None": # TODO: Remove in RF 8.0.
+ warnings.warn(
+ "'Try.variable' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'Try.assign' instead."
+ )
+ return self.assign
+
+ def validate(self, ctx: "ValidationContext"):
self._validate_body()
if self.type == Token.TRY:
self._validate_structure()
self._validate_end()
+ TemplatesNotAllowed("TRY").check(self)
def _validate_body(self):
if self._body_is_empty():
- self.errors += (f'{self.type} branch cannot be empty.',)
+ self.errors += (f"{self.type} branch cannot be empty.",)
def _validate_structure(self):
else_count = 0
@@ -294,158 +391,196 @@ def _validate_structure(self):
while branch:
if branch.type == Token.EXCEPT:
if else_count:
- self.errors += ('EXCEPT not allowed after ELSE.',)
+ self.errors += ("EXCEPT not allowed after ELSE.",)
if finally_count:
- self.errors += ('EXCEPT not allowed after FINALLY.',)
+ self.errors += ("EXCEPT not allowed after FINALLY.",)
if branch.patterns and empty_except_count:
- self.errors += ('EXCEPT without patterns must be last.',)
+ self.errors += ("EXCEPT without patterns must be last.",)
if not branch.patterns:
empty_except_count += 1
except_count += 1
if branch.type == Token.ELSE:
if finally_count:
- self.errors += ('ELSE not allowed after FINALLY.',)
+ self.errors += ("ELSE not allowed after FINALLY.",)
else_count += 1
if branch.type == Token.FINALLY:
finally_count += 1
branch = branch.next
if finally_count > 1:
- self.errors += ('Only one FINALLY allowed.',)
+ self.errors += ("Only one FINALLY allowed.",)
if else_count > 1:
- self.errors += ('Only one ELSE allowed.',)
+ self.errors += ("Only one ELSE allowed.",)
if empty_except_count > 1:
- self.errors += ('Only one EXCEPT without patterns allowed.',)
+ self.errors += ("Only one EXCEPT without patterns allowed.",)
if not (except_count or finally_count):
- self.errors += ('TRY structure must have EXCEPT or FINALLY branch.',)
+ self.errors += ("TRY structure must have EXCEPT or FINALLY branch.",)
def _validate_end(self):
if not self.end:
- self.errors += ('TRY must have closing END.',)
-
+ self.errors += ("TRY must have closing END.",)
-class While(Block):
- _fields = ('header', 'body', 'end')
- def __init__(self, header, body=None, end=None, errors=()):
- self.header = header
- self.body = body or []
- self.end = end
- self.errors = errors
+class While(NestedBlock):
+ header: WhileHeader
@property
- def condition(self):
+ def condition(self) -> str:
return self.header.condition
@property
- def limit(self):
+ def limit(self) -> "str|None":
return self.header.limit
- def validate(self, context):
+ @property
+ def on_limit(self) -> "str|None":
+ return self.header.on_limit
+
+ @property
+ def on_limit_message(self) -> "str|None":
+ return self.header.on_limit_message
+
+ def validate(self, ctx: "ValidationContext"):
if self._body_is_empty():
- self.errors += ('WHILE loop cannot be empty.',)
+ self.errors += ("WHILE loop cannot be empty.",)
if not self.end:
- self.errors += ('WHILE loop must have closing END.',)
+ self.errors += ("WHILE loop must have closing END.",)
+ TemplatesNotAllowed("WHILE").check(self)
+
+
+class Group(NestedBlock):
+ header: GroupHeader
+
+ @property
+ def name(self) -> str:
+ return self.header.name
+
+ def validate(self, ctx: "ValidationContext"):
+ if self._body_is_empty():
+ self.errors += ("GROUP cannot be empty.",)
+ if not self.end:
+ self.errors += ("GROUP must have closing END.",)
class ModelWriter(ModelVisitor):
- def __init__(self, output):
- if is_string(output) or is_pathlike(output):
+ def __init__(self, output: "Path|str|TextIO"):
+ if isinstance(output, (Path, str)):
self.writer = file_writer(output)
self.close_writer = True
else:
self.writer = output
self.close_writer = False
- def write(self, model):
+ def write(self, model: Node):
try:
self.visit(model)
finally:
if self.close_writer:
self.writer.close()
- def visit_Statement(self, statement):
- for token in statement.tokens:
+ def visit_Statement(self, statement: Statement):
+ for token in statement:
self.writer.write(token.value)
class ModelValidator(ModelVisitor):
def __init__(self):
- self._context = ValidationContext()
+ self.ctx = ValidationContext()
- def visit_Block(self, node):
- self._context.start_block(node)
- node.validate(self._context)
- ModelVisitor.generic_visit(self, node)
- self._context.end_block()
+ def visit_Block(self, node: Block):
+ with self.ctx.block(node):
+ node.validate(self.ctx)
+ super().generic_visit(node)
- def visit_Try(self, node):
- if node.header.type == Token.FINALLY:
- self._context.in_finally = True
- self.visit_Block(node)
- self._context.in_finally = False
-
- def visit_Statement(self, node):
- node.validate(self._context)
- ModelVisitor.generic_visit(self, node)
+ def visit_Statement(self, node: Statement):
+ node.validate(self.ctx)
class ValidationContext:
def __init__(self):
- self.roots = []
- self.in_finally = False
+ self.blocks = []
- def start_block(self, node):
- self.roots.append(node)
+ @contextmanager
+ def block(self, node: Block) -> Iterator[None]:
+ self.blocks.append(node)
+ try:
+ yield
+ finally:
+ self.blocks.pop()
- def end_block(self):
- self.roots.pop()
+ @property
+ def parent_block(self) -> "Block|None":
+ return self.blocks[-1] if self.blocks else None
@property
- def in_keyword(self):
- return Keyword in [type(r) for r in self.roots]
+ def tasks(self) -> bool:
+ for parent in self.blocks:
+ if isinstance(parent, TestCaseSection):
+ return parent.tasks
+ return False
@property
- def in_for(self):
- return For in [type(r) for r in self.roots]
+ def in_keyword(self) -> bool:
+ return any(isinstance(b, Keyword) for b in self.blocks)
@property
- def in_while(self):
- return While in [type(r) for r in self.roots]
+ def in_loop(self) -> bool:
+ return any(isinstance(b, (For, While)) for b in self.blocks)
+
+ @property
+ def in_finally(self) -> bool:
+ parent = self.parent_block
+ return isinstance(parent, Try) and parent.header.type == Token.FINALLY
class FirstStatementFinder(ModelVisitor):
def __init__(self):
- self.statement = None
+ self.statement: "Statement|None" = None
@classmethod
- def find_from(cls, model):
+ def find_from(cls, model: Node) -> "Statement|None":
finder = cls()
finder.visit(model)
return finder.statement
- def visit_Statement(self, statement):
+ def visit_Statement(self, statement: Statement):
if self.statement is None:
self.statement = statement
- def generic_visit(self, node):
+ def generic_visit(self, node: Node):
if self.statement is None:
- ModelVisitor.generic_visit(self, node)
+ super().generic_visit(node)
class LastStatementFinder(ModelVisitor):
def __init__(self):
- self.statement = None
+ self.statement: "Statement|None" = None
@classmethod
- def find_from(cls, model):
+ def find_from(cls, model: Node) -> "Statement|None":
finder = cls()
finder.visit(model)
return finder.statement
- def visit_Statement(self, statement):
+ def visit_Statement(self, statement: Statement):
self.statement = statement
+
+
+class TemplatesNotAllowed(ModelVisitor):
+
+ def __init__(self, kind: str):
+ self.kind = kind
+ self.found = False
+
+ def check(self, model: Node):
+ self.found = False
+ self.visit(model)
+ if self.found:
+ model.errors += (f"{self.kind} does not support templates.",)
+
+ def visit_TemplateArguments(self, node: None):
+ self.found = True
diff --git a/src/robot/parsing/model/statements.py b/src/robot/parsing/model/statements.py
index 3e5774acac5..4bae43bb015 100644
--- a/src/robot/parsing/model/statements.py
+++ b/src/robot/parsing/model/statements.py
@@ -15,86 +15,120 @@
import ast
import re
-
+import warnings
+from abc import ABC, abstractmethod
+from collections.abc import Iterator, Sequence
+from typing import ClassVar, Literal, overload, Type, TYPE_CHECKING, TypeVar
+
+from robot.conf import Language
+from robot.errors import DataError
+from robot.running import TypeInfo
from robot.running.arguments import UserKeywordArgumentParser
-from robot.utils import normalize_whitespace, seq2str, split_from_equals
-from robot.variables import is_scalar_assign, is_dict_variable, search_variable
+from robot.utils import normalize_whitespace, seq2str, split_from_equals, test_or_task
+from robot.variables import (
+ contains_variable, is_dict_variable, is_scalar_assign, search_variable,
+ VariableAssignment
+)
from ..lexer import Token
+if TYPE_CHECKING:
+ from .blocks import ValidationContext
+
+
+T = TypeVar("T", bound="Statement")
+FOUR_SPACES = " "
+EOL = "\n"
-FOUR_SPACES = ' '
-EOL = '\n'
+class Node(ast.AST, ABC):
+ _attributes = ("lineno", "col_offset", "end_lineno", "end_col_offset", "errors")
+ lineno: int
+ col_offset: int
+ end_lineno: int
+ end_col_offset: int
+ errors: "tuple[str, ...]" = ()
-class Statement(ast.AST):
- type = None
- handles_types = ()
- _fields = ('type', 'tokens')
- _attributes = ('lineno', 'col_offset', 'end_lineno', 'end_col_offset', 'errors')
- _statement_handlers = {}
- def __init__(self, tokens, errors=()):
+class Statement(Node, ABC):
+ _attributes = ("type", "tokens", *Node._attributes)
+ type: str
+ handles_types: "ClassVar[tuple[str, ...]]" = ()
+ statement_handlers: "ClassVar[dict[str, Type[Statement]]]" = {}
+ # Accepted configuration options. If the value is a tuple, it lists accepted
+ # values. If the used value contains a variable, it cannot be validated.
+ options: "dict[str, tuple|None]" = {}
+
+ def __init__(self, tokens: "Sequence[Token]", errors: "Sequence[str]" = ()):
self.tokens = tuple(tokens)
- self.errors = errors
+ self.errors = tuple(errors)
@property
- def lineno(self):
+ def lineno(self) -> int:
return self.tokens[0].lineno if self.tokens else -1
@property
- def col_offset(self):
+ def col_offset(self) -> int:
return self.tokens[0].col_offset if self.tokens else -1
@property
- def end_lineno(self):
+ def end_lineno(self) -> int:
return self.tokens[-1].lineno if self.tokens else -1
@property
- def end_col_offset(self):
+ def end_col_offset(self) -> int:
return self.tokens[-1].end_col_offset if self.tokens else -1
@classmethod
- def register(cls, subcls):
+ def register(cls, subcls: Type[T]) -> Type[T]:
types = subcls.handles_types or (subcls.type,)
for typ in types:
- cls._statement_handlers[typ] = subcls
+ cls.statement_handlers[typ] = subcls
return subcls
@classmethod
- def from_tokens(cls, tokens):
- handlers = cls._statement_handlers
+ def from_tokens(cls, tokens: "Sequence[Token]") -> "Statement":
+ """Create a statement from given tokens.
+
+ Statement type is got automatically from token types.
+
+ This classmethod should be called from :class:`Statement`, not from
+ its subclasses. If you know the subclass to use, simply create an
+ instance of it directly.
+ """
+ handlers = cls.statement_handlers
for token in tokens:
if token.type in handlers:
return handlers[token.type](tokens)
- if tokens and all(token.type == Token.ASSIGN for token in tokens):
+ if any(token.type == Token.ASSIGN for token in tokens):
return KeywordCall(tokens)
return EmptyLine(tokens)
@classmethod
- def from_params(cls, *args, **kwargs):
- """Create statement from passed parameters.
-
- Required and optional arguments should match class properties. Values are
- used to create matching tokens.
+ @abstractmethod
+ def from_params(cls, *args, **kwargs) -> "Statement":
+ """Create a statement from passed parameters.
- There is one notable difference for `Documentation` statement where
- ``settings_header`` flag is used to determine if statement belongs to
- settings header or test/keyword.
+ Required and optional arguments in general match class properties.
+ Values are used to create matching tokens.
Most implementations support following general properties:
- - `separator` whitespace inserted between each token. Default is four spaces.
+
+ - ``separator`` whitespace inserted between each token. Default is four spaces.
- ``indent`` whitespace inserted before first token. Default is four spaces.
- ``eol`` end of line sign. Default is ``'\\n'``.
+
+ This classmethod should be called from the :class:`Statement` subclass
+ to create, not from the :class:`Statement` class itself.
"""
raise NotImplementedError
@property
- def data_tokens(self):
+ def data_tokens(self) -> "list[Token]":
return [t for t in self.tokens if t.type not in Token.NON_DATA_TOKENS]
- def get_token(self, *types):
- """Return a token with the given ``type``.
+ def get_token(self, *types: str) -> "Token|None":
+ """Return a token with any of the given ``types``.
If there are no matches, return ``None``. If there are multiple
matches, return the first match.
@@ -104,11 +138,17 @@ def get_token(self, *types):
return token
return None
- def get_tokens(self, *types):
+ def get_tokens(self, *types: str) -> "list[Token]":
"""Return tokens having any of the given ``types``."""
return [t for t in self.tokens if t.type in types]
- def get_value(self, type, default=None):
+ @overload
+ def get_value(self, type: str, default: str) -> str: ...
+
+ @overload
+ def get_value(self, type: str, default: None = None) -> "str|None": ...
+
+ def get_value(self, type: str, default: "str|None" = None) -> "str|None":
"""Return value of a token with the given ``type``.
If there are no matches, return ``default``. If there are multiple
@@ -117,12 +157,27 @@ def get_value(self, type, default=None):
token = self.get_token(type)
return token.value if token else default
- def get_values(self, *types):
+ def get_values(self, *types: str) -> "tuple[str, ...]":
"""Return values of tokens having any of the given ``types``."""
return tuple(t.value for t in self.tokens if t.type in types)
+ def get_option(self, name: str, default: "str|None" = None) -> "str|None":
+ """Return value of a configuration option with the given ``name``.
+
+ If the option has not been used, return ``default``.
+
+ If the option has been used multiple times, values are joined together.
+ This is typically an error situation and validated elsewhere.
+
+ New in Robot Framework 6.1.
+ """
+ return self._get_options().get(name, default)
+
+ def _get_options(self) -> "dict[str, str]":
+ return dict(opt.split("=", 1) for opt in self.get_values(Token.OPTION))
+
@property
- def lines(self):
+ def lines(self) -> "Iterator[list[Token]]":
line = []
for token in self.tokens:
line.append(token)
@@ -132,108 +187,163 @@ def lines(self):
if line:
yield line
- def validate(self, context):
+ def validate(self, ctx: "ValidationContext"):
pass
- def __iter__(self):
+ def _validate_options(self):
+ for name, value in self._get_options().items():
+ if self.options[name] is not None:
+ expected = self.options[name]
+ if value.upper() not in expected and not contains_variable(value):
+ self.errors += (
+ f"{self.type} option '{name}' does not accept value '{value}'. "
+ f"Valid values are {seq2str(expected)}.",
+ )
+
+ def __iter__(self) -> "Iterator[Token]":
return iter(self.tokens)
- def __len__(self):
+ def __len__(self) -> int:
return len(self.tokens)
- def __getitem__(self, item):
+ def __getitem__(self, item) -> Token:
return self.tokens[item]
- def __repr__(self):
- errors = '' if not self.errors else ', errors=%s' % list(self.errors)
- return '%s(tokens=%s%s)' % (type(self).__name__, list(self.tokens), errors)
-
+ def __repr__(self) -> str:
+ name = type(self).__name__
+ tokens = f"tokens={list(self.tokens)}"
+ errors = f", errors={list(self.errors)}" if self.errors else ""
+ return f"{name}({tokens}{errors})"
-class DocumentationOrMetadata(Statement):
- def _join_value(self, tokens):
- lines = self._get_lines(tokens)
- return ''.join(self._yield_lines_with_newlines(lines))
+class DocumentationOrMetadata(Statement, ABC):
- def _get_lines(self, tokens):
- lines = []
- line = None
+ @property
+ def value(self) -> str:
+ return "".join(self._get_lines()).rstrip()
+
+ def _get_lines(self) -> "Iterator[str]":
+ base_offset = -1
+ for tokens in self._get_line_tokens():
+ yield from self._get_line_values(tokens, base_offset)
+ first = tokens[0]
+ if base_offset < 0 or 0 < first.col_offset < base_offset and first.value:
+ base_offset = first.col_offset
+
+ def _get_line_tokens(self) -> "Iterator[list[Token]]":
+ line: "list[Token]" = []
lineno = -1
- for t in tokens:
- if t.lineno != lineno:
+ # There are no EOLs during execution or if data has been parsed with
+ # `data_only=True` otherwise, so we need to look at line numbers to
+ # know when lines change. If model is created programmatically using
+ # `from_params` or otherwise, line numbers may not be set, but there
+ # ought to be EOLs. If both EOLs and line numbers are missing,
+ # everything is considered to be on the same line.
+ for token in self.get_tokens(Token.ARGUMENT, Token.EOL):
+ eol = token.type == Token.EOL
+ if token.lineno != lineno or eol:
+ if line:
+ yield line
line = []
- lines.append(line)
- line.append(t.value)
- lineno = t.lineno
- return [' '.join(line) for line in lines]
-
- def _yield_lines_with_newlines(self, lines):
- last_index = len(lines) - 1
- for index, line in enumerate(lines):
+ if not eol:
+ line.append(token)
+ lineno = token.lineno
+ if line:
yield line
- if index < last_index and not self._escaped_or_has_newline(line):
- yield '\n'
- def _escaped_or_has_newline(self, line):
- match = re.search(r'(\\+)n?$', line)
- return match and len(match.group(1)) % 2 == 1
+ def _get_line_values(self, tokens: "list[Token]", offset: int) -> "Iterator[str]":
+ token = None
+ for index, token in enumerate(tokens):
+ if token.col_offset > offset > 0:
+ yield " " * (token.col_offset - offset)
+ elif index > 0:
+ yield " "
+ yield self._remove_trailing_backslash(token.value)
+ offset = token.end_col_offset
+ if token and not self._has_trailing_backslash_or_newline(token.value):
+ yield "\n"
+ def _remove_trailing_backslash(self, value: str) -> str:
+ if value and value[-1] == "\\":
+ match = re.search(r"(\\+)$", value)
+ if match and len(match.group(1)) % 2 == 1:
+ value = value[:-1]
+ return value
-class SingleValue(Statement):
+ def _has_trailing_backslash_or_newline(self, line: str) -> bool:
+ match = re.search(r"(\\+)n?$", line)
+ return bool(match and len(match.group(1)) % 2 == 1)
+
+
+class SingleValue(Statement, ABC):
@property
- def value(self):
+ def value(self) -> "str|None":
values = self.get_values(Token.NAME, Token.ARGUMENT)
- if values and values[0].upper() != 'NONE':
+ if values and values[0].upper() != "NONE":
return values[0]
return None
-class MultiValue(Statement):
+class MultiValue(Statement, ABC):
@property
- def values(self):
+ def values(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
-class Fixture(Statement):
+class Fixture(Statement, ABC):
@property
- def name(self):
- return self.get_value(Token.NAME)
+ def name(self) -> str:
+ return self.get_value(Token.NAME, "")
@property
- def args(self):
+ def args(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@Statement.register
class SectionHeader(Statement):
- handles_types = (Token.SETTING_HEADER, Token.VARIABLE_HEADER,
- Token.TESTCASE_HEADER, Token.KEYWORD_HEADER,
- Token.COMMENT_HEADER)
+ handles_types = (
+ Token.SETTING_HEADER,
+ Token.VARIABLE_HEADER,
+ Token.TESTCASE_HEADER,
+ Token.TASK_HEADER,
+ Token.KEYWORD_HEADER,
+ Token.COMMENT_HEADER,
+ Token.INVALID_HEADER,
+ )
@classmethod
- def from_params(cls, type, name=None, eol=EOL):
+ def from_params(
+ cls,
+ type: str,
+ name: "str|None" = None,
+ eol: str = EOL,
+ ) -> "SectionHeader":
if not name:
- names = ('Settings', 'Variables', 'Test Cases', 'Keywords', 'Comments')
+ names = (
+ "Settings",
+ "Variables",
+ "Test Cases",
+ "Tasks",
+ "Keywords",
+ "Comments",
+ )
name = dict(zip(cls.handles_types, names))[type]
- if not name.startswith('*'):
- name = '*** %s ***' % name
- return cls([
- Token(type, name),
- Token('EOL', '\n')
- ])
+ header = f"*** {name} ***" if not name.startswith("*") else name
+ return cls([Token(type, header), Token(Token.EOL, eol)])
@property
- def type(self):
+ def type(self) -> str:
token = self.get_token(*self.handles_types)
- return token.type
+ return token.type # type: ignore
@property
- def name(self):
+ def name(self) -> str:
token = self.get_token(*self.handles_types)
- return normalize_whitespace(token.value).strip('* ')
+ return normalize_whitespace(token.value).strip("* ") if token else ""
@Statement.register
@@ -241,32 +351,46 @@ class LibraryImport(Statement):
type = Token.LIBRARY
@classmethod
- def from_params(cls, name, args=(), alias=None, separator=FOUR_SPACES, eol=EOL):
- sep = Token(Token.SEPARATOR, separator)
- tokens = [Token(Token.LIBRARY, 'Library'), sep, Token(Token.NAME, name)]
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ alias: "str|None" = None,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "LibraryImport":
+ tokens = [
+ Token(Token.LIBRARY, "Library"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, name),
+ ]
for arg in args:
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, arg))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
if alias is not None:
- tokens.append(sep)
- tokens.append(Token(Token.WITH_NAME))
- tokens.append(sep)
- tokens.append(Token(Token.NAME, alias))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.AS),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, alias),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.NAME)
+ def name(self) -> str:
+ return self.get_value(Token.NAME, "")
@property
- def args(self):
+ def args(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@property
- def alias(self):
- with_name = self.get_token(Token.WITH_NAME)
- return self.get_tokens(Token.NAME)[-1].value if with_name else None
+ def alias(self) -> "str|None":
+ separator = self.get_token(Token.AS)
+ return self.get_tokens(Token.NAME)[-1].value if separator else None
@Statement.register
@@ -274,17 +398,23 @@ class ResourceImport(Statement):
type = Token.RESOURCE
@classmethod
- def from_params(cls, name, separator=FOUR_SPACES, eol=EOL):
- return cls([
- Token(Token.RESOURCE, 'Resource'),
+ def from_params(
+ cls,
+ name: str,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "ResourceImport":
+ tokens = [
+ Token(Token.RESOURCE, "Resource"),
Token(Token.SEPARATOR, separator),
Token(Token.NAME, name),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.NAME)
+ def name(self) -> str:
+ return self.get_value(Token.NAME, "")
@Statement.register
@@ -292,25 +422,32 @@ class VariablesImport(Statement):
type = Token.VARIABLES
@classmethod
- def from_params(cls, name, args=(), separator=FOUR_SPACES, eol=EOL):
- sep = Token(Token.SEPARATOR, separator)
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "VariablesImport":
tokens = [
- Token(Token.VARIABLES, 'Variables'),
- sep,
- Token(Token.NAME, name)
+ Token(Token.VARIABLES, "Variables"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.NAME)
+ def name(self) -> str:
+ return self.get_value(Token.NAME, "")
@property
- def args(self):
+ def args(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@@ -319,85 +456,101 @@ class Documentation(DocumentationOrMetadata):
type = Token.DOCUMENTATION
@classmethod
- def from_params(cls, value, indent=FOUR_SPACES, separator=FOUR_SPACES,
- eol=EOL, settings_section=True):
+ def from_params(
+ cls,
+ value: str,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ settings_section: bool = True,
+ ) -> "Documentation":
if settings_section:
tokens = [
- Token(Token.DOCUMENTATION, 'Documentation'),
- Token(Token.SEPARATOR, separator)
+ Token(Token.DOCUMENTATION, "Documentation"),
+ Token(Token.SEPARATOR, separator),
]
else:
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.DOCUMENTATION, '[Documentation]'),
- Token(Token.SEPARATOR, separator)
+ Token(Token.DOCUMENTATION, "[Documentation]"),
+ Token(Token.SEPARATOR, separator),
]
- multiline_separator = ' ' * (len(tokens[-2].value) + len(separator) - 3)
+ multiline_separator = " " * (len(tokens[-2].value) + len(separator) - 3)
doc_lines = value.splitlines()
if doc_lines:
- tokens.append(Token(Token.ARGUMENT, doc_lines[0]))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.ARGUMENT, doc_lines[0]),
+ Token(Token.EOL, eol),
+ ]
for line in doc_lines[1:]:
if not settings_section:
- tokens.append(Token(Token.SEPARATOR, indent))
- tokens.append(Token(Token.CONTINUATION))
+ tokens += [Token(Token.SEPARATOR, indent)]
+ tokens += [Token(Token.CONTINUATION)]
if line:
- tokens.append(Token(Token.SEPARATOR, multiline_separator))
- tokens.append(Token(Token.ARGUMENT, line))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [Token(Token.SEPARATOR, multiline_separator)]
+ tokens += [
+ Token(Token.ARGUMENT, line),
+ Token(Token.EOL, eol),
+ ]
return cls(tokens)
- @property
- def value(self):
- tokens = self.get_tokens(Token.ARGUMENT)
- return self._join_value(tokens)
-
@Statement.register
class Metadata(DocumentationOrMetadata):
type = Token.METADATA
@classmethod
- def from_params(cls, name, value, separator=FOUR_SPACES, eol=EOL):
- sep = Token(Token.SEPARATOR, separator)
+ def from_params(
+ cls,
+ name: str,
+ value: str,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Metadata":
tokens = [
- Token(Token.METADATA, 'Metadata'),
- sep,
- Token(Token.NAME, name)
+ Token(Token.METADATA, "Metadata"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, name),
]
metadata_lines = value.splitlines()
if metadata_lines:
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, metadata_lines[0]))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, metadata_lines[0]),
+ Token(Token.EOL, eol),
+ ]
for line in metadata_lines[1:]:
- tokens.append(Token(Token.CONTINUATION))
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, line))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.CONTINUATION),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, line),
+ Token(Token.EOL, eol),
+ ]
return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.NAME)
-
- @property
- def value(self):
- tokens = self.get_tokens(Token.ARGUMENT)
- return self._join_value(tokens)
+ def name(self) -> str:
+ return self.get_value(Token.NAME, "")
@Statement.register
-class ForceTags(MultiValue):
- type = Token.FORCE_TAGS
+class TestTags(MultiValue):
+ type = Token.TEST_TAGS
@classmethod
- def from_params(cls, values, separator=FOUR_SPACES, eol=EOL):
- tokens = [Token(Token.FORCE_TAGS, 'Force Tags')]
+ def from_params(
+ cls,
+ values: "Sequence[str]",
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TestTags":
+ tokens = [Token(Token.TEST_TAGS, "Test Tags")]
for tag in values:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, tag))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, tag),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -406,12 +559,60 @@ class DefaultTags(MultiValue):
type = Token.DEFAULT_TAGS
@classmethod
- def from_params(cls, values, separator=FOUR_SPACES, eol=EOL):
- tokens = [Token(Token.DEFAULT_TAGS, 'Default Tags')]
+ def from_params(
+ cls,
+ values: "Sequence[str]",
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "DefaultTags":
+ tokens = [Token(Token.DEFAULT_TAGS, "Default Tags")]
for tag in values:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, tag))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, tag),
+ ]
+ tokens += [Token(Token.EOL, eol)]
+ return cls(tokens)
+
+
+@Statement.register
+class KeywordTags(MultiValue):
+ type = Token.KEYWORD_TAGS
+
+ @classmethod
+ def from_params(
+ cls,
+ values: "Sequence[str]",
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "KeywordTags":
+ tokens = [Token(Token.KEYWORD_TAGS, "Keyword Tags")]
+ for tag in values:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, tag),
+ ]
+ tokens += [Token(Token.EOL, eol)]
+ return cls(tokens)
+
+
+@Statement.register
+class SuiteName(SingleValue):
+ type = Token.SUITE_NAME
+
+ @classmethod
+ def from_params(
+ cls,
+ value: str,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "SuiteName":
+ tokens = [
+ Token(Token.SUITE_NAME, "Name"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, value),
+ Token(Token.EOL, eol),
+ ]
return cls(tokens)
@@ -420,16 +621,24 @@ class SuiteSetup(Fixture):
type = Token.SUITE_SETUP
@classmethod
- def from_params(cls, name, args=(), separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "SuiteSetup":
tokens = [
- Token(Token.SUITE_SETUP, 'Suite Setup'),
+ Token(Token.SUITE_SETUP, "Suite Setup"),
Token(Token.SEPARATOR, separator),
- Token(Token.NAME, name)
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -438,16 +647,24 @@ class SuiteTeardown(Fixture):
type = Token.SUITE_TEARDOWN
@classmethod
- def from_params(cls, name, args=(), separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "SuiteTeardown":
tokens = [
- Token(Token.SUITE_TEARDOWN, 'Suite Teardown'),
+ Token(Token.SUITE_TEARDOWN, "Suite Teardown"),
Token(Token.SEPARATOR, separator),
- Token(Token.NAME, name)
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -456,16 +673,24 @@ class TestSetup(Fixture):
type = Token.TEST_SETUP
@classmethod
- def from_params(cls, name, args=(), separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TestSetup":
tokens = [
- Token(Token.TEST_SETUP, 'Test Setup'),
+ Token(Token.TEST_SETUP, "Test Setup"),
Token(Token.SEPARATOR, separator),
- Token(Token.NAME, name)
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -474,16 +699,24 @@ class TestTeardown(Fixture):
type = Token.TEST_TEARDOWN
@classmethod
- def from_params(cls, name, args=(), separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TestTeardown":
tokens = [
- Token(Token.TEST_TEARDOWN, 'Test Teardown'),
+ Token(Token.TEST_TEARDOWN, "Test Teardown"),
Token(Token.SEPARATOR, separator),
- Token(Token.NAME, name)
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -492,13 +725,19 @@ class TestTemplate(SingleValue):
type = Token.TEST_TEMPLATE
@classmethod
- def from_params(cls, value, separator=FOUR_SPACES, eol=EOL):
- return cls([
- Token(Token.TEST_TEMPLATE, 'Test Template'),
+ def from_params(
+ cls,
+ value: str,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TestTemplate":
+ tokens = [
+ Token(Token.TEST_TEMPLATE, "Test Template"),
Token(Token.SEPARATOR, separator),
Token(Token.NAME, value),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
@Statement.register
@@ -506,59 +745,68 @@ class TestTimeout(SingleValue):
type = Token.TEST_TIMEOUT
@classmethod
- def from_params(cls, value, separator=FOUR_SPACES, eol=EOL):
- return cls([
- Token(Token.TEST_TIMEOUT, 'Test Timeout'),
+ def from_params(
+ cls,
+ value: str,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TestTimeout":
+ tokens = [
+ Token(Token.TEST_TIMEOUT, "Test Timeout"),
Token(Token.SEPARATOR, separator),
Token(Token.ARGUMENT, value),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
@Statement.register
class Variable(Statement):
type = Token.VARIABLE
+ options = {"separator": None}
@classmethod
- def from_params(cls, name, value, separator=FOUR_SPACES, eol=EOL):
- return cls([
- Token(Token.VARIABLE, name),
- Token(Token.SEPARATOR, separator),
- Token(Token.ARGUMENT, value),
- Token(Token.EOL, eol)
- ])
+ def from_params(
+ cls,
+ name: str,
+ value: "str|Sequence[str]",
+ value_separator: "str|None" = None,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Variable":
+ values = [value] if isinstance(value, str) else value
+ tokens = [Token(Token.VARIABLE, name)]
+ for value in values:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, value),
+ ]
+ if value_separator is not None:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"separator={value_separator}"),
+ ]
+ tokens += [Token(Token.EOL, eol)]
+ return cls(tokens)
@property
- def name(self):
- name = self.get_value(Token.VARIABLE)
- if name.endswith('='):
+ def name(self) -> str:
+ name = self.get_value(Token.VARIABLE, "")
+ if name.endswith("="):
return name[:-1].rstrip()
return name
@property
- def value(self):
+ def value(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
- def validate(self, context):
- name = self.get_value(Token.VARIABLE)
- match = search_variable(name, ignore_errors=True)
- if not match.is_assign(allow_assign_mark=True):
- self.errors += ("Invalid variable name '%s'." % name,)
- if match.is_dict_assign(allow_assign_mark=True):
- self._validate_dict_items()
-
- def _validate_dict_items(self):
- for item in self.get_values(Token.ARGUMENT):
- if not self._is_valid_dict_item(item):
- self.errors += (
- "Invalid dictionary variable item '%s'. "
- "Items must use 'name=value' syntax or be dictionary "
- "variables themselves." % item,
- )
+ @property
+ def separator(self) -> "str|None":
+ return self.get_option("separator")
- def _is_valid_dict_item(self, item):
- name, value = split_from_equals(item)
- return value is not None or is_dict_variable(item)
+ def validate(self, ctx: "ValidationContext"):
+ VariableValidator().validate(self)
+ self._validate_options()
@Statement.register
@@ -566,15 +814,19 @@ class TestCaseName(Statement):
type = Token.TESTCASE_NAME
@classmethod
- def from_params(cls, name, eol=EOL):
+ def from_params(cls, name: str, eol: str = EOL) -> "TestCaseName":
tokens = [Token(Token.TESTCASE_NAME, name)]
if eol:
- tokens.append(Token(Token.EOL, eol))
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.TESTCASE_NAME)
+ def name(self) -> str:
+ return self.get_value(Token.TESTCASE_NAME, "")
+
+ def validate(self, ctx: "ValidationContext"):
+ if not self.name:
+ self.errors += (test_or_task("{Test} name cannot be empty.", ctx.tasks),)
@Statement.register
@@ -582,15 +834,19 @@ class KeywordName(Statement):
type = Token.KEYWORD_NAME
@classmethod
- def from_params(cls, name, eol=EOL):
+ def from_params(cls, name: str, eol: str = EOL) -> "KeywordName":
tokens = [Token(Token.KEYWORD_NAME, name)]
if eol:
- tokens.append(Token(Token.EOL, eol))
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def name(self):
- return self.get_value(Token.KEYWORD_NAME)
+ def name(self) -> str:
+ return self.get_value(Token.KEYWORD_NAME, "")
+
+ def validate(self, ctx: "ValidationContext"):
+ if not self.name:
+ self.errors += ("User keyword name cannot be empty.",)
@Statement.register
@@ -598,18 +854,26 @@ class Setup(Fixture):
type = Token.SETUP
@classmethod
- def from_params(cls, name, args=(), indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- sep = Token(Token.SEPARATOR, separator)
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Setup":
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.SETUP, '[Setup]'),
- sep,
- Token(Token.NAME, name)
+ Token(Token.SETUP, "[Setup]"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -618,18 +882,26 @@ class Teardown(Fixture):
type = Token.TEARDOWN
@classmethod
- def from_params(cls, name, args=(), indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- sep = Token(Token.SEPARATOR, separator)
+ def from_params(
+ cls,
+ name: str,
+ args: "Sequence[str]" = (),
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Teardown":
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.TEARDOWN, '[Teardown]'),
- sep,
- Token(Token.NAME, name)
+ Token(Token.TEARDOWN, "[Teardown]"),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.NAME, name),
]
for arg in args:
- tokens.append(sep)
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -638,15 +910,23 @@ class Tags(MultiValue):
type = Token.TAGS
@classmethod
- def from_params(cls, values, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ values: "Sequence[str]",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Tags":
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.TAGS, '[Tags]')
+ Token(Token.TAGS, "[Tags]"),
]
for tag in values:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, tag))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, tag),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -655,14 +935,21 @@ class Template(SingleValue):
type = Token.TEMPLATE
@classmethod
- def from_params(cls, value, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- return cls([
+ def from_params(
+ cls,
+ value: str,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Template":
+ tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.TEMPLATE, '[Template]'),
+ Token(Token.TEMPLATE, "[Template]"),
Token(Token.SEPARATOR, separator),
Token(Token.NAME, value),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
@Statement.register
@@ -670,14 +957,21 @@ class Timeout(SingleValue):
type = Token.TIMEOUT
@classmethod
- def from_params(cls, value, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- return cls([
+ def from_params(
+ cls,
+ value: str,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Timeout":
+ tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.TIMEOUT, '[Timeout]'),
+ Token(Token.TIMEOUT, "[Timeout]"),
Token(Token.SEPARATOR, separator),
Token(Token.ARGUMENT, value),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
@Statement.register
@@ -685,37 +979,59 @@ class Arguments(MultiValue):
type = Token.ARGUMENTS
@classmethod
- def from_params(cls, args, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ args: "Sequence[str]",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Arguments":
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.ARGUMENTS, '[Arguments]'),
+ Token(Token.ARGUMENTS, "[Arguments]"),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
- def validate(self, context):
- errors = []
+ def validate(self, ctx: "ValidationContext"):
+ errors: "list[str]" = []
UserKeywordArgumentParser(error_reporter=errors.append).parse(self.values)
self.errors = tuple(errors)
@Statement.register
-class Return(MultiValue):
+class ReturnSetting(MultiValue):
+ """Represents the deprecated ``[Return]`` setting.
+
+ This class was named ``Return`` prior to Robot Framework 7.0. A forward
+ compatible ``ReturnSetting`` alias existed already in Robot Framework 6.1.
+ """
+
type = Token.RETURN
@classmethod
- def from_params(cls, args, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ args: "Sequence[str]",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "ReturnSetting":
tokens = [
Token(Token.SEPARATOR, indent),
- Token(Token.RETURN, '[Return]'),
+ Token(Token.RETURN, "[Return]"),
]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@@ -724,108 +1040,179 @@ class KeywordCall(Statement):
type = Token.KEYWORD
@classmethod
- def from_params(cls, name, assign=(), args=(), indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ name: str,
+ assign: "Sequence[str]" = (),
+ args: "Sequence[str]" = (),
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "KeywordCall":
tokens = [Token(Token.SEPARATOR, indent)]
for assignment in assign:
- tokens.append(Token(Token.ASSIGN, assignment))
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.KEYWORD, name))
+ tokens += [
+ Token(Token.ASSIGN, assignment),
+ Token(Token.SEPARATOR, separator),
+ ]
+ tokens += [Token(Token.KEYWORD, name)]
for arg in args:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def keyword(self):
- return self.get_value(Token.KEYWORD)
+ def keyword(self) -> str:
+ return self.get_value(Token.KEYWORD, "")
@property
- def args(self):
+ def args(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@property
- def assign(self):
+ def assign(self) -> "tuple[str, ...]":
return self.get_values(Token.ASSIGN)
+ def validate(self, ctx: "ValidationContext"):
+ AssignmentValidator().validate(self)
+
@Statement.register
class TemplateArguments(Statement):
type = Token.ARGUMENT
@classmethod
- def from_params(cls, args, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ args: "Sequence[str]",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "TemplateArguments":
tokens = []
for index, arg in enumerate(args):
- tokens.append(Token(Token.SEPARATOR, separator if index else indent))
- tokens.append(Token(Token.ARGUMENT, arg))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator if index else indent),
+ Token(Token.ARGUMENT, arg),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def args(self):
+ def args(self) -> "tuple[str, ...]":
return self.get_values(self.type)
@Statement.register
class ForHeader(Statement):
type = Token.FOR
+ options = {"start": None, "mode": ("STRICT", "SHORTEST", "LONGEST"), "fill": None}
@classmethod
- def from_params(cls, variables, values, flavor='IN', indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
+ def from_params(
+ cls,
+ assign: "Sequence[str]",
+ values: "Sequence[str]",
+ flavor: Literal["IN", "IN RANGE", "IN ENUMERATE", "IN ZIP"] = "IN",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "ForHeader":
tokens = [
Token(Token.SEPARATOR, indent),
Token(Token.FOR),
- Token(Token.SEPARATOR, separator)
+ Token(Token.SEPARATOR, separator),
]
- for variable in variables:
- tokens.append(Token(Token.VARIABLE, variable))
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.FOR_SEPARATOR, flavor))
+ for variable in assign:
+ tokens += [
+ Token(Token.VARIABLE, variable),
+ Token(Token.SEPARATOR, separator),
+ ]
+ tokens += [Token(Token.FOR_SEPARATOR, flavor)]
for value in values:
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.ARGUMENT, value))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, value),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def variables(self):
+ def assign(self) -> "tuple[str, ...]":
return self.get_values(Token.VARIABLE)
@property
- def values(self):
+ def variables(self) -> "tuple[str, ...]": # TODO: Remove in RF 8.0.
+ warnings.warn(
+ "'ForHeader.variables' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'ForHeader.assign' instead."
+ )
+ return self.assign
+
+ @property
+ def values(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@property
- def flavor(self):
+ def flavor(self) -> "str|None":
separator = self.get_token(Token.FOR_SEPARATOR)
return normalize_whitespace(separator.value) if separator else None
- def validate(self, context):
- if not self.variables:
- self._add_error('no loop variables')
+ @property
+ def start(self) -> "str|None":
+ return self.get_option("start") if self.flavor == "IN ENUMERATE" else None
+
+ @property
+ def mode(self) -> "str|None":
+ return self.get_option("mode") if self.flavor == "IN ZIP" else None
+
+ @property
+ def fill(self) -> "str|None":
+ return self.get_option("fill") if self.flavor == "IN ZIP" else None
+
+ def validate(self, ctx: "ValidationContext"):
+ if not self.assign:
+ self.errors += ("FOR loop has no variables.",)
if not self.flavor:
- self._add_error("no 'IN' or other valid separator")
+ self.errors += ("FOR loop has no 'IN' or other valid separator.",)
else:
- for var in self.variables:
- if not is_scalar_assign(var):
- self._add_error("invalid loop variable '%s'" % var)
+ for var in self.assign:
+ match = search_variable(var, ignore_errors=True, parse_type=True)
+ if not match.is_scalar_assign():
+ self.errors += (f"Invalid FOR loop variable '{var}'.",)
+ elif match.type:
+ try:
+ TypeInfo.from_variable(match)
+ except DataError as err:
+ self.errors += (f"Invalid FOR loop variable '{var}': {err}",)
if not self.values:
- self._add_error('no loop values')
-
- def _add_error(self, error):
- self.errors += ('FOR loop has %s.' % error,)
+ self.errors += ("FOR loop has no values.",)
+ self._validate_options()
-class IfElseHeader(Statement):
+class IfElseHeader(Statement, ABC):
@property
- def condition(self):
- return None
+ def condition(self) -> "str|None":
+ values = self.get_values(Token.ARGUMENT)
+ return ", ".join(values) if values else None
@property
- def assign(self):
- return None
+ def assign(self) -> "tuple[str, ...]":
+ return self.get_values(Token.ASSIGN)
+
+ def validate(self, ctx: "ValidationContext"):
+ conditions = self.get_tokens(Token.ARGUMENT)
+ if not conditions:
+ self.errors += (f"{self.type} must have a condition.",)
+ if len(conditions) > 1:
+ self.errors += (
+ f"{self.type} cannot have more than one condition, "
+ f"got {seq2str(c.value for c in conditions)}.",
+ )
@Statement.register
@@ -833,79 +1220,113 @@ class IfHeader(IfElseHeader):
type = Token.IF
@classmethod
- def from_params(cls, condition, indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- tokens = [Token(Token.SEPARATOR, indent),
- Token(cls.type),
- Token(Token.SEPARATOR, separator),
- Token(Token.ARGUMENT, condition)]
- if cls.type != Token.INLINE_IF:
- tokens.append(Token(Token.EOL, eol))
+ def from_params(
+ cls,
+ condition: str,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "IfHeader":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(cls.type),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, condition),
+ Token(Token.EOL, eol),
+ ]
return cls(tokens)
- @property
- def condition(self):
- values = self.get_values(Token.ARGUMENT)
- if len(values) != 1:
- return ', '.join(values) if values else None
- return values[0]
-
- def validate(self, context):
- conditions = len(self.get_tokens(Token.ARGUMENT))
- if conditions == 0:
- self.errors += ('%s must have a condition.' % self.type,)
- if conditions > 1:
- self.errors += ('%s cannot have more than one condition.' % self.type,)
-
@Statement.register
-class InlineIfHeader(IfHeader):
+class InlineIfHeader(IfElseHeader):
type = Token.INLINE_IF
- @property
- def assign(self):
- return self.get_values(Token.ASSIGN)
+ @classmethod
+ def from_params(
+ cls,
+ condition: str,
+ assign: "Sequence[str]" = (),
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ ) -> "InlineIfHeader":
+ tokens = [Token(Token.SEPARATOR, indent)]
+ for assignment in assign:
+ tokens += [
+ Token(Token.ASSIGN, assignment),
+ Token(Token.SEPARATOR, separator),
+ ]
+ tokens += [
+ Token(Token.INLINE_IF),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, condition),
+ ]
+ return cls(tokens)
+
+ def validate(self, ctx: "ValidationContext"):
+ super().validate(ctx)
+ AssignmentValidator().validate(self)
@Statement.register
-class ElseIfHeader(IfHeader):
+class ElseIfHeader(IfElseHeader):
type = Token.ELSE_IF
+ @classmethod
+ def from_params(
+ cls,
+ condition: str,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "ElseIfHeader":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.ELSE_IF),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, condition),
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
+
@Statement.register
class ElseHeader(IfElseHeader):
type = Token.ELSE
@classmethod
- def from_params(cls, indent=FOUR_SPACES, eol=EOL):
- return cls([
+ def from_params(cls, indent: str = FOUR_SPACES, eol: str = EOL) -> "ElseHeader":
+ tokens = [
Token(Token.SEPARATOR, indent),
Token(Token.ELSE),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
- def validate(self, context):
+ def validate(self, ctx: "ValidationContext"):
if self.get_tokens(Token.ARGUMENT):
values = self.get_values(Token.ARGUMENT)
- self.errors += (f'ELSE does not accept arguments, got {seq2str(values)}.',)
+ self.errors += (f"ELSE does not accept arguments, got {seq2str(values)}.",)
-class NoArgumentHeader(Statement):
+class NoArgumentHeader(Statement, ABC):
@classmethod
- def from_params(cls, indent=FOUR_SPACES, eol=EOL):
- return cls([
+ def from_params(cls, indent: str = FOUR_SPACES, eol: str = EOL):
+ tokens = [
Token(Token.SEPARATOR, indent),
Token(cls.type),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
- def validate(self, context):
+ def validate(self, ctx: "ValidationContext"):
if self.get_tokens(Token.ARGUMENT):
- self.errors += (f'{self.type} does not accept arguments, got '
- f'{seq2str(self.values)}.',)
+ self.errors += (
+ f"{self.type} does not accept arguments, got {seq2str(self.values)}.",
+ )
@property
- def values(self):
+ def values(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@@ -917,48 +1338,70 @@ class TryHeader(NoArgumentHeader):
@Statement.register
class ExceptHeader(Statement):
type = Token.EXCEPT
+ options = {"type": ("GLOB", "REGEXP", "START", "LITERAL")}
@classmethod
- def from_params(cls, patterns=None, variable=None, indent=FOUR_SPACES,
- separator=FOUR_SPACES, eol=EOL):
- tokens = [
- Token(Token.SEPARATOR, indent),
- Token(Token.EXCEPT),
- Token(Token.SEPARATOR, separator)
- ]
+ def from_params(
+ cls,
+ patterns: "Sequence[str]" = (),
+ type: "str|None" = None,
+ assign: "str|None" = None,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "ExceptHeader":
+ tokens = [Token(Token.SEPARATOR, indent), Token(Token.EXCEPT)]
for pattern in patterns:
- tokens.append(pattern)
- tokens.append(Token(Token.SEPARATOR, separator))
- if variable:
- tokens.append(Token(Token.AS))
- tokens.append(Token(Token.SEPARATOR, separator))
- tokens.append(Token(Token.VARIABLE, variable))
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, pattern),
+ ]
+ if type:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"type={type}"),
+ ]
+ if assign:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.AS),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.VARIABLE, assign),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def patterns(self):
+ def patterns(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
@property
- def pattern_type(self):
- value = self.get_value(Token.OPTION)
- return value[len('type='):] if value else None
+ def pattern_type(self) -> "str|None":
+ return self.get_option("type")
@property
- def variable(self):
+ def assign(self) -> "str|None":
return self.get_value(Token.VARIABLE)
- def validate(self, context):
+ @property
+ def variable(self) -> "str|None": # TODO: Remove in RF 8.0.
+ warnings.warn(
+ "'ExceptHeader.variable' is deprecated and will be removed in "
+ "Robot Framework 8.0. Use 'ExceptHeader.assigns' instead."
+ )
+ return self.assign
+
+ def validate(self, ctx: "ValidationContext"):
as_token = self.get_token(Token.AS)
if as_token:
- variables = self.get_tokens(Token.VARIABLE)
- if not variables:
- self.errors += ("EXCEPT's AS requires variable.",)
- elif len(variables) > 1:
- self.errors += ("EXCEPT's AS accepts only one variable.",)
- elif not is_scalar_assign(variables[0].value):
- self.errors += (f"EXCEPT's AS variable '{variables[0].value}' is invalid.",)
+ assign = self.get_tokens(Token.VARIABLE)
+ if not assign:
+ self.errors += ("EXCEPT AS requires a value.",)
+ elif len(assign) > 1:
+ self.errors += ("EXCEPT AS accepts only one value.",)
+ elif not is_scalar_assign(assign[0].value):
+ self.errors += (f"EXCEPT AS variable '{assign[0].value}' is invalid.",)
+ self._validate_options()
@Statement.register
@@ -974,73 +1417,233 @@ class End(NoArgumentHeader):
@Statement.register
class WhileHeader(Statement):
type = Token.WHILE
+ options = {
+ "limit": None,
+ "on_limit": ("PASS", "FAIL"),
+ "on_limit_message": None,
+ }
@classmethod
- def from_params(cls, condition, limit=None, indent=FOUR_SPACES,
- separator=FOUR_SPACES, eol=EOL):
- tokens = [Token(Token.SEPARATOR, indent),
- Token(cls.type),
- Token(Token.SEPARATOR, separator),
- Token(Token.ARGUMENT, condition)]
+ def from_params(
+ cls,
+ condition: str,
+ limit: "str|None" = None,
+ on_limit: "str|None " = None,
+ on_limit_message: "str|None" = None,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "WhileHeader":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.WHILE),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, condition),
+ ]
if limit:
- tokens.extend([Token(Token.SEPARATOR, indent),
- Token(Token.OPTION, limit)])
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"limit={limit}"),
+ ]
+ if on_limit:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"on_limit={on_limit}"),
+ ]
+ if on_limit_message:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"on_limit_message={on_limit_message}"),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
@property
- def condition(self):
- return ', '.join(self.get_values(Token.ARGUMENT))
+ def condition(self) -> str:
+ return ", ".join(self.get_values(Token.ARGUMENT))
@property
- def limit(self):
- value = self.get_value(Token.OPTION)
- return value[len('limit='):] if value else None
+ def limit(self) -> "str|None":
+ return self.get_option("limit")
- def validate(self, context):
- values = self.get_values(Token.ARGUMENT)
- if len(values) == 0:
- self.errors += ('WHILE must have a condition.',)
- if len(values) == 2:
- self.errors += (f"Second WHILE loop argument must be 'limit', "
- f"got '{values[1]}'.",)
- if len(values) > 2:
- self.errors += ('WHILE cannot have more than one condition.',)
+ @property
+ def on_limit(self) -> "str|None":
+ return self.get_option("on_limit")
+
+ @property
+ def on_limit_message(self) -> "str|None":
+ return self.get_option("on_limit_message")
+
+ def validate(self, ctx: "ValidationContext"):
+ conditions = self.get_values(Token.ARGUMENT)
+ if len(conditions) > 1:
+ self.errors += (
+ f"WHILE accepts only one condition, got {len(conditions)} "
+ f"conditions {seq2str(conditions)}.",
+ )
+ if self.on_limit and not self.limit:
+ self.errors += ("WHILE option 'on_limit' cannot be used without 'limit'.",)
+ self._validate_options()
@Statement.register
-class ReturnStatement(Statement):
- type = Token.RETURN_STATEMENT
+class GroupHeader(Statement):
+ type = Token.GROUP
+
+ @classmethod
+ def from_params(
+ cls,
+ name: str = "",
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "GroupHeader":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.GROUP),
+ ]
+ if name:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, name),
+ ]
+ tokens += [Token(Token.EOL, eol)]
+ return cls(tokens)
@property
- def values(self):
+ def name(self) -> str:
+ return ", ".join(self.get_values(Token.ARGUMENT))
+
+ def validate(self, ctx: "ValidationContext"):
+ names = self.get_values(Token.ARGUMENT)
+ if len(names) > 1:
+ self.errors += (
+ f"GROUP accepts only one argument as name, got {len(names)} "
+ f"arguments {seq2str(names)}.",
+ )
+
+
+@Statement.register
+class Var(Statement):
+ type = Token.VAR
+ options = {
+ "scope": ("LOCAL", "TEST", "TASK", "SUITE", "SUITES", "GLOBAL"),
+ "separator": None,
+ }
+
+ @classmethod
+ def from_params(
+ cls,
+ name: str,
+ value: "str|Sequence[str]",
+ scope: "str|None" = None,
+ value_separator: "str|None" = None,
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Var":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.VAR),
+ Token(Token.SEPARATOR, separator),
+ Token(Token.VARIABLE, name),
+ ]
+ values = [value] if isinstance(value, str) else value
+ for value in values:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, value),
+ ]
+ if scope:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"scope={scope}"),
+ ]
+ if value_separator:
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.OPTION, f"separator={value_separator}"),
+ ]
+ tokens += [Token(Token.EOL, eol)]
+ return cls(tokens)
+
+ @property
+ def name(self) -> str:
+ name = self.get_value(Token.VARIABLE, "")
+ if name.endswith("="):
+ return name[:-1].rstrip()
+ return name
+
+ @property
+ def value(self) -> "tuple[str, ...]":
return self.get_values(Token.ARGUMENT)
+ @property
+ def scope(self) -> "str|None":
+ return self.get_option("scope")
+
+ @property
+ def separator(self) -> "str|None":
+ return self.get_option("separator")
+
+ def validate(self, ctx: "ValidationContext"):
+ VariableValidator().validate(self)
+ self._validate_options()
+
+
+@Statement.register
+class Return(Statement):
+ """Represents the RETURN statement.
+
+ This class named ``ReturnStatement`` prior to Robot Framework 7.0.
+ The old name still exists as a backwards compatible alias.
+ """
+
+ type = Token.RETURN_STATEMENT
+
@classmethod
- def from_params(cls, values=(), indent=FOUR_SPACES, separator=FOUR_SPACES, eol=EOL):
- tokens = [Token(Token.SEPARATOR, indent),
- Token(Token.RETURN_STATEMENT)]
+ def from_params(
+ cls,
+ values: "Sequence[str]" = (),
+ indent: str = FOUR_SPACES,
+ separator: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Return":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.RETURN_STATEMENT),
+ ]
for value in values:
- tokens.extend([Token(Token.SEPARATOR, separator),
- Token(Token.ARGUMENT, value)])
- tokens.append(Token(Token.EOL, eol))
+ tokens += [
+ Token(Token.SEPARATOR, separator),
+ Token(Token.ARGUMENT, value),
+ ]
+ tokens += [Token(Token.EOL, eol)]
return cls(tokens)
- def validate(self, context):
- if not context.in_keyword:
- self.errors += ('RETURN can only be used inside a user keyword.', )
- if context.in_keyword and context.in_finally:
- self.errors += ('RETURN cannot be used in FINALLY branch.', )
+ @property
+ def values(self) -> "tuple[str, ...]":
+ return self.get_values(Token.ARGUMENT)
+
+ def validate(self, ctx: "ValidationContext"):
+ if not ctx.in_keyword:
+ self.errors += ("RETURN can only be used inside a user keyword.",)
+ if ctx.in_finally:
+ self.errors += ("RETURN cannot be used in FINALLY branch.",)
+
+
+# Backwards compatibility with RF < 7.
+ReturnStatement = Return
-class LoopControl(NoArgumentHeader):
+class LoopControl(NoArgumentHeader, ABC):
- def validate(self, context):
- super(LoopControl, self).validate(context)
- if not (context.in_for or context.in_while):
- self.errors += (f'{self.type} can only be used inside a loop.', )
- if context.in_finally:
- self.errors += (f'{self.type} cannot be used in FINALLY branch.', )
+ def validate(self, ctx: "ValidationContext"):
+ super().validate(ctx)
+ if not ctx.in_loop:
+ self.errors += (f"{self.type} can only be used inside a loop.",)
+ if ctx.in_finally:
+ self.errors += (f"{self.type} cannot be used in FINALLY branch.",)
@Statement.register
@@ -1058,32 +1661,75 @@ class Comment(Statement):
type = Token.COMMENT
@classmethod
- def from_params(cls, comment, indent=FOUR_SPACES, eol=EOL):
- return cls([
+ def from_params(
+ cls,
+ comment: str,
+ indent: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Comment":
+ tokens = [
Token(Token.SEPARATOR, indent),
Token(Token.COMMENT, comment),
- Token(Token.EOL, eol)
- ])
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
+
+
+@Statement.register
+class Config(Statement):
+ type = Token.CONFIG
+
+ @classmethod
+ def from_params(cls, config: str, eol: str = EOL) -> "Config":
+ tokens = [
+ Token(Token.CONFIG, config),
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
+
+ @property
+ def language(self) -> "Language|None":
+ value = " ".join(self.get_values(Token.CONFIG))
+ lang = value.split(":", 1)[1].strip()
+ return Language.from_name(lang) if lang else None
@Statement.register
class Error(Statement):
type = Token.ERROR
- handles_types = (Token.ERROR, Token.FATAL_ERROR)
- _errors = ()
+ _errors: "tuple[str, ...]" = ()
+
+ @classmethod
+ def from_params(
+ cls,
+ error: str,
+ value: str = "",
+ indent: str = FOUR_SPACES,
+ eol: str = EOL,
+ ) -> "Error":
+ tokens = [
+ Token(Token.SEPARATOR, indent),
+ Token(Token.ERROR, value, error=error),
+ Token(Token.EOL, eol),
+ ]
+ return cls(tokens)
+
+ @property
+ def values(self) -> "list[str]":
+ return [token.value for token in self.data_tokens]
@property
- def errors(self):
- """Errors got from the underlying ``ERROR`` and ``FATAL_ERROR`` tokens.
+ def errors(self) -> "tuple[str, ...]":
+ """Errors got from the underlying ``ERROR``token.
Errors can be set also explicitly. When accessing errors, they are returned
along with errors got from tokens.
"""
- tokens = self.get_tokens(Token.ERROR, Token.FATAL_ERROR)
- return tuple(t.error for t in tokens) + self._errors
+ tokens = self.get_tokens(Token.ERROR)
+ return tuple(t.error or "" for t in tokens) + self._errors
@errors.setter
- def errors(self, errors):
+ def errors(self, errors: "Sequence[str]"):
self._errors = tuple(errors)
@@ -1091,5 +1737,47 @@ class EmptyLine(Statement):
type = Token.EOL
@classmethod
- def from_params(cls, eol=EOL):
+ def from_params(cls, eol: str = EOL):
return cls([Token(Token.EOL, eol)])
+
+
+class VariableValidator:
+
+ def validate(self, statement: Statement):
+ name = statement.get_value(Token.VARIABLE, "")
+ match = search_variable(name, ignore_errors=True, parse_type=True)
+ if not match.is_assign(allow_assign_mark=True, allow_nested=True):
+ statement.errors += (f"Invalid variable name '{name}'.",)
+ return
+ if match.identifier == "&":
+ self._validate_dict_items(statement)
+ try:
+ TypeInfo.from_variable(match)
+ except DataError as err:
+ statement.errors += (f"Invalid variable '{name}': {err}",)
+
+ def _validate_dict_items(self, statement: Statement):
+ for item in statement.get_values(Token.ARGUMENT):
+ if not self._is_valid_dict_item(item):
+ statement.errors += (
+ f"Invalid dictionary variable item '{item}'. Items must use "
+ f"'name=value' syntax or be dictionary variables themselves.",
+ )
+
+ def _is_valid_dict_item(self, item: str) -> bool:
+ name, value = split_from_equals(item)
+ return value is not None or is_dict_variable(item)
+
+
+class AssignmentValidator:
+
+ def validate(self, statement: Statement):
+ assignment = statement.get_values(Token.ASSIGN)
+ if assignment:
+ assignment = VariableAssignment(assignment)
+ statement.errors += assignment.errors
+ for variable in assignment:
+ try:
+ TypeInfo.from_variable(variable)
+ except DataError as err:
+ statement.errors += (f"Invalid variable '{variable}': {err}",)
diff --git a/src/robot/parsing/model/visitor.py b/src/robot/parsing/model/visitor.py
index 26306481742..1ac1bcc4176 100644
--- a/src/robot/parsing/model/visitor.py
+++ b/src/robot/parsing/model/visitor.py
@@ -13,43 +13,82 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import ast
+from ast import NodeTransformer, NodeVisitor
+from typing import Callable
+
+from .statements import Node
+
+# Unbound method and thus needs `NodeVisitor` as `self`.
+VisitorMethod = Callable[[NodeVisitor, Node], "None|Node|list[Node]"]
class VisitorFinder:
+ __visitor_cache: "dict[type[Node], VisitorMethod]"
+
+ def __init_subclass__(cls, **kwargs):
+ super().__init_subclass__(**kwargs)
+ cls.__visitor_cache = {}
+
+ @classmethod
+ def _find_visitor(cls, node_cls: "type[Node]") -> VisitorMethod:
+ if node_cls not in cls.__visitor_cache:
+ visitor = cls._find_visitor_from_class(node_cls)
+ cls.__visitor_cache[node_cls] = visitor or cls.generic_visit
+ return cls.__visitor_cache[node_cls]
- def _find_visitor(self, cls):
- if cls is ast.AST:
- return None
- method = 'visit_' + cls.__name__
- if hasattr(self, method):
- return getattr(self, method)
- for base in cls.__bases__:
- visitor = self._find_visitor(base)
- if visitor:
- return visitor
+ @classmethod
+ def _find_visitor_from_class(cls, node_cls: "type[Node]") -> "VisitorMethod|None":
+ method_name = "visit_" + node_cls.__name__
+ method = getattr(cls, method_name, None)
+ if callable(method):
+ return method
+ if method_name in ("visit_TestTags", "visit_Return"):
+ method = cls._backwards_compatibility(method_name)
+ if callable(method):
+ return method
+ for base in node_cls.__bases__:
+ if issubclass(base, Node):
+ method = cls._find_visitor_from_class(base)
+ if method:
+ return method
return None
+ @classmethod
+ def _backwards_compatibility(cls, method_name):
+ name = {
+ "visit_TestTags": "visit_ForceTags",
+ "visit_Return": "visit_ReturnStatement",
+ }[method_name]
+ return getattr(cls, name, None)
-class ModelVisitor(ast.NodeVisitor, VisitorFinder):
+ def generic_visit(self, node: Node) -> "None|Node|list[Node]":
+ raise NotImplementedError
+
+
+class ModelVisitor(NodeVisitor, VisitorFinder):
"""NodeVisitor that supports matching nodes based on their base classes.
- Otherwise identical to the standard `ast.NodeVisitor
+ The biggest difference compared to the standard `ast.NodeVisitor
`__,
- but allows creating ``visit_ClassName`` methods so that the ``ClassName``
- is one of the base classes of the node. For example, this visitor method
- matches all statements::
+ is that this class allows creating ``visit_ClassName`` methods so that
+ the ``ClassName`` is one of the base classes of the node. For example,
+ the following visitor method matches all node classes that extend
+ ``Statement``::
def visit_Statement(self, node):
- # ...
+ ...
+
+ Another difference is that visitor methods are cached for performance
+ reasons. This means that dynamically adding ``visit_Something`` methods
+ does not work.
"""
- def visit(self, node):
- visitor = self._find_visitor(type(node)) or self.generic_visit
- visitor(node)
+ def visit(self, node: Node) -> None:
+ visitor_method = self._find_visitor(type(node))
+ visitor_method(self, node)
-class ModelTransformer(ast.NodeTransformer, VisitorFinder):
+class ModelTransformer(NodeTransformer, VisitorFinder):
"""NodeTransformer that supports matching nodes based on their base classes.
See :class:`ModelVisitor` for explanation how this is different compared
@@ -57,6 +96,6 @@ class ModelTransformer(ast.NodeTransformer, VisitorFinder):
`__.
"""
- def visit(self, node):
- visitor = self._find_visitor(type(node)) or self.generic_visit
- return visitor(node)
+ def visit(self, node: Node) -> "None|Node|list[Node]":
+ visitor_method = self._find_visitor(type(node))
+ return visitor_method(self, node)
diff --git a/src/robot/parsing/parser/__init__.py b/src/robot/parsing/parser/__init__.py
index b6be536be1d..40fcfaeb1a6 100644
--- a/src/robot/parsing/parser/__init__.py
+++ b/src/robot/parsing/parser/__init__.py
@@ -13,4 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .parser import get_model, get_resource_model, get_init_model
+from .parser import (
+ get_init_model as get_init_model,
+ get_model as get_model,
+ get_resource_model as get_resource_model,
+)
diff --git a/src/robot/parsing/parser/blockparsers.py b/src/robot/parsing/parser/blockparsers.py
index 82a2fb85b4f..16ae47dd6f4 100644
--- a/src/robot/parsing/parser/blockparsers.py
+++ b/src/robot/parsing/parser/blockparsers.py
@@ -13,44 +13,53 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC, abstractmethod
+
from ..lexer import Token
-from ..model import TestCase, Keyword, For, If, Try, While
+from ..model import (
+ Block, Container, End, For, Group, If, Keyword, NestedBlock, Statement, TestCase,
+ Try, While
+)
-class Parser:
- """Base class for parsers."""
+class Parser(ABC):
+ model: Container
- def __init__(self, model):
+ def __init__(self, model: Container):
self.model = model
- def handles(self, statement):
+ @abstractmethod
+ def handles(self, statement: Statement) -> bool:
raise NotImplementedError
- def parse(self, statement):
+ @abstractmethod
+ def parse(self, statement: Statement) -> "Parser|None":
raise NotImplementedError
-class BlockParser(Parser):
- unhandled_tokens = Token.HEADER_TOKENS | frozenset((Token.TESTCASE_NAME,
- Token.KEYWORD_NAME))
+class BlockParser(Parser, ABC):
+ model: Block
+ unhandled_tokens = Token.HEADER_TOKENS | {Token.TESTCASE_NAME, Token.KEYWORD_NAME}
- def __init__(self, model):
- Parser.__init__(self, model)
- self.nested_parsers = {
+ def __init__(self, model: Block):
+ super().__init__(model)
+ self.parsers: "dict[str, type[NestedBlockParser]]" = {
Token.FOR: ForParser,
+ Token.WHILE: WhileParser,
Token.IF: IfParser,
Token.INLINE_IF: IfParser,
Token.TRY: TryParser,
- Token.WHILE: WhileParser
+ Token.GROUP: GroupParser,
}
- def handles(self, statement):
+ def handles(self, statement: Statement) -> bool:
return statement.type not in self.unhandled_tokens
- def parse(self, statement):
- parser_class = self.nested_parsers.get(statement.type)
+ def parse(self, statement: Statement) -> "BlockParser|None":
+ parser_class = self.parsers.get(statement.type)
if parser_class:
- parser = parser_class(statement)
+ model_class = parser_class.__annotations__["model"]
+ parser = parser_class(model_class(statement))
self.model.body.append(parser.model)
return parser
self.model.body.append(statement)
@@ -58,75 +67,63 @@ def parse(self, statement):
class TestCaseParser(BlockParser):
-
- def __init__(self, header):
- BlockParser.__init__(self, TestCase(header))
+ model: TestCase
class KeywordParser(BlockParser):
+ model: Keyword
- def __init__(self, header):
- BlockParser.__init__(self, Keyword(header))
+class NestedBlockParser(BlockParser, ABC):
+ model: NestedBlock
-class NestedBlockParser(BlockParser):
-
- def handles(self, statement):
- return BlockParser.handles(self, statement) and \
- not getattr(self.model, 'end', False)
+ def __init__(self, model: NestedBlock, handle_end: bool = True):
+ super().__init__(model)
+ self.handle_end = handle_end
- def parse(self, statement):
+ def handles(self, statement: Statement) -> bool:
+ if self.model.end:
+ return False
if statement.type == Token.END:
+ return self.handle_end
+ return super().handles(statement)
+
+ def parse(self, statement: Statement) -> "BlockParser|None":
+ if isinstance(statement, End):
self.model.end = statement
return None
- return BlockParser.parse(self, statement)
+ return super().parse(statement)
class ForParser(NestedBlockParser):
+ model: For
- def __init__(self, header):
- NestedBlockParser.__init__(self, For(header))
+class WhileParser(NestedBlockParser):
+ model: While
-class IfParser(NestedBlockParser):
- def __init__(self, header, handle_end=True):
- super().__init__(If(header))
- self.handle_end = handle_end
+class GroupParser(NestedBlockParser):
+ model: Group
+
+
+class IfParser(NestedBlockParser):
+ model: If
- def parse(self, statement):
+ def parse(self, statement: Statement) -> "BlockParser|None":
if statement.type in (Token.ELSE_IF, Token.ELSE):
- parser = IfParser(statement, handle_end=False)
+ parser = IfParser(If(statement), handle_end=False)
self.model.orelse = parser.model
return parser
- return NestedBlockParser.parse(self, statement)
-
- def handles(self, statement):
- if statement.type == Token.END and not self.handle_end:
- return False
- return super().handles(statement)
+ return super().parse(statement)
class TryParser(NestedBlockParser):
+ model: Try
- def __init__(self, header, handle_end=True):
- super().__init__(Try(header))
- self.handle_end = handle_end
-
- def parse(self, statement):
+ def parse(self, statement) -> "BlockParser|None":
if statement.type in (Token.EXCEPT, Token.ELSE, Token.FINALLY):
- parser = TryParser(statement, handle_end=False)
+ parser = TryParser(Try(statement), handle_end=False)
self.model.next = parser.model
return parser
return super().parse(statement)
-
- def handles(self, statement):
- if statement.type == Token.END and not self.handle_end:
- return False
- return super().handles(statement)
-
-
-class WhileParser(NestedBlockParser):
-
- def __init__(self, header):
- super().__init__(While(header))
diff --git a/src/robot/parsing/parser/fileparser.py b/src/robot/parsing/parser/fileparser.py
index 7ca2241c5cd..b17d5e793fa 100644
--- a/src/robot/parsing/parser/fileparser.py
+++ b/src/robot/parsing/parser/fileparser.py
@@ -13,99 +13,109 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import os.path
+from pathlib import Path
-from robot.utils import is_pathlike, is_string
+from robot.utils import Source
from ..lexer import Token
-from ..model import (File, CommentSection, SettingSection, VariableSection,
- TestCaseSection, KeywordSection)
-
-from .blockparsers import Parser, TestCaseParser, KeywordParser
+from ..model import (
+ CommentSection, File, ImplicitCommentSection, InvalidSection, Keyword,
+ KeywordSection, Section, SettingSection, Statement, TestCase, TestCaseSection,
+ VariableSection
+)
+from .blockparsers import KeywordParser, Parser, TestCaseParser
class FileParser(Parser):
+ model: File
- def __init__(self, source=None):
- Parser.__init__(self, File(source=self._get_path(source)))
-
- def _get_path(self, source):
- if not source:
- return None
- if is_string(source) and '\n' not in source and os.path.isfile(source):
- return source
- if is_pathlike(source) and source.is_file():
- return str(source)
- return None
-
- def handles(self, statement):
- return True
-
- def parse(self, statement):
- parser_class = {
+ def __init__(self, source: "Source|None" = None):
+ super().__init__(File(source=self._get_path(source)))
+ self.parsers: "dict[str, type[SectionParser]]" = {
Token.SETTING_HEADER: SettingSectionParser,
Token.VARIABLE_HEADER: VariableSectionParser,
Token.TESTCASE_HEADER: TestCaseSectionParser,
+ Token.TASK_HEADER: TestCaseSectionParser,
Token.KEYWORD_HEADER: KeywordSectionParser,
Token.COMMENT_HEADER: CommentSectionParser,
+ Token.INVALID_HEADER: InvalidSectionParser,
+ Token.CONFIG: ImplicitCommentSectionParser,
Token.COMMENT: ImplicitCommentSectionParser,
Token.ERROR: ImplicitCommentSectionParser,
- Token.EOL: ImplicitCommentSectionParser
- }[statement.type]
- parser = parser_class(statement)
+ Token.EOL: ImplicitCommentSectionParser,
+ }
+
+ def _get_path(self, source: "Source|None") -> "Path|None":
+ if not source:
+ return None
+ if isinstance(source, str) and "\n" not in source:
+ source = Path(source)
+ try:
+ if isinstance(source, Path) and source.is_file():
+ return source
+ except OSError: # Can happen on Windows w/ Python < 3.10.
+ pass
+ return None
+
+ def handles(self, statement: Statement) -> bool:
+ return True
+
+ def parse(self, statement: Statement) -> "SectionParser":
+ parser_class = self.parsers[statement.type]
+ model_class: "type[Section]" = parser_class.__annotations__["model"]
+ parser = parser_class(model_class(statement))
self.model.sections.append(parser.model)
return parser
class SectionParser(Parser):
- model_class = None
+ model: Section
- def __init__(self, header):
- Parser.__init__(self, self.model_class(header))
-
- def handles(self, statement):
+ def handles(self, statement: Statement) -> bool:
return statement.type not in Token.HEADER_TOKENS
- def parse(self, statement):
+ def parse(self, statement: Statement) -> "Parser|None":
self.model.body.append(statement)
return None
class SettingSectionParser(SectionParser):
- model_class = SettingSection
+ model: SettingSection
class VariableSectionParser(SectionParser):
- model_class = VariableSection
+ model: VariableSection
class CommentSectionParser(SectionParser):
- model_class = CommentSection
+ model: CommentSection
class ImplicitCommentSectionParser(SectionParser):
+ model: ImplicitCommentSection
+
- def model_class(self, statement):
- return CommentSection(body=[statement])
+class InvalidSectionParser(SectionParser):
+ model: InvalidSection
class TestCaseSectionParser(SectionParser):
- model_class = TestCaseSection
+ model: TestCaseSection
- def parse(self, statement):
+ def parse(self, statement: Statement) -> "Parser|None":
if statement.type == Token.TESTCASE_NAME:
- parser = TestCaseParser(statement)
+ parser = TestCaseParser(TestCase(statement))
self.model.body.append(parser.model)
return parser
- return SectionParser.parse(self, statement)
+ return super().parse(statement)
class KeywordSectionParser(SectionParser):
- model_class = KeywordSection
+ model: KeywordSection
- def parse(self, statement):
+ def parse(self, statement: Statement) -> "Parser|None":
if statement.type == Token.KEYWORD_NAME:
- parser = KeywordParser(statement)
+ parser = KeywordParser(Keyword(statement))
self.model.body.append(parser.model)
return parser
- return SectionParser.parse(self, statement)
+ return super().parse(statement)
diff --git a/src/robot/parsing/parser/parser.py b/src/robot/parsing/parser/parser.py
index 3d82652d7d5..56b120a16fc 100644
--- a/src/robot/parsing/parser/parser.py
+++ b/src/robot/parsing/parser/parser.py
@@ -13,14 +13,24 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from ..lexer import Token, get_tokens, get_resource_tokens, get_init_tokens
-from ..model import Statement
+from typing import Callable, Iterator
+from robot.conf import LanguagesLike
+from robot.utils import Source
+
+from ..lexer import get_init_tokens, get_resource_tokens, get_tokens, Token
+from ..model import Config, File, ModelVisitor, Statement
+from .blockparsers import Parser
from .fileparser import FileParser
-def get_model(source, data_only=False, curdir=None):
- """Parses the given source to a model represented as an AST.
+def get_model(
+ source: Source,
+ data_only: bool = False,
+ curdir: "str|None" = None,
+ lang: LanguagesLike = None,
+) -> File:
+ """Parses the given source into a model represented as an AST.
How to use the model is explained more thoroughly in the general
documentation of the :mod:`robot.parsing` module.
@@ -36,48 +46,73 @@ def get_model(source, data_only=False, curdir=None):
:param curdir: Directory where the source file exists. This path is used
to set the value of the built-in ``${CURDIR}`` variable during parsing.
When not given, the variable is left as-is. Should only be given
- only if the model will be executed afterwards. If the model is saved
+ only if the model will be executed afterward. If the model is saved
back to disk, resolving ``${CURDIR}`` is typically not a good idea.
+ :param lang: Additional languages to be supported during parsing.
+ Can be a string matching any of the supported language codes or names,
+ an initialized :class:`~robot.conf.languages.Language` subclass,
+ a list containing such strings or instances, or a
+ :class:`~robot.conf.languages.Languages` instance.
Use :func:`get_resource_model` or :func:`get_init_model` when parsing
resource or suite initialization files, respectively.
"""
- return _get_model(get_tokens, source, data_only, curdir)
+ return _get_model(get_tokens, source, data_only, curdir, lang)
-def get_resource_model(source, data_only=False, curdir=None):
- """Parses the given source to a resource file model.
+def get_resource_model(
+ source: Source,
+ data_only: bool = False,
+ curdir: "str|None" = None,
+ lang: LanguagesLike = None,
+) -> File:
+ """Parses the given source into a resource file model.
- Otherwise same as :func:`get_model` but the source is considered to be
+ Same as :func:`get_model` otherwise, but the source is considered to be
a resource file. This affects, for example, what settings are valid.
"""
- return _get_model(get_resource_tokens, source, data_only, curdir)
+ return _get_model(get_resource_tokens, source, data_only, curdir, lang)
-def get_init_model(source, data_only=False, curdir=None):
- """Parses the given source to a init file model.
+def get_init_model(
+ source: Source,
+ data_only: bool = False,
+ curdir: "str|None" = None,
+ lang: LanguagesLike = None,
+) -> File:
+ """Parses the given source into an init file model.
- Otherwise same as :func:`get_model` but the source is considered to be
+ Same as :func:`get_model` otherwise, but the source is considered to be
a suite initialization file. This affects, for example, what settings are
valid.
"""
- return _get_model(get_init_tokens, source, data_only, curdir)
+ return _get_model(get_init_tokens, source, data_only, curdir, lang)
-def _get_model(token_getter, source, data_only=False, curdir=None):
- tokens = token_getter(source, data_only)
+def _get_model(
+ token_getter: Callable[..., Iterator[Token]],
+ source: Source,
+ data_only: bool,
+ curdir: "str|None",
+ lang: LanguagesLike,
+):
+ tokens = token_getter(source, data_only, lang=lang)
statements = _tokens_to_statements(tokens, curdir)
model = _statements_to_model(statements, source)
+ ConfigParser.parse(model)
model.validate_model()
return model
-def _tokens_to_statements(tokens, curdir=None):
+def _tokens_to_statements(
+ tokens: Iterator[Token],
+ curdir: "str|None",
+) -> Iterator[Statement]:
statement = []
EOS = Token.EOS
for t in tokens:
- if curdir and '${CURDIR}' in t.value:
- t.value = t.value.replace('${CURDIR}', curdir)
+ if curdir and "${CURDIR}" in t.value:
+ t.value = t.value.replace("${CURDIR}", curdir)
if t.type != EOS:
statement.append(t)
else:
@@ -85,14 +120,30 @@ def _tokens_to_statements(tokens, curdir=None):
statement = []
-def _statements_to_model(statements, source=None):
- parser = FileParser(source=source)
- model = parser.model
- stack = [parser]
+def _statements_to_model(statements: Iterator[Statement], source: Source) -> File:
+ root = FileParser(source=source)
+ stack: "list[Parser]" = [root]
for statement in statements:
while not stack[-1].handles(statement):
stack.pop()
parser = stack[-1].parse(statement)
if parser:
stack.append(parser)
- return model
+ return root.model
+
+
+class ConfigParser(ModelVisitor):
+
+ def __init__(self, model: File):
+ self.model = model
+
+ @classmethod
+ def parse(cls, model: File):
+ # Only implicit comment sections can contain configs. They have no header.
+ if model.sections and model.sections[0].header is None:
+ cls(model).visit(model.sections[0])
+
+ def visit_Config(self, node: Config):
+ language = node.language
+ if language:
+ self.model.languages.append(language.code)
diff --git a/src/robot/parsing/suitestructure.py b/src/robot/parsing/suitestructure.py
index f422855e1e5..619da460930 100644
--- a/src/robot/parsing/suitestructure.py
+++ b/src/robot/parsing/suitestructure.py
@@ -13,161 +13,243 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import fnmatch
import os.path
+import re
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Iterable, Iterator, Sequence
from robot.errors import DataError
-from robot.model import SuiteNamePatterns
from robot.output import LOGGER
-from robot.utils import abspath, get_error_message, safe_str
-
-
-class SuiteStructure:
-
- def __init__(self, source=None, init_file=None, children=None):
+from robot.utils import get_error_message
+
+
+class SuiteStructure(ABC):
+ source: "Path|None"
+ init_file: "Path|None"
+ children: "list[SuiteStructure]|None"
+
+ def __init__(
+ self,
+ extensions: "ValidExtensions",
+ source: "Path|None",
+ init_file: "Path|None" = None,
+ children: "Sequence[SuiteStructure]|None" = None,
+ ):
+ self._extensions = extensions
self.source = source
self.init_file = init_file
- self.children = children
- self.extension = self._get_extension(source, init_file)
-
- def _get_extension(self, source, init_file):
- if self.is_directory and not init_file:
- return None
- source = init_file or source
- return os.path.splitext(source)[1][1:].lower()
+ self.children = list(children) if children is not None else None
@property
- def is_directory(self):
- return self.children is not None
+ def extension(self) -> "str|None":
+ source = self._get_source_file()
+ return self._extensions.get_extension(source) if source else None
- def visit(self, visitor):
- if self.children is None:
- visitor.visit_file(self)
- else:
- visitor.visit_directory(self)
+ @abstractmethod
+ def _get_source_file(self) -> "Path|None":
+ raise NotImplementedError
+ @abstractmethod
+ def visit(self, visitor: "SuiteStructureVisitor"):
+ raise NotImplementedError
-class SuiteStructureBuilder:
- ignored_prefixes = ('_', '.')
- ignored_dirs = ('CVS',)
- def __init__(self, included_extensions=('robot',), included_suites=None):
- self.included_extensions = included_extensions
- self.included_suites = included_suites
+class SuiteFile(SuiteStructure):
+ source: Path
- def build(self, paths):
- paths = list(self._normalize_paths(paths))
- if len(paths) == 1:
- return self._build(paths[0], self.included_suites)
- children = [self._build(p, self.included_suites) for p in paths]
- return SuiteStructure(children=children)
+ def __init__(self, extensions: "ValidExtensions", source: Path):
+ super().__init__(extensions, source)
- def _normalize_paths(self, paths):
- if not paths:
- raise DataError('One or more source paths required.')
- for path in paths:
- path = os.path.normpath(path)
- if not os.path.exists(path):
- raise DataError("Parsing '%s' failed: File or directory to "
- "execute does not exist." % path)
- yield abspath(path)
-
- def _build(self, path, include_suites):
- if os.path.isfile(path):
- return SuiteStructure(path)
- include_suites = self._get_include_suites(path, include_suites)
- init_file, paths = self._get_child_paths(path, include_suites)
- children = [self._build(p, include_suites) for p in paths]
- return SuiteStructure(path, init_file, children)
-
- def _get_include_suites(self, path, incl_suites):
- if not incl_suites:
- return None
- if not isinstance(incl_suites, SuiteNamePatterns):
- incl_suites = SuiteNamePatterns(
- self._create_included_suites(incl_suites))
- # If a directory is included, also all its children should be included.
- if self._is_in_included_suites(os.path.basename(path), incl_suites):
- return None
- return incl_suites
-
- def _create_included_suites(self, incl_suites):
- for suite in incl_suites:
- yield suite
- while '.' in suite:
- suite = suite.split('.', 1)[1]
- yield suite
-
- def _get_child_paths(self, dirpath, incl_suites=None):
- init_file = None
- paths = []
- for path, is_init_file in self._list_dir(dirpath, incl_suites):
- if is_init_file:
- if not init_file:
- init_file = path
- else:
- LOGGER.error("Ignoring second test suite init file '%s'."
- % path)
- else:
- paths.append(path)
- return init_file, paths
+ def _get_source_file(self) -> Path:
+ return self.source
- def _list_dir(self, dir_path, incl_suites):
- try:
- names = os.listdir(dir_path)
- except:
- raise DataError("Reading directory '%s' failed: %s"
- % (dir_path, get_error_message()))
- for name in sorted(names, key=lambda item: item.lower()):
- name = safe_str(name) # Handles NFC normalization on OSX
- path = os.path.join(dir_path, name)
- base, ext = os.path.splitext(name)
- ext = ext[1:].lower()
- if self._is_init_file(path, base, ext):
- yield path, True
- elif self._is_included(path, base, ext, incl_suites):
- yield path, False
- else:
- LOGGER.info("Ignoring file or directory '%s'." % path)
+ def visit(self, visitor: "SuiteStructureVisitor"):
+ visitor.visit_file(self)
- def _is_init_file(self, path, base, ext):
- return (base.lower() == '__init__'
- and ext in self.included_extensions
- and os.path.isfile(path))
- def _is_included(self, path, base, ext, incl_suites):
- if base.startswith(self.ignored_prefixes):
- return False
- if os.path.isdir(path):
- return base not in self.ignored_dirs or ext
- if ext not in self.included_extensions:
- return False
- return self._is_in_included_suites(base, incl_suites)
+class SuiteDirectory(SuiteStructure):
+ children: "list[SuiteStructure]"
- def _is_in_included_suites(self, name, incl_suites):
- if not incl_suites:
- return True
- return incl_suites.match(self._split_prefix(name))
+ def __init__(
+ self,
+ extensions: "ValidExtensions",
+ source: "Path|None" = None,
+ init_file: "Path|None" = None,
+ children: Sequence[SuiteStructure] = (),
+ ):
+ super().__init__(extensions, source, init_file, children)
+
+ def _get_source_file(self) -> "Path|None":
+ return self.init_file
+
+ @property
+ def is_multi_source(self) -> bool:
+ return self.source is None
- def _split_prefix(self, name):
- result = name.split('__', 1)[-1]
- if result:
- return result
- return name
+ def add(self, child: "SuiteStructure"):
+ self.children.append(child)
+
+ def visit(self, visitor: "SuiteStructureVisitor"):
+ visitor.visit_directory(self)
class SuiteStructureVisitor:
- def visit_file(self, structure):
+ def visit_file(self, structure: SuiteFile):
pass
- def visit_directory(self, structure):
+ def visit_directory(self, structure: SuiteDirectory):
self.start_directory(structure)
for child in structure.children:
child.visit(self)
self.end_directory(structure)
- def start_directory(self, structure):
+ def start_directory(self, structure: SuiteDirectory):
pass
- def end_directory(self, structure):
+ def end_directory(self, structure: SuiteDirectory):
pass
+
+
+class SuiteStructureBuilder:
+ ignored_prefixes = ("_", ".")
+ ignored_dirs = ("CVS",)
+
+ def __init__(
+ self,
+ extensions: Sequence[str] = (".robot", ".rbt", ".robot.rst"),
+ included_files: Sequence[str] = (),
+ ):
+ self.extensions = ValidExtensions(extensions, included_files)
+ self.included_files = IncludedFiles(included_files)
+
+ def build(self, *paths: Path) -> SuiteStructure:
+ if len(paths) == 1:
+ return self._build(paths[0])
+ return self._build_multi_source(paths)
+
+ def _build(self, path: Path) -> SuiteStructure:
+ if path.is_file():
+ return SuiteFile(self.extensions, path)
+ return self._build_directory(path)
+
+ def _build_directory(self, path: Path) -> SuiteStructure:
+ structure = SuiteDirectory(self.extensions, path)
+ for item in self._list_dir(path):
+ if self._is_init_file(item):
+ if structure.init_file:
+ # TODO: This error should fail parsing for good.
+ LOGGER.error(f"Ignoring second test suite init file '{item}'.")
+ else:
+ structure.init_file = item
+ elif self._is_included(item):
+ structure.add(self._build(item))
+ else:
+ LOGGER.info(f"Ignoring file or directory '{item}'.")
+ return structure
+
+ def _list_dir(self, path: Path) -> "list[Path]":
+ try:
+ return sorted(path.iterdir(), key=lambda p: p.name.lower())
+ except OSError:
+ raise DataError(f"Reading directory '{path}' failed: {get_error_message()}")
+
+ def _is_init_file(self, path: Path) -> bool:
+ return (
+ path.stem.lower() == "__init__"
+ and self.extensions.match(path)
+ and path.is_file()
+ )
+
+ def _is_included(self, path: Path) -> bool:
+ if path.name.startswith(self.ignored_prefixes):
+ return False
+ if path.is_dir():
+ return path.name not in self.ignored_dirs
+ if not path.is_file():
+ return False
+ if not self.extensions.match(path):
+ return False
+ return self.included_files.match(path)
+
+ def _build_multi_source(self, paths: Iterable[Path]) -> SuiteStructure:
+ structure = SuiteDirectory(self.extensions)
+ for path in paths:
+ if self._is_init_file(path):
+ if structure.init_file:
+ raise DataError("Multiple init files not allowed.")
+ structure.init_file = path
+ else:
+ structure.add(self._build(path))
+ return structure
+
+
+class ValidExtensions:
+
+ def __init__(self, extensions: Sequence[str], included_files: Sequence[str] = ()):
+ self.extensions = {ext.lstrip(".").lower() for ext in extensions}
+ for pattern in included_files:
+ ext = os.path.splitext(pattern)[1]
+ if ext:
+ self.extensions.add(ext.lstrip(".").lower())
+
+ def match(self, path: Path) -> bool:
+ return any(ext in self.extensions for ext in self._extensions_from(path))
+
+ def get_extension(self, path: Path) -> str:
+ for ext in self._extensions_from(path):
+ if ext in self.extensions:
+ return ext
+ return path.suffix.lower()[1:]
+
+ def _extensions_from(self, path: Path) -> Iterator[str]:
+ suffixes = path.suffixes
+ while suffixes:
+ yield "".join(suffixes).lower()[1:]
+ suffixes.pop(0)
+
+
+class IncludedFiles:
+
+ def __init__(self, patterns: "Sequence[str|Path]" = ()):
+ self.patterns = [self._compile(i) for i in patterns]
+
+ def _compile(self, pattern: "str|Path") -> "re.Pattern":
+ pattern = self._dir_to_recursive(self._path_to_abs(self._normalize(pattern)))
+ # Handle recursive glob patterns.
+ parts = [self._translate(p) for p in pattern.split("**")]
+ return re.compile(".*".join(parts), re.IGNORECASE)
+
+ def _normalize(self, pattern: "str|Path") -> str:
+ if isinstance(pattern, Path):
+ pattern = str(pattern)
+ return os.path.normpath(pattern).replace("\\", "/")
+
+ def _path_to_abs(self, pattern: str) -> str:
+ if "/" in pattern or "." not in pattern or os.path.exists(pattern):
+ pattern = os.path.abspath(pattern).replace("\\", "/")
+ return pattern
+
+ def _dir_to_recursive(self, pattern: str) -> str:
+ if "." not in os.path.basename(pattern) or os.path.isdir(pattern):
+ pattern += "/**"
+ return pattern
+
+ def _translate(self, glob_pattern: str) -> str:
+ # `fnmatch.translate` returns pattern in format `(?s:)\Z` but we want
+ # only the `` part. This is a bit risky because the format may change
+ # in future Python versions, but we have tests and ought to notice that.
+ re_pattern = fnmatch.translate(glob_pattern)[4:-3]
+ # Unlike `fnmatch`, we want `*` to match only a single path segment.
+ return re_pattern.replace(".*", "[^/]*")
+
+ def match(self, path: Path) -> bool:
+ if not self.patterns:
+ return True
+ return self._match(path.name) or self._match(str(path))
+
+ def _match(self, path: str) -> bool:
+ path = self._normalize(path)
+ return any(p.fullmatch(path) for p in self.patterns)
diff --git a/src/robot/pythonpathsetter.py b/src/robot/pythonpathsetter.py
index 930fc7cb783..a58427e5e2a 100644
--- a/src/robot/pythonpathsetter.py
+++ b/src/robot/pythonpathsetter.py
@@ -13,29 +13,21 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Module that adds directories needed by Robot to sys.path when imported."""
+"""Modifies `sys.path` if Robot Framework's entry points are run as scripts.
-import sys
-import fnmatch
-from os.path import abspath, dirname
-
-ROBOTDIR = dirname(abspath(__file__))
+When, for example, `robot/run.py` or `robot/libdoc.py` is executed as a script,
+the `robot` directory is in `sys.path` but its parent directory is not.
+Importing this module adds the parent directory to `sys.path` to make it
+possible to import the `robot` module. The `robot` directory itself is removed
+to prevent importing internal modules directly.
-def add_path(path, end=False):
- if not end:
- remove_path(path)
- sys.path.insert(0, path)
- elif not any(fnmatch.fnmatch(p, path) for p in sys.path):
- sys.path.append(path)
+Does nothing if the `robot` module is already imported.
+"""
-def remove_path(path):
- sys.path = [p for p in sys.path if not fnmatch.fnmatch(p, path)]
+import sys
+from pathlib import Path
-# When, for example, robot/run.py is executed as a script, the directory
-# containing the robot module is not added to sys.path automatically but
-# the robot directory itself is. Former is added to allow importing
-# the module and the latter removed to prevent accidentally importing
-# internal modules directly.
-add_path(dirname(ROBOTDIR))
-remove_path(ROBOTDIR)
+def set_pythonpath():
+ robot_dir = Path(__file__).absolute().parent # zipsafe
+ sys.path = [str(robot_dir.parent)] + [p for p in sys.path if Path(p) != robot_dir]
diff --git a/src/robot/rebot.py b/src/robot/rebot.py
index ddf3508d142..a25c63535c4 100755
--- a/src/robot/rebot.py
+++ b/src/robot/rebot.py
@@ -32,18 +32,17 @@
import sys
-# Allows running as a script. __name__ check needed with multiprocessing:
-# https://github.com/robotframework/robotframework/issues/1137
-if 'robot' not in sys.modules and __name__ == '__main__':
- import pythonpathsetter
+if __name__ == "__main__" and "robot" not in sys.modules:
+ from pythonpathsetter import set_pythonpath
+
+ set_pythonpath()
from robot.conf import RebotSettings
from robot.errors import DataError
-from robot.reporting import ResultWriter
from robot.output import LOGGER
-from robot.utils import Application
+from robot.reporting import ResultWriter
from robot.run import RobotFramework
-
+from robot.utils import Application
USAGE = """Rebot -- Robot Framework report and log generator
@@ -124,7 +123,6 @@
--processemptysuite Processes output also if the top level suite is
empty. Useful e.g. with --include/--exclude when it
is not an error that there are no matches.
- Use --skiponfailure when starting execution instead.
-d --outputdir dir Where to create output files. The default is the
directory where Rebot is run from and the given path
is considered relative to that unless it is absolute.
@@ -132,6 +130,8 @@
specified. Given path, similarly as paths given to
--log, --report and --xunit, is relative to
--outputdir unless given as an absolute path.
+ --legacyoutput Create XML output file in format compatible with
+ Robot Framework 6.x and earlier.
-l --log file HTML log file. Can be disabled by giving a special
name `NONE`. Default: log.html
Examples: `--log mylog.html`, `-l none`
@@ -183,7 +183,6 @@
pattern. Documentation is shown in `Test Details` and
also as a tooltip in `Statistics by Tag`. Pattern can
use `*`, `?` and `[]` as wildcards like --test.
- Documentation can contain formatting like --doc.
Examples: --tagdoc mytag:Example
--tagdoc "owner-*:Original author"
--tagstatlink pattern:link:title * Add external links into `Statistics by
@@ -206,8 +205,8 @@
all: remove data from all keywords
passed: remove data only from keywords in passed
test cases and suites
- for: remove passed iterations from for loops
- while: remove passed iterations from while loops
+ for: remove passed iterations from FOR loops
+ while: remove passed iterations from WHILE loops
wuks: remove all but the last failing keyword
inside `BuiltIn.Wait Until Keyword Succeeds`
name:: remove data from keywords that match
@@ -262,6 +261,9 @@
on: always use colors
ansi: like `on` but use ANSI colors also on Windows
off: disable colors altogether
+ --consolelinks auto|off Control making paths to results files hyperlinks.
+ auto: use links when colors are enabled (default)
+ off: disable links unconditionally
-P --pythonpath path * Additional locations to add to the module search path
that is used when importing Python based extensions.
-A --argumentfile path * Text file to read more arguments from. File can have
@@ -287,11 +289,9 @@
`--merge --merge --nomerge --nostatusrc --statusrc` would not activate the
merge mode and would return a normal return code.
-Long option format is case-insensitive. For example, --SuiteStatLevel is
-equivalent to but easier to read than --suitestatlevel. Long options can
-also be shortened as long as they are unique. For example, `--logti Title`
-works while `--lo log.html` does not because the former matches only --logtitle
-but the latter matches both --log and --logtitle.
+Long option names are case and hyphen insensitive. For example, --TagStatLink
+and --tag-stat-link are equivalent to, but easier to read than, --tagstatlink.
+Long options can also be shortened as long as they are unique.
Environment Variables
=====================
@@ -306,6 +306,16 @@
Available levels are the same as for --loglevel
command line option and the default is INFO.
+Return Codes
+============
+
+0 All tests passed.
+1-249 Returned number of tests failed.
+250 250 or more failures.
+251 Help or version information printed.
+252 Invalid data or command line options.
+255 Unexpected internal error.
+
Examples
========
@@ -325,15 +335,22 @@
class Rebot(RobotFramework):
def __init__(self):
- Application.__init__(self, USAGE, arg_limits=(1,), env_options='REBOT_OPTIONS',
- logger=LOGGER)
+ Application.__init__(
+ self,
+ USAGE,
+ arg_limits=(1,),
+ env_options="REBOT_OPTIONS",
+ logger=LOGGER,
+ )
def main(self, datasources, **options):
try:
settings = RebotSettings(options)
- except:
- LOGGER.register_console_logger(stdout=options.get('stdout'),
- stderr=options.get('stderr'))
+ except DataError:
+ LOGGER.register_console_logger(
+ stdout=options.get("stdout"),
+ stderr=options.get("stderr"),
+ )
raise
LOGGER.register_console_logger(**settings.console_output_config)
if settings.pythonpath:
@@ -341,7 +358,7 @@ def main(self, datasources, **options):
LOGGER.disable_message_cache()
rc = ResultWriter(*datasources).write_results(settings)
if rc < 0:
- raise DataError('No outputs created.')
+ raise DataError("No outputs created.")
return rc
@@ -403,5 +420,5 @@ def rebot(*outputs, **options):
return Rebot().execute(*outputs, **options)
-if __name__ == '__main__':
+if __name__ == "__main__":
rebot_cli(sys.argv[1:])
diff --git a/src/robot/reporting/__init__.py b/src/robot/reporting/__init__.py
index 2847b60a862..152091de760 100644
--- a/src/robot/reporting/__init__.py
+++ b/src/robot/reporting/__init__.py
@@ -26,4 +26,4 @@
This package is considered stable.
"""
-from .resultwriter import ResultWriter
+from .resultwriter import ResultWriter as ResultWriter
diff --git a/src/robot/reporting/expandkeywordmatcher.py b/src/robot/reporting/expandkeywordmatcher.py
index 8ded3dfcd19..6a559707044 100644
--- a/src/robot/reporting/expandkeywordmatcher.py
+++ b/src/robot/reporting/expandkeywordmatcher.py
@@ -13,23 +13,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import MultiMatcher, is_list_like
+from collections.abc import Sequence
+
+from robot.result import Keyword
+from robot.utils import MultiMatcher
class ExpandKeywordMatcher:
- def __init__(self, expand_keywords):
- self.matched_ids = []
+ def __init__(self, expand_keywords: "str|Sequence[str]"):
+ self.matched_ids: "list[str]" = []
if not expand_keywords:
expand_keywords = []
- elif not is_list_like(expand_keywords):
+ elif isinstance(expand_keywords, str):
expand_keywords = [expand_keywords]
- names = [n[5:] for n in expand_keywords if n[:5].lower() == 'name:']
- tags = [p[4:] for p in expand_keywords if p[:4].lower() == 'tag:']
+ names = [n[5:] for n in expand_keywords if n[:5].lower() == "name:"]
+ tags = [p[4:] for p in expand_keywords if p[:4].lower() == "tag:"]
self._match_name = MultiMatcher(names).match
self._match_tags = MultiMatcher(tags).match_any
- def match(self, kw):
- if ((kw.passed or kw.skipped)
- and (self._match_name(kw.name or '') or self._match_tags(kw.tags))):
+ def match(self, kw: Keyword):
+ match = self._match_name(kw.full_name or "") or self._match_tags(kw.tags)
+ if match and not kw.not_run:
self.matched_ids.append(kw.id)
diff --git a/src/robot/reporting/jsbuildingcontext.py b/src/robot/reporting/jsbuildingcontext.py
index a08231f6ef8..d681be161f2 100644
--- a/src/robot/reporting/jsbuildingcontext.py
+++ b/src/robot/reporting/jsbuildingcontext.py
@@ -14,11 +14,11 @@
# limitations under the License.
from contextlib import contextmanager
-from os.path import exists, dirname
+from datetime import datetime
+from pathlib import Path
from robot.output.loggerhelper import LEVELS
-from robot.utils import (attribute_escape, get_link_path, html_escape, is_string,
- safe_str, timestamp_to_secs)
+from robot.utils import attribute_escape, get_link_path, html_escape, safe_str
from .expandkeywordmatcher import ExpandKeywordMatcher
from .stringcache import StringCache
@@ -26,23 +26,38 @@
class JsBuildingContext:
- def __init__(self, log_path=None, split_log=False, expand_keywords=None,
- prune_input=False):
- # log_path can be a custom object in unit tests
- self._log_dir = dirname(log_path) if is_string(log_path) else None
+ def __init__(
+ self,
+ log_path=None,
+ split_log=False,
+ expand_keywords=None,
+ prune_input=False,
+ ):
+ self._log_dir = self._get_log_dir(log_path)
self._split_log = split_log
self._prune_input = prune_input
self._strings = self._top_level_strings = StringCache()
self.basemillis = None
self.split_results = []
- self.min_level = 'NONE'
+ self.min_level = "NONE"
self._msg_links = {}
- self._expand_matcher = ExpandKeywordMatcher(expand_keywords) \
- if expand_keywords else None
+ self._expand_matcher = (
+ ExpandKeywordMatcher(expand_keywords) if expand_keywords else None
+ )
+
+ def _get_log_dir(self, log_path):
+ # log_path can be a custom object in unit tests
+ if isinstance(log_path, Path):
+ return log_path.parent
+ if isinstance(log_path, str):
+ return Path(log_path).parent
+ return None
def string(self, string, escape=True, attr=False):
- if escape and string:
- if not is_string(string):
+ if not string:
+ return self._strings.empty
+ if escape:
+ if not isinstance(string, str):
string = safe_str(string)
string = (html_escape if not attr else attribute_escape)(string)
return self._strings.add(string)
@@ -51,14 +66,18 @@ def html(self, string):
return self._strings.add(string, html=True)
def relative_source(self, source):
- rel_source = get_link_path(source, self._log_dir) \
- if self._log_dir and source and exists(source) else ''
+ if isinstance(source, str):
+ source = Path(source)
+ if self._log_dir and source and source.exists():
+ rel_source = get_link_path(source, self._log_dir)
+ else:
+ rel_source = ""
return self.string(rel_source)
- def timestamp(self, time):
- if not time:
+ def timestamp(self, ts: "datetime|None") -> "int|None":
+ if not ts:
return None
- millis = int(timestamp_to_secs(time) * 1000)
+ millis = round(ts.timestamp() * 1000)
if self.basemillis is None:
self.basemillis = millis
return millis - self.basemillis
diff --git a/src/robot/reporting/jsexecutionresult.py b/src/robot/reporting/jsexecutionresult.py
index 51746a830d4..41fcf1fbbe0 100644
--- a/src/robot/reporting/jsexecutionresult.py
+++ b/src/robot/reporting/jsexecutionresult.py
@@ -20,8 +20,17 @@
class JsExecutionResult:
- def __init__(self, suite, statistics, errors, strings, basemillis=None,
- split_results=None, min_level=None, expand_keywords=None):
+ def __init__(
+ self,
+ suite,
+ statistics,
+ errors,
+ strings,
+ basemillis=None,
+ split_results=None,
+ min_level=None,
+ expand_keywords=None,
+ ):
self.suite = suite
self.strings = strings
self.min_level = min_level
@@ -29,17 +38,19 @@ def __init__(self, suite, statistics, errors, strings, basemillis=None,
self.split_results = split_results or []
def _get_data(self, statistics, errors, basemillis, expand_keywords):
- return {'stats': statistics,
- 'errors': errors,
- 'baseMillis': basemillis,
- 'generated': int(time.time() * 1000) - basemillis,
- 'expand_keywords': expand_keywords}
+ return {
+ "stats": statistics,
+ "errors": errors,
+ "baseMillis": basemillis,
+ "generated": int(time.time() * 1000) - basemillis,
+ "expand_keywords": expand_keywords,
+ }
def remove_data_not_needed_in_report(self):
- self.data.pop('errors')
- remover = _KeywordRemover()
- self.suite = remover.remove_keywords(self.suite)
- self.suite, self.strings = remover.remove_unused_strings(self.suite, self.strings)
+ self.data.pop("errors")
+ rm = _KeywordRemover()
+ self.suite = rm.remove_keywords(self.suite)
+ self.suite, self.strings = rm.remove_unused_strings(self.suite, self.strings)
class _KeywordRemover:
@@ -48,9 +59,13 @@ def remove_keywords(self, suite):
return self._remove_keywords_from_suite(suite)
def _remove_keywords_from_suite(self, suite):
- return suite[:6] + (self._remove_keywords_from_suites(suite[6]),
- self._remove_keywords_from_tests(suite[7]),
- (), suite[9])
+ return (
+ *suite[:6],
+ self._remove_keywords_from_suites(suite[6]),
+ self._remove_keywords_from_tests(suite[7]),
+ (),
+ suite[9],
+ )
def _remove_keywords_from_suites(self, suites):
return tuple(self._remove_keywords_from_suite(s) for s in suites)
@@ -73,8 +88,7 @@ def _get_used_indices(self, model):
if isinstance(item, StringIndex):
yield item
elif isinstance(item, tuple):
- for i in self._get_used_indices(item):
- yield i
+ yield from self._get_used_indices(item)
def _get_used_strings(self, strings, used_indices, remap):
offset = 0
diff --git a/src/robot/reporting/jsmodelbuilders.py b/src/robot/reporting/jsmodelbuilders.py
index c6c8d681a42..514caac42d4 100644
--- a/src/robot/reporting/jsmodelbuilders.py
+++ b/src/robot/reporting/jsmodelbuilders.py
@@ -13,26 +13,52 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import re
+
from robot.output import LEVELS
+from robot.result import Error, Keyword, Message, Return
from .jsbuildingcontext import JsBuildingContext
from .jsexecutionresult import JsExecutionResult
-
-STATUSES = {'FAIL': 0, 'PASS': 1, 'SKIP': 2, 'NOT RUN': 3}
-KEYWORD_TYPES = {'KEYWORD': 0, 'SETUP': 1, 'TEARDOWN': 2,
- 'FOR': 3, 'ITERATION': 4,
- 'IF': 5, 'ELSE IF': 6, 'ELSE': 7,
- 'RETURN': 8, 'TRY': 9, 'EXCEPT': 10,
- 'FINALLY': 11, 'WHILE': 12, 'CONTINUE': 13, 'BREAK': 14}
+STATUSES = {"FAIL": 0, "PASS": 1, "SKIP": 2, "NOT RUN": 3}
+KEYWORD_TYPES = {
+ "KEYWORD": 0,
+ "SETUP": 1,
+ "TEARDOWN": 2,
+ "FOR": 3,
+ "ITERATION": 4,
+ "IF": 5,
+ "ELSE IF": 6,
+ "ELSE": 7,
+ "RETURN": 8,
+ "VAR": 9,
+ "TRY": 10,
+ "EXCEPT": 11,
+ "FINALLY": 12,
+ "WHILE": 13,
+ "GROUP": 14,
+ "CONTINUE": 15,
+ "BREAK": 16,
+ "ERROR": 17,
+}
class JsModelBuilder:
- def __init__(self, log_path=None, split_log=False, expand_keywords=None,
- prune_input_to_save_memory=False):
- self._context = JsBuildingContext(log_path, split_log, expand_keywords,
- prune_input_to_save_memory)
+ def __init__(
+ self,
+ log_path=None,
+ split_log=False,
+ expand_keywords=None,
+ prune_input_to_save_memory=False,
+ ):
+ self._context = JsBuildingContext(
+ log_path,
+ split_log,
+ expand_keywords,
+ prune_input_to_save_memory,
+ )
def build_from(self, result_from_xml):
# Statistics must be build first because building suite may prune input.
@@ -44,63 +70,79 @@ def build_from(self, result_from_xml):
basemillis=self._context.basemillis,
split_results=self._context.split_results,
min_level=self._context.min_level,
- expand_keywords=self._context.expand_keywords
+ expand_keywords=self._context.expand_keywords,
)
-class _Builder:
+class Builder:
+ robot_note = re.compile('(.*)')
- def __init__(self, context):
+ def __init__(self, context: JsBuildingContext):
self._context = context
self._string = self._context.string
self._html = self._context.html
self._timestamp = self._context.timestamp
- def _get_status(self, item):
- model = (STATUSES[item.status],
- self._timestamp(item.starttime),
- item.elapsedtime)
- msg = getattr(item, 'message', '')
+ def _get_status(self, item, note_only=False):
+ model = (
+ STATUSES[item.status],
+ self._timestamp(item.start_time),
+ round(item.elapsed_time.total_seconds() * 1000),
+ )
+ msg = item.message
if not msg:
return model
- elif msg.startswith('*HTML*'):
- msg = self._string(msg[6:].lstrip(), escape=False)
+ if note_only:
+ if msg.startswith("*HTML*"):
+ match = self.robot_note.search(msg)
+ if match:
+ index = self._string(match.group(1))
+ return (*model, index)
+ return model
+ if msg.startswith("*HTML*"):
+ index = self._string(msg[6:].lstrip(), escape=False)
else:
- msg = self._string(msg)
- return model + (msg,)
+ index = self._string(msg)
+ return (*model, index)
- def _build_keywords(self, steps, split=False):
+ def _build_body(self, body, split=False):
splitting = self._context.start_splitting_if_needed(split)
- # tuple([>]) is faster than tuple() with short lists.
- model = tuple([self._build_keyword(step) for step in steps])
+ # tuple([]) is faster than tuple() with short lists.
+ model = tuple([self._build_body_item(item) for item in body])
return model if not splitting else self._context.end_splitting(model)
- def _build_keyword(self, step):
+ def _build_body_item(self, item):
raise NotImplementedError
-class SuiteBuilder(_Builder):
+class SuiteBuilder(Builder):
def __init__(self, context):
- _Builder.__init__(self, context)
+ super().__init__(context)
self._build_suite = self.build
self._build_test = TestBuilder(context).build
- self._build_keyword = KeywordBuilder(context).build
+ self._build_body_item = BodyItemBuilder(context).build
def build(self, suite):
with self._context.prune_input(suite.tests, suite.suites):
stats = self._get_statistics(suite) # Must be done before pruning
- kws = [kw for kw in (suite.setup, suite.teardown) if kw]
- return (self._string(suite.name, attr=True),
- self._string(suite.source),
- self._context.relative_source(suite.source),
- self._html(suite.doc),
- tuple(self._yield_metadata(suite)),
- self._get_status(suite),
- tuple(self._build_suite(s) for s in suite.suites),
- tuple(self._build_test(t) for t in suite.tests),
- tuple(self._build_keyword(k, split=True) for k in kws),
- stats)
+ fixture = []
+ if suite.has_setup:
+ fixture.append(suite.setup)
+ if suite.has_teardown:
+ fixture.append(suite.teardown)
+ return (
+ self._string(suite.name, attr=True),
+ self._string(suite.source),
+ self._context.relative_source(suite.source),
+ self._html(suite.doc),
+ tuple(self._yield_metadata(suite)),
+ self._get_status(suite),
+ tuple(self._build_suite(s) for s in suite.suites),
+ tuple(self._build_test(t) for t in suite.tests),
+ tuple(self._build_body_item(kw, split=True) for kw in fixture),
+ stats,
+ )
def _yield_metadata(self, suite):
for name, value in suite.metadata.items():
@@ -112,95 +154,140 @@ def _get_statistics(self, suite):
return (stats.total, stats.passed, stats.failed, stats.skipped)
-class TestBuilder(_Builder):
+class TestBuilder(Builder):
def __init__(self, context):
- _Builder.__init__(self, context)
- self._build_keyword = KeywordBuilder(context).build
+ super().__init__(context)
+ self._build_body_item = BodyItemBuilder(context).build
def build(self, test):
- kws = self._get_keywords(test)
+ body = self._get_body_items(test)
with self._context.prune_input(test.body):
- return (self._string(test.name, attr=True),
- self._string(test.timeout),
- self._html(test.doc),
- tuple(self._string(t) for t in test.tags),
- self._get_status(test),
- self._build_keywords(kws, split=True))
-
- def _get_keywords(self, test):
- kws = []
- if test.setup:
- kws.append(test.setup)
- kws.extend(test.body.flatten())
- if test.teardown:
- kws.append(test.teardown)
- return kws
-
-
-class KeywordBuilder(_Builder):
+ return (
+ self._string(test.name, attr=True),
+ self._string(test.timeout),
+ self._html(test.doc),
+ tuple(self._string(t) for t in test.tags),
+ self._get_status(test),
+ self._build_body(body, split=True),
+ )
+
+ def _get_body_items(self, test):
+ body = test.body.flatten()
+ if test.has_setup:
+ body.insert(0, test.setup)
+ if test.has_teardown:
+ body.append(test.teardown)
+ return body
+
+
+class BodyItemBuilder(Builder):
def __init__(self, context):
- _Builder.__init__(self, context)
- self._build_keyword = self.build
+ super().__init__(context)
+ self._build_body_item = self.build
self._build_message = MessageBuilder(context).build
def build(self, item, split=False):
- if item.type == item.MESSAGE:
+ if isinstance(item, Message):
return self._build_message(item)
- return self.build_keyword(item, split)
-
- def build_keyword(self, kw, split=False):
+ with self._context.prune_input(item.body):
+ if isinstance(item, Keyword):
+ return self._build_keyword(item, split)
+ if isinstance(item, (Return, Error)):
+ return self._build(item, args=" ".join(item.values), split=split)
+ return self._build(item, item._log_name, split=split)
+
+ def _build_keyword(self, kw: Keyword, split):
self._context.check_expansion(kw)
- items = kw.body.flatten()
+ body = kw.body.flatten()
+ if kw.has_setup:
+ body.insert(0, kw.setup)
if kw.has_teardown:
- items.append(kw.teardown)
- with self._context.prune_input(kw.body):
- return (KEYWORD_TYPES[kw.type],
- self._string(kw.kwname, attr=True),
- self._string(kw.libname, attr=True),
- self._string(kw.timeout),
- self._html(kw.doc),
- self._string(', '.join(kw.args)),
- self._string(', '.join(kw.assign)),
- self._string(', '.join(kw.tags)),
- self._get_status(kw),
- self._build_keywords(items, split))
-
-
-class MessageBuilder(_Builder):
+ body.append(kw.teardown)
+ return self._build(
+ kw,
+ kw.name,
+ kw.owner,
+ kw.timeout,
+ kw.doc,
+ " ".join(kw.args),
+ " ".join(kw.assign),
+ ", ".join(kw.tags),
+ body,
+ split=split,
+ )
+
+ def _build(
+ self,
+ item,
+ name="",
+ owner="",
+ timeout="",
+ doc="",
+ args="",
+ assign="",
+ tags="",
+ body=None,
+ split=False,
+ ):
+ if body is None:
+ body = item.body.flatten()
+ return (
+ KEYWORD_TYPES[item.type],
+ self._string(name, attr=True),
+ self._string(owner, attr=True),
+ self._string(timeout),
+ self._html(doc),
+ self._string(args),
+ self._string(assign),
+ self._string(tags),
+ self._get_status(item, note_only=True),
+ self._build_body(body, split),
+ )
+
+
+class MessageBuilder(Builder):
def build(self, msg):
- if msg.level in ('WARN', 'ERROR'):
+ if msg.level in ("WARN", "ERROR"):
self._context.create_link_target(msg)
self._context.message_level(msg.level)
return self._build(msg)
def _build(self, msg):
- return (self._timestamp(msg.timestamp),
- LEVELS[msg.level],
- self._string(msg.html_message, escape=False))
+ return (
+ self._timestamp(msg.timestamp),
+ LEVELS[msg.level],
+ self._string(msg.html_message, escape=False),
+ )
class StatisticsBuilder:
def build(self, statistics):
- return (self._build_stats(statistics.total),
- self._build_stats(statistics.tags),
- self._build_stats(statistics.suite, exclude_empty=False))
+ return (
+ self._build_stats(statistics.total),
+ self._build_stats(statistics.tags),
+ self._build_stats(statistics.suite, exclude_empty=False),
+ )
def _build_stats(self, stats, exclude_empty=True):
- return tuple(stat.get_attributes(include_label=True,
- include_elapsed=True,
- exclude_empty=exclude_empty,
- html_escape=True)
- for stat in stats)
+ return tuple(
+ stat.get_attributes(
+ include_label=True,
+ include_elapsed=True,
+ exclude_empty=exclude_empty,
+ html_escape=True,
+ )
+ for stat in stats
+ )
-class ErrorsBuilder(_Builder):
+class ErrorsBuilder(Builder):
def __init__(self, context):
- _Builder.__init__(self, context)
+ super().__init__(context)
self._build_message = ErrorMessageBuilder(context).build
def build(self, errors):
@@ -213,4 +300,4 @@ class ErrorMessageBuilder(MessageBuilder):
def build(self, msg):
model = self._build(msg)
link = self._context.link(msg)
- return model if link is None else model + (link,)
+ return model if link is None else (*model, link)
diff --git a/src/robot/reporting/jswriter.py b/src/robot/reporting/jswriter.py
index 560a17ff297..f3666fbf4f0 100644
--- a/src/robot/reporting/jswriter.py
+++ b/src/robot/reporting/jswriter.py
@@ -17,16 +17,19 @@
class JsResultWriter:
- _output_attr = 'window.output'
- _settings_attr = 'window.settings'
- _suite_key = 'suite'
- _strings_key = 'strings'
-
- def __init__(self, output,
- start_block='\n',
- split_threshold=9500):
- writer = JsonWriter(output, separator=end_block+start_block)
+ _output_attr = "window.output"
+ _settings_attr = "window.settings"
+ _suite_key = "suite"
+ _strings_key = "strings"
+
+ def __init__(
+ self,
+ output,
+ start_block='\n",
+ split_threshold=9500,
+ ):
+ writer = JsonWriter(output, separator=end_block + start_block)
self._write = writer.write
self._write_json = writer.write_json
self._start_block = start_block
@@ -41,8 +44,8 @@ def write(self, result, settings):
self._write_settings_and_end_output_block(settings)
def _start_output_block(self):
- self._write(self._start_block, postfix='', separator=False)
- self._write('%s = {}' % self._output_attr)
+ self._write(self._start_block, postfix="", separator=False)
+ self._write(f"{self._output_attr} = {{}}")
def _write_suite(self, suite):
writer = SuiteWriter(self._write_json, self._split_threshold)
@@ -50,24 +53,23 @@ def _write_suite(self, suite):
def _write_strings(self, strings):
variable = self._output_var(self._strings_key)
- self._write('%s = []' % variable)
- prefix = '%s = %s.concat(' % (variable, variable)
- postfix = ');\n'
+ self._write(f"{variable} = []")
+ prefix = f"{variable} = {variable}.concat("
+ postfix = ");\n"
threshold = self._split_threshold
for index in range(0, len(strings), threshold):
- self._write_json(prefix, strings[index:index+threshold], postfix)
+ self._write_json(prefix, strings[index : index + threshold], postfix)
def _write_data(self, data):
for key in data:
- self._write_json('%s = ' % self._output_var(key), data[key])
+ self._write_json(f"{self._output_var(key)} = ", data[key])
def _write_settings_and_end_output_block(self, settings):
- self._write_json('%s = ' % self._settings_attr, settings,
- separator=False)
- self._write(self._end_block, postfix='', separator=False)
+ self._write_json(f"{self._settings_attr} = ", settings, separator=False)
+ self._write(self._end_block, postfix="", separator=False)
def _output_var(self, key):
- return '%s["%s"]' % (self._output_attr, key)
+ return f'{self._output_attr}["{key}"]'
class SuiteWriter:
@@ -79,21 +81,22 @@ def __init__(self, write_json, split_threshold):
def write(self, suite, variable):
mapping = {}
self._write_parts_over_threshold(suite, mapping)
- self._write_json('%s = ' % variable, suite, mapping=mapping)
+ self._write_json(f"{variable} = ", suite, mapping=mapping)
def _write_parts_over_threshold(self, data, mapping):
if not isinstance(data, tuple):
return 1
- not_written = 1 + sum(self._write_parts_over_threshold(item, mapping)
- for item in data)
+ not_written = 1
+ for item in data:
+ not_written += self._write_parts_over_threshold(item, mapping)
if not_written > self._split_threshold:
self._write_part(data, mapping)
return 1
return not_written
def _write_part(self, data, mapping):
- part_name = 'window.sPart%d' % len(mapping)
- self._write_json('%s = ' % part_name, data, mapping=mapping)
+ part_name = f"window.sPart{len(mapping)}"
+ self._write_json(f"{part_name} = ", data, mapping=mapping)
mapping[data] = part_name
@@ -103,6 +106,6 @@ def __init__(self, output):
self._writer = JsonWriter(output)
def write(self, keywords, strings, index, notify):
- self._writer.write_json('window.keywords%d = ' % index, keywords)
- self._writer.write_json('window.strings%d = ' % index, strings)
- self._writer.write('window.fileLoading.notify("%s")' % notify)
+ self._writer.write_json(f"window.keywords{index} = ", keywords)
+ self._writer.write_json(f"window.strings{index} = ", strings)
+ self._writer.write(f'window.fileLoading.notify("{notify}")')
diff --git a/src/robot/reporting/logreportwriters.py b/src/robot/reporting/logreportwriters.py
index 3b886f5fbb6..dbcb7cf2613 100644
--- a/src/robot/reporting/logreportwriters.py
+++ b/src/robot/reporting/logreportwriters.py
@@ -13,10 +13,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from os.path import basename, splitext
+from pathlib import Path
-from robot.htmldata import HtmlFileWriter, ModelWriter, LOG, REPORT
-from robot.utils import file_writer, is_string
+from robot.htmldata import HtmlFileWriter, LOG, ModelWriter, REPORT
+from robot.utils import file_writer
from .jswriter import JsResultWriter, SplitLogWriter
@@ -27,9 +27,11 @@ class _LogReportWriter:
def __init__(self, js_model):
self._js_model = js_model
- def _write_file(self, path, config, template):
- outfile = file_writer(path, usage=self.usage) \
- if is_string(path) else path # unit test hook
+ def _write_file(self, path: Path, config, template):
+ if isinstance(path, Path):
+ outfile = file_writer(path, usage=self.usage)
+ else:
+ outfile = path # unit test hook
with outfile:
model_writer = RobotModelWriter(outfile, self._js_model, config)
writer = HtmlFileWriter(outfile, model_writer)
@@ -37,28 +39,32 @@ def _write_file(self, path, config, template):
class LogWriter(_LogReportWriter):
- usage = 'log'
+ usage = "log"
- def write(self, path, config):
+ def write(self, path: "Path|str", config):
+ if isinstance(path, str):
+ path = Path(path)
self._write_file(path, config, LOG)
if self._js_model.split_results:
- self._write_split_logs(splitext(path)[0])
+ self._write_split_logs(path)
- def _write_split_logs(self, base):
- for index, (keywords, strings) in enumerate(self._js_model.split_results,
- start=1):
- self._write_split_log(index, keywords, strings, '%s-%d.js' % (base, index))
+ def _write_split_logs(self, path: Path):
+ for index, (kws, strings) in enumerate(self._js_model.split_results, start=1):
+ name = f"{path.stem}-{index}.js"
+ self._write_split_log(index, kws, strings, path.with_name(name))
- def _write_split_log(self, index, keywords, strings, path):
+ def _write_split_log(self, index, kws, strings, path: Path):
with file_writer(path, usage=self.usage) as outfile:
writer = SplitLogWriter(outfile)
- writer.write(keywords, strings, index, basename(path))
+ writer.write(kws, strings, index, path.name)
class ReportWriter(_LogReportWriter):
- usage = 'report'
+ usage = "report"
- def write(self, path, config):
+ def write(self, path: "Path|str", config):
+ if isinstance(path, str):
+ path = Path(path)
self._write_file(path, config, REPORT)
diff --git a/src/robot/reporting/outputwriter.py b/src/robot/reporting/outputwriter.py
index e03571ca43d..68c34c4a482 100644
--- a/src/robot/reporting/outputwriter.py
+++ b/src/robot/reporting/outputwriter.py
@@ -13,20 +13,18 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.output.xmllogger import XmlLogger
+from robot.output.xmllogger import LegacyXmlLogger, XmlLogger
class OutputWriter(XmlLogger):
+ generator = "Rebot"
- def __init__(self, output, rpa=False):
- XmlLogger.__init__(self, output, rpa=rpa, generator='Rebot')
+ def end_result(self, result):
+ self.close()
- def start_message(self, msg):
- self._write_message(msg)
- def close(self):
- self._writer.end('robot')
- self._writer.close()
+class LegacyOutputWriter(LegacyXmlLogger):
+ generator = "Rebot"
def end_result(self, result):
self.close()
diff --git a/src/robot/reporting/resultwriter.py b/src/robot/reporting/resultwriter.py
index 4095bb3ae44..c86b391fc1a 100644
--- a/src/robot/reporting/resultwriter.py
+++ b/src/robot/reporting/resultwriter.py
@@ -54,30 +54,30 @@ def write_results(self, settings=None, **options):
settings = settings or RebotSettings(options)
results = Results(settings, *self._sources)
if settings.output:
- self._write_output(results.result, settings.output)
+ self._write_output(results.result, settings.output, settings.legacy_output)
if settings.xunit:
self._write_xunit(results.result, settings.xunit)
if settings.log:
- config = dict(settings.log_config,
- minLevel=results.js_result.min_level)
+ config = dict(settings.log_config, minLevel=results.js_result.min_level)
self._write_log(results.js_result, settings.log, config)
if settings.report:
results.js_result.remove_data_not_needed_in_report()
- self._write_report(results.js_result, settings.report,
- settings.report_config)
+ self._write_report(
+ results.js_result, settings.report, settings.report_config
+ )
return results.return_code
- def _write_output(self, result, path):
- self._write('Output', result.save, path)
+ def _write_output(self, result, path, legacy_output=False):
+ self._write("Output", result.save, path, legacy_output)
def _write_xunit(self, result, path):
- self._write('XUnit', XUnitWriter(result).write, path)
+ self._write("XUnit", XUnitWriter(result).write, path)
def _write_log(self, js_result, path, config):
- self._write('Log', LogWriter(js_result).write, path, config)
+ self._write("Log", LogWriter(js_result).write, path, config)
def _write_report(self, js_result, path, config):
- self._write('Report', ReportWriter(js_result).write, path, config)
+ self._write("Report", ReportWriter(js_result).write, path, config)
def _write(self, name, writer, path, *args):
try:
@@ -85,7 +85,7 @@ def _write(self, name, writer, path, *args):
except DataError as err:
LOGGER.error(err.message)
else:
- LOGGER.output_file(name, path)
+ LOGGER.result_file(name, path)
class Results:
@@ -108,30 +108,39 @@ def result(self):
if self._result is None:
include_keywords = bool(self._settings.log or self._settings.output)
flattened = self._settings.flatten_keywords
- self._result = ExecutionResult(include_keywords=include_keywords,
- flattened_keywords=flattened,
- merge=self._settings.merge,
- rpa=self._settings.rpa,
- *self._sources)
+ self._result = ExecutionResult(
+ *self._sources,
+ include_keywords=include_keywords,
+ flattened_keywords=flattened,
+ merge=self._settings.merge,
+ rpa=self._settings.rpa,
+ )
if self._settings.rpa is None:
self._settings.rpa = self._result.rpa
- modifier = ModelModifier(self._settings.pre_rebot_modifiers,
- self._settings.process_empty_suite,
- LOGGER)
- self._result.suite.visit(modifier)
- self._result.configure(self._settings.status_rc,
- self._settings.suite_config,
- self._settings.statistics_config)
+ if self._settings.pre_rebot_modifiers:
+ modifier = ModelModifier(
+ self._settings.pre_rebot_modifiers,
+ self._settings.process_empty_suite,
+ LOGGER,
+ )
+ self._result.suite.visit(modifier)
+ self._result.configure(
+ self._settings.status_rc,
+ self._settings.suite_config,
+ self._settings.statistics_config,
+ )
self.return_code = self._result.return_code
return self._result
@property
def js_result(self):
if self._js_result is None:
- builder = JsModelBuilder(log_path=self._settings.log,
- split_log=self._settings.split_log,
- expand_keywords=self._settings.expand_keywords,
- prune_input_to_save_memory=self._prune)
+ builder = JsModelBuilder(
+ log_path=self._settings.log,
+ split_log=self._settings.split_log,
+ expand_keywords=self._settings.expand_keywords,
+ prune_input_to_save_memory=self._prune,
+ )
self._js_result = builder.build_from(self.result)
if self._prune:
self._result = None
diff --git a/src/robot/reporting/stringcache.py b/src/robot/reporting/stringcache.py
index 20ea35102f2..0a1cbda3edd 100644
--- a/src/robot/reporting/stringcache.py
+++ b/src/robot/reporting/stringcache.py
@@ -21,16 +21,16 @@ class StringIndex(int):
class StringCache:
+ empty = StringIndex(0)
_compress_threshold = 80
_use_compressed_threshold = 1.1
- _zero_index = StringIndex(0)
def __init__(self):
- self._cache = {('', False): self._zero_index}
+ self._cache = {("", False): self.empty}
def add(self, text, html=False):
if not text:
- return self._zero_index
+ return self.empty
key = (text, html)
if key not in self._cache:
self._cache[key] = StringIndex(len(self._cache))
@@ -47,4 +47,4 @@ def _encode(self, text, html=False):
if len(compressed) * self._use_compressed_threshold < len(text):
return compressed
# Strings starting with '*' are raw, others are compressed.
- return '*' + text
+ return "*" + text
diff --git a/src/robot/reporting/xunitwriter.py b/src/robot/reporting/xunitwriter.py
index e0fc2269cf2..6d11cc85669 100644
--- a/src/robot/reporting/xunitwriter.py
+++ b/src/robot/reporting/xunitwriter.py
@@ -13,7 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.result import ResultVisitor
+from robot.result import ResultVisitor, TestCase, TestSuite
from robot.utils import XmlWriter
@@ -23,7 +23,7 @@ def __init__(self, execution_result):
self._execution_result = execution_result
def write(self, output):
- xml_writer = XmlWriter(output, usage='xunit')
+ xml_writer = XmlWriter(output, usage="xunit")
writer = XUnitFileWriter(xml_writer)
self._execution_result.visit(writer)
@@ -35,52 +35,52 @@ class XUnitFileWriter(ResultVisitor):
http://marc.info/?l=ant-dev&m=123551933508682
"""
- def __init__(self, xml_writer):
+ def __init__(self, xml_writer: XmlWriter):
self._writer = xml_writer
- def start_suite(self, suite):
- tests, failures, skipped = self._get_stats(suite.statistics)
- attrs = {'name': suite.name,
- 'tests': tests,
- 'errors': '0',
- 'failures': failures,
- 'skipped': skipped,
- 'time': self._time_as_seconds(suite.elapsedtime),
- 'timestamp' : self._starttime_to_isoformat(suite.starttime)}
- self._writer.start('testsuite', attrs)
-
- def _get_stats(self, statistics):
- return (
- str(statistics.total),
- str(statistics.failed),
- str(statistics.skipped)
- )
-
- def end_suite(self, suite):
+ def start_suite(self, suite: TestSuite):
+ stats = suite.statistics # Accessing property only once.
+ attrs = {
+ "name": suite.name,
+ "tests": str(stats.total),
+ "errors": "0",
+ "failures": str(stats.failed),
+ "skipped": str(stats.skipped),
+ "time": format(suite.elapsed_time.total_seconds(), ".3f"),
+ "timestamp": suite.start_time.isoformat() if suite.start_time else None,
+ }
+ self._writer.start("testsuite", attrs)
+
+ def end_suite(self, suite: TestSuite):
if suite.metadata or suite.doc:
- self._writer.start('properties')
+ self._writer.start("properties")
if suite.doc:
- self._writer.element('property', attrs={'name': 'Documentation', 'value': suite.doc})
+ self._writer.element(
+ "property", attrs={"name": "Documentation", "value": suite.doc}
+ )
for meta_name, meta_value in suite.metadata.items():
- self._writer.element('property', attrs={'name': meta_name, 'value': meta_value})
- self._writer.end('properties')
- self._writer.end('testsuite')
-
- def visit_test(self, test):
- self._writer.start('testcase',
- {'classname': test.parent.longname,
- 'name': test.name,
- 'time': self._time_as_seconds(test.elapsedtime)})
+ self._writer.element(
+ "property", attrs={"name": meta_name, "value": meta_value}
+ )
+ self._writer.end("properties")
+ self._writer.end("testsuite")
+
+ def visit_test(self, test: TestCase):
+ attrs = {
+ "classname": test.parent.full_name,
+ "name": test.name,
+ "time": format(test.elapsed_time.total_seconds(), ".3f"),
+ }
+ self._writer.start("testcase", attrs)
if test.failed:
- self._writer.element('failure', attrs={'message': test.message,
- 'type': 'AssertionError'})
+ self._writer.element(
+ "failure", attrs={"message": test.message, "type": "AssertionError"}
+ )
if test.skipped:
- self._writer.element('skipped', attrs={'message': test.message,
- 'type': 'SkipExecution'})
- self._writer.end('testcase')
-
- def _time_as_seconds(self, millis):
- return '{:.3f}'.format(millis / 1000)
+ self._writer.element(
+ "skipped", attrs={"message": test.message, "type": "SkipExecution"}
+ )
+ self._writer.end("testcase")
def visit_keyword(self, kw):
pass
@@ -93,8 +93,3 @@ def visit_errors(self, errors):
def end_result(self, result):
self._writer.close()
-
- def _starttime_to_isoformat(self, stime):
- if not stime:
- return None
- return f'{stime[:4]}-{stime[4:6]}-{stime[6:8]}T{stime[9:22]}000'
diff --git a/src/robot/result/__init__.py b/src/robot/result/__init__.py
index e22809a4630..ce262b983fe 100644
--- a/src/robot/result/__init__.py
+++ b/src/robot/result/__init__.py
@@ -18,19 +18,15 @@
The main public API of this package consists of the :func:`~.ExecutionResult`
factory method, that returns :class:`~.Result` objects, and of the
:class:`~.ResultVisitor` abstract class, that eases further processing
-the results.
+the results. It is recommended to import these public entry-points via the
+:mod:`robot.api` package like in the example below.
-The model objects in the :mod:`~.model` module can also be considered to be
-part of the public API, because they can be found inside the :class:`~.Result`
-object. They can also be inspected and modified as part of the normal test
-execution by `pre-Rebot modifiers`__ and `listeners`__.
-
-It is highly recommended to import the public entry-points via the
-:mod:`robot.api` package like in the example below. In those rare cases
-where the aforementioned model objects are needed directly, they can be
-imported from this package.
-
-This package is considered stable.
+The model objects defined in the :mod:`robot.result.model` module are also
+part of the public API. They are used inside the :class:`~.Result` object,
+and they can also be inspected and modified as part of the normal test
+execution by using `pre-Rebot modifiers`__ and `listeners`__. These model
+objects are not exposed via :mod:`robot.api`, but they can be imported
+from :mod:`robot.result` if needed.
Example
-------
@@ -41,8 +37,29 @@
__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface
"""
-from .executionresult import Result
-from .model import (For, ForIteration, While, WhileIteration, If, IfBranch, Keyword,
- Message, TestCase, TestSuite, Try, TryBranch, Return, Continue, Break)
-from .resultbuilder import ExecutionResult, ExecutionResultBuilder
-from .visitor import ResultVisitor
+from .executionresult import Result as Result
+from .model import (
+ Break as Break,
+ Continue as Continue,
+ Error as Error,
+ For as For,
+ ForIteration as ForIteration,
+ Group as Group,
+ If as If,
+ IfBranch as IfBranch,
+ Keyword as Keyword,
+ Message as Message,
+ Return as Return,
+ TestCase as TestCase,
+ TestSuite as TestSuite,
+ Try as Try,
+ TryBranch as TryBranch,
+ Var as Var,
+ While as While,
+ WhileIteration as WhileIteration,
+)
+from .resultbuilder import (
+ ExecutionResult as ExecutionResult,
+ ExecutionResultBuilder as ExecutionResultBuilder,
+)
+from .visitor import ResultVisitor as ResultVisitor
diff --git a/src/robot/result/configurer.py b/src/robot/result/configurer.py
index 9cba4b65902..761443e666c 100644
--- a/src/robot/result/configurer.py
+++ b/src/robot/result/configurer.py
@@ -14,7 +14,7 @@
# limitations under the License.
from robot import model
-from robot.utils import is_string, secs_to_timestamp, timestamp_to_secs
+from robot.utils import parse_timestamp
class SuiteConfigurer(model.SuiteConfigurer):
@@ -30,32 +30,37 @@ class SuiteConfigurer(model.SuiteConfigurer):
that will do further configuration based on them.
"""
- def __init__(self, remove_keywords=None, log_level=None, start_time=None,
- end_time=None, **base_config):
- model.SuiteConfigurer.__init__(self, **base_config)
+ def __init__(
+ self,
+ remove_keywords=None,
+ log_level=None,
+ start_time=None,
+ end_time=None,
+ **base_config,
+ ):
+ super().__init__(**base_config)
self.remove_keywords = self._get_remove_keywords(remove_keywords)
self.log_level = log_level
- self.start_time = self._get_time(start_time)
- self.end_time = self._get_time(end_time)
+ self.start_time = self._to_datetime(start_time)
+ self.end_time = self._to_datetime(end_time)
def _get_remove_keywords(self, value):
if value is None:
return []
- if is_string(value):
+ if isinstance(value, str):
return [value]
return value
- def _get_time(self, timestamp):
+ def _to_datetime(self, timestamp):
if not timestamp:
return None
try:
- secs = timestamp_to_secs(timestamp, seps=' :.-_')
+ return parse_timestamp(timestamp)
except ValueError:
return None
- return secs_to_timestamp(secs, millis=True)
def visit_suite(self, suite):
- model.SuiteConfigurer.visit_suite(self, suite)
+ super().visit_suite(suite)
self._remove_keywords(suite)
self._set_times(suite)
suite.filter_messages(self.log_level)
@@ -66,6 +71,10 @@ def _remove_keywords(self, suite):
def _set_times(self, suite):
if self.start_time:
- suite.starttime = self.start_time
+ suite.end_time = suite.end_time # Preserve original value.
+ suite.elapsed_time = None # Force re-calculation.
+ suite.start_time = self.start_time
if self.end_time:
- suite.endtime = self.end_time
+ suite.start_time = suite.start_time
+ suite.elapsed_time = None
+ suite.end_time = self.end_time
diff --git a/src/robot/result/executionerrors.py b/src/robot/result/executionerrors.py
index cec7a0e39c5..dd3c0588e83 100644
--- a/src/robot/result/executionerrors.py
+++ b/src/robot/result/executionerrors.py
@@ -13,6 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Iterator, Sequence
+
from robot.model import ItemList, Message
from robot.utils import setter
@@ -22,28 +24,34 @@ class ExecutionErrors:
An error might be, for example, that importing a library has failed.
"""
- id = 'errors'
- def __init__(self, messages=None):
- #: A :class:`list-like object ` of
- #: :class:`~robot.model.message.Message` instances.
+ id = "errors"
+
+ def __init__(self, messages: Sequence[Message] = ()):
self.messages = messages
@setter
- def messages(self, messages):
- return ItemList(Message, {'parent': self}, items=messages)
+ def messages(self, messages) -> ItemList[Message]:
+ return ItemList(Message, {"parent": self}, items=messages)
- def add(self, other):
+ def add(self, other: "ExecutionErrors"):
self.messages.extend(other.messages)
def visit(self, visitor):
visitor.visit_errors(self)
- def __iter__(self):
+ def __iter__(self) -> Iterator[Message]:
return iter(self.messages)
- def __len__(self):
+ def __len__(self) -> int:
return len(self.messages)
- def __getitem__(self, index):
+ def __getitem__(self, index) -> Message:
return self.messages[index]
+
+ def __str__(self) -> str:
+ if not self:
+ return "No execution errors"
+ if len(self) == 1:
+ return f"Execution error: {self[0]}"
+ return "\n".join(["Execution errors:"] + ["- " + str(m) for m in self])
diff --git a/src/robot/result/executionresult.py b/src/robot/result/executionresult.py
index 6a7d16a247f..caafe3243c8 100644
--- a/src/robot/result/executionresult.py
+++ b/src/robot/result/executionresult.py
@@ -13,13 +13,43 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from datetime import datetime
+from pathlib import Path
+from typing import overload, Sequence, TextIO
+
from robot.errors import DataError
-from robot.model import Statistics
+from robot.model import Statistics, SuiteVisitor
+from robot.utils import JsonDumper, JsonLoader, setter
+from robot.version import get_full_version
from .executionerrors import ExecutionErrors
+from .flattenkeywordmatcher import Flattener
from .model import TestSuite
+def is_json_source(source) -> bool:
+ if isinstance(source, bytes):
+ # ISO-8859-1 is most likely *not* the right encoding, but decoding bytes
+ # with it always succeeds and characters we care about ought to be correct
+ # at least if the right encoding is UTF-8 or any ISO-8859-x encoding.
+ source = source.decode("ISO-8859-1")
+ if isinstance(source, str):
+ source = source.strip()
+ first, last = (source[0], source[-1]) if source else ("", "")
+ if (first, last) == ("{", "}"):
+ return True
+ if (first, last) == ("<", ">"):
+ return False
+ path = Path(source)
+ elif isinstance(source, Path):
+ path = source
+ elif hasattr(source, "name") and isinstance(source.name, str):
+ path = Path(source.name)
+ else:
+ return False
+ return bool(path and path.suffix.lower() == ".json")
+
+
class Result:
"""Test execution results.
@@ -30,27 +60,48 @@ class Result:
method.
"""
- def __init__(self, source=None, root_suite=None, errors=None, rpa=None):
- #: Path to the XML file where results are read from.
- self.source = source
- #: Hierarchical execution results as a
- #: :class:`~.result.model.TestSuite` object.
- self.suite = root_suite or TestSuite()
- #: Execution errors as an
- #: :class:`~.executionerrors.ExecutionErrors` object.
+ def __init__(
+ self,
+ source: "Path|str|None" = None,
+ suite: "TestSuite|None" = None,
+ errors: "ExecutionErrors|None" = None,
+ rpa: "bool|None" = None,
+ generator: str = "unknown",
+ generation_time: "datetime|str|None" = None,
+ ):
+ self.source = Path(source) if isinstance(source, str) else source
+ self.suite = suite or TestSuite()
self.errors = errors or ExecutionErrors()
- self.generated_by_robot = True
+ self.rpa = rpa
+ self.generator = generator
+ self.generation_time = generation_time
self._status_rc = True
self._stat_config = {}
- self.rpa = rpa
+
+ @setter
+ def rpa(self, rpa: "bool|None") -> "bool|None":
+ if rpa is not None:
+ self._set_suite_rpa(self.suite, rpa)
+ return rpa
+
+ def _set_suite_rpa(self, suite, rpa):
+ suite.rpa = rpa
+ for child in suite.suites:
+ self._set_suite_rpa(child, rpa)
+
+ @setter
+ def generation_time(self, timestamp: "datetime|str|None") -> "datetime|None":
+ if datetime is None:
+ return None
+ if isinstance(timestamp, str):
+ return datetime.fromisoformat(timestamp)
+ return timestamp
@property
- def statistics(self):
- """Test execution statistics.
+ def statistics(self) -> Statistics:
+ """Execution statistics.
- Statistics are an instance of
- :class:`~robot.model.statistics.Statistics` that is created based
- on the contained ``suite`` and possible
+ Statistics are created based on the contained ``suite`` and possible
:func:`configuration `.
Statistics are created every time this property is accessed. Saving
@@ -70,16 +121,20 @@ def statistics(self):
return Statistics(self.suite, rpa=self.rpa, **self._stat_config)
@property
- def return_code(self):
- """Return code (integer) of test execution.
+ def return_code(self) -> int:
+ """Execution return code.
- By default returns the number of failed tests (max 250),
+ By default, returns the number of failed tests or tasks (max 250),
but can be :func:`configured ` to always return 0.
"""
if self._status_rc:
return min(self.suite.statistics.failed, 250)
return 0
+ @property
+ def generated_by_robot(self) -> bool:
+ return self.generator.split()[0].upper() == "ROBOT"
+
def configure(self, status_rc=True, suite_config=None, stat_config=None):
"""Configures the result object and objects it contains.
@@ -96,14 +151,191 @@ def configure(self, status_rc=True, suite_config=None, stat_config=None):
self._status_rc = status_rc
self._stat_config = stat_config or {}
- def save(self, path=None):
- """Save results as a new output XML file.
+ @classmethod
+ def from_json(
+ cls,
+ source: "str|bytes|TextIO|Path",
+ include_keywords: bool = True,
+ flattened_keywords: Sequence[str] = (),
+ rpa: "bool|None" = None,
+ ) -> "Result":
+ """Construct a result object from JSON data.
+
+ :param source: JSON data as 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.
+ :param include_keywords: When ``False``, keyword and control structure
+ information is not parsed. This can save considerable amount of time
+ and memory. New in RF 7.3.2.
+ :param flattened_keywords: List of patterns controlling what keywords
+ and control structures to flatten. See the documentation of
+ the ``--flattenkeywords`` option for more details. New in RF 7.3.2.
+ :param rpa: Setting ``rpa`` either to ``True`` (RPA mode) or ``False``
+ (test automation) sets the execution mode explicitly. By default,
+ the mode is got from the parsed data.
+ :returns: :class:`Result` instance.
+
+ The 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 `.
+
+ :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.
+ """
+ loader = cls._get_json_loader(include_keywords)
+ try:
+ data = loader.load(source)
+ except (TypeError, ValueError) as err:
+ raise DataError(f"Loading JSON data failed: {err}")
+ if "suite" in data:
+ result = cls._from_full_json(data)
+ else:
+ result = cls._from_suite_json(data)
+ result.rpa = data.get("rpa", False) if rpa is None else rpa
+ if isinstance(source, Path):
+ result.source = source
+ elif isinstance(source, str) and source[0] != "{" and Path(source).exists():
+ result.source = Path(source)
+ result.handle_suite_teardown_failures()
+ if not include_keywords:
+ result.suite.visit(KeywordRemover())
+ if flattened_keywords:
+ result.suite.visit(Flattener(flattened_keywords))
+ return result
+
+ @classmethod
+ def _get_json_loader(cls, include_keywords: bool) -> JsonLoader:
+ if include_keywords:
+ return JsonLoader()
+
+ def remove_keywords(obj):
+ obj.pop("body", None)
+ obj.pop("setup", None)
+ # Teardowns cannot be removed yet, because we need to check suite
+ # teardown status. They are removed later using KeywordRemover.
+ return obj
+
+ return JsonLoader(object_hook=remove_keywords)
+
+ @classmethod
+ def _from_full_json(cls, data) -> "Result":
+ return Result(
+ suite=TestSuite.from_dict(data["suite"]),
+ errors=ExecutionErrors(data.get("errors")),
+ generator=data.get("generator"),
+ generation_time=data.get("generated"),
+ )
- :param path: Path to save results to. If omitted, overwrites the
- original file.
+ @classmethod
+ def _from_suite_json(cls, data) -> "Result":
+ return Result(suite=TestSuite.from_dict(data))
+
+ @overload
+ def to_json(
+ self,
+ file: None = None,
+ *,
+ include_statistics: bool = True,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> str: ...
+
+ @overload
+ def to_json(
+ self,
+ file: "TextIO|Path|str",
+ *,
+ include_statistics: bool = True,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> None: ...
+
+ def to_json(
+ self,
+ file: "None|TextIO|Path|str" = None,
+ *,
+ include_statistics: bool = True,
+ ensure_ascii: bool = False,
+ indent: int = 0,
+ separators: "tuple[str, str]" = (",", ":"),
+ ) -> "str|None":
+ """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
+ """
+ data = {
+ "generator": get_full_version("Rebot"),
+ "generated": datetime.now().isoformat(),
+ "rpa": self.rpa,
+ "suite": self.suite.to_dict(),
+ }
+ if include_statistics:
+ data["statistics"] = self.statistics.to_dict()
+ data["errors"] = self.errors.messages.to_dicts()
+ return JsonDumper(
+ ensure_ascii=ensure_ascii,
+ indent=indent,
+ separators=separators,
+ ).dump(data, file)
+
+ def save(self, target=None, legacy_output=False):
+ """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.
"""
- from robot.reporting.outputwriter import OutputWriter
- self.visit(OutputWriter(path or self.source, rpa=self.rpa))
+ from robot.reporting.outputwriter import LegacyOutputWriter, OutputWriter
+
+ target = target or self.source
+ if not target:
+ raise ValueError("Path required.")
+ if is_json_source(target):
+ self.to_json(target)
+ else:
+ writer = OutputWriter if not legacy_output else LegacyOutputWriter
+ self.visit(writer(target, rpa=self.rpa))
def visit(self, visitor):
"""An entry point to visit the whole result object.
@@ -131,18 +363,19 @@ def set_execution_mode(self, other):
elif self.rpa is None:
self.rpa = other.rpa
elif self.rpa is not other.rpa:
- this, that = ('task', 'test') if other.rpa else ('test', 'task')
- raise DataError("Conflicting execution modes. File '%s' has %ss "
- "but files parsed earlier have %ss. Use '--rpa' "
- "or '--norpa' options to set the execution mode "
- "explicitly." % (other.source, this, that))
+ this, that = ("task", "test") if other.rpa else ("test", "task")
+ raise DataError(
+ f"Conflicting execution modes. File '{other.source}' has {this}s "
+ f"but files parsed earlier have {that}s. Use '--rpa' or '--norpa' "
+ f"options to set the execution mode explicitly."
+ )
class CombinedResult(Result):
"""Combined results of multiple test executions."""
def __init__(self, results=None):
- Result.__init__(self)
+ super().__init__()
for result in results or ():
self.add_result(result)
@@ -150,3 +383,13 @@ def add_result(self, other):
self.set_execution_mode(other)
self.suite.suites.append(other.suite)
self.errors.add(other.errors)
+
+
+class KeywordRemover(SuiteVisitor):
+
+ def start_suite(self, suite):
+ suite.setup = suite.teardown = None
+
+ def visit_test(self, test):
+ test.setup = test.teardown = None
+ test.body = []
diff --git a/src/robot/result/flattenkeywordmatcher.py b/src/robot/result/flattenkeywordmatcher.py
index 54a590f871f..ae44243c6a1 100644
--- a/src/robot/result/flattenkeywordmatcher.py
+++ b/src/robot/result/flattenkeywordmatcher.py
@@ -14,36 +14,51 @@
# limitations under the License.
from robot.errors import DataError
-from robot.model import TagPatterns
-from robot.utils import MultiMatcher, is_list_like
+from robot.model import SuiteVisitor, TagPatterns
+from robot.utils import html_escape, MultiMatcher
+
+from .model import Keyword
def validate_flatten_keyword(options):
for opt in options:
low = opt.lower()
- # TODO: deprecate 'foritem' in RF 5.1
- if low == 'foritem':
- low = 'iteration'
- if not (low in ('for', 'while', 'iteration') or
- low.startswith('name:') or
- low.startswith('tag:')):
- raise DataError(f"Expected 'FOR', 'WHILE', 'ITERATION', 'TAG:' or "
- f"'NAME:', got '{opt}'.")
+ # TODO: Deprecate 'foritem' in RF 7.4!
+ if low == "foritem":
+ low = "iteration"
+ if not (
+ low in ("for", "while", "iteration") or low.startswith(("name:", "tag:"))
+ ):
+ raise DataError(
+ f"Expected 'FOR', 'WHILE', 'ITERATION', 'TAG:' or "
+ f"'NAME:', got '{opt}'."
+ )
+
+
+def create_flatten_message(original):
+ if not original:
+ start = ""
+ elif original.startswith("*HTML*"):
+ start = original[6:].strip() + ""
+ else:
+ start = html_escape(original) + ""
+ return f'*HTML* {start}Content flattened.'
class FlattenByTypeMatcher:
def __init__(self, flatten):
- if not is_list_like(flatten):
+ if isinstance(flatten, str):
flatten = [flatten]
flatten = [f.lower() for f in flatten]
self.types = set()
- if 'for' in flatten:
- self.types.add('for')
- if 'while' in flatten:
- self.types.add('while')
- if 'iteration' in flatten or 'foritem' in flatten:
- self.types.add('iter')
+ if "for" in flatten:
+ self.types.add("for")
+ if "while" in flatten:
+ self.types.add("while")
+ if "iteration" in flatten or "foritem" in flatten:
+ self.types.add("iter") # Matches output.xml tag.
+ self.types.add("iteration") # Matches model object type.
def match(self, tag):
return tag in self.types
@@ -55,13 +70,13 @@ def __bool__(self):
class FlattenByNameMatcher:
def __init__(self, flatten):
- if not is_list_like(flatten):
+ if isinstance(flatten, str):
flatten = [flatten]
- names = [n[5:] for n in flatten if n[:5].lower() == 'name:']
+ names = [n[5:] for n in flatten if n[:5].lower() == "name:"]
self._matcher = MultiMatcher(names)
- def match(self, kwname, libname=None):
- name = '%s.%s' % (libname, kwname) if libname else kwname
+ def match(self, name, owner=None):
+ name = f"{owner}.{name}" if owner else name
return self._matcher.match(name)
def __bool__(self):
@@ -71,13 +86,75 @@ def __bool__(self):
class FlattenByTagMatcher:
def __init__(self, flatten):
- if not is_list_like(flatten):
+ if isinstance(flatten, str):
flatten = [flatten]
- patterns = [p[4:] for p in flatten if p[:4].lower() == 'tag:']
+ patterns = [p[4:] for p in flatten if p[:4].lower() == "tag:"]
self._matcher = TagPatterns(patterns)
- def match(self, kwtags):
- return self._matcher.match(kwtags)
+ def match(self, tags):
+ return self._matcher.match(tags)
def __bool__(self):
return bool(self._matcher)
+
+
+class Flattener(SuiteVisitor):
+
+ def __init__(self, flatten):
+ self.name_matcher = FlattenByNameMatcher(flatten)
+ self.tag_matcher = FlattenByTagMatcher(flatten)
+ self.type_matcher = FlattenByTypeMatcher(flatten)
+
+ def start_suite(self, suite):
+ return bool(self)
+
+ def start_keyword(self, kw):
+ if self.name_matcher and self.name_matcher.match(kw.name, kw.owner):
+ self._flatten(kw)
+ if self.tag_matcher and self.tag_matcher.match(kw.tags):
+ self._flatten(kw)
+
+ def start_body_item(self, item):
+ if self.type_matcher and self.type_matcher.match(item.type.lower()):
+ self._flatten(item)
+
+ def _flatten(self, item):
+ item.message = create_flatten_message(item.message)
+ item.body = MessageFinder(item).messages
+
+ def __bool__(self):
+ return bool(self.name_matcher or self.tag_matcher or self.type_matcher)
+
+
+class FlattenByTags(SuiteVisitor):
+
+ def __init__(self, flatten):
+ if isinstance(flatten, str):
+ flatten = [flatten]
+ patterns = [p[4:] for p in flatten if p[:4].lower() == "tag:"]
+ self.matcher = TagPatterns(patterns)
+
+ def start_suite(self, suite):
+ return bool(self.matcher)
+
+ def start_keyword(self, keyword: Keyword):
+ if self.matcher.match(keyword.tags):
+ keyword.message = create_flatten_message(keyword.message)
+ keyword.body = MessageFinder(keyword).messages
+
+
+class MessageFinder(SuiteVisitor):
+
+ def __init__(self, keyword: Keyword):
+ self.messages = []
+ keyword.visit(self)
+
+ def visit_message(self, message):
+ self.messages.append(message)
+
+
+# TODO: Refactor this module in RF 7.4.
+# - Currently code working with XML tags and model objects is somewhat messy.
+# Either separate it better or make it more generic.
+# - MessageFinder API is now that nice.
+# - The module doesn't anymore contain only matchers so it should be renamed.
diff --git a/src/robot/result/keywordremover.py b/src/robot/result/keywordremover.py
index 9e58eb1b7ae..f3f2f0778b7 100644
--- a/src/robot/result/keywordremover.py
+++ b/src/robot/result/keywordremover.py
@@ -13,37 +13,44 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC
+
from robot.errors import DataError
from robot.model import SuiteVisitor, TagPattern
-from robot.utils import Matcher, plural_or_not
-
-
-def KeywordRemover(how):
- upper = how.upper()
- if upper.startswith('NAME:'):
- return ByNameKeywordRemover(pattern=how[5:])
- if upper.startswith('TAG:'):
- return ByTagKeywordRemover(pattern=how[4:])
- try:
- return {'ALL': AllKeywordsRemover,
- 'PASSED': PassedKeywordRemover,
- 'FOR': ForLoopItemsRemover,
- 'WHILE': WhileLoopItemsRemover,
- 'WUKS': WaitUntilKeywordSucceedsRemover}[upper]()
- except KeyError:
- raise DataError(f"Expected 'ALL', 'PASSED', 'NAME:', 'TAG:', "
- f"'FOR' or 'WUKS', got '{how}'.")
+from robot.utils import html_escape, Matcher, plural_or_not
-class _KeywordRemover(SuiteVisitor):
- _message = 'Keyword data removed using --RemoveKeywords option.'
+class KeywordRemover(SuiteVisitor, ABC):
+ message = "Content removed using the --remove-keywords option."
def __init__(self):
- self._removal_message = RemovalMessage(self._message)
+ self.removal_message = RemovalMessage(self.message)
+
+ @classmethod
+ def from_config(cls, conf):
+ upper = conf.upper()
+ if upper.startswith("NAME:"):
+ return ByNameKeywordRemover(pattern=conf[5:])
+ if upper.startswith("TAG:"):
+ return ByTagKeywordRemover(pattern=conf[4:])
+ try:
+ return {
+ "ALL": AllKeywordsRemover,
+ "PASSED": PassedKeywordRemover,
+ "FOR": ForLoopItemsRemover,
+ "WHILE": WhileLoopItemsRemover,
+ "WUKS": WaitUntilKeywordSucceedsRemover,
+ }[upper]()
+ except KeyError:
+ raise DataError(
+ f"Expected 'ALL', 'PASSED', 'NAME:', "
+ f"'TAG:', 'FOR' or 'WUKS', got '{conf}'."
+ )
def _clear_content(self, item):
- item.body.clear()
- self._removal_message.set(item)
+ if item.body:
+ item.body.clear()
+ self.removal_message.set_to(item)
def _failed_or_warning_or_error(self, item):
return not item.passed or self._warning_or_error(item)
@@ -54,64 +61,79 @@ def _warning_or_error(self, item):
return finder.found
-class AllKeywordsRemover(_KeywordRemover):
+class AllKeywordsRemover(KeywordRemover):
- def visit_keyword(self, keyword):
- self._clear_content(keyword)
+ def start_test(self, test):
+ test.body = test.body.filter(messages=False)
+
+ def start_body_item(self, item):
+ self._clear_content(item)
- def visit_for(self, for_):
- self._clear_content(for_)
+ def start_if(self, item):
+ pass
+
+ def start_if_branch(self, item):
+ self._clear_content(item)
+
+ def start_try(self, item):
+ pass
- def visit_if_branch(self, branch):
- self._clear_content(branch)
+ def start_try_branch(self, item):
+ self._clear_content(item)
-class PassedKeywordRemover(_KeywordRemover):
+class PassedKeywordRemover(KeywordRemover):
def start_suite(self, suite):
- if not suite.statistics.failed:
- for keyword in suite.setup, suite.teardown:
- if not self._warning_or_error(keyword):
- self._clear_content(keyword)
+ if not suite.failed:
+ self._remove_setup_and_teardown(suite)
def visit_test(self, test):
if not self._failed_or_warning_or_error(test):
- for keyword in test.body:
- self._clear_content(keyword)
+ test.body = test.body.filter(messages=False)
+ for item in test.body:
+ self._clear_content(item)
+ self._remove_setup_and_teardown(test)
def visit_keyword(self, keyword):
pass
+ def _remove_setup_and_teardown(self, item):
+ if item.has_setup and not self._warning_or_error(item.setup):
+ self._clear_content(item.setup)
+ if item.has_teardown and not self._warning_or_error(item.teardown):
+ self._clear_content(item.teardown)
+
-class ByNameKeywordRemover(_KeywordRemover):
+class ByNameKeywordRemover(KeywordRemover):
def __init__(self, pattern):
- _KeywordRemover.__init__(self)
- self._matcher = Matcher(pattern, ignore='_')
+ super().__init__()
+ self._matcher = Matcher(pattern, ignore="_")
def start_keyword(self, kw):
- if self._matcher.match(kw.name) and not self._warning_or_error(kw):
+ if self._matcher.match(kw.full_name) and not self._warning_or_error(kw):
self._clear_content(kw)
-class ByTagKeywordRemover(_KeywordRemover):
+class ByTagKeywordRemover(KeywordRemover):
def __init__(self, pattern):
- _KeywordRemover.__init__(self)
- self._pattern = TagPattern(pattern)
+ super().__init__()
+ self._pattern = TagPattern.from_string(pattern)
def start_keyword(self, kw):
if self._pattern.match(kw.tags) and not self._warning_or_error(kw):
self._clear_content(kw)
-class _LoopItemsRemover(_KeywordRemover):
- _message = '%d passing step%s removed using --RemoveKeywords option.'
+class LoopItemsRemover(KeywordRemover, ABC):
+ message = "{count} passing item{s} removed using the --remove-keywords option."
def _remove_from_loop(self, loop):
before = len(loop.body)
self._remove_keywords(loop.body)
- self._removal_message.set_if_removed(loop, before)
+ self.removal_message.set_to_if_removed(loop, before)
def _remove_keywords(self, body):
iterations = body.filter(messages=False)
@@ -120,29 +142,29 @@ def _remove_keywords(self, body):
body.remove(it)
-class ForLoopItemsRemover(_LoopItemsRemover):
+class ForLoopItemsRemover(LoopItemsRemover):
def start_for(self, for_):
self._remove_from_loop(for_)
-class WhileLoopItemsRemover(_LoopItemsRemover):
+class WhileLoopItemsRemover(LoopItemsRemover):
def start_while(self, while_):
self._remove_from_loop(while_)
-class WaitUntilKeywordSucceedsRemover(_KeywordRemover):
- _message = '%d failing step%s removed using --RemoveKeywords option.'
+class WaitUntilKeywordSucceedsRemover(KeywordRemover):
+ message = "{count} failing item{s} removed using the --remove-keywords option."
def start_keyword(self, kw):
- if kw.libname == 'BuiltIn' and kw.kwname == 'Wait Until Keyword Succeeds':
+ if kw.owner == "BuiltIn" and kw.name == "Wait Until Keyword Succeeds":
before = len(kw.body)
self._remove_keywords(kw.body)
- self._removal_message.set_if_removed(kw, before)
+ self.removal_message.set_to_if_removed(kw, before)
def _remove_keywords(self, body):
- keywords = body.filter(messages=False)
+ keywords = body.filter(keywords=True)
if keywords:
include_from_end = 2 if keywords[-1].passed else 1
for kw in keywords[:-include_from_end]:
@@ -165,19 +187,27 @@ def start_keyword(self, keyword):
return not self.found
def visit_message(self, msg):
- if msg.level in ('WARN', 'ERROR'):
+ if msg.level in ("WARN", "ERROR"):
self.found = True
class RemovalMessage:
def __init__(self, message):
- self._message = message
+ self.message = message
- def set_if_removed(self, kw, len_before):
- removed = len_before - len(kw.body)
+ def set_to_if_removed(self, item, len_before):
+ removed = len_before - len(item.body)
if removed:
- self.set(kw, self._message % (removed, plural_or_not(removed)))
-
- def set(self, kw, message=None):
- kw.doc = ('%s\n\n_%s_' % (kw.doc, message or self._message)).strip()
+ message = self.message.format(count=removed, s=plural_or_not(removed))
+ self.set_to(item, message)
+
+ def set_to(self, item, message=None):
+ if not item.message:
+ start = ""
+ elif item.message.startswith("*HTML*"):
+ start = item.message[6:].strip() + ""
+ else:
+ start = html_escape(item.message) + ""
+ message = message or self.message
+ item.message = f'*HTML* {start}{message}'
diff --git a/src/robot/result/merger.py b/src/robot/result/merger.py
index fec380a2363..320f3530cf2 100644
--- a/src/robot/result/merger.py
+++ b/src/robot/result/merger.py
@@ -36,21 +36,24 @@ def start_suite(self, suite):
else:
old = self._find(self.current.suites, suite.name)
if old is not None:
- old.starttime = old.endtime = None
+ old.start_time = old.end_time = old.elapsed_time = None
+ old.doc = suite.doc
+ old.metadata.update(suite.metadata)
old.setup = suite.setup
old.teardown = suite.teardown
self.current = old
else:
suite.message = self._create_add_message(suite, suite=True)
self.current.suites.append(suite)
- return bool(old)
+ return old is not None
def _find_root(self, name):
root = self.result.suite
if root.name != name:
- raise DataError("Cannot merge outputs containing different root suites. "
- "Original suite is '%s' and merged is '%s'."
- % (root.name, name))
+ raise DataError(
+ f"Cannot merge outputs containing different root suites. "
+ f"Original suite is '{root.name}' and merged is '{name}'."
+ )
return root
def _find(self, items, name):
@@ -75,60 +78,64 @@ def visit_test(self, test):
self.current.tests[index] = test
def _create_add_message(self, item, suite=False):
- item_type = 'Suite' if suite else test_or_task('{Test}', self.rpa)
- prefix = '*HTML* %s added from merged output.' % item_type
+ item_type = "Suite" if suite else test_or_task("Test", self.rpa)
+ prefix = f"*HTML* {item_type} added from merged output."
if not item.message:
return prefix
- return ''.join([prefix, '', self._html(item.message)])
+ return "".join([prefix, "", self._html(item.message)])
def _html(self, message):
- if message.startswith('*HTML*'):
+ if message.startswith("*HTML*"):
return message[6:].lstrip()
return html_escape(message)
def _create_merge_message(self, new, old):
- header = test_or_task('*HTML* '
- '{Test} has been re-executed and results merged.'
- '', self.rpa)
- return ''.join([
+ header = (
+ f'*HTML* {test_or_task("Test", self.rpa)} '
+ f"has been re-executed and results merged."
+ )
+ parts = [
header,
- '',
- self._format_status_and_message('New', new),
- '',
- self._format_old_status_and_message(old, header)
- ])
+ "",
+ self._format_status_and_message("New", new),
+ "",
+ self._format_old_status_and_message(old, header),
+ ]
+ return "".join(parts)
def _format_status_and_message(self, state, test):
- message = '%s %s ' % (self._status_header(state),
- self._status_text(test.status))
+ msg = f"{self._status_header(state)} {self._status_text(test.status)} "
if test.message:
- message += '%s %s ' % (self._message_header(state),
- self._html(test.message))
- return message
+ msg += f"{self._message_header(state)} {self._html(test.message)} "
+ return msg
def _status_header(self, state):
- return '%s status:' % (state.lower(), state)
+ return f'{state} status:'
def _status_text(self, status):
- return '%s' % (status.lower(), status)
+ return f'{status}'
def _message_header(self, state):
- return '%s message:' % (state.lower(), state)
+ return f'{state} message:'
def _format_old_status_and_message(self, test, merge_header):
if not test.message.startswith(merge_header):
- return self._format_status_and_message('Old', test)
- status_and_message = test.message.split('', 1)[1]
- return (
- status_and_message
- .replace(self._status_header('New'), self._status_header('Old'))
- .replace(self._message_header('New'), self._message_header('Old'))
+ return self._format_status_and_message("Old", test)
+ status_and_message = test.message.split("", 1)[1]
+ return status_and_message.replace(
+ self._status_header("New"),
+ self._status_header("Old"),
+ ).replace(
+ self._message_header("New"),
+ self._message_header("Old"),
)
def _create_skip_message(self, test, new):
- msg = test_or_task('*HTML* {Test} has been re-executed and results merged. '
- 'Latter result had %s status and was ignored. Message:\n%s'
- % (self._status_text('SKIP'), self._html(new.message)))
- if not test.message:
- return msg
- return '%sOriginal message:\n%s' % (msg, self._html(test.message))
+ msg = (
+ f"*HTML* {test_or_task('Test', self.rpa)} has been re-executed and "
+ f"results merged. Latter result had {self._status_text('SKIP')} "
+ f"status and was ignored. Message:\n{self._html(new.message)}"
+ )
+ if test.message:
+ msg += f"Original message:\n{self._html(test.message)}"
+ return msg
diff --git a/src/robot/result/messagefilter.py b/src/robot/result/messagefilter.py
index 29c7ed19967..8a5fafcaea8 100644
--- a/src/robot/result/messagefilter.py
+++ b/src/robot/result/messagefilter.py
@@ -13,21 +13,24 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.output.loggerhelper import IsLogged
+from robot import output
-from robot.model import SuiteVisitor
+from .visitor import ResultVisitor
-class MessageFilter(SuiteVisitor):
+class MessageFilter(ResultVisitor):
- def __init__(self, log_level=None):
- self.is_logged = IsLogged(log_level or 'TRACE')
+ def __init__(self, level="TRACE"):
+ log_level = output.LogLevel(level or "TRACE")
+ self.log_all = log_level.level == "TRACE"
+ self.is_logged = log_level.is_logged
def start_suite(self, suite):
- if self.is_logged.level == 'TRACE':
+ if self.log_all:
return False
- def start_keyword(self, keyword):
- for item in list(keyword.body):
- if item.type == item.MESSAGE and not self.is_logged(item.level):
- keyword.body.remove(item)
+ def start_body_item(self, item):
+ if hasattr(item, "body"):
+ for msg in item.body.filter(messages=True):
+ if not self.is_logged(msg):
+ item.body.remove(msg)
diff --git a/src/robot/result/model.py b/src/robot/result/model.py
index ba35c934c84..f48f2e41c8e 100644
--- a/src/robot/result/model.py
+++ b/src/robot/result/model.py
@@ -16,7 +16,7 @@
"""Module implementing result related model objects.
During test execution these objects are created internally by various runners.
-At that time they can inspected and modified by listeners__.
+At that time they can be inspected and modified by listeners__.
When results are parsed from XML output files after execution to be able to
create logs and reports, these objects are created by the
@@ -27,85 +27,243 @@
by custom scripts and tools. In such usage it is often easiest to inspect and
modify these objects using the :mod:`visitor interface `.
+If classes defined here are needed, for example, as type hints, they can
+be imported via the :mod:`robot.running` module.
+
__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface
__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#programmatic-modification-of-results
-
"""
-from collections import OrderedDict
-from itertools import chain
-import warnings
+from datetime import datetime, timedelta
+from io import StringIO
+from pathlib import Path
+from typing import Literal, Mapping, overload, Sequence, TextIO, TypeVar, Union
from robot import model
-from robot.model import BodyItem, Keywords, TotalStatisticsBuilder
-from robot.utils import get_elapsed_time, setter
+from robot.model import (
+ BodyItem, create_fixture, DataDict, Tags, TestSuites, TotalStatistics,
+ TotalStatisticsBuilder
+)
+from robot.utils import setter
from .configurer import SuiteConfigurer
-from .messagefilter import MessageFilter
-from .modeldeprecation import deprecated, DeprecatedAttributesMixin
from .keywordremover import KeywordRemover
+from .messagefilter import MessageFilter
+from .modeldeprecation import DeprecatedAttributesMixin
from .suiteteardownfailed import SuiteTeardownFailed, SuiteTeardownFailureHandler
+IT = TypeVar("IT", bound="IfBranch|TryBranch")
+FW = TypeVar("FW", bound="ForIteration|WhileIteration")
+BodyItemParent = Union[
+ "TestSuite", "TestCase", "Keyword", "For", "ForIteration", "If", "IfBranch",
+ "Try", "TryBranch", "While", "WhileIteration", "Group", None
+] # fmt: skip
-class Body(model.Body):
- __slots__ = []
+class Body(model.BaseBody[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error"
+]): # fmt: skip
+ __slots__ = ()
-class Branches(model.Branches):
- __slots__ = []
+class Branches(model.BaseBranches[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error", IT
+]): # fmt: skip
+ __slots__ = ()
-class Iterations(model.BaseBody):
- __slots__ = ['iteration_class']
- def __init__(self, iteration_class, parent=None, items=None):
- self.iteration_class = iteration_class
- super().__init__(parent, items)
-
- def create_iteration(self, *args, **kwargs):
- return self.append(self.iteration_class(*args, **kwargs))
+class Iterations(model.BaseIterations[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "Message", "Error", FW
+]): # fmt: skip
+ __slots__ = ()
@Body.register
@Branches.register
@Iterations.register
class Message(model.Message):
- __slots__ = []
+ __slots__ = ()
+
+ def to_dict(self, include_type=True) -> DataDict:
+ if not include_type:
+ return super().to_dict()
+ return {"type": self.type, **super().to_dict()}
class StatusMixin:
- __slots__ = []
- PASS = 'PASS'
- FAIL = 'FAIL'
- SKIP = 'SKIP'
- NOT_RUN = 'NOT RUN'
- NOT_SET = 'NOT SET'
+ PASS = "PASS"
+ FAIL = "FAIL"
+ SKIP = "SKIP"
+ NOT_RUN = "NOT RUN"
+ NOT_SET = "NOT SET"
+ status: Literal["PASS", "FAIL", "SKIP", "NOT RUN", "NOT SET"]
+ __slots__ = ()
@property
- def elapsedtime(self):
- """Total execution time in milliseconds."""
- return get_elapsed_time(self.starttime, self.endtime)
+ def start_time(self) -> "datetime|None":
+ """Execution start time as a ``datetime`` or as a ``None`` if not set.
+
+ If start time is not set, it is calculated based :attr:`end_time`
+ and :attr:`elapsed_time` if possible.
+
+ Can be set either directly as a ``datetime`` or as a string in ISO 8601
+ format.
+
+ New in Robot Framework 6.1. Heavily enhanced in Robot Framework 7.0.
+ """
+ if self._start_time:
+ return self._start_time
+ if self._end_time:
+ return self._end_time - self.elapsed_time
+ return None
+
+ @start_time.setter
+ def start_time(self, start_time: "datetime|str|None"):
+ if isinstance(start_time, str):
+ start_time = datetime.fromisoformat(start_time)
+ self._start_time = start_time
@property
- def passed(self):
+ def end_time(self) -> "datetime|None":
+ """Execution end time as a ``datetime`` or as a ``None`` if not set.
+
+ If end time is not set, it is calculated based :attr:`start_time`
+ and :attr:`elapsed_time` if possible.
+
+ Can be set either directly as a ``datetime`` or as a string in ISO 8601
+ format.
+
+ New in Robot Framework 6.1. Heavily enhanced in Robot Framework 7.0.
+ """
+ if self._end_time:
+ return self._end_time
+ if self._start_time:
+ return self._start_time + self.elapsed_time
+ return None
+
+ @end_time.setter
+ def end_time(self, end_time: "datetime|str|None"):
+ if isinstance(end_time, str):
+ end_time = datetime.fromisoformat(end_time)
+ self._end_time = end_time
+
+ @property
+ def elapsed_time(self) -> timedelta:
+ """Total execution time as a ``timedelta``.
+
+ If not set, calculated based on :attr:`start_time` and :attr:`end_time`
+ if possible. If that fails, calculated based on the elapsed time of
+ child items.
+
+ Can be set either directly as a ``timedelta`` or as an integer or a float
+ representing seconds.
+
+ New in Robot Framework 6.1. Heavily enhanced in Robot Framework 7.0.
+ """
+ if self._elapsed_time is not None:
+ return self._elapsed_time
+ if self._start_time and self._end_time:
+ return self._end_time - self._start_time
+ return self._elapsed_time_from_children()
+
+ def _elapsed_time_from_children(self) -> timedelta:
+ elapsed = timedelta()
+ for child in self.body:
+ if hasattr(child, "elapsed_time"):
+ elapsed += child.elapsed_time
+ if getattr(self, "has_setup", False):
+ elapsed += self.setup.elapsed_time
+ if getattr(self, "has_teardown", False):
+ elapsed += self.teardown.elapsed_time
+ return elapsed
+
+ @elapsed_time.setter
+ def elapsed_time(self, elapsed_time: "timedelta|int|float|None"):
+ if isinstance(elapsed_time, (int, float)):
+ elapsed_time = timedelta(seconds=elapsed_time)
+ self._elapsed_time = elapsed_time
+
+ @property
+ def starttime(self) -> "str|None":
+ """Execution start time as a string or as a ``None`` if not set.
+
+ The string format is ``%Y%m%d %H:%M:%S.%f``.
+
+ Considered deprecated starting from Robot Framework 7.0.
+ :attr:`start_time` should be used instead.
+ """
+ return self._datetime_to_timestr(self.start_time)
+
+ @starttime.setter
+ def starttime(self, starttime: "str|None"):
+ self.start_time = self._timestr_to_datetime(starttime)
+
+ @property
+ def endtime(self) -> "str|None":
+ """Execution end time as a string or as a ``None`` if not set.
+
+ The string format is ``%Y%m%d %H:%M:%S.%f``.
+
+ Considered deprecated starting from Robot Framework 7.0.
+ :attr:`end_time` should be used instead.
+ """
+ return self._datetime_to_timestr(self.end_time)
+
+ @endtime.setter
+ def endtime(self, endtime: "str|None"):
+ self.end_time = self._timestr_to_datetime(endtime)
+
+ @property
+ def elapsedtime(self) -> int:
+ """Total execution time in milliseconds.
+
+ Considered deprecated starting from Robot Framework 7.0.
+ :attr:`elapsed_time` should be used instead.
+ """
+ return round(self.elapsed_time.total_seconds() * 1000)
+
+ def _timestr_to_datetime(self, ts: "str|None") -> "datetime|None":
+ if not ts:
+ return None
+ ts = ts.ljust(24, "0")
+ return datetime(
+ int(ts[:4]),
+ int(ts[4:6]),
+ int(ts[6:8]),
+ int(ts[9:11]),
+ int(ts[12:14]),
+ int(ts[15:17]),
+ int(ts[18:24]),
+ )
+
+ def _datetime_to_timestr(self, dt: "datetime|None") -> "str|None":
+ if not dt:
+ return None
+ return dt.isoformat(" ", timespec="milliseconds").replace("-", "")
+
+ @property
+ def passed(self) -> bool:
"""``True`` when :attr:`status` is 'PASS', ``False`` otherwise."""
return self.status == self.PASS
@passed.setter
- def passed(self, passed):
+ def passed(self, passed: bool):
self.status = self.PASS if passed else self.FAIL
@property
- def failed(self):
+ def failed(self) -> bool:
"""``True`` when :attr:`status` is 'FAIL', ``False`` otherwise."""
return self.status == self.FAIL
@failed.setter
- def failed(self, failed):
+ def failed(self, failed: bool):
self.status = self.FAIL if failed else self.PASS
@property
- def skipped(self):
+ def skipped(self) -> bool:
"""``True`` when :attr:`status` is 'SKIP', ``False`` otherwise.
Setting to ``False`` value is ambiguous and raises an exception.
@@ -113,13 +271,13 @@ def skipped(self):
return self.status == self.SKIP
@skipped.setter
- def skipped(self, skipped):
+ def skipped(self, skipped: Literal[True]):
if not skipped:
- raise ValueError("`skipped` value must be truthy, got '%s'." % skipped)
+ raise ValueError(f"`skipped` value must be truthy, got '{skipped}'.")
self.status = self.SKIP
@property
- def not_run(self):
+ def not_run(self) -> bool:
"""``True`` when :attr:`status` is 'NOT RUN', ``False`` otherwise.
Setting to ``False`` value is ambiguous and raises an exception.
@@ -127,205 +285,374 @@ def not_run(self):
return self.status == self.NOT_RUN
@not_run.setter
- def not_run(self, not_run):
+ def not_run(self, not_run: Literal[True]):
if not not_run:
- raise ValueError("`not_run` value must be truthy, got '%s'." % not_run)
+ raise ValueError(f"`not_run` value must be truthy, got '{not_run}'.")
self.status = self.NOT_RUN
+ def to_dict(self):
+ data = {
+ "status": self.status,
+ "elapsed_time": self.elapsed_time.total_seconds(),
+ }
+ if self.start_time:
+ data["start_time"] = self.start_time.isoformat()
+ if self.message:
+ data["message"] = self.message
+ return data
-class ForIteration(BodyItem, StatusMixin, DeprecatedAttributesMixin):
- """Represents one FOR loop iteration."""
- type = BodyItem.ITERATION
- body_class = Body
- repr_args = ('variables',)
- __slots__ = ['variables', 'status', 'starttime', 'endtime', 'doc']
- def __init__(self, variables=None, status='FAIL', starttime=None, endtime=None,
- doc='', parent=None):
- self.variables = variables or OrderedDict()
- self.parent = parent
+class ForIteration(model.ForIteration, StatusMixin, DeprecatedAttributesMixin):
+ body_class = Body
+ __slots__ = (
+ "assign",
+ "message",
+ "status",
+ "_start_time",
+ "_end_time",
+ "_elapsed_time",
+ )
+
+ def __init__(
+ self,
+ assign: "Mapping[str, str]|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(assign, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
- self.body = None
-
- @setter
- def body(self, body):
- return self.body_class(self, body)
-
- def visit(self, visitor):
- visitor.visit_for_iteration(self)
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
- @property
- @deprecated
- def name(self):
- return ', '.join('%s = %s' % item for item in self.variables.items())
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
@Body.register
class For(model.For, StatusMixin, DeprecatedAttributesMixin):
- iterations_class = Iterations
iteration_class = ForIteration
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
-
- def __init__(self, variables=(), flavor='IN', values=(), status='FAIL',
- starttime=None, endtime=None, doc='', parent=None):
- super().__init__(variables, flavor, values, parent)
+ iterations_class = Iterations[iteration_class]
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ assign: Sequence[str] = (),
+ flavor: Literal["IN", "IN RANGE", "IN ENUMERATE", "IN ZIP"] = "IN",
+ values: Sequence[str] = (),
+ start: "str|None" = None,
+ mode: "str|None" = None,
+ fill: "str|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(assign, flavor, values, start, mode, fill, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
@setter
- def body(self, iterations):
+ def body(self, iterations: "Sequence[ForIteration|DataDict]") -> iterations_class:
return self.iterations_class(self.iteration_class, self, iterations)
@property
- @deprecated
- def name(self):
- return '%s %s [ %s ]' % (' | '.join(self.variables), self.flavor,
- ' | '.join(self.values))
+ def _log_name(self):
+ return str(self)[7:] # Drop 'FOR ' prefix.
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
-class WhileIteration(BodyItem, StatusMixin, DeprecatedAttributesMixin):
- """Represents one WHILE loop iteration."""
- type = BodyItem.ITERATION
- body_class = Body
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
- def __init__(self, status='FAIL', starttime=None, endtime=None,
- doc='', parent=None):
- self.parent = parent
+class WhileIteration(model.WhileIteration, StatusMixin, DeprecatedAttributesMixin):
+ body_class = Body
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
- self.body = None
-
- @setter
- def body(self, body):
- return self.body_class(self, body)
-
- def visit(self, visitor):
- visitor.visit_while_iteration(self)
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
- @property
- @deprecated
- def name(self):
- return ''
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
@Body.register
class While(model.While, StatusMixin, DeprecatedAttributesMixin):
- iterations_class = Iterations
iteration_class = WhileIteration
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
-
- def __init__(self, condition=None, limit=None, parent=None, status='FAIL', starttime=None, endtime=None, doc=''):
- super().__init__(condition, limit, parent)
+ iterations_class = Iterations[iteration_class]
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ condition: "str|None" = None,
+ limit: "str|None" = None,
+ on_limit: "str|None" = None,
+ on_limit_message: "str|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(condition, limit, on_limit, on_limit_message, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
@setter
- def body(self, iterations):
+ def body(self, iterations: "Sequence[WhileIteration|DataDict]") -> iterations_class:
return self.iterations_class(self.iteration_class, self, iterations)
@property
- @deprecated
- def name(self):
- return self.condition + (f' | limit={self.limit}' if self.limit else '')
+ def _log_name(self):
+ return str(self)[9:] # Drop 'WHILE ' prefix.
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
-class IfBranch(model.IfBranch, StatusMixin, DeprecatedAttributesMixin):
+
+@Body.register
+class Group(model.Group, StatusMixin, DeprecatedAttributesMixin):
body_class = Body
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ name: str = "",
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(name, parent)
+ self.status = status
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
- def __init__(self, type=BodyItem.IF, condition=None, status='FAIL',
- starttime=None, endtime=None, doc='', parent=None):
+ @property
+ def _log_name(self):
+ return self.name
+
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
+
+
+class IfBranch(model.IfBranch, StatusMixin, DeprecatedAttributesMixin):
+ body_class = Body
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ type: str = BodyItem.IF,
+ condition: "str|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(type, condition, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
@property
- @deprecated
- def name(self):
- return self.condition
+ def _log_name(self):
+ return self.condition or ""
+
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
@Body.register
class If(model.If, StatusMixin, DeprecatedAttributesMixin):
branch_class = IfBranch
- branches_class = Branches
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
-
- def __init__(self, status='FAIL', starttime=None, endtime=None, doc='', parent=None):
+ branches_class = Branches[branch_class]
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
class TryBranch(model.TryBranch, StatusMixin, DeprecatedAttributesMixin):
body_class = Body
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
-
- def __init__(self, type=BodyItem.TRY, patterns=(), pattern_type=None, variable=None,
- status='FAIL', starttime=None, endtime=None, doc='', parent=None):
- super().__init__(type, patterns, pattern_type, variable, parent)
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ type: str = BodyItem.TRY,
+ patterns: Sequence[str] = (),
+ pattern_type: "str|None" = None,
+ assign: "str|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(type, patterns, pattern_type, assign, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
@property
- @deprecated
- def name(self):
- patterns = list(self.patterns)
- if self.pattern_type:
- patterns.append(f'type={self.pattern_type}')
- parts = []
- if patterns:
- parts.append(' | '.join(patterns))
- if self.variable:
- parts.append(f'AS {self.variable}')
- return ' '.join(parts)
+ def _log_name(self):
+ return str(self)[len(self.type) + 4 :] # Drop ' ' prefix.
+
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
@Body.register
class Try(model.Try, StatusMixin, DeprecatedAttributesMixin):
branch_class = TryBranch
- branches_class = Branches
- __slots__ = ['status', 'starttime', 'endtime', 'doc']
-
- def __init__(self, status='FAIL', starttime=None, endtime=None, doc='', parent=None):
+ branches_class = Branches[branch_class]
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.doc = doc
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+
+ def to_dict(self) -> DataDict:
+ return {**super().to_dict(), **StatusMixin.to_dict(self)}
@Body.register
-class Return(model.Return, StatusMixin, DeprecatedAttributesMixin):
- __slots__ = ['status', 'starttime', 'endtime']
+class Var(model.Var, StatusMixin, DeprecatedAttributesMixin):
body_class = Body
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ name: str = "",
+ value: "str|Sequence[str]" = (),
+ scope: "str|None" = None,
+ separator: "str|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(name, value, scope, separator, parent)
+ self.status = status
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self.body = ()
- def __init__(self, values=(), status='FAIL', starttime=None, endtime=None, parent=None):
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Child messages and possible other constructs.
+
+ Contains the message logged about assignment. Contains something else
+ only if running VAR has failed due to a syntax error or listeners have
+ logged messages or executed keywords.
+ """
+ return self.body_class(self, body)
+
+ @property
+ def _log_name(self):
+ return str(self)[7:] # Drop 'VAR ' prefix.
+
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ return data
+
+
+@Body.register
+class Return(model.Return, StatusMixin, DeprecatedAttributesMixin):
+ body_class = Body
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ values: Sequence[str] = (),
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(values, parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.body = None
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self.body = ()
@setter
- def body(self, body):
- """Child keywords and messages as a :class:`~.Body` object.
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Child keywords and messages.
Typically empty. Only contains something if running RETURN has failed
due to a syntax error or listeners have logged messages or executed
@@ -333,32 +660,38 @@ def body(self, body):
"""
return self.body_class(self, body)
- @property
- @deprecated
- def args(self):
- return self.values
-
- @property
- @deprecated
- def doc(self):
- return ''
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ return data
@Body.register
class Continue(model.Continue, StatusMixin, DeprecatedAttributesMixin):
- __slots__ = ['status', 'starttime', 'endtime']
body_class = Body
-
- def __init__(self, status='FAIL', starttime=None, endtime=None, parent=None):
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.body = None
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self.body = ()
@setter
- def body(self, body):
- """Child keywords and messages as a :class:`~.Body` object.
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Child keywords and messages.
Typically empty. Only contains something if running CONTINUE has failed
due to a syntax error or listeners have logged messages or executed
@@ -366,32 +699,38 @@ def body(self, body):
"""
return self.body_class(self, body)
- @property
- @deprecated
- def args(self):
- return ()
-
- @property
- @deprecated
- def doc(self):
- return ''
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ return data
@Body.register
class Break(model.Break, StatusMixin, DeprecatedAttributesMixin):
- __slots__ = ['status', 'starttime', 'endtime']
body_class = Body
-
- def __init__(self, status='FAIL', starttime=None, endtime=None, parent=None):
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
super().__init__(parent)
self.status = status
- self.starttime = starttime
- self.endtime = endtime
- self.body = None
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self.body = ()
@setter
- def body(self, body):
- """Child keywords and messages as a :class:`~.Body` object.
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Child keywords and messages.
Typically empty. Only contains something if running BREAK has failed
due to a syntax error or listeners have logged messages or executed
@@ -399,184 +738,375 @@ def body(self, body):
"""
return self.body_class(self, body)
- @property
- @deprecated
- def args(self):
- return ()
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ return data
- @property
- @deprecated
- def doc(self):
- return ''
+
+@Body.register
+class Error(model.Error, StatusMixin, DeprecatedAttributesMixin):
+ body_class = Body
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ values: Sequence[str] = (),
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(values, parent)
+ self.status = status
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self.body = ()
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Body typically containing only the related error message."""
+ return self.body_class(self, body)
+
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ return data
@Body.register
@Branches.register
@Iterations.register
class Keyword(model.Keyword, StatusMixin):
- """Represents results of a single keyword.
+ """Represents an executed library or user keyword."""
- See the base class for documentation of attributes not documented here.
- """
body_class = Body
- __slots__ = ['kwname', 'libname', 'status', 'starttime', 'endtime', 'message',
- 'sourcename']
-
- def __init__(self, kwname='', libname='', doc='', args=(), assign=(), tags=(),
- timeout=None, type=BodyItem.KEYWORD, status='FAIL', starttime=None,
- endtime=None, parent=None, sourcename=None):
- super().__init__(None, doc, args, assign, tags, timeout, type, parent)
- #: Name of the keyword without library or resource name.
- self.kwname = kwname
+ __slots__ = (
+ "owner",
+ "source_name",
+ "doc",
+ "timeout",
+ "status",
+ "message",
+ "_start_time",
+ "_end_time",
+ "_elapsed_time",
+ "_setup",
+ "_teardown",
+ )
+
+ def __init__(
+ self,
+ name: "str|None" = "",
+ owner: "str|None" = None,
+ source_name: "str|None" = None,
+ doc: str = "",
+ args: Sequence[str] = (),
+ assign: Sequence[str] = (),
+ tags: Sequence[str] = (),
+ timeout: "str|None" = None,
+ type: str = BodyItem.KEYWORD,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: BodyItemParent = None,
+ ):
+ super().__init__(name, args, assign, type, parent)
#: Name of the library or resource containing this keyword.
- self.libname = libname
- #: Execution status as a string. ``PASS``, ``FAIL``, ``SKIP`` or ``NOT RUN``.
- self.status = status
- #: Keyword execution start time in format ``%Y%m%d %H:%M:%S.%f``.
- self.starttime = starttime
- #: Keyword execution end time in format ``%Y%m%d %H:%M:%S.%f``.
- self.endtime = endtime
- #: Keyword status message. Used only if suite teardowns fails.
- self.message = ''
+ self.owner = owner
#: Original name of keyword with embedded arguments.
- self.sourcename = sourcename
- self.body = None
+ self.source_name = source_name
+ self.doc = doc
+ self.tags = tags
+ self.timeout = timeout
+ self.status = status
+ self.message = message
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+ self._setup = None
+ self._teardown = None
+ self.body = ()
@setter
- def body(self, body):
- """Child keywords and messages as a :class:`~.Body` object."""
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Keyword body.
+
+ Body can consist of child keywords, messages, and control structures
+ such as IF/ELSE.
+ """
return self.body_class(self, body)
@property
- def keywords(self):
- """Deprecated since Robot Framework 4.0.
+ def messages(self) -> "list[Message]":
+ """Keyword's messages.
- Use :attr:`body` or :attr:`teardown` instead.
+ Starting from Robot Framework 4.0 this is a list generated from messages
+ in :attr:`body`.
"""
- keywords = self.body.filter(messages=False)
- if self.teardown:
- keywords.append(self.teardown)
- return Keywords(self, keywords)
+ return self.body.filter(messages=True) # type: ignore
+
+ @property
+ def full_name(self) -> "str|None":
+ """Keyword name in format ``owner.name``.
+
+ Just ``name`` if :attr:`owner` is not set. In practice this is the
+ case only with user keywords in the suite file.
- @keywords.setter
- def keywords(self, keywords):
- Keywords.raise_deprecation_error()
+ Cannot be set directly. Set :attr:`name` and :attr:`owner` separately
+ instead.
+ Notice that prior to Robot Framework 7.0, the ``name`` attribute contained
+ the full name and keyword and owner names were in ``kwname`` and ``libname``,
+ respectively.
+ """
+ return f"{self.owner}.{self.name}" if self.owner else self.name
+
+ # TODO: Deprecate 'kwname', 'libname' and 'sourcename' loudly in RF 8.
@property
- def messages(self):
- """Keyword's messages.
+ def kwname(self) -> "str|None":
+ """Deprecated since Robot Framework 7.0. Use :attr:`name` instead."""
+ return self.name
- Starting from Robot Framework 4.0 this is a list generated from messages
- in :attr:`body`.
+ @kwname.setter
+ def kwname(self, name: "str|None"):
+ self.name = name
+
+ @property
+ def libname(self) -> "str|None":
+ """Deprecated since Robot Framework 7.0. Use :attr:`owner` instead."""
+ return self.owner
+
+ @libname.setter
+ def libname(self, name: "str|None"):
+ self.owner = name
+
+ @property
+ def sourcename(self) -> str:
+ """Deprecated since Robot Framework 7.0. Use :attr:`source_name` instead."""
+ return self.source_name
+
+ @sourcename.setter
+ def sourcename(self, name: str):
+ self.source_name = name
+
+ @property
+ def setup(self) -> "Keyword":
+ """Keyword setup.
+
+ See :attr:`teardown` for more information. New in Robot Framework 7.0.
"""
- return self.body.filter(messages=True)
+ if self._setup is None:
+ self.setup = None
+ return self._setup
+
+ @setup.setter
+ def setup(self, setup: "Keyword|DataDict|None"):
+ self._setup = create_fixture(self.__class__, setup, self, self.SETUP)
@property
- def children(self):
- """List of child keywords and messages in creation order.
+ def has_setup(self) -> bool:
+ """Check does a keyword have a setup without creating a setup object.
- Deprecated since Robot Framework 4.0. Use :att:`body` instead.
+ See :attr:`has_teardown` for more information. New in Robot Framework 7.0.
"""
- warnings.warn("'Keyword.children' is deprecated. Use 'Keyword.body' instead.")
- return list(self.body)
+ return bool(self._setup)
@property
- def name(self):
- """Keyword name in format ``libname.kwname``.
+ def teardown(self) -> "Keyword":
+ """Keyword teardown.
+
+ Teardown can be modified by setting attributes directly::
+
+ keyword.teardown.name = 'Example'
+ keyword.teardown.args = ('First', 'Second')
+
+ Alternatively the :meth:`config` method can be used to set multiple
+ attributes in one call::
- Just ``kwname`` if :attr:`libname` is empty. In practice that is the
- case only with user keywords in the same file as the executed test case
- or test suite.
+ keyword.teardown.config(name='Example', args=('First', 'Second'))
- Cannot be set directly. Set :attr:`libname` and :attr:`kwname`
- separately instead.
+ The easiest way to reset the whole teardown is setting it to ``None``.
+ It will automatically recreate the underlying ``Keyword`` object::
+
+ keyword.teardown = None
+
+ This attribute is a ``Keyword`` object also when a keyword has no teardown
+ but in that case its truth value is ``False``. If there is a need to just
+ check does a keyword have a teardown, using the :attr:`has_teardown`
+ attribute avoids creating the ``Keyword`` object and is thus more memory
+ efficient.
+
+ New in Robot Framework 4.0. Earlier teardown was accessed like
+ ``keyword.keywords.teardown``. :attr:`has_teardown` is new in Robot
+ Framework 4.1.2.
"""
- if not self.libname:
- return self.kwname
- return '%s.%s' % (self.libname, self.kwname)
+ if self._teardown is None:
+ self.teardown = None
+ return self._teardown
+
+ @teardown.setter
+ def teardown(self, teardown: "Keyword|DataDict|None"):
+ self._teardown = create_fixture(self.__class__, teardown, self, self.TEARDOWN)
+
+ @property
+ def has_teardown(self) -> bool:
+ """Check does a keyword have a teardown without creating a teardown object.
- @name.setter
- def name(self, name):
- if name is not None:
- raise AttributeError("Cannot set 'name' attribute directly. "
- "Set 'kwname' and 'libname' separately instead.")
- self.kwname = None
- self.libname = None
+ A difference between using ``if kw.has_teardown:`` and ``if kw.teardown:``
+ is that accessing the :attr:`teardown` attribute creates a :class:`Keyword`
+ object representing a teardown even when the keyword actually does not
+ have one. This typically does not matter, but with bigger suite structures
+ having lots of keywords it can have a considerable effect on memory usage.
+ New in Robot Framework 4.1.2.
+ """
+ return bool(self._teardown)
-class TestCase(model.TestCase, StatusMixin):
+ @setter
+ def tags(self, tags: Sequence[str]) -> model.Tags:
+ """Keyword tags."""
+ return Tags(tags)
+
+ def to_dict(self) -> DataDict:
+ data = {**super().to_dict(), **StatusMixin.to_dict(self)}
+ if self.owner:
+ data["owner"] = self.owner
+ if self.source_name:
+ data["source_name"] = self.source_name
+ if self.doc:
+ data["doc"] = self.doc
+ if self.tags:
+ data["tags"] = list(self.tags)
+ if self.timeout:
+ data["timeout"] = self.timeout
+ if self.body:
+ data["body"] = self.body.to_dicts()
+ if self.has_setup:
+ data["setup"] = self.setup.to_dict()
+ if self.has_teardown:
+ data["teardown"] = self.teardown.to_dict()
+ return data
+
+
+class TestCase(model.TestCase[Keyword], StatusMixin):
"""Represents results of a single test case.
See the base class for documentation of attributes not documented here.
"""
- __slots__ = ['status', 'message', 'starttime', 'endtime']
+
body_class = Body
fixture_class = Keyword
-
- def __init__(self, name='', doc='', tags=None, timeout=None, lineno=None,
- status='FAIL', message='', starttime=None, endtime=None,
- parent=None):
+ __slots__ = ("status", "message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ tags: Sequence[str] = (),
+ timeout: "str|None" = None,
+ lineno: "int|None" = None,
+ status: str = "FAIL",
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: "TestSuite|None" = None,
+ ):
super().__init__(name, doc, tags, timeout, lineno, parent)
- #: Status as a string ``PASS`` or ``FAIL``. See also :attr:`passed`.
self.status = status
- #: Test message. Typically a failure message but can be set also when
- #: test passes.
self.message = message
- #: Test case execution start time in format ``%Y%m%d %H:%M:%S.%f``.
- self.starttime = starttime
- #: Test case execution end time in format ``%Y%m%d %H:%M:%S.%f``.
- self.endtime = endtime
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
@property
- def not_run(self):
+ def not_run(self) -> bool:
return False
- @property
- def critical(self):
- warnings.warn("'TestCase.critical' is deprecated and always returns 'True'.")
- return True
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Test body."""
+ return self.body_class(self, body)
+
+ def to_dict(self) -> DataDict:
+ return {"id": self.id, **super().to_dict(), **StatusMixin.to_dict(self)}
+
+ @classmethod
+ def from_dict(cls, data: DataDict) -> "TestCase":
+ data.pop("id", None)
+ return super().from_dict(data)
-class TestSuite(model.TestSuite, StatusMixin):
+class TestSuite(model.TestSuite[Keyword, TestCase], StatusMixin):
"""Represents results of a single test suite.
See the base class for documentation of attributes not documented here.
"""
- __slots__ = ['message', 'starttime', 'endtime']
+
test_class = TestCase
fixture_class = Keyword
-
- def __init__(self, name='', doc='', metadata=None, source=None, message='',
- starttime=None, endtime=None, rpa=False, parent=None):
+ __slots__ = ("message", "_start_time", "_end_time", "_elapsed_time")
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ metadata: "Mapping[str, str]|None" = None,
+ source: "Path|str|None" = None,
+ rpa: bool = False,
+ message: str = "",
+ start_time: "datetime|str|None" = None,
+ end_time: "datetime|str|None" = None,
+ elapsed_time: "timedelta|int|float|None" = None,
+ parent: "TestSuite|None" = None,
+ ):
super().__init__(name, doc, metadata, source, rpa, parent)
#: Possible suite setup or teardown error message.
self.message = message
- #: Suite execution start time in format ``%Y%m%d %H:%M:%S.%f``.
- self.starttime = starttime
- #: Suite execution end time in format ``%Y%m%d %H:%M:%S.%f``.
- self.endtime = endtime
+ self.start_time = start_time
+ self.end_time = end_time
+ self.elapsed_time = elapsed_time
+
+ def _elapsed_time_from_children(self) -> timedelta:
+ elapsed = timedelta()
+ if self.has_setup:
+ elapsed += self.setup.elapsed_time
+ if self.has_teardown:
+ elapsed += self.teardown.elapsed_time
+ for child in (*self.suites, *self.tests):
+ elapsed += child.elapsed_time
+ return elapsed
@property
- def passed(self):
+ def passed(self) -> bool:
"""``True`` if no test has failed but some have passed, ``False`` otherwise."""
return self.status == self.PASS
@property
- def failed(self):
+ def failed(self) -> bool:
"""``True`` if any test has failed, ``False`` otherwise."""
return self.status == self.FAIL
@property
- def skipped(self):
+ def skipped(self) -> bool:
"""``True`` if there are no passed or failed tests, ``False`` otherwise."""
return self.status == self.SKIP
@property
- def not_run(self):
+ def not_run(self) -> bool:
return False
@property
- def status(self):
+ def status(self) -> Literal["PASS", "SKIP", "FAIL"]:
"""'PASS', 'FAIL' or 'SKIP' depending on test statuses.
- If any test has failed, status is 'FAIL'.
@@ -592,8 +1122,8 @@ def status(self):
return self.SKIP
@property
- def statistics(self):
- """Suite statistics as a :class:`~robot.model.totalstatistics.TotalStatistics` object.
+ def statistics(self) -> TotalStatistics:
+ """Suite statistics.
Recreated every time this property is accessed, so saving the results
to a variable and inspecting it is often a good idea::
@@ -603,40 +1133,36 @@ def statistics(self):
print(stats.total)
print(stats.message)
"""
- return TotalStatisticsBuilder(self, self.rpa).stats
+ return TotalStatisticsBuilder(self, bool(self.rpa)).stats
@property
- def full_message(self):
+ def full_message(self) -> str:
"""Combination of :attr:`message` and :attr:`stat_message`."""
if not self.message:
return self.stat_message
- return '%s\n\n%s' % (self.message, self.stat_message)
+ return f"{self.message}\n\n{self.stat_message}"
@property
- def stat_message(self):
+ def stat_message(self) -> str:
"""String representation of the :attr:`statistics`."""
return self.statistics.message
- @property
- def elapsedtime(self):
- """Total execution time in milliseconds."""
- if self.starttime and self.endtime:
- return get_elapsed_time(self.starttime, self.endtime)
- return sum(child.elapsedtime for child in
- chain(self.suites, self.tests, (self.setup, self.teardown)))
+ @setter
+ def suites(self, suites: "Sequence[TestSuite|DataDict]") -> TestSuites["TestSuite"]:
+ return TestSuites["TestSuite"](self.__class__, self, suites)
- def remove_keywords(self, how):
+ def remove_keywords(self, how: str):
"""Remove keywords based on the given condition.
- :param how: What approach to use when removing keywords. Either
+ :param how: Which approach to use when removing keywords. Either
``ALL``, ``PASSED``, ``FOR``, ``WUKS``, or ``NAME:``.
For more information about the possible values see the documentation
of the ``--removekeywords`` command line option.
"""
- self.visit(KeywordRemover(how))
+ self.visit(KeywordRemover.from_config(how))
- def filter_messages(self, log_level='TRACE'):
+ def filter_messages(self, log_level: str = "TRACE"):
"""Remove log messages below the specified ``log_level``."""
self.visit(MessageFilter(log_level))
@@ -658,17 +1184,134 @@ def configure(self, **options):
and keywords have to make it possible to set multiple attributes in
one call.
"""
- model.TestSuite.configure(self) # Parent validates call is allowed.
+ super().configure() # Parent validates is call allowed.
self.visit(SuiteConfigurer(**options))
def handle_suite_teardown_failures(self):
"""Internal usage only."""
self.visit(SuiteTeardownFailureHandler())
- def suite_teardown_failed(self, error):
+ def suite_teardown_failed(self, message: str):
"""Internal usage only."""
- self.visit(SuiteTeardownFailed(error))
+ self.visit(SuiteTeardownFailed(message))
- def suite_teardown_skipped(self, message):
+ def suite_teardown_skipped(self, message: str):
"""Internal usage only."""
self.visit(SuiteTeardownFailed(message, skipped=True))
+
+ def to_dict(self) -> DataDict:
+ return {"id": self.id, **super().to_dict(), **StatusMixin.to_dict(self)}
+
+ @classmethod
+ def from_dict(cls, data: DataDict) -> "TestSuite":
+ """Create suite based on result data in a dictionary.
+
+ ``data`` can either contain only the suite data got, for example, from
+ the :meth:`to_dict` method, or it can contain full result data with
+ execution errors and other such information in addition to the suite data.
+ In the latter case only the suite data is used, though.
+
+ Support for full result data is new in Robot Framework 7.2.
+ """
+ if "suite" in data:
+ data = data["suite"]
+ # `body` on the suite level means that a listener has logged something or
+ # executed a keyword in a `start/end_suite` method. Throwing such data
+ # away isn't great, but it's better than data being invalid and properly
+ # handling it would be complicated. We handle such XML outputs (see
+ # `xmlelementhandlers`), but with JSON there can even be one `body` in
+ # the beginning and other at the end, and even preserving them both
+ # would be hard.
+ data.pop("body", None)
+ # Don't set attributes that are automatically calculated and unsettable.
+ data.pop("id", None)
+ data.pop("status", None)
+ return super().from_dict(data)
+
+ @classmethod
+ def from_json(cls, source: "str|bytes|TextIO|Path") -> "TestSuite":
+ """Create suite based on results in JSON.
+
+ The data is given as the ``source`` parameter. It can be:
+
+ - a string 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.
+
+ Supports JSON produced by :meth:`to_json` that contains only the suite
+ information, as well as full result JSON that contains also execution
+ errors and other information. In the latter case errors and all other
+ information is silently ignored, though. If that is a problem,
+ :class:`~robot.result.resultbuilder.ExecutionResult` should be used
+ instead.
+
+ Support for full result JSON is new in Robot Framework 7.2.
+ """
+ return super().from_json(source)
+
+ @overload
+ def to_xml(self, file: None = None) -> str: ...
+
+ @overload
+ def to_xml(self, file: "TextIO|Path|str") -> None: ...
+
+ def to_xml(self, file: "None|TextIO|Path|str" = None) -> "str|None":
+ """Serialize suite into XML.
+
+ The format is the same that is used with normal output.xml files, but
+ the ```` root node is omitted and the result contains only
+ the ```` structure.
+
+ The ``file`` parameter controls what to do with the resulting XML 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.
+
+ A serialized suite can be recreated by using the :meth:`from_xml` method.
+
+ New in Robot Framework 7.0.
+ """
+ from robot.reporting.outputwriter import OutputWriter
+
+ output, close = self._get_output(file)
+ try:
+ self.visit(OutputWriter(output, suite_only=True))
+ finally:
+ if close:
+ output.close()
+ return output.getvalue() if file is None else None
+
+ def _get_output(self, output) -> "tuple[TextIO|StringIO, bool]":
+ close = False
+ if output is None:
+ output = StringIO()
+ elif isinstance(output, (Path, str)):
+ output = open(output, "w", encoding="UTF-8")
+ close = True
+ return output, close
+
+ @classmethod
+ def from_xml(cls, source: "str|TextIO|Path") -> "TestSuite":
+ """Create suite based on results in XML.
+
+ The data is given as the ``source`` parameter. It can be:
+
+ - a string 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.
+
+ Supports both normal output.xml files and files containing only the
+ ```` structure created, for example, with the :meth:`to_xml`
+ method. When using normal output.xml files, possible execution errors
+ listed in ```` are silently ignored. If that is a problem,
+ :class:`~robot.result.resultbuilder.ExecutionResult` should be used
+ instead.
+
+ New in Robot Framework 7.0.
+ """
+ from .resultbuilder import ExecutionResult
+
+ return ExecutionResult(source).suite
diff --git a/src/robot/result/modeldeprecation.py b/src/robot/result/modeldeprecation.py
index e67aec224f3..ad78f2e5ac6 100644
--- a/src/robot/result/modeldeprecation.py
+++ b/src/robot/result/modeldeprecation.py
@@ -13,28 +13,37 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import warnings
+
from robot.model import Tags
def deprecated(method):
def wrapper(self, *args, **kws):
"""Deprecated."""
+ warnings.warn(
+ f"'robot.result.{type(self).__name__}.{method.__name__}' is "
+ f"deprecated and will be removed in Robot Framework 8.0.",
+ stacklevel=1,
+ )
return method(self, *args, **kws)
+
return wrapper
class DeprecatedAttributesMixin:
- __slots__ = []
+ _log_name = ""
+ __slots__ = ()
@property
@deprecated
def name(self):
- return ''
+ return self._log_name
@property
@deprecated
def kwname(self):
- return self.name
+ return self._log_name
@property
@deprecated
@@ -63,5 +72,5 @@ def timeout(self):
@property
@deprecated
- def message(self):
- return ''
+ def doc(self):
+ return ""
diff --git a/src/robot/result/resultbuilder.py b/src/robot/result/resultbuilder.py
index 882bbeef69f..5bfcea0f883 100644
--- a/src/robot/result/resultbuilder.py
+++ b/src/robot/result/resultbuilder.py
@@ -13,39 +13,60 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Sequence
+from xml.etree import ElementTree as ET
+
from robot.errors import DataError
-from robot.model import SuiteVisitor
-from robot.utils import ET, ETSource, get_error_message
+from robot.utils import ETSource, get_error_message
-from .executionresult import Result, CombinedResult
-from .flattenkeywordmatcher import (FlattenByNameMatcher, FlattenByTypeMatcher,
- FlattenByTagMatcher)
+from .executionresult import CombinedResult, is_json_source, KeywordRemover, Result
+from .flattenkeywordmatcher import (
+ create_flatten_message, FlattenByNameMatcher, FlattenByTags, FlattenByTypeMatcher
+)
from .merger import Merger
from .xmlelementhandlers import XmlElementHandler
-def ExecutionResult(*sources, **options):
+def ExecutionResult(
+ *sources,
+ merge: bool = False,
+ include_keywords: bool = True,
+ flattened_keywords: Sequence[str] = (),
+ rpa: "bool|None" = None,
+):
"""Factory method to constructs :class:`~.executionresult.Result` objects.
- :param sources: XML source(s) containing execution results.
- Can be specified as paths, opened file objects, or strings/bytes
- containing XML directly. Support for bytes is new in RF 3.2.
- :param options: Configuration options.
- Using ``merge=True`` causes multiple results to be combined so that
- tests in the latter results replace the ones in the original.
- Setting ``rpa`` either to ``True`` (RPA mode) or ``False`` (test
- automation) sets execution mode explicitly. By default it is got
+ :param sources: XML or JSON source(s) containing execution results.
+ Can be specified as paths (``pathlib.Path`` or ``str``), opened file
+ objects, or strings/bytes containing XML/JSON directly.
+ :param merge: When ``True`` and multiple sources are given, results are merged
+ instead of combined.
+ :param include_keywords: When ``False``, keyword and control structure information
+ is not parsed. This can save considerable amount of time and memory.
+ :param flattened_keywords: List of patterns controlling what keywords
+ and control structures to flatten. See the documentation of
+ the ``--flattenkeywords`` option for more details.
+ :param rpa: Setting ``rpa`` either to ``True`` (RPA mode) or ``False`` (test
+ automation) sets the execution mode explicitly. By default, the mode is got
from processed output files and conflicting modes cause an error.
- Other options are passed directly to the
- :class:`ExecutionResultBuilder` object used internally.
:returns: :class:`~.executionresult.Result` instance.
- Should be imported by external code via the :mod:`robot.api` package.
- See the :mod:`robot.result` package for a usage example.
+ A source is considered to be JSON in these cases:
+ - It is a path with a ``.json`` suffix.
+ - It is an open file that has a ``name`` attribute with a ``.json`` suffix.
+ - It is string or bytes starting with ``{`` and ending with ``}``.
+
+ This method should be imported by external code via the :mod:`robot.api`
+ package. See the :mod:`robot.result` package for a usage example.
"""
if not sources:
- raise DataError('One or more data source needed.')
- if options.pop('merge', False):
+ raise DataError("One or more data source needed.")
+ options = {
+ "include_keywords": include_keywords,
+ "flattened_keywords": flattened_keywords,
+ "rpa": rpa,
+ }
+ if merge:
return _merge_results(sources[0], sources[1:], options)
if len(sources) > 1:
return _combine_results(sources, options)
@@ -55,8 +76,8 @@ def ExecutionResult(*sources, **options):
def _merge_results(original, merged, options):
result = ExecutionResult(original, **options)
merger = Merger(result, rpa=result.rpa)
- for path in merged:
- merged = ExecutionResult(path, **options)
+ for source in merged:
+ merged = ExecutionResult(source, **options)
merger.merge(merged)
return result
@@ -66,38 +87,56 @@ def _combine_results(sources, options):
def _single_result(source, options):
+ if is_json_source(source):
+ return _json_result(source, **options)
+ return _xml_result(source, **options)
+
+
+def _json_result(source, include_keywords, flattened_keywords, rpa):
+ try:
+ return Result.from_json(source, include_keywords, flattened_keywords, rpa)
+ except IOError as err:
+ error = err.strerror
+ except Exception:
+ error = get_error_message()
+ raise DataError(f"Reading JSON source '{source}' failed: {error}")
+
+
+def _xml_result(source, include_keywords, flattened_keywords, rpa):
ets = ETSource(source)
- result = Result(source, rpa=options.pop('rpa', None))
+ builder = ExecutionResultBuilder(ets, include_keywords, flattened_keywords)
+ result = Result(source, rpa=rpa)
try:
- return ExecutionResultBuilder(ets, **options).build(result)
+ return builder.build(result)
except IOError as err:
error = err.strerror
- except:
+ except Exception:
error = get_error_message()
raise DataError(f"Reading XML source '{ets}' failed: {error}")
+# TODO:
+# - Rename e.g. to XmlExecutionResultBuilder. Probably best done in a major release.
+# - Add Result.from_xml as a more convenient API. Could be done in RF 7.4.
class ExecutionResultBuilder:
- """Builds :class:`~.executionresult.Result` objects based on output files.
+ """Builds :class:`~.executionresult.Result` objects based on XML output files.
Instead of using this builder directly, it is recommended to use the
:func:`ExecutionResult` factory method.
"""
- def __init__(self, source, include_keywords=True, flattened_keywords=None):
+ def __init__(self, source, include_keywords=True, flattened_keywords=()):
"""
:param source: Path to the XML output file to build
:class:`~.executionresult.Result` objects from.
- :param include_keywords: Boolean controlling whether to include
- keyword information in the result or not. Keywords are
- not needed when generating only report. Although the the option name
- has word "keyword", it controls also including FOR and IF structures.
- :param flatten_keywords: List of patterns controlling what keywords to
- flatten. See the documentation of ``--flattenkeywords`` option for
- more details.
+ :param include_keywords: Controls whether to include keywords and control
+ structures like FOR and IF in the result or not. They are not needed
+ when generating only a report.
+ :param flattened_keywords: List of patterns controlling what keywords
+ and control structures to flatten. See the documentation of
+ the ``--flattenkeywords`` option for more details.
"""
- self._source = source \
- if isinstance(source, ETSource) else ETSource(source)
+ self._source = source if isinstance(source, ETSource) else ETSource(source)
self._include_keywords = include_keywords
self._flattened_keywords = flattened_keywords
@@ -107,98 +146,82 @@ def build(self, result):
with self._source as source:
self._parse(source, handler.start, handler.end)
result.handle_suite_teardown_failures()
+ if self._flattened_keywords:
+ # Tags are nowadays written after keyword content, so we cannot
+ # flatten based on them when parsing output.xml.
+ result.suite.visit(FlattenByTags(self._flattened_keywords))
if not self._include_keywords:
- result.suite.visit(RemoveKeywords())
+ result.suite.visit(KeywordRemover())
return result
def _parse(self, source, start, end):
- context = ET.iterparse(source, events=('start', 'end'))
+ context = ET.iterparse(source, events=("start", "end"))
if not self._include_keywords:
context = self._omit_keywords(context)
elif self._flattened_keywords:
context = self._flatten_keywords(context, self._flattened_keywords)
for event, elem in context:
- if event == 'start':
+ if event == "start":
start(elem)
else:
end(elem)
elem.clear()
+ # Python 3.15 emits a warning if context is not closed, but `close` is
+ # new in Python 3.13.
+ try:
+ context.close()
+ except AttributeError:
+ pass
def _omit_keywords(self, context):
- omitted_kws = 0
+ omitted_elements = {"kw", "for", "while", "if", "try", "group", "variable"}
+ omitted = 0
for event, elem in context:
- # Teardowns aren't omitted yet to allow checking suite teardown status.
- # They'll be removed later when not needed in `build()`.
- omit = elem.tag in ('kw', 'for', 'if') and elem.get('type') != 'TEARDOWN'
- start = event == 'start'
+ # Teardowns cannot be removed yet, because we need to check suite
+ # teardown status. They are removed later using KeywordRemover.
+ omit = elem.tag in omitted_elements and elem.get("type") != "TEARDOWN"
+ start = event == "start"
if omit and start:
- omitted_kws += 1
- if not omitted_kws:
+ omitted += 1
+ if not omitted:
yield event, elem
elif not start:
elem.clear()
if omit and not start:
- omitted_kws -= 1
+ omitted -= 1
def _flatten_keywords(self, context, flattened):
# Performance optimized. Do not change without profiling!
name_match, by_name = self._get_matcher(FlattenByNameMatcher, flattened)
type_match, by_type = self._get_matcher(FlattenByTypeMatcher, flattened)
- tags_match, by_tags = self._get_matcher(FlattenByTagMatcher, flattened)
- started = -1 # if 0 or more, we are flattening
- tags = []
- containers = {'kw', 'for', 'while', 'iter', 'if', 'try'}
- inside_kw = 0 # to make sure we don't read tags from a test
- seen_doc = False
+ started = -1 # If 0 or more, we are flattening.
+ include_on_top = {"doc", "tag", "timeout", "status"}
for event, elem in context:
tag = elem.tag
- start = event == 'start'
- end = not start
- if start:
- if tag in containers:
- inside_kw += 1
- if started >= 0:
- started += 1
- elif by_name and name_match(elem.get('name', ''), elem.get('library')):
- started = 0
- seen_doc = False
- elif by_type and type_match(tag):
- started = 0
- seen_doc = False
- tags = []
- else:
- if tag in containers:
- inside_kw -= 1
- if started == 0 and not seen_doc:
- doc = ET.Element('doc')
- doc.text = '_*Content flattened.*_'
- yield 'start', doc
- yield 'end', doc
- elif by_tags and inside_kw and started < 0 and tag == 'tag':
- tags.append(elem.text or '')
- if tags_match(tags):
- started = 0
- seen_doc = False
- elif started == 0 and tag == 'doc':
- seen_doc = True
- elem.text = f"{elem.text or ''}\n\n_*Content flattened.*_".strip()
- if started <= 0 or tag == 'msg':
+ if event == "start":
+ if started >= 0:
+ started += 1
+ elif (
+ by_name
+ and tag == "kw"
+ and name_match(
+ elem.get("name", ""),
+ elem.get("owner") or elem.get("library"),
+ # 'library' is for RF < 7 compatibility
+ )
+ ):
+ started = 0
+ elif by_type and type_match(tag):
+ started = 0
+ elif started == 1 and tag == "status":
+ elem.text = create_flatten_message(elem.text)
+ if started <= 0 or (started == 1 and tag in include_on_top) or tag == "msg":
yield event, elem
else:
elem.clear()
- if started >= 0 and end and tag in containers:
+ if started >= 0 and event == "end":
started -= 1
def _get_matcher(self, matcher_class, flattened):
matcher = matcher_class(flattened)
return matcher.match, bool(matcher)
-
-
-class RemoveKeywords(SuiteVisitor):
-
- def start_suite(self, suite):
- suite.setup = None
- suite.teardown = None
-
- def visit_test(self, test):
- test.body = []
diff --git a/src/robot/result/suiteteardownfailed.py b/src/robot/result/suiteteardownfailed.py
index 7d41eea27b7..cea8f4f3c9f 100644
--- a/src/robot/result/suiteteardownfailed.py
+++ b/src/robot/result/suiteteardownfailed.py
@@ -19,12 +19,12 @@
class SuiteTeardownFailureHandler(SuiteVisitor):
def end_suite(self, suite):
- teardown = suite.teardown
- # Both 'PASS' and 'NOT RUN' statuses are OK.
- if teardown and teardown.status == teardown.FAIL:
- suite.suite_teardown_failed(teardown.message)
- if teardown and teardown.status == teardown.SKIP:
- suite.suite_teardown_skipped(teardown.message)
+ if suite.has_teardown:
+ teardown = suite.teardown
+ if teardown.status == teardown.FAIL:
+ suite.suite_teardown_failed(teardown.message)
+ if teardown.status == teardown.SKIP:
+ suite.suite_teardown_skipped(teardown.message)
def visit_test(self, test):
pass
@@ -34,10 +34,10 @@ def visit_keyword(self, keyword):
class SuiteTeardownFailed(SuiteVisitor):
- _normal_msg = 'Parent suite teardown failed:\n%s'
- _also_msg = '\n\nAlso parent suite teardown failed:\n%s'
- _normal_skip_msg = 'Skipped in parent suite teardown:\n%s'
- _also_skip_msg = 'Skipped in parent suite teardown:\n%s\n\nEarlier message:\n%s'
+ _normal_msg = "Parent suite teardown failed:\n%s"
+ _also_msg = "\n\nAlso parent suite teardown failed:\n%s"
+ _normal_skip_msg = "Skipped in parent suite teardown:\n%s"
+ _also_skip_msg = "Skipped in parent suite teardown:\n%s\n\nEarlier message:\n%s"
def __init__(self, message, skipped=False):
self.message = message
diff --git a/src/robot/result/visitor.py b/src/robot/result/visitor.py
index 61f55974621..3a67c32cd9e 100644
--- a/src/robot/result/visitor.py
+++ b/src/robot/result/visitor.py
@@ -39,6 +39,7 @@ class ResultVisitor(SuiteVisitor):
For more information about the visitor algorithm see documentation in
:mod:`robot.model.visitor` module.
"""
+
def visit_result(self, result):
if self.start_result(result) is not False:
result.suite.visit(self)
diff --git a/src/robot/result/xmlelementhandlers.py b/src/robot/result/xmlelementhandlers.py
index b0e5514164b..99606ee7375 100644
--- a/src/robot/result/xmlelementhandlers.py
+++ b/src/robot/result/xmlelementhandlers.py
@@ -13,6 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from datetime import datetime
+
from robot.errors import DataError
@@ -47,10 +49,7 @@ def register(cls, handler):
def get_child_handler(self, tag):
if tag not in self.children:
- if not self.tag:
- raise DataError("Incompatible root element '%s'." % tag)
- raise DataError("Incompatible child element '%s' for '%s'."
- % (tag, self.tag))
+ raise DataError(f"Incompatible child element '{tag}' for '{self.tag}'.")
return self.element_handlers[tag]
def start(self, elem, result):
@@ -59,77 +58,113 @@ def start(self, elem, result):
def end(self, elem, result):
pass
- def _timestamp(self, elem, attr_name):
- timestamp = elem.get(attr_name)
- return timestamp if timestamp != 'N/A' else None
+ def _legacy_timestamp(self, elem, attr_name):
+ ts = elem.get(attr_name)
+ return self._parse_legacy_timestamp(ts)
+
+ def _parse_legacy_timestamp(self, ts):
+ if ts == "N/A" or not ts:
+ return None
+ ts = ts.ljust(24, "0")
+ return datetime(
+ int(ts[:4]),
+ int(ts[4:6]),
+ int(ts[6:8]),
+ int(ts[9:11]),
+ int(ts[12:14]),
+ int(ts[15:17]),
+ int(ts[18:24]),
+ )
class RootHandler(ElementHandler):
- children = frozenset(('robot',))
+ children = frozenset(("robot", "suite"))
+
+ def get_child_handler(self, tag):
+ try:
+ return super().get_child_handler(tag)
+ except DataError:
+ raise DataError(f"Incompatible root element '{tag}'.")
@ElementHandler.register
class RobotHandler(ElementHandler):
- tag = 'robot'
- children = frozenset(('suite', 'statistics', 'errors'))
+ tag = "robot"
+ children = frozenset(("suite", "statistics", "errors"))
def start(self, elem, result):
- generator = elem.get('generator', 'unknown').split()[0].upper()
- result.generated_by_robot = generator == 'ROBOT'
+ result.generator = elem.get("generator", "unknown")
+ result.generation_time = self._parse_generation_time(elem.get("generated"))
if result.rpa is None:
- result.rpa = elem.get('rpa', 'false') == 'true'
+ result.rpa = elem.get("rpa", "false") == "true"
return result
+ def _parse_generation_time(self, generated):
+ if not generated:
+ return None
+ try:
+ return datetime.fromisoformat(generated)
+ except ValueError:
+ return self._parse_legacy_timestamp(generated)
+
@ElementHandler.register
class SuiteHandler(ElementHandler):
- tag = 'suite'
- # 'metadata' is for RF < 4 compatibility.
- children = frozenset(('doc', 'metadata', 'meta', 'status', 'kw', 'test', 'suite'))
+ tag = "suite"
+ # "metadata" is for RF < 4 compatibility.
+ children = frozenset(("doc", "metadata", "meta", "status", "kw", "test", "suite"))
def start(self, elem, result):
- if hasattr(result, 'suite'): # root
- return result.suite.config(name=elem.get('name', ''),
- source=elem.get('source'),
- rpa=result.rpa)
- return result.suites.create(name=elem.get('name', ''),
- source=elem.get('source'),
- rpa=result.rpa)
+ if hasattr(result, "suite"): # root
+ return result.suite.config(
+ name=elem.get("name", ""),
+ source=elem.get("source"),
+ rpa=result.rpa,
+ )
+ return result.suites.create(
+ name=elem.get("name", ""),
+ source=elem.get("source"),
+ rpa=result.rpa,
+ )
def get_child_handler(self, tag):
- if tag == 'status':
+ if tag == "status":
return StatusHandler(set_status=False)
- return ElementHandler.get_child_handler(self, tag)
+ return super().get_child_handler(tag)
@ElementHandler.register
class TestHandler(ElementHandler):
- tag = 'test'
- # 'tags' is for RF < 4 compatibility.
- children = frozenset(('doc', 'tags', 'tag', 'timeout', 'status', 'kw', 'if', 'for',
- 'try', 'while', 'return', 'break', 'continue', 'msg'))
+ tag = "test"
+ # "tags" is for RF < 4 compatibility.
+ children = frozenset((
+ "doc", "tags", "tag", "timeout", "status", "kw", "if", "for", "try", "while",
+ "group", "variable", "return", "break", "continue", "error", "msg"
+ )) # fmt: skip
def start(self, elem, result):
- lineno = elem.get('line')
+ lineno = elem.get("line")
if lineno:
lineno = int(lineno)
- return result.tests.create(name=elem.get('name', ''), lineno=lineno)
+ return result.tests.create(name=elem.get("name", ""), lineno=lineno)
@ElementHandler.register
class KeywordHandler(ElementHandler):
- tag = 'kw'
- # 'arguments', 'assign' and 'tags' are for RF < 4 compatibility.
- children = frozenset(('doc', 'arguments', 'arg', 'assign', 'var', 'tags', 'tag',
- 'timeout', 'status', 'msg', 'kw', 'if', 'for', 'try',
- 'while', 'return', 'break', 'continue'))
+ tag = "kw"
+ # "arguments", "assign" and "tags" are for RF < 4 compatibility.
+ children = frozenset((
+ "doc", "arguments", "arg", "assign", "var", "tags", "tag", "timeout", "status",
+ "msg", "kw", "if", "for", "try", "while", "group", "variable", "return",
+ "break", "continue", "error"
+ )) # fmt: skip
def start(self, elem, result):
- elem_type = elem.get('type')
+ elem_type = elem.get("type")
if not elem_type:
creator = self._create_keyword
else:
- creator = getattr(self, '_create_%s' % elem_type.lower().replace(' ', '_'))
+ creator = getattr(self, "_create_" + elem_type.lower())
return creator(elem, result)
def _create_keyword(self, elem, result):
@@ -137,9 +172,15 @@ def _create_keyword(self, elem, result):
body = result.body
except AttributeError:
body = self._get_body_for_suite_level_keyword(result)
- return body.create_keyword(kwname=elem.get('name', ''),
- libname=elem.get('library'),
- sourcename=elem.get('sourcename'))
+ return body.create_keyword(**self._get_keyword_attrs(elem))
+
+ def _get_keyword_attrs(self, elem):
+ # "library" and "sourcename" are RF < 7 compatibility.
+ return {
+ "name": elem.get("name", ""),
+ "owner": elem.get("owner") or elem.get("library"),
+ "source_name": elem.get("source_name") or elem.get("sourcename"),
+ }
def _get_body_for_suite_level_keyword(self, result):
# Someone, most likely a listener, has created a `` element on suite level.
@@ -147,66 +188,85 @@ def _get_body_for_suite_level_keyword(self, result):
# seen tests or not. Create an implicit setup/teardown if needed. Possible real
# setup/teardown parsed later will reset the implicit one otherwise, but leaves
# the added keyword into its body.
- kw_type = 'teardown' if result.tests or result.suites else 'setup'
+ kw_type = "teardown" if result.tests or result.suites else "setup"
keyword = getattr(result, kw_type)
if not keyword:
- keyword.config(kwname='Implicit %s' % kw_type, status=keyword.PASS)
+ keyword.config(name=f"Implicit {kw_type}", status=keyword.PASS)
return keyword.body
def _create_setup(self, elem, result):
- return result.setup.config(kwname=elem.get('name', ''),
- libname=elem.get('library'))
+ return result.setup.config(**self._get_keyword_attrs(elem))
def _create_teardown(self, elem, result):
- return result.teardown.config(kwname=elem.get('name', ''),
- libname=elem.get('library'))
+ return result.teardown.config(**self._get_keyword_attrs(elem))
# RF < 4 compatibility.
def _create_for(self, elem, result):
- return result.body.create_keyword(kwname=elem.get('name'), type='FOR')
+ return result.body.create_keyword(name=elem.get("name"), type="FOR")
def _create_foritem(self, elem, result):
- return result.body.create_keyword(kwname=elem.get('name'), type='ITERATION')
+ return result.body.create_keyword(name=elem.get("name"), type="ITERATION")
_create_iteration = _create_foritem
@ElementHandler.register
class ForHandler(ElementHandler):
- tag = 'for'
- children = frozenset(('var', 'value', 'iter', 'status', 'doc', 'msg', 'kw'))
+ tag = "for"
+ children = frozenset(("var", "value", "iter", "status", "doc", "msg", "kw"))
def start(self, elem, result):
- return result.body.create_for(flavor=elem.get('flavor'))
+ return result.body.create_for(
+ flavor=elem.get("flavor"),
+ start=elem.get("start"),
+ mode=elem.get("mode"),
+ fill=elem.get("fill"),
+ )
@ElementHandler.register
class WhileHandler(ElementHandler):
- tag = 'while'
- children = frozenset(('iter', 'status', 'doc', 'msg', 'kw'))
+ tag = "while"
+ children = frozenset(("iter", "status", "doc", "msg", "kw"))
def start(self, elem, result):
return result.body.create_while(
- condition=elem.get('condition'),
- limit=elem.get('limit')
+ condition=elem.get("condition"),
+ limit=elem.get("limit"),
+ on_limit=elem.get("on_limit"),
+ on_limit_message=elem.get("on_limit_message"),
)
@ElementHandler.register
class IterationHandler(ElementHandler):
- tag = 'iter'
- children = frozenset(('var', 'doc', 'status', 'kw', 'if', 'for', 'msg', 'try',
- 'while', 'return', 'break', 'continue'))
+ tag = "iter"
+ children = frozenset((
+ "var", "doc", "status", "kw", "if", "for", "msg", "try", "while", "group",
+ "variable", "return", "break", "continue", "error"
+ )) # fmt: skip
def start(self, elem, result):
return result.body.create_iteration()
+@ElementHandler.register
+class GroupHandler(ElementHandler):
+ tag = "group"
+ children = frozenset((
+ "status", "kw", "if", "for", "try", "while", "group", "msg", "variable",
+ "return", "break", "continue", "error"
+ )) # fmt: skip
+
+ def start(self, elem, result):
+ return result.body.create_group(name=elem.get("name", ""))
+
+
@ElementHandler.register
class IfHandler(ElementHandler):
- tag = 'if'
- children = frozenset(('branch', 'status', 'doc', 'msg', 'kw'))
+ tag = "if"
+ children = frozenset(("branch", "status", "doc", "msg", "kw"))
def start(self, elem, result):
return result.body.create_if()
@@ -214,18 +274,22 @@ def start(self, elem, result):
@ElementHandler.register
class BranchHandler(ElementHandler):
- tag = 'branch'
- children = frozenset(('status', 'kw', 'if', 'for', 'try', 'while', 'msg', 'doc',
- 'return', 'pattern', 'break', 'continue'))
+ tag = "branch"
+ children = frozenset((
+ "status", "kw", "if", "for", "try", "while", "group", "msg", "doc", "variable",
+ "return", "pattern", "break", "continue", "error"
+ )) # fmt: skip
def start(self, elem, result):
+ if "variable" in elem.attrib: # RF < 7.0 compatibility.
+ elem.attrib["assign"] = elem.attrib.pop("variable")
return result.body.create_branch(**elem.attrib)
@ElementHandler.register
class TryHandler(ElementHandler):
- tag = 'try'
- children = frozenset(('branch', 'status', 'doc', 'msg', 'kw'))
+ tag = "try"
+ children = frozenset(("branch", "status", "doc", "msg", "kw"))
def start(self, elem, result):
return result.body.create_try()
@@ -233,17 +297,30 @@ def start(self, elem, result):
@ElementHandler.register
class PatternHandler(ElementHandler):
- tag = 'pattern'
+ tag = "pattern"
children = frozenset()
def end(self, elem, result):
- result.patterns += (elem.text or '',)
+ result.patterns += (elem.text or "",)
+
+
+@ElementHandler.register
+class VariableHandler(ElementHandler):
+ tag = "variable"
+ children = frozenset(("var", "status", "msg", "kw"))
+
+ def start(self, elem, result):
+ return result.body.create_var(
+ name=elem.get("name", ""),
+ scope=elem.get("scope"),
+ separator=elem.get("separator"),
+ )
@ElementHandler.register
class ReturnHandler(ElementHandler):
- tag = 'return'
- children = frozenset(('status', 'value', 'msg', 'kw'))
+ tag = "return"
+ children = frozenset(("value", "status", "msg", "kw"))
def start(self, elem, result):
return result.body.create_return()
@@ -251,8 +328,8 @@ def start(self, elem, result):
@ElementHandler.register
class ContinueHandler(ElementHandler):
- tag = 'continue'
- children = frozenset(('status', 'msg', 'kw'))
+ tag = "continue"
+ children = frozenset(("status", "msg", "kw"))
def start(self, elem, result):
return result.body.create_continue()
@@ -260,140 +337,173 @@ def start(self, elem, result):
@ElementHandler.register
class BreakHandler(ElementHandler):
- tag = 'break'
- children = frozenset(('status', 'msg', 'kw'))
+ tag = "break"
+ children = frozenset(("status", "msg", "kw"))
def start(self, elem, result):
return result.body.create_break()
+@ElementHandler.register
+class ErrorHandler(ElementHandler):
+ tag = "error"
+ children = frozenset(("status", "msg", "value", "kw"))
+
+ def start(self, elem, result):
+ return result.body.create_error()
+
+
@ElementHandler.register
class MessageHandler(ElementHandler):
- tag = 'msg'
+ tag = "msg"
+
+ def end(self, elem, result):
+ self._create_message(elem, result.body.create_message)
+
+ def _create_message(self, elem, creator):
+ if "time" in elem.attrib: # RF >= 7
+ timestamp = elem.attrib["time"]
+ else: # RF < 7
+ timestamp = self._legacy_timestamp(elem, "timestamp")
+ creator(
+ elem.text or "",
+ elem.get("level", "INFO"),
+ elem.get("html") in ("true", "yes"), # "yes" is RF < 4 compatibility
+ timestamp,
+ )
+
+
+class ErrorMessageHandler(MessageHandler):
def end(self, elem, result):
- html_true = ('true', 'yes') # 'yes' is compatibility for RF < 4.
- result.body.create_message(elem.text or '',
- elem.get('level', 'INFO'),
- elem.get('html') in html_true,
- self._timestamp(elem, 'timestamp'))
+ self._create_message(elem, result.messages.create)
@ElementHandler.register
class StatusHandler(ElementHandler):
- tag = 'status'
+ tag = "status"
def __init__(self, set_status=True):
self.set_status = set_status
def end(self, elem, result):
if self.set_status:
- result.status = elem.get('status', 'FAIL')
- result.starttime = self._timestamp(elem, 'starttime')
- result.endtime = self._timestamp(elem, 'endtime')
+ result.status = elem.get("status", "FAIL")
+ if "elapsed" in elem.attrib: # RF >= 7
+ result.elapsed_time = float(elem.attrib["elapsed"])
+ result.start_time = elem.get("start")
+ else: # RF < 7
+ result.start_time = self._legacy_timestamp(elem, "starttime")
+ result.end_time = self._legacy_timestamp(elem, "endtime")
if elem.text:
result.message = elem.text
@ElementHandler.register
class DocHandler(ElementHandler):
- tag = 'doc'
+ tag = "doc"
def end(self, elem, result):
- result.doc = elem.text or ''
+ try:
+ result.doc = elem.text or ""
+ except AttributeError:
+ # With RF < 7 control structures can have `` containing information
+ # about flattening or removing date. Nowadays, they don't have `doc`
+ # attribute at all and `message` is used for this information.
+ result.message = elem.text or ""
@ElementHandler.register
-class MetadataHandler(ElementHandler): # RF < 4 compatibility.
- tag = 'metadata'
- children = frozenset(('item',))
+class MetadataHandler(ElementHandler): # RF < 4 compatibility.
+ tag = "metadata"
+ children = frozenset(("item",))
@ElementHandler.register
-class MetadataItemHandler(ElementHandler): # RF < 4 compatibility.
- tag = 'item'
+class MetadataItemHandler(ElementHandler): # RF < 4 compatibility.
+ tag = "item"
def end(self, elem, result):
- result.metadata[elem.get('name', '')] = elem.text or ''
+ result.metadata[elem.get("name", "")] = elem.text or ""
@ElementHandler.register
class MetaHandler(ElementHandler):
- tag = 'meta'
+ tag = "meta"
def end(self, elem, result):
- result.metadata[elem.get('name', '')] = elem.text or ''
+ result.metadata[elem.get("name", "")] = elem.text or ""
@ElementHandler.register
-class TagsHandler(ElementHandler): # RF < 4 compatibility.
- tag = 'tags'
- children = frozenset(('tag',))
+class TagsHandler(ElementHandler): # RF < 4 compatibility.
+ tag = "tags"
+ children = frozenset(("tag",))
@ElementHandler.register
class TagHandler(ElementHandler):
- tag = 'tag'
+ tag = "tag"
def end(self, elem, result):
- result.tags.add(elem.text or '')
+ result.tags.add(elem.text or "")
@ElementHandler.register
class TimeoutHandler(ElementHandler):
- tag = 'timeout'
+ tag = "timeout"
def end(self, elem, result):
- result.timeout = elem.get('value')
+ result.timeout = elem.get("value")
@ElementHandler.register
-class AssignHandler(ElementHandler): # RF < 4 compatibility.
- tag = 'assign'
- children = frozenset(('var',))
+class AssignHandler(ElementHandler): # RF < 4 compatibility.
+ tag = "assign"
+ children = frozenset(("var",))
@ElementHandler.register
class VarHandler(ElementHandler):
- tag = 'var'
+ tag = "var"
def end(self, elem, result):
- value = elem.text or ''
- if result.type == result.KEYWORD:
+ value = elem.text or ""
+ if result.type in (result.KEYWORD, result.FOR):
result.assign += (value,)
- elif result.type == result.FOR:
- result.variables += (value,)
elif result.type == result.ITERATION:
- result.variables[elem.get('name')] = value
+ result.assign[elem.get("name")] = value
+ elif result.type == result.VAR:
+ result.value += (value,)
else:
- raise DataError("Invalid element '%s' for result '%r'." % (elem, result))
+ raise DataError(f"Invalid element '{elem}' for result '{result!r}'.")
@ElementHandler.register
-class ArgumentsHandler(ElementHandler): # RF < 4 compatibility.
- tag = 'arguments'
- children = frozenset(('arg',))
+class ArgumentsHandler(ElementHandler): # RF < 4 compatibility.
+ tag = "arguments"
+ children = frozenset(("arg",))
@ElementHandler.register
class ArgumentHandler(ElementHandler):
- tag = 'arg'
+ tag = "arg"
def end(self, elem, result):
- result.args += (elem.text or '',)
+ result.args += (elem.text or "",)
@ElementHandler.register
class ValueHandler(ElementHandler):
- tag = 'value'
+ tag = "value"
def end(self, elem, result):
- result.values += (elem.text or '',)
+ result.values += (elem.text or "",)
@ElementHandler.register
class ErrorsHandler(ElementHandler):
- tag = 'errors'
+ tag = "errors"
def start(self, elem, result):
return result.errors
@@ -402,19 +512,9 @@ def get_child_handler(self, tag):
return ErrorMessageHandler()
-class ErrorMessageHandler(ElementHandler):
-
- def end(self, elem, result):
- html_true = ('true', 'yes') # 'yes' is compatibility for RF < 4.
- result.messages.create(elem.text or '',
- elem.get('level', 'INFO'),
- elem.get('html') in html_true,
- self._timestamp(elem, 'timestamp'))
-
-
@ElementHandler.register
class StatisticsHandler(ElementHandler):
- tag = 'statistics'
+ tag = "statistics"
def get_child_handler(self, tag):
return self
diff --git a/src/robot/run.py b/src/robot/run.py
index 7c3a4811253..008534b32e5 100755
--- a/src/robot/run.py
+++ b/src/robot/run.py
@@ -31,20 +31,21 @@
"""
import sys
+from threading import current_thread
-# Allows running as a script. __name__ check needed with multiprocessing:
-# https://github.com/robotframework/robotframework/issues/1137
-if 'robot' not in sys.modules and __name__ == '__main__':
- import pythonpathsetter
+if __name__ == "__main__" and "robot" not in sys.modules:
+ from pythonpathsetter import set_pythonpath
+
+ set_pythonpath()
from robot.conf import RobotSettings
+from robot.errors import DataError
from robot.model import ModelModifier
-from robot.output import LOGGER, pyloggingconf
+from robot.output import librarylogger, LOGGER, pyloggingconf
from robot.reporting import ResultWriter
from robot.running.builder import TestSuiteBuilder
from robot.utils import Application, text
-
USAGE = """Robot Framework -- A generic automation framework
Version:
@@ -89,12 +90,21 @@
terminology so that "test" is replaced with "task"
in logs and reports. By default the mode is got
from test/task header in data files.
+ --language lang * Activate localization. `lang` can be a name or a code
+ of a built-in language, or a path or a module name of
+ a custom language file.
-F --extension value Parse only files with this extension when executing
a directory. Has no effect when running individual
files or when using resource files. If more than one
extension is needed, separate them with a colon.
Examples: `--extension txt`, `--extension robot:txt`
Only `*.robot` files are parsed by default.
+ -I --parseinclude pattern * Parse only files matching `pattern`. It can be:
+ - a file name or pattern like `example.robot` or
+ `*.robot` to parse all files matching that name,
+ - a file path like `path/to/example.robot`, or
+ - a directory path like `path/to/example` to parse
+ all files in that directory, recursively.
-N --name name Set the name of the top level suite. By default the
name is created based on the executed file or
directory.
@@ -150,9 +160,9 @@
given without `${}`. See --variablefile for a more
powerful variable setting mechanism.
Examples:
- --variable str:Hello => ${str} = `Hello`
- -v hi:Hi_World -E space:_ => ${hi} = `Hi World`
- -v x: -v y:42 => ${x} = ``, ${y} = `42`
+ --variable name:Robot => ${name} = `Robot`
+ -v "hello:Hello world" => ${hello} = `Hello world`
+ -v x: -v y:42 => ${x} = ``, ${y} = `42`
-V --variablefile path * Python or YAML file file to read variables from.
Possible arguments to the variable file can be given
after the path using colon or semicolon as separator.
@@ -169,6 +179,8 @@
can also be further processed with Rebot tool. Can be
disabled by giving a special value `NONE`.
Default: output.xml
+ --legacyoutput Create XML output file in format compatible with
+ Robot Framework 6.x and earlier.
-l --log file HTML log file. Can be disabled by giving a special
value `NONE`. Default: log.html
Examples: `--log mylog.html`, `-l NONE`
@@ -229,7 +241,6 @@
pattern. Documentation is shown in `Test Details` and
also as a tooltip in `Statistics by Tag`. Pattern can
use `*`, `?` and `[]` as wildcards like --test.
- Documentation can contain formatting like --doc.
Examples: --tagdoc mytag:Example
--tagdoc "owner-*:Original author"
--tagstatlink pattern:link:title * Add external links into `Statistics by
@@ -252,8 +263,8 @@
all: remove data from all keywords
passed: remove data only from keywords in passed
test cases and suites
- for: remove passed iterations from for loops
- while: remove passed iterations from while loops
+ for: remove passed iterations from FOR loops
+ while: remove passed iterations from WHILE loops
wuks: remove all but the last failing keyword
inside `BuiltIn.Wait Until Keyword Succeeds`
name:: remove data from keywords that match
@@ -286,12 +297,6 @@
tag:: flatten matched keywords using same
matching rules as with
`--removekeywords tag:`
- --listener class * A class for monitoring test execution. Gets
- notifications e.g. when tests start and end.
- Arguments to the listener class can be given after
- the name using a colon or a semicolon as a separator.
- Examples: --listener MyListenerClass
- --listener path/to/Listener.py:arg1:arg2
--nostatusrc Sets the return code to zero regardless of failures
in test cases. Error codes are returned normally.
--dryrun Verifies test data and runs tests so that library
@@ -310,10 +315,20 @@
The seed must be an integer.
Examples: --randomize all
--randomize tests:1234
- --prerunmodifier class * Class to programmatically modify the suite
- structure before execution.
- --prerebotmodifier class * Class to programmatically modify the result
- model before creating reports and logs.
+ --listener listener * Class or module for monitoring test execution.
+ Gets notifications e.g. when tests start and end.
+ Arguments to the listener class can be given after
+ the name using a colon or a semicolon as a separator.
+ Examples: --listener MyListener
+ --listener path/to/Listener.py:arg1:arg2
+ --prerunmodifier modifier * Class to programmatically modify the suite
+ structure before execution. Accepts arguments the
+ same way as with --listener.
+ --prerebotmodifier modifier * Class to programmatically modify the result
+ model before creating reports and logs. Accepts
+ arguments the same way as with --listener.
+ --parser parser * Custom parser class or module. Parser classes accept
+ arguments the same way as with --listener.
--console type How to report execution on the console.
verbose: report every suite and test (default)
dotted: only show `.` for passed test, `s` for
@@ -328,6 +343,9 @@
on: always use colors
ansi: like `on` but use ANSI colors also on Windows
off: disable colors altogether
+ --consolelinks auto|off Control making paths to results files hyperlinks.
+ auto: use links when colors are enabled (default)
+ off: disable links unconditionally
-K --consolemarkers auto|on|off Show markers on the console when top level
keywords in a test case end. Values have same
semantics as with --consolecolors.
@@ -367,11 +385,9 @@
`--dryrun --dryrun --nodryrun --nostatusrc --statusrc` would not activate the
dry-run mode and would return a normal return code.
-Long option format is case-insensitive. For example, --SuiteStatLevel is
-equivalent to but easier to read than --suitestatlevel. Long options can
-also be shortened as long as they are unique. For example, `--logti Title`
-works while `--lo log.html` does not because the former matches only --logtitle
-but the latter matches --log, --loglevel and --logtitle.
+Long option names are case and hyphen insensitive. For example, --TagStatLink
+and --tag-stat-link are equivalent to, but easier to read than, --tagstatlink.
+Long options can also be shortened as long as they are unique.
Environment Variables
=====================
@@ -389,6 +405,17 @@
ROBOT_INTERNAL_TRACES When set to any non-empty value, Robot Framework's
internal methods are included in error tracebacks.
+Return Codes
+============
+
+0 All tests passed.
+1-249 Returned number of tests failed.
+250 250 or more failures.
+251 Help or version information printed.
+252 Invalid data or command line options.
+253 Execution stopped by user.
+255 Unexpected internal error.
+
Examples
========
@@ -414,45 +441,61 @@
class RobotFramework(Application):
def __init__(self):
- Application.__init__(self, USAGE, arg_limits=(1,), env_options='ROBOT_OPTIONS',
- logger=LOGGER)
+ super().__init__(
+ USAGE,
+ arg_limits=(1,),
+ env_options="ROBOT_OPTIONS",
+ logger=LOGGER,
+ )
def main(self, datasources, **options):
try:
settings = RobotSettings(options)
- except:
- LOGGER.register_console_logger(stdout=options.get('stdout'),
- stderr=options.get('stderr'))
+ except DataError:
+ LOGGER.register_console_logger(
+ stdout=options.get("stdout"),
+ stderr=options.get("stderr"),
+ )
raise
LOGGER.register_console_logger(**settings.console_output_config)
- LOGGER.info(f'Settings:\n{settings}')
+ LOGGER.info(f"Settings:\n{settings}")
if settings.pythonpath:
sys.path = settings.pythonpath + sys.path
- builder = TestSuiteBuilder(settings.suite_names,
- included_extensions=settings.extension,
- rpa=settings.rpa,
- allow_empty_suite=settings.run_empty_suite)
+ builder = TestSuiteBuilder(
+ included_extensions=settings.extension,
+ included_files=settings.parse_include,
+ custom_parsers=settings.parsers,
+ rpa=settings.rpa,
+ lang=settings.languages,
+ allow_empty_suite=settings.run_empty_suite,
+ )
suite = builder.build(*datasources)
- settings.rpa = suite.rpa
if settings.pre_run_modifiers:
- suite.visit(ModelModifier(settings.pre_run_modifiers,
- settings.run_empty_suite, LOGGER))
+ modifier = ModelModifier(
+ settings.pre_run_modifiers,
+ settings.run_empty_suite,
+ LOGGER,
+ )
+ suite.visit(modifier)
suite.configure(**settings.suite_config)
+ settings.rpa = suite.validate_execution_mode()
with pyloggingconf.robot_handler_enabled(settings.log_level):
old_max_error_lines = text.MAX_ERROR_LINES
old_max_assign_length = text.MAX_ASSIGN_LENGTH
text.MAX_ERROR_LINES = settings.max_error_lines
text.MAX_ASSIGN_LENGTH = settings.max_assign_length
+ librarylogger.LOGGING_THREADS[0] = current_thread().name
try:
result = suite.run(settings)
finally:
text.MAX_ERROR_LINES = old_max_error_lines
text.MAX_ASSIGN_LENGTH = old_max_assign_length
- LOGGER.info("Tests execution ended. Statistics:\n%s"
- % result.suite.stat_message)
+ librarylogger.LOGGING_THREADS[0] = "MainThread"
+ LOGGER.info(
+ f"Tests execution ended. Statistics:\n{result.suite.stat_message}"
+ )
if settings.log or settings.report or settings.xunit:
- writer = ResultWriter(settings.output if settings.log
- else result)
+ writer = ResultWriter(settings.output if settings.log else result)
writer.write_results(settings.get_rebot_settings())
return result.return_code
@@ -460,8 +503,7 @@ def validate(self, options, arguments):
return self._filter_options_without_value(options), arguments
def _filter_options_without_value(self, options):
- return dict((name, value) for name, value in options.items()
- if value not in (None, []))
+ return {n: v for n, v in options.items() if v not in (None, [])}
def run_cli(arguments=None, exit=True):
@@ -554,5 +596,5 @@ def run(*tests, **options):
return RobotFramework().execute(*tests, **options)
-if __name__ == '__main__':
+if __name__ == "__main__":
run_cli(sys.argv[1:])
diff --git a/src/robot/running/__init__.py b/src/robot/running/__init__.py
index b53795189d7..1dbe7adf718 100644
--- a/src/robot/running/__init__.py
+++ b/src/robot/running/__init__.py
@@ -15,20 +15,41 @@
"""Implements the core test execution logic.
-The main public entry points of this package are of the following two classes:
-
-* :class:`~robot.running.builder.builders.TestSuiteBuilder` for creating
- executable test suites based on existing test case files and directories.
+The public API of this module consists of the following objects:
* :class:`~robot.running.model.TestSuite` for creating an executable
test suite structure programmatically.
-It is recommended to import both of these classes via the :mod:`robot.api`
-package like in the examples below. Also :class:`~robot.running.model.TestCase`
-and :class:`~robot.running.model.Keyword` classes used internally by the
-:class:`~robot.running.model.TestSuite` class are part of the public API.
-In those rare cases where these classes are needed directly, they can be
-imported from this package.
+* :class:`~robot.running.builder.builders.TestSuiteBuilder` for creating
+ executable test suites based on data on a file system.
+ Instead of using this class directly, it is possible to use the
+ :meth:`TestSuite.from_file_system `
+ classmethod that uses it internally.
+
+* Classes used by :class:`~robot.running.model.TestSuite`, such as
+ :class:`~robot.running.model.TestCase`, :class:`~robot.running.model.Keyword`
+ and :class:`~robot.running.model.If` that are defined in the
+ :mod:`robot.running.model` module. These classes are typically only needed
+ in type hints.
+
+* Keyword implementation related classes :class:`~robot.running.resourcemodel.UserKeyword`,
+ :class:`~robot.running.librarykeyword.LibraryKeyword`,
+ :class:`~robot.running.invalidkeyword.InvalidKeyword` and their common base class
+ :class:`~robot.running.keywordimplementation.KeywordImplementation`. Also these
+ classes are mainly needed in type hints.
+
+* :class:`~robot.running.builder.settings.TestDefaults` that is part of the
+ `external parsing API`__ and also typically needed only in type hints.
+
+__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#parser-interface
+
+:class:`~robot.running.model.TestSuite` and
+:class:`~robot.running.builder.builders.TestSuiteBuilder` can be imported also via
+the :mod:`robot.api` package.
+
+.. note:: Prior to Robot Framework 6.1, only some classes in
+ :mod:`robot.running.model` were exposed via :mod:`robot.running`.
+ Keyword implementation related classes are new in Robot Framework 7.0.
Examples
--------
@@ -45,15 +66,13 @@
[Setup] Set Environment Variable SKYNET activated
Environment Variable Should Be Set SKYNET
-We can easily parse and create an executable test suite based on the above file
-using the :class:`~robot.running.builder.TestSuiteBuilder` class as follows::
+We can easily create an executable test suite based on the above file::
- from robot.api import TestSuiteBuilder
+ from robot.api import TestSuite
- suite = TestSuiteBuilder().build('path/to/activate_skynet.robot')
+ suite = TestSuite.from_file_system('path/to/activate_skynet.robot')
-That was easy. Let's next generate the same test suite from scratch
-using the :class:`~robot.running.model.TestSuite` class::
+That was easy. Let's next generate the same test suite from scratch::
from robot.api import TestSuite
@@ -95,11 +114,45 @@
ResultWriter('skynet.xml').write_results()
"""
-from .arguments import ArgInfo, ArgumentSpec, TypeConverter
-from .builder import TestSuiteBuilder, ResourceFileBuilder
-from .context import EXECUTION_CONTEXTS
-from .model import Keyword, TestCase, TestSuite
-from .testlibraries import TestLibrary
-from .usererrorhandler import UserErrorHandler
-from .userkeyword import UserLibrary
-from .runkwregister import RUN_KW_REGISTER
+from .arguments import (
+ ArgInfo as ArgInfo,
+ ArgumentSpec as ArgumentSpec,
+ TypeConverter as TypeConverter,
+ TypeInfo as TypeInfo,
+)
+from .builder import (
+ ResourceFileBuilder as ResourceFileBuilder,
+ TestDefaults as TestDefaults,
+ TestSuiteBuilder as TestSuiteBuilder,
+)
+from .context import EXECUTION_CONTEXTS as EXECUTION_CONTEXTS
+from .invalidkeyword import InvalidKeyword as InvalidKeyword
+from .keywordimplementation import KeywordImplementation as KeywordImplementation
+from .librarykeyword import LibraryKeyword as LibraryKeyword
+from .model import (
+ Break as Break,
+ Continue as Continue,
+ Error as Error,
+ For as For,
+ ForIteration as ForIteration,
+ Group as Group,
+ If as If,
+ IfBranch as IfBranch,
+ Keyword as Keyword,
+ Return as Return,
+ TestCase as TestCase,
+ TestSuite as TestSuite,
+ Try as Try,
+ TryBranch as TryBranch,
+ Var as Var,
+ While as While,
+ WhileIteration as WhileIteration,
+)
+from .resourcemodel import (
+ Import as Import,
+ ResourceFile as ResourceFile,
+ UserKeyword as UserKeyword,
+ Variable as Variable,
+)
+from .runkwregister import RUN_KW_REGISTER as RUN_KW_REGISTER
+from .testlibraries import TestLibrary as TestLibrary
diff --git a/src/robot/running/arguments/__init__.py b/src/robot/running/arguments/__init__.py
index 274595bf067..2c545f80e88 100644
--- a/src/robot/running/arguments/__init__.py
+++ b/src/robot/running/arguments/__init__.py
@@ -13,10 +13,14 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .argumentmapper import DefaultValue
-from .argumentparser import (DynamicArgumentParser, PythonArgumentParser,
- UserKeywordArgumentParser)
-from .argumentspec import ArgumentSpec, ArgInfo
-from .embedded import EmbeddedArguments
-from .customconverters import CustomArgumentConverters
-from .typeconverters import TypeConverter
+from .argumentmapper import DefaultValue as DefaultValue
+from .argumentparser import (
+ DynamicArgumentParser as DynamicArgumentParser,
+ PythonArgumentParser as PythonArgumentParser,
+ UserKeywordArgumentParser as UserKeywordArgumentParser,
+)
+from .argumentspec import ArgInfo as ArgInfo, ArgumentSpec as ArgumentSpec
+from .customconverters import CustomArgumentConverters as CustomArgumentConverters
+from .embedded import EmbeddedArguments as EmbeddedArguments
+from .typeconverters import TypeConverter as TypeConverter
+from .typeinfo import TypeInfo as TypeInfo
diff --git a/src/robot/running/arguments/argumentconverter.py b/src/robot/running/arguments/argumentconverter.py
index b7d241cf04f..2ae5500a747 100644
--- a/src/robot/running/arguments/argumentconverter.py
+++ b/src/robot/running/arguments/argumentconverter.py
@@ -13,58 +13,109 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import TYPE_CHECKING
+
from robot.variables import contains_variable
-from .typeconverters import TypeConverter
+from .typeconverters import UnknownConverter
+from .typeinfo import TypeInfo
+
+if TYPE_CHECKING:
+ from robot.conf import LanguagesLike
+
+ from .argumentspec import ArgumentSpec
+ from .customconverters import CustomArgumentConverters
class ArgumentConverter:
- def __init__(self, argspec, converters, dry_run=False):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
- self._converters = converters
- self._dry_run = dry_run
+ def __init__(
+ self,
+ arg_spec: "ArgumentSpec",
+ custom_converters: "CustomArgumentConverters",
+ dry_run: bool = False,
+ languages: "LanguagesLike" = None,
+ ):
+ self.spec = arg_spec
+ self.custom_converters = custom_converters
+ self.dry_run = dry_run
+ self.languages = languages
def convert(self, positional, named):
return self._convert_positional(positional), self._convert_named(named)
def _convert_positional(self, positional):
- names = self._argspec.positional
- converted = [self._convert(name, value)
- for name, value in zip(names, positional)]
- if self._argspec.var_positional:
- converted.extend(self._convert(self._argspec.var_positional, value)
- for value in positional[len(names):])
+ names = self.spec.positional
+ converted = [self._convert(n, v) for n, v in zip(names, positional)]
+ if self.spec.var_positional:
+ converted.extend(
+ self._convert(self.spec.var_positional, value)
+ for value in positional[len(names) :]
+ )
return converted
def _convert_named(self, named):
- names = set(self._argspec.positional) | set(self._argspec.named_only)
- var_named = self._argspec.var_named
- return [(name, self._convert(name if name in names else var_named, value))
- for name, value in named]
+ names = set(self.spec.positional) | set(self.spec.named_only)
+ var_named = self.spec.var_named
+ return [
+ (name, self._convert(name if name in names else var_named, value))
+ for name, value in named
+ ]
def _convert(self, name, value):
- spec = self._argspec
- if (spec.types is None
- or self._dry_run and contains_variable(value, identifiers='$@&%')):
+ spec = self.spec
+ if (
+ spec.types is None
+ or self.dry_run
+ and contains_variable(value, identifiers="$@&%")
+ ):
return value
conversion_error = None
+ # Don't convert None if argument has None as a default value.
+ # Python < 3.11 adds None to type hints automatically when using None as
+ # a default value which preserves None automatically. This code keeps
+ # the same behavior also with newer Python versions. We can consider
+ # changing this once Python 3.11 is our minimum supported version.
+ if value is None and name in spec.defaults and spec.defaults[name] is None:
+ return value
+ # Primarily convert arguments based on type hints.
if name in spec.types:
- converter = TypeConverter.converter_for(spec.types[name], self._converters)
- if converter:
+ info: TypeInfo = spec.types[name]
+ converter = info.get_converter(
+ self.custom_converters,
+ self.languages,
+ allow_unknown=True,
+ )
+ # If type is unknown, don't attempt conversion. It would succeed, but
+ # we want to, for now, attempt conversion based on the default value.
+ if not isinstance(converter, UnknownConverter):
try:
- return converter.convert(name, value)
+ return converter.convert(value, name)
except ValueError as err:
conversion_error = err
+ # Try conversion also based on the default value type. We probably should
+ # do this only if there is no explicit type hint, but Python < 3.11
+ # handling `arg: type = None` differently than newer versions would mean
+ # that conversion behavior depends on the Python version. Once Python 3.11
+ # is our minimum supported version, we can consider reopening
+ # https://github.com/robotframework/robotframework/issues/4881
if name in spec.defaults:
- converter = TypeConverter.converter_for(type(spec.defaults[name]))
- if converter:
- try:
- return converter.convert(name, value, explicit_type=False,
- strict=bool(conversion_error))
- except ValueError as err:
- conversion_error = conversion_error or err
+ typ = type(spec.defaults[name])
+ if typ is str:
+ # Don't convert arguments to strings.
+ info = TypeInfo()
+ elif typ is int:
+ # Try also conversion to float.
+ info = TypeInfo.from_sequence([int, float])
+ elif typ is type(None) and isinstance(value, str) and value == "":
+ # Don't convert empty string to None.
+ info = TypeInfo()
+ else:
+ info = TypeInfo.from_type(typ)
+ try:
+ return info.convert(value, name, languages=self.languages)
+ except (ValueError, TypeError):
+ pass
if conversion_error:
raise conversion_error
return value
diff --git a/src/robot/running/arguments/argumentmapper.py b/src/robot/running/arguments/argumentmapper.py
index b31fb57d1fc..6a35f45225c 100644
--- a/src/robot/running/arguments/argumentmapper.py
+++ b/src/robot/running/arguments/argumentmapper.py
@@ -13,59 +13,63 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import TYPE_CHECKING
+
from robot.errors import DataError
+if TYPE_CHECKING:
+ from .argumentspec import ArgumentSpec
+
class ArgumentMapper:
- def __init__(self, argspec):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
+ def __init__(self, arg_spec: "ArgumentSpec"):
+ self.arg_spec = arg_spec
def map(self, positional, named, replace_defaults=True):
- template = KeywordCallTemplate(self._argspec)
+ template = KeywordCallTemplate(self.arg_spec)
template.fill_positional(positional)
template.fill_named(named)
if replace_defaults:
template.replace_defaults()
- return template.args, template.kwargs
+ return template.positional, template.named
class KeywordCallTemplate:
- def __init__(self, argspec):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
- self.args = [None if arg not in argspec.defaults
- else DefaultValue(argspec.defaults[arg])
- for arg in argspec.positional]
- self.kwargs = []
+ def __init__(self, spec: "ArgumentSpec"):
+ self.spec = spec
+ self.positional = [
+ DefaultValue(spec.defaults[arg]) if arg in spec.defaults else None
+ for arg in spec.positional
+ ]
+ self.named = []
def fill_positional(self, positional):
- self.args[:len(positional)] = positional
+ self.positional[: len(positional)] = positional
def fill_named(self, named):
- spec = self._argspec
+ spec = self.spec
for name, value in named:
if name in spec.positional_or_named:
index = spec.positional_or_named.index(name)
- self.args[index] = value
+ self.positional[index] = value
elif spec.var_named or name in spec.named_only:
- self.kwargs.append((name, value))
+ self.named.append((name, value))
else:
- raise DataError("Non-existing named argument '%s'." % name)
+ raise DataError(f"Non-existing named argument '{name}'.")
named_names = {name for name, _ in named}
for name in spec.named_only:
if name not in named_names:
value = DefaultValue(spec.defaults[name])
- self.kwargs.append((name, value))
+ self.named.append((name, value))
def replace_defaults(self):
is_default = lambda arg: isinstance(arg, DefaultValue)
- while self.args and is_default(self.args[-1]):
- self.args.pop()
- self.args = [a if not is_default(a) else a.value for a in self.args]
- self.kwargs = [(n, v) for n, v in self.kwargs if not is_default(v)]
+ while self.positional and is_default(self.positional[-1]):
+ self.positional.pop()
+ self.positional = [a if not is_default(a) else a.value for a in self.positional]
+ self.named = [(n, v) for n, v in self.named if not is_default(v)]
class DefaultValue:
@@ -77,5 +81,4 @@ def resolve(self, variables):
try:
return variables.replace_scalar(self.value)
except DataError as err:
- raise DataError('Resolving argument default values failed: %s'
- % err.message)
+ raise DataError(f"Resolving argument default values failed: {err}")
diff --git a/src/robot/running/arguments/argumentparser.py b/src/robot/running/arguments/argumentparser.py
index 4f3009ddffe..7c4e4072676 100644
--- a/src/robot/running/arguments/argumentparser.py
+++ b/src/robot/running/arguments/argumentparser.py
@@ -13,203 +13,303 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from inspect import isclass, signature, Parameter
-from typing import get_type_hints
+from abc import ABC, abstractmethod
+from inspect import isclass, Parameter, signature
+from typing import Any, Callable, get_type_hints
from robot.errors import DataError
-from robot.utils import is_string, split_from_equals
-from robot.variables import is_assign, is_scalar_assign
+from robot.utils import NOT_SET, split_from_equals
+from robot.variables import search_variable
from .argumentspec import ArgumentSpec
+from .typeinfo import TypeInfo
-class _ArgumentParser:
+class ArgumentParser(ABC):
- def __init__(self, type='Keyword', error_reporter=None):
- self._type = type
- self._error_reporter = error_reporter
+ def __init__(
+ self,
+ type: str = "Keyword",
+ error_reporter: "Callable[[str], None]|None" = None,
+ ):
+ self.type = type
+ self.error_reporter = error_reporter
- def parse(self, source, name=None):
+ @abstractmethod
+ def parse(self, source: Any, name: "str|None" = None) -> ArgumentSpec:
raise NotImplementedError
- def _report_error(self, error):
- if self._error_reporter:
- self._error_reporter(error)
+ def _report_error(self, error: str):
+ if self.error_reporter:
+ self.error_reporter(error)
else:
- raise DataError('Invalid argument specification: %s' % error)
+ raise DataError(f"Invalid argument specification: {error}")
-class PythonArgumentParser(_ArgumentParser):
+class PythonArgumentParser(ArgumentParser):
- def parse(self, handler, name=None):
- spec = ArgumentSpec(name, self._type)
- self._set_args(spec, handler)
- self._set_types(spec, handler)
- return spec
-
- def _set_args(self, spec, handler):
+ def parse(self, method, name=None):
try:
- sig = signature(handler)
- except ValueError: # Can occur w/ C functions (incl. many builtins).
- spec.var_positional = 'args'
- return
+ sig = signature(method)
+ except ValueError: # Can occur with C functions (incl. many builtins).
+ return ArgumentSpec(name, self.type, var_positional="args")
+ except TypeError as err: # Occurs if handler isn't actually callable.
+ raise DataError(str(err))
parameters = list(sig.parameters.values())
# `inspect.signature` drops `self` with bound methods and that's the case when
# inspecting keywords. `__init__` is got directly from class (i.e. isn't bound)
# so we need to handle that case ourselves.
# Partial objects do not have __name__ at least in Python =< 3.10.
- if getattr(handler, '__name__', None) == '__init__':
+ if getattr(method, "__name__", None) == "__init__":
parameters = parameters[1:]
- setters = {
- Parameter.POSITIONAL_ONLY: spec.positional_only.append,
- Parameter.POSITIONAL_OR_KEYWORD: spec.positional_or_named.append,
- Parameter.VAR_POSITIONAL: lambda name: setattr(spec, 'var_positional', name),
- Parameter.KEYWORD_ONLY: spec.named_only.append,
- Parameter.VAR_KEYWORD: lambda name: setattr(spec, 'var_named', name),
- }
+ spec = self._create_spec(parameters, name)
+ self._set_types(spec, method)
+ return spec
+
+ def _create_spec(self, parameters, name):
+ positional_only = []
+ positional_or_named = []
+ var_positional = None
+ named_only = []
+ var_named = None
+ defaults = {}
for param in parameters:
- setters[param.kind](param.name)
+ kind = param.kind
+ if kind == Parameter.POSITIONAL_ONLY:
+ positional_only.append(param.name)
+ elif kind == Parameter.POSITIONAL_OR_KEYWORD:
+ positional_or_named.append(param.name)
+ elif kind == Parameter.VAR_POSITIONAL:
+ var_positional = param.name
+ elif kind == Parameter.KEYWORD_ONLY:
+ named_only.append(param.name)
+ elif kind == Parameter.VAR_KEYWORD:
+ var_named = param.name
if param.default is not param.empty:
- spec.defaults[param.name] = param.default
-
- def _set_types(self, spec, handler):
+ defaults[param.name] = param.default
+ return ArgumentSpec(
+ name,
+ self.type,
+ positional_only,
+ positional_or_named,
+ var_positional,
+ named_only,
+ var_named,
+ defaults,
+ )
+
+ def _set_types(self, spec, method):
+ types = self._get_types(method)
+ if isinstance(types, dict) and "return" in types:
+ spec.return_type = types.pop("return")
+ spec.types = types
+
+ def _get_types(self, method):
# If types are set using the `@keyword` decorator, use them. Including when
- # types are explicitly disabled with `@keyword(types=None)`. Otherwise read
+ # types are explicitly disabled with `@keyword(types=None)`. Otherwise get
# type hints.
- if isclass(handler):
- handler = handler.__init__
- robot_types = getattr(handler, 'robot_types', ())
- if robot_types or robot_types is None:
- spec.types = robot_types
- else:
- spec.types = self._get_type_hints(handler)
-
- def _get_type_hints(self, handler):
+ if isclass(method):
+ method = method.__init__
+ types = getattr(method, "robot_types", ())
+ if types or types is None:
+ return types
try:
- return get_type_hints(handler)
+ return get_type_hints(method)
except Exception: # Can raise pretty much anything
# Not all functions have `__annotations__`.
# https://github.com/robotframework/robotframework/issues/4059
- return getattr(handler, '__annotations__', {})
-
-
-class _ArgumentSpecParser(_ArgumentParser):
-
- def parse(self, argspec, name=None):
- spec = ArgumentSpec(name, self._type)
- named_only = False
- for arg in argspec:
- arg = self._validate_arg(arg)
- if spec.var_named:
- self._report_error('Only last argument can be kwargs.')
- elif isinstance(arg, tuple):
- arg, default = arg
- arg = self._add_arg(spec, arg, named_only)
- spec.defaults[arg] = default
- elif self._is_kwargs(arg):
- spec.var_named = self._format_kwargs(arg)
- elif self._is_varargs(arg):
- if named_only:
- self._report_error('Cannot have multiple varargs.')
- if not self._is_kw_only_separator(arg):
- spec.var_positional = self._format_varargs(arg)
- named_only = True
- elif spec.defaults and not named_only:
- self._report_error('Non-default argument after default arguments.')
+ return getattr(method, "__annotations__", {})
+
+
+class ArgumentSpecParser(ArgumentParser):
+
+ def parse(self, arguments, name=None):
+ positional_only = []
+ positional_or_named = []
+ var_positional = None
+ named_only = []
+ var_named = None
+ defaults = {}
+ types = {}
+ named_only_separator_seen = positional_only_separator_seen = False
+ target = positional_or_named
+ for arg in arguments:
+ arg, default = self._validate_arg(arg)
+ if var_named:
+ self._report_error("Only last argument can be kwargs.")
+ elif self._is_positional_only_separator(arg):
+ if positional_only_separator_seen:
+ self._report_error("Too many positional-only separators.")
+ if named_only_separator_seen:
+ self._report_error(
+ "Positional-only separator must be before named-only arguments."
+ )
+ positional_only = positional_or_named
+ target = positional_or_named = []
+ positional_only_separator_seen = True
+ elif default is not NOT_SET:
+ self._parse_type(arg, types)
+ arg = self._format_arg(arg)
+ target.append(arg)
+ defaults[arg] = default
+ elif self._is_var_named(arg):
+ self._parse_type(arg, types)
+ var_named = self._format_var_named(arg)
+ elif self._is_var_positional(arg):
+ if named_only_separator_seen:
+ self._report_error("Cannot have multiple varargs.")
+ elif not self._is_named_only_separator(arg):
+ self._parse_type(arg, types)
+ var_positional = self._format_var_positional(arg)
+ named_only_separator_seen = True
+ target = named_only
else:
- self._add_arg(spec, arg, named_only)
- return spec
-
+ if defaults and not named_only_separator_seen:
+ self._report_error("Non-default argument after default arguments.")
+ self._parse_type(arg, types)
+ arg = self._format_arg(arg)
+ target.append(arg)
+ return ArgumentSpec(
+ name,
+ self.type,
+ positional_only,
+ positional_or_named,
+ var_positional,
+ named_only,
+ var_named,
+ defaults,
+ types=types,
+ )
+
+ @abstractmethod
def _validate_arg(self, arg):
raise NotImplementedError
- def _is_kwargs(self, arg):
+ @abstractmethod
+ def _is_var_positional(self, arg):
raise NotImplementedError
- def _format_kwargs(self, kwargs):
+ @abstractmethod
+ def _is_var_named(self, arg):
raise NotImplementedError
- def _is_kw_only_separator(self, arg):
+ @abstractmethod
+ def _is_positional_only_separator(self, arg):
raise NotImplementedError
- def _is_varargs(self, arg):
+ @abstractmethod
+ def _is_named_only_separator(self, arg):
raise NotImplementedError
- def _format_varargs(self, varargs):
+ @abstractmethod
+ def _format_arg(self, arg):
raise NotImplementedError
- def _format_arg(self, arg):
- return arg
+ @abstractmethod
+ def _format_var_named(self, arg):
+ raise NotImplementedError
- def _add_arg(self, spec, arg, named_only=False):
- arg = self._format_arg(arg)
- target = spec.positional_or_named if not named_only else spec.named_only
- target.append(arg)
- return arg
+ @abstractmethod
+ def _format_var_positional(self, arg):
+ raise NotImplementedError
+
+ @abstractmethod
+ def _parse_type(self, arg, types):
+ raise NotImplementedError
-class DynamicArgumentParser(_ArgumentSpecParser):
+class DynamicArgumentParser(ArgumentSpecParser):
def _validate_arg(self, arg):
if isinstance(arg, tuple):
- if self._is_invalid_tuple(arg):
- self._report_error('Invalid argument "%s".' % (arg,))
+ if not self._is_valid_tuple(arg):
+ self._report_error(f'Invalid argument "{arg}".')
+ return None, NOT_SET
if len(arg) == 1:
- return arg[0]
- return arg
- if '=' in arg:
- return tuple(arg.split('=', 1))
- return arg
-
- def _is_invalid_tuple(self, arg):
- return (len(arg) > 2
- or not is_string(arg[0])
- or (arg[0].startswith('*') and len(arg) > 1))
+ return arg[0], NOT_SET
+ return arg[0], arg[1]
+ if "=" in arg:
+ return tuple(arg.split("=", 1))
+ return arg, NOT_SET
- def _is_kwargs(self, arg):
- return arg.startswith('**')
+ def _is_valid_tuple(self, arg):
+ return (
+ len(arg) in (1, 2)
+ and isinstance(arg[0], str)
+ and not (arg[0].startswith("*") and len(arg) == 2)
+ )
- def _format_kwargs(self, kwargs):
- return kwargs[2:]
+ def _is_var_positional(self, arg):
+ return arg[:1] == "*"
- def _is_varargs(self, arg):
- return arg.startswith('*')
+ def _is_var_named(self, arg):
+ return arg[:2] == "**"
- def _is_kw_only_separator(self, arg):
- return arg == '*'
+ def _is_positional_only_separator(self, arg):
+ return arg == "/"
- def _format_varargs(self, varargs):
- return varargs[1:]
+ def _is_named_only_separator(self, arg):
+ return arg == "*"
+ def _format_arg(self, arg):
+ return arg
-class UserKeywordArgumentParser(_ArgumentSpecParser):
-
- def _validate_arg(self, arg):
- arg, default = split_from_equals(arg)
- if not (is_assign(arg) or arg == '@{}'):
- self._report_error("Invalid argument syntax '%s'." % arg)
- if default is None:
- return arg
- if not is_scalar_assign(arg):
- typ = 'list' if arg[0] == '@' else 'dictionary'
- self._report_error("Only normal arguments accept default values, "
- "%s arguments like '%s' do not." % (typ, arg))
- return arg, default
-
- def _is_kwargs(self, arg):
- return arg and arg[0] == '&'
+ def _format_var_positional(self, arg):
+ return arg[1:]
- def _format_kwargs(self, kwargs):
- return kwargs[2:-1]
+ def _format_var_named(self, arg):
+ return arg[2:]
- def _is_varargs(self, arg):
- return arg and arg[0] == '@'
+ def _parse_type(self, arg, types):
+ pass
- def _is_kw_only_separator(self, arg):
- return arg == '@{}'
- def _format_varargs(self, varargs):
- return varargs[2:-1]
+class UserKeywordArgumentParser(ArgumentSpecParser):
- def _format_arg(self, arg):
- return arg[2:-1]
+ def _validate_arg(self, arg):
+ arg, default = split_from_equals(arg)
+ match = search_variable(arg, parse_type=True, ignore_errors=True)
+ if not (match.is_assign() or self._is_named_only_separator(match)):
+ self._report_error(f"Invalid argument syntax '{arg}'.")
+ match = search_variable("")
+ default = NOT_SET
+ elif default is None:
+ default = NOT_SET
+ elif arg[0] != "$":
+ kind = "list" if arg[0] == "@" else "dictionary"
+ self._report_error(
+ f"Only normal arguments accept default values, "
+ f"{kind} arguments like '{arg}' do not."
+ )
+ default = NOT_SET
+ return match, default
+
+ def _is_var_positional(self, match):
+ return match.identifier == "@"
+
+ def _is_var_named(self, match):
+ return match.identifier == "&"
+
+ def _is_positional_only_separator(self, arg):
+ return False
+
+ def _is_named_only_separator(self, match):
+ return match.identifier == "@" and not match.base
+
+ def _format_arg(self, match):
+ return match.base
+
+ def _format_var_named(self, match):
+ return match.base
+
+ def _format_var_positional(self, match):
+ return match.base
+
+ def _parse_type(self, match, types):
+ try:
+ info = TypeInfo.from_variable(match, handle_list_and_dict=False)
+ except DataError as err:
+ self._report_error(f"Invalid argument '{match}': {err}")
+ else:
+ if info:
+ types[match.base] = info
diff --git a/src/robot/running/arguments/argumentresolver.py b/src/robot/running/arguments/argumentresolver.py
index 3bd092755a5..23f670c65c2 100644
--- a/src/robot/running/arguments/argumentresolver.py
+++ b/src/robot/running/arguments/argumentresolver.py
@@ -13,105 +13,137 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import TYPE_CHECKING
+
from robot.errors import DataError
-from robot.utils import is_string, is_dict_like, split_from_equals
+from robot.utils import is_dict_like, split_from_equals
from robot.variables import is_dict_variable
+from ..model import Argument
from .argumentvalidator import ArgumentValidator
+if TYPE_CHECKING:
+ from .argumentspec import ArgumentSpec
-class ArgumentResolver:
- def __init__(self, argspec, resolve_named=True,
- resolve_variables_until=None, dict_to_kwargs=False):
- self._named_resolver = NamedArgumentResolver(argspec) \
- if resolve_named else NullNamedArgumentResolver()
- self._variable_replacer = VariableReplacer(resolve_variables_until)
- self._dict_to_kwargs = DictToKwargs(argspec, dict_to_kwargs)
- self._argument_validator = ArgumentValidator(argspec)
+class ArgumentResolver:
- def resolve(self, arguments, variables=None):
- positional, named = self._named_resolver.resolve(arguments, variables)
- positional, named = self._variable_replacer.replace(positional, named,
- variables)
- positional, named = self._dict_to_kwargs.handle(positional, named)
- self._argument_validator.validate(positional, named,
- dryrun=variables is None)
+ def __init__(
+ self,
+ spec: "ArgumentSpec",
+ resolve_named: bool = True,
+ resolve_args_until: "int|None" = None,
+ dict_to_kwargs: bool = False,
+ ):
+ self.named_resolver = (
+ NamedArgumentResolver(spec)
+ if resolve_named
+ else NullNamedArgumentResolver()
+ )
+ self.variable_replacer = VariableReplacer(spec, resolve_args_until)
+ self.dict_to_kwargs = DictToKwargs(spec, dict_to_kwargs)
+ self.argument_validator = ArgumentValidator(spec)
+
+ def resolve(self, args, named_args=None, variables=None):
+ if named_args is None:
+ positional, named = self.named_resolver.resolve(args, variables)
+ else:
+ positional, named = args, list(named_args.items())
+ positional, named = self.variable_replacer.replace(positional, named, variables)
+ positional, named = self.dict_to_kwargs.handle(positional, named)
+ self.argument_validator.validate(positional, named, dryrun=variables is None)
return positional, named
class NamedArgumentResolver:
- def __init__(self, argspec):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
+ def __init__(self, spec: "ArgumentSpec"):
+ self.spec = spec
def resolve(self, arguments, variables=None):
- positional = []
+ known_positional_count = max(
+ len(self.spec.positional_only),
+ len(self.spec.embedded),
+ )
+ positional = list(arguments[:known_positional_count])
named = []
- for arg in arguments:
+ for arg in arguments[known_positional_count:]:
if is_dict_variable(arg):
named.append(arg)
- elif self._is_named(arg, named, variables):
- named.append(split_from_equals(arg))
- elif named:
- self._raise_positional_after_named()
else:
- positional.append(arg)
+ name, value = self._split_named(arg, named, variables)
+ if name is not None:
+ named.append((name, value))
+ elif named:
+ self._raise_positional_after_named()
+ else:
+ positional.append(value)
return positional, named
- def _is_named(self, arg, previous_named, variables=None):
+ def _split_named(self, arg, previous_named, variables):
+ if isinstance(arg, Argument):
+ return arg.name, arg.value
name, value = split_from_equals(arg)
- if value is None:
- return False
+ if value is None or not self._is_named(name, previous_named, variables):
+ return None, arg
+ return name, value
+
+ def _is_named(self, name, previous_named, variables):
+ if previous_named or self.spec.var_named:
+ return True
if variables:
try:
name = variables.replace_scalar(name)
except DataError:
return False
- spec = self._argspec
- return bool(previous_named or
- spec.var_named or
- name in spec.positional_or_named or
- name in spec.named_only)
+ return name in self.spec.named
def _raise_positional_after_named(self):
- raise DataError("%s '%s' got positional argument after named arguments."
- % (self._argspec.type.capitalize(), self._argspec.name))
+ raise DataError(
+ f"{self.spec.type.capitalize()} '{self.spec.name}' "
+ f"got positional argument after named arguments."
+ )
class NullNamedArgumentResolver:
def resolve(self, arguments, variables=None):
- return arguments, {}
+ return arguments, []
class DictToKwargs:
- def __init__(self, argspec, enabled=False):
- self._maxargs = argspec.maxargs
- self._enabled = enabled and bool(argspec.var_named)
+ def __init__(self, spec: "ArgumentSpec", enabled: bool = False):
+ self.maxargs = spec.maxargs
+ self.enabled = enabled and bool(spec.var_named)
def handle(self, positional, named):
- if self._enabled and self._extra_arg_has_kwargs(positional, named):
+ if self.enabled and self._extra_arg_has_kwargs(positional, named):
named = positional.pop().items()
return positional, named
def _extra_arg_has_kwargs(self, positional, named):
- if named or len(positional) != self._maxargs + 1:
+ if named or len(positional) != self.maxargs + 1:
return False
return is_dict_like(positional[-1])
class VariableReplacer:
- def __init__(self, resolve_until=None):
- self._resolve_until = resolve_until
+ def __init__(self, spec: "ArgumentSpec", resolve_until: "int|None" = None):
+ self.spec = spec
+ self.resolve_until = resolve_until
def replace(self, positional, named, variables=None):
# `variables` is None in dry-run mode and when using Libdoc.
if variables:
- positional = variables.replace_list(positional, self._resolve_until)
+ if self.spec.embedded:
+ embedded = len(self.spec.embedded)
+ positional = [
+ variables.replace_scalar(emb) for emb in positional[:embedded]
+ ] + variables.replace_list(positional[embedded:])
+ else:
+ positional = variables.replace_list(positional, self.resolve_until)
named = list(self._replace_named(named, variables.replace_scalar))
else:
# If `var` isn't a tuple, it's a &{dict} variables.
@@ -121,8 +153,8 @@ def replace(self, positional, named, variables=None):
def _replace_named(self, named, replace_scalar):
for item in named:
for name, value in self._get_replaced_named(item, replace_scalar):
- if not is_string(name):
- raise DataError('Argument names must be strings.')
+ if not isinstance(name, str):
+ raise DataError("Argument names must be strings.")
yield name, value
def _get_replaced_named(self, item, replace_scalar):
diff --git a/src/robot/running/arguments/argumentspec.py b/src/robot/running/arguments/argumentspec.py
index bde9325609d..4283fc03015 100644
--- a/src/robot/running/arguments/argumentspec.py
+++ b/src/robot/running/arguments/argumentspec.py
@@ -15,145 +15,252 @@
import sys
from enum import Enum
+from typing import Any, Callable, Iterator, Mapping, Sequence
-from robot.utils import is_union, safe_str, setter, type_repr
+from robot.utils import NOT_SET, safe_str, setter, SetterAwareType
from .argumentconverter import ArgumentConverter
from .argumentmapper import ArgumentMapper
from .argumentresolver import ArgumentResolver
+from .typeinfo import TypeInfo
from .typevalidator import TypeValidator
-class ArgumentSpec:
+class ArgumentSpec(metaclass=SetterAwareType):
+ __slots__ = (
+ "_name",
+ "type",
+ "positional_only",
+ "positional_or_named",
+ "var_positional",
+ "named_only",
+ "var_named",
+ "embedded",
+ "defaults",
+ )
- def __init__(self, name=None, type='Keyword', positional_only=None,
- positional_or_named=None, var_positional=None, named_only=None,
- var_named=None, defaults=None, types=None):
+ def __init__(
+ self,
+ name: "str|Callable[[], str]|None" = None,
+ type: str = "Keyword",
+ positional_only: Sequence[str] = (),
+ positional_or_named: Sequence[str] = (),
+ var_positional: "str|None" = None,
+ named_only: Sequence[str] = (),
+ var_named: "str|None" = None,
+ defaults: "Mapping[str, Any]|None" = None,
+ embedded: Sequence[str] = (),
+ types: "Mapping|Sequence|None" = None,
+ return_type: "TypeInfo|None" = None,
+ ):
self.name = name
self.type = type
- self.positional_only = positional_only or []
- self.positional_or_named = positional_or_named or []
+ self.positional_only = tuple(positional_only)
+ self.positional_or_named = tuple(positional_or_named)
self.var_positional = var_positional
- self.named_only = named_only or []
+ self.named_only = tuple(named_only)
self.var_named = var_named
+ self.embedded = tuple(embedded)
self.defaults = defaults or {}
self.types = types
+ self.return_type = return_type
+
+ @property
+ def name(self) -> "str|None":
+ return self._name if not callable(self._name) else self._name()
+
+ @name.setter
+ def name(self, name: "str|Callable[[], str]|None"):
+ self._name = name
@setter
- def types(self, types):
+ def types(self, types: "Mapping|Sequence|None") -> "dict[str, TypeInfo]|None":
return TypeValidator(self).validate(types)
+ @setter
+ def return_type(self, hint) -> "TypeInfo|None":
+ if hint in (None, type(None)):
+ return None
+ if isinstance(hint, TypeInfo):
+ return hint
+ return TypeInfo.from_type_hint(hint, sequence_is_union=True)
+
@property
- def positional(self):
+ def positional(self) -> "tuple[str, ...]":
return self.positional_only + self.positional_or_named
@property
- def minargs(self):
+ def named(self) -> "tuple[str, ...]":
+ return self.named_only + self.positional_or_named
+
+ @property
+ def minargs(self) -> int:
return len([arg for arg in self.positional if arg not in self.defaults])
@property
- def maxargs(self):
+ def maxargs(self) -> int:
return len(self.positional) if not self.var_positional else sys.maxsize
@property
- def argument_names(self):
- return (self.positional_only +
- self.positional_or_named +
- ([self.var_positional] if self.var_positional else []) +
- self.named_only +
- ([self.var_named] if self.var_named else []))
-
- def resolve(self, arguments, variables=None, converters=None,
- resolve_named=True, resolve_variables_until=None,
- dict_to_kwargs=False):
- resolver = ArgumentResolver(self, resolve_named,
- resolve_variables_until, dict_to_kwargs)
- positional, named = resolver.resolve(arguments, variables)
- return self.convert(positional, named, converters, dry_run=not variables)
-
- def convert(self, positional, named, converters=None, dry_run=False):
+ def argument_names(self) -> "tuple[str, ...]":
+ var_positional = (self.var_positional,) if self.var_positional else ()
+ var_named = (self.var_named,) if self.var_named else ()
+ return (
+ self.positional_only
+ + self.positional_or_named
+ + var_positional
+ + self.named_only
+ + var_named
+ )
+
+ def resolve(
+ self,
+ args,
+ named_args=None,
+ variables=None,
+ converters=None,
+ resolve_named=True,
+ resolve_args_until=None,
+ dict_to_kwargs=False,
+ languages=None,
+ ) -> "tuple[list, list]":
+ resolver = ArgumentResolver(
+ self,
+ resolve_named,
+ resolve_args_until,
+ dict_to_kwargs,
+ )
+ positional, named = resolver.resolve(args, named_args, variables)
+ return self.convert(
+ positional,
+ named,
+ converters,
+ dry_run=not variables,
+ languages=languages,
+ )
+
+ def convert(
+ self,
+ positional,
+ named,
+ converters=None,
+ dry_run=False,
+ languages=None,
+ ) -> "tuple[list, list]":
if self.types or self.defaults:
- converter = ArgumentConverter(self, converters, dry_run)
+ converter = ArgumentConverter(self, converters, dry_run, languages)
positional, named = converter.convert(positional, named)
return positional, named
- def map(self, positional, named, replace_defaults=True):
+ def map(
+ self,
+ positional,
+ named,
+ replace_defaults=True,
+ ) -> "tuple[list, list]":
mapper = ArgumentMapper(self)
return mapper.map(positional, named, replace_defaults)
- def __iter__(self):
- notset = ArgInfo.NOTSET
+ def copy(self) -> "ArgumentSpec":
+ types = dict(self.types) if self.types is not None else None
+ return type(self)(
+ self.name,
+ self.type,
+ self.positional_only,
+ self.positional_or_named,
+ self.var_positional,
+ self.named_only,
+ self.var_named,
+ dict(self.defaults),
+ self.embedded,
+ types,
+ self.return_type,
+ )
+
+ def __iter__(self) -> Iterator["ArgInfo"]:
get_type = (self.types or {}).get
get_default = self.defaults.get
for arg in self.positional_only:
- yield ArgInfo(ArgInfo.POSITIONAL_ONLY, arg,
- get_type(arg, notset), get_default(arg, notset))
+ yield ArgInfo(
+ ArgInfo.POSITIONAL_ONLY,
+ arg,
+ get_type(arg),
+ get_default(arg, NOT_SET),
+ )
if self.positional_only:
yield ArgInfo(ArgInfo.POSITIONAL_ONLY_MARKER)
for arg in self.positional_or_named:
- yield ArgInfo(ArgInfo.POSITIONAL_OR_NAMED, arg,
- get_type(arg, notset), get_default(arg, notset))
+ yield ArgInfo(
+ ArgInfo.POSITIONAL_OR_NAMED,
+ arg,
+ get_type(arg),
+ get_default(arg, NOT_SET),
+ )
if self.var_positional:
- yield ArgInfo(ArgInfo.VAR_POSITIONAL, self.var_positional,
- get_type(self.var_positional, notset))
+ yield ArgInfo(
+ ArgInfo.VAR_POSITIONAL,
+ self.var_positional,
+ get_type(self.var_positional),
+ )
elif self.named_only:
yield ArgInfo(ArgInfo.NAMED_ONLY_MARKER)
for arg in self.named_only:
- yield ArgInfo(ArgInfo.NAMED_ONLY, arg,
- get_type(arg, notset), get_default(arg, notset))
+ yield ArgInfo(
+ ArgInfo.NAMED_ONLY,
+ arg,
+ get_type(arg),
+ get_default(arg, NOT_SET),
+ )
if self.var_named:
- yield ArgInfo(ArgInfo.VAR_NAMED, self.var_named,
- get_type(self.var_named, notset))
+ yield ArgInfo(
+ ArgInfo.VAR_NAMED,
+ self.var_named,
+ get_type(self.var_named),
+ )
def __bool__(self):
- return any([self.positional_only, self.positional_or_named, self.var_positional,
- self.named_only, self.var_named])
+ return any(self)
def __str__(self):
- return ', '.join(str(arg) for arg in self)
+ return ", ".join(str(arg) for arg in self)
class ArgInfo:
- NOTSET = object()
- POSITIONAL_ONLY = 'POSITIONAL_ONLY'
- POSITIONAL_ONLY_MARKER = 'POSITIONAL_ONLY_MARKER'
- POSITIONAL_OR_NAMED = 'POSITIONAL_OR_NAMED'
- VAR_POSITIONAL = 'VAR_POSITIONAL'
- NAMED_ONLY_MARKER = 'NAMED_ONLY_MARKER'
- NAMED_ONLY = 'NAMED_ONLY'
- VAR_NAMED = 'VAR_NAMED'
-
- def __init__(self, kind, name='', types=NOTSET, default=NOTSET):
+ """Contains argument information. Only used by Libdoc."""
+
+ POSITIONAL_ONLY = "POSITIONAL_ONLY"
+ POSITIONAL_ONLY_MARKER = "POSITIONAL_ONLY_MARKER"
+ POSITIONAL_OR_NAMED = "POSITIONAL_OR_NAMED"
+ VAR_POSITIONAL = "VAR_POSITIONAL"
+ NAMED_ONLY_MARKER = "NAMED_ONLY_MARKER"
+ NAMED_ONLY = "NAMED_ONLY"
+ VAR_NAMED = "VAR_NAMED"
+
+ def __init__(
+ self,
+ kind: str,
+ name: str = "",
+ type: "TypeInfo|None" = None,
+ default: Any = NOT_SET,
+ ):
self.kind = kind
self.name = name
- self.types = types
+ self.type = type or TypeInfo()
self.default = default
- @setter
- def types(self, typ):
- if not typ or typ is self.NOTSET:
- return tuple()
- if isinstance(typ, tuple):
- return typ
- if is_union(typ):
- return typ.__args__
- return (typ,)
-
@property
- def required(self):
- if self.kind in (self.POSITIONAL_ONLY,
- self.POSITIONAL_OR_NAMED,
- self.NAMED_ONLY):
- return self.default is self.NOTSET
+ def required(self) -> bool:
+ if self.kind in (
+ self.POSITIONAL_ONLY,
+ self.POSITIONAL_OR_NAMED,
+ self.NAMED_ONLY,
+ ):
+ return self.default is NOT_SET
return False
@property
- def types_reprs(self):
- return [type_repr(t) for t in self.types]
-
- @property
- def default_repr(self):
- if self.default is self.NOTSET:
+ def default_repr(self) -> "str|None":
+ if self.default is NOT_SET:
return None
if isinstance(self.default, Enum):
return self.default.name
@@ -161,19 +268,19 @@ def default_repr(self):
def __str__(self):
if self.kind == self.POSITIONAL_ONLY_MARKER:
- return '/'
+ return "/"
if self.kind == self.NAMED_ONLY_MARKER:
- return '*'
+ return "*"
ret = self.name
if self.kind == self.VAR_POSITIONAL:
- ret = '*' + ret
+ ret = "*" + ret
elif self.kind == self.VAR_NAMED:
- ret = '**' + ret
- if self.types:
- ret = '%s: %s' % (ret, ' | '.join(self.types_reprs))
- default_sep = ' = '
+ ret = "**" + ret
+ if self.type:
+ ret = f"{ret}: {self.type}"
+ default_sep = " = "
else:
- default_sep = '='
- if self.default is not self.NOTSET:
- ret = '%s%s%s' % (ret, default_sep, self.default_repr)
+ default_sep = "="
+ if self.default is not NOT_SET:
+ ret = f"{ret}{default_sep}{self.default_repr}"
return ret
diff --git a/src/robot/running/arguments/argumentvalidator.py b/src/robot/running/arguments/argumentvalidator.py
index 3048ba35393..20c79bac3b0 100644
--- a/src/robot/running/arguments/argumentvalidator.py
+++ b/src/robot/running/arguments/argumentvalidator.py
@@ -13,44 +13,42 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import TYPE_CHECKING
+
from robot.errors import DataError
-from robot.utils import plural_or_not, seq2str
+from robot.utils import plural_or_not as s, seq2str
from robot.variables import is_dict_variable, is_list_variable
+if TYPE_CHECKING:
+ from .argumentspec import ArgumentSpec
+
class ArgumentValidator:
- def __init__(self, argspec):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
+ def __init__(self, arg_spec: "ArgumentSpec"):
+ self.spec = arg_spec
def validate(self, positional, named, dryrun=False):
- named = set(name for name, value in named)
- if dryrun and (any(is_list_variable(arg) for arg in positional) or
- any(is_dict_variable(arg) for arg in named)):
+ named = {name for name, value in named}
+ if dryrun and (
+ any(is_list_variable(arg) for arg in positional)
+ or any(is_dict_variable(arg) for arg in named)
+ ):
return
- self._validate_no_multiple_values(positional, named, self._argspec)
- self._validate_no_positional_only_as_named(named, self._argspec)
- self._validate_positional_limits(positional, named, self._argspec)
- self._validate_no_mandatory_missing(positional, named, self._argspec)
- self._validate_no_named_only_missing(named, self._argspec)
- self._validate_no_extra_named(named, self._argspec)
+ self._validate_no_multiple_values(positional, named, self.spec)
+ self._validate_positional_limits(positional, named, self.spec)
+ self._validate_no_mandatory_missing(positional, named, self.spec)
+ self._validate_no_named_only_missing(named, self.spec)
+ self._validate_no_extra_named(named, self.spec)
def _validate_no_multiple_values(self, positional, named, spec):
- for name in spec.positional[:len(positional)]:
+ for name in spec.positional[: len(positional) - len(spec.embedded)]:
if name in named and name not in spec.positional_only:
- self._raise_error("got multiple values for argument '%s'" % name)
+ self._raise_error(f"got multiple values for argument '{name}'")
def _raise_error(self, message):
- raise DataError("%s '%s' %s." % (self._argspec.type.capitalize(),
- self._argspec.name, message))
-
- def _validate_no_positional_only_as_named(self, named, spec):
- if not spec.var_named:
- for name in named:
- if name in spec.positional_only:
- self._raise_error("does not accept argument '%s' as named "
- "argument" % name)
+ name = f"'{self.spec.name}' " if self.spec.name else ""
+ raise DataError(f"{self.spec.type.capitalize()} {name}{message}.")
def _validate_positional_limits(self, positional, named, spec):
count = len(positional) + self._named_positionals(named, spec)
@@ -61,32 +59,36 @@ def _named_positionals(self, named, spec):
return sum(1 for n in named if n in spec.positional_or_named)
def _raise_wrong_count(self, count, spec):
- minend = plural_or_not(spec.minargs)
- if spec.minargs == spec.maxargs:
- expected = '%d argument%s' % (spec.minargs, minend)
+ embedded = len(spec.embedded)
+ minargs = spec.minargs - embedded
+ maxargs = spec.maxargs - embedded
+ if minargs == maxargs:
+ expected = f"{minargs} argument{s(minargs)}"
elif not spec.var_positional:
- expected = '%d to %d arguments' % (spec.minargs, spec.maxargs)
+ expected = f"{minargs} to {maxargs} arguments"
else:
- expected = 'at least %d argument%s' % (spec.minargs, minend)
+ expected = f"at least {minargs} argument{s(minargs)}"
if spec.var_named or spec.named_only:
- expected = expected.replace('argument', 'non-named argument')
- self._raise_error("expected %s, got %d" % (expected, count))
+ expected = expected.replace("argument", "non-named argument")
+ self._raise_error(f"expected {expected}, got {count - embedded}")
def _validate_no_mandatory_missing(self, positional, named, spec):
- for name in spec.positional[len(positional):]:
+ for name in spec.positional[len(positional) :]:
if name not in spec.defaults and name not in named:
- self._raise_error("missing value for argument '%s'" % name)
+ self._raise_error(f"missing value for argument '{name}'")
def _validate_no_named_only_missing(self, named, spec):
defined = set(named) | set(spec.defaults)
missing = [arg for arg in spec.named_only if arg not in defined]
if missing:
- self._raise_error("missing named-only argument%s %s"
- % (plural_or_not(missing), seq2str(sorted(missing))))
+ self._raise_error(
+ f"missing named-only argument{s(missing)} {seq2str(sorted(missing))}"
+ )
def _validate_no_extra_named(self, named, spec):
if not spec.var_named:
extra = set(named) - set(spec.positional_or_named) - set(spec.named_only)
if extra:
- self._raise_error("got unexpected named argument%s %s"
- % (plural_or_not(extra), seq2str(sorted(extra))))
+ self._raise_error(
+ f"got unexpected named argument{s(extra)} {seq2str(sorted(extra))}"
+ )
diff --git a/src/robot/running/arguments/customconverters.py b/src/robot/running/arguments/customconverters.py
index 726205ca86a..a30a3ba3508 100644
--- a/src/robot/running/arguments/customconverters.py
+++ b/src/robot/running/arguments/customconverters.py
@@ -13,9 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.utils import getdoc, is_union, type_name
-
-from .argumentparser import PythonArgumentParser
+from robot.utils import getdoc, seq2str, type_name
class CustomArgumentConverters:
@@ -24,13 +22,15 @@ def __init__(self, converters):
self.converters = converters
@classmethod
- def from_dict(cls, converters, error_reporter):
+ def from_dict(cls, converters, library=None):
valid = []
for type_, conv in converters.items():
try:
- info = ConverterInfo.for_converter(type_, conv)
+ info = ConverterInfo.for_converter(type_, conv, library)
except TypeError as err:
- error_reporter(str(err))
+ if library is None:
+ raise
+ library.report_error(str(err))
else:
valid.append(info)
return cls(valid)
@@ -51,10 +51,11 @@ def __len__(self):
class ConverterInfo:
- def __init__(self, type, converter, value_types):
+ def __init__(self, type, converter, value_types, library=None):
self.type = type
self.converter = converter
self.value_types = value_types
+ self.library = library
@property
def name(self):
@@ -65,28 +66,65 @@ def doc(self):
return getdoc(self.converter) or getdoc(self.type)
@classmethod
- def for_converter(cls, type_, converter):
+ def for_converter(cls, type_, converter, library):
if not isinstance(type_, type):
- raise TypeError(f'Custom converters must be specified using types, '
- f'got {type_name(type_)} {type_!r}.')
+ raise TypeError(
+ f"Custom converters must be specified using types, "
+ f"got {type_name(type_)} {type_!r}."
+ )
+ if converter is None:
+
+ def converter(arg):
+ raise TypeError(
+ f"Only {type_.__name__} instances are accepted, "
+ f"got {type_name(arg)}."
+ )
+
if not callable(converter):
- raise TypeError(f'Custom converters must be callable, converter for '
- f'{type_name(type_)} is {type_name(converter)}.')
- spec = PythonArgumentParser(type='Converter').parse(converter)
- if len(spec.positional) != 1:
- raise TypeError(f'Custom converters must accept exactly one positional '
- f'argument, converter {converter.__name__!r} accepts '
- f'{len(spec.positional)}.')
- if len(spec.named_only):
- raise TypeError(f'Custom converter {converter.__name__!r} accepts '
- f'keyword-only arguments which is not supported.')
- arg_type = spec.types.get(spec.positional[0])
- if arg_type is None:
+ raise TypeError(
+ f"Custom converters must be callable, converter for "
+ f"{type_name(type_)} is {type_name(converter)}."
+ )
+ spec = cls._get_arg_spec(converter)
+ type_info = spec.types.get(
+ spec.positional[0] if spec.positional else spec.var_positional
+ )
+ if type_info is None:
accepts = ()
- elif is_union(arg_type):
- accepts = arg_type.__args__
- elif hasattr(arg_type, '__origin__'):
- accepts = (arg_type.__origin__,)
+ elif type_info.is_union:
+ accepts = type_info.nested
else:
- accepts = (arg_type,)
- return cls(type_, converter, accepts)
+ accepts = (type_info,)
+ accepts = tuple(info.type for info in accepts)
+ pass_library = spec.minargs == 2 or spec.var_positional
+ return cls(type_, converter, accepts, library if pass_library else None)
+
+ @classmethod
+ def _get_arg_spec(cls, converter):
+ # Avoid cyclic import. Yuck.
+ from .argumentparser import PythonArgumentParser
+
+ spec = PythonArgumentParser(type="Converter").parse(converter)
+ if spec.minargs > 2:
+ required = seq2str([a for a in spec.positional if a not in spec.defaults])
+ raise TypeError(
+ f"Custom converters cannot have more than two mandatory "
+ f"arguments, '{converter.__name__}' has {required}."
+ )
+ if not spec.maxargs:
+ raise TypeError(
+ f"Custom converters must accept one positional argument, "
+ f"'{converter.__name__}' accepts none."
+ )
+ if spec.named_only and set(spec.named_only) - set(spec.defaults):
+ required = seq2str(sorted(set(spec.named_only) - set(spec.defaults)))
+ raise TypeError(
+ f"Custom converters cannot have mandatory keyword-only "
+ f"arguments, '{converter.__name__}' has {required}."
+ )
+ return spec
+
+ def convert(self, value):
+ if not self.library:
+ return self.converter(value)
+ return self.converter(value, self.library.instance)
diff --git a/src/robot/running/arguments/embedded.py b/src/robot/running/arguments/embedded.py
index 0bc5ea36577..95bd98005cf 100644
--- a/src/robot/running/arguments/embedded.py
+++ b/src/robot/running/arguments/embedded.py
@@ -14,78 +14,201 @@
# limitations under the License.
import re
+import warnings
+from typing import Mapping, Sequence
from robot.errors import DataError
from robot.utils import get_error_message
-from robot.variables import VariableIterator
+from robot.variables import VariableMatches
+from ..context import EXECUTION_CONTEXTS
+from .typeinfo import TypeInfo
+
+VARIABLE_PLACEHOLDER = "robot-834d5d70-239e-43f6-97fb-902acf41625b"
-class EmbeddedArguments:
- def __init__(self, name):
- if '${' in name:
- self.name, self.args = EmbeddedArgumentParser().parse(name)
- else:
- self.name, self.args = None, []
+class EmbeddedArguments:
- def __bool__(self):
- return self.name is not None
+ def __init__(
+ self,
+ name: re.Pattern,
+ args: Sequence[str] = (),
+ custom_patterns: "Mapping[str, str]|None" = None,
+ types: "Sequence[TypeInfo|None]" = (),
+ ):
+ self.name = name
+ self.args = tuple(args)
+ self.custom_patterns = custom_patterns or None
+ self.types = types
+
+ @classmethod
+ def from_name(cls, name: str) -> "EmbeddedArguments|None":
+ return EmbeddedArgumentParser().parse(name) if "${" in name else None
+
+ def match(self, name: str) -> "re.Match|None":
+ """Deprecated since Robot Framework 7.3."""
+ warnings.warn(
+ "'EmbeddedArguments.match()' is deprecated since Robot Framework 7.3. Use "
+ "new 'EmbeddedArguments.matches()' or 'EmbeddedArguments.parse_args()' "
+ "instead. Alternatively, use 'EmbeddedArguments.name.fullmatch()' to "
+ "preserve the old behavior and to be compatible with earlier Robot "
+ "Framework versions."
+ )
+ return self.name.fullmatch(name)
+
+ def matches(self, name: str) -> bool:
+ """Return ``True`` if ``name`` matches these embedded arguments."""
+ args, _ = self._parse_args(name)
+ return bool(args)
+
+ def parse_args(self, name: str) -> "tuple[str, ...]":
+ """Parse arguments matching these embedded arguments from ``name``."""
+ args, placeholders = self._parse_args(name)
+ if not placeholders:
+ return args
+ return tuple([self._replace_placeholders(a, placeholders) for a in args])
+
+ def _parse_args(self, name: str) -> "tuple[tuple[str, ...], dict[str, str]]":
+ parts = []
+ placeholders = {}
+ for match in VariableMatches(name):
+ ph = f"={VARIABLE_PLACEHOLDER}-{len(placeholders) + 1}="
+ placeholders[ph] = match.match
+ parts[-1:] = [match.before, ph, match.after]
+ name = "".join(parts) if parts else name
+ match = self.name.fullmatch(name)
+ args = match.groups() if match else ()
+ return args, placeholders
+
+ def _replace_placeholders(self, arg: str, placeholders: "dict[str, str]") -> str:
+ for ph in placeholders:
+ if ph in arg:
+ arg = arg.replace(ph, placeholders[ph])
+ return arg
+
+ def map(self, args: Sequence[object]) -> "list[tuple[str, object]]":
+ args = [
+ info.convert(value, name) if info else value
+ for info, name, value in zip(self.types, self.args, args)
+ ]
+ self.validate(args)
+ return list(zip(self.args, args))
+
+ def validate(self, args: Sequence[object]):
+ """Validate that embedded args match custom regexps.
+
+ Initial validation is done already when matching keywords, but this
+ validation makes sure arguments match also if they are given as variables.
+
+ Currently, argument not matching only causes a deprecation warning, but
+ that will be changed to ``ValueError`` in RF 8.0:
+ https://github.com/robotframework/robotframework/issues/4069
+ """
+ if not self.custom_patterns:
+ return
+ for name, value in zip(self.args, args):
+ if name in self.custom_patterns and isinstance(value, str):
+ pattern = self.custom_patterns[name]
+ if not re.fullmatch(pattern, value):
+ # TODO: Change to `raise ValueError(...)` in RF 8.0.
+ context = EXECUTION_CONTEXTS.current
+ context.warn(
+ f"Embedded argument '{name}' got value {value!r} "
+ f"that does not match custom pattern {pattern!r}. "
+ f"The argument is still accepted, but this behavior "
+ f"will change in Robot Framework 8.0."
+ )
class EmbeddedArgumentParser:
- _regexp_extension = re.compile(r'(? "EmbeddedArguments|None":
+ name_parts = []
args = []
- name_regexp = ['^']
- for before, variable, string in VariableIterator(string, identifiers='$'):
- name, pattern = self._get_name_and_pattern(variable[2:-1])
- args.append(name)
- name_regexp.extend([re.escape(before), '(%s)' % pattern])
- name_regexp.extend([re.escape(string), '$'])
- name = self._compile_regexp(name_regexp) if args else None
- return name, args
-
- def _get_name_and_pattern(self, name):
- if ':' not in name:
- return name, self._default_pattern
- name, pattern = name.split(':', 1)
- return name, self._format_custom_regexp(pattern)
-
- def _format_custom_regexp(self, pattern):
- for formatter in (self._regexp_extensions_are_not_allowed,
- self._make_groups_non_capturing,
- self._unescape_curly_braces,
- self._add_automatic_variable_pattern):
+ custom_patterns = {}
+ after = string = " ".join(string.split())
+ types = []
+ for match in VariableMatches(string, identifiers="$"):
+ arg, typ, pattern = self._parse_arg(match.base)
+ args.append(arg)
+ types.append(None if typ is None else self._get_type_info(arg, typ))
+ if pattern is None:
+ pattern = self._default_pattern
+ else:
+ custom_patterns[arg] = pattern
+ pattern = self._format_custom_regexp(pattern)
+ name_parts.extend([re.escape(match.before), "(", pattern, ")"])
+ after = match.after
+ if not args:
+ return None
+ name_parts.append(re.escape(after))
+ name = self._compile_regexp("".join(name_parts))
+ return EmbeddedArguments(name, args, custom_patterns, types)
+
+ def _parse_arg(self, arg: str) -> "tuple[str, str|None, str|None]":
+ if ":" not in arg:
+ return arg, None, None
+ match = re.fullmatch("([^:]+): ([^:]+)(:(.*))?", arg)
+ if match:
+ arg, typ, _, pattern = match.groups()
+ return arg, typ, pattern
+ arg, pattern = arg.split(":", 1)
+ return arg, None, pattern
+
+ def _format_custom_regexp(self, pattern: str) -> str:
+ for formatter in (
+ self._remove_inline_flags,
+ self._make_groups_non_capturing,
+ self._unescape_curly_braces,
+ self._escape_escapes,
+ self._add_variable_placeholder_pattern,
+ ):
pattern = formatter(pattern)
return pattern
- def _regexp_extensions_are_not_allowed(self, pattern):
- if not self._regexp_extension.search(pattern):
- return pattern
- raise DataError('Regexp extensions are not allowed in embedded '
- 'arguments.')
+ def _remove_inline_flags(self, pattern: str) -> str:
+ # Inline flags are included in custom regexp stored separately, but they
+ # must be removed from the full pattern.
+ match = self._inline_flag.match(pattern)
+ return pattern if match is None else pattern[match.end() :]
- def _make_groups_non_capturing(self, pattern):
+ def _make_groups_non_capturing(self, pattern: str) -> str:
return self._regexp_group_start.sub(self._regexp_group_escape, pattern)
- def _unescape_curly_braces(self, pattern):
- def unescaper(match):
+ def _unescape_curly_braces(self, pattern: str) -> str:
+ # Users must escape possible lone curly braces in patters (e.g. `${x:\{}`)
+ # or otherwise the variable syntax is invalid.
+ def unescape(match):
backslashes = len(match.group(1))
- return '\\' * (backslashes // 2 * 2) + match.group(2)
- return self._escaped_curly.sub(unescaper, pattern)
+ return "\\" * (backslashes // 2 * 2) + match.group(2)
+
+ return self._escaped_curly.sub(unescape, pattern)
- def _add_automatic_variable_pattern(self, pattern):
- return '%s|%s' % (pattern, self._variable_pattern)
+ def _escape_escapes(self, pattern: str) -> str:
+ # When keywords are matched, embedded arguments have not yet been
+ # resolved which means possible escapes are still doubled. We thus
+ # need to double them in the pattern as well.
+ return pattern.replace(r"\\", r"\\\\")
+
+ def _add_variable_placeholder_pattern(self, pattern: str) -> str:
+ return rf"{pattern}|={VARIABLE_PLACEHOLDER}-\d+="
+
+ def _get_type_info(self, name: str, typ: str) -> "TypeInfo|None":
+ var = f"${{{name}: {typ}}}"
+ try:
+ return TypeInfo.from_variable(var)
+ except DataError as err:
+ raise DataError(f"Invalid embedded argument '{var}': {err}")
- def _compile_regexp(self, pattern):
+ def _compile_regexp(self, pattern: str) -> re.Pattern:
try:
- return re.compile(''.join(pattern), re.IGNORECASE)
+ return re.compile(pattern.replace(r"\ ", r"\s"), re.IGNORECASE)
except Exception:
- raise DataError("Compiling embedded arguments regexp failed: %s"
- % get_error_message())
+ raise DataError(
+ f"Compiling embedded arguments regexp failed: {get_error_message()}"
+ )
diff --git a/src/robot/running/arguments/typeconverters.py b/src/robot/running/arguments/typeconverters.py
index 7e1e2d21f2f..3f4e98d829e 100644
--- a/src/robot/running/arguments/typeconverters.py
+++ b/src/robot/running/arguments/typeconverters.py
@@ -15,16 +15,24 @@
from ast import literal_eval
from collections import OrderedDict
-from collections.abc import ByteString, Container, Mapping, Sequence, Set
-from typing import Any, Union
-from datetime import datetime, date, timedelta
-from decimal import InvalidOperation, Decimal
+from collections.abc import Collection, Mapping, Sequence, Set
+from datetime import date, datetime, timedelta
+from decimal import Decimal, InvalidOperation
from enum import Enum
from numbers import Integral, Real
+from os import PathLike
+from pathlib import Path, PurePath
+from typing import Any, Literal, TYPE_CHECKING, Union
+from robot.conf import Languages
from robot.libraries.DateTime import convert_date, convert_time
-from robot.utils import (FALSE_STRINGS, TRUE_STRINGS, eq, get_error_message,
- is_string, is_union, safe_str, seq2str, type_name)
+from robot.utils import (
+ eq, get_error_message, plural_or_not as s, safe_str, Secret, seq2str, type_name
+)
+
+if TYPE_CHECKING:
+ from .customconverters import ConverterInfo, CustomArgumentConverters
+ from .typeinfo import TypedDictInfo, TypeInfo
NoneType = type(None)
@@ -32,116 +40,163 @@
class TypeConverter:
type = None
- type_name = None
+ type_name = None # Used also by Libdoc. Can be overridden by instances.
abc = None
- aliases = ()
value_types = (str,)
doc = None
+ nested: "list[TypeConverter]|dict[str, TypeConverter]|None"
_converters = OrderedDict()
- _type_aliases = {}
- def __init__(self, used_type, custom_converters=None):
- self.used_type = used_type
+ def __init__(
+ self,
+ type_info: "TypeInfo",
+ custom_converters: "CustomArgumentConverters|None" = None,
+ languages: "Languages|None" = None,
+ ):
+ self.type_info = type_info
self.custom_converters = custom_converters
+ self.languages = languages
+ self.nested = self._get_nested(type_info, custom_converters, languages)
+ self.type_name = self._get_type_name()
+
+ def _get_nested(
+ self,
+ type_info: "TypeInfo",
+ custom_converters: "CustomArgumentConverters|None",
+ languages: "Languages|None",
+ ) -> "list[TypeConverter]|None":
+ if not type_info.nested:
+ return None
+ return [
+ self.converter_for(info, custom_converters, languages)
+ for info in type_info.nested
+ ]
+
+ def _get_type_name(self) -> str:
+ if self.type_name and not self.nested:
+ return self.type_name
+ return str(self.type_info)
+
+ @property
+ def languages(self) -> Languages:
+ # Initialize only when needed to save time especially with Libdoc.
+ if self._languages is None:
+ self._languages = Languages()
+ return self._languages
+
+ @languages.setter
+ def languages(self, languages: "Languages|None"):
+ self._languages = languages
@classmethod
- def register(cls, converter):
+ def register(cls, converter: "type[TypeConverter]") -> "type[TypeConverter]":
cls._converters[converter.type] = converter
- for name in (converter.type_name,) + converter.aliases:
- if name is not None and not isinstance(name, property):
- cls._type_aliases[name.lower()] = converter.type
return converter
@classmethod
- def converter_for(cls, type_, custom_converters=None):
- try:
- hash(type_)
- except TypeError:
- return None
- if getattr(type_, '__origin__', None) and type_.__origin__ is not Union:
- type_ = type_.__origin__
- if isinstance(type_, str):
- try:
- type_ = cls._type_aliases[type_.lower()]
- except KeyError:
- return None
+ def converter_for(
+ cls,
+ type_info: "TypeInfo",
+ custom_converters: "CustomArgumentConverters|None" = None,
+ languages: "Languages|None" = None,
+ ) -> "TypeConverter":
+ if type_info.type is None:
+ return UnknownConverter(type_info)
if custom_converters:
- info = custom_converters.get_converter_info(type_)
+ info = custom_converters.get_converter_info(type_info.type)
if info:
- return CustomConverter(type_, info)
- if type_ in cls._converters:
- return cls._converters[type_](type_)
+ return CustomConverter(type_info, info, languages)
+ if type_info.type in cls._converters:
+ conv_class = cls._converters[type_info.type]
+ return conv_class(type_info, custom_converters, languages)
for converter in cls._converters.values():
- if converter.handles(type_):
- return converter(type_, custom_converters)
- return None
+ if converter.handles(type_info):
+ return converter(type_info, custom_converters, languages)
+ return UnknownConverter(type_info)
@classmethod
- def handles(cls, type_):
+ def handles(cls, type_info: "TypeInfo") -> bool:
handled = (cls.type, cls.abc) if cls.abc else cls.type
- return isinstance(type_, type) and issubclass(type_, handled)
-
- def convert(self, name, value, explicit_type=True, strict=True):
+ return isinstance(type_info.type, type) and issubclass(type_info.type, handled)
+
+ def convert(
+ self,
+ value: Any,
+ name: "str|None" = None,
+ kind: str = "Argument",
+ ) -> Any:
if self.no_conversion_needed(value):
return value
if not self._handles_value(value):
- return self._handle_error(name, value, strict=strict)
+ return self._handle_error(value, name, kind)
try:
if not isinstance(value, str):
- return self._non_string_convert(value, explicit_type)
- return self._convert(value, explicit_type)
+ return self._non_string_convert(value)
+ return self._string_convert(value)
except ValueError as error:
- return self._handle_error(name, value, error, strict)
+ return self._handle_error(value, name, kind, error)
- def no_conversion_needed(self, value):
+ def no_conversion_needed(self, value: Any) -> bool:
try:
- return isinstance(value, self.used_type)
+ return isinstance(value, self.type_info.type)
except TypeError:
- # If the used type doesn't like `isinstance` (e.g. TypedDict),
- # compare the value to the generic type instead.
- if self.type and self.type is not self.used_type:
+ # Used type wasn't a class. Compare to generic type instead.
+ if self.type and self.type is not self.type_info.type:
return isinstance(value, self.type)
- raise
+ return False
+
+ def validate(self):
+ """Validate converter. Raise ``TypeError`` for unrecognized types."""
+ if self.nested:
+ self._validate(self.nested)
+
+ def _validate(self, nested):
+ for converter in nested:
+ converter.validate()
def _handles_value(self, value):
return isinstance(value, self.value_types)
- def _non_string_convert(self, value, explicit_type=True):
- return self._convert(value, explicit_type)
+ def _non_string_convert(self, value):
+ return self._convert(value)
- def _convert(self, value, explicit_type=True):
+ def _string_convert(self, value):
+ return self._convert(value)
+
+ def _convert(self, value):
raise NotImplementedError
- def _handle_error(self, name, value, error=None, strict=True):
- if not strict:
- return value
- value_type = '' if isinstance(value, str) else f' ({type_name(value)})'
- ending = f': {error}' if (error and error.args) else '.'
+ def _handle_error(self, value, name, kind, error=None):
+ typ = "" if isinstance(value, str) else f" ({type_name(value)})"
+ value = safe_str(value)
+ kind = kind.capitalize() if kind.islower() else kind
+ ending = f": {error}" if (error and error.args) else "."
+ cannot_be_converted = f"cannot be converted to {self.type_name}{ending}"
+ if name is None:
+ raise ValueError(f"{kind} '{value}'{typ} {cannot_be_converted}")
raise ValueError(
- f"Argument '{name}' got value '{safe_str(value)}'{value_type} that "
- f"cannot be converted to {self.type_name}{ending}"
+ f"{kind} '{name}' got value '{value}'{typ} that {cannot_be_converted}"
)
- def _literal_eval(self, value, expected):
- if expected is set and value == 'set()':
- # `ast.literal_eval` has no way to define an empty set.
- return set()
+ def _literal_eval(self, value, expected, name=None):
try:
value = literal_eval(value)
except (ValueError, SyntaxError):
# Original errors aren't too informative in these cases.
- raise ValueError('Invalid expression.')
+ raise ValueError("Invalid expression.")
except TypeError as err:
- raise ValueError(f'Evaluating expression failed: {err}')
+ raise ValueError(f"Evaluating expression failed: {err}")
if not isinstance(value, expected):
- raise ValueError(f'Value is {type_name(value)}, not {expected.__name__}.')
+ raise ValueError(
+ f"Value is {type_name(value)}, not {name or expected.__name__}."
+ )
return value
def _remove_number_separators(self, value):
- if is_string(value):
- for sep in ' ', '_':
+ if isinstance(value, str):
+ for sep in " ", "_":
if sep in value:
- value = value.replace(sep, '')
+ value = value.replace(sep, "")
return value
@@ -149,18 +204,15 @@ def _remove_number_separators(self, value):
class EnumConverter(TypeConverter):
type = Enum
- @property
- def type_name(self):
- return self.used_type.__name__
-
@property
def value_types(self):
- return (str, int) if issubclass(self.used_type, int) else (str,)
+ return (str, int) if issubclass(self.type_info.type, int) else (str,)
- def _convert(self, value, explicit_type=True):
- enum = self.used_type
- if isinstance(value, int):
- return self._find_by_int_value(enum, value)
+ def _non_string_convert(self, value):
+ return self._find_by_int_value(self.type_info.type, value)
+
+ def _string_convert(self, value):
+ enum = self.type_info.type
try:
return enum[value]
except KeyError:
@@ -168,19 +220,23 @@ def _convert(self, value, explicit_type=True):
def _find_by_normalized_name_or_int_value(self, enum, value):
members = sorted(enum.__members__)
- matches = [m for m in members if eq(m, value, ignore='_')]
+ matches = [m for m in members if eq(m, value, ignore="_-")]
if len(matches) == 1:
return getattr(enum, matches[0])
if len(matches) > 1:
- raise ValueError(f"{self.type_name} has multiple members matching "
- f"'{value}'. Available: {seq2str(matches)}")
+ raise ValueError(
+ f"{self.type_name} has multiple members matching '{value}'. "
+ f"Available: {seq2str(matches)}"
+ )
try:
- if issubclass(self.used_type, int):
+ if issubclass(self.type_info.type, int):
return self._find_by_int_value(enum, value)
except ValueError:
- members = [f'{m} ({getattr(enum, m)})' for m in members]
- raise ValueError(f"{self.type_name} does not have member '{value}'. "
- f"Available: {seq2str(members)}")
+ members = [f"{m} ({getattr(enum, m)})" for m in members]
+ raise ValueError(
+ f"{self.type_name} does not have member '{value}'. "
+ f"Available: {seq2str(members)}"
+ )
def _find_by_int_value(self, enum, value):
value = int(value)
@@ -188,23 +244,53 @@ def _find_by_int_value(self, enum, value):
if member.value == value:
return member
values = sorted(member.value for member in enum)
- raise ValueError(f"{self.type_name} does not have value '{value}'. "
- f"Available: {seq2str(values)}")
+ raise ValueError(
+ f"{self.type_name} does not have value '{value}'. "
+ f"Available: {seq2str(values)}"
+ )
+
+
+@TypeConverter.register
+class AnyConverter(TypeConverter):
+ type = Any
+ type_name = "Any"
+ value_types = (Any,)
+
+ @classmethod
+ def handles(cls, type_info: "TypeInfo"):
+ return type_info.type is cls.type
+
+ def no_conversion_needed(self, value):
+ return True
+
+ def _convert(self, value):
+ return value
+
+ def _handles_value(self, value):
+ return True
+
+
+@TypeConverter.register
+class ObjectConverter(AnyConverter):
+ type = object
+ type_name = "object"
+ value_types = (Any,)
@TypeConverter.register
class StringConverter(TypeConverter):
type = str
- type_name = 'string'
- aliases = ('string', 'str', 'unicode')
+ type_name = "string"
value_types = (Any,)
def _handles_value(self, value):
return True
- def _convert(self, value, explicit_type=True):
- if not explicit_type:
- return value
+ def _non_string_convert(self, value):
+ if isinstance(value, Secret):
+ raise ValueError
+ if isinstance(value, (bytes, bytearray)):
+ return value.decode("latin-1")
try:
return str(value)
except Exception:
@@ -214,20 +300,19 @@ def _convert(self, value, explicit_type=True):
@TypeConverter.register
class BooleanConverter(TypeConverter):
type = bool
- type_name = 'boolean'
- aliases = ('bool',)
+ type_name = "boolean"
value_types = (str, int, float, NoneType)
- def _non_string_convert(self, value, explicit_type=True):
+ def _non_string_convert(self, value):
return value
- def _convert(self, value, explicit_type=True):
- upper = value.upper()
- if upper == 'NONE':
+ def _string_convert(self, value):
+ normalized = value.title()
+ if normalized == "None":
return None
- if upper in TRUE_STRINGS:
+ if normalized in self.languages.true_strings:
return True
- if upper in FALSE_STRINGS:
+ if normalized in self.languages.false_strings:
return False
return value
@@ -236,35 +321,38 @@ def _convert(self, value, explicit_type=True):
class IntegerConverter(TypeConverter):
type = int
abc = Integral
- type_name = 'integer'
- aliases = ('int', 'long')
+ type_name = "integer"
value_types = (str, float)
- def _non_string_convert(self, value, explicit_type=True):
+ def _non_string_convert(self, value):
if value.is_integer():
return int(value)
- raise ValueError('Conversion would lose precision.')
+ raise ValueError("Conversion would lose precision.")
- def _convert(self, value, explicit_type=True):
+ def _string_convert(self, value):
value = self._remove_number_separators(value)
value, base = self._get_base(value)
try:
return int(value, base)
except ValueError:
- if base == 10 and not explicit_type:
+ if base == 10:
try:
- return float(value)
- except ValueError:
+ value, denominator = Decimal(value).as_integer_ratio()
+ except (InvalidOperation, ValueError, OverflowError):
pass
- raise ValueError
+ else:
+ if denominator != 1:
+ raise ValueError("Conversion would lose precision.")
+ return value
+ raise ValueError
def _get_base(self, value):
value = value.lower()
- for prefix, base in [('0x', 16), ('0o', 8), ('0b', 2)]:
+ for prefix, base in [("0x", 16), ("0o", 8), ("0b", 2)]:
if prefix in value:
parts = value.split(prefix)
- if len(parts) == 2 and parts[0] in ('', '-', '+'):
- return ''.join(parts), base
+ if len(parts) == 2 and parts[0] in ("", "-", "+"):
+ return "".join(parts), base
return value, 10
@@ -272,11 +360,10 @@ def _get_base(self, value):
class FloatConverter(TypeConverter):
type = float
abc = Real
- type_name = 'float'
- aliases = ('double',)
+ type_name = "float"
value_types = (str, Real)
- def _convert(self, value, explicit_type=True):
+ def _convert(self, value):
try:
return float(self._remove_number_separators(value))
except ValueError:
@@ -286,10 +373,10 @@ def _convert(self, value, explicit_type=True):
@TypeConverter.register
class DecimalConverter(TypeConverter):
type = Decimal
- type_name = 'decimal'
+ type_name = "decimal"
value_types = (str, int, float)
- def _convert(self, value, explicit_type=True):
+ def _convert(self, value):
try:
return Decimal(self._remove_number_separators(value))
except InvalidOperation:
@@ -302,55 +389,69 @@ def _convert(self, value, explicit_type=True):
@TypeConverter.register
class BytesConverter(TypeConverter):
type = bytes
- abc = ByteString
- type_name = 'bytes'
- value_types = (str, bytearray)
+ type_name = "bytes"
+ value_types = (str, bytearray, Sequence, int)
- def _non_string_convert(self, value, explicit_type=True):
- return bytes(value)
+ def _non_string_convert(self, value: "bytearray | Sequence | int") -> bytes:
+ if isinstance(value, bytearray):
+ return bytes(value)
+ if isinstance(value, int):
+ value = [value]
+ return bytes([self._validate_int(v) for v in value])
+
+ def _validate_int(self, value: object) -> int:
+ try:
+ value = int(value) # type: ignore
+ except Exception:
+ raise ValueError(f"{value!r} is not an integer.")
+ if value < 0 or value > 255:
+ raise ValueError(f"{value} is not in range 0-255.")
+ return value
- def _convert(self, value, explicit_type=True):
+ def _string_convert(self, value: str) -> bytes:
try:
- return value.encode('latin-1')
+ return value.encode("latin-1")
except UnicodeEncodeError as err:
- invalid = value[err.start:err.start+1]
+ invalid = value[err.start : err.start + 1]
raise ValueError(f"Character '{invalid}' cannot be mapped to a byte.")
@TypeConverter.register
-class ByteArrayConverter(TypeConverter):
+class ByteArrayConverter(BytesConverter):
type = bytearray
- type_name = 'bytearray'
- value_types = (str, bytes)
+ type_name = "bytearray"
+ value_types = (str, bytes, Sequence, int)
- def _non_string_convert(self, value, explicit_type=True):
+ def _non_string_convert(self, value: "bytes | Sequence | int") -> bytearray:
+ if not isinstance(value, bytes):
+ value = super()._non_string_convert(value)
return bytearray(value)
- def _convert(self, value, explicit_type=True):
- try:
- return bytearray(value, 'latin-1')
- except UnicodeEncodeError as err:
- invalid = value[err.start:err.start+1]
- raise ValueError(f"Character '{invalid}' cannot be mapped to a byte.")
+ def _string_convert(self, value: str) -> bytearray:
+ return bytearray(super()._string_convert(value))
@TypeConverter.register
class DateTimeConverter(TypeConverter):
type = datetime
- type_name = 'datetime'
+ type_name = "datetime"
value_types = (str, int, float)
- def _convert(self, value, explicit_type=True):
- return convert_date(value, result_format='datetime')
+ def _convert(self, value):
+ if isinstance(value, str) and value.lower() in ("now", "today"):
+ return datetime.now()
+ return convert_date(value, result_format="datetime")
@TypeConverter.register
class DateConverter(TypeConverter):
type = date
- type_name = 'date'
+ type_name = "date"
- def _convert(self, value, explicit_type=True):
- dt = convert_date(value, result_format='datetime')
+ def _convert(self, value):
+ if isinstance(value, str) and value.lower() in ("now", "today"):
+ return date.today()
+ dt = convert_date(value, result_format="datetime")
if dt.hour or dt.minute or dt.second or dt.microsecond:
raise ValueError("Value is datetime, not date.")
return dt.date()
@@ -359,159 +460,450 @@ def _convert(self, value, explicit_type=True):
@TypeConverter.register
class TimeDeltaConverter(TypeConverter):
type = timedelta
- type_name = 'timedelta'
+ type_name = "timedelta"
value_types = (str, int, float)
- def _convert(self, value, explicit_type=True):
- return convert_time(value, result_format='timedelta')
+ def _convert(self, value):
+ return convert_time(value, result_format="timedelta")
+
+
+@TypeConverter.register
+class PathConverter(TypeConverter):
+ type = Path
+ abc = PathLike
+ type_name = "Path"
+ value_types = (str, PurePath)
+
+ def _convert(self, value):
+ return Path(value)
@TypeConverter.register
class NoneConverter(TypeConverter):
type = NoneType
- type_name = 'None'
+ type_name = "None"
@classmethod
- def handles(cls, type_):
- return type_ in (NoneType, None)
+ def handles(cls, type_info: "TypeInfo") -> bool:
+ return type_info.type in (NoneType, None)
- def _convert(self, value, explicit_type=True):
- if value.upper() == 'NONE':
+ def _string_convert(self, value):
+ if value.upper() in ("NONE", ""):
return None
raise ValueError
@TypeConverter.register
-class ListConverter(TypeConverter):
- type = list
- type_name = 'list'
- abc = Sequence
+class SequenceConverter(TypeConverter):
+ type = Sequence
+ type_name = "Sequence"
value_types = (str, Sequence)
def no_conversion_needed(self, value):
- if isinstance(value, str):
+ if (
+ isinstance(value, str)
+ or not super().no_conversion_needed(value)
+ or self._must_make_mutable(value)
+ ):
return False
- return super().no_conversion_needed(value)
+ if not self.nested:
+ return True
+ no_conversion_needed = self.nested[0].no_conversion_needed
+ return all(no_conversion_needed(v) for v in value)
+
+ def _must_make_mutable(self, value):
+ return not isinstance(value, self.type_info.type)
+
+ def _string_convert(self, value):
+ return self._convert(self._literal_eval(value, Sequence))
+
+ def _convert(self, value):
+ if self._must_make_mutable(value):
+ value = list(value)
+ if self.nested:
+ value = self._convert_nested(value)
+ return value
+
+ def _convert_nested(self, value):
+ result_type = type(value)
+ convert = self.nested[0].convert
+ value = [convert(v, name=str(i), kind="Item") for i, v in enumerate(value)]
+ try:
+ return result_type(value)
+ except Exception:
+ raise ValueError("Cannot recreate object after converting items.")
+
+
+@TypeConverter.register
+class ListConverter(SequenceConverter):
+ type = list
+ type_name = "list"
+
+ def _must_make_immutable(self):
+ return False
- def _non_string_convert(self, value, explicit_type=True):
- return list(value)
+ def _string_convert(self, value):
+ value = self._literal_eval(value, Sequence, name="list")
+ return self._convert(list(value))
- def _convert(self, value, explicit_type=True):
- return self._literal_eval(value, list)
+ def _non_string_convert(self, value):
+ return self._convert(list(value))
@TypeConverter.register
class TupleConverter(TypeConverter):
type = tuple
- type_name = 'tuple'
+ type_name = "tuple"
value_types = (str, Sequence)
- def _non_string_convert(self, value, explicit_type=True):
- return tuple(value)
+ @property
+ def homogenous(self) -> bool:
+ nested = self.type_info.nested
+ return nested and nested[-1].type is Ellipsis
+
+ def no_conversion_needed(self, value):
+ if isinstance(value, str) or not super().no_conversion_needed(value):
+ return False
+ if not self.nested:
+ return True
+ if self.homogenous:
+ converter = self.nested[0]
+ return all(converter.no_conversion_needed(v) for v in value)
+ if len(value) != len(self.nested):
+ return False
+ return all(c.no_conversion_needed(v) for c, v in zip(self.nested, value))
+
+ def _string_convert(self, value):
+ value = self._literal_eval(value, Sequence, name="tuple")
+ return self._convert_nested(tuple(value))
+
+ def _non_string_convert(self, value):
+ return self._convert_nested(tuple(value))
- def _convert(self, value, explicit_type=True):
- return self._literal_eval(value, tuple)
+ def _convert_nested(self, value):
+ if not self.nested:
+ return value
+ if self.homogenous:
+ convert = self.nested[0].convert
+ return tuple(
+ convert(v, name=str(i), kind="Item") for i, v in enumerate(value)
+ )
+ if len(value) != len(self.nested):
+ raise ValueError(
+ f"Expected {len(self.nested)} item{s(self.nested)}, got {len(value)}."
+ )
+ return tuple(
+ c.convert(v, name=str(i), kind="Item")
+ for i, (c, v) in enumerate(zip(self.nested, value))
+ )
+
+ def _validate(self, nested: "list[TypeConverter]"):
+ if self.homogenous:
+ nested = nested[:-1]
+ super()._validate(nested)
@TypeConverter.register
-class DictionaryConverter(TypeConverter):
- type = dict
- abc = Mapping
- type_name = 'dictionary'
- aliases = ('dict', 'map')
+class TypedDictConverter(TypeConverter):
+ type = "TypedDict"
+ value_types = (str, Mapping)
+ type_info: "TypedDictInfo"
+ nested: "dict[str, TypeConverter]"
+
+ def _get_nested(
+ self,
+ type_info: "TypedDictInfo",
+ custom_converters: "CustomArgumentConverters|None",
+ languages: "Languages|None",
+ ) -> "dict[str, TypeConverter]":
+ return {
+ name: self.converter_for(info, custom_converters, languages)
+ for name, info in type_info.annotations.items()
+ }
+
+ @classmethod
+ def handles(cls, type_info: "TypeInfo") -> bool:
+ return type_info.is_typed_dict
+
+ def no_conversion_needed(self, value):
+ if not isinstance(value, Mapping):
+ return False
+ for key in value:
+ try:
+ converter = self.nested[key]
+ except KeyError:
+ return False
+ else:
+ if not converter.no_conversion_needed(value[key]):
+ return False
+ return set(value).issuperset(self.type_info.required)
+
+ def _non_string_convert(self, value):
+ return self._convert_items(value)
+
+ def _string_convert(self, value):
+ return self._convert_items(self._literal_eval(value, dict))
+
+ def _convert_items(self, value):
+ not_allowed = []
+ for key in value:
+ try:
+ converter = self.nested[key]
+ except KeyError:
+ not_allowed.append(key)
+ else:
+ if converter:
+ value[key] = converter.convert(value[key], name=key, kind="Item")
+ if not_allowed:
+ error = f"Item{s(not_allowed)} {seq2str(sorted(not_allowed))} not allowed."
+ available = [key for key in self.nested if key not in value]
+ if available:
+ error += f" Available item{s(available)}: {seq2str(sorted(available))}"
+ raise ValueError(error)
+ missing = [key for key in self.type_info.required if key not in value]
+ if missing:
+ raise ValueError(
+ f"Required item{s(missing)} {seq2str(sorted(missing))} missing."
+ )
+ return value
+
+ def _validate(self, nested: "dict[str, TypeConverter]"):
+ super()._validate(nested.values())
+
+
+@TypeConverter.register
+class MappingConverter(TypeConverter):
+ type = Mapping
+ type_name = "Mapping"
value_types = (str, Mapping)
- def _non_string_convert(self, value, explicit_type=True):
- if issubclass(self.used_type, dict) and not isinstance(value, dict):
- return dict(value)
+ def no_conversion_needed(self, value):
+ if (
+ isinstance(value, str)
+ or not super().no_conversion_needed(value)
+ or self._must_make_mutable(value)
+ ):
+ return False
+ if not self.nested:
+ return True
+ no_key_conversion = self.nested[0].no_conversion_needed
+ no_value_conversion = self.nested[1].no_conversion_needed
+ return all(
+ no_key_conversion(k) and no_value_conversion(value[k]) for k in value
+ )
+
+ def _must_make_mutable(self, value):
+ return not isinstance(value, self.type_info.type)
+
+ def _string_convert(self, value):
+ return self._convert(self._literal_eval(value, Mapping))
+
+ def _convert(self, value):
+ if self._must_make_mutable(value):
+ value = dict(value)
+ if self.nested:
+ value = self._convert_nested(value)
return value
- def _convert(self, value, explicit_type=True):
- return self._literal_eval(value, dict)
+ def _convert_nested(self, value):
+ result_type = type(value)
+ convert_key = self._get_converter(self.nested[0], "Key")
+ convert_value = self._get_converter(self.nested[1], "Item")
+ value = {convert_key(None, k): convert_value(k, value[k]) for k in value}
+ try:
+ return result_type(value)
+ except Exception:
+ raise ValueError("Cannot recreate object after converting items.")
+
+ def _get_converter(self, converter, kind):
+ return lambda name, value: converter.convert(value, name, kind=kind)
+
+
+@TypeConverter.register
+class DictionaryConverter(MappingConverter):
+ type = dict
+ type_name = "dictionary"
+
+ def _must_make_immutable(self):
+ return False
+
+ def _string_convert(self, value):
+ return self._convert(self._literal_eval(value, dict))
+
+ def _non_string_convert(self, value):
+ return self._convert(dict(value))
@TypeConverter.register
class SetConverter(TypeConverter):
type = set
abc = Set
- type_name = 'set'
- value_types = (str, Container)
+ type_name = "set"
+ value_types = (str, Collection)
+
+ def no_conversion_needed(self, value):
+ if isinstance(value, str) or not super().no_conversion_needed(value):
+ return False
+ if not self.nested:
+ return True
+ no_conversion_needed = self.nested[0].no_conversion_needed
+ return all(no_conversion_needed(v) for v in value)
- def _non_string_convert(self, value, explicit_type=True):
- return set(value)
+ def _string_convert(self, value):
+ if value == "set()": # literal_eval doesn't support "set()" with Python 3.8.
+ return set()
+ value = self._literal_eval(value, (set, Sequence), name="set")
+ return self._convert_nested(set(value))
+
+ def _non_string_convert(self, value):
+ return self._convert_nested(set(value))
- def _convert(self, value, explicit_type=True):
- return self._literal_eval(value, set)
+ def _convert_nested(self, value):
+ if self.nested:
+ convert = self.nested[0].convert
+ value = {convert(v, kind="Item") for v in value}
+ return value
@TypeConverter.register
-class FrozenSetConverter(TypeConverter):
+class FrozenSetConverter(SetConverter):
type = frozenset
- type_name = 'frozenset'
- value_types = (str, Container)
+ type_name = "frozenset"
- def _non_string_convert(self, value, explicit_type=True):
- return frozenset(value)
-
- def _convert(self, value, explicit_type=True):
- # There are issues w/ literal_eval. See self._literal_eval for details.
- if value == 'frozenset()':
+ def _string_convert(self, value):
+ if value == "frozenset()": # literal_eval doesn't support "frozenset()".
return frozenset()
- return frozenset(self._literal_eval(value, set))
+ return frozenset(super()._string_convert(value))
+
+ def _non_string_convert(self, value):
+ return frozenset(super()._non_string_convert(value))
@TypeConverter.register
-class CombinedConverter(TypeConverter):
+class UnionConverter(TypeConverter):
type = Union
- def __init__(self, union, custom_converters):
- super().__init__(self._get_types(union))
- self.converters = [TypeConverter.converter_for(t, custom_converters)
- for t in self.used_type]
-
- def _get_types(self, union):
- if not union:
- return ()
- if isinstance(union, tuple):
- return union
- return union.__args__
-
- @property
- def type_name(self):
- return ' or '.join(type_name(t) for t in self.used_type)
+ def _get_type_name(self) -> str:
+ names = [converter.type_name for converter in self.nested]
+ return seq2str(names, quote="", lastsep=" or ")
@classmethod
- def handles(cls, type_):
- return is_union(type_, allow_tuple=True)
+ def handles(cls, type_info: "TypeInfo") -> bool:
+ return type_info.is_union
def _handles_value(self, value):
return True
def no_conversion_needed(self, value):
- for converter in self.converters:
- if converter and converter.no_conversion_needed(value):
+ for converter in self.nested:
+ if (
+ converter.no_conversion_needed(value)
+ and not isinstance(converter, ObjectConverter)
+ ): # fmt:skip
+ return True
+ return False
+
+ def _convert(self, value):
+ unknown_types = False
+ for converter in self.nested:
+ if converter:
+ try:
+ return converter.convert(value)
+ except ValueError:
+ pass
+ else:
+ unknown_types = True
+ if unknown_types:
+ return value
+ raise ValueError
+
+
+@TypeConverter.register
+class LiteralConverter(TypeConverter):
+ type = Literal
+ type_name = "Literal"
+ value_types = (Any,)
+
+ def _get_type_name(self) -> str:
+ names = [info.name for info in self.type_info.nested]
+ return seq2str(names, quote="", lastsep=" or ")
+
+ @classmethod
+ def converter_for(
+ cls,
+ type_info: "TypeInfo",
+ custom_converters: "CustomArgumentConverters|None" = None,
+ languages: "Languages|None" = None,
+ ) -> TypeConverter:
+ info = type(type_info)(type_info.name, type(type_info.type))
+ return super().converter_for(info, custom_converters, languages)
+
+ @classmethod
+ def handles(cls, type_info: "TypeInfo") -> bool:
+ return type_info.type is Literal
+
+ def no_conversion_needed(self, value: Any) -> bool:
+ for info in self.type_info.nested:
+ expected = info.type
+ if value == expected and type(value) is type(expected):
return True
return False
- def _convert(self, value, explicit_type=True):
- for converter in self.converters:
- if not converter:
- return value
+ def _handles_value(self, value):
+ return True
+
+ def _convert(self, value):
+ matches = []
+ for info, converter in zip(self.type_info.nested, self.nested):
+ expected = info.type
+ if value == expected and type(value) is type(expected):
+ return expected
try:
- return converter.convert('', value, explicit_type)
+ converted = converter.convert(value)
except ValueError:
pass
+ else:
+ if (
+ isinstance(expected, str)
+ and eq(converted, expected, ignore="_-")
+ or converted == expected
+ ):
+ matches.append(expected)
+ if len(matches) == 1:
+ return matches[0]
+ if matches:
+ raise ValueError("No unique match found.")
+ raise ValueError
+
+
+@TypeConverter.register
+class SecretConverter(TypeConverter):
+ type = Secret
+ type_name = "Secret"
+
+ def _convert(self, value):
raise ValueError
+ def _handle_error(self, value, name, kind, error=None):
+ kind = kind.capitalize() if kind.islower() else kind
+ typ = type_name(value)
+ if name is None:
+ raise ValueError(f"{kind} must have type 'Secret', got {typ}.")
+ raise ValueError(f"{kind} '{name}' must have type 'Secret', got {typ}.")
+
class CustomConverter(TypeConverter):
- def __init__(self, used_type, converter_info):
- super().__init__(used_type)
+ def __init__(
+ self,
+ type_info: "TypeInfo",
+ converter_info: "ConverterInfo",
+ languages: "Languages|None" = None,
+ ):
self.converter_info = converter_info
+ super().__init__(type_info, languages=languages)
- @property
- def type_name(self):
+ def _get_type_name(self) -> str:
return self.converter_info.name
@property
@@ -525,10 +917,22 @@ def value_types(self):
def _handles_value(self, value):
return not self.value_types or isinstance(value, self.value_types)
- def _convert(self, value, explicit_type=True):
+ def _convert(self, value):
try:
- return self.converter_info.converter(value)
+ return self.converter_info.convert(value)
except ValueError:
raise
except Exception:
raise ValueError(get_error_message())
+
+
+class UnknownConverter(TypeConverter):
+
+ def convert(self, value, name=None, kind="Argument"):
+ return value
+
+ def validate(self):
+ raise TypeError(f"Unrecognized type '{self.type_name}'.")
+
+ def __bool__(self):
+ return False
diff --git a/src/robot/running/arguments/typeinfo.py b/src/robot/running/arguments/typeinfo.py
new file mode 100644
index 00000000000..339aecbeb07
--- /dev/null
+++ b/src/robot/running/arguments/typeinfo.py
@@ -0,0 +1,479 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+from collections.abc import Mapping, Sequence, Set
+from datetime import date, datetime, timedelta
+from decimal import Decimal
+from enum import Enum
+from pathlib import Path
+from typing import Any, ForwardRef, get_args, get_origin, get_type_hints, Literal, Union
+
+# Standard get_args and get_origin handle at least Annotated wrong in Python 3.8.
+if sys.version_info < (3, 9):
+ try:
+ from typing_extensions import get_args, get_origin
+ except ImportError:
+ pass
+# typing_extensions.Literal is typing.Literal with Python 3.10.1 and newer.
+if sys.version_info < (3, 10, 1):
+ try:
+ from typing_extensions import Literal as ExtLiteral
+ except ImportError:
+ ExtLiteral = Literal
+else:
+ ExtLiteral = Literal
+# NotRequired and Required are new in Python 3.11.
+if sys.version_info >= (3, 11):
+ from typing import NotRequired, Required
+else:
+ try:
+ from typing_extensions import NotRequired, Required
+ except ImportError:
+ NotRequired = Required = object()
+
+from robot.conf import Languages, LanguagesLike
+from robot.errors import DataError
+from robot.utils import (
+ is_union, NOT_SET, plural_or_not as s, Secret, setter, SetterAwareType, type_name,
+ type_repr, typeddict_types
+)
+from robot.variables import search_variable, VariableMatch
+
+from ..context import EXECUTION_CONTEXTS
+from .customconverters import CustomArgumentConverters
+from .typeconverters import TypeConverter
+
+TYPE_NAMES = {
+ "...": Ellipsis,
+ "ellipsis": Ellipsis,
+ "any": Any,
+ "object": object,
+ "str": str,
+ "string": str,
+ "unicode": str,
+ "bool": bool,
+ "boolean": bool,
+ "int": int,
+ "integer": int,
+ "long": int,
+ "float": float,
+ "double": float,
+ "decimal": Decimal,
+ "bytes": bytes,
+ "bytearray": bytearray,
+ "datetime": datetime,
+ "date": date,
+ "timedelta": timedelta,
+ "path": Path,
+ "none": type(None),
+ "sequence": Sequence,
+ "list": list,
+ "tuple": tuple,
+ "set": set,
+ "frozenset": frozenset,
+ "mapping": Mapping,
+ "map": Mapping,
+ "dictionary": dict,
+ "dict": dict,
+ "union": Union,
+ "literal": Literal,
+ "secret": Secret,
+}
+LITERAL_TYPES = (int, str, bytes, bool, Enum, type(None))
+
+
+class TypeInfo(metaclass=SetterAwareType):
+ """Represents an argument type.
+
+ Normally created using the :meth:`from_type_hint` classmethod.
+ With unions and parametrized types, :attr:`nested` contains nested types.
+
+ Values can be converted according to this type info by using the
+ :meth:`convert` method.
+
+ Part of the public API starting from Robot Framework 7.0. In such usage
+ should be imported via the :mod:`robot.api` package.
+ """
+
+ is_typed_dict = False
+ __slots__ = ("name", "type")
+
+ def __init__(
+ self,
+ name: "str|None" = None,
+ type: Any = NOT_SET,
+ nested: "Sequence[TypeInfo]|None" = None,
+ ):
+ if type is NOT_SET:
+ type = TYPE_NAMES.get(name.lower()) if name else None
+ self.name = name
+ self.type = type
+ self.nested = nested
+
+ @setter
+ def nested(self, nested: "Sequence[TypeInfo]") -> "tuple[TypeInfo, ...]|None":
+ """Nested types as a tuple of ``TypeInfo`` objects.
+
+ Used with parameterized types and unions.
+ """
+ typ = self.type
+ if self.is_union:
+ return self._validate_union(nested)
+ if nested is None:
+ return None
+ if typ is None:
+ return tuple(nested)
+ if typ is Literal:
+ return self._validate_literal(nested)
+ if isinstance(typ, type):
+ if issubclass(typ, tuple):
+ if nested[-1].type is Ellipsis:
+ return self._validate_nested_count(
+ nested, 2, "Homogenous tuple", offset=-1
+ )
+ return tuple(nested)
+ if (
+ issubclass(typ, Sequence)
+ and not issubclass(typ, (str, bytes, bytearray, memoryview))
+ ): # fmt: skip
+ return self._validate_nested_count(nested, 1)
+ if issubclass(typ, Set):
+ return self._validate_nested_count(nested, 1)
+ if issubclass(typ, Mapping):
+ return self._validate_nested_count(nested, 2)
+ if typ in TYPE_NAMES.values():
+ self._report_nested_error(nested)
+ return tuple(nested)
+
+ def _validate_union(self, nested):
+ if not nested:
+ raise DataError("Union cannot be empty.")
+ return tuple(nested)
+
+ def _validate_literal(self, nested):
+ if not nested:
+ raise DataError("Literal cannot be empty.")
+ for info in nested:
+ if not isinstance(info.type, LITERAL_TYPES):
+ raise DataError(
+ f"Literal supports only integers, strings, bytes, Booleans, enums "
+ f"and None, value {info.name} is {type_name(info.type)}."
+ )
+ return tuple(nested)
+
+ def _validate_nested_count(self, nested, expected, kind=None, offset=0):
+ if len(nested) != expected:
+ self._report_nested_error(nested, expected, kind, offset)
+ return tuple(nested)
+
+ def _report_nested_error(self, nested, expected=0, kind=None, offset=0):
+ expected += offset
+ actual = len(nested) + offset
+ args = ", ".join(str(n) for n in nested)
+ kind = kind or f"'{self.name}{'[]' if expected > 0 else ''}'"
+ if expected == 0:
+ raise DataError(
+ f"{kind} does not accept parameters, "
+ f"'{self.name}[{args}]' has {actual}."
+ )
+ raise DataError(
+ f"{kind} requires exactly {expected} parameter{s(expected)}, "
+ f"'{self.name}[{args}]' has {actual}."
+ )
+
+ @property
+ def is_union(self):
+ return self.name == "Union"
+
+ @classmethod
+ def from_type_hint(cls, hint: Any, sequence_is_union: bool = False) -> "TypeInfo":
+ """Construct a ``TypeInfo`` based on a type hint.
+
+ The type hint can be in various different formats:
+
+ - an actual type such as ``int``
+ - a parameterized type such as ``list[int]``
+ - a union such as ``int | float``
+ - a string such as ``'int'``, ``'list[int]'`` or ``'int | float'``
+ - a ``TypedDict`` (represented as a :class:`TypedDictInfo`)
+ - if ``sequence_is_union`` is ``True``, a sequence of type hints like
+ ``[int, float]`` or ``('int', 'list[int]')`` creates a union
+
+ In special cases using a more specialized method like :meth:`from_type`
+ may be more appropriate than using this generic method.
+
+ Prior to Robot Framework 7.4, sequences always created a union. If you
+ need to handle sequences as unions, it is recommended to call
+ :meth:`from_sequence` explicitly.
+ """
+ if hint is NOT_SET:
+ return cls()
+ if isinstance(hint, cls):
+ return hint
+ if isinstance(hint, ForwardRef):
+ hint = hint.__forward_arg__
+ if isinstance(hint, typeddict_types):
+ return TypedDictInfo(hint.__name__, hint)
+ if is_union(hint):
+ nested = [cls.from_type_hint(a) for a in get_args(hint)]
+ return cls("Union", nested=nested)
+ origin = get_origin(hint)
+ if origin:
+ args = get_args(hint)
+ if origin is Literal or origin is ExtLiteral:
+ origin = Literal
+ nested = [
+ cls(a.name if isinstance(a, Enum) else repr(a), a) for a in args
+ ]
+ elif args:
+ nested = [cls.from_type_hint(a) for a in args]
+ else:
+ nested = None
+ return cls(type_repr(hint, nested=False), origin, nested)
+ if isinstance(hint, str):
+ return cls.from_string(hint)
+ if hint is Any:
+ return cls("Any", hint)
+ if hint is None:
+ return cls("None", type(None))
+ if hint is Ellipsis:
+ return cls("...", hint)
+ if hint is Union: # Plain Union without params.
+ return cls("Union")
+ if isinstance(hint, type):
+ return cls(type_repr(hint), hint)
+ if isinstance(hint, Sequence):
+ if sequence_is_union:
+ return cls.from_sequence(hint)
+ if isinstance(hint, list):
+ # Better string representation with Callable params and other lists.
+ items = [t.__name__ if isinstance(t, type) else repr(t) for t in hint]
+ return cls(f"[{', '.join(items)}]")
+ return cls(str(hint))
+
+ @classmethod
+ def from_type(cls, hint: type) -> "TypeInfo":
+ """Construct a ``TypeInfo`` based on an actual type.
+
+ Use :meth:`from_type_hint` if the type hint can also be something else
+ than a concrete type such as a string or a type expression.
+ """
+ return cls(type_repr(hint), hint)
+
+ @classmethod
+ def from_string(cls, hint: str) -> "TypeInfo":
+ """Construct a ``TypeInfo`` based on a string.
+
+ In addition to just types names or their aliases like ``int`` or ``integer``,
+ supports also parameterized types like ``list[int]`` as well as unions like
+ ``int | float``.
+
+ Use :meth:`from_type_hint` if the type hint can also be something else
+ than a string such as an actual type.
+ """
+ # Needs to be imported here due to cyclic dependency.
+ from .typeinfoparser import TypeInfoParser
+
+ try:
+ return TypeInfoParser(hint).parse()
+ except ValueError as err:
+ raise DataError(str(err))
+
+ @classmethod
+ def from_sequence(cls, sequence: Sequence) -> "TypeInfo":
+ """Construct a ``TypeInfo`` based on a sequence of types.
+
+ Types can be actual types, strings, or anything else accepted by
+ :meth:`from_type_hint`. If the sequence contains just one type,
+ a ``TypeInfo`` created based on it is returned. If there are more
+ types, the returned ``TypeInfo`` represents a union. Using an empty
+ sequence is an error.
+
+ Use :meth:`from_type_hint` if other types than sequences need to
+ supported.
+ """
+ infos = []
+ for typ in sequence:
+ info = cls.from_type_hint(typ, sequence_is_union=True)
+ if info.is_union:
+ infos.extend(info.nested)
+ else:
+ infos.append(info)
+ if len(infos) == 1:
+ return infos[0]
+ return cls("Union", nested=infos)
+
+ @classmethod
+ def from_variable(
+ cls,
+ variable: "str|VariableMatch",
+ handle_list_and_dict: bool = True,
+ ) -> "TypeInfo":
+ """Construct a ``TypeInfo`` based on a variable.
+
+ Type can be specified using syntax like ``${x: int}``.
+
+ :param variable: Variable as a string or as an already parsed
+ ``VariableMatch`` object.
+ :param handle_list_and_dict: When ``True``, types in list and dictionary
+ variables get ``list[]`` and ``dict[]`` decoration implicitly.
+ For example, ``@{x: int}``, ``&{x: int}`` and ``&{x: str=int}``
+ yield types ``list[int]``, ``dict[Any, int]`` and ``dict[str, int]``,
+ respectively.
+ :raises: ``DataError`` if variable has an unrecognized type. Variable
+ not having a type is not an error.
+
+ New in Robot Framework 7.3.
+ """
+ if isinstance(variable, str):
+ variable = search_variable(variable, parse_type=True)
+ if not variable.type:
+ return cls()
+ type_ = variable.type
+ if handle_list_and_dict:
+ if variable.identifier == "@":
+ type_ = f"list[{type_}]"
+ elif variable.identifier == "&":
+ if "=" in type_:
+ kt, vt = type_.split("=", 1)
+ else:
+ kt, vt = "Any", type_
+ type_ = f"dict[{kt}, {vt}]"
+ info = cls.from_string(type_)
+ cls._validate_var_type(info)
+ return info
+
+ @classmethod
+ def _validate_var_type(cls, info):
+ if info.type is None:
+ raise DataError(f"Unrecognized type '{info.name}'.")
+ if info.nested and info.type is not Literal:
+ for nested in info.nested:
+ cls._validate_var_type(nested)
+
+ def convert(
+ self,
+ value: Any,
+ name: "str|None" = None,
+ custom_converters: "CustomArgumentConverters|dict|None" = None,
+ languages: "LanguagesLike" = None,
+ kind: str = "Argument",
+ allow_unknown: bool = False,
+ ) -> object:
+ """Convert ``value`` based on type information this ``TypeInfo`` contains.
+
+ :param value: Value to convert.
+ :param name: Name of the argument or other thing to convert.
+ Used only for error reporting.
+ :param custom_converters: Custom argument converters.
+ :param languages: Language configuration. During execution, uses the
+ current language configuration by default.
+ :param kind: Type of the thing to be converted.
+ Used only for error reporting.
+ :param allow_unknown: If ``False``, a ``TypeError`` is raised if there
+ is no converter for this type or to its nested types. If ``True``,
+ conversion returns the original value instead.
+ :raises: ``ValueError`` if conversion fails and ``TypeError`` if there is
+ no converter for this type and unknown converters are not accepted.
+ :return: Converted value.
+ """
+ converter = self.get_converter(custom_converters, languages, allow_unknown)
+ return converter.convert(value, name, kind)
+
+ def get_converter(
+ self,
+ custom_converters: "CustomArgumentConverters|dict|None" = None,
+ languages: "LanguagesLike" = None,
+ allow_unknown: bool = False,
+ ) -> TypeConverter:
+ """Get argument converter for this ``TypeInfo``.
+
+ :param custom_converters: Custom argument converters.
+ :param languages: Language configuration. During execution, uses the
+ current language configuration by default.
+ :param allow_unknown: If ``False``, a ``TypeError`` is raised if there
+ is no converter for this type or to its nested types. If ``True``,
+ a special ``UnknownConverter`` is returned instead.
+ :raises: ``TypeError`` if there is no converter and unknown converters
+ are not accepted.
+ :return: ``TypeConverter``.
+
+ The :meth:`convert` method handles the common conversion case, but this
+ method can be used if the converter is needed multiple times or its
+ needed also for other purposes than conversion.
+
+ New in Robot Framework 7.2.
+ """
+ if isinstance(custom_converters, dict):
+ custom_converters = CustomArgumentConverters.from_dict(custom_converters)
+ if not languages and EXECUTION_CONTEXTS.current:
+ languages = EXECUTION_CONTEXTS.current.languages
+ elif not isinstance(languages, Languages):
+ languages = Languages(languages)
+ converter = TypeConverter.converter_for(self, custom_converters, languages)
+ if not allow_unknown:
+ converter.validate()
+ return converter
+
+ def __str__(self):
+ if self.is_union:
+ return " | ".join(str(n) for n in self.nested)
+ name = self.name or ""
+ if self.nested is None:
+ return name
+ nested = ", ".join(str(n) for n in self.nested)
+ return f"{name}[{nested}]"
+
+ def __bool__(self):
+ return self.name is not None
+
+
+class TypedDictInfo(TypeInfo):
+ """Represents ``TypedDict`` used as an argument."""
+
+ is_typed_dict = True
+ __slots__ = ("annotations", "required")
+
+ def __init__(self, name: str, type: type):
+ super().__init__(name, type)
+ type_hints = self._get_type_hints(type)
+ # __required_keys__ is new in Python 3.9.
+ self.required = getattr(type, "__required_keys__", frozenset())
+ if sys.version_info < (3, 11):
+ self._handle_typing_extensions_required_and_not_required(type_hints)
+ self.annotations = {
+ name: TypeInfo.from_type_hint(hint) for name, hint in type_hints.items()
+ }
+
+ def _get_type_hints(self, type) -> "dict[str, Any]":
+ try:
+ return get_type_hints(type)
+ except Exception:
+ return type.__annotations__
+
+ def _handle_typing_extensions_required_and_not_required(self, type_hints):
+ # NotRequired and Required are handled automatically by Python 3.11 and newer,
+ # but with older they appear in type hints and need to be handled separately.
+ required = set(self.required)
+ for key, hint in type_hints.items():
+ origin = get_origin(hint)
+ if origin is Required:
+ required.add(key)
+ type_hints[key] = get_args(hint)[0]
+ elif origin is NotRequired:
+ required.discard(key)
+ type_hints[key] = get_args(hint)[0]
+ self.required = frozenset(required)
diff --git a/src/robot/running/arguments/typeinfoparser.py b/src/robot/running/arguments/typeinfoparser.py
new file mode 100644
index 00000000000..b5c0cff74bd
--- /dev/null
+++ b/src/robot/running/arguments/typeinfoparser.py
@@ -0,0 +1,220 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from ast import literal_eval
+from dataclasses import dataclass
+from enum import auto, Enum
+from typing import Literal
+
+from .typeinfo import LITERAL_TYPES, TypeInfo
+
+
+class TokenType(Enum):
+ NAME = auto()
+ LEFT_SQUARE = auto()
+ RIGHT_SQUARE = auto()
+ PIPE = auto()
+ COMMA = auto()
+
+ def __repr__(self):
+ return str(self)
+
+
+@dataclass
+class Token:
+ type: TokenType
+ value: str
+ position: int = -1
+
+
+class TypeInfoTokenizer:
+ markers = {
+ "[": TokenType.LEFT_SQUARE,
+ "]": TokenType.RIGHT_SQUARE,
+ "|": TokenType.PIPE,
+ ",": TokenType.COMMA,
+ }
+
+ def __init__(self, source: str):
+ self.source = source
+ self.tokens: "list[Token]" = []
+ self.start = 0
+ self.current = 0
+
+ @property
+ def at_end(self) -> bool:
+ return self.current >= len(self.source)
+
+ def tokenize(self) -> "list[Token]":
+ while not self.at_end:
+ self.start = self.current
+ char = self.advance()
+ if char in self.markers:
+ self.add_token(self.markers[char])
+ elif char.strip():
+ self.name()
+ return self.tokens
+
+ def advance(self) -> str:
+ char = self.source[self.current]
+ self.current += 1
+ return char
+
+ def peek(self) -> "str|None":
+ try:
+ return self.source[self.current]
+ except IndexError:
+ return None
+
+ def name(self):
+ end_at = set(self.markers) | {None}
+ closing_quote = None
+ char = self.source[self.current - 1]
+ if char in ('"', "'"):
+ end_at = {None}
+ closing_quote = char
+ elif char == "b" and self.peek() in ('"', "'"):
+ end_at = {None}
+ closing_quote = self.advance()
+ while True:
+ char = self.peek()
+ if char in end_at:
+ break
+ self.current += 1
+ if char == closing_quote:
+ break
+ self.add_token(TokenType.NAME)
+
+ def add_token(self, type: TokenType):
+ value = self.source[self.start : self.current].strip()
+ self.tokens.append(Token(type, value, self.start))
+
+
+class TypeInfoParser:
+
+ def __init__(self, source: str):
+ self.source = source
+ self.tokens: "list[Token]" = []
+ self.current = 0
+
+ @property
+ def at_end(self) -> bool:
+ return self.peek() is None
+
+ def parse(self) -> TypeInfo:
+ self.tokens = TypeInfoTokenizer(self.source).tokenize()
+ info = self.type()
+ if not self.at_end:
+ self.error(f"Extra content after '{info}'.")
+ return info
+
+ def type(self) -> TypeInfo:
+ if not self.check(TokenType.NAME):
+ self.error("Type name missing.")
+ info = TypeInfo(self.advance().value)
+ if self.match(TokenType.LEFT_SQUARE):
+ info.nested = self.params(literal=info.type is Literal)
+ if self.match(TokenType.PIPE):
+ nested = [info, *self.union()]
+ info = TypeInfo("Union", nested=nested)
+ return info
+
+ def params(self, literal: bool = False) -> "list[TypeInfo]":
+ params = []
+ prev = None
+ while True:
+ token = self.peek()
+ if not token:
+ self.error("Closing ']' missing.")
+ if token.type is TokenType.RIGHT_SQUARE:
+ self.advance()
+ break
+ if token.type is TokenType.COMMA:
+ if not prev or prev.type is TokenType.COMMA:
+ self.error("Type missing before ','.")
+ self.advance()
+ prev = token
+ continue
+ if token.type is TokenType.NAME:
+ param = self.type()
+ elif token.type is TokenType.LEFT_SQUARE:
+ self.advance()
+ param = TypeInfo()
+ param.nested = self.params()
+ if literal:
+ param = self._literal_param(param)
+ params.append(param)
+ prev = token
+ if literal and not params:
+ self.error("Literal cannot be empty.")
+ return params
+
+ def _literal_param(self, param: TypeInfo) -> TypeInfo:
+ try:
+ if param.name is None:
+ raise ValueError
+ try:
+ value = literal_eval(param.name)
+ except ValueError:
+ if param.name.isidentifier():
+ return TypeInfo(param.name, None)
+ raise
+ if not isinstance(value, LITERAL_TYPES):
+ raise ValueError
+ except (ValueError, SyntaxError):
+ self.error(f"Invalid literal value {str(param)!r}.")
+ else:
+ return TypeInfo(repr(value), value)
+
+ def union(self) -> "list[TypeInfo]":
+ types = []
+ while not types or self.match(TokenType.PIPE):
+ info = self.type()
+ if info.is_union:
+ types.extend(info.nested)
+ else:
+ types.append(info)
+ return types
+
+ def match(self, *types: TokenType) -> bool:
+ for typ in types:
+ if self.check(typ):
+ self.advance()
+ return True
+ return False
+
+ def check(self, expected: TokenType) -> bool:
+ peeked = self.peek()
+ return peeked and peeked.type == expected
+
+ def advance(self) -> "Token|None":
+ token = self.peek()
+ if token:
+ self.current += 1
+ return token
+
+ def peek(self) -> "Token|None":
+ try:
+ return self.tokens[self.current]
+ except IndexError:
+ return None
+
+ def error(self, message: str, token: "Token|None" = None):
+ if not token:
+ token = self.peek()
+ position = f"index {token.position}" if token else "end"
+ raise ValueError(
+ f"Parsing type {self.source!r} failed: Error at {position}: {message}"
+ )
diff --git a/src/robot/running/arguments/typevalidator.py b/src/robot/running/arguments/typevalidator.py
index 94a728e797e..3fe0fe5fcfe 100644
--- a/src/robot/running/arguments/typevalidator.py
+++ b/src/robot/running/arguments/typevalidator.py
@@ -13,44 +13,57 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from collections.abc import Mapping, Sequence
+from typing import TYPE_CHECKING
+
from robot.errors import DataError
-from robot.utils import (is_dict_like, is_list_like, plural_or_not as s,
- seq2str, type_name)
+from robot.utils import (
+ is_dict_like, is_list_like, plural_or_not as s, seq2str, type_name
+)
+
+from .typeinfo import TypeInfo
+
+if TYPE_CHECKING:
+ from .argumentspec import ArgumentSpec
class TypeValidator:
- def __init__(self, argspec):
- """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`"""
- self._argspec = argspec
+ def __init__(self, spec: "ArgumentSpec"):
+ self.spec = spec
- def validate(self, types):
+ def validate(self, types: "Mapping|Sequence|None") -> "dict[str, TypeInfo]|None":
if types is None:
return None
if not types:
return {}
if is_dict_like(types):
- return self.validate_type_dict(types)
- if is_list_like(types):
- return self.convert_type_list_to_dict(types)
- raise DataError('Type information must be given as a dictionary or '
- 'a list, got %s.' % type_name(types))
-
- def validate_type_dict(self, types):
- # 'return' isn't used for anything yet but it may be shown by Libdoc
- # in the future. Trying to be forward compatible.
- names = set(self._argspec.argument_names + ['return'])
+ self._validate_type_dict(types)
+ elif is_list_like(types):
+ types = self._type_list_to_dict(types)
+ else:
+ raise DataError(
+ f"Type information must be given as a dictionary or a list, "
+ f"got {type_name(types)}."
+ )
+ return {
+ k: TypeInfo.from_type_hint(types[k], sequence_is_union=True) for k in types
+ }
+
+ def _validate_type_dict(self, types: Mapping):
+ names = set(self.spec.argument_names)
extra = [t for t in types if t not in names]
if extra:
- raise DataError('Type information given to non-existing '
- 'argument%s %s.'
- % (s(extra), seq2str(sorted(extra))))
- return types
+ raise DataError(
+ f"Type information given to non-existing "
+ f"argument{s(extra)} {seq2str(sorted(extra))}."
+ )
- def convert_type_list_to_dict(self, types):
- names = self._argspec.argument_names
+ def _type_list_to_dict(self, types: Sequence) -> dict:
+ names = self.spec.argument_names
if len(types) > len(names):
- raise DataError('Type information given to %d argument%s but '
- 'keyword has only %d argument%s.'
- % (len(types), s(types), len(names), s(names)))
+ raise DataError(
+ f"Type information given to {len(types)} argument{s(types)} "
+ f"but keyword has only {len(names)} argument{s(names)}."
+ )
return {name: value for name, value in zip(names, types) if value}
diff --git a/src/robot/running/bodyrunner.py b/src/robot/running/bodyrunner.py
index 13dea76b650..204b728af1a 100644
--- a/src/robot/running/bodyrunner.py
+++ b/src/robot/running/bodyrunner.py
@@ -13,25 +13,27 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from collections import OrderedDict
-from contextlib import contextmanager
import re
import time
+from collections import OrderedDict
+from contextlib import contextmanager
+from datetime import datetime
+from itertools import zip_longest
-from robot.errors import (BreakLoop, ContinueLoop, DataError, ExecutionFailed,
- ExecutionFailures, ExecutionPassed, ExecutionStatus)
-from robot.result import (For as ForResult, While as WhileResult, If as IfResult,
- IfBranch as IfBranchResult, Try as TryResult,
- TryBranch as TryBranchResult)
+from robot.errors import (
+ BreakLoop, ContinueLoop, DataError, ExecutionFailed, ExecutionFailures,
+ ExecutionPassed, ExecutionStatus
+)
from robot.output import librarylogger as logger
-from robot.utils import (cut_assign_value, frange, get_error_message, is_string,
- is_list_like, is_number, plural_or_not as s, seq2str,
- split_from_equals, type_name, Matcher, timestr_to_secs)
-from robot.variables import is_dict_variable, evaluate_expression
+from robot.utils import (
+ cut_assign_value, frange, get_error_message, is_list_like, Matcher, normalize,
+ plural_or_not as s, secs_to_timestr, seq2str, split_from_equals, timestr_to_secs,
+ type_name
+)
+from robot.variables import evaluate_expression, is_dict_variable, search_variable
from .statusreporter import StatusReporter
-
DEFAULT_WHILE_LIMIT = 10_000
@@ -42,12 +44,12 @@ def __init__(self, context, run=True, templated=False):
self._run = run
self._templated = templated
- def run(self, body):
+ def run(self, data, result):
errors = []
passed = None
- for step in body:
+ for item in data.body:
try:
- step.run(self._context, self._run, self._templated)
+ item.run(result, self._context, self._run, self._templated)
except ExecutionPassed as exception:
exception.set_earlier_failures(errors)
passed = exception
@@ -57,9 +59,19 @@ def run(self, body):
self._run = exception.can_continue(self._context, self._templated)
if passed:
raise passed
+ if errors and self._templated:
+ errors = self._handle_skip_with_templates(errors, result)
if errors:
raise ExecutionFailures(errors)
+ def _handle_skip_with_templates(self, errors, result):
+ iterations = result.body.filter(messages=False)
+ if len(iterations) < 2 or not any(e.skip for e in errors):
+ return errors
+ if all(i.skipped for i in iterations):
+ raise ExecutionFailed("All iterations skipped.", skip=True)
+ return [e for e in errors if not e.skip]
+
class KeywordRunner:
@@ -67,74 +79,126 @@ def __init__(self, context, run=True):
self._context = context
self._run = run
- def run(self, step, name=None):
+ def run(self, data, result, setup_or_teardown=False):
context = self._context
- runner = context.get_runner(name or step.name)
+ if setup_or_teardown:
+ runner = self._get_setup_teardown_runner(data, context)
+ else:
+ runner = context.get_runner(data.name, recommend_on_failure=self._run)
+ if not runner:
+ return None
if context.dry_run:
- return runner.dry_run(step, context)
- return runner.run(step, context, self._run)
+ return runner.dry_run(data, result, context)
+ return runner.run(data, result, context, self._run)
-
-def ForRunner(context, flavor='IN', run=True, templated=False):
- runners = {'IN': ForInRunner,
- 'IN RANGE': ForInRangeRunner,
- 'IN ZIP': ForInZipRunner,
- 'IN ENUMERATE': ForInEnumerateRunner}
- runner = runners[flavor or 'IN']
+ def _get_setup_teardown_runner(self, data, context):
+ try:
+ name = context.variables.replace_string(data.name)
+ except DataError as err:
+ if context.dry_run:
+ return None
+ raise ExecutionFailed(err.message)
+ if name.upper() in ("NONE", ""):
+ return None
+ # If the matched runner accepts embedded arguments, use the original name
+ # instead of the one where variables are already replaced and converted to
+ # strings. This allows using non-string values as embedded arguments also
+ # in this context. An exact match after variables have been replaced has
+ # a precedence over a possible embedded match with the original name, though.
+ # BuiltIn.run_keyword has the same logic.
+ runner = context.get_runner(name, recommend_on_failure=self._run)
+ if hasattr(runner, "embedded_args") and name != data.name:
+ candidate = context.get_runner(data.name)
+ if hasattr(candidate, "embedded_args"):
+ runner = candidate
+ return runner
+
+
+def ForRunner(context, flavor="IN", run=True, templated=False):
+ runners = {
+ "IN": ForInRunner,
+ "IN RANGE": ForInRangeRunner,
+ "IN ZIP": ForInZipRunner,
+ "IN ENUMERATE": ForInEnumerateRunner,
+ }
+ runner = runners[flavor or "IN"]
return runner(context, run, templated)
class ForInRunner:
- flavor = 'IN'
+ flavor = "IN"
def __init__(self, context, run=True, templated=False):
self._context = context
self._run = run
self._templated = templated
- def run(self, data):
- result = ForResult(data.variables, data.flavor, data.values)
- with StatusReporter(data, result, self._context, self._run) as status:
- run_at_least_once = False
- if self._run:
- if data.error:
- raise DataError(data.error)
- run_at_least_once = self._run_loop(data, result)
- if not run_at_least_once:
- status.pass_status = result.NOT_RUN
- self._run_one_round(data, result, run=False)
-
- def _run_loop(self, data, result):
+ def run(self, data, result):
+ error = None
+ run = False
+ if self._run:
+ if data.error:
+ error = DataError(data.error, syntax=True)
+ else:
+ run = True
+ with StatusReporter(data, result, self._context, run) as status:
+ if run:
+ try:
+ assign, types = self._split_types(data)
+ values_for_rounds = self._get_values_for_rounds(data)
+ except DataError as err:
+ error = err
+ else:
+ if self._run_loop(data, result, assign, types, values_for_rounds):
+ return
+ status.pass_status = result.NOT_RUN
+ self._no_run_one_round(data, result)
+ if error:
+ raise error
+
+ def _run_loop(self, data, result, assign, types, values_for_rounds):
errors = []
executed = False
- for values in self._get_values_for_rounds(data):
+ for values in values_for_rounds:
executed = True
try:
- self._run_one_round(data, result, values)
- except BreakLoop as exception:
- if exception.earlier_failures:
- errors.extend(exception.earlier_failures.get_errors())
- break
- except ContinueLoop as exception:
- if exception.earlier_failures:
- errors.extend(exception.earlier_failures.get_errors())
- continue
- except ExecutionPassed as exception:
- exception.set_earlier_failures(errors)
- raise exception
- except ExecutionFailed as exception:
- errors.extend(exception.get_errors())
- if not exception.can_continue(self._context,
- self._templated):
+ self._run_one_round(data, result, assign, types, values)
+ except (BreakLoop, ContinueLoop) as ctrl:
+ if ctrl.earlier_failures:
+ errors.extend(ctrl.earlier_failures.get_errors())
+ if isinstance(ctrl, BreakLoop):
+ break
+ except ExecutionPassed as passed:
+ passed.set_earlier_failures(errors)
+ raise passed
+ except ExecutionFailed as failed:
+ errors.extend(failed.get_errors())
+ if not failed.can_continue(self._context, self._templated):
break
if errors:
+ if self._templated and len(errors) > 1 and all(e.skip for e in errors):
+ raise ExecutionFailed("All iterations skipped.", skip=True)
raise ExecutionFailures(errors)
return executed
+ def _split_types(self, data):
+ from .arguments import TypeInfo
+
+ assign = []
+ types = []
+ for variable in data.assign:
+ match = search_variable(variable, parse_type=True)
+ assign.append(match.name)
+ try:
+ types.append(TypeInfo.from_variable(match) if match.type else None)
+ except DataError as err:
+ raise DataError(f"Invalid FOR loop variable '{variable}': {err}")
+ return assign, types
+
def _get_values_for_rounds(self, data):
if self._context.dry_run:
- return [None]
- values_per_round = len(data.variables)
+ return [[""] * len(data.assign)]
+ values_per_round = len(data.assign)
if self._is_dict_iteration(data.values):
values = self._resolve_dict_values(data.values)
values = self._map_dict_values_to_rounds(values, values_per_round)
@@ -150,16 +214,15 @@ def _is_dict_iteration(self, values):
return True
if split_from_equals(item)[1] is None:
all_name_value = False
- if all_name_value:
+ if all_name_value and values:
name, value = split_from_equals(values[0])
logger.warn(
- "FOR loop iteration over values that are all in 'name=value' "
- "format like '%s' is deprecated. In the future this syntax "
- "will mean iterating over names and values separately like "
- "when iterating over '&{dict} variables. Escape at least one "
- "of the values like '%s\\=%s' to use normal FOR loop "
- "iteration and to disable this warning."
- % (values[0], name, value)
+ f"FOR loop iteration over values that are all in 'name=value' format "
+ f"like '{values[0]}' is deprecated. In the future this syntax will "
+ f"mean iterating over names and values separately like when iterating "
+ f"over '&{{dict}} variables. Escape at least one of the values like "
+ f"'{name}\\={value}' to use normal FOR loop iteration and to disable "
+ f"this warning."
)
return False
@@ -173,24 +236,24 @@ def _resolve_dict_values(self, values):
key, value = split_from_equals(item)
if value is None:
raise DataError(
- "Invalid FOR loop value '%s'. When iterating over "
- "dictionaries, values must be '&{dict}' variables "
- "or use 'key=value' syntax." % item
+ f"Invalid FOR loop value '{item}'. When iterating "
+ f"over dictionaries, values must be '&{{dict}}' "
+ f"variables or use 'key=value' syntax.",
+ syntax=True,
)
try:
result[replace_scalar(key)] = replace_scalar(value)
except TypeError:
- raise DataError(
- "Invalid dictionary item '%s': %s"
- % (item, get_error_message())
- )
+ err = get_error_message()
+ raise DataError(f"Invalid dictionary item '{item}': {err}")
return result.items()
def _map_dict_values_to_rounds(self, values, per_round):
if per_round > 2:
raise DataError(
- 'Number of FOR loop variables must be 1 or 2 when iterating '
- 'over dictionaries, got %d.' % per_round
+ f"Number of FOR loop variables must be 1 or 2 when iterating "
+ f"over dictionaries, got {per_round}.",
+ syntax=True,
)
return values
@@ -202,129 +265,200 @@ def _map_values_to_rounds(self, values, per_round):
if count % per_round != 0:
self._raise_wrong_variable_count(per_round, count)
# Map list of values to list of lists containing values per round.
- return (values[i:i+per_round] for i in range(0, count, per_round))
+ return (values[i : i + per_round] for i in range(0, count, per_round))
def _raise_wrong_variable_count(self, variables, values):
raise DataError(
- 'Number of FOR loop values should be multiple of its variables. '
- 'Got %d variables but %d value%s.' % (variables, values, s(values))
+ f"Number of FOR loop values should be multiple of its variables. "
+ f"Got {variables} variables but {values} value{s(values)}."
)
- def _run_one_round(self, data, result, values=None, run=True):
- result = result.body.create_iteration()
- if values is not None:
- variables = self._context.variables
- else: # Not really run (earlier failure, unexecuted IF branch, dry-run)
- variables = {}
- values = [''] * len(data.variables)
- for name, value in self._map_variables_and_values(data.variables, values):
+ def _run_one_round(self, data, result, assign, types, values, run=True):
+ ctx = self._context
+ iter_data = data.get_iteration()
+ iter_result = result.body.create_iteration()
+ variables = ctx.variables if run and not ctx.dry_run else {}
+ if len(assign) == 1 and len(values) != 1:
+ values = [tuple(values)]
+ for orig, name, type_info, value in zip(data.assign, assign, types, values):
+ if type_info and not ctx.dry_run:
+ value = type_info.convert(value, orig, kind="FOR loop variable")
variables[name] = value
- result.variables[name] = cut_assign_value(value)
+ iter_data.assign[orig] = value
+ iter_result.assign[orig] = cut_assign_value(value)
runner = BodyRunner(self._context, run, self._templated)
- with StatusReporter(data, result, self._context, run):
- runner.run(data.body)
-
- def _map_variables_and_values(self, variables, values):
- if len(variables) == 1 and len(values) != 1:
- return [(variables[0], tuple(values))]
- return zip(variables, values)
+ with StatusReporter(iter_data, iter_result, self._context, run):
+ runner.run(iter_data, iter_result)
+
+ def _no_run_one_round(self, data, result):
+ self._run_one_round(
+ data,
+ result,
+ assign=data.assign,
+ types=[None] * len(data.assign),
+ values=[""] * len(data.assign),
+ run=False,
+ )
class ForInRangeRunner(ForInRunner):
- flavor = 'IN RANGE'
+ flavor = "IN RANGE"
def _resolve_dict_values(self, values):
raise DataError(
- 'FOR IN RANGE loops do not support iterating over dictionaries.'
+ "FOR IN RANGE loops do not support iterating over dictionaries.",
+ syntax=True,
)
def _map_values_to_rounds(self, values, per_round):
if not 1 <= len(values) <= 3:
raise DataError(
- 'FOR IN RANGE expected 1-3 values, got %d.' % len(values)
+ f"FOR IN RANGE expected 1-3 values, got {len(values)}.",
+ syntax=True,
)
try:
values = [self._to_number_with_arithmetic(v) for v in values]
- except:
- raise DataError(
- 'Converting FOR IN RANGE values failed: %s.'
- % get_error_message()
- )
+ except Exception:
+ msg = get_error_message()
+ raise DataError(f"Converting FOR IN RANGE values failed: {msg}.")
values = frange(*values)
- return ForInRunner._map_values_to_rounds(self, values, per_round)
+ return super()._map_values_to_rounds(values, per_round)
def _to_number_with_arithmetic(self, item):
- if is_number(item):
+ if isinstance(item, (int, float)):
return item
number = eval(str(item), {})
- if not is_number(number):
- raise TypeError("Expected number, got %s." % type_name(item))
+ if not isinstance(number, (int, float)):
+ raise TypeError(f"Expected number, got {type_name(item)}.")
return number
class ForInZipRunner(ForInRunner):
- flavor = 'IN ZIP'
- _start = 0
+ flavor = "IN ZIP"
+ _mode = None
+ _fill = None
+
+ def _get_values_for_rounds(self, data):
+ self._mode = self._resolve_mode(data.mode)
+ self._fill = self._resolve_fill(data.fill)
+ return super()._get_values_for_rounds(data)
+
+ def _resolve_mode(self, mode):
+ if not mode or self._context.dry_run:
+ return None
+ try:
+ mode = self._context.variables.replace_string(mode)
+ valid = ("STRICT", "SHORTEST", "LONGEST")
+ if mode.upper() in valid:
+ return mode.upper()
+ raise DataError(
+ f"Value '{mode}' is not accepted. Valid values are {seq2str(valid)}."
+ )
+ except DataError as err:
+ raise DataError(f"Invalid FOR IN ZIP mode: {err}")
+
+ def _resolve_fill(self, fill):
+ if not fill or self._context.dry_run:
+ return None
+ try:
+ return self._context.variables.replace_scalar(fill)
+ except DataError as err:
+ raise DataError(f"Invalid FOR IN ZIP fill value: {err}")
def _resolve_dict_values(self, values):
raise DataError(
- 'FOR IN ZIP loops do not support iterating over dictionaries.'
+ "FOR IN ZIP loops do not support iterating over dictionaries.",
+ syntax=True,
)
def _map_values_to_rounds(self, values, per_round):
- for item in values:
+ self._validate_types(values)
+ if len(values) % per_round != 0:
+ self._raise_wrong_variable_count(per_round, len(values))
+ if self._mode == "LONGEST":
+ return zip_longest(*values, fillvalue=self._fill)
+ if self._mode == "STRICT":
+ self._validate_strict_lengths(values)
+ if self._mode is None:
+ self._deprecate_different_lengths(values)
+ return zip(*values)
+
+ def _validate_types(self, values):
+ for index, item in enumerate(values, start=1):
if not is_list_like(item):
raise DataError(
- "FOR IN ZIP items must all be list-like, got %s '%s'."
- % (type_name(item), item)
+ f"FOR IN ZIP items must be list-like, "
+ f"but item {index} is {type_name(item)}."
)
- if len(values) % per_round != 0:
- self._raise_wrong_variable_count(per_round, len(values))
- return zip(*(list(item) for item in values))
+
+ def _validate_strict_lengths(self, values):
+ lengths = []
+ for index, item in enumerate(values, start=1):
+ try:
+ lengths.append(len(item))
+ except TypeError:
+ raise DataError(
+ f"FOR IN ZIP items must have length in the STRICT mode, "
+ f"but item {index} does not."
+ )
+ if len(set(lengths)) > 1:
+ raise DataError(
+ f"FOR IN ZIP items must have equal lengths in the STRICT mode, "
+ f"but lengths are {seq2str(lengths, quote='')}."
+ )
+
+ def _deprecate_different_lengths(self, values):
+ try:
+ self._validate_strict_lengths(values)
+ except DataError as err:
+ logger.warn(
+ f"FOR IN ZIP default mode will be changed from SHORTEST to STRICT in "
+ f"Robot Framework 8.0. Use 'mode=SHORTEST' to keep using the SHORTEST "
+ f"mode. If the mode is not changed, execution will fail like this in "
+ f"the future: {err}"
+ )
class ForInEnumerateRunner(ForInRunner):
- flavor = 'IN ENUMERATE'
+ flavor = "IN ENUMERATE"
+ _start = 0
- def _resolve_dict_values(self, values):
- self._start, values = self._get_start(values)
- return ForInRunner._resolve_dict_values(self, values)
+ def _get_values_for_rounds(self, data):
+ self._start = self._resolve_start(data.start)
+ return super()._get_values_for_rounds(data)
- def _resolve_values(self, values):
- self._start, values = self._get_start(values)
- return ForInRunner._resolve_values(self, values)
-
- def _get_start(self, values):
- if not values[-1].startswith('start='):
- return 0, values
- start = self._context.variables.replace_string(values[-1][6:])
- if len(values) == 1:
- raise DataError('FOR loop has no loop values.')
+ def _resolve_start(self, start):
+ if not start or self._context.dry_run:
+ return 0
try:
- return int(start), values[:-1]
- except ValueError:
- raise ValueError("Invalid FOR IN ENUMERATE start value '%s'." % start)
+ start = self._context.variables.replace_string(start)
+ try:
+ return int(start)
+ except ValueError:
+ raise DataError(f"Value must be an integer, got '{start}'.")
+ except DataError as err:
+ raise DataError(f"Invalid FOR IN ENUMERATE start value: {err}")
def _map_dict_values_to_rounds(self, values, per_round):
if per_round > 3:
raise DataError(
- 'Number of FOR IN ENUMERATE loop variables must be 1-3 when '
- 'iterating over dictionaries, got %d.' % per_round
+ f"Number of FOR IN ENUMERATE loop variables must be 1-3 "
+ f"when iterating over dictionaries, got {per_round}.",
+ syntax=True,
)
if per_round == 2:
return ((i, v) for i, v in enumerate(values, start=self._start))
- return ((i,) + v for i, v in enumerate(values, start=self._start))
+ return ((i, *v) for i, v in enumerate(values, start=self._start))
def _map_values_to_rounds(self, values, per_round):
- per_round = max(per_round-1, 1)
- values = ForInRunner._map_values_to_rounds(self, values, per_round)
- return ([i] + v for i, v in enumerate(values, start=self._start))
+ values = super()._map_values_to_rounds(values, max(per_round - 1, 1))
+ return ((i, *v) for i, v in enumerate(values, start=self._start))
def _raise_wrong_variable_count(self, variables, values):
raise DataError(
- 'Number of FOR IN ENUMERATE loop values should be multiple of '
- 'its variables (excluding the index). Got %d variables but %d '
- 'value%s.' % (variables, values, s(values))
+ f"Number of FOR IN ENUMERATE loop values should be multiple of its "
+ f"variables (excluding the index). Got {variables} variables but "
+ f"{values} value{s(values)}."
)
@@ -335,49 +469,110 @@ def __init__(self, context, run=True, templated=False):
self._run = run
self._templated = templated
- def run(self, data):
- run = self._run
- executed_once = False
- result = WhileResult(data.condition, data.limit)
- with StatusReporter(data, result, self._context, run) as status:
- if self._context.dry_run or not run:
+ def run(self, data, result):
+ ctx = self._context
+ error = None
+ run = False
+ result.start_time = datetime.now()
+ iter_result = result.body.create_iteration(start_time=datetime.now())
+ if self._run:
+ if data.error:
+ error = DataError(data.error, syntax=True)
+ elif not ctx.dry_run:
+ try:
+ run = self._should_run(data.condition, ctx.variables)
+ except DataError as err:
+ error = err
+ with StatusReporter(data, result, self._context, run):
+ iter_data = data.get_iteration()
+ if run:
try:
- self._run_iteration(data, result, run)
- except (BreakLoop, ContinueLoop):
- pass
+ limit = WhileLimit.create(data, ctx.variables)
+ except DataError as err:
+ error = err
+ run = False
+ if ctx.dry_run or not run:
+ self._run_iteration(iter_data, iter_result, run)
+ if error:
+ raise error
return
- if data.error:
- raise DataError(data.error)
- limit = WhileLimit.create(data.limit, self._context.variables)
- while self._should_run(data.condition, self._context.variables) \
- and limit.is_valid:
- executed_once = True
+ errors = []
+ while True:
try:
with limit:
- self._run_iteration(data, result, run)
- except BreakLoop:
+ self._run_iteration(iter_data, iter_result)
+ except (BreakLoop, ContinueLoop) as ctrl:
+ if ctrl.earlier_failures:
+ errors.extend(ctrl.earlier_failures.get_errors())
+ if isinstance(ctrl, BreakLoop):
+ break
+ except ExecutionPassed as passed:
+ passed.set_earlier_failures(errors)
+ raise passed
+ except LimitExceeded as exceeded:
+ if exceeded.on_limit_pass:
+ self._context.info(exceeded.message)
+ else:
+ errors.append(exceeded)
+ break
+ except ExecutionFailed as failed:
+ errors.extend(failed.get_errors())
+ if not failed.can_continue(ctx, self._templated):
+ break
+ iter_result = result.body.create_iteration(start_time=datetime.now())
+ iter_data = data.get_iteration()
+ if not self._should_run(data.condition, ctx.variables):
break
- except ContinueLoop:
- continue
- if not executed_once:
- status.pass_status = result.NOT_RUN
- self._run_iteration(data, result, run=False)
- if not limit.is_valid:
- raise DataError(limit.reason)
-
- def _run_iteration(self, data, result, run):
+ if errors:
+ raise ExecutionFailures(errors)
+
+ def _run_iteration(self, data, result, run=True):
runner = BodyRunner(self._context, run, self._templated)
- with StatusReporter(data, result.body.create_iteration(), self._context, run):
- runner.run(data.body)
+ with StatusReporter(data, result, self._context, run):
+ runner.run(data, result)
def _should_run(self, condition, variables):
+ if not condition:
+ return True
+ try:
+ return evaluate_expression(
+ condition,
+ variables.current,
+ resolve_variables=True,
+ )
+ except Exception:
+ msg = get_error_message()
+ raise DataError(f"Invalid WHILE loop condition: {msg}")
+
+
+class GroupRunner:
+
+ def __init__(self, context, run=True, templated=False):
+ self._context = context
+ self._run = run
+ self._templated = templated
+
+ def run(self, data, result):
+ if self._run:
+ error = self._initialize(data, result)
+ run = error is None
+ else:
+ error = None
+ run = False
+ with StatusReporter(data, result, self._context, run=run):
+ runner = BodyRunner(self._context, run, self._templated)
+ runner.run(data, result)
+ if error:
+ raise error
+
+ def _initialize(self, data, result):
+ if data.error:
+ return DataError(data.error, syntax=True)
try:
- condition = variables.replace_scalar(condition)
- if is_string(condition):
- return evaluate_expression(condition, variables.current.store)
- return bool(condition)
+ result.name = self._context.variables.replace_string(result.name)
except DataError as err:
- raise DataError(f'Evaluating WHILE loop condition failed: {err}')
+ return err
+ return None
class IfRunner:
@@ -388,13 +583,18 @@ def __init__(self, context, run=True, templated=False):
self._run = run
self._templated = templated
- def run(self, data):
+ def run(self, data, result):
with self._dry_run_recursion_detection(data) as recursive_dry_run:
error = None
- with StatusReporter(data, IfResult(), self._context, self._run):
+ with StatusReporter(data, result, self._context, self._run):
for branch in data.body:
try:
- if self._run_if_branch(branch, recursive_dry_run, data.error):
+ if self._run_if_branch(
+ branch,
+ result,
+ recursive_dry_run,
+ data.error,
+ ):
self._run = False
except ExecutionStatus as err:
error = err
@@ -404,53 +604,58 @@ def run(self, data):
@contextmanager
def _dry_run_recursion_detection(self, data):
- dry_run = self._context.dry_run
- if dry_run:
- recursive_dry_run = data in self._dry_run_stack
- self._dry_run_stack.append(data)
+ if not self._context.dry_run:
+ yield False
else:
- recursive_dry_run = False
- try:
- yield recursive_dry_run
- finally:
- if dry_run:
+ data = data.to_dict()
+ recursive = data in self._dry_run_stack
+ self._dry_run_stack.append(data)
+ try:
+ yield recursive
+ finally:
self._dry_run_stack.pop()
- def _run_if_branch(self, branch, recursive_dry_run=False, error=None):
+ def _run_if_branch(self, data, result, recursive_dry_run=False, syntax_error=None):
context = self._context
- result = IfBranchResult(branch.type, branch.condition)
- if error:
+ result = result.body.create_branch(
+ data.type,
+ data.condition,
+ start_time=datetime.now(),
+ )
+ error = None
+ if syntax_error:
run_branch = False
+ error = DataError(syntax_error, syntax=True)
else:
try:
- run_branch = self._should_run_branch(branch, context, recursive_dry_run)
- except:
- error = get_error_message()
+ run_branch = self._should_run_branch(data, context, recursive_dry_run)
+ except DataError as err:
+ error = err
run_branch = False
- with StatusReporter(branch, result, context, run_branch):
+ with StatusReporter(data, result, context, run_branch):
runner = BodyRunner(context, run_branch, self._templated)
if not recursive_dry_run:
- runner.run(branch.body)
+ runner.run(data, result)
if error and self._run:
- raise DataError(error)
+ raise error
return run_branch
- def _should_run_branch(self, branch, context, recursive_dry_run=False):
- condition = branch.condition
- variables = context.variables
+ def _should_run_branch(self, data, context, recursive_dry_run=False):
if context.dry_run:
return not recursive_dry_run
if not self._run:
return False
- if condition is None:
+ if data.condition is None:
return True
try:
- condition = variables.replace_scalar(condition)
- if is_string(condition):
- return evaluate_expression(condition, variables.current.store)
- return bool(condition)
- except DataError as err:
- raise DataError(f'Evaluating {branch.type} condition failed: {err}')
+ return evaluate_expression(
+ data.condition,
+ context.variables.current,
+ resolve_variables=True,
+ )
+ except Exception:
+ msg = get_error_message()
+ raise DataError(f"Invalid {data.type} condition: {msg}")
class TryRunner:
@@ -460,38 +665,49 @@ def __init__(self, context, run=True, templated=False):
self._run = run
self._templated = templated
- def run(self, data):
+ def run(self, data, result):
run = self._run
- with StatusReporter(data, TryResult(), self._context, run):
+ with StatusReporter(data, result, self._context, run):
if data.error:
- self._run_invalid(data)
- return False
- error = self._run_try(data, run)
+ self._run_invalid(data, result)
+ return
+ error = self._run_try(data, result, run)
run_excepts_or_else = self._should_run_excepts_or_else(error, run)
if error:
- error = self._run_excepts(data, error, run=run_excepts_or_else)
- self._run_else(data, run=False)
+ error = self._run_excepts(data, result, error, run=run_excepts_or_else)
+ self._run_else(data, result, run=False)
else:
- self._run_excepts(data, error, run=False)
- error = self._run_else(data, run=run_excepts_or_else)
- error = self._run_finally(data, run) or error
+ self._run_excepts(data, result, error, run=False)
+ error = self._run_else(data, result, run=run_excepts_or_else)
+ error = self._run_finally(data, result, run) or error
if error:
raise error
- def _run_invalid(self, data):
+ def _run_invalid(self, data, result):
error_reported = False
for branch in data.body:
- result = TryBranchResult(branch.type, branch.patterns, branch.variable)
- with StatusReporter(branch, result, self._context, run=False, suppress=True):
+ branch_result = result.body.create_branch(
+ branch.type,
+ branch.patterns,
+ branch.pattern_type,
+ branch.assign,
+ )
+ with StatusReporter(
+ branch,
+ branch_result,
+ self._context,
+ run=False,
+ suppress=True,
+ ):
runner = BodyRunner(self._context, run=False, templated=self._templated)
- runner.run(branch.body)
+ runner.run(branch, branch_result)
if not error_reported:
error_reported = True
- raise ExecutionFailed(data.error)
- raise ExecutionFailed(data.error)
+ raise DataError(data.error, syntax=True)
+ raise ExecutionFailed(data.error, syntax=True)
- def _run_try(self, data, run):
- result = TryBranchResult(data.TRY)
+ def _run_try(self, data, result, run):
+ result = result.body.create_branch(data.TRY)
return self._run_branch(data.try_branch, result, run)
def _should_run_excepts_or_else(self, error, run):
@@ -499,23 +715,21 @@ def _should_run_excepts_or_else(self, error, run):
return False
if not error:
return True
- return not (error.skip or isinstance(error, ExecutionPassed))
+ return not (error.skip or error.syntax or isinstance(error, ExecutionPassed))
- def _run_branch(self, branch, result, run=True, error=None):
+ def _run_branch(self, data, result, run=True, error=None):
try:
- with StatusReporter(branch, result, self._context, run):
+ with StatusReporter(data, result, self._context, run):
if error:
raise error
runner = BodyRunner(self._context, run, self._templated)
- runner.run(branch.body)
+ runner.run(data, result)
except ExecutionStatus as err:
- if isinstance(err, ExecutionFailed) and err.syntax:
- raise err
return err
else:
return None
- def _run_excepts(self, data, error, run):
+ def _run_excepts(self, data, result, error, run):
for branch in data.except_branches:
try:
run_branch = run and self._should_run_except(branch, error)
@@ -524,51 +738,57 @@ def _run_excepts(self, data, error, run):
pattern_error = err
else:
pattern_error = None
- result = TryBranchResult(branch.type, branch.patterns,
- branch.pattern_type, branch.variable)
+ branch_result = result.body.create_branch(
+ branch.type,
+ branch.patterns,
+ branch.pattern_type,
+ branch.assign,
+ )
if run_branch:
- if branch.variable:
- self._context.variables[branch.variable] = str(error)
- error = self._run_branch(branch, result, error=pattern_error)
+ if branch.assign:
+ self._context.variables[branch.assign] = str(error)
+ error = self._run_branch(branch, branch_result, error=pattern_error)
run = False
else:
- self._run_branch(branch, result, run=False)
+ self._run_branch(branch, branch_result, run=False)
return error
def _should_run_except(self, branch, error):
if not branch.patterns:
return True
matchers = {
- 'GLOB': lambda m, p: Matcher(p, spaceless=False, caseless=False).match(m),
- 'LITERAL': lambda m, p: m == p,
- 'REGEXP': lambda m, p: re.match(rf'{p}\Z', m) is not None,
- 'START': lambda m, p: m.startswith(p)
+ "GLOB": lambda m, p: Matcher(p, spaceless=False, caseless=False).match(m),
+ "REGEXP": lambda m, p: re.fullmatch(p, m) is not None,
+ "START": lambda m, p: m.startswith(p),
+ "LITERAL": lambda m, p: m == p,
}
if branch.pattern_type:
pattern_type = self._context.variables.replace_string(branch.pattern_type)
else:
- pattern_type = 'LITERAL'
+ pattern_type = "LITERAL"
matcher = matchers.get(pattern_type.upper())
if not matcher:
- raise DataError(f"Invalid EXCEPT pattern type '{pattern_type}', "
- f"expected {seq2str(matchers, lastsep=' or ')}.")
+ raise DataError(
+ f"Invalid EXCEPT pattern type '{pattern_type}'. "
+ f"Valid values are {seq2str(matchers)}."
+ )
for pattern in branch.patterns:
if matcher(error.message, self._context.variables.replace_string(pattern)):
return True
return False
- def _run_else(self, data, run):
+ def _run_else(self, data, result, run):
if data.else_branch:
- result = TryBranchResult(data.ELSE)
+ result = result.body.create_branch(data.ELSE)
return self._run_branch(data.else_branch, result, run)
- def _run_finally(self, data, run):
+ def _run_finally(self, data, result, run):
if data.finally_branch:
- result = TryBranchResult(data.FINALLY)
+ result = result.body.create_branch(data.FINALLY)
try:
with StatusReporter(data.finally_branch, result, self._context, run):
runner = BodyRunner(self._context, run, self._templated)
- runner.run(data.finally_branch.body)
+ runner.run(data.finally_branch, result)
except ExecutionStatus as err:
return err
else:
@@ -576,31 +796,93 @@ def _run_finally(self, data, run):
class WhileLimit:
- is_valid = True
+
+ def __init__(self, on_limit=None, on_limit_message=None):
+ self.on_limit = on_limit
+ self.on_limit_message = on_limit_message
@classmethod
- def create(cls, limit, variables):
+ def create(cls, data, variables):
+ limit = cls._parse_limit(data.limit, variables)
+ on_limit = cls._parse_on_limit(data.on_limit, variables)
+ on_limit_msg = cls._parse_on_limit_message(data.on_limit_message, variables)
+ if not limit:
+ return IterationCountLimit(DEFAULT_WHILE_LIMIT, on_limit, on_limit_msg)
+ if limit.upper() == "NONE":
+ return NoLimit()
try:
- if not limit:
- return IterationCountLimit(DEFAULT_WHILE_LIMIT)
- if limit.upper() == 'NONE':
- return NoLimit()
- value = variables.replace_string(limit)
- try:
- count = int(value.replace(' ', ''))
- if count <= 0:
- return InvalidLimit(f"Iteration limit must be a positive integer, "
- f"got: '{count}'.")
- return IterationCountLimit(count)
- except ValueError:
- return DurationLimit(timestr_to_secs(value))
- except Exception as error:
- return InvalidLimit(error)
+ count = cls._parse_limit_as_count(limit)
+ except ValueError:
+ seconds = cls._parse_limit_as_timestr(limit)
+ return DurationLimit(seconds, on_limit, on_limit_msg)
+ else:
+ return IterationCountLimit(count, on_limit, on_limit_msg)
+
+ @classmethod
+ def _parse_limit(cls, limit, variables):
+ if not limit:
+ return None
+ try:
+ return variables.replace_string(limit)
+ except DataError as err:
+ raise DataError(f"Invalid WHILE loop limit: {err}")
+
+ @classmethod
+ def _parse_on_limit(cls, on_limit, variables):
+ if not on_limit:
+ return None
+ try:
+ on_limit = variables.replace_string(on_limit)
+ if on_limit.upper() in ("PASS", "FAIL"):
+ return on_limit.upper()
+ raise DataError(
+ f"Value '{on_limit}' is not accepted. Valid values are "
+ f"'PASS' and 'FAIL'."
+ )
+ except DataError as err:
+ raise DataError(f"Invalid WHILE loop 'on_limit': {err}")
+
+ @classmethod
+ def _parse_on_limit_message(cls, on_limit_message, variables):
+ if not on_limit_message:
+ return None
+ try:
+ return variables.replace_string(on_limit_message)
+ except DataError as err:
+ raise DataError(f"Invalid WHILE loop 'on_limit_message': '{err}")
+
+ @classmethod
+ def _parse_limit_as_count(cls, limit):
+ limit = normalize(limit)
+ if limit.endswith("times"):
+ limit = limit[:-5]
+ elif limit.endswith("x"):
+ limit = limit[:-1]
+ count = int(limit)
+ if count <= 0:
+ raise DataError(
+ f"Invalid WHILE loop limit: Iteration count must be a positive "
+ f"integer, got '{count}'."
+ )
+ return count
+
+ @classmethod
+ def _parse_limit_as_timestr(cls, limit):
+ try:
+ return timestr_to_secs(limit)
+ except ValueError as err:
+ raise DataError(f"Invalid WHILE loop limit: {err.args[0]}")
def limit_exceeded(self):
- raise ExecutionFailed(f"WHILE loop was aborted because it did not finish within the "
- f"limit of {self}. Use the 'limit' argument to increase or "
- f"remove the limit if needed.")
+ if self.on_limit_message:
+ message = self.on_limit_message
+ else:
+ message = (
+ f"WHILE loop was aborted because it did not finish within the limit "
+ f"of {self}. Use the 'limit' argument to increase or remove the limit "
+ f"if needed."
+ )
+ raise LimitExceeded(self.on_limit == "PASS", message)
def __enter__(self):
raise NotImplementedError
@@ -611,7 +893,8 @@ def __exit__(self, exc_type, exc_val, exc_tb):
class DurationLimit(WhileLimit):
- def __init__(self, max_time):
+ def __init__(self, max_time, on_limit, on_limit_message):
+ super().__init__(on_limit, on_limit_message)
self.max_time = max_time
self.start_time = None
@@ -622,12 +905,13 @@ def __enter__(self):
self.limit_exceeded()
def __str__(self):
- return f'{self.max_time} seconds'
+ return secs_to_timestr(self.max_time)
class IterationCountLimit(WhileLimit):
- def __init__(self, max_iterations):
+ def __init__(self, max_iterations, on_limit, on_limit_message):
+ super().__init__(on_limit, on_limit_message)
self.max_iterations = max_iterations
self.current_iterations = 0
@@ -637,7 +921,7 @@ def __enter__(self):
self.current_iterations += 1
def __str__(self):
- return f'{self.max_iterations} iterations'
+ return f"{self.max_iterations} iterations"
class NoLimit(WhileLimit):
@@ -646,11 +930,8 @@ def __enter__(self):
pass
-class InvalidLimit(WhileLimit):
- is_valid = False
+class LimitExceeded(ExecutionFailed):
- def __init__(self, reason):
- self.reason = f'Invalid WHILE loop limit: {reason}'
-
- def __enter__(self):
- raise DataError(self.reason)
+ def __init__(self, on_limit_pass, message):
+ super().__init__(message)
+ self.on_limit_pass = on_limit_pass
diff --git a/src/robot/running/builder/__init__.py b/src/robot/running/builder/__init__.py
index cfe3cdf8ea1..41d53951005 100644
--- a/src/robot/running/builder/__init__.py
+++ b/src/robot/running/builder/__init__.py
@@ -13,5 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .builders import TestSuiteBuilder, ResourceFileBuilder
-from .parsers import RobotParser
+from .builders import (
+ ResourceFileBuilder as ResourceFileBuilder,
+ TestSuiteBuilder as TestSuiteBuilder,
+)
+from .parsers import RobotParser as RobotParser
+from .settings import TestDefaults as TestDefaults
diff --git a/src/robot/running/builder/builders.py b/src/robot/running/builder/builders.py
index 49985130808..61469a11aa1 100644
--- a/src/robot/running/builder/builders.py
+++ b/src/robot/running/builder/builders.py
@@ -13,14 +13,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import os
+import warnings
+from os.path import normpath
+from pathlib import Path
+from typing import cast, Sequence
+from robot.conf import LanguagesLike
from robot.errors import DataError
from robot.output import LOGGER
-from robot.parsing import SuiteStructureBuilder, SuiteStructureVisitor
+from robot.parsing import (
+ SuiteDirectory, SuiteFile, SuiteStructure, SuiteStructureBuilder,
+ SuiteStructureVisitor
+)
+from robot.utils import Importer, seq2str, split_args_from_name_or_path, type_name
-from .parsers import RobotParser, NoInitFileDirectoryParser, RestParser
-from .testsettings import TestDefaults
+from ..model import TestSuite
+from ..resourcemodel import ResourceFile
+from .parsers import (
+ CustomParser, JsonParser, NoInitFileDirectoryParser, Parser, RestParser, RobotParser
+)
+from .settings import TestDefaults
class TestSuiteBuilder:
@@ -32,178 +44,278 @@ class TestSuiteBuilder:
- Execute the created suite by using its
:meth:`~robot.running.model.TestSuite.run` method. The suite can be
- can be modified before execution if needed.
+ modified before execution if needed.
- Inspect the suite to see, for example, what tests it has or what tags
tests have. This can be more convenient than using the lower level
- :mod:`~robot.parsing` APIs but does not allow saving modified data
- back to the disk.
+ :mod:`~robot.parsing` APIs.
Both modifying the suite and inspecting what data it contains are easiest
done by using the :mod:`~robot.model.visitor` interface.
This class is part of the public API and should be imported via the
- :mod:`robot.api` package.
+ :mod:`robot.api` package. An alternative is using the
+ :meth:`TestSuite.from_file_system `
+ classmethod that uses this class internally.
"""
- def __init__(self, included_suites=None, included_extensions=('robot',),
- rpa=None, allow_empty_suite=False, process_curdir=True):
+ def __init__(
+ self,
+ included_suites: str = "DEPRECATED",
+ included_extensions: Sequence[str] = (".robot", ".rbt", ".robot.rst"),
+ included_files: Sequence[str] = (),
+ custom_parsers: Sequence[str] = (),
+ defaults: "TestDefaults|None" = None,
+ rpa: "bool|None" = None,
+ lang: LanguagesLike = None,
+ allow_empty_suite: bool = False,
+ process_curdir: bool = True,
+ ):
"""
- :param include_suites:
- List of suite names to include. If ``None`` or an empty list, all
- suites are included. Same as using `--suite` on the command line.
+ :param included_suites:
+ This argument used to be used for limiting what suite file to parse.
+ It is deprecated and has no effect starting from RF 6.1. Use the
+ new ``included_files`` argument or filter the created suite after
+ parsing instead.
:param included_extensions:
- List of extensions of files to parse. Same as `--extension`.
- :param rpa: Explicit test execution mode. ``True`` for RPA and
- ``False`` for test automation. By default mode is got from data file
- headers and possible conflicting headers cause an error.
- Same as `--rpa` or `--norpa`.
+ List of extensions of files to parse. Same as ``--extension``.
+ :param included_files:
+ List of names, paths or directory paths of files to parse. All files
+ are parsed by default. Same as `--parse-include`. New in RF 6.1.
+ :param custom_parsers:
+ Custom parsers as names or paths (same as ``--parser``) or as
+ parser objects. New in RF 6.1.
+ :param defaults:
+ Possible test specific defaults from suite initialization files.
+ New in RF 6.1.
+ :param rpa:
+ Explicit execution mode. ``True`` for RPA and ``False`` for test
+ automation. By default, mode is got from data file headers.
+ Same as ``--rpa`` or ``--norpa``.
+ :param lang:
+ Additional languages to be supported during parsing.
+ Can be a string matching any of the supported language codes or names,
+ an initialized :class:`~robot.conf.languages.Language` subclass,
+ a list containing such strings or instances, or a
+ :class:`~robot.conf.languages.Languages` instance.
:param allow_empty_suite:
Specify is it an error if the built suite contains no tests.
- Same as `--runemptysuite`.
+ Same as ``--runemptysuite``.
:param process_curdir:
Control processing the special ``${CURDIR}`` variable. It is
resolved already at parsing time by default, but that can be
changed by giving this argument ``False`` value.
"""
+ self.standard_parsers = self._get_standard_parsers(lang, process_curdir)
+ self.custom_parsers = self._get_custom_parsers(custom_parsers)
+ self.defaults = defaults
+ self.included_extensions = tuple(included_extensions or ())
+ self.included_files = tuple(included_files or ())
self.rpa = rpa
- self.included_suites = included_suites
- self.included_extensions = included_extensions
self.allow_empty_suite = allow_empty_suite
- self.process_curdir = process_curdir
+ # TODO: Remove in RF 8.0.
+ if included_suites != "DEPRECATED":
+ warnings.warn(
+ "'TestSuiteBuilder' argument 'included_suites' is deprecated and "
+ "has no effect. Use the new 'included_files' argument or filter "
+ "the created suite instead."
+ )
+
+ def _get_standard_parsers(
+ self,
+ lang: LanguagesLike,
+ process_curdir: bool,
+ ) -> "dict[str, Parser]":
+ robot_parser = RobotParser(lang, process_curdir)
+ rest_parser = RestParser(lang, process_curdir)
+ json_parser = JsonParser()
+ return {
+ "robot": robot_parser,
+ "rst": rest_parser,
+ "rest": rest_parser,
+ "robot.rst": rest_parser,
+ "rbt": json_parser,
+ "json": json_parser,
+ }
+
+ def _get_custom_parsers(self, parsers: Sequence[str]) -> "dict[str, CustomParser]":
+ custom_parsers = {}
+ importer = Importer("parser", LOGGER)
+ for parser in parsers:
+ if isinstance(parser, (str, Path)):
+ name, args = split_args_from_name_or_path(parser)
+ parser = importer.import_class_or_module(name, args)
+ else:
+ name = type_name(parser)
+ try:
+ custom_parser = CustomParser(parser)
+ except TypeError as err:
+ raise DataError(f"Importing parser '{name}' failed: {err}")
+ for ext in custom_parser.extensions:
+ custom_parsers[ext] = custom_parser
+ return custom_parsers
- def build(self, *paths):
+ def build(self, *paths: "Path|str") -> TestSuite:
"""
:param paths: Paths to test data files or directories.
:return: :class:`~robot.running.model.TestSuite` instance.
"""
- structure = SuiteStructureBuilder(self.included_extensions,
- self.included_suites).build(paths)
- parser = SuiteStructureParser(self.included_extensions,
- self.rpa, self.process_curdir)
- suite = parser.parse(structure)
- if not self.included_suites and not self.allow_empty_suite:
- self._validate_test_counts(suite, multisource=len(paths) > 1)
+ paths = self._normalize_paths(paths)
+ extensions = self.included_extensions + tuple(self.custom_parsers)
+ structure = SuiteStructureBuilder(extensions, self.included_files).build(*paths)
+ suite = SuiteStructureParser(
+ self._get_parsers(paths),
+ self.defaults,
+ self.rpa,
+ ).parse(structure)
+ if not self.allow_empty_suite:
+ self._validate_not_empty(suite, multi_source=len(paths) > 1)
suite.remove_empty_suites(preserve_direct_children=len(paths) > 1)
return suite
- def _validate_test_counts(self, suite, multisource=False):
- def validate(suite):
- if not suite.has_tests:
- raise DataError("Suite '%s' contains no tests or tasks."
- % suite.name)
- if not multisource:
- validate(suite)
- else:
- for s in suite.suites:
- validate(s)
+ def _normalize_paths(self, paths: "Sequence[Path|str]") -> "tuple[Path, ...]":
+ if not paths:
+ raise DataError("One or more source paths required.")
+ # Cannot use `Path.resolve()` here because it resolves all symlinks which
+ # isn't desired. `Path` doesn't have any methods for normalizing paths
+ # so need to use `os.path.normpath()`. Also that _may_ resolve symlinks,
+ # but we need to do it for backwards compatibility.
+ paths = [Path(normpath(p)).absolute() for p in paths]
+ non_existing = [p for p in paths if not p.exists()]
+ if non_existing:
+ raise DataError(
+ f"Parsing {seq2str(non_existing)} failed: "
+ f"File or directory to execute does not exist."
+ )
+ return tuple(paths)
+
+ def _get_parsers(self, paths: "Sequence[Path]") -> "dict[str|None, Parser]":
+ parsers = {None: NoInitFileDirectoryParser(), **self.custom_parsers}
+ robot_parser = self.standard_parsers["robot"]
+ for ext in (
+ *self.included_extensions,
+ *[self._get_ext(pattern) for pattern in self.included_files],
+ *[self._get_ext(pth) for pth in paths if pth.is_file()],
+ ):
+ ext = ext.lstrip(".").lower()
+ if ext not in parsers and ext.replace(".", "").isalnum():
+ parsers[ext] = self.standard_parsers.get(ext, robot_parser)
+ return parsers
+
+ def _get_ext(self, path: "str|Path") -> str:
+ if not isinstance(path, Path):
+ path = Path(path)
+ return "".join(path.suffixes)
+
+ def _validate_not_empty(self, suite: TestSuite, multi_source: bool = False):
+ if multi_source:
+ for child in suite.suites:
+ self._validate_not_empty(child)
+ elif not suite.has_tests:
+ raise DataError(f"Suite '{suite.name}' contains no tests or tasks.")
class SuiteStructureParser(SuiteStructureVisitor):
- def __init__(self, included_extensions, rpa=None, process_curdir=True):
+ def __init__(
+ self,
+ parsers: "dict[str|None, Parser]",
+ defaults: "TestDefaults|None" = None,
+ rpa: "bool|None" = None,
+ ):
+ self.parsers = parsers
self.rpa = rpa
- self._rpa_given = rpa is not None
- self.suite = None
- self._stack = []
- self.parsers = self._get_parsers(included_extensions, process_curdir)
-
- def _get_parsers(self, extensions, process_curdir):
- robot_parser = RobotParser(process_curdir)
- rest_parser = RestParser(process_curdir)
- parsers = {
- None: NoInitFileDirectoryParser(),
- 'robot': robot_parser,
- 'rst': rest_parser,
- 'rest': rest_parser
- }
- for ext in extensions:
- if ext not in parsers:
- parsers[ext] = robot_parser
- return parsers
+ self.defaults = defaults
+ self.suite: "TestSuite|None" = None
+ self._stack: "list[tuple[TestSuite, TestDefaults]]" = []
- def _get_parser(self, extension):
- try:
- return self.parsers[extension]
- except KeyError:
- return self.parsers['robot']
+ @property
+ def parent_defaults(self) -> "TestDefaults|None":
+ return self._stack[-1][-1] if self._stack else self.defaults
- def parse(self, structure):
+ def parse(self, structure: SuiteStructure) -> TestSuite:
structure.visit(self)
- self.suite.rpa = self.rpa
- return self.suite
+ return cast(TestSuite, self.suite)
- def visit_file(self, structure):
- LOGGER.info("Parsing file '%s'." % structure.source)
- suite, _ = self._build_suite(structure)
- if self._stack:
- self._stack[-1][0].suites.append(suite)
- else:
+ def visit_file(self, structure: SuiteFile):
+ LOGGER.info(f"Parsing file '{structure.source}'.")
+ suite = self._build_suite_file(structure)
+ if self.rpa is not None:
+ suite.rpa = self.rpa
+ if self.suite is None:
self.suite = suite
+ else:
+ self._stack[-1][0].suites.append(suite)
- def start_directory(self, structure):
+ def start_directory(self, structure: SuiteDirectory):
if structure.source:
- LOGGER.info("Parsing directory '%s'." % structure.source)
- suite, defaults = self._build_suite(structure)
+ LOGGER.info(f"Parsing directory '{structure.source}'.")
+ suite, defaults = self._build_suite_directory(structure)
if self.suite is None:
self.suite = suite
else:
self._stack[-1][0].suites.append(suite)
self._stack.append((suite, defaults))
- def end_directory(self, structure):
+ def end_directory(self, structure: SuiteDirectory):
suite, _ = self._stack.pop()
- if suite.rpa is None and suite.suites:
- suite.rpa = suite.suites[0].rpa
-
- def _build_suite(self, structure):
- parent_defaults = self._stack[-1][-1] if self._stack else None
- source = structure.source
- defaults = TestDefaults(parent_defaults)
- parser = self._get_parser(structure.extension)
+ if self.rpa is not None:
+ suite.rpa = self.rpa
+ elif suite.rpa is None and suite.suites:
+ if all(s.rpa is False for s in suite.suites):
+ suite.rpa = False
+ elif all(s.rpa is True for s in suite.suites):
+ suite.rpa = True
+
+ def _build_suite_file(self, structure: SuiteFile):
+ source = cast(Path, structure.source)
+ defaults = self.parent_defaults or TestDefaults()
+ parser = self.parsers[structure.extension]
try:
- if structure.is_directory:
- suite = parser.parse_init_file(structure.init_file or source, defaults)
- else:
- suite = parser.parse_suite_file(source, defaults)
- if not suite.tests:
- LOGGER.info("Data source '%s' has no tests or tasks." % source)
- self._validate_execution_mode(suite)
+ suite = parser.parse_suite_file(source, defaults)
+ if not suite.tests:
+ LOGGER.info(f"Data source '{source}' has no tests or tasks.")
except DataError as err:
- raise DataError("Parsing '%s' failed: %s" % (source, err.message))
- return suite, defaults
+ raise DataError(f"Parsing '{source}' failed: {err.message}") from err
+ return suite
- def _validate_execution_mode(self, suite):
- if self._rpa_given:
- suite.rpa = self.rpa
- elif suite.rpa is None:
- pass
- elif self.rpa is None:
- self.rpa = suite.rpa
- elif self.rpa is not suite.rpa:
- this, that = ('tasks', 'tests') if suite.rpa else ('tests', 'tasks')
- raise DataError("Conflicting execution modes. File has %s "
- "but files parsed earlier have %s. Fix headers "
- "or use '--rpa' or '--norpa' options to set the "
- "execution mode explicitly." % (this, that))
+ def _build_suite_directory(self, structure: SuiteDirectory):
+ source = cast(Path, structure.init_file or structure.source)
+ defaults = TestDefaults(self.parent_defaults)
+ parser = self.parsers[structure.extension]
+ try:
+ suite = parser.parse_init_file(source, defaults)
+ if structure.is_multi_source:
+ suite.config(name="", source=None)
+ except DataError as err:
+ raise DataError(f"Parsing '{source}' failed: {err.message}")
+ return suite, defaults
class ResourceFileBuilder:
- def __init__(self, process_curdir=True):
+ def __init__(self, lang: LanguagesLike = None, process_curdir: bool = True):
+ self.lang = lang
self.process_curdir = process_curdir
- def build(self, source):
- LOGGER.info("Parsing resource file '%s'." % source)
+ def build(self, source: Path) -> ResourceFile:
+ if not isinstance(source, Path):
+ source = Path(source)
+ LOGGER.info(f"Parsing resource file '{source}'.")
resource = self._parse(source)
if resource.imports or resource.variables or resource.keywords:
- LOGGER.info("Imported resource file '%s' (%d keywords)."
- % (source, len(resource.keywords)))
+ kws = len(resource.keywords)
+ LOGGER.info(f"Imported resource file '{source}' ({kws} keywords).")
else:
- LOGGER.warn("Imported resource file '%s' is empty." % source)
+ LOGGER.warn(f"Imported resource file '{source}' is empty.")
return resource
- def _parse(self, source):
- if os.path.splitext(source)[1].lower() in ('.rst', '.rest'):
- return RestParser(self.process_curdir).parse_resource_file(source)
- return RobotParser(self.process_curdir).parse_resource_file(source)
+ def _parse(self, source: Path) -> ResourceFile:
+ suffix = source.suffix.lower()
+ if suffix in (".rst", ".rest"):
+ parser = RestParser(self.lang, self.process_curdir)
+ elif suffix in (".json", ".rsrc"):
+ parser = JsonParser()
+ else:
+ parser = RobotParser(self.lang, self.process_curdir)
+ return parser.parse_resource_file(source)
diff --git a/src/robot/running/builder/parsers.py b/src/robot/running/builder/parsers.py
index e3407555acc..c44b35ec420 100644
--- a/src/robot/running/builder/parsers.py
+++ b/src/robot/running/builder/parsers.py
@@ -13,133 +13,184 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import os
-from ast import NodeVisitor
+from abc import ABC
+from inspect import signature
+from pathlib import Path
+from robot.conf import LanguagesLike
from robot.errors import DataError
-from robot.output import LOGGER
-from robot.parsing import get_model, get_resource_model, get_init_model, Token
-from robot.utils import FileReader, read_rest_data
+from robot.parsing import File, get_init_model, get_model, get_resource_model
+from robot.utils import FileReader, get_error_message, read_rest_data, type_name
-from .testsettings import TestDefaults
-from .transformers import SuiteBuilder, SettingsBuilder, ResourceBuilder
-from ..model import TestSuite, ResourceFile
+from ..model import TestSuite
+from ..resourcemodel import ResourceFile
+from .settings import FileSettings, InitFileSettings, TestDefaults
+from .transformers import ResourceBuilder, SuiteBuilder
-class BaseParser:
+class Parser(ABC):
- def parse_init_file(self, source, defaults=None):
- raise NotImplementedError
+ @property
+ def name(self) -> str:
+ return type(self).__name__
- def parse_suite_file(self, source, defaults=None):
- raise NotImplementedError
+ def parse_suite_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ raise DataError(f"'{self.name}' does not support parsing suite files.")
- def parse_resource_file(self, source):
- raise NotImplementedError
+ def parse_init_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ raise DataError(f"'{self.name}' does not support parsing initialization files.")
+ def parse_resource_file(self, source: Path) -> ResourceFile:
+ raise DataError(f"'{self.name}' does not support parsing resource files.")
-class RobotParser(BaseParser):
- def __init__(self, process_curdir=True):
+class RobotParser(Parser):
+ extensions = ()
+
+ def __init__(self, lang: LanguagesLike = None, process_curdir: bool = True):
+ self.lang = lang
self.process_curdir = process_curdir
- def parse_init_file(self, source, defaults=None):
- directory = os.path.dirname(source)
- suite = TestSuite(name=format_name(directory), source=directory)
- return self._build(suite, source, defaults, get_model=get_init_model)
-
- def parse_suite_file(self, source, defaults=None):
- suite = TestSuite(name=format_name(source), source=source)
- return self._build(suite, source, defaults)
-
- def build_suite(self, model, name=None, defaults=None):
- source = model.source
- suite = TestSuite(name=name or format_name(source), source=source)
- return self._build(suite, source, defaults, model)
-
- def _build(self, suite, source, defaults, model=None, get_model=get_model):
- if defaults is None:
- defaults = TestDefaults()
- if model is None:
- model = get_model(self._get_source(source), data_only=True,
- curdir=self._get_curdir(source))
- ErrorReporter(source).visit(model)
- SettingsBuilder(suite, defaults).visit(model)
- SuiteBuilder(suite, defaults).visit(model)
- suite.rpa = self._get_rpa_mode(model)
+ def parse_suite_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ model = get_model(
+ self._get_source(source),
+ data_only=True,
+ curdir=self._get_curdir(source),
+ lang=self.lang,
+ )
+ model.source = source
+ return self.parse_model(model, defaults)
+
+ def parse_init_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ model = get_init_model(
+ self._get_source(source),
+ data_only=True,
+ curdir=self._get_curdir(source),
+ lang=self.lang,
+ )
+ model.source = source
+ suite = TestSuite(
+ name=TestSuite.name_from_source(source.parent),
+ source=source.parent,
+ rpa=None,
+ )
+ SuiteBuilder(suite, InitFileSettings(defaults)).build(model)
+ return suite
+
+ def parse_model(
+ self,
+ model: File,
+ defaults: "TestDefaults|None" = None,
+ ) -> TestSuite:
+ name = TestSuite.name_from_source(model.source, self.extensions)
+ suite = TestSuite(name=name, source=model.source)
+ SuiteBuilder(suite, FileSettings(defaults)).build(model)
return suite
- def _get_curdir(self, source):
- if not self.process_curdir:
- return None
- return os.path.dirname(source).replace('\\', '\\\\')
+ def _get_curdir(self, source: Path) -> "str|None":
+ return str(source.parent).replace("\\", "\\\\") if self.process_curdir else None
- def _get_source(self, source):
+ def _get_source(self, source: Path) -> "Path|str":
return source
- def parse_resource_file(self, source):
- model = get_resource_model(self._get_source(source), data_only=True,
- curdir=self._get_curdir(source))
- resource = ResourceFile(source=source)
- ErrorReporter(source).visit(model)
- ResourceBuilder(resource).visit(model)
+ def parse_resource_file(self, source: Path) -> ResourceFile:
+ model = get_resource_model(
+ self._get_source(source),
+ data_only=True,
+ curdir=self._get_curdir(source),
+ lang=self.lang,
+ )
+ model.source = source
+ return self.parse_resource_model(model)
+
+ def parse_resource_model(self, model: File) -> ResourceFile:
+ resource = ResourceFile(source=model.source)
+ ResourceBuilder(resource).build(model)
return resource
- def _get_rpa_mode(self, data):
- if not data:
- return None
- tasks = [s.tasks for s in data.sections if hasattr(s, 'tasks')]
- if all(tasks) or not any(tasks):
- return tasks[0] if tasks else None
- raise DataError('One file cannot have both tests and tasks.')
-
class RestParser(RobotParser):
+ extensions = (".robot.rst", ".rst", ".rest")
- def _get_source(self, source):
+ def _get_source(self, source: Path) -> str:
with FileReader(source) as reader:
return read_rest_data(reader)
-class NoInitFileDirectoryParser(BaseParser):
-
- def parse_init_file(self, source, defaults=None):
- return TestSuite(name=format_name(source), source=source)
-
-
-def format_name(source):
- def strip_possible_prefix_from_name(name):
- result = name.split('__', 1)[-1]
- if result:
- return result
- return name
-
- def format_name(name):
- name = strip_possible_prefix_from_name(name)
- name = name.replace('_', ' ').strip()
- return name.title() if name.islower() else name
-
- if source is None:
- return None
- if os.path.isdir(source):
- basename = os.path.basename(source)
- else:
- basename = os.path.splitext(os.path.basename(source))[0]
- return format_name(basename)
-
-
-class ErrorReporter(NodeVisitor):
-
- def __init__(self, source):
- self.source = source
-
- def visit_Error(self, node):
- fatal = node.get_token(Token.FATAL_ERROR)
- if fatal:
- raise DataError(self._format_message(fatal))
- for error in node.get_tokens(Token.ERROR):
- LOGGER.error(self._format_message(error))
-
- def _format_message(self, token):
- return ("Error in file '%s' on line %s: %s"
- % (self.source, token.lineno, token.error))
+class JsonParser(Parser):
+
+ def parse_suite_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ return TestSuite.from_json(source)
+
+ def parse_init_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ return TestSuite.from_json(source)
+
+ def parse_resource_file(self, source: Path) -> ResourceFile:
+ try:
+ return ResourceFile.from_json(source)
+ except DataError as err:
+ raise DataError(f"Parsing JSON resource file '{source}' failed: {err}")
+
+
+class NoInitFileDirectoryParser(Parser):
+
+ def parse_init_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ return TestSuite(
+ name=TestSuite.name_from_source(source),
+ source=source,
+ rpa=None,
+ )
+
+
+class CustomParser(Parser):
+
+ def __init__(self, parser):
+ self.parser = parser
+ if not getattr(parser, "parse", None):
+ raise TypeError(f"'{self.name}' does not have mandatory 'parse' method.")
+ if not self.extensions:
+ raise TypeError(
+ f"'{self.name}' does not have mandatory 'EXTENSION' or 'extension' "
+ f"attribute."
+ )
+
+ @property
+ def name(self) -> str:
+ return type_name(self.parser)
+
+ @property
+ def extensions(self) -> "tuple[str, ...]":
+ ext = (
+ getattr(self.parser, "EXTENSION", None)
+ or getattr(self.parser, "extension", None)
+ ) # fmt: skip
+ extensions = [ext] if isinstance(ext, str) else list(ext or ())
+ return tuple(ext.lower().lstrip(".") for ext in extensions)
+
+ def parse_suite_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ return self._parse(self.parser.parse, source, defaults)
+
+ def parse_init_file(self, source: Path, defaults: TestDefaults) -> TestSuite:
+ parse_init = getattr(self.parser, "parse_init", None)
+ try:
+ return self._parse(parse_init, source, defaults, init=True)
+ except NotImplementedError:
+ return super().parse_init_file(source, defaults) # Raises DataError
+
+ def _parse(self, method, source, defaults, init=False) -> TestSuite:
+ if not method:
+ raise NotImplementedError
+ accepts_defaults = len(signature(method).parameters) == 2
+ try:
+ suite = method(source, defaults) if accepts_defaults else method(source)
+ if not isinstance(suite, TestSuite):
+ raise TypeError(
+ f"Return value should be 'robot.running.TestSuite', got "
+ f"'{type_name(suite)}'."
+ )
+ except Exception:
+ method_name = "parse" if not init else "parse_init"
+ raise DataError(
+ f"Calling '{self.name}.{method_name}()' failed: {get_error_message()}"
+ )
+ return suite
diff --git a/src/robot/running/builder/settings.py b/src/robot/running/builder/settings.py
new file mode 100644
index 00000000000..a617108deb6
--- /dev/null
+++ b/src/robot/running/builder/settings.py
@@ -0,0 +1,220 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from collections.abc import Sequence
+from typing import TypedDict
+
+from ..model import TestCase
+
+
+class OptionalItems(TypedDict, total=False):
+ args: "Sequence[str]"
+ lineno: int
+
+
+class FixtureDict(OptionalItems):
+ """Dictionary containing setup or teardown info.
+
+ :attr:`args` and :attr:`lineno` are optional.
+ """
+
+ name: str
+
+
+class TestDefaults:
+ """Represents default values for test related settings set in init files.
+
+ Parsers parsing suite files can read defaults and parsers parsing init
+ files can set them. The easiest way to set defaults to a test is using
+ the :meth:`set_to` method.
+
+ This class is part of the `public parser API`__. When implementing ``parse``
+ or ``parse_init`` method so that they accept two arguments, the second is
+ an instance of this class. If the class is needed as a type hint, it can
+ be imported via :mod:`robot.running` or :mod:`robot.api.interfaces`.
+
+ __ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#parser-interface
+ """
+
+ def __init__(
+ self,
+ parent: "TestDefaults|None" = None,
+ setup: "FixtureDict|None" = None,
+ teardown: "FixtureDict|None" = None,
+ tags: "Sequence[str]" = (),
+ timeout: "str|None" = None,
+ ):
+ self.parent = parent
+ self.setup = setup
+ self.teardown = teardown
+ self.tags = tags
+ self.timeout = timeout
+
+ @property
+ def setup(self) -> "FixtureDict|None":
+ """Default setup as a ``Keyword`` object or ``None`` when not set.
+
+ Can be set also using a dictionary.
+ """
+ if self._setup:
+ return self._setup
+ if self.parent:
+ return self.parent.setup
+ return None
+
+ @setup.setter
+ def setup(self, setup: "FixtureDict|None"):
+ self._setup = setup
+
+ @property
+ def teardown(self) -> "FixtureDict|None":
+ """Default teardown as a ``Keyword`` object or ``None`` when not set.
+
+ Can be set also using a dictionary.
+ """
+ if self._teardown:
+ return self._teardown
+ if self.parent:
+ return self.parent.teardown
+ return None
+
+ @teardown.setter
+ def teardown(self, teardown: "FixtureDict|None"):
+ self._teardown = teardown
+
+ @property
+ def tags(self) -> "tuple[str, ...]":
+ """Default tags. Can be set also as a sequence."""
+ return self._tags + self.parent.tags if self.parent else self._tags
+
+ @tags.setter
+ def tags(self, tags: "Sequence[str]"):
+ self._tags = tuple(tags)
+
+ @property
+ def timeout(self) -> "str|None":
+ """Default timeout."""
+ if self._timeout:
+ return self._timeout
+ if self.parent:
+ return self.parent.timeout
+ return None
+
+ @timeout.setter
+ def timeout(self, timeout: "str|None"):
+ self._timeout = timeout
+
+ def set_to(self, test: TestCase):
+ """Sets defaults to the given test.
+
+ Tags are always added to the test. Setup, teardown and timeout are
+ set only if the test does not have them set initially.
+ """
+ if self.tags:
+ test.tags += self.tags
+ if self.setup and not test.has_setup:
+ test.setup.config(**self.setup)
+ if self.teardown and not test.has_teardown:
+ test.teardown.config(**self.teardown)
+ if self.timeout and not test.timeout:
+ test.timeout = self.timeout
+
+
+class FileSettings:
+
+ def __init__(self, test_defaults: "TestDefaults|None" = None):
+ self.test_defaults = test_defaults or TestDefaults()
+ self.test_setup = None
+ self.test_teardown = None
+ self.test_tags = ()
+ self.test_timeout = None
+ self.test_template = None
+ self.default_tags = ()
+ self.keyword_tags = ()
+
+ @property
+ def test_setup(self) -> "FixtureDict|None":
+ return self._test_setup or self.test_defaults.setup
+
+ @test_setup.setter
+ def test_setup(self, setup: "FixtureDict|None"):
+ self._test_setup = setup
+
+ @property
+ def test_teardown(self) -> "FixtureDict|None":
+ return self._test_teardown or self.test_defaults.teardown
+
+ @test_teardown.setter
+ def test_teardown(self, teardown: "FixtureDict|None"):
+ self._test_teardown = teardown
+
+ @property
+ def test_tags(self) -> "tuple[str, ...]":
+ return self._test_tags + self.test_defaults.tags
+
+ @test_tags.setter
+ def test_tags(self, tags: "Sequence[str]"):
+ self._test_tags = tuple(tags)
+
+ @property
+ def test_timeout(self) -> "str|None":
+ return self._test_timeout or self.test_defaults.timeout
+
+ @test_timeout.setter
+ def test_timeout(self, timeout: "str|None"):
+ self._test_timeout = timeout
+
+ @property
+ def test_template(self) -> "str|None":
+ return self._test_template
+
+ @test_template.setter
+ def test_template(self, template: "str|None"):
+ self._test_template = template
+
+ @property
+ def default_tags(self) -> "tuple[str, ...]":
+ return self._default_tags
+
+ @default_tags.setter
+ def default_tags(self, tags: "Sequence[str]"):
+ self._default_tags = tuple(tags)
+
+ @property
+ def keyword_tags(self) -> "tuple[str, ...]":
+ return self._keyword_tags
+
+ @keyword_tags.setter
+ def keyword_tags(self, tags: "Sequence[str]"):
+ self._keyword_tags = tuple(tags)
+
+
+class InitFileSettings(FileSettings):
+
+ @FileSettings.test_setup.setter
+ def test_setup(self, setup: "FixtureDict|None"):
+ self.test_defaults.setup = setup
+
+ @FileSettings.test_teardown.setter
+ def test_teardown(self, teardown: "FixtureDict|None"):
+ self.test_defaults.teardown = teardown
+
+ @FileSettings.test_tags.setter
+ def test_tags(self, tags: "Sequence[str]"):
+ self.test_defaults.tags = tags
+
+ @FileSettings.test_timeout.setter
+ def test_timeout(self, timeout: "str|None"):
+ self.test_defaults.timeout = timeout
diff --git a/src/robot/running/builder/testsettings.py b/src/robot/running/builder/testsettings.py
deleted file mode 100644
index 403f85d3afd..00000000000
--- a/src/robot/running/builder/testsettings.py
+++ /dev/null
@@ -1,136 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-NOTSET = object()
-
-
-class TestDefaults:
-
- def __init__(self, parent=None):
- self.parent = parent
- self._setup = {}
- self._teardown = {}
- self._force_tags = ()
- self.default_tags = ()
- self.template = None
- self._timeout = None
-
- @property
- def setup(self):
- if self._setup:
- return self._setup
- if self.parent:
- return self.parent.setup
- return {}
-
- @setup.setter
- def setup(self, setup):
- self._setup = setup
-
- @property
- def teardown(self):
- if self._teardown:
- return self._teardown
- if self.parent:
- return self.parent.teardown
- return {}
-
- @teardown.setter
- def teardown(self, teardown):
- self._teardown = teardown
-
- @property
- def force_tags(self):
- parent_force_tags = self.parent.force_tags if self.parent else ()
- return self._force_tags + parent_force_tags
-
- @force_tags.setter
- def force_tags(self, force_tags):
- self._force_tags = force_tags
-
- @property
- def timeout(self):
- if self._timeout:
- return self._timeout
- if self.parent:
- return self.parent.timeout
- return None
-
- @timeout.setter
- def timeout(self, timeout):
- self._timeout = timeout
-
-
-class TestSettings:
-
- def __init__(self, defaults):
- self.defaults = defaults
- self._setup = NOTSET
- self._teardown = NOTSET
- self._timeout = NOTSET
- self._template = NOTSET
- self._tags = NOTSET
-
- @property
- def setup(self):
- if self._setup is NOTSET:
- return self.defaults.setup
- return self._setup
-
- @setup.setter
- def setup(self, setup):
- self._setup = setup
-
- @property
- def teardown(self):
- if self._teardown is NOTSET:
- return self.defaults.teardown
- return self._teardown
-
- @teardown.setter
- def teardown(self, teardown):
- self._teardown = teardown
-
- @property
- def timeout(self):
- if self._timeout is NOTSET:
- return self.defaults.timeout
- return self._timeout
-
- @timeout.setter
- def timeout(self, timeout):
- self._timeout = timeout
-
- @property
- def template(self):
- if self._template is NOTSET:
- return self.defaults.template
- return self._template
-
- @template.setter
- def template(self, template):
- self._template = template
-
- @property
- def tags(self):
- if self._tags is NOTSET:
- tags = self.defaults.default_tags
- else:
- tags = self._tags
- return tags + self.defaults.force_tags
-
- @tags.setter
- def tags(self, tags):
- self._tags = tags
diff --git a/src/robot/running/builder/transformers.py b/src/robot/running/builder/transformers.py
index 58efbdabb60..3a3a9578f9e 100644
--- a/src/robot/running/builder/transformers.py
+++ b/src/robot/running/builder/transformers.py
@@ -13,18 +13,22 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from ast import NodeVisitor
+from robot.errors import DataError
+from robot.output import LOGGER
+from robot.parsing import File, ModelVisitor, Token
+from robot.utils import NormalizedDict
+from robot.variables import VariableMatches
-from robot.variables import VariableIterator
+from ..model import For, Group, If, IfBranch, TestCase, TestSuite, Try, TryBranch, While
+from ..resourcemodel import ResourceFile, UserKeyword
+from .settings import FileSettings
-from .testsettings import TestSettings
+class SettingsBuilder(ModelVisitor):
-class SettingsBuilder(NodeVisitor):
-
- def __init__(self, suite, test_defaults):
+ def __init__(self, suite: TestSuite, settings: FileSettings):
self.suite = suite
- self.test_defaults = test_defaults
+ self.settings = settings
def visit_Documentation(self, node):
self.suite.doc = node.value
@@ -32,48 +36,66 @@ def visit_Documentation(self, node):
def visit_Metadata(self, node):
self.suite.metadata[node.name] = node.value
+ def visit_SuiteName(self, node):
+ self.suite.name = node.value
+
def visit_SuiteSetup(self, node):
- self.suite.setup.config(name=node.name, args=node.args,
- lineno=node.lineno)
+ self.suite.setup.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_SuiteTeardown(self, node):
- self.suite.teardown.config(name=node.name, args=node.args,
- lineno=node.lineno)
+ self.suite.teardown.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_TestSetup(self, node):
- self.test_defaults.setup = {
- 'name': node.name, 'args': node.args, 'lineno': node.lineno
+ self.settings.test_setup = {
+ "name": node.name,
+ "args": node.args,
+ "lineno": node.lineno,
}
def visit_TestTeardown(self, node):
- self.test_defaults.teardown = {
- 'name': node.name, 'args': node.args, 'lineno': node.lineno
+ self.settings.test_teardown = {
+ "name": node.name,
+ "args": node.args,
+ "lineno": node.lineno,
}
def visit_TestTimeout(self, node):
- self.test_defaults.timeout = node.value
+ self.settings.test_timeout = node.value
def visit_DefaultTags(self, node):
- self.test_defaults.default_tags = node.values
-
- def visit_ForceTags(self, node):
- self.test_defaults.force_tags = node.values
+ self.settings.default_tags = node.values
+
+ def visit_TestTags(self, node):
+ for tag in node.values:
+ if tag.startswith("-"):
+ LOGGER.warn(
+ f"Error in file '{self.suite.source}' on line {node.lineno}: "
+ f"Setting tags starting with a hyphen like '{tag}' using the "
+ f"'Test Tags' setting is deprecated. In Robot Framework 8.0 this "
+ f"syntax will be used for removing tags. Escape the tag like "
+ f"'\\{tag}' to use the literal value and to avoid this warning."
+ )
+ self.settings.test_tags = node.values
+
+ def visit_KeywordTags(self, node):
+ self.settings.keyword_tags = node.values
def visit_TestTemplate(self, node):
- self.test_defaults.template = node.value
-
- def visit_ResourceImport(self, node):
- self.suite.resource.imports.create(type='Resource', name=node.name,
- lineno=node.lineno)
+ self.settings.test_template = node.value
def visit_LibraryImport(self, node):
- self.suite.resource.imports.create(type='Library', name=node.name,
- args=node.args, alias=node.alias,
- lineno=node.lineno)
+ self.suite.resource.imports.library(
+ node.name,
+ node.args,
+ node.alias,
+ node.lineno,
+ )
+
+ def visit_ResourceImport(self, node):
+ self.suite.resource.imports.resource(node.name, node.lineno)
def visit_VariablesImport(self, node):
- self.suite.resource.imports.create(type='Variables', name=node.name,
- args=node.args, lineno=node.lineno)
+ self.suite.resource.imports.variables(node.name, node.args, node.lineno)
def visit_VariableSection(self, node):
pass
@@ -85,87 +107,195 @@ def visit_KeywordSection(self, node):
pass
-class SuiteBuilder(NodeVisitor):
+class SuiteBuilder(ModelVisitor):
- def __init__(self, suite, test_defaults):
+ def __init__(self, suite: TestSuite, settings: FileSettings):
self.suite = suite
- self.test_defaults = test_defaults
+ self.settings = settings
+ self.seen_keywords = NormalizedDict(ignore="_")
+ self.rpa = None
+
+ def build(self, model: File):
+ ErrorReporter(model.source).visit(model)
+ SettingsBuilder(self.suite, self.settings).visit(model)
+ self.visit(model)
+ if self.rpa is not None:
+ self.suite.rpa = self.rpa
def visit_SettingSection(self, node):
pass
def visit_Variable(self, node):
- self.suite.resource.variables.create(name=node.name,
- value=node.value,
- lineno=node.lineno,
- error=format_error(node.errors))
+ self.suite.resource.variables.create(
+ name=node.name,
+ value=node.value,
+ separator=node.separator,
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+ def visit_TestCaseSection(self, node):
+ if self.rpa is None:
+ self.rpa = node.tasks
+ elif self.rpa != node.tasks:
+ raise DataError("One file cannot have both tests and tasks.")
+ self.generic_visit(node)
def visit_TestCase(self, node):
- TestCaseBuilder(self.suite, self.test_defaults).visit(node)
+ TestCaseBuilder(self.suite, self.settings).build(node)
def visit_Keyword(self, node):
- KeywordBuilder(self.suite.resource).visit(node)
+ KeywordBuilder(
+ self.suite.resource,
+ self.settings,
+ self.seen_keywords,
+ ).build(node)
-class ResourceBuilder(NodeVisitor):
+class ResourceBuilder(ModelVisitor):
- def __init__(self, resource):
+ def __init__(self, resource: ResourceFile):
self.resource = resource
+ self.settings = FileSettings()
+ self.seen_keywords = NormalizedDict(ignore="_")
+
+ def build(self, model: File):
+ ErrorReporter(model.source, raise_on_invalid_header=True).visit(model)
+ self.visit(model)
def visit_Documentation(self, node):
self.resource.doc = node.value
+ def visit_KeywordTags(self, node):
+ self.settings.keyword_tags = node.values
+
def visit_LibraryImport(self, node):
- self.resource.imports.create(type='Library', name=node.name,
- args=node.args, alias=node.alias,
- lineno=node.lineno)
+ self.resource.imports.library(node.name, node.args, node.alias, node.lineno)
def visit_ResourceImport(self, node):
- self.resource.imports.create(type='Resource', name=node.name,
- lineno=node.lineno)
+ self.resource.imports.resource(node.name, node.lineno)
def visit_VariablesImport(self, node):
- self.resource.imports.create(type='Variables', name=node.name,
- args=node.args, lineno=node.lineno)
+ self.resource.imports.variables(node.name, node.args, node.lineno)
def visit_Variable(self, node):
- self.resource.variables.create(name=node.name,
- value=node.value,
- lineno=node.lineno,
- error=format_error(node.errors))
+ self.resource.variables.create(
+ name=node.name,
+ value=node.value,
+ separator=node.separator,
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
def visit_Keyword(self, node):
- KeywordBuilder(self.resource).visit(node)
+ KeywordBuilder(self.resource, self.settings, self.seen_keywords).build(node)
-class TestCaseBuilder(NodeVisitor):
+class BodyBuilder(ModelVisitor):
- def __init__(self, suite, defaults):
- self.suite = suite
- self.settings = TestSettings(defaults)
- self.test = None
+ def __init__(
+ self,
+ model: "TestCase|UserKeyword|For|If|Try|While|Group|None" = None,
+ ):
+ self.model = model
- def visit_TestCase(self, node):
- self.test = self.suite.tests.create(name=node.name, lineno=node.lineno)
+ def visit_For(self, node):
+ ForBuilder(self.model).build(node)
+
+ def visit_While(self, node):
+ WhileBuilder(self.model).build(node)
+
+ def visit_Group(self, node):
+ GroupBuilder(self.model).build(node)
+
+ def visit_If(self, node):
+ IfBuilder(self.model).build(node)
+
+ def visit_Try(self, node):
+ TryBuilder(self.model).build(node)
+
+ def visit_KeywordCall(self, node):
+ self.model.body.create_keyword(
+ name=node.keyword,
+ args=node.args,
+ assign=node.assign,
+ lineno=node.lineno,
+ )
+
+ def visit_TemplateArguments(self, node):
+ self.model.body.create_keyword(args=node.args, lineno=node.lineno)
+
+ def visit_Var(self, node):
+ self.model.body.create_var(
+ node.name,
+ node.value,
+ node.scope,
+ node.separator,
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+ def visit_Return(self, node):
+ self.model.body.create_return(
+ node.values,
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+ def visit_Continue(self, node):
+ self.model.body.create_continue(
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+ def visit_Break(self, node):
+ self.model.body.create_break(
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+ def visit_Error(self, node):
+ self.model.body.create_error(
+ node.values,
+ lineno=node.lineno,
+ error=format_error(node.errors),
+ )
+
+
+class TestCaseBuilder(BodyBuilder):
+ model: TestCase
+
+ def __init__(self, suite: TestSuite, settings: FileSettings):
+ super().__init__(suite.tests.create())
+ self.settings = settings
+ self._test_has_tags = False
+
+ def build(self, node):
+ settings = self.settings
+ # Possible parsing errors aren't reported further with tests because:
+ # - We only validate that test body or name isn't empty.
+ # - That is validated again during execution.
+ # - This way e.g. model modifiers can add content to body.
+ self.model.config(
+ name=node.name,
+ tags=settings.test_tags,
+ timeout=settings.test_timeout,
+ template=settings.test_template,
+ lineno=node.lineno,
+ )
+ if settings.test_setup:
+ self.model.setup.config(**settings.test_setup)
+ if settings.test_teardown:
+ self.model.teardown.config(**settings.test_teardown)
self.generic_visit(node)
- self._set_settings(self.test, self.settings)
-
- def _set_settings(self, test, settings):
- if settings.setup:
- test.setup.config(**settings.setup)
- if settings.teardown:
- test.teardown.config(**settings.teardown)
- if settings.timeout:
- test.timeout = settings.timeout
- if settings.tags:
- test.tags = settings.tags
- if settings.template:
- test.template = settings.template
- self._set_template(test, settings.template)
+ if not self._test_has_tags:
+ self.model.tags.add(settings.default_tags)
+ if self.model.template:
+ self._set_template(self.model, self.model.template)
def _set_template(self, parent, template):
for item in parent.body:
- if item.type == item.FOR:
+ if item.type in (item.FOR, item.GROUP):
self._set_template(item, template)
elif item.type == item.IF_ELSE_ROOT:
for branch in item.body:
@@ -176,146 +306,138 @@ def _set_template(self, parent, template):
item.args = args
def _format_template(self, template, arguments):
- variables = VariableIterator(template, identifiers='$')
- count = len(variables)
+ matches = VariableMatches(template, identifiers="$")
+ count = len(matches)
if count == 0 or count != len(arguments):
return template, arguments
temp = []
- for (before, _, after), arg in zip(variables, arguments):
- temp.extend([before, arg])
- temp.append(after)
- return ''.join(temp), ()
-
- def visit_For(self, node):
- ForBuilder(self.test).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.test).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.test).build(node)
-
- def visit_Try(self, node):
- TryBuilder(self.test).build(node)
-
- def visit_TemplateArguments(self, node):
- self.test.body.create_keyword(args=node.args, lineno=node.lineno)
+ for match, arg in zip(matches, arguments):
+ temp[-1:] = [match.before, arg, match.after]
+ return "".join(temp), ()
def visit_Documentation(self, node):
- self.test.doc = node.value
+ self.model.doc = node.value
def visit_Setup(self, node):
- self.settings.setup = {
- 'name': node.name, 'args': node.args, 'lineno': node.lineno
- }
+ self.model.setup.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_Teardown(self, node):
- self.settings.teardown = {
- 'name': node.name, 'args': node.args, 'lineno': node.lineno
- }
+ self.model.teardown.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_Timeout(self, node):
- self.settings.timeout = node.value
+ self.model.timeout = node.value
def visit_Tags(self, node):
- self.settings.tags = node.values
+ self.model.tags.add(node.values, remove_negated=True)
+ self._test_has_tags = True
def visit_Template(self, node):
- self.settings.template = node.value
-
- def visit_KeywordCall(self, node):
- self.test.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
+ self.model.template = node.value
- def visit_ReturnStatement(self, node):
- self.test.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
- def visit_Continue(self, node):
- self.test.body.create_continue(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Break(self, node):
- self.test.body.create_break(lineno=node.lineno,
- error=format_error(node.errors))
+class KeywordBuilder(BodyBuilder):
+ model: UserKeyword
-
-class KeywordBuilder(NodeVisitor):
-
- def __init__(self, resource):
+ def __init__(
+ self,
+ resource: ResourceFile,
+ settings: FileSettings,
+ seen_keywords: NormalizedDict,
+ ):
+ super().__init__(resource.keywords.create(tags=settings.keyword_tags))
self.resource = resource
- self.kw = None
- self.teardown = None
+ self.seen_keywords = seen_keywords
+ self.return_setting = None
- def visit_Keyword(self, node):
- self.kw = self.resource.keywords.create(name=node.name,
- lineno=node.lineno)
+ def build(self, node):
+ kw = self.model
+ try:
+ # Validate only name here. Reporting all parsing errors would report also
+ # body being empty, but we want to validate it only at parsing time.
+ if not node.name:
+ raise DataError("User keyword name cannot be empty.")
+ kw.config(name=node.name, lineno=node.lineno)
+ except DataError as err:
+ # Errors other than name being empty mean that name contains invalid
+ # embedded arguments. Need to set `_name` to bypass `@property`.
+ kw.config(_name=node.name, lineno=node.lineno, error=str(err))
+ self._report_error(node, err)
self.generic_visit(node)
- if self.teardown is not None:
- self.kw.teardown.config(**self.teardown)
+ if self.return_setting:
+ kw.body.create_return(self.return_setting)
+ if not kw.embedded:
+ self._handle_duplicates(kw, self.seen_keywords, node)
+
+ def _report_error(self, node, error):
+ error = f"Creating keyword '{self.model.name}' failed: {error}"
+ ErrorReporter(self.model.source).report_error(node, error)
+
+ def _handle_duplicates(self, kw, seen, node):
+ if kw.name in seen:
+ error = "Keyword with same name defined multiple times."
+ seen[kw.name].error = error
+ self.resource.keywords.pop()
+ self._report_error(node, error)
+ else:
+ seen[kw.name] = kw
def visit_Documentation(self, node):
- self.kw.doc = node.value
+ self.model.doc = node.value
def visit_Arguments(self, node):
- self.kw.args = node.values
if node.errors:
- self.kw.error = ('Invalid argument specification: %s'
- % format_error(node.errors))
+ error = "Invalid argument specification: " + format_error(node.errors)
+ self.model.error = error
+ self._report_error(node, error)
+ else:
+ self.model.args = node.values
def visit_Tags(self, node):
- self.kw.tags = node.values
+ for tag in node.values:
+ if tag.startswith("-"):
+ self.model.tags.remove(tag[1:])
+ else:
+ self.model.tags.add(tag)
- def visit_Return(self, node):
- self.kw.return_ = node.values
+ def visit_ReturnSetting(self, node):
+ ErrorReporter(self.model.source).visit(node)
+ self.return_setting = node.values
def visit_Timeout(self, node):
- self.kw.timeout = node.value
+ self.model.timeout = node.value
+
+ def visit_Setup(self, node):
+ self.model.setup.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_Teardown(self, node):
- self.teardown = {
- 'name': node.name, 'args': node.args, 'lineno': node.lineno
- }
+ self.model.teardown.config(name=node.name, args=node.args, lineno=node.lineno)
def visit_KeywordCall(self, node):
- self.kw.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
-
- def visit_ReturnStatement(self, node):
- self.kw.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Continue(self, node):
- self.kw.body.create_continue(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Break(self, node):
- self.kw.body.create_break(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_For(self, node):
- ForBuilder(self.kw).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.kw).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.kw).build(node)
-
- def visit_Try(self, node):
- TryBuilder(self.kw).build(node)
+ self.model.body.create_keyword(
+ name=node.keyword,
+ args=node.args,
+ assign=node.assign,
+ lineno=node.lineno,
+ )
-class ForBuilder(NodeVisitor):
+class ForBuilder(BodyBuilder):
+ model: For
- def __init__(self, parent):
- self.parent = parent
- self.model = None
+ def __init__(self, parent: "TestCase|UserKeyword|For|If|Try|While|Group"):
+ super().__init__(parent.body.create_for())
def build(self, node):
error = format_error(self._get_errors(node))
- self.model = self.parent.body.create_for(
- node.variables, node.flavor, node.values, lineno=node.lineno, error=error
+ self.model.config(
+ assign=node.assign,
+ flavor=node.flavor or "IN",
+ values=node.values,
+ start=node.start,
+ mode=node.mode,
+ fill=node.fill,
+ lineno=node.lineno,
+ error=error,
)
for step in node.body:
self.visit(step)
@@ -327,68 +449,40 @@ def _get_errors(self, node):
errors += node.end.errors
return errors
- def visit_KeywordCall(self, node):
- self.model.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
- def visit_TemplateArguments(self, node):
- self.model.body.create_keyword(args=node.args, lineno=node.lineno)
+class IfBuilder(BodyBuilder):
+ model: "IfBranch|None"
- def visit_For(self, node):
- ForBuilder(self.model).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.model).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.model).build(node)
-
- def visit_Try(self, node):
- TryBuilder(self.model).build(node)
-
- def visit_ReturnStatement(self, node):
- self.model.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Continue(self, node):
- self.model.body.create_continue(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Break(self, node):
- self.model.body.create_break(lineno=node.lineno,
- error=format_error(node.errors))
-
-
-class IfBuilder(NodeVisitor):
-
- def __init__(self, parent):
- self.parent = parent
- self.model = None
+ def __init__(self, parent: "TestCase|UserKeyword|For|If|Try|While|Group"):
+ super().__init__()
+ self.root = parent.body.create_if()
def build(self, node):
- root = self.parent.body.create_if(lineno=node.lineno,
- error=format_error(self._get_errors(node)))
+ self.root.config(lineno=node.lineno, error=format_error(self._get_errors(node)))
assign = node.assign
node_type = None
while node:
- node_type = node.type if node.type != 'INLINE IF' else 'IF'
- self.model = root.body.create_branch(node_type, node.condition,
- lineno=node.lineno)
+ node_type = node.type if node.type != "INLINE IF" else "IF"
+ self.model = self.root.body.create_branch(
+ node_type,
+ node.condition,
+ lineno=node.lineno,
+ )
for step in node.body:
self.visit(step)
if assign:
for item in self.model.body:
# Having assign when model item doesn't support assign is an error,
# but it has been handled already when model was validated.
- if hasattr(item, 'assign'):
+ if hasattr(item, "assign"):
item.assign = assign
node = node.orelse
# Smallish hack to make sure assignment is always run.
- if assign and node_type != 'ELSE':
- root.body.create_branch('ELSE').body.create_keyword(
- assign=assign, name='BuiltIn.Set Variable', args=['${NONE}']
+ if assign and node_type != "ELSE":
+ self.root.body.create_branch("ELSE").body.create_keyword(
+ assign=assign, name="BuiltIn.Set Variable", args=["${NONE}"]
)
- return root
+ return self.root
def _get_errors(self, node):
errors = node.header.errors + node.errors
@@ -398,60 +492,28 @@ def _get_errors(self, node):
errors += node.end.errors
return errors
- def visit_KeywordCall(self, node):
- self.model.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
- def visit_TemplateArguments(self, node):
- self.model.body.create_keyword(args=node.args, lineno=node.lineno)
+class TryBuilder(BodyBuilder):
+ model: "TryBranch|None"
- def visit_For(self, node):
- ForBuilder(self.model).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.model).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.model).build(node)
-
- def visit_Try(self, node):
- TryBuilder(self.model).build(node)
-
- def visit_ReturnStatement(self, node):
- self.model.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Continue(self, node):
- self.model.body.create_continue(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_Break(self, node):
- self.model.body.create_break(lineno=node.lineno,
- error=format_error(node.errors))
-
-
-class TryBuilder(NodeVisitor):
-
- def __init__(self, parent):
- self.parent = parent
- self.model = None
- self.template_error = None
+ def __init__(self, parent: "TestCase|UserKeyword|For|If|Try|While|Group"):
+ super().__init__()
+ self.root = parent.body.create_try()
def build(self, node):
- root = self.parent.body.create_try(lineno=node.lineno)
- errors = self._get_errors(node)
+ self.root.config(lineno=node.lineno, error=format_error(self._get_errors(node)))
while node:
- self.model = root.body.create_branch(node.type, node.patterns,
- node.pattern_type, node.variable,
- lineno=node.lineno)
+ self.model = self.root.body.create_branch(
+ node.type,
+ node.patterns,
+ node.pattern_type,
+ node.assign,
+ lineno=node.lineno,
+ )
for step in node.body:
self.visit(step)
node = node.next
- if self.template_error:
- errors += (self.template_error,)
- if errors:
- root.error = format_error(errors)
- return root
+ return self.root
def _get_errors(self, node):
errors = node.header.errors + node.errors
@@ -461,49 +523,42 @@ def _get_errors(self, node):
errors += node.end.errors
return errors
- def visit_For(self, node):
- ForBuilder(self.model).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.model).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.model).build(node)
-
- def visit_Try(self, node):
- TryBuilder(self.model).build(node)
- def visit_ReturnStatement(self, node):
- self.model.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
+class WhileBuilder(BodyBuilder):
+ model: While
- def visit_Continue(self, node):
- self.model.body.create_continue(lineno=node.lineno,
- error=format_error(node.errors))
+ def __init__(self, parent: "TestCase|UserKeyword|For|If|Try|While|Group"):
+ super().__init__(parent.body.create_while())
- def visit_Break(self, node):
- self.model.body.create_break(lineno=node.lineno,
- error=format_error(node.errors))
-
- def visit_KeywordCall(self, node):
- self.model.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
+ def build(self, node):
+ self.model.config(
+ condition=node.condition,
+ limit=node.limit,
+ on_limit=node.on_limit,
+ on_limit_message=node.on_limit_message,
+ lineno=node.lineno,
+ error=format_error(self._get_errors(node)),
+ )
+ for step in node.body:
+ self.visit(step)
+ return self.model
- def visit_TemplateArguments(self, node):
- self.template_error = 'Templates cannot be used with TRY.'
+ def _get_errors(self, node):
+ errors = node.header.errors + node.errors
+ if node.end:
+ errors += node.end.errors
+ return errors
-class WhileBuilder(NodeVisitor):
+class GroupBuilder(BodyBuilder):
+ model: Group
- def __init__(self, parent):
- self.parent = parent
- self.model = None
+ def __init__(self, parent: "TestCase|UserKeyword|For|If|Try|While|Group"):
+ super().__init__(parent.body.create_group())
def build(self, node):
error = format_error(self._get_errors(node))
- self.model = self.parent.body.create_while(
- node.condition, node.limit, lineno=node.lineno, error=error
- )
+ self.model.config(name=node.name, lineno=node.lineno, error=error)
for step in node.body:
self.visit(step)
return self.model
@@ -514,39 +569,55 @@ def _get_errors(self, node):
errors += node.end.errors
return errors
- def visit_KeywordCall(self, node):
- self.model.body.create_keyword(name=node.keyword, args=node.args,
- assign=node.assign, lineno=node.lineno)
-
- def visit_TemplateArguments(self, node):
- self.model.body.create_keyword(args=node.args, lineno=node.lineno)
- def visit_For(self, node):
- ForBuilder(self.model).build(node)
-
- def visit_While(self, node):
- WhileBuilder(self.model).build(node)
-
- def visit_If(self, node):
- IfBuilder(self.model).build(node)
+def format_error(errors):
+ if not errors:
+ return None
+ if len(errors) == 1:
+ return errors[0]
+ return "\n- ".join(["Multiple errors:", *errors])
- def visit_Try(self, node):
- TryBuilder(self.model).build(node)
- def visit_ReturnStatement(self, node):
- self.model.body.create_return(node.values, lineno=node.lineno,
- error=format_error(node.errors))
+class ErrorReporter(ModelVisitor):
- def visit_Break(self, node):
- self.model.body.create_break(error=format_error(node.errors))
+ def __init__(self, source, raise_on_invalid_header=False):
+ self.source = source
+ self.raise_on_invalid_header = raise_on_invalid_header
- def visit_Continue(self, node):
- self.model.body.create_continue(error=format_error(node.errors))
+ def visit_TestCase(self, node):
+ pass
+ def visit_Keyword(self, node):
+ pass
-def format_error(errors):
- if not errors:
- return None
- if len(errors) == 1:
- return errors[0]
- return '\n- '.join(('Multiple errors:',) + errors)
+ def visit_ReturnSetting(self, node):
+ # Empty 'visit_Keyword' above prevents calling this when visiting the whole
+ # model, but 'KeywordBuilder.visit_ReturnSetting' visits the node it gets.
+ self.report_error(node.get_token(Token.RETURN_SETTING), warn=True)
+
+ def visit_SectionHeader(self, node):
+ token = node.get_token(*Token.HEADER_TOKENS)
+ if not token.error:
+ return
+ if token.type == Token.INVALID_HEADER:
+ self.report_error(token, throw=self.raise_on_invalid_header)
+ else:
+ # Errors, other than totally invalid headers, can occur only with
+ # deprecated singular headers, and we want to report them as warnings.
+ # A more generic solution for separating errors and warnings would be good.
+ self.report_error(token, warn=True)
+
+ def visit_Error(self, node):
+ for token in node.get_tokens(Token.ERROR):
+ self.report_error(token)
+
+ def report_error(self, source, error=None, warn=False, throw=False):
+ if not error:
+ if isinstance(source, Token):
+ error = source.error
+ else:
+ error = format_error(source.errors)
+ message = f"Error in file '{self.source}' on line {source.lineno}: {error}"
+ if throw:
+ raise DataError(message)
+ LOGGER.write(message, level="WARN" if warn else "ERROR")
diff --git a/src/robot/running/context.py b/src/robot/running/context.py
index 67d52b1bf68..bf2938b5198 100644
--- a/src/robot/running/context.py
+++ b/src/robot/running/context.py
@@ -13,15 +13,60 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import asyncio
+import inspect
+import sys
from contextlib import contextmanager
-from robot.errors import DataError
+from robot.errors import DataError, ExecutionFailed
+
+
+class Asynchronous:
+
+ def __init__(self):
+ self._loop_ref = None
+
+ @property
+ def event_loop(self):
+ if self._loop_ref is None:
+ self._loop_ref = asyncio.new_event_loop()
+ return self._loop_ref
+
+ def close_loop(self):
+ if self._loop_ref:
+ self._loop_ref.close()
+ self._loop_ref = None
+
+ def run_until_complete(self, coroutine):
+ task = self.event_loop.create_task(coroutine)
+ try:
+ return self.event_loop.run_until_complete(task)
+ except ExecutionFailed as err:
+ if err.dont_continue:
+ task.cancel()
+ # Wait for task and its children to cancel.
+ self.event_loop.run_until_complete(
+ asyncio.gather(task, return_exceptions=True)
+ )
+ raise err
+
+ def is_loop_required(self, obj):
+ return inspect.iscoroutine(obj) and not self._is_loop_running()
+
+ def _is_loop_running(self):
+ try:
+ asyncio.get_running_loop()
+ except RuntimeError:
+ return False
+ else:
+ return True
class ExecutionContexts:
def __init__(self):
self._contexts = []
+ self._asynchronous = Asynchronous()
@property
def current(self):
@@ -39,12 +84,14 @@ def namespaces(self):
return (context.namespace for context in self)
def start_suite(self, suite, namespace, output, dry_run=False):
- ctx = _ExecutionContext(suite, namespace, output, dry_run)
+ ctx = _ExecutionContext(suite, namespace, output, dry_run, self._asynchronous)
self._contexts.append(ctx)
return ctx
def end_suite(self):
self._contexts.pop()
+ if not self._contexts:
+ self._asynchronous.close_loop()
# This is ugly but currently needed e.g. by BuiltIn
@@ -52,22 +99,26 @@ def end_suite(self):
class _ExecutionContext:
- _started_keywords_threshold = 100
- def __init__(self, suite, namespace, output, dry_run=False):
+ def __init__(self, suite, namespace, output, dry_run=False, asynchronous=None):
self.suite = suite
self.test = None
- self.timeouts = set()
+ self.timeouts = []
+ self.active_timeouts = []
self.namespace = namespace
self.output = output
self.dry_run = dry_run
self.in_suite_teardown = False
self.in_test_teardown = False
self.in_keyword_teardown = 0
- self._started_keywords = 0
self.timeout_occurred = False
+ self.steps = []
self.user_keywords = []
- self.step_types = []
+ self.asynchronous = asynchronous
+
+ @property
+ def languages(self):
+ return self.namespace.languages
@contextmanager
def suite_teardown(self):
@@ -79,10 +130,10 @@ def suite_teardown(self):
@contextmanager
def test_teardown(self, test):
- self.variables.set_test('${TEST_STATUS}', test.status)
- self.variables.set_test('${TEST_MESSAGE}', test.message)
+ self.variables.set_test("${TEST_STATUS}", test.status)
+ self.variables.set_test("${TEST_MESSAGE}", test.message)
self.in_test_teardown = True
- self._remove_timeout(test.timeout)
+ self.timeouts = [] # Clear current timeouts.
try:
yield
finally:
@@ -90,13 +141,15 @@ def test_teardown(self, test):
@contextmanager
def keyword_teardown(self, error):
- self.variables.set_keyword('${KEYWORD_STATUS}', 'FAIL' if error else 'PASS')
- self.variables.set_keyword('${KEYWORD_MESSAGE}', str(error or ''))
+ self.variables.set_keyword("${KEYWORD_STATUS}", "FAIL" if error else "PASS")
+ self.variables.set_keyword("${KEYWORD_MESSAGE}", str(error or ""))
self.in_keyword_teardown += 1
+ self.timeouts, timeouts = [], self.timeouts # Disable current timeouts.
try:
yield
finally:
self.in_keyword_teardown -= 1
+ self.timeouts = timeouts
@contextmanager
def user_keyword(self, handler):
@@ -108,73 +161,121 @@ def user_keyword(self, handler):
self.namespace.end_user_keyword()
self.user_keywords.pop()
+ def warn_on_invalid_private_call(self, handler):
+ parent = self.user_keywords[-1] if self.user_keywords else None
+ if not parent or parent.source != handler.source:
+ self.warn(
+ f"Keyword '{handler.full_name}' is private and should only "
+ f"be called by keywords in the same file."
+ )
+
@contextmanager
- def timeout(self, timeout):
+ def keyword_timeout(self, timeout):
self._add_timeout(timeout)
try:
yield
finally:
self._remove_timeout(timeout)
+ @contextmanager
+ def timeout(self, timeout):
+ runner = timeout.get_runner()
+ self.active_timeouts.append(runner)
+ with self.output.delayed_logging:
+ self.output.debug(timeout.get_message)
+ try:
+ yield runner
+ finally:
+ self.active_timeouts.pop()
+
+ @property
+ @contextmanager
+ def paused_timeouts(self):
+ if not self.active_timeouts:
+ yield
+ return
+ for runner in self.active_timeouts:
+ runner.pause()
+ with self.output.delayed_logging_paused:
+ try:
+ yield
+ finally:
+ for runner in self.active_timeouts:
+ runner.resume()
+
@property
def in_teardown(self):
- return bool(self.in_suite_teardown or
- self.in_test_teardown or
- self.in_keyword_teardown)
+ return bool(
+ self.in_suite_teardown or self.in_test_teardown or self.in_keyword_teardown
+ )
@property
def variables(self):
return self.namespace.variables
- @property
- def continue_on_failure(self):
- parents = ([self.test] if self.test else []) + self.user_keywords
- if not parents:
- return False
- if 'robot:continue-on-failure' in parents[-1].tags:
- return True
- return any('robot:recursive-continue-on-failure' in p.tags for p in parents)
+ def continue_on_failure(self, default=False):
+ parents = [
+ result
+ for _, result, implementation in reversed(self.steps)
+ if implementation and implementation.type == "USER KEYWORD"
+ ]
+ if self.test:
+ parents.append(self.test)
+ for index, parent in enumerate(parents):
+ robot = parent.tags.robot
+ if index == 0 and robot("stop-on-failure"):
+ return False
+ if index == 0 and robot("continue-on-failure"):
+ return True
+ if robot("recursive-stop-on-failure"):
+ return False
+ if robot("recursive-continue-on-failure"):
+ return True
+ return default or self.in_teardown
@property
def allow_loop_control(self):
- for typ in reversed(self.step_types):
- if typ == 'ITERATION':
+ for _, result, _ in reversed(self.steps):
+ if result.type == "ITERATION":
return True
- if typ == 'KEYWORD':
+ if result.type == "KEYWORD" and result.owner != "BuiltIn":
return False
return False
- def end_suite(self, suite):
- for name in ['${PREV_TEST_NAME}',
- '${PREV_TEST_STATUS}',
- '${PREV_TEST_MESSAGE}']:
+ def end_suite(self, data, result):
+ for name in [
+ "${PREV_TEST_NAME}",
+ "${PREV_TEST_STATUS}",
+ "${PREV_TEST_MESSAGE}",
+ ]:
self.variables.set_global(name, self.variables[name])
- self.output.end_suite(suite)
- self.namespace.end_suite(suite)
+ self.output.end_suite(data, result)
+ self.namespace.end_suite(data)
EXECUTION_CONTEXTS.end_suite()
def set_suite_variables(self, suite):
- self.variables['${SUITE_NAME}'] = suite.longname
- self.variables['${SUITE_SOURCE}'] = suite.source or ''
- self.variables['${SUITE_DOCUMENTATION}'] = suite.doc
- self.variables['${SUITE_METADATA}'] = suite.metadata.copy()
+ self.variables["${SUITE_NAME}"] = suite.full_name
+ self.variables["${SUITE_SOURCE}"] = str(suite.source or "")
+ self.variables["${SUITE_DOCUMENTATION}"] = suite.doc
+ self.variables["${SUITE_METADATA}"] = suite.metadata.copy()
def report_suite_status(self, status, message):
- self.variables['${SUITE_STATUS}'] = status
- self.variables['${SUITE_MESSAGE}'] = message
+ self.variables["${SUITE_STATUS}"] = status
+ self.variables["${SUITE_MESSAGE}"] = message
- def start_test(self, test):
- self.test = test
- self._add_timeout(test.timeout)
+ def start_test(self, data, result):
+ self.test = result
+ self._add_timeout(result.timeout)
self.namespace.start_test()
- self.variables.set_test('${TEST_NAME}', test.name)
- self.variables.set_test('${TEST_DOCUMENTATION}', test.doc)
- self.variables.set_test('@{TEST_TAGS}', list(test.tags))
+ self.variables.set_test("${TEST_NAME}", result.name)
+ self.variables.set_test("${TEST_DOCUMENTATION}", result.doc)
+ self.variables.set_test("@{TEST_TAGS}", list(result.tags))
+ self.output.start_test(data, result)
def _add_timeout(self, timeout):
if timeout:
timeout.start()
- self.timeouts.add(timeout)
+ self.timeouts.append(timeout)
def _remove_timeout(self, timeout):
if timeout in self.timeouts:
@@ -182,30 +283,104 @@ def _remove_timeout(self, timeout):
def end_test(self, test):
self.test = None
- self._remove_timeout(test.timeout)
+ self.timeouts = []
self.namespace.end_test()
- self.variables.set_suite('${PREV_TEST_NAME}', test.name)
- self.variables.set_suite('${PREV_TEST_STATUS}', test.status)
- self.variables.set_suite('${PREV_TEST_MESSAGE}', test.message)
+ self.variables.set_suite("${PREV_TEST_NAME}", test.name)
+ self.variables.set_suite("${PREV_TEST_STATUS}", test.status)
+ self.variables.set_suite("${PREV_TEST_MESSAGE}", test.message)
self.timeout_occurred = False
- def start_keyword(self, keyword):
- self._started_keywords += 1
- if self._started_keywords > self._started_keywords_threshold:
- raise DataError('Maximum limit of started keywords and control '
- 'structures exceeded.')
- self.output.start_keyword(keyword)
- if keyword.libname != 'BuiltIn':
- self.step_types.append(keyword.type)
-
- def end_keyword(self, keyword):
- self.output.end_keyword(keyword)
- self._started_keywords -= 1
- if keyword.libname != 'BuiltIn':
- self.step_types.pop()
-
- def get_runner(self, name):
- return self.namespace.get_runner(name)
+ def start_body_item(self, data, result, implementation=None):
+ self._prevent_execution_close_to_recursion_limit()
+ self.steps.append((data, result, implementation))
+ output = self.output
+ args = (data, result)
+ if implementation:
+ if implementation.error:
+ method = output.start_invalid_keyword
+ elif implementation.type == implementation.LIBRARY_KEYWORD:
+ method = output.start_library_keyword
+ else:
+ method = output.start_user_keyword
+ args = (data, implementation, result)
+ elif result.type in (result.ELSE, result.ITERATION):
+ method = {
+ result.IF_ELSE_ROOT: output.start_if_branch,
+ result.TRY_EXCEPT_ROOT: output.start_try_branch,
+ result.FOR: output.start_for_iteration,
+ result.WHILE: output.start_while_iteration,
+ }[result.parent.type]
+ else:
+ method = {
+ result.FOR: output.start_for,
+ result.WHILE: output.start_while,
+ result.GROUP: output.start_group,
+ result.IF_ELSE_ROOT: output.start_if,
+ result.IF: output.start_if_branch,
+ result.ELSE: output.start_if_branch,
+ result.ELSE_IF: output.start_if_branch,
+ result.TRY_EXCEPT_ROOT: output.start_try,
+ result.TRY: output.start_try_branch,
+ result.EXCEPT: output.start_try_branch,
+ result.FINALLY: output.start_try_branch,
+ result.VAR: output.start_var,
+ result.BREAK: output.start_break,
+ result.CONTINUE: output.start_continue,
+ result.RETURN: output.start_return,
+ result.ERROR: output.start_error,
+ }[result.type]
+ method(*args)
+
+ def _prevent_execution_close_to_recursion_limit(self):
+ try:
+ sys._getframe(sys.getrecursionlimit() - 100)
+ except (ValueError, AttributeError):
+ pass
+ else:
+ raise DataError("Recursive execution stopped.")
+
+ def end_body_item(self, data, result, implementation=None):
+ output = self.output
+ args = (data, result)
+ if implementation:
+ if implementation.error:
+ method = output.end_invalid_keyword
+ elif implementation.type == implementation.LIBRARY_KEYWORD:
+ method = output.end_library_keyword
+ else:
+ method = output.end_user_keyword
+ args = (data, implementation, result)
+ elif result.type in (result.ELSE, result.ITERATION):
+ method = {
+ result.IF_ELSE_ROOT: output.end_if_branch,
+ result.TRY_EXCEPT_ROOT: output.end_try_branch,
+ result.FOR: output.end_for_iteration,
+ result.WHILE: output.end_while_iteration,
+ }[result.parent.type]
+ else:
+ method = {
+ result.FOR: output.end_for,
+ result.WHILE: output.end_while,
+ result.GROUP: output.end_group,
+ result.IF_ELSE_ROOT: output.end_if,
+ result.IF: output.end_if_branch,
+ result.ELSE: output.end_if_branch,
+ result.ELSE_IF: output.end_if_branch,
+ result.TRY_EXCEPT_ROOT: output.end_try,
+ result.TRY: output.end_try_branch,
+ result.EXCEPT: output.end_try_branch,
+ result.FINALLY: output.end_try_branch,
+ result.VAR: output.end_var,
+ result.BREAK: output.end_break,
+ result.CONTINUE: output.end_continue,
+ result.RETURN: output.end_return,
+ result.ERROR: output.end_error,
+ }[result.type]
+ method(*args)
+ self.steps.pop()
+
+ def get_runner(self, name, recommend_on_failure=True):
+ return self.namespace.get_runner(name, recommend_on_failure)
def trace(self, message):
self.output.trace(message)
diff --git a/src/robot/running/dynamicmethods.py b/src/robot/running/dynamicmethods.py
index aa5f30a1fe4..ff42ae130b2 100644
--- a/src/robot/running/dynamicmethods.py
+++ b/src/robot/running/dynamicmethods.py
@@ -14,59 +14,65 @@
# limitations under the License.
from robot.errors import DataError
-from robot.utils import get_error_message, is_bytes, is_list_like, is_string, type_name
+from robot.utils import get_error_message, is_list_like, type_name
from .arguments import PythonArgumentParser
+from .context import EXECUTION_CONTEXTS
def no_dynamic_method(*args):
return None
-class _DynamicMethod:
+class DynamicMethod:
_underscore_name = NotImplemented
- def __init__(self, lib):
- self.method = self._get_method(lib)
+ def __init__(self, instance):
+ self.instance = instance
+ self.method = self._get_method(instance)
- def _get_method(self, lib):
+ def _get_method(self, instance):
for name in self._underscore_name, self._camelCaseName:
- method = getattr(lib, name, None)
+ method = getattr(instance, name, None)
if callable(method):
return method
return no_dynamic_method
@property
def _camelCaseName(self):
- tokens = self._underscore_name.split('_')
- return ''.join([tokens[0]] + [t.capitalize() for t in tokens[1:]])
+ tokens = self._underscore_name.split("_")
+ return "".join([tokens[0]] + [t.capitalize() for t in tokens[1:]])
@property
def name(self):
return self.method.__name__
- def __call__(self, *args):
+ def __call__(self, *args, **kwargs):
try:
- return self._handle_return_value(self.method(*args))
- except:
- raise DataError("Calling dynamic method '%s' failed: %s"
- % (self.name, get_error_message()))
+ ctx = EXECUTION_CONTEXTS.current
+ result = self.method(*args, **kwargs)
+ if ctx and ctx.asynchronous.is_loop_required(result):
+ result = ctx.asynchronous.run_until_complete(result)
+ return self._handle_return_value(result)
+ except Exception:
+ raise DataError(
+ f"Calling dynamic method '{self.name}' failed: {get_error_message()}"
+ )
def _handle_return_value(self, value):
raise NotImplementedError
def _to_string(self, value, allow_tuple=False, allow_none=False):
- if is_string(value):
+ if isinstance(value, str):
return value
- if is_bytes(value):
- return value.decode('UTF-8')
+ if isinstance(value, bytes):
+ return value.decode("UTF-8")
if allow_tuple and is_list_like(value) and len(value) > 0:
return tuple(value)
if allow_none and value is None:
return value
- or_tuple = ' or a non-empty tuple' if allow_tuple else ''
- raise DataError('Return value must be a string%s, got %s.'
- % (or_tuple, type_name(value)))
+ allowed = "a string or a non-empty tuple" if allow_tuple else "a string"
+ raise DataError(f"Return value must be {allowed}, got {type_name(value)}.")
def _to_list(self, value):
if value is None:
@@ -77,18 +83,21 @@ def _to_list(self, value):
def _to_list_of_strings(self, value, allow_tuples=False):
try:
- return [self._to_string(item, allow_tuples)
- for item in self._to_list(value)]
+ return [
+ self._to_string(item, allow_tuples) for item in self._to_list(value)
+ ]
except DataError:
- raise DataError('Return value must be a list of strings%s.'
- % (' or non-empty tuples' if allow_tuples else ''))
+ allowed = "strings or non-empty tuples" if allow_tuples else "strings"
+ raise DataError(
+ f"Return value must be a list of {allowed}, got {type_name(value)}."
+ )
def __bool__(self):
return self.method is not no_dynamic_method
-class GetKeywordNames(_DynamicMethod):
- _underscore_name = 'get_keyword_names'
+class GetKeywordNames(DynamicMethod):
+ _underscore_name = "get_keyword_names"
def _handle_return_value(self, value):
names = self._to_list_of_strings(value)
@@ -102,53 +111,81 @@ def _remove_duplicates(self, names):
yield name
-class RunKeyword(_DynamicMethod):
- _underscore_name = 'run_keyword'
-
- @property
- def supports_kwargs(self):
- spec = PythonArgumentParser().parse(self.method)
- return len(spec.positional) == 3
+class RunKeyword(DynamicMethod):
+ _underscore_name = "run_keyword"
+ def __init__(
+ self,
+ instance,
+ keyword_name: "str|None" = None,
+ supports_named_args: "bool|None" = None,
+ ):
+ super().__init__(instance)
+ self.keyword_name = keyword_name
+ self._supports_named_args = supports_named_args
-class GetKeywordDocumentation(_DynamicMethod):
- _underscore_name = 'get_keyword_documentation'
+ @property
+ def supports_named_args(self) -> bool:
+ if self._supports_named_args is None:
+ spec = PythonArgumentParser().parse(self.method)
+ self._supports_named_args = len(spec.positional) == 3
+ return self._supports_named_args
+
+ def __call__(self, *positional, **named):
+ if self.supports_named_args:
+ args = (self.keyword_name, positional, named)
+ elif named:
+ # This should never happen.
+ raise ValueError(
+ f"'named' should not be used when named-argument support is "
+ f"not enabled, got {named}."
+ )
+ else:
+ args = (self.keyword_name, positional)
+ return self.method(*args)
+
+
+class GetKeywordDocumentation(DynamicMethod):
+ _underscore_name = "get_keyword_documentation"
def _handle_return_value(self, value):
- return self._to_string(value or '')
+ return self._to_string(value or "")
-class GetKeywordArguments(_DynamicMethod):
- _underscore_name = 'get_keyword_arguments'
+class GetKeywordArguments(DynamicMethod):
+ _underscore_name = "get_keyword_arguments"
- def __init__(self, lib):
- _DynamicMethod.__init__(self, lib)
- self._supports_kwargs = RunKeyword(lib).supports_kwargs
+ def __init__(self, instance, supports_named_args: "bool|None" = None):
+ super().__init__(instance)
+ if supports_named_args is None:
+ self.supports_named_args = RunKeyword(instance).supports_named_args
+ else:
+ self.supports_named_args = supports_named_args
def _handle_return_value(self, value):
if value is None:
- if self._supports_kwargs:
- return ['*varargs', '**kwargs']
- return ['*varargs']
+ if self.supports_named_args:
+ return ["*varargs", "**kwargs"]
+ return ["*varargs"]
return self._to_list_of_strings(value, allow_tuples=True)
-class GetKeywordTypes(_DynamicMethod):
- _underscore_name = 'get_keyword_types'
+class GetKeywordTypes(DynamicMethod):
+ _underscore_name = "get_keyword_types"
def _handle_return_value(self, value):
return value if self else {}
-class GetKeywordTags(_DynamicMethod):
- _underscore_name = 'get_keyword_tags'
+class GetKeywordTags(DynamicMethod):
+ _underscore_name = "get_keyword_tags"
def _handle_return_value(self, value):
return self._to_list_of_strings(value)
-class GetKeywordSource(_DynamicMethod):
- _underscore_name = 'get_keyword_source'
+class GetKeywordSource(DynamicMethod):
+ _underscore_name = "get_keyword_source"
def _handle_return_value(self, value):
return self._to_string(value, allow_none=True)
diff --git a/src/robot/running/handlers.py b/src/robot/running/handlers.py
deleted file mode 100644
index 687f022825b..00000000000
--- a/src/robot/running/handlers.py
+++ /dev/null
@@ -1,318 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from copy import copy
-import inspect
-
-from robot.utils import (getdoc, getshortdoc, is_list_like, normpath, printable_name,
- split_tags_from_doc, type_name)
-from robot.errors import DataError
-from robot.model import Tags
-
-from .arguments import ArgumentSpec, DynamicArgumentParser, PythonArgumentParser
-from .dynamicmethods import GetKeywordSource, GetKeywordTypes
-from .librarykeywordrunner import (EmbeddedArgumentsRunner,
- LibraryKeywordRunner, RunKeywordRunner)
-from .runkwregister import RUN_KW_REGISTER
-
-
-def Handler(library, name, method):
- if RUN_KW_REGISTER.is_run_keyword(library.orig_name, name):
- return _RunKeywordHandler(library, name, method)
- return _PythonHandler(library, name, method)
-
-
-def DynamicHandler(library, name, method, doc, argspec, tags=None):
- if RUN_KW_REGISTER.is_run_keyword(library.orig_name, name):
- return _DynamicRunKeywordHandler(library, name, method, doc, argspec, tags)
- return _DynamicHandler(library, name, method, doc, argspec, tags)
-
-
-def InitHandler(library, method=None, docgetter=None):
- return _PythonInitHandler(library, '__init__', method, docgetter)
-
-
-class _RunnableHandler:
-
- def __init__(self, library, handler_name, handler_method, doc='', tags=None):
- self.library = library
- self._handler_name = handler_name
- self.name = self._get_name(handler_name, handler_method)
- self.arguments = self._parse_arguments(handler_method)
- self._method = self._get_initial_handler(library, handler_name,
- handler_method)
- doc, tags_from_doc = split_tags_from_doc(doc or '')
- tags_from_attr = self._get_tags_from_attribute(handler_method)
- self._doc = doc
- self.tags = Tags(tuple(tags_from_doc) +
- tuple(tags_from_attr) +
- tuple(tags or ()))
-
- def _get_name(self, handler_name, handler_method):
- robot_name = getattr(handler_method, 'robot_name', None)
- name = robot_name or printable_name(handler_name, code_style=True)
- if not name:
- raise DataError('Keyword name cannot be empty.')
- return name
-
- def _parse_arguments(self, handler_method):
- raise NotImplementedError
-
- def _get_tags_from_attribute(self, handler_method):
- tags = getattr(handler_method, 'robot_tags', ())
- if not is_list_like(tags):
- raise DataError("Expected tags to be list-like, got %s."
- % type_name(tags))
- return tags
-
- def _get_initial_handler(self, library, name, method):
- if library.scope.is_global:
- return self._get_global_handler(method, name)
- return None
-
- def resolve_arguments(self, args, variables=None):
- return self.arguments.resolve(args, variables, self.library.converters)
-
- @property
- def doc(self):
- return self._doc
-
- @property
- def longname(self):
- return '%s.%s' % (self.library.name, self.name)
-
- @property
- def shortdoc(self):
- return getshortdoc(self.doc)
-
- @property
- def libname(self):
- return self.library.name
-
- @property
- def source(self):
- return self.library.source
-
- @property
- def lineno(self):
- return -1
-
- def create_runner(self, name):
- return LibraryKeywordRunner(self)
-
- def current_handler(self):
- if self._method:
- return self._method
- return self._get_handler(self.library.get_instance(), self._handler_name)
-
- def _get_global_handler(self, method, name):
- return method
-
- def _get_handler(self, lib_instance, handler_name):
- try:
- return getattr(lib_instance, handler_name)
- except AttributeError:
- # Occurs with old-style classes.
- if handler_name == '__init__':
- return None
- raise
-
-
-class _PythonHandler(_RunnableHandler):
-
- def __init__(self, library, handler_name, handler_method):
- _RunnableHandler.__init__(self, library, handler_name, handler_method,
- getdoc(handler_method))
-
- def _parse_arguments(self, handler_method):
- return PythonArgumentParser().parse(handler_method, self.longname)
-
- @property
- def source(self):
- handler = self.current_handler()
- # `getsourcefile` can return None and raise TypeError.
- try:
- source = inspect.getsourcefile(inspect.unwrap(handler))
- except TypeError:
- source = None
- return normpath(source) if source else self.library.source
-
- @property
- def lineno(self):
- handler = self.current_handler()
- try:
- lines, start_lineno = inspect.getsourcelines(inspect.unwrap(handler))
- except (TypeError, OSError, IOError):
- return -1
- for increment, line in enumerate(lines):
- if line.strip().startswith('def '):
- return start_lineno + increment
- return start_lineno
-
-
-class _DynamicHandler(_RunnableHandler):
-
- def __init__(self, library, handler_name, dynamic_method, doc='',
- argspec=None, tags=None):
- self._argspec = argspec
- self._run_keyword_method_name = dynamic_method.name
- self._supports_kwargs = dynamic_method.supports_kwargs
- _RunnableHandler.__init__(self, library, handler_name,
- dynamic_method.method, doc, tags)
- self._source_info = None
-
- def _parse_arguments(self, handler_method):
- spec = DynamicArgumentParser().parse(self._argspec, self.longname)
- if not self._supports_kwargs:
- if spec.var_named:
- raise DataError("Too few '%s' method parameters for **kwargs "
- "support." % self._run_keyword_method_name)
- if spec.named_only:
- raise DataError("Too few '%s' method parameters for "
- "keyword-only arguments support."
- % self._run_keyword_method_name)
- get_keyword_types = GetKeywordTypes(self.library.get_instance())
- spec.types = get_keyword_types(self._handler_name)
- return spec
-
- @property
- def source(self):
- if self._source_info is None:
- self._source_info = self._get_source_info()
- return self._source_info[0]
-
- def _get_source_info(self):
- get_keyword_source = GetKeywordSource(self.library.get_instance())
- try:
- source = get_keyword_source(self._handler_name)
- except DataError as err:
- self.library.report_error(
- f"Getting source information for keyword '{self.name}' failed: {err}",
- err.details
- )
- source = None
- if source and ':' in source and source.rsplit(':', 1)[1].isdigit():
- source, lineno = source.rsplit(':', 1)
- lineno = int(lineno)
- else:
- lineno = -1
- return normpath(source) if source else self.library.source, lineno
-
- @property
- def lineno(self):
- if self._source_info is None:
- self._source_info = self._get_source_info()
- return self._source_info[1]
-
- def resolve_arguments(self, arguments, variables=None):
- positional, named = super().resolve_arguments(arguments, variables)
- if not self._supports_kwargs:
- positional, named = self.arguments.map(positional, named)
- return positional, named
-
- def _get_handler(self, lib_instance, handler_name):
- runner = getattr(lib_instance, self._run_keyword_method_name)
- return self._get_dynamic_handler(runner, handler_name)
-
- def _get_global_handler(self, method, name):
- return self._get_dynamic_handler(method, name)
-
- def _get_dynamic_handler(self, runner, name):
- def handler(*positional, **kwargs):
- if self._supports_kwargs:
- return runner(name, positional, kwargs)
- else:
- return runner(name, positional)
- return handler
-
-
-class _RunKeywordHandler(_PythonHandler):
-
- def create_runner(self, name):
- default_dry_run_keywords = ('name' in self.arguments.positional and
- self._args_to_process)
- return RunKeywordRunner(self, default_dry_run_keywords)
-
- @property
- def _args_to_process(self):
- return RUN_KW_REGISTER.get_args_to_process(self.library.orig_name,
- self.name)
-
- def resolve_arguments(self, args, variables=None):
- return self.arguments.resolve(args, variables, self.library.converters,
- resolve_named=False,
- resolve_variables_until=self._args_to_process)
-
-
-class _DynamicRunKeywordHandler(_DynamicHandler, _RunKeywordHandler):
- _parse_arguments = _RunKeywordHandler._parse_arguments
- resolve_arguments = _RunKeywordHandler.resolve_arguments
-
-
-class _PythonInitHandler(_PythonHandler):
-
- def __init__(self, library, handler_name, handler_method, docgetter):
- _PythonHandler.__init__(self, library, handler_name, handler_method)
- self._docgetter = docgetter
-
- def _get_name(self, handler_name, handler_method):
- return '__init__'
-
- @property
- def doc(self):
- if self._docgetter:
- self._doc = self._docgetter() or self._doc
- self._docgetter = None
- return self._doc
-
- def _parse_arguments(self, init_method):
- parser = PythonArgumentParser(type='Library')
- return parser.parse(init_method or (lambda: None), self.library.name)
-
-
-class EmbeddedArgumentsHandler:
-
- def __init__(self, name_regexp, orig_handler):
- self.arguments = ArgumentSpec() # Show empty argument spec for Libdoc
- self.name_regexp = name_regexp
- self._orig_handler = orig_handler
-
- def __getattr__(self, item):
- return getattr(self._orig_handler, item)
-
- @property
- def library(self):
- return self._orig_handler.library
-
- @library.setter
- def library(self, library):
- self._orig_handler.library = library
-
- def matches(self, name):
- return self.name_regexp.match(name) is not None
-
- def create_runner(self, name):
- return EmbeddedArgumentsRunner(self, name)
-
- def resolve_arguments(self, args, variables=None):
- positional = [variables.replace_scalar(a) for a in args] if variables else args
- named = {}
- argspec = self._orig_handler.arguments
- return argspec.convert(positional, named, self.library.converters,
- dry_run=not variables)
-
- def __copy__(self):
- orig_handler = copy(self._orig_handler)
- return EmbeddedArgumentsHandler(self.name_regexp, orig_handler)
diff --git a/src/robot/running/handlerstore.py b/src/robot/running/handlerstore.py
deleted file mode 100644
index 5b5959205fa..00000000000
--- a/src/robot/running/handlerstore.py
+++ /dev/null
@@ -1,84 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from operator import attrgetter
-
-from robot.errors import DataError, KeywordError
-from robot.utils import NormalizedDict
-
-from .usererrorhandler import UserErrorHandler
-
-
-class HandlerStore:
- LIBRARY_TYPE = 'Library'
- TEST_CASE_FILE_TYPE = 'Test case file'
- RESOURCE_FILE_TYPE = 'Resource file'
-
- def __init__(self, source, source_type):
- self.source = source
- self.source_type = source_type
- self._normal = NormalizedDict(ignore='_')
- self._embedded = []
-
- def add(self, handler, embedded=False):
- if embedded:
- self._embedded.append(handler)
- elif handler.name not in self._normal:
- self._normal[handler.name] = handler
- else:
- error = DataError('Keyword with same name defined multiple times.')
- self._normal[handler.name] = UserErrorHandler(error, handler.name,
- handler.libname)
- raise error
-
- def __iter__(self):
- handlers = list(self._normal.values()) + self._embedded
- return iter(sorted(handlers, key=attrgetter('name')))
-
- def __len__(self):
- return len(self._normal) + len(self._embedded)
-
- def __contains__(self, name):
- if name in self._normal:
- return True
- return any(template.matches(name) for template in self._embedded)
-
- def create_runner(self, name):
- return self[name].create_runner(name)
-
- def __getitem__(self, name):
- try:
- return self._normal[name]
- except KeyError:
- return self._find_embedded(name)
-
- def _find_embedded(self, name):
- embedded = [template for template in self._embedded if template.matches(name)]
- if len(embedded) == 1:
- return embedded[0]
- self._raise_no_single_match(name, embedded)
-
- def _raise_no_single_match(self, name, found):
- if self.source_type == self.TEST_CASE_FILE_TYPE:
- source = self.source_type
- else:
- source = "%s '%s'" % (self.source_type, self.source)
- if not found:
- raise KeywordError("%s contains no keywords matching name '%s'."
- % (source, name))
- error = ["%s contains multiple keywords matching name '%s':"
- % (source, name)]
- names = sorted(handler.name for handler in found)
- raise KeywordError('\n '.join(error + names))
diff --git a/src/robot/running/importer.py b/src/robot/running/importer.py
index 0aea7e1dcaf..6e8b85a8c6c 100644
--- a/src/robot/running/importer.py
+++ b/src/robot/running/importer.py
@@ -13,20 +13,25 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import copy
-import os.path
import os
+from robot.errors import DataError, FrameworkError
from robot.output import LOGGER
-from robot.errors import FrameworkError, DataError
-from robot.utils import normpath, seq2str, seq2str2, is_string
+from robot.utils import normpath, seq2str, seq2str2
from .builder import ResourceFileBuilder
-from .handlerstore import HandlerStore
from .testlibraries import TestLibrary
-
-RESOURCE_EXTENSIONS = ('.resource', '.robot', '.txt', '.tsv', '.rst', '.rest')
+RESOURCE_EXTENSIONS = {
+ ".resource",
+ ".robot",
+ ".txt",
+ ".tsv",
+ ".rst",
+ ".rest",
+ ".json",
+ ".rsrc",
+}
class Importer:
@@ -40,74 +45,60 @@ def reset(self):
def close_global_library_listeners(self):
for lib in self._library_cache.values():
- lib.close_global_listeners()
+ lib.scope_manager.close_global_listeners()
def import_library(self, name, args, alias, variables):
- lib = TestLibrary(name, args, variables, create_handlers=False)
- positional, named = lib.positional_args, lib.named_args
- lib = self._import_library(name, positional, named, lib)
+ lib = TestLibrary.from_name(
+ name,
+ args=args,
+ variables=variables,
+ create_keywords=False,
+ )
+ positional, named = lib.init.positional, lib.init.named
+ args_str = seq2str2(positional + [f"{n}={named[n]}" for n in named])
+ key = (name, positional, named)
+ if key in self._library_cache:
+ LOGGER.info(f"Found library '{name}' with arguments {args_str} from cache.")
+ lib = self._library_cache[key]
+ else:
+ lib.create_keywords()
+ if lib.scope is not lib.scope.GLOBAL:
+ lib.instance = None
+ self._library_cache[key] = lib
+ self._log_imported_library(name, args_str, lib)
if alias:
alias = variables.replace_scalar(alias)
- lib = self._copy_library(lib, alias)
- LOGGER.info("Imported library '%s' with name '%s'" % (name, alias))
+ lib = lib.copy(name=alias)
+ LOGGER.info(f"Imported library '{name}' with name '{alias}'.")
return lib
- def import_resource(self, path):
+ def import_resource(self, path, lang=None):
self._validate_resource_extension(path)
if path in self._resource_cache:
- LOGGER.info("Found resource file '%s' from cache" % path)
+ LOGGER.info(f"Found resource file '{path}' from cache.")
else:
- resource = ResourceFileBuilder().build(path)
+ resource = ResourceFileBuilder(lang=lang).build(path)
self._resource_cache[path] = resource
return self._resource_cache[path]
def _validate_resource_extension(self, path):
extension = os.path.splitext(path)[1]
if extension.lower() not in RESOURCE_EXTENSIONS:
- raise DataError("Invalid resource file extension '%s'. "
- "Supported extensions are %s."
- % (extension, seq2str(RESOURCE_EXTENSIONS)))
-
- def _import_library(self, name, positional, named, lib):
- args = positional + ['%s=%s' % arg for arg in named]
- key = (name, positional, named)
- if key in self._library_cache:
- LOGGER.info("Found library '%s' with arguments %s from cache."
- % (name, seq2str2(args)))
- return self._library_cache[key]
- lib.create_handlers()
- self._library_cache[key] = lib
- self._log_imported_library(name, args, lib)
- return lib
-
- def _log_imported_library(self, name, args, lib):
- type = lib.__class__.__name__.replace('Library', '').lower()[1:]
- listener = ', with listener' if lib.has_listener else ''
- LOGGER.info("Imported library '%s' with arguments %s "
- "(version %s, %s type, %s scope, %d keywords%s)"
- % (name, seq2str2(args), lib.version or '',
- type, lib.scope, len(lib), listener))
- if not lib:
- LOGGER.warn("Imported library '%s' contains no keywords." % name)
-
- def _copy_library(self, orig, name):
- # This is pretty ugly. Hopefully we can remove cache and copying
- # altogether in 3.0 and always just re-import libraries:
- # https://github.com/robotframework/robotframework/issues/2106
- lib = copy.copy(orig)
- lib.name = name
- lib.scope = type(lib.scope)(lib)
- lib.reset_instance()
- lib.handlers = HandlerStore(orig.handlers.source, orig.handlers.source_type)
- for handler in orig.handlers._normal.values():
- handler = copy.copy(handler)
- handler.library = lib
- lib.handlers.add(handler)
- for handler in orig.handlers._embedded:
- handler = copy.copy(handler)
- handler.library = lib
- lib.handlers.add(handler, embedded=True)
- return lib
+ raise DataError(
+ f"Invalid resource file extension '{extension}'. "
+ f"Supported extensions are {seq2str(sorted(RESOURCE_EXTENSIONS))}."
+ )
+
+ def _log_imported_library(self, name, args_str, lib):
+ kind = type(lib).__name__.replace("Library", "").lower()
+ listener = ", with listener" if lib.listeners else ""
+ LOGGER.info(
+ f"Imported library '{name}' with arguments {args_str} "
+ f"(version {lib.version or ''}, {kind} type, "
+ f"{lib.scope.name} scope, {len(lib.keywords)} keywords{listener})."
+ )
+ if not (lib.keywords or lib.listeners):
+ LOGGER.warn(f"Imported library '{name}' contains no keywords.")
class ImportCache:
@@ -122,8 +113,8 @@ def __init__(self):
self._items = []
def __setitem__(self, key, item):
- if not is_string(key) and not isinstance(key, tuple):
- raise FrameworkError('Invalid key for ImportCache')
+ if not isinstance(key, (str, tuple)):
+ raise FrameworkError("Invalid key for ImportCache")
key = self._norm_path_key(key)
if key not in self._keys:
self._keys.append(key)
@@ -154,4 +145,4 @@ def _norm_path_key(self, key):
return key
def _is_path(self, key):
- return is_string(key) and os.path.isabs(key) and os.path.exists(key)
+ return isinstance(key, str) and os.path.isabs(key) and os.path.exists(key)
diff --git a/src/robot/running/invalidkeyword.py b/src/robot/running/invalidkeyword.py
new file mode 100644
index 00000000000..b3b1656710f
--- /dev/null
+++ b/src/robot/running/invalidkeyword.py
@@ -0,0 +1,73 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from robot.errors import DataError
+from robot.result import Keyword as KeywordResult
+from robot.variables import VariableAssignment
+
+from .arguments import EmbeddedArguments
+from .keywordimplementation import KeywordImplementation
+from .model import Keyword as KeywordData
+from .statusreporter import StatusReporter
+
+
+class InvalidKeyword(KeywordImplementation):
+ """Represents an invalid keyword call.
+
+ Keyword may not have been found, there could have been multiple matches,
+ or the keyword call itself could have been invalid.
+ """
+
+ type = KeywordImplementation.INVALID_KEYWORD
+
+ def _get_embedded(self, name) -> "EmbeddedArguments|None":
+ try:
+ return super()._get_embedded(name)
+ except DataError:
+ return None
+
+ def create_runner(self, name, languages=None):
+ return InvalidKeywordRunner(self, name)
+
+ def bind(self, data: KeywordData) -> "InvalidKeyword":
+ return self.copy(parent=data.parent)
+
+
+class InvalidKeywordRunner:
+
+ def __init__(self, keyword: InvalidKeyword, name: "str|None" = None):
+ self.keyword = keyword
+ self.name = name or keyword.name
+ if not keyword.error:
+ raise ValueError("Executed 'InvalidKeyword' instance requires 'error'.")
+
+ def run(self, data: KeywordData, result: KeywordResult, context, run=True):
+ kw = self.keyword.bind(data)
+ args = tuple(data.args)
+ if data.named_args:
+ args += tuple(f"{n}={v}" for n, v in data.named_args.items())
+ result.config(
+ name=self.name,
+ owner=kw.owner.name if kw.owner else None,
+ args=args,
+ assign=tuple(VariableAssignment(data.assign)),
+ type=data.type,
+ )
+ with StatusReporter(data, result, context, run, implementation=kw):
+ # 'error' is can be set to 'None' by a listener that handles it.
+ if run and kw.error is not None:
+ raise DataError(kw.error)
+
+ dry_run = run
diff --git a/src/robot/running/keywordfinder.py b/src/robot/running/keywordfinder.py
new file mode 100644
index 00000000000..6fb803514b5
--- /dev/null
+++ b/src/robot/running/keywordfinder.py
@@ -0,0 +1,91 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Generic, Literal, overload, TYPE_CHECKING, TypeVar
+
+from robot.utils import NormalizedDict, plural_or_not as s, seq2str
+
+from .keywordimplementation import KeywordImplementation
+
+if TYPE_CHECKING:
+ from .resourcemodel import ResourceFile
+ from .testlibraries import TestLibrary
+
+
+K = TypeVar("K", bound=KeywordImplementation)
+
+
+class KeywordFinder(Generic[K]):
+
+ def __init__(self, owner: "TestLibrary|ResourceFile"):
+ self.owner = owner
+ self.cache: KeywordCache | None = None
+
+ @overload
+ def find(self, name: str, count: Literal[1]) -> "K": ...
+
+ @overload
+ def find(self, name: str, count: "int|None" = None) -> "list[K]": ...
+
+ def find(self, name: str, count: "int|None" = None) -> "list[K]|K":
+ """Find keywords based on the given ``name``.
+
+ With normal keywords matching is a case, space and underscore insensitive
+ string comparison and there cannot be more than one match. With keywords
+ accepting embedded arguments, matching is done against the name and
+ there can be multiple matches.
+
+ Returns matching keywords as a list, possibly as an empty list, without
+ any validation by default. If the optional ``count`` is used, raises
+ a ``ValueError`` if the number of found keywords does not match. If
+ ``count`` is ``1`` and exactly one keyword is found, returns that keyword
+ directly and not as a list.
+ """
+ if self.cache is None:
+ self.cache = KeywordCache[K](self.owner.keywords)
+ return self.cache.find(name, count)
+
+ def invalidate_cache(self):
+ self.cache = None
+
+
+class KeywordCache(Generic[K]):
+
+ def __init__(self, keywords: "list[K]"):
+ self.normal = NormalizedDict[K](ignore="_")
+ self.embedded: list[K] = []
+ add_normal = self.normal.__setitem__
+ add_embedded = self.embedded.append
+ for kw in keywords:
+ if kw.embedded:
+ add_embedded(kw)
+ else:
+ add_normal(kw.name, kw)
+
+ def find(self, name: str, count: "int|None" = None) -> "list[K]|K":
+ try:
+ keywords = [self.normal[name]]
+ except KeyError:
+ keywords = [kw for kw in self.embedded if kw.matches(name)]
+ if count is not None:
+ if len(keywords) != count:
+ names = ": " + seq2str([k.name for k in keywords]) if keywords else "."
+ raise ValueError(
+ f"Expected {count} keyword{s(count)} matching name '{name}', "
+ f"found {len(keywords)}{names}"
+ )
+ if count == 1:
+ return keywords[0]
+ return keywords
diff --git a/src/robot/running/keywordimplementation.py b/src/robot/running/keywordimplementation.py
new file mode 100644
index 00000000000..b88e2f37d67
--- /dev/null
+++ b/src/robot/running/keywordimplementation.py
@@ -0,0 +1,178 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pathlib import Path
+from typing import Any, Literal, Mapping, Sequence, TYPE_CHECKING
+
+from robot.model import ModelObject, Tags
+from robot.utils import eq, getshortdoc, setter
+
+from .arguments import ArgInfo, ArgumentSpec, EmbeddedArguments
+from .model import BodyItemParent, Keyword
+
+if TYPE_CHECKING:
+ from robot.conf import LanguagesLike
+
+ from .librarykeywordrunner import LibraryKeywordRunner
+ from .resourcemodel import ResourceFile
+ from .testlibraries import TestLibrary
+ from .userkeywordrunner import UserKeywordRunner
+
+
+class KeywordImplementation(ModelObject):
+ """Base class for different keyword implementations."""
+
+ USER_KEYWORD = "USER KEYWORD"
+ LIBRARY_KEYWORD = "LIBRARY KEYWORD"
+ INVALID_KEYWORD = "INVALID KEYWORD"
+ type: Literal["USER KEYWORD", "LIBRARY KEYWORD", "INVALID KEYWORD"]
+ repr_args = ("name", "args")
+ __slots__ = ("_name", "embedded", "_doc", "_lineno", "owner", "parent", "error")
+
+ def __init__(
+ self,
+ name: str = "",
+ args: "ArgumentSpec|None" = None,
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ lineno: "int|None" = None,
+ owner: "ResourceFile|TestLibrary|None" = None,
+ parent: "BodyItemParent|None" = None,
+ error: "str|None" = None,
+ ):
+ self._name = name
+ self.embedded = self._get_embedded(name)
+ self.args = args
+ self._doc = doc
+ self.tags = tags
+ self._lineno = lineno
+ self.owner = owner
+ self.parent = parent
+ self.error = error
+
+ def _get_embedded(self, name) -> "EmbeddedArguments|None":
+ return EmbeddedArguments.from_name(name)
+
+ @property
+ def name(self) -> str:
+ return self._name
+
+ @name.setter
+ def name(self, name: str):
+ self.embedded = self._get_embedded(name)
+ if self.owner and self._name:
+ self.owner.keyword_finder.invalidate_cache()
+ self._name = name
+
+ @property
+ def full_name(self) -> str:
+ if self.owner and self.owner.name:
+ return f"{self.owner.name}.{self.name}"
+ return self.name
+
+ @setter
+ def args(self, spec: "ArgumentSpec|None") -> ArgumentSpec:
+ """Information about accepted arguments.
+
+ It would be more correct to use term *parameter* instead of
+ *argument* in this context, and this attribute may be renamed
+ accordingly in the future. A forward compatible :attr:`params`
+ attribute exists already now.
+ """
+ if spec is None:
+ spec = ArgumentSpec()
+ spec.name = lambda: self.full_name
+ return spec
+
+ @property
+ def params(self) -> ArgumentSpec:
+ """Keyword parameter information.
+
+ This is a forward compatible alias for :attr:`args`.
+ """
+ return self.args
+
+ @property
+ def doc(self) -> str:
+ return self._doc
+
+ @doc.setter
+ def doc(self, doc: str):
+ self._doc = doc
+
+ @property
+ def short_doc(self) -> str:
+ return getshortdoc(self.doc)
+
+ @setter
+ def tags(self, tags: "Tags|Sequence[str]") -> Tags:
+ return Tags(tags)
+
+ @property
+ def lineno(self) -> "int|None":
+ return self._lineno
+
+ @lineno.setter
+ def lineno(self, lineno: "int|None"):
+ self._lineno = lineno
+
+ @property
+ def private(self) -> bool:
+ return bool(self.tags and self.tags.robot("private"))
+
+ @property
+ def source(self) -> "Path|None":
+ return self.owner.source if self.owner is not None else None
+
+ def matches(self, name: str) -> bool:
+ """Returns true if ``name`` matches the keyword name.
+
+ With normal keywords matching is a case, space and underscore insensitive
+ string comparison. With keywords accepting embedded arguments, matching
+ is done against the name.
+ """
+ if self.embedded:
+ return self.embedded.matches(name)
+ return eq(self.name, name, ignore="_")
+
+ def resolve_arguments(
+ self,
+ args: "Sequence[str|Any]",
+ named_args: "Mapping[str, Any]|None" = None,
+ variables=None,
+ languages: "LanguagesLike" = None,
+ ) -> "tuple[list, list]":
+ return self.args.resolve(args, named_args, variables, languages=languages)
+
+ def create_runner(
+ self,
+ name: "str|None",
+ languages: "LanguagesLike" = None,
+ ) -> "LibraryKeywordRunner|UserKeywordRunner":
+ raise NotImplementedError
+
+ def bind(self, data: Keyword) -> "KeywordImplementation":
+ raise NotImplementedError
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return name == "name" or value
+
+ def _repr_format(self, name: str, value: Any) -> str:
+ if name == "args":
+ value = [self._decorate_arg(a) for a in self.args]
+ return super()._repr_format(name, value)
+
+ def _decorate_arg(self, arg: ArgInfo) -> str:
+ return str(arg)
diff --git a/src/robot/running/librarykeyword.py b/src/robot/running/librarykeyword.py
new file mode 100644
index 00000000000..f4afbbada83
--- /dev/null
+++ b/src/robot/running/librarykeyword.py
@@ -0,0 +1,482 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import inspect
+from os.path import normpath
+from pathlib import Path
+from typing import Any, Callable, Generic, Mapping, Sequence, TYPE_CHECKING, TypeVar
+
+from robot.errors import DataError
+from robot.model import Tags
+from robot.utils import (
+ is_init, is_list_like, printable_name, split_tags_from_doc, type_name
+)
+
+from .arguments import ArgumentSpec, DynamicArgumentParser, PythonArgumentParser
+from .dynamicmethods import (
+ GetKeywordArguments, GetKeywordDocumentation, GetKeywordSource, GetKeywordTags,
+ GetKeywordTypes, RunKeyword
+)
+from .keywordimplementation import KeywordImplementation
+from .librarykeywordrunner import (
+ EmbeddedArgumentsRunner, LibraryKeywordRunner, RunKeywordRunner
+)
+from .model import BodyItemParent, Keyword
+from .runkwregister import RUN_KW_REGISTER
+
+if TYPE_CHECKING:
+ from robot.conf import LanguagesLike
+
+ from .testlibraries import DynamicLibrary, TestLibrary
+
+
+Self = TypeVar("Self", bound="LibraryKeyword")
+K = TypeVar("K", bound="LibraryKeyword")
+
+
+class LibraryKeyword(KeywordImplementation):
+ """Base class for different library keywords."""
+
+ type = KeywordImplementation.LIBRARY_KEYWORD
+ owner: "TestLibrary"
+ __slots__ = ("_resolve_args_until",)
+
+ def __init__(
+ self,
+ owner: "TestLibrary",
+ name: str = "",
+ args: "ArgumentSpec|None" = None,
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ resolve_args_until: "int|None" = None,
+ parent: "BodyItemParent|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(name, args, doc, tags, owner=owner, parent=parent, error=error)
+ self._resolve_args_until = resolve_args_until
+
+ @property
+ def method(self) -> Callable[..., Any]:
+ raise NotImplementedError
+
+ @property
+ def lineno(self) -> "int|None":
+ method = self.method
+ try:
+ lines, start_lineno = inspect.getsourcelines(inspect.unwrap(method))
+ except (TypeError, OSError, IOError):
+ return None
+ for increment, line in enumerate(lines):
+ if line.strip().startswith("def "):
+ return start_lineno + increment
+ return start_lineno
+
+ def create_runner(
+ self,
+ name: "str|None",
+ languages: "LanguagesLike" = None,
+ ) -> LibraryKeywordRunner:
+ if self.embedded:
+ return EmbeddedArgumentsRunner(self, name)
+ if self._resolve_args_until is not None:
+ dry_run = RUN_KW_REGISTER.get_dry_run(self.owner.real_name, self.name)
+ return RunKeywordRunner(self, dry_run_children=dry_run)
+ return LibraryKeywordRunner(self, languages=languages)
+
+ def resolve_arguments(
+ self,
+ args: "Sequence[str|Any]",
+ named_args: "Mapping[str, Any]|None" = None,
+ variables=None,
+ languages: "LanguagesLike" = None,
+ ) -> "tuple[list, list]":
+ resolve_args_until = self._resolve_args_until
+ positional, named = self.args.resolve(
+ args,
+ named_args,
+ variables,
+ self.owner.converters,
+ resolve_named=resolve_args_until is None,
+ resolve_args_until=resolve_args_until,
+ languages=languages,
+ )
+ if self.embedded:
+ self.embedded.validate(positional)
+ return positional, named
+
+ def bind(self: Self, data: Keyword) -> Self:
+ return self.copy(parent=data.parent)
+
+ def copy(self: Self, **attributes) -> Self:
+ raise NotImplementedError
+
+
+class StaticKeyword(LibraryKeyword):
+ """Represents a keyword in a static library."""
+
+ __slots__ = ("method_name",)
+
+ def __init__(
+ self,
+ method_name: str,
+ owner: "TestLibrary",
+ name: str = "",
+ args: "ArgumentSpec|None" = None,
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ resolve_args_until: "int|None" = None,
+ parent: "BodyItemParent|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(
+ owner,
+ name,
+ args,
+ doc,
+ tags,
+ resolve_args_until,
+ parent,
+ error,
+ )
+ self.method_name = method_name
+
+ @property
+ def method(self) -> Callable[..., Any]:
+ """Keyword method."""
+ return getattr(self.owner.instance, self.method_name)
+
+ @property
+ def source(self) -> "Path|None":
+ # `getsourcefile` can return None and raise TypeError.
+ try:
+ if self.method is None:
+ raise TypeError
+ source = inspect.getsourcefile(inspect.unwrap(self.method))
+ except TypeError:
+ source = None
+ return Path(normpath(source)) if source else super().source
+
+ @classmethod
+ def from_name(cls, name: str, owner: "TestLibrary") -> "StaticKeyword":
+ return StaticKeywordCreator(name, owner).create(method_name=name)
+
+ def copy(self, **attributes) -> "StaticKeyword":
+ return StaticKeyword(
+ self.method_name,
+ self.owner,
+ self.name,
+ self.args,
+ self._doc,
+ self.tags,
+ self._resolve_args_until,
+ self.parent,
+ self.error,
+ ).config(**attributes)
+
+
+class DynamicKeyword(LibraryKeyword):
+ """Represents a keyword in a dynamic library."""
+
+ owner: "DynamicLibrary"
+ __slots__ = ("run_keyword", "_orig_name", "__source_info")
+
+ def __init__(
+ self,
+ owner: "DynamicLibrary",
+ name: str = "",
+ args: "ArgumentSpec|None" = None,
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ resolve_args_until: "int|None" = None,
+ parent: "BodyItemParent|None" = None,
+ error: "str|None" = None,
+ ):
+ # TODO: It would probably be better not to convert name we got from
+ # `get_keyword_names`. That would have some backwards incompatibility
+ # effects, but we can consider it in RF 8.0.
+ super().__init__(
+ owner,
+ printable_name(name, code_style=True),
+ args,
+ doc,
+ tags,
+ resolve_args_until,
+ parent,
+ error,
+ )
+ self._orig_name = name
+ self.__source_info = None
+
+ @property
+ def method(self) -> Callable[..., Any]:
+ """Dynamic ``run_keyword`` method."""
+ return RunKeyword(
+ self.owner.instance,
+ self._orig_name,
+ self.owner.supports_named_args,
+ )
+
+ @property
+ def source(self) -> "Path|None":
+ return self._source_info[0] or super().source
+
+ @property
+ def lineno(self) -> "int|None":
+ return self._source_info[1]
+
+ @property
+ def _source_info(self) -> "tuple[Path|None, int]":
+ if not self.__source_info:
+ get_keyword_source = GetKeywordSource(self.owner.instance)
+ try:
+ source = get_keyword_source(self._orig_name)
+ except DataError as err:
+ source = None
+ self.owner.report_error(
+ f"Getting source information for keyword '{self.name}' "
+ f"failed: {err}",
+ err.details,
+ )
+ if source and ":" in source and source.rsplit(":", 1)[1].isdigit():
+ source, lineno = source.rsplit(":", 1)
+ lineno = int(lineno)
+ else:
+ lineno = None
+ self.__source_info = Path(normpath(source)) if source else None, lineno
+ return self.__source_info
+
+ @classmethod
+ def from_name(cls, name: str, owner: "DynamicLibrary") -> "DynamicKeyword":
+ return DynamicKeywordCreator(name, owner).create()
+
+ def resolve_arguments(
+ self,
+ args: "Sequence[str|Any]",
+ named_args: "Mapping[str, Any]|None" = None,
+ variables=None,
+ languages: "LanguagesLike" = None,
+ ) -> "tuple[list, list]":
+ positional, named = super().resolve_arguments(
+ args,
+ named_args,
+ variables,
+ languages,
+ )
+ if not self.owner.supports_named_args:
+ positional, named = self.args.map(positional, named)
+ return positional, named
+
+ def copy(self, **attributes) -> "DynamicKeyword":
+ return DynamicKeyword(
+ self.owner,
+ self._orig_name,
+ self.args,
+ self._doc,
+ self.tags,
+ self._resolve_args_until,
+ self.parent,
+ self.error,
+ ).config(**attributes)
+
+
+class LibraryInit(LibraryKeyword):
+ """Represents a library initializer.
+
+ :attr:`positional` and :attr:`named` contain arguments used for initializing
+ the library.
+ """
+
+ def __init__(
+ self,
+ owner: "TestLibrary",
+ name: str = "",
+ args: "ArgumentSpec|None" = None,
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ positional: "list|None" = None,
+ named: "dict|None" = None,
+ ):
+ super().__init__(owner, name, args, doc, tags)
+ self.positional = positional or []
+ self.named = named or {}
+
+ @property
+ def doc(self) -> str:
+ from .testlibraries import DynamicLibrary
+
+ if isinstance(self.owner, DynamicLibrary):
+ doc = GetKeywordDocumentation(self.owner.instance)("__init__")
+ if doc:
+ return doc
+ return self._doc
+
+ @doc.setter
+ def doc(self, doc: str):
+ self._doc = doc
+
+ @property
+ def method(self) -> "Callable[..., None]|None":
+ """Initializer method.
+
+ ``None`` with module based libraries and when class based libraries
+ do not have ``__init__``.
+ """
+ return getattr(self.owner.instance, "__init__", None)
+
+ @classmethod
+ def from_class(cls, klass) -> "LibraryInit":
+ method = getattr(klass, "__init__", None)
+ return LibraryInitCreator(method).create()
+
+ @classmethod
+ def null(cls) -> "LibraryInit":
+ return LibraryInitCreator(None).create()
+
+ def copy(self, **attributes) -> "LibraryInit":
+ return LibraryInit(
+ self.owner,
+ self.name,
+ self.args,
+ self._doc,
+ self.tags,
+ self.positional,
+ self.named,
+ ).config(**attributes)
+
+
+class KeywordCreator(Generic[K]):
+ keyword_class: "type[K]"
+
+ def __init__(self, name: str, library: "TestLibrary|None" = None):
+ self.name = name
+ self.library = library
+ self.extra = {}
+ if library and RUN_KW_REGISTER.is_run_keyword(library.real_name, name):
+ resolve_until = RUN_KW_REGISTER.get_args_to_process(library.real_name, name)
+ self.extra["resolve_args_until"] = resolve_until
+
+ @property
+ def instance(self) -> Any:
+ return self.library.instance
+
+ def create(self, **extra) -> K:
+ tags = self.get_tags()
+ doc, doc_tags = split_tags_from_doc(self.get_doc())
+ kw = self.keyword_class(
+ owner=self.library,
+ name=self.get_name(),
+ args=self.get_args(),
+ doc=doc,
+ tags=tags + doc_tags,
+ **self.extra,
+ **extra,
+ )
+ kw.args.name = lambda: kw.full_name
+ return kw
+
+ def get_name(self) -> str:
+ raise NotImplementedError
+
+ def get_args(self) -> ArgumentSpec:
+ raise NotImplementedError
+
+ def get_doc(self) -> str:
+ raise NotImplementedError
+
+ def get_tags(self) -> "list[str]":
+ raise NotImplementedError
+
+
+class StaticKeywordCreator(KeywordCreator[StaticKeyword]):
+ keyword_class = StaticKeyword
+
+ def __init__(self, name: str, library: "TestLibrary"):
+ super().__init__(name, library)
+ self.method = getattr(library.instance, name)
+
+ def get_name(self) -> str:
+ robot_name = getattr(self.method, "robot_name", None)
+ name = robot_name or printable_name(self.name, code_style=True)
+ if not name:
+ raise DataError("Keyword name cannot be empty.")
+ return name
+
+ def get_args(self) -> ArgumentSpec:
+ return PythonArgumentParser().parse(self.method)
+
+ def get_doc(self) -> str:
+ return inspect.getdoc(self.method) or ""
+
+ def get_tags(self) -> "list[str]":
+ tags = getattr(self.method, "robot_tags", ())
+ if not is_list_like(tags):
+ raise DataError(f"Expected tags to be list-like, got {type_name(tags)}.")
+ return list(tags)
+
+
+class DynamicKeywordCreator(KeywordCreator[DynamicKeyword]):
+ keyword_class = DynamicKeyword
+ library: "DynamicLibrary"
+
+ def get_name(self) -> str:
+ return self.name
+
+ def get_args(self) -> ArgumentSpec:
+ supports_named_args = self.library.supports_named_args
+ get_keyword_arguments = GetKeywordArguments(self.instance, supports_named_args)
+ spec = DynamicArgumentParser().parse(get_keyword_arguments(self.name))
+ if not supports_named_args:
+ name = RunKeyword(self.instance).name
+ prefix = f"Too few '{name}' method parameters to support "
+ if spec.named_only:
+ raise DataError(prefix + "named-only arguments.")
+ if spec.var_named:
+ raise DataError(prefix + "free named arguments.")
+ types = GetKeywordTypes(self.instance)(self.name)
+ if isinstance(types, dict) and "return" in types:
+ spec.return_type = types.pop("return")
+ spec.types = types
+ return spec
+
+ def get_doc(self) -> str:
+ return GetKeywordDocumentation(self.instance)(self.name)
+
+ def get_tags(self) -> "list[str]":
+ return GetKeywordTags(self.instance)(self.name)
+
+
+class LibraryInitCreator(KeywordCreator[LibraryInit]):
+ keyword_class = LibraryInit
+
+ def __init__(self, method: "Callable[..., None]|None"):
+ super().__init__("__init__")
+ self.method = method if is_init(method) else lambda: None
+
+ def create(self, **extra) -> LibraryInit:
+ init = super().create(**extra)
+ init.args.name = lambda: init.owner.name
+ return init
+
+ def get_name(self) -> str:
+ return self.name
+
+ def get_args(self) -> ArgumentSpec:
+ return PythonArgumentParser("Library").parse(self.method)
+
+ def get_doc(self) -> str:
+ return inspect.getdoc(self.method) or ""
+
+ def get_tags(self) -> "list[str]":
+ return []
diff --git a/src/robot/running/librarykeywordrunner.py b/src/robot/running/librarykeywordrunner.py
index 1097e9c75c3..44fd64194a5 100644
--- a/src/robot/running/librarykeywordrunner.py
+++ b/src/robot/running/librarykeywordrunner.py
@@ -13,180 +13,264 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from contextlib import contextmanager
+from typing import TYPE_CHECKING
+
from robot.errors import DataError
-from robot.output import LOGGER
from robot.result import Keyword as KeywordResult
from robot.utils import prepr, safe_str
from robot.variables import contains_variable, is_list_variable, VariableAssignment
from .bodyrunner import BodyRunner
-from .model import Keyword
+from .model import Keyword as KeywordData
from .outputcapture import OutputCapturer
+from .resourcemodel import UserKeyword
from .signalhandler import STOP_SIGNAL_MONITOR
from .statusreporter import StatusReporter
+if TYPE_CHECKING:
+ from .librarykeyword import LibraryKeyword
-class LibraryKeywordRunner:
-
- def __init__(self, handler, name=None):
- self._handler = handler
- self.name = name or handler.name
- self.pre_run_messages = None
-
- @property
- def library(self):
- return self._handler.library
-
- @property
- def libname(self):
- return self._handler.library.name
- @property
- def longname(self):
- return '%s.%s' % (self.library.name, self.name)
+class LibraryKeywordRunner:
- def run(self, kw, context, run=True):
- assignment = VariableAssignment(kw.assign)
- result = self._get_result(kw, assignment)
- with StatusReporter(kw, result, context, run):
+ def __init__(
+ self,
+ keyword: "LibraryKeyword",
+ name: "str|None" = None,
+ languages=None,
+ ):
+ self.keyword = keyword
+ self.name = name or keyword.name
+ self.pre_run_messages = ()
+ self.languages = languages
+
+ def run(self, data: KeywordData, result: KeywordResult, context, run=True):
+ kw = self.keyword.bind(data)
+ assignment = VariableAssignment(data.assign)
+ self._config_result(result, data, kw, assignment)
+ with StatusReporter(data, result, context, run, implementation=kw):
if run:
with assignment.assigner(context) as assigner:
- return_value = self._run(context, kw.args)
+ return_value = self._run(data, kw, context)
assigner.assign(return_value)
return return_value
+ return None
- def _get_result(self, kw, assignment):
- handler = self._handler
- return KeywordResult(kwname=self.name,
- libname=handler.libname,
- doc=handler.shortdoc,
- args=kw.args,
- assign=tuple(assignment),
- tags=handler.tags,
- type=kw.type)
-
- def _run(self, context, args):
+ def _config_result(
+ self,
+ result: KeywordResult,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ assignment,
+ ):
+ args = tuple(data.args)
+ if data.named_args:
+ args += tuple(f"{n}={v}" for n, v in data.named_args.items())
+ result.config(
+ name=self.name,
+ owner=kw.owner.name,
+ doc=kw.short_doc,
+ args=args,
+ assign=tuple(assignment),
+ tags=kw.tags,
+ type=data.type,
+ )
+
+ def _run(self, data: KeywordData, kw: "LibraryKeyword", context):
if self.pre_run_messages:
for message in self.pre_run_messages:
context.output.message(message)
variables = context.variables if not context.dry_run else None
- positional, named = self._handler.resolve_arguments(args, variables)
- context.output.trace(lambda: self._trace_log_args(positional, named))
- runner = self._runner_for(context, self._handler.current_handler(),
- positional, dict(named))
- return self._run_with_output_captured_and_signal_monitor(runner, context)
+ positional, named = self._resolve_arguments(data, kw, variables)
+ context.output.trace(
+ lambda: self._trace_log_args(positional, named), write_if_flat=False
+ )
+ if kw.error:
+ raise DataError(kw.error)
+ return self._execute(kw.method, positional, named, context)
+
+ def _resolve_arguments(
+ self,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ variables=None,
+ ):
+ return kw.resolve_arguments(
+ data.args,
+ data.named_args,
+ variables,
+ self.languages,
+ )
def _trace_log_args(self, positional, named):
- args = [prepr(arg) for arg in positional]
- args += ['%s=%s' % (safe_str(n), prepr(v)) for n, v in named]
- return 'Arguments: [ %s ]' % ' | '.join(args)
-
- def _runner_for(self, context, handler, positional, named):
- timeout = self._get_timeout(context)
- if timeout and timeout.active:
- def runner():
- with LOGGER.delayed_logging:
- context.output.debug(timeout.get_message)
- return timeout.run(handler, args=positional, kwargs=named)
- return runner
- return lambda: handler(*positional, **named)
+ args = [
+ *[prepr(arg) for arg in positional],
+ *[f"{safe_str(n)}={prepr(v)}" for n, v in named],
+ ]
+ return f"Arguments: [ {' | '.join(args)} ]"
def _get_timeout(self, context):
return min(context.timeouts) if context.timeouts else None
- def _run_with_output_captured_and_signal_monitor(self, runner, context):
- with OutputCapturer():
- return self._run_with_signal_monitoring(runner, context)
-
- def _run_with_signal_monitoring(self, runner, context):
+ def _execute(self, method, positional, named, context):
+ timeout = self._get_timeout(context)
+ if timeout:
+ method = self._wrap_with_timeout(method, timeout, context)
+ with self._monitor(context):
+ result = method(*positional, **dict(named))
+ if context.asynchronous.is_loop_required(result):
+ return context.asynchronous.run_until_complete(result)
+ return result
+
+ def _wrap_with_timeout(self, method, timeout, context):
+ def wrapper(*args, **kwargs):
+ with context.timeout(timeout) as runner:
+ return runner.run(method, args=args, kwargs=kwargs)
+
+ return wrapper
+
+ @contextmanager
+ def _monitor(self, context):
+ STOP_SIGNAL_MONITOR.start_running_keyword(context.in_teardown)
+ capturer = OutputCapturer()
+ capturer.start()
try:
- STOP_SIGNAL_MONITOR.start_running_keyword(context.in_teardown)
- return runner()
+ yield
finally:
+ capturer.stop()
STOP_SIGNAL_MONITOR.stop_running_keyword()
- def dry_run(self, kw, context):
- assignment = VariableAssignment(kw.assign)
- result = self._get_result(kw, assignment)
- with StatusReporter(kw, result, context, run=False):
+ def dry_run(self, data: KeywordData, result: KeywordResult, context):
+ kw = self.keyword.bind(data)
+ assignment = VariableAssignment(data.assign)
+ self._config_result(result, data, kw, assignment)
+ with StatusReporter(
+ data,
+ result,
+ context,
+ implementation=kw,
+ run=self._get_initial_dry_run_status(kw),
+ ):
assignment.validate_assignment()
- self._dry_run(context, kw.args)
-
- def _dry_run(self, context, args):
- if self._executed_in_dry_run(self._handler):
- self._run(context, args)
- else:
- self._handler.resolve_arguments(args)
-
- def _executed_in_dry_run(self, handler):
- keywords_to_execute = ('BuiltIn.Import Library',
- 'BuiltIn.Set Library Search Order',
- 'BuiltIn.Set Tags',
- 'BuiltIn.Remove Tags')
- return (handler.libname == 'Reserved' or
- handler.longname in keywords_to_execute)
+ if self._executed_in_dry_run(kw):
+ self._run(data, kw, context)
+ else:
+ self._resolve_arguments(data, kw)
+ self._dry_run(data, kw, result, context)
+
+ def _get_initial_dry_run_status(self, kw):
+ return self._executed_in_dry_run(kw)
+
+ def _executed_in_dry_run(self, kw: "LibraryKeyword"):
+ return kw.owner.name == "BuiltIn" and kw.name in (
+ "Import Library",
+ "Set Library Search Order",
+ "Set Tags",
+ "Remove Tags",
+ "Import Resource",
+ )
+
+ def _dry_run(
+ self,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ result: KeywordResult,
+ context,
+ ):
+ pass
class EmbeddedArgumentsRunner(LibraryKeywordRunner):
- def __init__(self, handler, name):
- super().__init__(handler, name)
- self._embedded_args = handler.name_regexp.match(name).groups()
-
- def _run(self, context, args):
- if args:
- raise DataError("Positional arguments are not allowed when using "
- "embedded arguments.")
- return super()._run(context, self._embedded_args)
-
- def _dry_run(self, context, args):
- return super()._dry_run(context, self._embedded_args)
-
- def _get_result(self, kw, assignment):
- result = super()._get_result(kw, assignment)
- result.sourcename = self._handler.name
- return result
+ def __init__(self, keyword: "LibraryKeyword", name: "str"):
+ super().__init__(keyword, name)
+ self.embedded_args = keyword.embedded.parse_args(name)
+
+ def _resolve_arguments(
+ self,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ variables=None,
+ ):
+ return kw.resolve_arguments(
+ self.embedded_args + data.args,
+ data.named_args,
+ variables,
+ self.languages,
+ )
+
+ def _config_result(
+ self,
+ result: KeywordResult,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ assignment,
+ ):
+ super()._config_result(result, data, kw, assignment)
+ result.source_name = kw.name
class RunKeywordRunner(LibraryKeywordRunner):
- def __init__(self, handler, default_dry_run_keywords=False):
- super().__init__(handler)
- self._default_dry_run_keywords = default_dry_run_keywords
+ def __init__(self, keyword: "LibraryKeyword", dry_run_children=False):
+ super().__init__(keyword)
+ self._dry_run_children = dry_run_children
def _get_timeout(self, context):
+ # These keywords are not affected by timeouts. Keywords they execute are.
return None
- def _run_with_output_captured_and_signal_monitor(self, runner, context):
- return self._run_with_signal_monitoring(runner, context)
-
- def _dry_run(self, context, args):
- super()._dry_run(context, args)
- keywords = [kw for kw in self._get_dry_run_keywords(args)
- if not contains_variable(kw.name)]
- BodyRunner(context).run(keywords)
-
- def _get_dry_run_keywords(self, args):
- name = self._handler.name
- if name == 'Run Keyword If':
- return self._get_run_kw_if_keywords(args)
- if name == 'Run Keywords':
- return self._get_run_kws_keywords(args)
- if self._default_dry_run_keywords:
- return self._get_default_run_kw_keywords(args)
- return []
-
- def _get_run_kw_if_keywords(self, given_args):
+ @contextmanager
+ def _monitor(self, context):
+ STOP_SIGNAL_MONITOR.start_running_keyword(context.in_teardown)
+ try:
+ yield
+ finally:
+ STOP_SIGNAL_MONITOR.stop_running_keyword()
+
+ def _get_initial_dry_run_status(self, kw):
+ return self._dry_run_children or super()._get_initial_dry_run_status(kw)
+
+ def _dry_run(
+ self,
+ data: KeywordData,
+ kw: "LibraryKeyword",
+ result: KeywordResult,
+ context,
+ ):
+ wrapper = UserKeyword(
+ name=kw.name,
+ doc=f"Wraps keywords executed by '{kw.name}' in dry-run.",
+ parent=kw.parent,
+ )
+ for child in self._get_dry_run_children(kw, data.args):
+ if not contains_variable(child.name):
+ child.lineno = data.lineno
+ wrapper.body.append(child)
+ BodyRunner(context).run(wrapper, result)
+
+ def _get_dry_run_children(self, kw: "LibraryKeyword", args):
+ if not self._dry_run_children:
+ return []
+ if kw.name == "Run Keyword If":
+ return self._get_dry_run_children_for_run_keyword_if(args)
+ if kw.name == "Run Keywords":
+ return self._get_dry_run_children_for_run_keyword(args)
+ index = kw.args.positional.index("name")
+ return [KeywordData(name=args[index], args=args[index + 1 :])]
+
+ def _get_dry_run_children_for_run_keyword_if(self, given_args):
for kw_call in self._get_run_kw_if_calls(given_args):
if kw_call:
- yield Keyword(name=kw_call[0], args=kw_call[1:])
+ yield KeywordData(name=kw_call[0], args=kw_call[1:])
def _get_run_kw_if_calls(self, given_args):
- while 'ELSE IF' in given_args:
- kw_call, given_args = self._split_run_kw_if_args(given_args, 'ELSE IF', 2)
+ while "ELSE IF" in given_args:
+ kw_call, given_args = self._split_run_kw_if_args(given_args, "ELSE IF", 2)
yield kw_call
- if 'ELSE' in given_args:
- kw_call, else_call = self._split_run_kw_if_args(given_args, 'ELSE', 1)
+ if "ELSE" in given_args:
+ kw_call, else_call = self._split_run_kw_if_args(given_args, "ELSE", 1)
yield kw_call
yield else_call
elif self._validate_kw_call(given_args):
@@ -197,9 +281,11 @@ def _get_run_kw_if_calls(self, given_args):
def _split_run_kw_if_args(self, given_args, control_word, required_after):
index = list(given_args).index(control_word)
expr_and_call = given_args[:index]
- remaining = given_args[index+1:]
- if not (self._validate_kw_call(expr_and_call) and
- self._validate_kw_call(remaining, required_after)):
+ remaining = given_args[index + 1 :]
+ if not (
+ self._validate_kw_call(expr_and_call)
+ and self._validate_kw_call(remaining, required_after)
+ ):
raise DataError("Invalid 'Run Keyword If' usage.")
if is_list_variable(expr_and_call[0]):
return (), remaining
@@ -210,22 +296,18 @@ def _validate_kw_call(self, kw_call, min_length=2):
return True
return any(is_list_variable(item) for item in kw_call)
- def _get_run_kws_keywords(self, given_args):
+ def _get_dry_run_children_for_run_keyword(self, given_args):
for kw_call in self._get_run_kws_calls(given_args):
- yield Keyword(name=kw_call[0], args=kw_call[1:])
+ yield KeywordData(name=kw_call[0], args=kw_call[1:])
def _get_run_kws_calls(self, given_args):
- if 'AND' not in given_args:
+ if "AND" not in given_args:
for kw_call in given_args:
- yield [kw_call,]
+ yield [kw_call]
else:
- while 'AND' in given_args:
- index = list(given_args).index('AND')
- kw_call, given_args = given_args[:index], given_args[index + 1:]
+ while "AND" in given_args:
+ index = list(given_args).index("AND")
+ kw_call, given_args = given_args[:index], given_args[index + 1 :]
yield kw_call
if given_args:
yield given_args
-
- def _get_default_run_kw_keywords(self, given_args):
- index = list(self._handler.arguments.positional).index('name')
- return [Keyword(name=given_args[index], args=given_args[index+1:])]
diff --git a/src/robot/running/libraryscopes.py b/src/robot/running/libraryscopes.py
index 0188c48b503..f183bb20a91 100644
--- a/src/robot/running/libraryscopes.py
+++ b/src/robot/running/libraryscopes.py
@@ -13,39 +13,42 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import inspect
+from enum import auto, Enum
+from typing import TYPE_CHECKING
-from robot.utils import normalize
+from robot.errors import DataError
+from .context import EXECUTION_CONTEXTS
-def LibraryScope(libcode, library):
- scope = _get_scope(libcode)
- if scope == 'GLOBAL':
- return GlobalScope(library)
- if scope in ('SUITE', 'TESTSUITE'):
- return TestSuiteScope(library)
- return TestCaseScope(library)
+if TYPE_CHECKING:
+ from .testlibraries import TestLibrary
-def _get_scope(libcode):
- if inspect.ismodule(libcode):
- return 'GLOBAL'
- scope = getattr(libcode, 'ROBOT_LIBRARY_SCOPE', '')
- return normalize(str(scope), ignore='_').upper()
+class Scope(Enum):
+ GLOBAL = auto()
+ SUITE = auto()
+ TEST = auto()
-class GlobalScope:
- is_global = True
+class ScopeManager:
- def __init__(self, library):
- self._register_listeners = library.register_listeners
- self._unregister_listeners = library.unregister_listeners
+ def __init__(self, library: "TestLibrary"):
+ self.library = library
+
+ @classmethod
+ def for_library(cls, library):
+ manager = {
+ Scope.GLOBAL: GlobalScopeManager,
+ Scope.SUITE: SuiteScopeManager,
+ Scope.TEST: TestScopeManager,
+ }[library.scope]
+ return manager(library)
def start_suite(self):
- self._register_listeners()
+ pass
def end_suite(self):
- self._unregister_listeners()
+ pass
def start_test(self):
pass
@@ -53,45 +56,62 @@ def start_test(self):
def end_test(self):
pass
- def __str__(self):
- return 'GLOBAL'
+ def close_global_listeners(self):
+ pass
+ def register_listeners(self):
+ if self.library.listeners:
+ try:
+ listeners = EXECUTION_CONTEXTS.current.output.library_listeners
+ listeners.register(self.library)
+ except DataError as err:
+ self.library._has_listeners = False
+ self.library.report_error(f"Registering listeners failed: {err}")
-class TestSuiteScope(GlobalScope):
- is_global = False
+ def unregister_listeners(self, close=False):
+ if self.library.listeners:
+ listeners = EXECUTION_CONTEXTS.current.output.library_listeners
+ listeners.unregister(self.library, close)
- def __init__(self, library):
- GlobalScope.__init__(self, library)
- self._reset_instance = library.reset_instance
- self._instance_cache = []
+
+class GlobalScopeManager(ScopeManager):
def start_suite(self):
- prev = self._reset_instance()
- self._instance_cache.append(prev)
- self._register_listeners()
+ self.register_listeners()
def end_suite(self):
- self._unregister_listeners(close=True)
- prev = self._instance_cache.pop()
- self._reset_instance(prev)
+ self.unregister_listeners()
+
+ def close_global_listeners(self):
+ self.register_listeners()
+ self.unregister_listeners(close=True)
- def __str__(self):
- return 'SUITE'
+class SuiteScopeManager(ScopeManager):
+
+ def __init__(self, library):
+ super().__init__(library)
+ self.instance_cache = []
+
+ def start_suite(self):
+ self.instance_cache.append(self.library._instance)
+ self.library.instance = None
+ self.register_listeners()
+
+ def end_suite(self):
+ self.unregister_listeners(close=True)
+ self.library.instance = self.instance_cache.pop()
-class TestCaseScope(TestSuiteScope):
+
+class TestScopeManager(SuiteScopeManager):
def start_test(self):
- self._unregister_listeners()
- prev = self._reset_instance()
- self._instance_cache.append(prev)
- self._register_listeners()
+ self.unregister_listeners()
+ self.instance_cache.append(self.library._instance)
+ self.library.instance = None
+ self.register_listeners()
def end_test(self):
- self._unregister_listeners(close=True)
- prev = self._instance_cache.pop()
- self._reset_instance(prev)
- self._register_listeners()
-
- def __str__(self):
- return 'TEST'
+ self.unregister_listeners(close=True)
+ self.library.instance = self.instance_cache.pop()
+ self.register_listeners()
diff --git a/src/robot/running/model.py b/src/robot/running/model.py
index 391313926c6..09501d165bd 100644
--- a/src/robot/running/model.py
+++ b/src/robot/running/model.py
@@ -15,296 +15,799 @@
"""Module implementing test execution related model objects.
-When tests are executed normally, these objects are created based on the test
-data on the file system by :class:`~.builder.TestSuiteBuilder`, but external
-tools can also create an executable test suite model structure directly.
-Regardless the approach to create it, the model is executed by calling
-:meth:`~TestSuite.run` method of the root test suite. See the
-:mod:`robot.running` package level documentation for more information and
-examples.
-
-The most important classes defined in this module are :class:`TestSuite`,
-:class:`TestCase` and :class:`Keyword`. When tests are executed, these objects
-can be inspected and modified by `pre-run modifiers`__ and `listeners`__.
-The aforementioned objects are considered stable, but other objects in this
-module may still be changed in the future major releases.
+When tests are executed by Robot Framework, a :class:`TestSuite` structure using
+classes defined in this module is created by
+:class:`~robot.running.builder.builders.TestSuiteBuilder`
+based on data on a file system. In addition to that, external tools can
+create executable suite structures programmatically.
+
+Regardless the approach to construct it, a :class:`TestSuite` object is executed
+by calling its :meth:`~TestSuite.run` method as shown in the example in
+the :mod:`robot.running` package level documentation. When a suite is run,
+test, keywords, and other objects it contains can be inspected and modified
+by using `pre-run modifiers`__ and `listeners`__.
+
+The :class:`TestSuite` class is exposed via the :mod:`robot.api` package. If other
+classes are needed, they can be imported from :mod:`robot.running`.
__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#programmatic-modification-of-results
__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface
"""
-import os
+import warnings
+from pathlib import Path
+from typing import Any, Literal, Mapping, Sequence, TYPE_CHECKING, TypeVar, Union
from robot import model
from robot.conf import RobotSettings
-from robot.errors import BreakLoop, ContinueLoop, ReturnFromKeyword, DataError
-from robot.model import Keywords, BodyItem
+from robot.errors import (
+ BreakLoop, ContinueLoop, DataError, ReturnFromKeyword, VariableError
+)
+from robot.model import BodyItem, DataDict, TestSuites
from robot.output import LOGGER, Output, pyloggingconf
-from robot.result import (Break as BreakResult, Continue as ContinueResult,
- Return as ReturnResult)
-from robot.utils import seq2str, setter
+from robot.result import Result
+from robot.utils import format_assign_message, setter
+from robot.variables import VariableResolver
-from .bodyrunner import ForRunner, IfRunner, KeywordRunner, TryRunner, WhileRunner
+from .bodyrunner import (
+ ForRunner, GroupRunner, IfRunner, KeywordRunner, TryRunner, WhileRunner
+)
from .randomizer import Randomizer
from .statusreporter import StatusReporter
+if TYPE_CHECKING:
+ from robot.parsing import File
+
+ from .builder import TestDefaults
+ from .resourcemodel import ResourceFile, UserKeyword
+
+
+IT = TypeVar("IT", bound="IfBranch|TryBranch")
+BodyItemParent = Union[
+ "TestSuite", "TestCase", "UserKeyword", "For", "While", "If", "IfBranch",
+ "Try", "TryBranch", "Group", None
+] # fmt: skip
+
+
+class Body(model.BaseBody[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "model.Message", "Error"
+]): # fmt: skip
+ __slots__ = ()
+
+
+class Branches(model.BaseBranches[
+ "Keyword", "For", "While", "Group", "If", "Try", "Var", "Return", "Continue",
+ "Break", "model.Message", "Error", IT
+]): # fmt: skip
+ __slots__ = ()
+
+
+class WithSource:
+ parent: BodyItemParent
+ __slots__ = ()
+
+ @property
+ def source(self) -> "Path|None":
+ return self.parent.source if self.parent is not None else None
+
+
+class Argument:
+ """A temporary API for creating named arguments with non-string values.
+
+ This class was added in RF 7.0.1 (#5031) after a failed attempt to add a public
+ API for this purpose in RF 7.0 (#5000). A better public API that allows passing
+ named arguments separately was added in RF 7.1 (#5143).
+
+ If you need to support also RF 7.0, you can pass named arguments as two-item tuples
+ like `(name, value)` and positional arguments as one-item tuples like `(value,)`.
+ That approach does not work anymore in RF 7.0.1, though, so the code needs to be
+ conditional depending on Robot Framework version.
+
+ The main limitation of this class is that it is not compatible with the JSON model.
+ The current plan is to remove this in the future, possibly already in RF 8.0, but
+ we can consider preserving it if it turns out to be useful.
+ """
+
+ def __init__(self, name: "str|None", value: Any):
+ """
+ :param name: Argument name. If ``None``, argument is considered positional.
+ :param value: Argument value.
+ """
+ self.name = name
+ self.value = value
-class Body(model.Body):
- __slots__ = []
+ def __str__(self):
+ return str(self.value) if self.name is None else f"{self.name}={self.value}"
@Body.register
-class Keyword(model.Keyword):
- """Represents a single executable keyword.
+class Keyword(model.Keyword, WithSource):
+ """Represents an executable keyword call.
- These keywords never have child keywords or messages. The actual keyword
- that is executed depends on the context where this model is executed.
+ A keyword call consists only of a keyword name, arguments and possible
+ assignment in the data::
- See the base class for documentation of attributes not documented here.
+ Keyword arg
+ ${result} = Another Keyword arg1 arg2
+
+ The actual keyword that is executed depends on the context where this model
+ is executed.
+
+ Arguments originating from normal Robot Framework data are stored in the
+ :attr:`args` attribute as a tuple of strings in the exact same format as in
+ the data. This means that arguments can have variables and escape characters,
+ and that named arguments are specified using the ``name=value`` syntax.
+
+ When creating keywords programmatically, it is possible to set :attr:`named_args`
+ separately and use :attr:`args` only for positional arguments. Argument values
+ do not need to be strings, but also in this case strings can contain variables
+ and normal Robot Framework escaping rules must be taken into account.
"""
- __slots__ = ['lineno']
- def __init__(self, name='', doc='', args=(), assign=(), tags=(), timeout=None,
- type=BodyItem.KEYWORD, parent=None, lineno=None):
- super().__init__(name, doc, args, assign, tags, timeout, type, parent)
+ __slots__ = ("named_args", "lineno")
+
+ def __init__(
+ self,
+ name: str = "",
+ args: "Sequence[str|Argument|Any]" = (),
+ named_args: "Mapping[str, Any]|None" = None,
+ assign: Sequence[str] = (),
+ type: str = BodyItem.KEYWORD,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ ):
+ super().__init__(name, args, assign, type, parent)
+ self.named_args = named_args
self.lineno = lineno
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.named_args is not None:
+ data["named_args"] = self.named_args
+ if self.lineno:
+ data["lineno"] = self.lineno
+ return data
- def run(self, context, run=True, templated=None):
- return KeywordRunner(context, run).run(self)
+ def run(self, result, context, run=True, templated=None):
+ return KeywordRunner(context, run).run(self, result.body.create_keyword())
+
+
+class ForIteration(model.ForIteration, WithSource):
+ body_class = Body
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ assign: "Mapping[str, str]|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(assign, parent)
+ self.lineno = lineno
+ self.error = error
@Body.register
-class For(model.For):
- __slots__ = ['lineno', 'error']
+class For(model.For, WithSource):
body_class = Body
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ assign: Sequence[str] = (),
+ flavor: Literal["IN", "IN RANGE", "IN ENUMERATE", "IN ZIP"] = "IN",
+ values: Sequence[str] = (),
+ start: "str|None" = None,
+ mode: "str|None" = None,
+ fill: "str|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(assign, flavor, values, start, mode, fill, parent)
+ self.lineno = lineno
+ self.error = error
- def __init__(self, variables, flavor, values, parent=None, lineno=None, error=None):
- super().__init__(variables, flavor, values, parent)
+ @classmethod
+ def from_dict(cls, data: DataDict) -> "For":
+ # RF 6.1 compatibility
+ if "variables" in data:
+ data["assign"] = data.pop("variables")
+ return super().from_dict(data)
+
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
+
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_for(
+ self.assign,
+ self.flavor,
+ self.values,
+ self.start,
+ self.mode,
+ self.fill,
+ )
+ return ForRunner(context, self.flavor, run, templated).run(self, result)
+
+ def get_iteration(self, assign: "Mapping[str, str]|None" = None) -> ForIteration:
+ iteration = ForIteration(assign, self, self.lineno, self.error)
+ iteration.body = [item.to_dict() for item in self.body]
+ return iteration
+
+
+class WhileIteration(model.WhileIteration, WithSource):
+ body_class = Body
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
- def run(self, context, run=True, templated=False):
- return ForRunner(context, self.flavor, run, templated).run(self)
+@Body.register
+class While(model.While, WithSource):
+ body_class = Body
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ condition: "str|None" = None,
+ limit: "str|None" = None,
+ on_limit: "str|None" = None,
+ on_limit_message: "str|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(condition, limit, on_limit, on_limit_message, parent)
+ self.lineno = lineno
+ self.error = error
+
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
+
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_while(
+ self.condition,
+ self.limit,
+ self.on_limit,
+ self.on_limit_message,
+ )
+ return WhileRunner(context, run, templated).run(self, result)
+
+ def get_iteration(self) -> WhileIteration:
+ iteration = WhileIteration(self, self.lineno, self.error)
+ iteration.body = [item.to_dict() for item in self.body]
+ return iteration
@Body.register
-class While(model.While):
- __slots__ = ['lineno', 'error']
+class Group(model.Group, WithSource):
body_class = Body
-
- def __init__(self, condition=None, limit=None, parent=None, lineno=None, error=None):
- super().__init__(condition, limit, parent)
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ name: str = "",
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(name, parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
- def run(self, context, run=True, templated=False):
- return WhileRunner(context, run, templated).run(self)
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_group(self.name)
+ return GroupRunner(context, run, templated).run(self, result)
-class IfBranch(model.IfBranch):
- __slots__ = ['lineno']
+class IfBranch(model.IfBranch, WithSource):
body_class = Body
-
- def __init__(self, type=BodyItem.IF, condition=None, parent=None, lineno=None):
+ __slots__ = ("lineno",)
+
+ def __init__(
+ self,
+ type: str = BodyItem.IF,
+ condition: "str|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ ):
super().__init__(type, condition, parent)
self.lineno = lineno
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ return data
@Body.register
-class If(model.If):
- __slots__ = ['lineno', 'error']
+class If(model.If, WithSource):
branch_class = IfBranch
-
- def __init__(self, parent=None, lineno=None, error=None):
+ branches_class = Branches[branch_class]
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
super().__init__(parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def run(self, result, context, run=True, templated=False):
+ return IfRunner(context, run, templated).run(self, result.body.create_if())
- def run(self, context, run=True, templated=False):
- return IfRunner(context, run, templated).run(self)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
-class TryBranch(model.TryBranch):
- __slots__ = ['lineno']
+class TryBranch(model.TryBranch, WithSource):
body_class = Body
-
- def __init__(self, type=BodyItem.TRY, patterns=(), pattern_type=None,
- variable=None, parent=None, lineno=None):
- super().__init__(type, patterns, pattern_type, variable, parent)
+ __slots__ = ("lineno",)
+
+ def __init__(
+ self,
+ type: str = BodyItem.TRY,
+ patterns: Sequence[str] = (),
+ pattern_type: "str|None" = None,
+ assign: "str|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ ):
+ super().__init__(type, patterns, pattern_type, assign, parent)
self.lineno = lineno
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ @classmethod
+ def from_dict(cls, data: DataDict) -> "TryBranch":
+ # RF 6.1 compatibility.
+ if "variable" in data:
+ data["assign"] = data.pop("variable")
+ return super().from_dict(data)
+
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ return data
@Body.register
-class Try(model.Try):
- __slots__ = ['lineno', 'error']
+class Try(model.Try, WithSource):
branch_class = TryBranch
-
- def __init__(self, parent=None, lineno=None, error=None):
+ branches_class = Branches[branch_class]
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
super().__init__(parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def run(self, result, context, run=True, templated=False):
+ return TryRunner(context, run, templated).run(self, result.body.create_try())
- def run(self, context, run=True, templated=False):
- return TryRunner(context, run, templated).run(self)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
@Body.register
-class Return(model.Return):
- __slots__ = ['lineno', 'error']
+class Var(model.Var, WithSource):
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ name: str = "",
+ value: "str|Sequence[str]" = (),
+ scope: "str|None" = None,
+ separator: "str|None" = None,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(name, value, scope, separator, parent)
+ self.lineno = lineno
+ self.error = error
+
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_var(
+ self.name,
+ self.value,
+ self.scope,
+ self.separator,
+ )
+ with StatusReporter(self, result, context, run):
+ if self.error and run:
+ raise DataError(self.error, syntax=True)
+ if not run or context.dry_run:
+ return
+ scope, config = self._get_scope(context.variables)
+ if scope != "local" and not self.value and self.name[:1] == "$":
+ context.warn(
+ f"Using the VAR syntax to create a scalar variable without "
+ f"a value in other than the local scope like "
+ f"'VAR {self.name} scope={self.scope}' "
+ f"is deprecated. In the future this syntax will promote "
+ f"an existing variable to the new scope. Use "
+ f"'VAR {self.name} ${{EMPTY}} scope={self.scope}' "
+ f"instead."
+ )
+ set_variable = getattr(context.variables, f"set_{scope}")
+ try:
+ name, value = self._resolve_name_and_value(context.variables)
+ set_variable(name, value, **config)
+ context.info(format_assign_message(name, value))
+ except DataError as err:
+ raise VariableError(f"Setting variable '{self.name}' failed: {err}")
+
+ def _get_scope(self, variables):
+ if not self.scope:
+ return "local", {}
+ try:
+ scope = variables.replace_string(self.scope)
+ if scope.upper() == "TASK":
+ return "test", {}
+ if scope.upper() == "SUITES":
+ return "suite", {"children": True}
+ if scope.upper() in ("LOCAL", "TEST", "SUITE", "GLOBAL"):
+ return scope.lower(), {}
+ raise DataError(
+ f"Value '{scope}' is not accepted. Valid values are "
+ f"'LOCAL', 'TEST', 'TASK', 'SUITE', 'SUITES' and 'GLOBAL'."
+ )
+ except DataError as err:
+ raise DataError(f"Invalid VAR scope: {err}")
+
+ def _resolve_name_and_value(self, variables):
+ resolver = VariableResolver.from_variable(self)
+ resolver.resolve(variables)
+ return resolver.name, resolver.value
+
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
+
- def __init__(self, values=(), parent=None, lineno=None, error=None):
+@Body.register
+class Return(model.Return, WithSource):
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ values: Sequence[str] = (),
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
super().__init__(values, parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
-
- def run(self, context, run=True, templated=False):
- with StatusReporter(self, ReturnResult(self.values), context, run):
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_return(self.values)
+ with StatusReporter(self, result, context, run):
if run:
if self.error:
- raise DataError(self.error)
- raise ReturnFromKeyword(self.values)
+ raise DataError(self.error, syntax=True)
+ if not context.dry_run:
+ raise ReturnFromKeyword(self.values)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
-@Body.register
-class Continue(model.Continue):
- __slots__ = ['lineno', 'error']
- def __init__(self, parent=None, lineno=None, error=None):
+@Body.register
+class Continue(model.Continue, WithSource):
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
super().__init__(parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
-
- def run(self, context, run=True, templated=False):
- with StatusReporter(self, ContinueResult(), context, run):
- if self.error:
- raise DataError(self.error)
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_continue()
+ with StatusReporter(self, result, context, run):
if run:
- raise ContinueLoop()
+ if self.error:
+ raise DataError(self.error, syntax=True)
+ if not context.dry_run:
+ raise ContinueLoop
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
-@Body.register
-class Break(model.Break):
- __slots__ = ['lineno', 'error']
- def __init__(self, parent=None, lineno=None, error=None):
+@Body.register
+class Break(model.Break, WithSource):
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
super().__init__(parent)
self.lineno = lineno
self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_break()
+ with StatusReporter(self, result, context, run):
+ if run:
+ if self.error:
+ raise DataError(self.error, syntax=True)
+ if not context.dry_run:
+ raise BreakLoop
- def run(self, context, run=True, templated=False):
- with StatusReporter(self, BreakResult(), context, run):
- if self.error:
- raise DataError(self.error)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
+
+
+@Body.register
+class Error(model.Error, WithSource):
+ __slots__ = ("lineno", "error")
+
+ def __init__(
+ self,
+ values: Sequence[str] = (),
+ parent: BodyItemParent = None,
+ lineno: "int|None" = None,
+ error: str = "",
+ ):
+ super().__init__(values, parent)
+ self.lineno = lineno
+ self.error = error
+
+ def run(self, result, context, run=True, templated=False):
+ result = result.body.create_error(self.values)
+ with StatusReporter(self, result, context, run):
if run:
- raise BreakLoop()
+ raise DataError(self.error)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.lineno:
+ data["lineno"] = self.lineno
+ data["error"] = self.error
+ return data
-class TestCase(model.TestCase):
+
+class TestCase(model.TestCase[Keyword]):
"""Represents a single executable test case.
See the base class for documentation of attributes not documented here.
"""
- __slots__ = ['template']
- body_class = Body #: Internal usage only.
- fixture_class = Keyword #: Internal usage only.
- def __init__(self, name='', doc='', tags=None, timeout=None, template=None,
- lineno=None):
- super().__init__(name, doc, tags, timeout, lineno)
+ body_class = Body #: Internal usage only.
+ fixture_class = Keyword #: Internal usage only.
+ __slots__ = ("template", "error")
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ tags: Sequence[str] = (),
+ timeout: "str|None" = None,
+ lineno: "int|None" = None,
+ parent: "TestSuite|None" = None,
+ template: "str|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(name, doc, tags, timeout, lineno, parent)
#: Name of the keyword that has been used as a template when building the test.
# ``None`` if template is not used.
self.template = template
+ self.error = error
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ if self.template:
+ data["template"] = self.template
+ if self.error:
+ data["error"] = self.error
+ return data
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ """Test body as a :class:`~robot.running.Body` object."""
+ return self.body_class(self, body)
-class TestSuite(model.TestSuite):
+class TestSuite(model.TestSuite[Keyword, TestCase]):
"""Represents a single executable test suite.
See the base class for documentation of attributes not documented here.
"""
- __slots__ = ['resource']
- test_class = TestCase #: Internal usage only.
- fixture_class = Keyword #: Internal usage only.
- def __init__(self, name='', doc='', metadata=None, source=None, rpa=None):
- super().__init__(name, doc, metadata, source, rpa)
+ test_class = TestCase #: Internal usage only.
+ fixture_class = Keyword #: Internal usage only.
+ __slots__ = ()
+
+ def __init__(
+ self,
+ name: str = "",
+ doc: str = "",
+ metadata: "Mapping[str, str]|None" = None,
+ source: "Path|str|None" = None,
+ rpa: "bool|None" = False,
+ parent: "TestSuite|None" = None,
+ ):
+ super().__init__(name, doc, metadata, source, rpa, parent)
#: :class:`ResourceFile` instance containing imports, variables and
#: keywords the suite owns. When data is parsed from the file system,
#: this data comes from the same test case file that creates the suite.
- self.resource = ResourceFile(source=source)
+ self.resource = None
+
+ @setter
+ def resource(self, resource: "ResourceFile|dict|None") -> "ResourceFile":
+ from .resourcemodel import ResourceFile
+
+ if resource is None:
+ resource = ResourceFile()
+ if isinstance(resource, dict):
+ resource = ResourceFile.from_dict(resource)
+ resource.owner = self
+ return resource
@classmethod
- def from_file_system(cls, *paths, **config):
+ def from_file_system(cls, *paths: "Path|str", **config) -> "TestSuite":
"""Create a :class:`TestSuite` object based on the given ``paths``.
- ``paths`` are file or directory paths where to read the data from.
+ :param paths: File or directory paths where to read the data from.
+ :param config: Configuration parameters for :class:`~.builders.TestSuiteBuilder`
+ class that is used internally for building the suite.
- Internally utilizes the :class:`~.builders.TestSuiteBuilder` class
- and ``config`` can be used to configure how it is initialized.
-
- New in Robot Framework 3.2.
+ See also :meth:`from_model` and :meth:`from_string`.
"""
from .builder import TestSuiteBuilder
+
return TestSuiteBuilder(**config).build(*paths)
@classmethod
- def from_model(cls, model, name=None):
+ def from_model(
+ cls,
+ model: "File",
+ name: "str|None" = None,
+ *,
+ defaults: "TestDefaults|None" = None,
+ ) -> "TestSuite":
"""Create a :class:`TestSuite` object based on the given ``model``.
+ :param model: Model to create the suite from.
+ :param name: Deprecated since Robot Framework 6.1.
+ :param defaults: Possible test specific defaults from suite
+ initialization files. New in Robot Framework 6.1.
+
The model can be created by using the
:func:`~robot.parsing.parser.parser.get_model` function and possibly
modified by other tooling in the :mod:`robot.parsing` module.
- New in Robot Framework 3.2.
+ Giving suite name is deprecated and users should set it and possible
+ other attributes to the returned suite separately. One easy way is using
+ the :meth:`config` method like this::
+
+ suite = TestSuite.from_model(model).config(name='X', doc='Example')
+
+ See also :meth:`from_file_system` and :meth:`from_string`.
"""
from .builder import RobotParser
- return RobotParser().build_suite(model, name)
- def configure(self, randomize_suites=False, randomize_tests=False,
- randomize_seed=None, **options):
+ suite = RobotParser().parse_model(model, defaults)
+ if name is not None:
+ # TODO: Remove 'name' in RF 8.0.
+ warnings.warn(
+ "'name' argument of 'TestSuite.from_model' is deprecated. "
+ "Set the name to the returned suite separately."
+ )
+ suite.name = name
+ return suite
+
+ @classmethod
+ def from_string(
+ cls,
+ string: str,
+ *,
+ defaults: "TestDefaults|None" = None,
+ **config,
+ ) -> "TestSuite":
+ """Create a :class:`TestSuite` object based on the given ``string``.
+
+ :param string: String to create the suite from.
+ :param defaults: Possible test specific defaults from suite
+ initialization files.
+ :param config: Configuration parameters for
+ :func:`~robot.parsing.parser.parser.get_model` used internally.
+
+ If suite name or other attributes need to be set, an easy way is using
+ the :meth:`config` method like this::
+
+ suite = TestSuite.from_string(string).config(name='X', doc='Example')
+
+ New in Robot Framework 6.1. See also :meth:`from_model` and
+ :meth:`from_file_system`.
+ """
+ from robot.parsing import get_model
+
+ model = get_model(string, data_only=True, **config)
+ return cls.from_model(model, defaults=defaults)
+
+ def configure(
+ self,
+ randomize_suites: bool = False,
+ randomize_tests: bool = False,
+ randomize_seed: "int|None" = None,
+ **options,
+ ):
"""A shortcut to configure a suite using one method call.
Can only be used with the root test suite.
@@ -316,17 +819,22 @@ def configure(self, randomize_suites=False, randomize_tests=False,
Example::
- suite.configure(included_tags=['smoke'],
+ suite.configure(include_tags=['smoke'],
doc='Smoke test results.')
Not to be confused with :meth:`config` method that suites, tests,
and keywords have to make it possible to set multiple attributes in
one call.
"""
- model.TestSuite.configure(self, **options)
+ super().configure(**options)
self.randomize(randomize_suites, randomize_tests, randomize_seed)
- def randomize(self, suites=True, tests=True, seed=None):
+ def randomize(
+ self,
+ suites: bool = True,
+ tests: bool = True,
+ seed: "int|None" = None,
+ ):
"""Randomizes the order of suites and/or tests, recursively.
:param suites: Boolean controlling should suites be randomized.
@@ -336,8 +844,12 @@ def randomize(self, suites=True, tests=True, seed=None):
"""
self.visit(Randomizer(suites, tests, seed))
- def run(self, settings=None, **options):
- """Executes the suite based based the given ``settings`` or ``options``.
+ @setter
+ def suites(self, suites: "Sequence[TestSuite|DataDict]") -> TestSuites["TestSuite"]:
+ return TestSuites["TestSuite"](self.__class__, self, suites)
+
+ def run(self, settings=None, **options) -> Result:
+ """Executes the suite based on the given ``settings`` or ``options``.
:param settings: :class:`~robot.conf.settings.RobotSettings` object
to configure test execution.
@@ -355,7 +867,7 @@ def run(self, settings=None, **options):
If such an option is used only once, it can be given also as a single
string like ``variable='VAR:value'``.
- Additionally listener option allows passing object directly instead of
+ Additionally, listener option allows passing object directly instead of
listener name, e.g. ``run('tests.robot', listener=Listener())``.
To capture stdout and/or stderr streams, pass open file objects in as
@@ -407,134 +919,7 @@ def run(self, settings=None, **options):
output.close(runner.result)
return runner.result
-
-class Variable:
-
- def __init__(self, name, value, source=None, lineno=None, error=None):
- self.name = name
- self.value = value
- self.source = source
- self.lineno = lineno
- self.error = error
-
- def report_invalid_syntax(self, message, level='ERROR'):
- source = self.source or ''
- line = ' on line %s' % self.lineno if self.lineno is not None else ''
- LOGGER.write("Error in file '%s'%s: Setting variable '%s' failed: %s"
- % (source, line, self.name, message), level)
-
-
-class ResourceFile:
-
- def __init__(self, doc='', source=None):
- self.doc = doc
- self.source = source
- self.imports = []
- self.keywords = []
- self.variables = []
-
- @setter
- def imports(self, imports):
- return Imports(self.source, imports)
-
- @setter
- def keywords(self, keywords):
- return model.ItemList(UserKeyword, {'parent': self}, items=keywords)
-
- @setter
- def variables(self, variables):
- return model.ItemList(Variable, {'source': self.source}, items=variables)
-
-
-class UserKeyword:
-
- def __init__(self, name, args=(), doc='', tags=(), return_=None,
- timeout=None, lineno=None, parent=None, error=None):
- self.name = name
- self.args = args
- self.doc = doc
- self.tags = tags
- self.return_ = return_ or ()
- self.timeout = timeout
- self.lineno = lineno
- self.parent = parent
- self.error = error
- self.body = None
- self._teardown = None
-
- @setter
- def body(self, body):
- """Child keywords as a :class:`~.Body` object."""
- return Body(self, body)
-
- @property
- def keywords(self):
- """Deprecated since Robot Framework 4.0.
-
- Use :attr:`body` or :attr:`teardown` instead.
- """
- kws = list(self.body)
- if self.teardown:
- kws.append(self.teardown)
- return Keywords(self, kws)
-
- @keywords.setter
- def keywords(self, keywords):
- Keywords.raise_deprecation_error()
-
- @property
- def teardown(self):
- if self._teardown is None:
- self._teardown = Keyword(None, parent=self, type=Keyword.TEARDOWN)
- return self._teardown
-
- @setter
- def tags(self, tags):
- return model.Tags(tags)
-
- @property
- def source(self):
- return self.parent.source if self.parent is not None else None
-
-
-class Import:
- ALLOWED_TYPES = ('Library', 'Resource', 'Variables')
-
- def __init__(self, type, name, args=(), alias=None, source=None, lineno=None):
- if type not in self.ALLOWED_TYPES:
- raise ValueError("Invalid import type '%s'. Should be one of %s."
- % (type, seq2str(self.ALLOWED_TYPES, lastsep=' or ')))
- self.type = type
- self.name = name
- self.args = args
- self.alias = alias
- self.source = source
- self.lineno = lineno
-
- @property
- def directory(self):
- if not self.source:
- return None
- if os.path.isdir(self.source):
- return self.source
- return os.path.dirname(self.source)
-
- def report_invalid_syntax(self, message, level='ERROR'):
- source = self.source or ''
- line = ' on line %s' % self.lineno if self.lineno is not None else ''
- LOGGER.write("Error in file '%s'%s: %s" % (source, line, message), level)
-
-
-class Imports(model.ItemList):
-
- def __init__(self, source, imports=None):
- super().__init__(Import, {'source': source}, items=imports)
-
- def library(self, name, args=(), alias=None, lineno=None):
- self.create('Library', name, args, alias, lineno)
-
- def resource(self, path, lineno=None):
- self.create('Resource', path, lineno)
-
- def variables(self, path, args=(), lineno=None):
- self.create('Variables', path, args, lineno)
+ def to_dict(self) -> DataDict:
+ data = super().to_dict()
+ data["resource"] = self.resource.to_dict()
+ return data
diff --git a/src/robot/running/namespace.py b/src/robot/running/namespace.py
index dfb2785d732..ee828b3cd45 100644
--- a/src/robot/running/namespace.py
+++ b/src/robot/running/namespace.py
@@ -16,35 +16,40 @@
import copy
import os
from collections import OrderedDict
-from itertools import chain
+from robot.conf import Languages
from robot.errors import DataError, KeywordError
from robot.libraries import STDLIBS
from robot.output import LOGGER, Message
-from robot.utils import (RecommendationFinder, eq, find_file, is_string,
- normalize, printable_name, seq2str2)
+from robot.utils import eq, find_file, normalize, RecommendationFinder, seq2str2
+from .context import EXECUTION_CONTEXTS
from .importer import ImportCache, Importer
-from .model import Import
+from .invalidkeyword import InvalidKeyword
+from .resourcemodel import Import
from .runkwregister import RUN_KW_REGISTER
-from .usererrorhandler import UserErrorHandler
-from .userkeyword import UserLibrary
IMPORTER = Importer()
class Namespace:
- _default_libraries = ('BuiltIn', 'Reserved', 'Easter')
- _library_import_by_path_ends = ('.py', '/', os.sep)
- _variables_import_by_path_ends = _library_import_by_path_ends + ('.yaml', '.yml')
-
- def __init__(self, variables, suite, resource):
- LOGGER.info(f"Initializing namespace for suite '{suite.longname}'.")
+ _default_libraries = ("BuiltIn", "Easter")
+ _library_import_by_path_ends = (".py", "/", os.sep)
+ _variables_import_by_path_ends = (
+ *_library_import_by_path_ends,
+ ".yaml",
+ ".yml",
+ ".json",
+ )
+
+ def __init__(self, variables, suite, resource, languages):
+ LOGGER.info(f"Initializing namespace for suite '{suite.full_name}'.")
self.variables = variables
+ self.languages = languages
self._imports = resource.imports
- self._kw_store = KeywordStore(resource)
+ self._kw_store = KeywordStore(resource, languages)
self._imported_variable_files = ImportCache()
- self._suite_name = suite.longname
+ self._suite_name = suite.full_name
self._running_test = False
@property
@@ -57,89 +62,95 @@ def handle_imports(self):
def _import_default_libraries(self):
for name in self._default_libraries:
- self.import_library(name, notify=name == 'BuiltIn')
+ self._import_library(Import(Import.LIBRARY, name), notify=name == "BuiltIn")
def _handle_imports(self, import_settings):
for item in import_settings:
try:
if not item.name:
- raise DataError(f'{item.type} setting requires value.')
+ raise DataError(f"{item.setting_name} setting requires value.")
self._import(item)
except DataError as err:
- item.report_invalid_syntax(err.message)
+ item.report_error(err.message)
def _import(self, import_setting):
- action = {'Library': self._import_library,
- 'Resource': self._import_resource,
- 'Variables': self._import_variables}[import_setting.type]
+ action = import_setting.select(
+ self._import_library,
+ self._import_resource,
+ self._import_variables,
+ )
action(import_setting)
def import_resource(self, name, overwrite=True):
- self._import_resource(Import('Resource', name), overwrite=overwrite)
-
- def _import_resource(self, import_setting, overwrite=False):
- path = self._resolve_name(import_setting)
+ owner, lineno = self._current_owner_and_lineno()
+ import_ = Import(Import.RESOURCE, name, owner=owner, lineno=lineno)
+ self._import_resource(import_, overwrite=overwrite)
+
+ def _current_owner_and_lineno(self):
+ ctx = EXECUTION_CONTEXTS.current
+ if not ctx.steps:
+ return None, -1
+ owner = ctx.steps[-1][0]
+ return owner, owner.lineno
+
+ def _import_resource(self, import_, overwrite=False):
+ path = self._resolve_name(import_)
self._validate_not_importing_init_file(path)
if overwrite or path not in self._kw_store.resources:
- resource = IMPORTER.import_resource(path)
- self.variables.set_from_variable_table(resource.variables, overwrite)
- user_library = UserLibrary(resource)
- self._kw_store.resources[path] = user_library
+ resource = IMPORTER.import_resource(path, self.languages)
+ self.variables.set_from_variable_section(resource.variables, overwrite)
+ self._kw_store.resources[path] = resource
self._handle_imports(resource.imports)
- LOGGER.imported("Resource", user_library.name,
- importer=import_setting.source,
- source=path)
+ LOGGER.resource_import(resource, import_)
else:
- LOGGER.info(f"Resource file '{path}' already imported by "
- f"suite '{self._suite_name}'.")
+ name = self._suite_name
+ LOGGER.info(f"Resource file '{path}' already imported by suite '{name}'.")
def _validate_not_importing_init_file(self, path):
name = os.path.splitext(os.path.basename(path))[0]
- if name.lower() == '__init__':
- raise DataError(f"Initialization file '{path}' cannot be imported as "
- f"a resource file.")
+ if name.lower() == "__init__":
+ raise DataError(
+ f"Initialization file '{path}' cannot be imported as a resource file."
+ )
def import_variables(self, name, args, overwrite=False):
- self._import_variables(Import('Variables', name, args), overwrite)
+ owner, lineno = self._current_owner_and_lineno()
+ import_ = Import(Import.VARIABLES, name, args, owner=owner, lineno=lineno)
+ self._import_variables(import_, overwrite=overwrite)
- def _import_variables(self, import_setting, overwrite=False):
- path = self._resolve_name(import_setting)
- args = self._resolve_args(import_setting)
+ def _import_variables(self, import_, overwrite=False):
+ path = self._resolve_name(import_)
+ args = self._resolve_args(import_)
if overwrite or (path, args) not in self._imported_variable_files:
self._imported_variable_files.add((path, args))
self.variables.set_from_file(path, args, overwrite)
- LOGGER.imported("Variables", os.path.basename(path),
- args=list(args),
- importer=import_setting.source,
- source=path)
+ LOGGER.variables_import(
+ {"name": os.path.basename(path), "args": args, "source": path},
+ importer=import_,
+ )
else:
msg = f"Variable file '{path}'"
if args:
msg += f" with arguments {seq2str2(args)}"
LOGGER.info(f"{msg} already imported by suite '{self._suite_name}'.")
- def import_library(self, name, args=(), alias=None, notify=True):
- self._import_library(Import('Library', name, args, alias),
- notify=notify)
+ def import_library(self, name, args=(), alias=None):
+ owner, lineno = self._current_owner_and_lineno()
+ import_ = Import(Import.LIBRARY, name, args, alias, owner, lineno)
+ self._import_library(import_)
- def _import_library(self, import_setting, notify=True):
- name = self._resolve_name(import_setting)
- lib = IMPORTER.import_library(name, import_setting.args,
- import_setting.alias, self.variables)
+ def _import_library(self, import_, notify=True):
+ name = self._resolve_name(import_)
+ lib = IMPORTER.import_library(name, import_.args, import_.alias, self.variables)
if lib.name in self._kw_store.libraries:
- LOGGER.info(f"Library '{lib.name}' already imported by suite "
- f"'{self._suite_name}'.")
+ self._duplicate_library_import_warning(lib, import_.source, import_.lineno)
return
if notify:
- LOGGER.imported("Library", lib.name,
- args=list(import_setting.args),
- originalname=lib.orig_name,
- importer=import_setting.source,
- source=lib.source)
+ LOGGER.library_import(lib, import_)
self._kw_store.libraries[lib.name] = lib
- lib.start_suite()
+ lib.scope_manager.start_suite()
if self._running_test:
- lib.start_test()
+ lib.scope_manager.start_test()
def _resolve_name(self, setting):
name = setting.name
@@ -148,20 +159,43 @@ def _resolve_name(self, setting):
except DataError as err:
self._raise_replacing_vars_failed(setting, err)
if self._is_import_by_path(setting.type, name):
- return find_file(name, setting.directory, file_type=setting.type)
+ file_type = setting.select("Library", "Resource file", "Variable file")
+ return find_file(name, setting.directory, file_type=file_type)
return name
def _raise_replacing_vars_failed(self, setting, error):
- raise DataError(f"Replacing variables from setting '{setting.type}' "
- f"failed: {error}")
+ raise DataError(
+ f"Replacing variables from setting '{setting.setting_name}' failed: {error}"
+ )
def _is_import_by_path(self, import_type, path):
- if import_type == 'Library':
+ if import_type == Import.LIBRARY:
return path.lower().endswith(self._library_import_by_path_ends)
- if import_type == 'Variables':
+ if import_type == Import.VARIABLES:
return path.lower().endswith(self._variables_import_by_path_ends)
return True
+ def _duplicate_library_import_warning(self, lib, source, lineno):
+ prev = self._kw_store.libraries[lib.name]
+ prefix = f"Error in file '{source}' on line {lineno}: " if source else ""
+ level = "WARN"
+ if lib.real_name != prev.real_name:
+ explanation = f"another library with name '{lib.name}'"
+ elif (
+ lib.init.positional != prev.init.positional
+ or lib.init.named != prev.init.named
+ ):
+ explanation = f"library '{lib.name}' with different arguments"
+ else:
+ explanation = f"library '{lib.name}' with same arguments"
+ prefix = ""
+ level = "INFO"
+ LOGGER.write(
+ f"{prefix}Suite '{self._suite_name}' has already imported {explanation}. "
+ f"This import is ignored.",
+ level,
+ )
+
def _resolve_args(self, import_setting):
try:
return self.variables.replace_list(import_setting.args)
@@ -177,12 +211,12 @@ def start_test(self):
self._running_test = True
self.variables.start_test()
for lib in self.libraries:
- lib.start_test()
+ lib.scope_manager.start_test()
def end_test(self):
self.variables.end_test()
for lib in self.libraries:
- lib.end_test()
+ lib.scope_manager.end_test()
self._running_test = True
def start_suite(self):
@@ -190,7 +224,7 @@ def start_suite(self):
def end_suite(self, suite):
for lib in self.libraries:
- lib.end_suite()
+ lib.scope_manager.end_suite()
if not suite.parent:
IMPORTER.close_global_library_listeners()
self.variables.end_suite()
@@ -201,37 +235,41 @@ def start_user_keyword(self):
def end_user_keyword(self):
self.variables.end_keyword()
- def get_library_instance(self, libname):
- return self._kw_store.get_library(libname).get_instance()
+ def get_library_instance(self, name):
+ return self._kw_store.get_library(name).instance
def get_library_instances(self):
- return dict((name, lib.get_instance())
- for name, lib in self._kw_store.libraries.items())
+ return {name: lib.instance for name, lib in self._kw_store.libraries.items()}
- def reload_library(self, libname_or_instance):
- library = self._kw_store.get_library(libname_or_instance)
- library.reload()
+ def reload_library(self, name_or_instance):
+ library = self._kw_store.get_library(name_or_instance)
+ library.create_keywords()
return library
- def get_runner(self, name):
+ def get_runner(self, name, recommend_on_failure=True):
+ # TODO: Consider changing the default value of `recommend_on_failure` to False.
+ # Recommendations are not needed in all contexts and collecting them has a
+ # performance effect that has caused issues #4659 and #5051. It is possible to
+ # opt-out from collecting recommendations, but making it opt-in could be safer.
try:
- return self._kw_store.get_runner(name)
- except DataError as error:
- return UserErrorHandler(error, name)
+ return self._kw_store.get_runner(name, recommend_on_failure)
+ except DataError as err:
+ return InvalidKeyword(str(name), error=str(err)).create_runner(name)
class KeywordStore:
- def __init__(self, resource):
- self.user_keywords = UserLibrary(resource, UserLibrary.TEST_CASE_FILE_TYPE)
+ def __init__(self, suite_file, languages: Languages):
+ self.suite_file = suite_file
self.libraries = OrderedDict()
self.resources = ImportCache()
self.search_order = ()
+ self.languages = languages
def get_library(self, name_or_instance):
if name_or_instance is None:
raise DataError("Library can not be None.")
- if is_string(name_or_instance):
+ if isinstance(name_or_instance, str):
return self._get_lib_by_name(name_or_instance)
return self._get_lib_by_instance(name_or_instance)
@@ -250,193 +288,293 @@ def _no_library_found(self, name, multiple=False):
def _get_lib_by_instance(self, instance):
for lib in self.libraries.values():
- if lib.get_instance(create=False) is instance:
+ if lib._instance is instance:
return lib
self._no_library_found(instance)
- def get_runner(self, name):
+ def get_runner(self, name, recommend=True):
runner = self._get_runner(name)
if runner is None:
- self._raise_no_keyword_found(name)
+ self._raise_no_keyword_found(name, recommend)
return runner
- def _raise_no_keyword_found(self, name):
- if name.strip(': ').upper() == 'FOR':
+ def _raise_no_keyword_found(self, name, recommend=True):
+ if name.strip(": ").upper() == "FOR":
raise KeywordError(
f"Support for the old FOR loop syntax has been removed. "
f"Replace '{name}' with 'FOR', end the loop with 'END', and "
f"remove escaping backslashes."
)
- if name == '\\':
+ if name == "\\":
raise KeywordError(
"No keyword with name '\\' found. If it is used inside a for "
"loop, remove escaping backslashes and end the loop with 'END'."
)
message = f"No keyword with name '{name}' found."
- finder = KeywordRecommendationFinder(self.user_keywords,
- self.libraries,
- self.resources)
- raise KeywordError(finder.recommend_similar_keywords(name, message))
+ if recommend:
+ finder = KeywordRecommendationFinder(
+ self.suite_file,
+ *self.libraries.values(),
+ *self.resources.values(),
+ )
+ raise KeywordError(finder.recommend_similar_keywords(name, message))
+ raise KeywordError(message)
- def _get_runner(self, name):
+ def _get_runner(self, name, strip_bdd_prefix=True):
if not name:
- raise DataError('Keyword name cannot be empty.')
- if not is_string(name):
- raise DataError('Keyword name must be a string.')
- runner = self._get_runner_from_test_case_file(name)
- if not runner and '.' in name:
+ raise DataError("Keyword name cannot be empty.")
+ if not isinstance(name, str):
+ raise DataError("Keyword name must be a string.")
+ runner = None
+ if strip_bdd_prefix:
+ runner = self._get_bdd_style_runner(name)
+ if runner:
+ runner = copy.copy(runner)
+ runner.name = name
+ if not runner:
+ runner = self._get_runner_from_suite_file(name)
+ if not runner and "." in name:
runner = self._get_explicit_runner(name)
if not runner:
runner = self._get_implicit_runner(name)
- if not runner:
- runner = self._get_bdd_style_runner(name)
return runner
def _get_bdd_style_runner(self, name):
- lower = name.lower()
- for prefix in ['given ', 'when ', 'then ', 'and ', 'but ']:
- if lower.startswith(prefix):
- runner = self._get_runner(name[len(prefix):])
+ # TODO: Consider using 'startswith' instead of regexps for checking does any
+ # prefix match. That ought to make that check a bit faster (especially if the
+ # tuple of prefixes is pre-built in 'Languages'), but finding the keyword if
+ # there's a match can be a bit slower. It also makes it explicit that prefixes
+ # are constants, not patterns, and allows deprecating 'bdd_prefix_regexp'.
+ match = self.languages.bdd_prefix_regexp.match(name)
+ if not match:
+ return None
+ runner = self._get_runner(name[match.end() :], strip_bdd_prefix=False)
+ if runner:
+ return runner
+ # Some prefix matched, but there was no matching keyword. Go through all
+ # prefixes individually to see were there possibly multiple matching ones.
+ # https://github.com/robotframework/robotframework/issues/5456
+ name = " ".join(name.split()).title() # Normalize spaces and case.
+ for prefix in sorted(self.languages.bdd_prefixes, key=len, reverse=True):
+ prefix += " "
+ if name.startswith(prefix):
+ runner = self._get_runner(name[len(prefix) :], strip_bdd_prefix=False)
if runner:
- runner = copy.copy(runner)
- runner.name = name
- return runner
+ return runner
return None
def _get_implicit_runner(self, name):
- runner = self._get_runner_from_resource_files(name)
- if not runner:
- runner = self._get_runner_from_libraries(name)
+ return (
+ self._get_runner_from_resource_files(name)
+ or self._get_runner_from_libraries(name)
+ ) # fmt: skip
+
+ def _get_runner_from_suite_file(self, name):
+ keywords = self.suite_file.find_keywords(name)
+ if not keywords:
+ return None
+ if len(keywords) > 1:
+ keywords = self._select_best_matches(keywords)
+ if len(keywords) > 1:
+ self._raise_multiple_keywords_found(keywords, name)
+ runner = keywords[0].create_runner(name, self.languages)
+ ctx = EXECUTION_CONTEXTS.current
+ caller = ctx.user_keywords[-1] if ctx.user_keywords else ctx.test
+ if (
+ caller
+ and runner.keyword.source != caller.source
+ and self._exists_in_resource_file(name, caller.source)
+ ):
+ message = (
+ f"Keyword '{caller.full_name}' called keyword '{name}' that exists "
+ f"both in the same resource file as the caller and in the suite "
+ f"file using that resource. The keyword in the suite file is used "
+ f"now, but this will change in Robot Framework 8.0."
+ )
+ runner.pre_run_messages += (Message(message, level="WARN"),)
return runner
- def _get_runner_from_test_case_file(self, name):
- if name in self.user_keywords.handlers:
- return self.user_keywords.handlers.create_runner(name)
+ def _select_best_matches(self, keywords):
+ # "Normal" matches are considered exact and win over embedded matches.
+ normal = [kw for kw in keywords if not kw.embedded]
+ if normal:
+ return normal
+ matches = [
+ kw for kw in keywords if not self._is_worse_match_than_others(kw, keywords)
+ ]
+ return matches or keywords
+
+ def _is_worse_match_than_others(self, candidate, alternatives):
+ for other in alternatives:
+ if (
+ candidate is not other
+ and self._is_better_match(other, candidate)
+ and not self._is_better_match(candidate, other)
+ ):
+ return True
+ return False
+
+ def _is_better_match(self, candidate, other):
+ # Embedded match is considered better than another if the other matches
+ # it, but it doesn't match the other.
+ return other.matches(candidate.name) and not candidate.matches(other.name)
+
+ def _exists_in_resource_file(self, name, source):
+ for resource in self.resources.values():
+ if resource.source == source and resource.find_keywords(name):
+ return True
+ return False
def _get_runner_from_resource_files(self, name):
- found = [lib.handlers.create_runner(name)
- for lib in self.resources.values()
- if name in lib.handlers]
- if not found:
+ keywords = [
+ kw for res in self.resources.values() for kw in res.find_keywords(name)
+ ]
+ if not keywords:
return None
- if len(found) > 1:
- found = self._get_runner_based_on_search_order(found)
- if len(found) == 1:
- return found[0]
- self._raise_multiple_keywords_found(name, found)
+ if len(keywords) > 1:
+ keywords = self._filter_based_on_search_order(keywords)
+ if len(keywords) > 1:
+ keywords = self._prioritize_same_file_or_public(keywords)
+ if len(keywords) > 1:
+ keywords = self._select_best_matches(keywords)
+ if len(keywords) > 1:
+ self._raise_multiple_keywords_found(keywords, name)
+ return keywords[0].create_runner(name, self.languages)
def _get_runner_from_libraries(self, name):
- found = [lib.handlers.create_runner(name) for lib in self.libraries.values()
- if name in lib.handlers]
- if not found:
+ keywords = [
+ kw for lib in self.libraries.values() for kw in lib.find_keywords(name)
+ ]
+ if not keywords:
return None
- if len(found) > 1:
- found = self._get_runner_based_on_search_order(found)
- if len(found) == 2:
- found = self._filter_stdlib_runner(*found)
- if len(found) == 1:
- return found[0]
- self._raise_multiple_keywords_found(name, found)
-
- def _get_runner_based_on_search_order(self, runners):
- for libname in self.search_order:
- for runner in runners:
- if eq(libname, runner.libname):
- return [runner]
- return runners
-
- def _filter_stdlib_runner(self, runner1, runner2):
- stdlibs_without_remote = STDLIBS - {'Remote'}
- if runner1.library.orig_name in stdlibs_without_remote:
- standard, custom = runner1, runner2
- elif runner2.library.orig_name in stdlibs_without_remote:
- standard, custom = runner2, runner1
+ pre_run_message = None
+ if len(keywords) > 1:
+ keywords = self._filter_based_on_search_order(keywords)
+ if len(keywords) > 1:
+ keywords = self._select_best_matches(keywords)
+ if len(keywords) > 1:
+ keywords, pre_run_message = self._filter_stdlib_handler(keywords)
+ if len(keywords) > 1:
+ self._raise_multiple_keywords_found(keywords, name)
+ runner = keywords[0].create_runner(name, self.languages)
+ if pre_run_message:
+ runner.pre_run_messages += (pre_run_message,)
+ return runner
+
+ def _prioritize_same_file_or_public(self, keywords):
+ user_keywords = EXECUTION_CONTEXTS.current.user_keywords
+ if user_keywords:
+ parent_source = user_keywords[-1].source
+ matches = [kw for kw in keywords if kw.source == parent_source]
+ if matches:
+ return matches
+ matches = [kw for kw in keywords if not kw.private]
+ return matches or keywords
+
+ def _filter_based_on_search_order(self, keywords):
+ for name in self.search_order:
+ matches = [kw for kw in keywords if eq(name, kw.owner.name)]
+ if matches:
+ return matches
+ return keywords
+
+ def _filter_stdlib_handler(self, keywords):
+ warning = None
+ if len(keywords) != 2:
+ return keywords, warning
+ stdlibs_without_remote = STDLIBS - {"Remote"}
+ if keywords[0].owner.real_name in stdlibs_without_remote:
+ standard, custom = keywords
+ elif keywords[1].owner.real_name in stdlibs_without_remote:
+ custom, standard = keywords
else:
- return [runner1, runner2]
- if not RUN_KW_REGISTER.is_run_keyword(custom.library.orig_name, custom.name):
- self._custom_and_standard_keyword_conflict_warning(custom, standard)
- return [custom]
-
- def _custom_and_standard_keyword_conflict_warning(self, custom, standard):
- custom_with_name = standard_with_name = ''
- if custom.library.name != custom.library.orig_name:
- custom_with_name = f" imported as '{custom.library.name}'"
- if standard.library.name != standard.library.orig_name:
- standard_with_name = f" imported as '{standard.library.name}'"
- warning = Message(
+ return keywords, warning
+ if not RUN_KW_REGISTER.is_run_keyword(custom.owner.real_name, custom.name):
+ warning = self._get_conflict_warning(custom, standard)
+ return [custom], warning
+
+ def _get_conflict_warning(self, custom, standard):
+ custom_with_name = standard_with_name = ""
+ if custom.owner.name != custom.owner.real_name:
+ custom_with_name = f" imported as '{custom.owner.name}'"
+ if standard.owner.name != standard.owner.real_name:
+ standard_with_name = f" imported as '{standard.owner.name}'"
+ return Message(
f"Keyword '{standard.name}' found both from a custom library "
- f"'{custom.library.orig_name}'{custom_with_name} and a standard library "
- f"'{standard.library.orig_name}'{standard_with_name}. The custom keyword "
+ f"'{custom.owner.real_name}'{custom_with_name} and a standard library "
+ f"'{standard.owner.real_name}'{standard_with_name}. The custom keyword "
f"is used. To select explicitly, and to get rid of this warning, use "
- f"either '{custom.longname}' or '{standard.longname}'.",
- level='WARN'
+ f"either '{custom.full_name}' or '{standard.full_name}'.",
+ level="WARN",
)
- if custom.pre_run_messages:
- custom.pre_run_messages.append(warning)
- else:
- custom.pre_run_messages = [warning]
def _get_explicit_runner(self, name):
- found = []
- for owner_name, kw_name in self._yield_owner_and_kw_names(name):
- found.extend(self._find_keywords(owner_name, kw_name))
- if len(found) > 1:
- self._raise_multiple_keywords_found(name, found, implicit=False)
- return found[0] if found else None
-
- def _yield_owner_and_kw_names(self, full_name):
- tokens = full_name.split('.')
- for i in range(1, len(tokens)):
- yield '.'.join(tokens[:i]), '.'.join(tokens[i:])
-
- def _find_keywords(self, owner_name, name):
- return [owner.handlers.create_runner(name)
- for owner in chain(self.libraries.values(), self.resources.values())
- if eq(owner.name, owner_name) and name in owner.handlers]
-
- def _raise_multiple_keywords_found(self, name, found, implicit=True):
- error = f"Multiple keywords with name '{name}' found"
- if implicit:
- error += ". Give the full name of the keyword you want to use"
- names = sorted(runner.longname for runner in found)
- raise KeywordError('\n '.join([error+':'] + names))
+ kws_and_names = []
+ for owner_name, kw_name in self._get_owner_and_kw_names(name):
+ for owner in (*self.libraries.values(), *self.resources.values()):
+ if eq(owner.name, owner_name):
+ for kw in owner.find_keywords(kw_name):
+ kws_and_names.append((kw, kw_name))
+ if not kws_and_names:
+ return None
+ if len(kws_and_names) == 1:
+ kw, kw_name = kws_and_names[0]
+ else:
+ keywords = [kw for kw, _ in kws_and_names]
+ matches = self._select_best_matches(keywords)
+ if len(matches) > 1:
+ self._raise_multiple_keywords_found(keywords, name, implicit=False)
+ kw, kw_name = kws_and_names[keywords.index(matches[0])]
+ return kw.create_runner(kw_name, self.languages)
+
+ def _get_owner_and_kw_names(self, full_name):
+ tokens = full_name.split(".")
+ return [
+ (".".join(tokens[:index]), ".".join(tokens[index:]))
+ for index in range(1, len(tokens))
+ ]
+
+ def _raise_multiple_keywords_found(self, keywords, name, implicit=True):
+ if any(kw.embedded for kw in keywords):
+ error = f"Multiple keywords matching name '{name}' found"
+ else:
+ error = f"Multiple keywords with name '{name}' found"
+ if implicit:
+ error += ". Give the full name of the keyword you want to use"
+ names = sorted(kw.full_name for kw in keywords)
+ raise KeywordError("\n ".join([error + ":", *names]))
class KeywordRecommendationFinder:
- def __init__(self, user_keywords, libraries, resources):
- self.user_keywords = user_keywords
- self.libraries = libraries
- self.resources = resources
+ def __init__(self, *owners):
+ self.owners = owners
def recommend_similar_keywords(self, name, message):
"""Return keyword names similar to `name`."""
- candidates = self._get_candidates('.' in name)
+ candidates = self._get_candidates(use_full_name="." in name)
finder = RecommendationFinder(
- lambda name: normalize(candidates.get(name, name), ignore='_')
+ lambda name: normalize(candidates.get(name, name), ignore="_")
+ )
+ return finder.find_and_format(
+ name,
+ candidates,
+ message,
+ check_missing_argument_separator=True,
)
- return finder.find_and_format(name, candidates, message,
- check_missing_argument_separator=True)
@staticmethod
def format_recommendations(message, recommendations):
return RecommendationFinder().format(message, recommendations)
- def _get_candidates(self, use_full_name):
- names = {}
- for owner, name in self._get_all_handler_names():
- full_name = f'{owner}.{name}' if owner else name
- names[full_name] = full_name if use_full_name else name
- return names
-
- def _get_all_handler_names(self):
- """Return a list of `(library_name, handler_name)` tuples."""
- handlers = [('', printable_name(handler.name, True))
- for handler in self.user_keywords.handlers]
- for library in chain(self.libraries.values(), self.resources.values()):
- if library.name != 'Reserved':
- handlers.extend(
- ((library.name or '',
- printable_name(handler.name, code_style=True))
- for handler in library.handlers))
- return sorted(handlers)
+ def _get_candidates(self, use_full_name=False):
+ candidates = {}
+ names = sorted(
+ (owner.name or "", kw.name)
+ for owner in self.owners
+ for kw in owner.keywords
+ )
+ for owner, name in names:
+ full_name = f"{owner}.{name}" if owner else name
+ candidates[full_name] = full_name if use_full_name else name
+ return candidates
diff --git a/src/robot/running/outputcapture.py b/src/robot/running/outputcapture.py
index 7522f51b95f..fc1de79966f 100644
--- a/src/robot/running/outputcapture.py
+++ b/src/robot/running/outputcapture.py
@@ -13,8 +13,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from io import StringIO
import sys
+from io import StringIO
from robot.output import LOGGER
from robot.utils import console_decode, console_encode
@@ -23,19 +23,27 @@
class OutputCapturer:
def __init__(self, library_import=False):
- self._library_import = library_import
- self._python_out = PythonCapturer(stdout=True)
- self._python_err = PythonCapturer(stdout=False)
+ self.library_import = library_import
+ self.stdout = None
+ self.stderr = None
+
+ def start(self):
+ self.stdout = StreamCapturer(stdout=True)
+ self.stderr = StreamCapturer(stdout=False)
+ if self.library_import:
+ LOGGER.enable_library_import_logging()
+
+ def stop(self):
+ self._release_and_log()
+ if self.library_import:
+ LOGGER.disable_library_import_logging()
def __enter__(self):
- if self._library_import:
- LOGGER.enable_library_import_logging()
+ self.start()
return self
def __exit__(self, exc_type, exc_value, exc_trace):
- self._release_and_log()
- if self._library_import:
- LOGGER.disable_library_import_logging()
+ self.stop()
return False
def _release_and_log(self):
@@ -44,15 +52,16 @@ def _release_and_log(self):
LOGGER.log_output(stdout)
if stderr:
LOGGER.log_output(stderr)
- sys.__stderr__.write(console_encode(stderr, stream=sys.__stderr__))
+ if sys.__stderr__:
+ sys.__stderr__.write(console_encode(stderr, stream=sys.__stderr__))
def _release(self):
- stdout = self._python_out.release()
- stderr = self._python_err.release()
+ stdout = self.stdout.release()
+ stderr = self.stderr.release()
return stdout, stderr
-class PythonCapturer:
+class StreamCapturer:
def __init__(self, stdout=True):
if stdout:
diff --git a/src/robot/running/randomizer.py b/src/robot/running/randomizer.py
index 4149561a38d..6dd09c1c44d 100644
--- a/src/robot/running/randomizer.py
+++ b/src/robot/running/randomizer.py
@@ -34,14 +34,15 @@ def start_suite(self, suite):
if self.randomize_tests:
self._shuffle(suite.tests)
if not suite.parent:
- suite.metadata['Randomized'] = self._get_message()
+ suite.metadata["Randomized"] = self._get_message()
def _get_message(self):
- possibilities = {(True, True): 'Suites and tests',
- (True, False): 'Suites',
- (False, True): 'Tests'}
- randomized = (self.randomize_suites, self.randomize_tests)
- return '%s (seed %s)' % (possibilities[randomized], self.seed)
+ randomized = {
+ (True, True): "Suites and tests",
+ (True, False): "Suites",
+ (False, True): "Tests",
+ }[(self.randomize_suites, self.randomize_tests)]
+ return f"{randomized} (seed {self.seed})"
def visit_test(self, test):
pass
diff --git a/src/robot/running/resourcemodel.py b/src/robot/running/resourcemodel.py
new file mode 100644
index 00000000000..050cab37f90
--- /dev/null
+++ b/src/robot/running/resourcemodel.py
@@ -0,0 +1,512 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pathlib import Path
+from typing import Any, Iterable, Literal, overload, Sequence, TYPE_CHECKING
+
+from robot import model
+from robot.model import BodyItem, create_fixture, DataDict, ModelObject, Tags
+from robot.output import LOGGER
+from robot.utils import NOT_SET, setter
+
+from .arguments import ArgInfo, ArgumentSpec, UserKeywordArgumentParser
+from .keywordfinder import KeywordFinder
+from .keywordimplementation import KeywordImplementation
+from .model import Body, BodyItemParent, Keyword, TestSuite
+from .userkeywordrunner import EmbeddedArgumentsRunner, UserKeywordRunner
+
+if TYPE_CHECKING:
+ from robot.conf import LanguagesLike
+ from robot.parsing import File
+
+
+class ResourceFile(ModelObject):
+ """Represents a resource file."""
+
+ repr_args = ("source",)
+ __slots__ = ("_source", "owner", "doc", "keyword_finder")
+
+ def __init__(
+ self,
+ source: "Path|str|None" = None,
+ owner: "TestSuite|None" = None,
+ doc: str = "",
+ ):
+ self.source = source
+ self.owner = owner
+ self.doc = doc
+ self.keyword_finder = KeywordFinder["UserKeyword"](self)
+ self.imports = []
+ self.variables = []
+ self.keywords = []
+
+ @property
+ def source(self) -> "Path|None":
+ if self._source:
+ return self._source
+ if self.owner:
+ return self.owner.source
+ return None
+
+ @source.setter
+ def source(self, source: "Path|str|None"):
+ if isinstance(source, str):
+ source = Path(source)
+ self._source = source
+
+ @property
+ def name(self) -> "str|None":
+ """Resource file name.
+
+ ``None`` if resource file is part of a suite or if it does not have
+ :attr:`source`, name of the source file without the extension otherwise.
+ """
+ if self.owner or not self.source:
+ return None
+ return self.source.stem
+
+ @setter
+ def imports(self, imports: Sequence["Import"]) -> "Imports":
+ return Imports(self, imports)
+
+ @setter
+ def variables(self, variables: Sequence["Variable"]) -> "Variables":
+ return Variables(self, variables)
+
+ @setter
+ def keywords(self, keywords: Sequence["UserKeyword"]) -> "UserKeywords":
+ return UserKeywords(self, keywords)
+
+ @classmethod
+ def from_file_system(cls, path: "Path|str", **config) -> "ResourceFile":
+ """Create a :class:`ResourceFile` object based on the give ``path``.
+
+ :param path: File path where to read the data from.
+ :param config: Configuration parameters for :class:`~.builders.ResourceFileBuilder`
+ class that is used internally for building the suite.
+
+ New in Robot Framework 6.1. See also :meth:`from_string` and :meth:`from_model`.
+ """
+ from .builder import ResourceFileBuilder
+
+ return ResourceFileBuilder(**config).build(path)
+
+ @classmethod
+ def from_string(cls, string: str, **config) -> "ResourceFile":
+ """Create a :class:`ResourceFile` object based on the given ``string``.
+
+ :param string: String to create the resource file from.
+ :param config: Configuration parameters for
+ :func:`~robot.parsing.parser.parser.get_resource_model` used internally.
+
+ New in Robot Framework 6.1. See also :meth:`from_file_system` and
+ :meth:`from_model`.
+ """
+ from robot.parsing import get_resource_model
+
+ model = get_resource_model(string, data_only=True, **config)
+ return cls.from_model(model)
+
+ @classmethod
+ def from_model(cls, model: "File") -> "ResourceFile":
+ """Create a :class:`ResourceFile` object based on the given ``model``.
+
+ :param model: Model to create the suite from.
+
+ The model can be created by using the
+ :func:`~robot.parsing.parser.parser.get_resource_model` function and possibly
+ modified by other tooling in the :mod:`robot.parsing` module.
+
+ New in Robot Framework 6.1. See also :meth:`from_file_system` and
+ :meth:`from_string`.
+ """
+ from .builder import RobotParser
+
+ return RobotParser().parse_resource_model(model)
+
+ @overload
+ def find_keywords(self, name: str, count: Literal[1]) -> "UserKeyword": ...
+
+ @overload
+ def find_keywords(
+ self,
+ name: str,
+ count: "int|None" = None,
+ ) -> "list[UserKeyword]": ...
+
+ def find_keywords(
+ self,
+ name: str,
+ count: "int|None" = None,
+ ) -> "list[UserKeyword]|UserKeyword":
+ return self.keyword_finder.find(name, count)
+
+ def to_dict(self) -> DataDict:
+ data = {}
+ if self._source:
+ data["source"] = str(self._source)
+ if self.doc:
+ data["doc"] = self.doc
+ if self.imports:
+ data["imports"] = self.imports.to_dicts()
+ if self.variables:
+ data["variables"] = self.variables.to_dicts()
+ if self.keywords:
+ data["keywords"] = self.keywords.to_dicts()
+ return data
+
+
+class UserKeyword(KeywordImplementation):
+ """Represents a user keyword."""
+
+ type = KeywordImplementation.USER_KEYWORD
+ fixture_class = Keyword
+ __slots__ = ("timeout", "_setup", "_teardown")
+
+ def __init__(
+ self,
+ name: str = "",
+ args: "ArgumentSpec|Sequence[str]|None" = (),
+ doc: str = "",
+ tags: "Tags|Sequence[str]" = (),
+ timeout: "str|None" = None,
+ lineno: "int|None" = None,
+ owner: "ResourceFile|None" = None,
+ parent: "BodyItemParent|None" = None,
+ error: "str|None" = None,
+ ):
+ super().__init__(name, args, doc, tags, lineno, owner, parent, error)
+ self.timeout = timeout
+ self._setup = None
+ self._teardown = None
+ self.body = []
+
+ @setter
+ def args(self, spec: "ArgumentSpec|Sequence[str]|None") -> ArgumentSpec:
+ if not spec:
+ spec = ArgumentSpec()
+ elif not isinstance(spec, ArgumentSpec):
+ spec = UserKeywordArgumentParser().parse(spec)
+ spec.name = lambda: self.full_name
+ return spec
+
+ @setter
+ def body(self, body: "Sequence[BodyItem|DataDict]") -> Body:
+ return Body(self, body)
+
+ @property
+ def setup(self) -> Keyword:
+ """User keyword setup as a :class:`Keyword` object.
+
+ New in Robot Framework 7.0.
+ """
+ if self._setup is None:
+ self.setup = None
+ return self._setup
+
+ @setup.setter
+ def setup(self, setup: "Keyword|DataDict|None"):
+ self._setup = create_fixture(self.fixture_class, setup, self, Keyword.SETUP)
+
+ @property
+ def has_setup(self) -> bool:
+ """Check does a keyword have a setup without creating a setup object.
+
+ See :attr:`has_teardown` for more information. New in Robot Framework 7.0.
+ """
+ return bool(self._setup)
+
+ @property
+ def teardown(self) -> Keyword:
+ """User keyword teardown as a :class:`Keyword` object."""
+ if self._teardown is None:
+ self.teardown = None
+ return self._teardown
+
+ @teardown.setter
+ def teardown(self, teardown: "Keyword|DataDict|None"):
+ self._teardown = create_fixture(
+ self.fixture_class,
+ teardown,
+ self,
+ Keyword.TEARDOWN,
+ )
+
+ @property
+ def has_teardown(self) -> bool:
+ """Check does a keyword have a teardown without creating a teardown object.
+
+ A difference between using ``if kw.has_teardown:`` and ``if kw.teardown:``
+ is that accessing the :attr:`teardown` attribute creates a :class:`Keyword`
+ object representing the teardown even when the user keyword actually does
+ not have one. This can have an effect on memory usage.
+
+ New in Robot Framework 6.1.
+ """
+ return bool(self._teardown)
+
+ def create_runner(
+ self,
+ name: "str|None",
+ languages: "LanguagesLike" = None,
+ ) -> "UserKeywordRunner|EmbeddedArgumentsRunner":
+ if self.embedded:
+ return EmbeddedArgumentsRunner(self, name)
+ return UserKeywordRunner(self)
+
+ def bind(self, data: Keyword) -> "UserKeyword":
+ kw = UserKeyword(
+ "",
+ self.args.copy(),
+ self.doc,
+ self.tags,
+ self.timeout,
+ self.lineno,
+ self.owner,
+ data.parent,
+ self.error,
+ )
+ # Avoid possible errors setting name with invalid embedded args.
+ kw._name = self._name
+ kw.embedded = self.embedded
+ if self.has_setup:
+ kw.setup = self.setup.to_dict()
+ if self.has_teardown:
+ kw.teardown = self.teardown.to_dict()
+ kw.body = self.body.to_dicts()
+ return kw
+
+ def to_dict(self) -> DataDict:
+ data: DataDict = {"name": self.name}
+ for name, value in [
+ ("args", tuple(self._decorate_arg(a) for a in self.args)),
+ ("doc", self.doc),
+ ("tags", tuple(self.tags)),
+ ("timeout", self.timeout),
+ ("lineno", self.lineno),
+ ("error", self.error),
+ ]:
+ if value:
+ data[name] = value
+ if self.has_setup:
+ data["setup"] = self.setup.to_dict()
+ data["body"] = self.body.to_dicts()
+ if self.has_teardown:
+ data["teardown"] = self.teardown.to_dict()
+ return data
+
+ def _decorate_arg(self, arg: ArgInfo) -> str:
+ if arg.kind == arg.VAR_NAMED:
+ deco = "&"
+ elif arg.kind in (arg.VAR_POSITIONAL, arg.NAMED_ONLY_MARKER):
+ deco = "@"
+ else:
+ deco = "$"
+ result = f"{deco}{{{arg.name}}}"
+ if arg.default is not NOT_SET:
+ result += f"={arg.default}"
+ return result
+
+
+class Variable(ModelObject):
+ repr_args = ("name", "value", "separator")
+
+ def __init__(
+ self,
+ name: str = "",
+ value: Sequence[str] = (),
+ separator: "str|None" = None,
+ owner: "ResourceFile|None" = None,
+ lineno: "int|None" = None,
+ error: "str|None" = None,
+ ):
+ self.name = name
+ self.value = tuple(value)
+ self.separator = separator
+ self.owner = owner
+ self.lineno = lineno
+ self.error = error
+
+ @property
+ def source(self) -> "Path|None":
+ return self.owner.source if self.owner is not None else None
+
+ def report_error(self, message: str, level: str = "ERROR"):
+ source = self.source or ""
+ line = f" on line {self.lineno}" if self.lineno else ""
+ LOGGER.write(
+ f"Error in file '{source}'{line}: "
+ f"Setting variable '{self.name}' failed: {message}",
+ level,
+ )
+
+ def to_dict(self) -> DataDict:
+ data = {"name": self.name, "value": self.value}
+ if self.lineno:
+ data["lineno"] = self.lineno
+ if self.error:
+ data["error"] = self.error
+ return data
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return not (name == "separator" and value is None)
+
+
+class Import(ModelObject):
+ """Represents library, resource file or variable file import."""
+
+ repr_args = ("type", "name", "args", "alias")
+ LIBRARY = "LIBRARY"
+ RESOURCE = "RESOURCE"
+ VARIABLES = "VARIABLES"
+
+ def __init__(
+ self,
+ type: Literal["LIBRARY", "RESOURCE", "VARIABLES"],
+ name: str,
+ args: Sequence[str] = (),
+ alias: "str|None" = None,
+ owner: "ResourceFile|Keyword|None" = None,
+ lineno: "int|None" = None,
+ ):
+ if type not in (self.LIBRARY, self.RESOURCE, self.VARIABLES):
+ raise ValueError(
+ f"Invalid import type: Expected '{self.LIBRARY}', "
+ f"'{self.RESOURCE}' or '{self.VARIABLES}', got '{type}'."
+ )
+ self.type = type
+ self.name = name
+ self.args = tuple(args)
+ self.alias = alias
+ self.owner = owner
+ self.lineno = lineno
+
+ @property
+ def source(self) -> "Path|None":
+ return self.owner.source if self.owner is not None else None
+
+ @property
+ def directory(self) -> "Path|None":
+ source = self.source
+ return source.parent if source and not source.is_dir() else source
+
+ @property
+ def setting_name(self) -> str:
+ return self.type.title()
+
+ def select(self, library: Any, resource: Any, variables: Any) -> Any:
+ return {
+ self.LIBRARY: library,
+ self.RESOURCE: resource,
+ self.VARIABLES: variables,
+ }[self.type]
+
+ def report_error(self, message: str, level: str = "ERROR"):
+ source = self.source or ""
+ line = f" on line {self.lineno}" if self.lineno else ""
+ LOGGER.write(f"Error in file '{source}'{line}: {message}", level)
+
+ @classmethod
+ def from_dict(cls, data) -> "Import":
+ return cls(**data)
+
+ def to_dict(self) -> DataDict:
+ data: DataDict = {"type": self.type, "name": self.name}
+ if self.args:
+ data["args"] = self.args
+ if self.alias:
+ data["alias"] = self.alias
+ if self.lineno:
+ data["lineno"] = self.lineno
+ return data
+
+ def _include_in_repr(self, name: str, value: Any) -> bool:
+ return name in ("type", "name") or value
+
+
+class Imports(model.ItemList):
+
+ def __init__(self, owner: ResourceFile, imports: Sequence[Import] = ()):
+ super().__init__(Import, {"owner": owner}, items=imports)
+
+ def library(
+ self,
+ name: str,
+ args: Sequence[str] = (),
+ alias: "str|None" = None,
+ lineno: "int|None" = None,
+ ) -> Import:
+ """Create library import."""
+ return self.create(Import.LIBRARY, name, args, alias, lineno=lineno)
+
+ def resource(self, name: str, lineno: "int|None" = None) -> Import:
+ """Create resource import."""
+ return self.create(Import.RESOURCE, name, lineno=lineno)
+
+ def variables(
+ self,
+ name: str,
+ args: Sequence[str] = (),
+ lineno: "int|None" = None,
+ ) -> Import:
+ """Create variables import."""
+ return self.create(Import.VARIABLES, name, args, lineno=lineno)
+
+ def create(self, *args, **kwargs) -> Import:
+ """Generic method for creating imports.
+
+ Import type specific methods :meth:`library`, :meth:`resource` and
+ :meth:`variables` are recommended over this method.
+ """
+ # RF 6.1 changed types to upper case. Code below adds backwards compatibility.
+ if args:
+ args = (args[0].upper(),) + args[1:]
+ elif "type" in kwargs:
+ kwargs["type"] = kwargs["type"].upper()
+ return super().create(*args, **kwargs)
+
+
+class Variables(model.ItemList[Variable]):
+
+ def __init__(self, owner: ResourceFile, variables: Sequence[Variable] = ()):
+ super().__init__(Variable, {"owner": owner}, items=variables)
+
+
+class UserKeywords(model.ItemList[UserKeyword]):
+
+ def __init__(self, owner: ResourceFile, keywords: Sequence[UserKeyword] = ()):
+ self.invalidate_keyword_cache = owner.keyword_finder.invalidate_cache
+ self.invalidate_keyword_cache()
+ super().__init__(UserKeyword, {"owner": owner}, items=keywords)
+
+ def append(self, item: "UserKeyword|DataDict") -> UserKeyword:
+ self.invalidate_keyword_cache()
+ return super().append(item)
+
+ def extend(self, items: "Iterable[UserKeyword|DataDict]"):
+ self.invalidate_keyword_cache()
+ return super().extend(items)
+
+ def __setitem__(self, index: "int|slice", item: "Iterable[UserKeyword|DataDict]"):
+ self.invalidate_keyword_cache()
+ return super().__setitem__(index, item)
+
+ def insert(self, index: int, item: "UserKeyword|DataDict"):
+ self.invalidate_keyword_cache()
+ super().insert(index, item)
+
+ def clear(self):
+ self.invalidate_keyword_cache()
+ super().clear()
diff --git a/src/robot/running/runkwregister.py b/src/robot/running/runkwregister.py
index 2fcad6f158a..0337ec9aa0a 100644
--- a/src/robot/running/runkwregister.py
+++ b/src/robot/running/runkwregister.py
@@ -13,7 +13,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import inspect
import warnings
from robot.utils import NormalizedDict
@@ -24,8 +23,45 @@ class _RunKeywordRegister:
def __init__(self):
self._libs = {}
- def register_run_keyword(self, libname, keyword, args_to_process=None,
- deprecation_warning=True):
+ def register_run_keyword(
+ self,
+ libname,
+ keyword,
+ args_to_process,
+ deprecation_warning=True,
+ dry_run=False,
+ ):
+ """Deprecated API for registering "run keyword variants".
+
+ Registered keywords are handled specially by Robot so that:
+
+ - Their arguments are not resolved normally (use ``args_to_process``
+ to control that). This mainly means replacing variables and handling
+ escapes.
+ - They are not stopped by timeouts.
+ - If there are conflicts with keyword names, these keywords have
+ *lower* precedence than other keywords.
+
+ This API is pretty bad and will be reimplemented in the future.
+ It is thus not considered stable, but external libraries can use it
+ if they really need it and are aware of forthcoming breaking changes.
+
+ Something like this is needed at least internally also in the future.
+ For external libraries we hopefully could provide a better API for
+ running keywords so that they would not need this in the first place.
+
+ For more details see the following issues and issues linked from it:
+ https://github.com/robotframework/robotframework/issues/2190
+
+ :param libname: Name of the library the keyword belongs to.
+ :param keyword: Name of the keyword itself.
+ :param args_to_process: How many arguments to process normally before
+ passing them to the keyword. Other arguments are not touched at all.
+ :param dry_run: When true, this keyword is executed in dry run. Keywords
+ to actually run are got based on the ``name`` argument these
+ keywords must have.
+ :param deprecation_warning: Set to ``False```to avoid the warning.
+ """
if deprecation_warning:
warnings.warn(
"The API to register run keyword variants and to disable variable "
@@ -33,26 +69,24 @@ def register_run_keyword(self, libname, keyword, args_to_process=None,
"For more information see "
"https://github.com/robotframework/robotframework/issues/2190. "
"Use with `deprecation_warning=False` to avoid this warning.",
- UserWarning
+ UserWarning,
)
- if args_to_process is None:
- args_to_process = self._get_args_from_method(keyword)
- keyword = keyword.__name__
if libname not in self._libs:
- self._libs[libname] = NormalizedDict(ignore=['_'])
- self._libs[libname][keyword] = int(args_to_process)
+ self._libs[libname] = NormalizedDict(ignore=["_"])
+ self._libs[libname][keyword] = (int(args_to_process), dry_run)
def get_args_to_process(self, libname, kwname):
if libname in self._libs and kwname in self._libs[libname]:
- return self._libs[libname][kwname]
+ return self._libs[libname][kwname][0]
return -1
+ def get_dry_run(self, libname, kwname):
+ if libname in self._libs and kwname in self._libs[libname]:
+ return self._libs[libname][kwname][1]
+ return False
+
def is_run_keyword(self, libname, kwname):
return self.get_args_to_process(libname, kwname) >= 0
- def _get_args_from_method(self, method):
- raise RuntimeError('Cannot determine arguments to process '
- 'automatically in Python 3.')
-
RUN_KW_REGISTER = _RunKeywordRegister()
diff --git a/src/robot/running/signalhandler.py b/src/robot/running/signalhandler.py
index cdabcdaaf95..da0dfc333ca 100644
--- a/src/robot/running/signalhandler.py
+++ b/src/robot/running/signalhandler.py
@@ -13,9 +13,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import sys
-from threading import current_thread
import signal
+import sys
+from threading import current_thread, main_thread
from robot.errors import ExecutionFailed
from robot.output import LOGGER
@@ -31,16 +31,20 @@ def __init__(self):
def __call__(self, signum, frame):
self._signal_count += 1
- LOGGER.info('Received signal: %s.' % signum)
+ LOGGER.info(f"Received signal: {signum}.")
if self._signal_count > 1:
- sys.__stderr__.write('Execution forcefully stopped.\n')
- raise SystemExit()
- sys.__stderr__.write('Second signal will force exit.\n')
+ self._write_to_stderr("Execution forcefully stopped.")
+ raise SystemExit
+ self._write_to_stderr("Second signal will force exit.")
if self._running_keyword:
self._stop_execution_gracefully()
+ def _write_to_stderr(self, message):
+ if sys.__stderr__:
+ sys.__stderr__.write(message + "\n")
+
def _stop_execution_gracefully(self):
- raise ExecutionFailed('Execution terminated by signal', exit=True)
+ raise ExecutionFailed("Execution terminated by signal", exit=True)
def __enter__(self):
if self._can_register_signal:
@@ -51,26 +55,29 @@ def __enter__(self):
return self
def __exit__(self, *exc_info):
+ self._signal_count = 0
if self._can_register_signal:
signal.signal(signal.SIGINT, self._orig_sigint or signal.SIG_DFL)
signal.signal(signal.SIGTERM, self._orig_sigterm or signal.SIG_DFL)
@property
def _can_register_signal(self):
- return signal and current_thread().name == 'MainThread'
+ return signal and current_thread() is main_thread()
def _register_signal_handler(self, signum):
try:
signal.signal(signum, self)
except ValueError as err:
- self._warn_about_registeration_error(signum, err)
-
- def _warn_about_registeration_error(self, signum, err):
- name, ctrlc = {signal.SIGINT: ('INT', 'or with Ctrl-C '),
- signal.SIGTERM: ('TERM', '')}[signum]
- LOGGER.warn('Registering signal %s failed. Stopping execution '
- 'gracefully with this signal %sis not possible. '
- 'Original error was: %s' % (name, ctrlc, err))
+ if signum == signal.SIGINT:
+ name = "INT"
+ or_ctrlc = "or with Ctrl-C "
+ else:
+ name = "TERM"
+ or_ctrlc = ""
+ LOGGER.warn(
+ f"Registering signal {name} failed. Stopping execution gracefully with "
+ f"this signal {or_ctrlc}is not possible. Original error was: {err}"
+ )
def start_running_keyword(self, in_teardown):
self._running_keyword = True
diff --git a/src/robot/running/status.py b/src/robot/running/status.py
index 41d1e43c185..e225e126139 100644
--- a/src/robot/running/status.py
+++ b/src/robot/running/status.py
@@ -13,9 +13,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from abc import ABC
+
from robot.errors import PassExecution
from robot.model import TagPatterns
-from robot.utils import html_escape, test_or_task
+from robot.utils import html_escape, plural_or_not as s, seq2str, test_or_task
class Failure:
@@ -29,9 +31,13 @@ def __init__(self):
self.teardown_skipped = None
def __bool__(self):
- return bool(
- self.setup or self.test or self.teardown or
- self.setup_skipped or self.test_skipped or self.teardown_skipped
+ return (
+ self.setup is not None
+ or self.test is not None
+ or self.teardown is not None
+ or self.setup_skipped is not None
+ or self.test_skipped is not None
+ or self.teardown_skipped is not None
)
@@ -45,10 +51,10 @@ def __init__(self, failure_mode=False, error_mode=False, skip_teardown_mode=Fals
self.error = False
self.fatal = False
- def failure_occurred(self, fatal=False):
+ def failure_occurred(self, fatal=False, suite_setup=False):
if fatal:
self.fatal = True
- if self.failure_mode:
+ if self.failure_mode and not suite_setup:
self.failure = True
def error_occurred(self):
@@ -63,7 +69,7 @@ def __bool__(self):
return bool(self.failure or self.error or self.fatal)
-class _ExecutionStatus:
+class ExecutionStatus(ABC):
def __init__(self, parent, exit=None):
self.parent = parent
@@ -71,7 +77,6 @@ def __init__(self, parent, exit=None):
self.failure = Failure()
self.skipped = False
self._teardown_allowed = False
- self._rpa = False
@property
def failed(self):
@@ -88,11 +93,13 @@ def setup_executed(self, error=None):
self.failure.setup_skipped = msg
self.skipped = True
elif self._skip_on_failure():
- self.failure.test = self._skip_on_fail_msg(f'Setup failed:\n{msg}')
+ self.failure.test = self._skip_on_fail_msg(f"Setup failed:\n{msg}")
self.skipped = True
else:
self.failure.setup = msg
- self.exit.failure_occurred(error.exit)
+ self.exit.failure_occurred(
+ error.exit, suite_setup=isinstance(self, SuiteStatus)
+ )
self._teardown_allowed = True
def teardown_executed(self, error=None):
@@ -102,7 +109,7 @@ def teardown_executed(self, error=None):
self.failure.teardown_skipped = msg
self.skipped = True
elif self._skip_on_failure():
- self.failure.test = self._skip_on_fail_msg(f'Teardown failed:\n{msg}')
+ self.failure.test = self._skip_on_fail_msg(f"Teardown failed:\n{msg}")
self.skipped = True
else:
self.failure.teardown = msg
@@ -121,10 +128,10 @@ def teardown_allowed(self):
@property
def status(self):
if self.skipped or (self.parent and self.parent.skipped):
- return 'SKIP'
+ return "SKIP"
if self.failed:
- return 'FAIL'
- return 'PASS'
+ return "FAIL"
+ return "PASS"
def _skip_on_failure(self):
return False
@@ -138,7 +145,7 @@ def message(self):
return self._my_message()
if self.parent and not self.parent.passed:
return self._parent_message()
- return ''
+ return ""
def _my_message(self):
raise NotImplementedError
@@ -147,10 +154,15 @@ def _parent_message(self):
return ParentMessage(self.parent).message
-class SuiteStatus(_ExecutionStatus):
+class SuiteStatus(ExecutionStatus):
- def __init__(self, parent=None, exit_on_failure=False, exit_on_error=False,
- skip_teardown_on_exit=False):
+ def __init__(
+ self,
+ parent=None,
+ exit_on_failure=False,
+ exit_on_error=False,
+ skip_teardown_on_exit=False,
+ ):
if parent is None:
exit = Exit(exit_on_failure, exit_on_error, skip_teardown_on_exit)
else:
@@ -161,19 +173,19 @@ def _my_message(self):
return SuiteMessage(self).message
-class TestStatus(_ExecutionStatus):
+class TestStatus(ExecutionStatus):
- def __init__(self, parent, test, skip_on_failure=None, rpa=False):
+ def __init__(self, parent, test, skip_on_failure=(), rpa=False):
super().__init__(parent)
- self._test = test
- self._skip_on_failure_tags = skip_on_failure
- self._rpa = rpa
+ self.test = test
+ self.skip_on_failure_tags = TagPatterns(skip_on_failure)
+ self.rpa = rpa
def test_failed(self, message=None, error=None):
if error is not None:
message = str(error)
skip = error.skip
- fatal = error.exit
+ fatal = error.exit or self.test.tags.robot("exit-on-failure")
else:
skip = fatal = False
if skip:
@@ -198,25 +210,33 @@ def skip_on_failure_after_tag_changes(self):
return False
def _skip_on_failure(self):
- tags = list(self._skip_on_failure_tags or []) + ['robot:skip-on-failure']
- return TagPatterns(tags).match(self._test.tags)
+ tags = self.test.tags
+ return tags.robot("skip-on-failure") or self.skip_on_failure_tags.match(tags)
- def _skip_on_fail_msg(self, msg):
+ def _skip_on_fail_msg(self, fail_msg):
+ if self.test.tags.robot("skip-on-failure"):
+ tags = ["robot:skip-on-failure"]
+ kind = "tag"
+ else:
+ tags = self.skip_on_failure_tags
+ kind = "tag" if tags.is_constant else "tag pattern"
return test_or_task(
- "{Test} failed but skip-on-failure mode was active and it was marked "
- "skipped.\n\nOriginal failure:\n%s" % msg, rpa=self._rpa
+ f"Failed {{test}} skipped using {seq2str(tags)} {kind}{s(tags)}.\n\n"
+ f"Original failure:\n{fail_msg}",
+ rpa=self.rpa,
)
def _my_message(self):
return TestMessage(self).message
-class _Message:
- setup_message = NotImplemented
- setup_skipped_message = NotImplemented
- teardown_skipped_message = NotImplemented
- teardown_message = NotImplemented
- also_teardown_message = NotImplemented
+class Message(ABC):
+ setup_message = ""
+ setup_skipped_message = ""
+ teardown_skipped_message = ""
+ teardown_message = ""
+ also_teardown_message = ""
+ also_teardown_skip_message = ""
def __init__(self, status):
self.failure = status.failure
@@ -230,15 +250,17 @@ def message(self):
def _get_message_before_teardown(self):
if self.failure.setup_skipped:
return self._format_setup_or_teardown_message(
- self.setup_skipped_message, self.failure.setup_skipped)
+ self.setup_skipped_message, self.failure.setup_skipped
+ )
if self.failure.setup:
return self._format_setup_or_teardown_message(
- self.setup_message, self.failure.setup)
- return self.failure.test_skipped or self.failure.test or ''
+ self.setup_message, self.failure.setup
+ )
+ return self.failure.test_skipped or self.failure.test or ""
def _format_setup_or_teardown_message(self, prefix, message):
- if message.startswith('*HTML*'):
- prefix = '*HTML* ' + prefix
+ if message.startswith("*HTML*"):
+ prefix = "*HTML* " + prefix
message = message[6:].lstrip()
return prefix % message
@@ -249,37 +271,39 @@ def _get_message_after_teardown(self, message):
if self.failure.teardown:
prefix, msg = self.teardown_message, self.failure.teardown
else:
- prefix, msg = self.teardown_skipped_message, self.failure.teardown_skipped
+ prefix, msg = (
+ self.teardown_skipped_message,
+ self.failure.teardown_skipped,
+ )
return self._format_setup_or_teardown_message(prefix, msg)
return self._format_message_with_teardown_message(message)
def _format_message_with_teardown_message(self, message):
teardown = self.failure.teardown or self.failure.teardown_skipped
- if teardown.startswith('*HTML*'):
+ if teardown.startswith("*HTML*"):
teardown = teardown[6:].lstrip()
- if not message.startswith('*HTML*'):
- message = '*HTML* ' + html_escape(message)
- elif message.startswith('*HTML*'):
+ if not message.startswith("*HTML*"):
+ message = "*HTML* " + html_escape(message)
+ elif message.startswith("*HTML*"):
teardown = html_escape(teardown)
if self.failure.teardown:
return self.also_teardown_message % (message, teardown)
return self.also_teardown_skip_message % (teardown, message)
-class TestMessage(_Message):
- setup_message = 'Setup failed:\n%s'
- teardown_message = 'Teardown failed:\n%s'
- setup_skipped_message = '%s'
- teardown_skipped_message = '%s'
- also_teardown_message = '%s\n\nAlso teardown failed:\n%s'
- also_teardown_skip_message = 'Skipped in teardown:\n%s\n\nEarlier message:\n%s'
- exit_on_fatal_message = 'Test execution stopped due to a fatal error.'
- exit_on_failure_message = \
- 'Failure occurred and exit-on-failure mode is in use.'
- exit_on_error_message = 'Error occurred and exit-on-error mode is in use.'
+class TestMessage(Message):
+ setup_message = "Setup failed:\n%s"
+ teardown_message = "Teardown failed:\n%s"
+ setup_skipped_message = "%s"
+ teardown_skipped_message = "%s"
+ also_teardown_message = "%s\n\nAlso teardown failed:\n%s"
+ also_teardown_skip_message = "Skipped in teardown:\n%s\n\nEarlier message:\n%s"
+ exit_on_fatal_message = "Test execution stopped due to a fatal error."
+ exit_on_failure_message = "Failure occurred and exit-on-failure mode is in use."
+ exit_on_error_message = "Error occurred and exit-on-error mode is in use."
def __init__(self, status):
- _Message.__init__(self, status)
+ super().__init__(status)
self.exit = status.exit
@property
@@ -293,26 +317,28 @@ def message(self):
return self.exit_on_fatal_message
if self.exit.error:
return self.exit_on_error_message
- return ''
+ return ""
-class SuiteMessage(_Message):
- setup_message = 'Suite setup failed:\n%s'
- setup_skipped_message = 'Skipped in suite setup:\n%s'
- teardown_skipped_message = 'Skipped in suite teardown:\n%s'
- teardown_message = 'Suite teardown failed:\n%s'
- also_teardown_message = '%s\n\nAlso suite teardown failed:\n%s'
- also_teardown_skip_message = 'Skipped in suite teardown:\n%s\n\nEarlier message:\n%s'
+class SuiteMessage(Message):
+ setup_message = "Suite setup failed:\n%s"
+ setup_skipped_message = "Skipped in suite setup:\n%s"
+ teardown_skipped_message = "Skipped in suite teardown:\n%s"
+ teardown_message = "Suite teardown failed:\n%s"
+ also_teardown_message = "%s\n\nAlso suite teardown failed:\n%s"
+ also_teardown_skip_message = (
+ "Skipped in suite teardown:\n%s\n\nEarlier message:\n%s"
+ )
class ParentMessage(SuiteMessage):
- setup_message = 'Parent suite setup failed:\n%s'
- setup_skipped_message = 'Skipped in parent suite setup:\n%s'
- teardown_skipped_message = 'Skipped in parent suite teardown:\n%s'
- teardown_message = 'Parent suite teardown failed:\n%s'
- also_teardown_message = '%s\n\nAlso parent suite teardown failed:\n%s'
+ setup_message = "Parent suite setup failed:\n%s"
+ setup_skipped_message = "Skipped in parent suite setup:\n%s"
+ teardown_skipped_message = "Skipped in parent suite teardown:\n%s"
+ teardown_message = "Parent suite teardown failed:\n%s"
+ also_teardown_message = "%s\n\nAlso parent suite teardown failed:\n%s"
def __init__(self, status):
while status.parent and status.parent.failed:
status = status.parent
- SuiteMessage.__init__(self, status)
+ super().__init__(status)
diff --git a/src/robot/running/statusreporter.py b/src/robot/running/statusreporter.py
index 951b5c13d1f..693db63f889 100644
--- a/src/robot/running/statusreporter.py
+++ b/src/robot/running/statusreporter.py
@@ -13,18 +13,29 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.errors import (ExecutionFailed, ExecutionStatus, DataError,
- HandlerExecutionFailed, KeywordError, VariableError)
-from robot.utils import ErrorDetails, get_timestamp
+from datetime import datetime
-from .modelcombiner import ModelCombiner
+from robot.errors import (
+ BreakLoop, ContinueLoop, DataError, ExecutionFailed, ExecutionStatus,
+ HandlerExecutionFailed, ReturnFromKeyword
+)
+from robot.utils import ErrorDetails
class StatusReporter:
- def __init__(self, data, result, context, run=True, suppress=False):
+ def __init__(
+ self,
+ data,
+ result,
+ context,
+ run=True,
+ suppress=False,
+ implementation=None,
+ ):
self.data = data
self.result = result
+ self.implementation = implementation
self.context = context
if run:
self.pass_status = result.PASS
@@ -38,35 +49,42 @@ def __enter__(self):
context = self.context
result = self.result
self.initial_test_status = context.test.status if context.test else None
- result.starttime = get_timestamp()
- context.start_keyword(ModelCombiner(self.data, result))
- self._warn_if_deprecated(result.doc, result.name)
+ if not result.start_time:
+ result.start_time = datetime.now()
+ context.start_body_item(self.data, result, self.implementation)
+ if result.type in result.KEYWORD_TYPES:
+ self._warn_if_deprecated(result.doc, result.full_name)
return self
def _warn_if_deprecated(self, doc, name):
- if doc.startswith('*DEPRECATED') and '*' in doc[1:]:
- message = ' ' + doc.split('*', 2)[-1].strip()
- self.context.warn("Keyword '%s' is deprecated.%s" % (name, message))
+ if doc.startswith("*DEPRECATED") and "*" in doc[1:]:
+ message = " " + doc.split("*", 2)[-1].strip()
+ self.context.warn(f"Keyword '{name}' is deprecated.{message}")
- def __exit__(self, exc_type, exc_val, exc_tb):
+ def __exit__(self, exc_type, exc_value, exc_traceback):
context = self.context
result = self.result
- failure = self._get_failure(exc_type, exc_val, exc_tb, context)
+ failure = self._get_failure(exc_value, context)
if failure is None:
result.status = self.pass_status
else:
result.status = failure.status
- if result.type == result.TEARDOWN:
+ if not isinstance(failure, (BreakLoop, ContinueLoop, ReturnFromKeyword)):
result.message = failure.message
- if self.initial_test_status == 'PASS':
+ if self.initial_test_status == "PASS" and result.status != "NOT RUN":
context.test.status = result.status
- result.endtime = get_timestamp()
- context.end_keyword(ModelCombiner(self.data, result))
- if failure is not exc_val:
+ result.elapsed_time = datetime.now() - result.start_time
+ orig_status = (result.status, result.message)
+ context.end_body_item(self.data, result, self.implementation)
+ if orig_status != (result.status, result.message):
+ if result.passed or result.not_run:
+ return True
+ raise ExecutionFailed(result.message, skip=result.skipped)
+ if failure is not exc_value and not self.suppress:
raise failure
return self.suppress
- def _get_failure(self, exc_type, exc_value, exc_tb, context):
+ def _get_failure(self, exc_value, context):
if exc_value is None:
return None
if isinstance(exc_value, ExecutionStatus):
@@ -74,8 +92,7 @@ def _get_failure(self, exc_type, exc_value, exc_tb, context):
if isinstance(exc_value, DataError):
msg = exc_value.message
context.fail(msg)
- syntax = not isinstance(exc_value, (KeywordError, VariableError))
- return ExecutionFailed(msg, syntax=syntax)
+ return ExecutionFailed(msg, syntax=exc_value.syntax)
error = ErrorDetails(exc_value)
failure = HandlerExecutionFailed(error)
if failure.timeout:
diff --git a/src/robot/running/suiterunner.py b/src/robot/running/suiterunner.py
index bc24402bc5c..5405c841154 100644
--- a/src/robot/running/suiterunner.py
+++ b/src/robot/running/suiterunner.py
@@ -13,15 +13,21 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from robot.errors import ExecutionFailed, ExecutionStatus, DataError, PassExecution
+from datetime import datetime
+
+from robot.errors import ExecutionStatus, PassExecution
from robot.model import SuiteVisitor, TagPatterns
-from robot.result import TestSuite, Result
-from robot.utils import get_timestamp, is_list_like, NormalizedDict, test_or_task
+from robot.result import (
+ Keyword as KeywordResult, Result, TestCase as TestResult, TestSuite as SuiteResult
+)
+from robot.utils import (
+ is_list_like, NormalizedDict, plural_or_not as s, seq2str, test_or_task
+)
from robot.variables import VariableScopes
from .bodyrunner import BodyRunner, KeywordRunner
from .context import EXECUTION_CONTEXTS
-from .modelcombiner import ModelCombiner
+from .model import Keyword as KeywordData, TestCase as TestData, TestSuite as SuiteData
from .namespace import Namespace
from .status import SuiteStatus, TestStatus
from .timeouts import TestTimeout
@@ -31,127 +37,166 @@ class SuiteRunner(SuiteVisitor):
def __init__(self, output, settings):
self.result = None
- self._output = output
- self._settings = settings
- self._variables = VariableScopes(settings)
- self._suite = None
- self._suite_status = None
- self._executed = [NormalizedDict(ignore='_')]
- self._skipped_tags = TagPatterns(settings.skip)
+ self.output = output
+ self.settings = settings
+ self.variables = VariableScopes(settings)
+ self.suite_result = None
+ self.suite_status = None
+ self.executed = [NormalizedDict(ignore="_")]
+ self.skipped_tags = TagPatterns(settings.skip)
@property
- def _context(self):
+ def context(self):
return EXECUTION_CONTEXTS.current
- def start_suite(self, suite):
- if suite.name in self._executed[-1] and suite.parent.source:
- self._output.warn(f"Multiple suites with name '{suite.name}' executed in "
- f"suite '{suite.parent.longname}'.")
- self._executed[-1][suite.name] = True
- self._executed.append(NormalizedDict(ignore='_'))
- self._output.library_listeners.new_suite_scope()
- result = TestSuite(source=suite.source,
- name=suite.name,
- doc=suite.doc,
- metadata=suite.metadata,
- starttime=get_timestamp(),
- rpa=self._settings.rpa)
+ def start_suite(self, data: SuiteData):
+ if data.name in self.executed[-1] and data.parent.source:
+ self.output.warn(
+ f"Multiple suites with name '{data.name}' executed in "
+ f"suite '{data.parent.full_name}'."
+ )
+ self.executed[-1][data.name] = True
+ self.executed.append(NormalizedDict(ignore="_"))
+ self.output.library_listeners.new_suite_scope()
+ result = SuiteResult(
+ source=data.source,
+ name=data.name,
+ doc=data.doc,
+ metadata=data.metadata,
+ start_time=datetime.now(),
+ rpa=self.settings.rpa,
+ )
if not self.result:
- self.result = Result(root_suite=result, rpa=self._settings.rpa)
- self.result.configure(status_rc=self._settings.status_rc,
- stat_config=self._settings.statistics_config)
+ self.result = Result(suite=result, rpa=self.settings.rpa)
+ self.result.configure(
+ status_rc=self.settings.status_rc,
+ stat_config=self.settings.statistics_config,
+ )
else:
- self._suite.suites.append(result)
- self._suite = result
- self._suite_status = SuiteStatus(self._suite_status,
- self._settings.exit_on_failure,
- self._settings.exit_on_error,
- self._settings.skip_teardown_on_exit)
- ns = Namespace(self._variables, result, suite.resource)
+ self.suite_result.suites.append(result)
+ self.suite_result = result
+ self.suite_status = SuiteStatus(
+ self.suite_status,
+ self.settings.exit_on_failure,
+ self.settings.exit_on_error,
+ self.settings.skip_teardown_on_exit,
+ )
+ ns = Namespace(self.variables, result, data.resource, self.settings.languages)
ns.start_suite()
- ns.variables.set_from_variable_table(suite.resource.variables)
- EXECUTION_CONTEXTS.start_suite(result, ns, self._output,
- self._settings.dry_run)
- self._context.set_suite_variables(result)
- if not self._suite_status.failed:
+ ns.variables.set_from_variable_section(data.resource.variables)
+ EXECUTION_CONTEXTS.start_suite(result, ns, self.output, self.settings.dry_run)
+ self.context.set_suite_variables(result)
+ if not self.suite_status.failed:
ns.handle_imports()
ns.variables.resolve_delayed()
result.doc = self._resolve_setting(result.doc)
- result.metadata = [(self._resolve_setting(n), self._resolve_setting(v))
- for n, v in result.metadata.items()]
- self._context.set_suite_variables(result)
- self._output.start_suite(ModelCombiner(suite, result,
- tests=suite.tests,
- suites=suite.suites,
- test_count=suite.test_count))
- self._output.register_error_listener(self._suite_status.error_occurred)
- self._run_setup(suite.setup, self._suite_status)
+ result.metadata = [
+ (self._resolve_setting(n), self._resolve_setting(v))
+ for n, v in result.metadata.items()
+ ]
+ self.context.set_suite_variables(result)
+ self.output.start_suite(data, result)
+ self.output.register_error_listener(self.suite_status.error_occurred)
+ self._run_setup(
+ data,
+ self.suite_status,
+ self.suite_result,
+ run=self._any_test_run(data),
+ )
+
+ def _any_test_run(self, suite: SuiteData):
+ skipped_tags = self.skipped_tags
+ for test in suite.all_tests:
+ tags = test.tags
+ if not (
+ skipped_tags.match(tags)
+ or tags.robot("skip")
+ or tags.robot("exclude")
+ ): # fmt: skip
+ return True
+ return False
def _resolve_setting(self, value):
if is_list_like(value):
- return self._variables.replace_list(value, ignore_errors=True)
- return self._variables.replace_string(value, ignore_errors=True)
-
- def end_suite(self, suite):
- self._suite.message = self._suite_status.message
- self._context.report_suite_status(self._suite.status,
- self._suite.full_message)
- with self._context.suite_teardown():
- failure = self._run_teardown(suite.teardown, self._suite_status)
+ return self.variables.replace_list(value, ignore_errors=True)
+ return self.variables.replace_string(value, ignore_errors=True)
+
+ def end_suite(self, suite: SuiteData):
+ self.suite_result.message = self.suite_status.message
+ self.context.report_suite_status(
+ self.suite_result.status, self.suite_result.full_message
+ )
+ with self.context.suite_teardown():
+ failure = self._run_teardown(suite, self.suite_status, self.suite_result)
if failure:
if failure.skip:
- self._suite.suite_teardown_skipped(str(failure))
+ self.suite_result.suite_teardown_skipped(str(failure))
else:
- self._suite.suite_teardown_failed(str(failure))
- self._suite.endtime = get_timestamp()
- self._suite.message = self._suite_status.message
- self._context.end_suite(ModelCombiner(suite, self._suite))
- self._executed.pop()
- self._suite = self._suite.parent
- self._suite_status = self._suite_status.parent
- self._output.library_listeners.discard_suite_scope()
-
- def visit_test(self, test):
- settings = self._settings
- if TagPatterns("robot:exclude").match(test.tags):
+ self.suite_result.suite_teardown_failed(str(failure))
+ self.suite_result.end_time = datetime.now()
+ self.suite_result.message = self.suite_status.message
+ self.context.end_suite(suite, self.suite_result)
+ self._clear_result(self.suite_result)
+ self.executed.pop()
+ self.suite_result = self.suite_result.parent
+ self.suite_status = self.suite_status.parent
+ self.output.library_listeners.discard_suite_scope()
+
+ def visit_test(self, data: TestData):
+ settings = self.settings
+ result = self.suite_result.tests.create(
+ self._resolve_setting(data.name),
+ self._resolve_setting(data.doc),
+ self._resolve_setting(data.tags),
+ self._get_timeout(data),
+ data.lineno,
+ start_time=datetime.now(),
+ )
+ if result.tags.robot("exclude"):
+ self.suite_result.tests.pop()
return
- if test.name in self._executed[-1]:
- self._output.warn(
- test_or_task(f"Multiple {{test}}s with name '{test.name}' executed in "
- f"suite '{test.parent.longname}'.", settings.rpa))
- self._executed[-1][test.name] = True
- result = self._suite.tests.create(self._resolve_setting(test.name),
- self._resolve_setting(test.doc),
- self._resolve_setting(test.tags),
- self._get_timeout(test),
- test.lineno,
- starttime=get_timestamp())
- self._context.start_test(result)
- self._output.start_test(ModelCombiner(test, result))
- status = TestStatus(self._suite_status, result, settings.skip_on_failure,
- settings.rpa)
+ if result.name in self.executed[-1]:
+ self.output.warn(
+ test_or_task(
+ f"Multiple {{test}}s with name '{result.name}' executed "
+ f"in suite '{result.parent.full_name}'.",
+ settings.rpa,
+ )
+ )
+ self.executed[-1][result.name] = True
+ self.context.start_test(data, result)
+ status = TestStatus(
+ self.suite_status,
+ result,
+ settings.skip_on_failure,
+ settings.rpa,
+ )
if status.exit:
self._add_exit_combine()
- result.tags.add('robot:exit')
+ result.tags.add("robot:exit")
if status.passed:
- if not test.name:
- status.test_failed(
- test_or_task('{Test} name cannot be empty.', settings.rpa))
- elif not test.body:
- status.test_failed(
- test_or_task('{Test} contains no keywords.', settings.rpa))
- elif TagPatterns('robot:skip').match(test.tags):
+ if not data.error:
+ if not data.name:
+ data.error = "Test name cannot be empty."
+ elif not data.body:
+ data.error = "Test cannot be empty."
+ if data.error:
+ if settings.rpa:
+ data.error = data.error.replace("Test", "Task")
+ status.test_failed(data.error)
+ elif result.tags.robot("skip"):
status.test_skipped(
- test_or_task("{Test} skipped using 'robot:skip' tag.",
- settings.rpa))
- elif self._skipped_tags.match(test.tags):
+ self._get_skipped_message(["robot:skip"], settings.rpa)
+ )
+ elif self.skipped_tags.match(result.tags):
status.test_skipped(
- test_or_task("{Test} skipped using '--skip' command line option.",
- settings.rpa))
- self._run_setup(test.setup, status, result)
+ self._get_skipped_message(self.skipped_tags, settings.rpa)
+ )
+ self._run_setup(data, status, result)
if status.passed:
+ runner = BodyRunner(self.context, templated=bool(data.template))
try:
- BodyRunner(self._context, templated=bool(test.template)).run(test.body)
+ runner.run(data, result)
except PassExecution as exception:
err = exception.earlier_failures
if err:
@@ -166,66 +211,90 @@ def visit_test(self, test):
status.test_failed(status.message)
result.status = status.status
result.message = status.message or result.message
- with self._context.test_teardown(result):
- self._run_teardown(test.teardown, status, result)
+ with self.context.test_teardown(result):
+ self._run_teardown(data, status, result)
if status.passed and result.timeout and result.timeout.timed_out():
status.test_failed(result.timeout.get_message())
result.message = status.message
if status.skip_on_failure_after_tag_changes:
result.message = status.message or result.message
result.status = status.status
- result.endtime = get_timestamp()
+ result.end_time = datetime.now()
failed_before_listeners = result.failed
- self._output.end_test(ModelCombiner(test, result))
+ # TODO: can this be removed to context
+ self.output.end_test(data, result)
if result.failed and not failed_before_listeners:
status.failure_occurred()
- self._context.end_test(result)
+ self.context.end_test(result)
+ self._clear_result(result)
+
+ def _get_skipped_message(self, tags, rpa):
+ kind = "tag" if getattr(tags, "is_constant", True) else "tag pattern"
+ return test_or_task(
+ f"{{Test}} skipped using {seq2str(tags)} {kind}{s(tags)}.", rpa
+ )
+
+ def _clear_result(self, result: "SuiteResult|TestResult"):
+ if result.has_setup:
+ result.setup = None
+ if result.has_teardown:
+ result.teardown = None
+ if hasattr(result, "body"):
+ result.body.clear()
def _add_exit_combine(self):
- exit_combine = ('NOT robot:exit', '')
- if exit_combine not in self._settings['TagStatCombine']:
- self._settings['TagStatCombine'].append(exit_combine)
+ exit_combine = ("NOT robot:exit", "")
+ if exit_combine not in self.settings["TagStatCombine"]:
+ self.settings["TagStatCombine"].append(exit_combine)
- def _get_timeout(self, test):
+ def _get_timeout(self, test: TestData):
if not test.timeout:
return None
- return TestTimeout(test.timeout, self._variables, rpa=test.parent.rpa)
+ return TestTimeout(test.timeout, self.variables, rpa=test.parent.rpa)
- def _run_setup(self, setup, status, result=None):
- if status.passed:
- exception = self._run_setup_or_teardown(setup)
+ def _run_setup(
+ self,
+ item: "SuiteData|TestData",
+ status: "SuiteStatus|TestStatus",
+ result: "SuiteResult|TestResult",
+ run: bool = True,
+ ):
+ if run and status.passed:
+ if item.has_setup:
+ exception = self._run_setup_or_teardown(item.setup, result.setup)
+ else:
+ exception = None
status.setup_executed(exception)
- if result and isinstance(exception, PassExecution):
+ if isinstance(exception, PassExecution) and isinstance(result, TestResult):
result.message = exception.message
elif status.parent and status.parent.skipped:
status.skipped = True
- def _run_teardown(self, teardown, status, result=None):
- if status.teardown_allowed:
- exception = self._run_setup_or_teardown(teardown)
- status.teardown_executed(exception)
- failed = exception and not isinstance(exception, PassExecution)
- if result and exception:
- if failed or status.skipped or exception.skip:
- result.message = status.message
- else:
- # Pass execution used in teardown,
- # and it overrides previous failure message
- result.message = exception.message
- return exception if failed else None
-
- def _run_setup_or_teardown(self, data):
- if not data:
- return None
- try:
- name = self._variables.replace_string(data.name)
- except DataError as err:
- if self._settings.dry_run:
- return None
- return ExecutionFailed(message=err.message)
- if name.upper() in ('', 'NONE'):
+ def _run_teardown(
+ self,
+ item: "SuiteData|TestData",
+ status: "SuiteStatus|TestStatus",
+ result: "SuiteResult|TestResult",
+ ):
+ if not status.teardown_allowed:
return None
+ if item.has_teardown:
+ exception = self._run_setup_or_teardown(item.teardown, result.teardown)
+ else:
+ exception = None
+ status.teardown_executed(exception)
+ failed = exception and not isinstance(exception, PassExecution)
+ if isinstance(result, TestResult) and exception:
+ if failed or status.skipped or exception.skip:
+ result.message = status.message
+ else:
+ # Pass execution has been used in teardown,
+ # and it overrides previous failure message
+ result.message = exception.message
+ return exception if failed else None
+
+ def _run_setup_or_teardown(self, data: KeywordData, result: KeywordResult):
try:
- KeywordRunner(self._context).run(data, name=name)
+ KeywordRunner(self.context).run(data, result, setup_or_teardown=True)
except ExecutionStatus as err:
return err
diff --git a/src/robot/running/testlibraries.py b/src/robot/running/testlibraries.py
index 4c2c3ee5944..f079ce79e65 100644
--- a/src/robot/running/testlibraries.py
+++ b/src/robot/running/testlibraries.py
@@ -13,405 +13,578 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from functools import partial
import inspect
-import os
+from functools import cached_property, partial
+from pathlib import Path
+from types import ModuleType
+from typing import Any, Literal, overload, Sequence, TypeVar
from robot.errors import DataError
from robot.libraries import STDLIBS
from robot.output import LOGGER
-from robot.utils import (getdoc, get_error_details, Importer, is_dict_like, is_init,
- is_list_like, normalize, seq2str2, type_name)
-
-from .arguments import EmbeddedArguments, CustomArgumentConverters
-from .context import EXECUTION_CONTEXTS
-from .dynamicmethods import (GetKeywordArguments, GetKeywordDocumentation,
- GetKeywordNames, GetKeywordTags, RunKeyword)
-from .handlers import Handler, InitHandler, DynamicHandler, EmbeddedArgumentsHandler
-from .handlerstore import HandlerStore
-from .libraryscopes import LibraryScope
+from robot.utils import (
+ get_error_details, getdoc, Importer, is_dict_like, is_list_like, normalize,
+ NormalizedDict, seq2str2, setter, type_name
+)
+
+from .arguments import CustomArgumentConverters
+from .dynamicmethods import GetKeywordDocumentation, GetKeywordNames, RunKeyword
+from .keywordfinder import KeywordFinder
+from .librarykeyword import DynamicKeyword, LibraryInit, LibraryKeyword, StaticKeyword
+from .libraryscopes import Scope, ScopeManager
from .outputcapture import OutputCapturer
+Self = TypeVar("Self", bound="TestLibrary")
+
+
+class TestLibrary:
+ """Represents imported test library."""
+
+ def __init__(
+ self,
+ code: "type|ModuleType",
+ init: LibraryInit,
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ logger=LOGGER,
+ ):
+ self.code = code
+ self.init = init
+ self.init.owner = self
+ self.instance = None
+ self.name = name or code.__name__
+ self.real_name = real_name or self.name
+ self.source = source
+ self._logger = logger
+ self.keywords: list[LibraryKeyword] = []
+ self._has_listeners = None
+ self.scope_manager = ScopeManager.for_library(self)
+ self.keyword_finder = KeywordFinder[LibraryKeyword](self)
+
+ @property
+ def instance(self) -> Any:
+ """Current library instance.
+
+ With module based libraries this is the module itself.
+
+ With class based libraries this is an instance of the class. Instances are
+ cleared automatically during execution based on their scope. Accessing this
+ property creates a new instance if needed.
+
+ :attr:`code` contains the original library code. With module based libraries
+ it is the same as :attr:`instance`. With class based libraries it is
+ the library class.
+ """
+ instance = self.code if self._instance is None else self._instance
+ if self._has_listeners is None:
+ self._has_listeners = self._instance_has_listeners(instance)
+ return instance
+
+ @instance.setter
+ def instance(self, instance: Any):
+ self._instance = instance
+
+ @property
+ def listeners(self) -> "list[Any]":
+ if self._has_listeners is None:
+ self._has_listeners = self._instance_has_listeners(self.instance)
+ if self._has_listeners is False:
+ return []
+ listener = self.instance.ROBOT_LIBRARY_LISTENER
+ return list(listener) if is_list_like(listener) else [listener]
+
+ def _instance_has_listeners(self, instance) -> bool:
+ return getattr(instance, "ROBOT_LIBRARY_LISTENER", None) is not None
+
+ @property
+ def converters(self) -> "CustomArgumentConverters|None":
+ converters = getattr(self.code, "ROBOT_LIBRARY_CONVERTERS", None)
+ if not converters:
+ return None
+ if not is_dict_like(converters):
+ self.report_error(
+ f"Argument converters must be given as a dictionary, "
+ f"got {type_name(converters)}."
+ )
+ return None
+ return CustomArgumentConverters.from_dict(converters, self)
+
+ @property
+ def doc(self) -> str:
+ return getdoc(self.instance)
+
+ @property
+ def doc_format(self) -> str:
+ return self._attr("ROBOT_LIBRARY_DOC_FORMAT", upper=True)
+
+ @property
+ def scope(self) -> Scope:
+ scope = self._attr("ROBOT_LIBRARY_SCOPE", "TEST", upper=True)
+ if scope == "GLOBAL":
+ return Scope.GLOBAL
+ if scope in ("SUITE", "TESTSUITE"):
+ return Scope.SUITE
+ return Scope.TEST
+
+ @setter
+ def source(self, source: "Path|str|None") -> "Path|None":
+ return Path(source) if source else None
+
+ @property
+ def version(self) -> str:
+ return self._attr("ROBOT_LIBRARY_VERSION") or self._attr("__version__")
-def TestLibrary(name, args=None, variables=None, create_handlers=True, logger=LOGGER):
- if name in STDLIBS:
- import_name = 'robot.libraries.' + name
- else:
- import_name = name
- with OutputCapturer(library_import=True):
- importer = Importer('library', logger=LOGGER)
- libcode, source = importer.import_class_or_module(import_name,
- return_source=True)
- libclass = _get_lib_class(libcode)
- lib = libclass(libcode, name, args or [], source, logger, variables)
- if create_handlers:
- lib.create_handlers()
- return lib
-
-
-def _get_lib_class(libcode):
- if inspect.ismodule(libcode):
- return _ModuleLibrary
- if GetKeywordNames(libcode):
- if RunKeyword(libcode):
- return _DynamicLibrary
+ @property
+ def lineno(self) -> int:
+ return 1
+
+ def _attr(self, name, default="", upper=False) -> str:
+ value = str(getattr(self.code, name, default))
+ if upper:
+ value = normalize(value, ignore="_").upper()
+ return value
+
+ @classmethod
+ def from_name(
+ cls,
+ name: str,
+ real_name: "str|None" = None,
+ args: "Sequence[str]|None" = None,
+ variables=None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "TestLibrary":
+ if name in STDLIBS:
+ import_name = "robot.libraries." + name
else:
- return _HybridLibrary
- return _ClassLibrary
+ import_name = name
+ if Path(name).exists():
+ name = Path(name).stem
+ with OutputCapturer(library_import=True):
+ importer = Importer("library", logger=logger)
+ code, source = importer.import_class_or_module(
+ import_name, return_source=True
+ )
+ return cls.from_code(
+ code, name, real_name, source, args, variables, create_keywords, logger
+ )
+ @classmethod
+ def from_code(
+ cls,
+ code: "type|ModuleType",
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ args: "Sequence[str]|None" = None,
+ variables=None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "TestLibrary":
+ if inspect.ismodule(code):
+ lib = cls.from_module(
+ code, name, real_name, source, create_keywords, logger
+ )
+ if args: # Resolving arguments reports an error.
+ lib.init.resolve_arguments(args, variables=variables)
+ return lib
+ if args is None:
+ args = ()
+ return cls.from_class(
+ code, name, real_name, source, args, variables, create_keywords, logger
+ )
-class _BaseTestLibrary:
- get_handler_error_level = 'INFO'
+ @classmethod
+ def from_module(
+ cls,
+ module: ModuleType,
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "TestLibrary":
+ return ModuleLibrary.from_module(
+ module, name, real_name, source, create_keywords, logger
+ )
- def __init__(self, libcode, name, args, source, logger, variables):
- if os.path.exists(name):
- name = os.path.splitext(os.path.basename(os.path.abspath(name)))[0]
- self._libcode = libcode
- self._libinst = None
- self.version = self._get_version(libcode)
- self.name = name
- self.orig_name = name # Stores original name when importing WITH NAME
- self.source = source
- self.logger = logger
- self.converters = self._get_converters(libcode)
- self.handlers = HandlerStore(self.name, HandlerStore.LIBRARY_TYPE)
- self.has_listener = None # Set when first instance is created
- self._doc = None
- self.doc_format = self._get_doc_format(libcode)
- self.scope = LibraryScope(libcode, self)
- self.init = self._create_init_handler(libcode)
- self.positional_args, self.named_args \
- = self.init.resolve_arguments(args, variables)
-
- def __len__(self):
- return len(self.handlers)
-
- def __bool__(self):
- return bool(self.handlers) or self.has_listener
+ @classmethod
+ def from_class(
+ cls,
+ klass: type,
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ args: Sequence[str] = (),
+ variables=None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "TestLibrary":
+ if not GetKeywordNames(klass):
+ library = ClassLibrary
+ elif not RunKeyword(klass):
+ library = HybridLibrary
+ else:
+ library = DynamicLibrary
+ return library.from_class(
+ klass, name, real_name, source, args, variables, create_keywords, logger
+ )
+
+ def create_keywords(self):
+ raise NotImplementedError
+
+ @overload
+ def find_keywords(
+ self,
+ name: str,
+ count: Literal[1],
+ ) -> LibraryKeyword: ...
+
+ @overload
+ def find_keywords(
+ self,
+ name: str,
+ count: "int|None" = None,
+ ) -> "list[LibraryKeyword]": ...
+
+ def find_keywords(
+ self,
+ name: str,
+ count: "int|None" = None,
+ ) -> "list[LibraryKeyword]|LibraryKeyword":
+ return self.keyword_finder.find(name, count)
+
+ def copy(self: Self, name: str) -> Self:
+ lib = type(self)(
+ self.code,
+ self.init.copy(),
+ name,
+ self.real_name,
+ self.source,
+ self._logger,
+ )
+ lib.instance = self.instance
+ lib.keywords = [kw.copy(owner=lib) for kw in self.keywords]
+ return lib
+
+ def report_error(
+ self,
+ message: str,
+ details: "str|None" = None,
+ level: str = "ERROR",
+ details_level: str = "INFO",
+ ):
+ prefix = "Error in" if level in ("ERROR", "WARN") else "In"
+ self._logger.write(f"{prefix} library '{self.name}': {message}", level)
+ if details:
+ self._logger.write(f"Details:\n{details}", details_level)
+
+
+class ModuleLibrary(TestLibrary):
@property
- def doc(self):
- if self._doc is None:
- self._doc = getdoc(self.get_instance())
- return self._doc
+ def scope(self) -> Scope:
+ return Scope.GLOBAL
+
+ @classmethod
+ def from_module(
+ cls,
+ module: ModuleType,
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "ModuleLibrary":
+ library = cls(module, LibraryInit.null(), name, real_name, source, logger)
+ if create_keywords:
+ library.create_keywords()
+ return library
+
+ @classmethod
+ def from_class(cls, *args, **kws) -> "TestLibrary":
+ raise TypeError(f"Cannot create '{cls.__name__}' from class.")
+
+ def create_keywords(self):
+ includes = getattr(self.code, "__all__", None)
+ StaticKeywordCreator(self, included_names=includes).create_keywords()
+
+
+class ClassLibrary(TestLibrary):
@property
- def lineno(self):
- if inspect.ismodule(self._libcode):
- return 1
+ def instance(self) -> Any:
+ if self._instance is None:
+ positional, named = self.init.positional, self.init.named
+ try:
+ with OutputCapturer(library_import=True):
+ self._instance = self.code(*positional, **named)
+ except Exception:
+ message, details = get_error_details()
+ if positional or named:
+ args = seq2str2(positional + [f"{n}={named[n]}" for n in named])
+ args_text = f"arguments {args}"
+ else:
+ args_text = "no arguments"
+ raise DataError(
+ f"Initializing library '{self.name}' with {args_text} "
+ f"failed: {message}\n{details}"
+ )
+ if self._has_listeners is None:
+ self._has_listeners = self._instance_has_listeners(self._instance)
+ return self._instance
+
+ @instance.setter
+ def instance(self, instance):
+ self._instance = instance
+
+ @property
+ def lineno(self) -> int:
try:
- lines, start_lineno = inspect.getsourcelines(self._libcode)
+ lines, start_lineno = inspect.getsourcelines(self.code)
except (TypeError, OSError, IOError):
- return -1
+ return 1
for increment, line in enumerate(lines):
- if line.strip().startswith('class '):
+ if line.strip().startswith("class "):
return start_lineno + increment
return start_lineno
- def create_handlers(self):
- self._create_handlers(self.get_instance())
- self.reset_instance()
-
- def reload(self):
- self.handlers = HandlerStore(self.name, HandlerStore.LIBRARY_TYPE)
- self._create_handlers(self.get_instance())
+ @classmethod
+ def from_module(cls, *args, **kws) -> "TestLibrary":
+ raise TypeError(f"Cannot create '{cls.__name__}' from module.")
+
+ @classmethod
+ def from_class(
+ cls,
+ klass: type,
+ name: "str|None" = None,
+ real_name: "str|None" = None,
+ source: "Path|None" = None,
+ args: Sequence[str] = (),
+ variables=None,
+ create_keywords: bool = True,
+ logger=LOGGER,
+ ) -> "ClassLibrary":
+ init = LibraryInit.from_class(klass)
+ library = cls(klass, init, name, real_name, source, logger)
+ positional, named = init.args.resolve(args, variables=variables)
+ init.positional, init.named = list(positional), dict(named)
+ if create_keywords:
+ library.create_keywords()
+ return library
+
+ def create_keywords(self):
+ StaticKeywordCreator(self, avoid_properties=True).create_keywords()
+
+
+class HybridLibrary(ClassLibrary):
+
+ def create_keywords(self):
+ names = DynamicKeywordCreator(self).get_keyword_names()
+ creator = StaticKeywordCreator(self, getting_method_failed_level="ERROR")
+ creator.create_keywords(names)
+
+
+class DynamicLibrary(ClassLibrary):
+ _supports_named_args = None
- def start_suite(self):
- self.scope.start_suite()
+ @property
+ def supports_named_args(self) -> bool:
+ if self._supports_named_args is None:
+ self._supports_named_args = RunKeyword(self.instance).supports_named_args
+ return self._supports_named_args
- def end_suite(self):
- self.scope.end_suite()
+ @property
+ def doc(self) -> str:
+ return GetKeywordDocumentation(self.instance)("__intro__") or super().doc
- def start_test(self):
- self.scope.start_test()
+ def create_keywords(self):
+ DynamicKeywordCreator(self).create_keywords()
- def end_test(self):
- self.scope.end_test()
- def report_error(self, message, details=None, level='ERROR',
- details_level='INFO'):
- prefix = 'Error in' if level in ('ERROR', 'WARN') else 'In'
- self.logger.write("%s library '%s': %s" % (prefix, self.name, message),
- level)
- if details:
- self.logger.write('Details:\n%s' % details, details_level)
+class KeywordCreator:
- def _get_version(self, libcode):
- return self._get_attr(libcode, 'ROBOT_LIBRARY_VERSION') \
- or self._get_attr(libcode, '__version__')
+ def __init__(self, library: TestLibrary, getting_method_failed_level="INFO"):
+ self.library = library
+ self.getting_method_failed_level = getting_method_failed_level
- def _get_attr(self, object, attr, default='', upper=False):
- value = str(getattr(object, attr, default))
- if upper:
- value = normalize(value, ignore='_').upper()
- return value
+ def get_keyword_names(self) -> "list[str]":
+ raise NotImplementedError
- def _get_doc_format(self, libcode):
- return self._get_attr(libcode, 'ROBOT_LIBRARY_DOC_FORMAT', upper=True)
+ def create_keywords(self, names: "list[str]|None" = None):
+ library = self.library
+ library.keyword_finder.invalidate_cache()
+ instance = library.instance
+ keywords = library.keywords = []
+ if names is None:
+ names = self.get_keyword_names()
+ seen = NormalizedDict(ignore="_")
+ for name in names:
+ try:
+ kw = self._create_keyword(instance, name)
+ except DataError as err:
+ self._adding_keyword_failed(
+ name, err.message, err.details, self.getting_method_failed_level
+ )
+ else:
+ if not kw:
+ continue
+ try:
+ if kw.embedded:
+ self._validate_embedded(kw)
+ else:
+ self._handle_duplicates(kw, seen)
+ except DataError as err:
+ self._adding_keyword_failed(kw.name, err.message, err.details)
+ else:
+ keywords.append(kw)
+ library._logger.debug(f"Created keyword '{kw.name}'.")
+
+ def _create_keyword(self, instance, name) -> "LibraryKeyword|None":
+ raise NotImplementedError
+
+ def _handle_duplicates(self, kw: LibraryKeyword, seen: NormalizedDict):
+ if kw.name in seen:
+ error = "Keyword with same name defined multiple times."
+ seen[kw.name].error = error
+ raise DataError(error)
+ seen[kw.name] = kw
+
+ def _validate_embedded(self, kw: LibraryKeyword):
+ if len(kw.embedded.args) > kw.args.maxargs:
+ raise DataError(
+ "Keyword must accept at least as many positional arguments "
+ "as it has embedded arguments."
+ )
+ if any(kw.embedded.types):
+ arg, typ = next(
+ (a, t) for a, t in zip(kw.embedded.args, kw.embedded.types) if t
+ )
+ raise DataError(
+ f"Library keywords do not support type information with "
+ f"embedded arguments like '${{{arg}: {typ}}}'. "
+ f"Use type hints with function arguments instead."
+ )
+ kw.args.embedded = kw.embedded.args
+
+ def _adding_keyword_failed(self, name, error, details, level="ERROR"):
+ self.library.report_error(
+ f"Adding keyword '{name}' failed: {error}",
+ details,
+ level=level,
+ details_level="DEBUG",
+ )
- def _create_init_handler(self, libcode):
- return InitHandler(self, self._resolve_init_method(libcode))
- def _resolve_init_method(self, libcode):
- init = getattr(libcode, '__init__', None)
- return init if is_init(init) else None
+class StaticKeywordCreator(KeywordCreator):
- def _get_converters(self, libcode):
- converters = getattr(libcode, 'ROBOT_LIBRARY_CONVERTERS', None)
- if not converters:
- return None
- if not is_dict_like(converters):
- self.report_error(f'Argument converters must be given as a dictionary, '
- f'got {type_name(converters)}.')
- return None
- return CustomArgumentConverters.from_dict(converters, self.report_error)
-
- def reset_instance(self, instance=None):
- prev = self._libinst
- if not self.scope.is_global:
- self._libinst = instance
- return prev
-
- def get_instance(self, create=True):
- if not create:
- return self._libinst
- if self._libinst is None:
- self._libinst = self._get_instance(self._libcode)
- if self.has_listener is None:
- self.has_listener = bool(self.get_listeners(self._libinst))
- return self._libinst
-
- def _get_instance(self, libcode):
- with OutputCapturer(library_import=True):
- try:
- return libcode(*self.positional_args, **dict(self.named_args))
- except:
- self._raise_creating_instance_failed()
-
- def get_listeners(self, libinst=None):
- if libinst is None:
- libinst = self.get_instance()
- listeners = getattr(libinst, 'ROBOT_LIBRARY_LISTENER', None)
- if listeners is None:
- return []
- if is_list_like(listeners):
- return listeners
- return [listeners]
+ def __init__(
+ self,
+ library: TestLibrary,
+ getting_method_failed_level="INFO",
+ included_names=None,
+ avoid_properties=False,
+ ):
+ super().__init__(library, getting_method_failed_level)
+ self.included_names = included_names
+ self.avoid_properties = avoid_properties
- def register_listeners(self):
- if self.has_listener:
- try:
- listeners = EXECUTION_CONTEXTS.current.output.library_listeners
- listeners.register(self.get_listeners(), self)
- except DataError as err:
- self.has_listener = False
- # Error should have information about suite where the
- # problem occurred but we don't have such info here.
- self.report_error("Registering listeners failed: %s" % err)
-
- def unregister_listeners(self, close=False):
- if self.has_listener:
- listeners = EXECUTION_CONTEXTS.current.output.library_listeners
- listeners.unregister(self, close)
-
- def close_global_listeners(self):
- if self.scope.is_global:
- for listener in self.get_listeners():
- self._close_listener(listener)
-
- def _close_listener(self, listener):
- method = (getattr(listener, 'close', None) or
- getattr(listener, '_close', None))
+ def get_keyword_names(self) -> "list[str]":
+ instance = self.library.instance
try:
- if method:
- method()
+ return self._get_names(instance)
except Exception:
message, details = get_error_details()
- name = getattr(listener, '__name__', None) or type_name(listener)
- self.report_error("Calling method '%s' of listener '%s' failed: %s"
- % (method.__name__, name, message), details)
-
- def _create_handlers(self, libcode):
+ raise DataError(
+ f"Getting keyword names from library '{self.library.name}' "
+ f"failed: {message}",
+ details,
+ )
+
+ def _get_names(self, instance) -> "list[str]":
+ names = []
+ auto_keywords = getattr(instance, "ROBOT_AUTO_KEYWORDS", True)
+ included_names = self.included_names
+ for name in dir(instance):
+ if self._is_included(name, instance, auto_keywords, included_names):
+ names.append(name)
+ return names
+
+ def _is_included(self, name, instance, auto_keywords, included_names) -> bool:
+ if not (
+ auto_keywords
+ and name[:1] != "_"
+ or self._is_explicitly_included(name, instance)
+ ):
+ return False
+ return included_names is None or name in included_names
+
+ def _is_explicitly_included(self, name, instance) -> bool:
try:
- names = self._get_handler_names(libcode)
- except Exception:
- message, details = get_error_details()
- raise DataError("Getting keyword names from library '%s' failed: %s"
- % (self.name, message), details)
- for name in names:
- method = self._try_to_get_handler_method(libcode, name)
- if method:
- handler, embedded = self._try_to_create_handler(name, method)
- if handler:
- try:
- self.handlers.add(handler, embedded)
- except DataError as err:
- self._adding_keyword_failed(handler.name, err)
- else:
- self.logger.debug("Created keyword '%s'" % handler.name)
-
- def _get_handler_names(self, libcode):
- def has_robot_name(name):
+ candidate = inspect.getattr_static(instance, name)
+ except AttributeError: # Attribute is dynamic. Try harder.
try:
- handler = self._get_handler_method(libcode, name)
- except DataError:
+ candidate = getattr(instance, name)
+ except Exception: # Attribute is invalid. Report.
+ msg, details = get_error_details()
+ self._adding_keyword_failed(
+ name, msg, details, self.getting_method_failed_level
+ )
return False
- return hasattr(handler, 'robot_name')
-
- auto_keywords = getattr(libcode, 'ROBOT_AUTO_KEYWORDS', True)
- if auto_keywords:
- predicate = lambda name: name[:1] != '_' or has_robot_name(name)
- else:
- predicate = has_robot_name
- return [name for name in dir(libcode) if predicate(name)]
-
- def _try_to_get_handler_method(self, libcode, name):
+ if isinstance(candidate, (classmethod, staticmethod)):
+ candidate = candidate.__func__
try:
- return self._get_handler_method(libcode, name)
- except DataError as err:
- self._adding_keyword_failed(name, err, self.get_handler_error_level)
- return None
-
- def _adding_keyword_failed(self, name, error, level='ERROR'):
- self.report_error(
- "Adding keyword '%s' failed: %s" % (name, error.message),
- error.details,
- level=level,
- details_level='DEBUG'
- )
+ return hasattr(candidate, "robot_name")
+ except Exception:
+ return False
- def _get_handler_method(self, libcode, name):
+ def _create_keyword(self, instance, name) -> "StaticKeyword|None":
+ if self.avoid_properties:
+ self._pre_validate_method(instance, name)
try:
- method = getattr(libcode, name)
+ method = getattr(instance, name)
except Exception:
message, details = get_error_details()
- raise DataError(f'Getting handler method failed: {message}', details)
- self._validate_handler_method(method)
- return method
-
- def _validate_handler_method(self, method):
- # isroutine returns false for partial objects. This may change in Python 3.11.
- if not (inspect.isroutine(method) or isinstance(method, partial)):
- raise DataError('Not a method or function.')
- if getattr(method, 'robot_not_keyword', False):
- raise DataError('Not exposed as a keyword.')
- return method
-
- def _try_to_create_handler(self, name, method):
+ raise DataError(f"Getting handler method failed: {message}", details)
+ self._validate_method(method)
try:
- handler = self._create_handler(name, method)
+ return StaticKeyword.from_name(name, self.library)
except DataError as err:
- self._adding_keyword_failed(name, err)
- return None, False
- try:
- return self._get_possible_embedded_args_handler(handler)
- except DataError as err:
- self._adding_keyword_failed(handler.name, err)
- return None, False
-
- def _create_handler(self, handler_name, handler_method):
- return Handler(self, handler_name, handler_method)
-
- def _get_possible_embedded_args_handler(self, handler):
- embedded = EmbeddedArguments(handler.name)
- if embedded:
- self._validate_embedded_count(embedded, handler.arguments)
- return EmbeddedArgumentsHandler(embedded.name, handler), True
- return handler, False
-
- def _validate_embedded_count(self, embedded, arguments):
- if not (arguments.minargs <= len(embedded.args) <= arguments.maxargs):
- raise DataError('Embedded argument count does not match number of '
- 'accepted arguments.')
-
- def _raise_creating_instance_failed(self):
- msg, details = get_error_details()
- if self.positional_args or self.named_args:
- args = self.positional_args + ['%s=%s' % item for item in self.named_args]
- args_text = 'arguments %s' % seq2str2(args)
- else:
- args_text = 'no arguments'
- raise DataError("Initializing library '%s' with %s failed: %s\n%s"
- % (self.name, args_text, msg, details))
-
-
-class _ClassLibrary(_BaseTestLibrary):
-
- def _get_handler_method(self, libinst, name):
- # Type is checked before using getattr to avoid calling properties.
- for item in (libinst,) + inspect.getmro(libinst.__class__):
- if item is object:
- continue
- if hasattr(item, '__dict__') and name in item.__dict__:
- self._validate_handler_method(item.__dict__[name])
- return getattr(libinst, name)
- raise DataError('No non-implicit implementation found.')
-
-
-class _ModuleLibrary(_BaseTestLibrary):
-
- def _get_handler_method(self, libcode, name):
- method = _BaseTestLibrary._get_handler_method(self, libcode, name)
- if hasattr(libcode, '__all__') and name not in libcode.__all__:
- raise DataError('Not exposed as a keyword.')
- return method
-
- def get_instance(self, create=True):
- if not create:
- return self._libcode
- if self.has_listener is None:
- self.has_listener = bool(self.get_listeners(self._libcode))
- return self._libcode
-
- def _create_init_handler(self, libcode):
- return InitHandler(self)
+ self._adding_keyword_failed(name, err.message, err.details)
+ return None
+ def _pre_validate_method(self, instance, name):
+ try:
+ candidate = inspect.getattr_static(instance, name)
+ except AttributeError: # Attribute is dynamic. Cannot pre-validate.
+ return
+ if isinstance(candidate, classmethod):
+ candidate = candidate.__func__
+ if isinstance(candidate, cached_property) or not inspect.isroutine(candidate):
+ raise DataError("Not a method or function.")
-class _HybridLibrary(_BaseTestLibrary):
- get_handler_error_level = 'ERROR'
+ def _validate_method(self, candidate):
+ if not (inspect.isroutine(candidate) or isinstance(candidate, partial)):
+ raise DataError("Not a method or function.")
+ if getattr(candidate, "robot_not_keyword", False):
+ raise DataError("Not exposed as a keyword.")
- def _get_handler_names(self, instance):
- return GetKeywordNames(instance)()
+class DynamicKeywordCreator(KeywordCreator):
+ library: DynamicLibrary
-class _DynamicLibrary(_BaseTestLibrary):
- get_handler_error_level = 'ERROR'
+ def __init__(self, library: "DynamicLibrary|HybridLibrary"):
+ super().__init__(library, getting_method_failed_level="ERROR")
- def __init__(self, libcode, name, args, source, logger, variables=None):
- _BaseTestLibrary.__init__(self, libcode, name, args, source, logger,
- variables)
+ def get_keyword_names(self) -> "list[str]":
+ try:
+ return GetKeywordNames(self.library.instance)()
+ except DataError as err:
+ raise DataError(
+ f"Getting keyword names from library '{self.library.name}' "
+ f"failed: {err}"
+ )
- @property
- def doc(self):
- if self._doc is None:
- self._doc = (self._get_kw_doc('__intro__') or
- _BaseTestLibrary.doc.fget(self))
- return self._doc
-
- def _get_kw_doc(self, name):
- getter = GetKeywordDocumentation(self.get_instance())
- return getter(name)
-
- def _get_kw_args(self, name):
- getter = GetKeywordArguments(self.get_instance())
- return getter(name)
-
- def _get_kw_tags(self, name):
- getter = GetKeywordTags(self.get_instance())
- return getter(name)
-
- def _get_handler_names(self, instance):
- return GetKeywordNames(instance)()
-
- def _get_handler_method(self, instance, name):
- return RunKeyword(instance)
-
- def _create_handler(self, name, method):
- argspec = self._get_kw_args(name)
- tags = self._get_kw_tags(name)
- doc = self._get_kw_doc(name)
- return DynamicHandler(self, name, method, doc, argspec, tags)
-
- def _create_init_handler(self, libcode):
- docgetter = lambda: self._get_kw_doc('__init__')
- return InitHandler(self, self._resolve_init_method(libcode), docgetter)
+ def _create_keyword(self, instance, name) -> DynamicKeyword:
+ return DynamicKeyword.from_name(name, self.library)
diff --git a/src/robot/running/timeouts/__init__.py b/src/robot/running/timeouts/__init__.py
index 68d5e6067b2..df2dc2a42c5 100644
--- a/src/robot/running/timeouts/__init__.py
+++ b/src/robot/running/timeouts/__init__.py
@@ -13,115 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import time
-
-from robot.utils import Sortable, secs_to_timestr, timestr_to_secs, WINDOWS
-from robot.errors import TimeoutError, DataError, FrameworkError
-
-if WINDOWS:
- from .windows import Timeout
-else:
- from .posix import Timeout
-
-
-class _Timeout(Sortable):
-
- def __init__(self, timeout=None, variables=None):
- self.string = timeout or ''
- self.secs = -1
- self.starttime = -1
- self.error = None
- if variables:
- self.replace_variables(variables)
-
- @property
- def active(self):
- return self.starttime > 0
-
- def replace_variables(self, variables):
- try:
- self.string = variables.replace_string(self.string)
- if not self:
- return
- self.secs = timestr_to_secs(self.string)
- self.string = secs_to_timestr(self.secs)
- except (DataError, ValueError) as err:
- self.secs = 0.000001 # to make timeout active
- self.error = ('Setting %s timeout failed: %s' % (self.type.lower(), err))
-
- def start(self):
- if self.secs > 0:
- self.starttime = time.time()
-
- def time_left(self):
- if not self.active:
- return -1
- elapsed = time.time() - self.starttime
- # Timeout granularity is 1ms. Without rounding some timeout tests fail
- # intermittently on Windows, probably due to threading.Event.wait().
- return round(self.secs - elapsed, 3)
-
- def timed_out(self):
- return self.active and self.time_left() <= 0
-
- def run(self, runnable, args=None, kwargs=None):
- if self.error:
- raise DataError(self.error)
- if not self.active:
- raise FrameworkError('Timeout is not active')
- timeout = self.time_left()
- error = TimeoutError(self._timeout_error,
- test_timeout=isinstance(self, TestTimeout))
- if timeout <= 0:
- raise error
- executable = lambda: runnable(*(args or ()), **(kwargs or {}))
- return Timeout(timeout, error).execute(executable)
-
- def get_message(self):
- if not self.active:
- return '%s timeout not active.' % self.type
- if not self.timed_out():
- return '%s timeout %s active. %s seconds left.' \
- % (self.type, self.string, self.time_left())
- return self._timeout_error
-
- @property
- def _timeout_error(self):
- return '%s timeout %s exceeded.' % (self.type, self.string)
-
- def __str__(self):
- return self.string
-
- def __bool__(self):
- return bool(self.string and self.string.upper() != 'NONE')
-
- @property
- def _sort_key(self):
- return not self.active, self.time_left()
-
- def __eq__(self, other):
- return self is other
-
- def __hash__(self):
- return id(self)
-
-
-class TestTimeout(_Timeout):
- type = 'Test'
- _keyword_timeout_occurred = False
-
- def __init__(self, timeout=None, variables=None, rpa=False):
- if rpa:
- self.type = 'Task'
- _Timeout.__init__(self, timeout, variables)
-
- def set_keyword_timeout(self, timeout_occurred):
- if timeout_occurred:
- self._keyword_timeout_occurred = True
-
- def any_timeout_occurred(self):
- return self.timed_out() or self._keyword_timeout_occurred
-
-
-class KeywordTimeout(_Timeout):
- type = 'Keyword'
+from .timeout import KeywordTimeout as KeywordTimeout, TestTimeout as TestTimeout
diff --git a/src/robot/running/modelcombiner.py b/src/robot/running/timeouts/nosupport.py
similarity index 55%
rename from src/robot/running/modelcombiner.py
rename to src/robot/running/timeouts/nosupport.py
index 0e781f4dab5..5943b216c05 100644
--- a/src/robot/running/modelcombiner.py
+++ b/src/robot/running/timeouts/nosupport.py
@@ -13,20 +13,12 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from robot.errors import DataError
-class ModelCombiner:
- __slots__ = ['data', 'result', 'priority']
+from .runner import Runner
- def __init__(self, data, result, **priority):
- self.data = data
- self.result = result
- self.priority = priority
- def __getattr__(self, name):
- if name in self.priority:
- return self.priority[name]
- if hasattr(self.result, name):
- return getattr(self.result, name)
- if hasattr(self.data, name):
- return getattr(self.data, name)
- raise AttributeError(name)
+class NoSupportRunner(Runner):
+
+ def _run(self, runnable):
+ raise DataError("Timeouts are not supported on this platform.")
diff --git a/src/robot/running/timeouts/posix.py b/src/robot/running/timeouts/posix.py
index 51678be7542..c2cbb4d7e46 100644
--- a/src/robot/running/timeouts/posix.py
+++ b/src/robot/running/timeouts/posix.py
@@ -13,16 +13,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from signal import setitimer, signal, SIGALRM, ITIMER_REAL
+from signal import ITIMER_REAL, setitimer, SIG_DFL, SIGALRM, signal
+from robot.errors import DataError, TimeoutExceeded
-class Timeout:
+from .runner import Runner
- def __init__(self, timeout, error):
- self._timeout = timeout
- self._error = error
- def execute(self, runnable):
+class PosixRunner(Runner):
+ _started = 0
+
+ def __init__(
+ self,
+ timeout: float,
+ timeout_error: TimeoutExceeded,
+ data_error: "DataError|None" = None,
+ ):
+ super().__init__(timeout, timeout_error, data_error)
+ self._orig_alrm = None
+
+ def _run(self, runnable):
self._start_timer()
try:
return runnable()
@@ -30,11 +40,18 @@ def execute(self, runnable):
self._stop_timer()
def _start_timer(self):
- signal(SIGALRM, self._raise_timeout_error)
- setitimer(ITIMER_REAL, self._timeout)
+ if not self._started:
+ self._orig_alrm = signal(SIGALRM, self._raise_timeout)
+ setitimer(ITIMER_REAL, self.timeout)
+ type(self)._started += 1
- def _raise_timeout_error(self, signum, frame):
- raise self._error
+ def _raise_timeout(self, signum, frame):
+ self.exceeded = True
+ if not self.paused:
+ raise self.timeout_error
def _stop_timer(self):
- setitimer(ITIMER_REAL, 0)
+ type(self)._started -= 1
+ if not self._started:
+ setitimer(ITIMER_REAL, 0)
+ signal(SIGALRM, self._orig_alrm or SIG_DFL)
diff --git a/src/robot/running/timeouts/runner.py b/src/robot/running/timeouts/runner.py
new file mode 100644
index 00000000000..f2d61ac89b8
--- /dev/null
+++ b/src/robot/running/timeouts/runner.py
@@ -0,0 +1,89 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from collections.abc import Callable, Mapping, Sequence
+
+from robot.errors import DataError, TimeoutExceeded
+from robot.utils import WINDOWS
+
+
+class Runner:
+ runner_implementation: "type[Runner]|None" = None
+
+ def __init__(
+ self,
+ timeout: float,
+ timeout_error: TimeoutExceeded,
+ data_error: "DataError|None" = None,
+ ):
+ self.timeout = round(timeout, 3)
+ self.timeout_error = timeout_error
+ self.data_error = data_error
+ self.exceeded = False
+ self.paused = 0
+
+ @classmethod
+ def for_platform(
+ cls,
+ timeout: float,
+ timeout_error: TimeoutExceeded,
+ data_error: "DataError|None" = None,
+ ) -> "Runner":
+ runner = cls.runner_implementation
+ if not runner:
+ runner = cls.runner_implementation = cls._get_runner_implementation()
+ return runner(timeout, timeout_error, data_error)
+
+ @classmethod
+ def _get_runner_implementation(cls) -> "type[Runner]":
+ if WINDOWS:
+ from .windows import WindowsRunner
+
+ return WindowsRunner
+ try:
+ from .posix import PosixRunner
+
+ return PosixRunner
+ except ImportError:
+ from .nosupport import NoSupportRunner
+
+ return NoSupportRunner
+
+ def run(
+ self,
+ runnable: "Callable[..., object]",
+ args: "Sequence|None" = None,
+ kwargs: "Mapping|None" = None,
+ ) -> object:
+ if self.data_error:
+ raise self.data_error
+ if self.timeout <= 0:
+ raise self.timeout_error
+ try:
+ return self._run(lambda: runnable(*(args or ()), **(kwargs or {})))
+ finally:
+ if self.exceeded and not self.paused:
+ raise self.timeout_error from None
+
+ def _run(self, runnable: "Callable[[], object]") -> object:
+ raise NotImplementedError
+
+ def pause(self):
+ self.paused += 1
+
+ def resume(self):
+ self.paused -= 1
+ if self.exceeded and not self.paused:
+ raise self.timeout_error
diff --git a/src/robot/running/timeouts/timeout.py b/src/robot/running/timeouts/timeout.py
new file mode 100644
index 00000000000..d9a83d84188
--- /dev/null
+++ b/src/robot/running/timeouts/timeout.py
@@ -0,0 +1,144 @@
+# Copyright 2008-2015 Nokia Networks
+# Copyright 2016- Robot Framework Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import time
+from collections.abc import Callable, Mapping, Sequence
+
+from robot.errors import DataError, TimeoutExceeded
+from robot.utils import secs_to_timestr, Sortable, timestr_to_secs
+
+from .runner import Runner
+
+
+class Timeout(Sortable):
+ kind: str
+
+ def __init__(
+ self,
+ timeout: "float|str|None" = None,
+ variables=None,
+ start: bool = False,
+ ):
+ try:
+ self.timeout = self._parse(timeout, variables)
+ except (DataError, ValueError) as err:
+ self.timeout = 0.000001 # to make timeout active
+ self.string = str(timeout)
+ self.error = f"Setting {self.kind.lower()} timeout failed: {err}"
+ else:
+ self.string = secs_to_timestr(self.timeout) if self.timeout else "NONE"
+ self.error = None
+ if start:
+ self.start()
+ else:
+ self.start_time = -1
+
+ def _parse(self, timeout, variables) -> "float|None":
+ if not timeout:
+ return None
+ if variables:
+ timeout = variables.replace_string(timeout)
+ else:
+ timeout = str(timeout)
+ if timeout.upper() in ("NONE", ""):
+ return None
+ timeout = timestr_to_secs(timeout)
+ if timeout <= 0:
+ return None
+ return timeout
+
+ def start(self):
+ if self.timeout is None:
+ raise ValueError("Cannot start inactive timeout.")
+ self.start_time = time.time()
+
+ def time_left(self) -> float:
+ if self.start_time < 0:
+ raise ValueError("Timeout is not started.")
+ return self.timeout - (time.time() - self.start_time)
+
+ def timed_out(self) -> bool:
+ return self.time_left() <= 0
+
+ def get_runner(self) -> Runner:
+ """Get a runner that can run code with a timeout."""
+ timeout_error = TimeoutExceeded(
+ f"{self.kind.title()} timeout {self} exceeded.",
+ test_timeout=self.kind != "KEYWORD",
+ )
+ data_error = DataError(self.error) if self.error else None
+ return Runner.for_platform(self.time_left(), timeout_error, data_error)
+
+ def run(
+ self,
+ runnable: "Callable[..., object]",
+ args: "Sequence|None" = None,
+ kwargs: "Mapping|None" = None,
+ ) -> object:
+ """Convenience method to directly run code with a timeout."""
+ return self.get_runner().run(runnable, args, kwargs)
+
+ def get_message(self):
+ kind = self.kind.title()
+ if self.start_time < 0:
+ return f"{kind} timeout not active."
+ left = self.time_left()
+ if left > 0:
+ return f"{kind} timeout {self} active. {left:.3f} seconds left."
+ return f"{kind} timeout {self} exceeded."
+
+ def __str__(self):
+ return self.string
+
+ def __bool__(self):
+ return self.timeout is not None
+
+ @property
+ def _sort_key(self):
+ if self.timeout is None:
+ raise ValueError("Cannot compare inactive timeout.")
+ return self.time_left()
+
+ def __eq__(self, other):
+ return self is other
+
+ def __hash__(self):
+ return id(self)
+
+
+class TestTimeout(Timeout):
+ kind = "TEST"
+ _keyword_timeout_occurred = False
+
+ def __init__(
+ self,
+ timeout: "float|str|None" = None,
+ variables=None,
+ start: bool = False,
+ rpa: bool = False,
+ ):
+ self.kind = "TASK" if rpa else self.kind
+ super().__init__(timeout, variables, start)
+
+ def set_keyword_timeout(self, timeout_occurred):
+ if timeout_occurred:
+ self._keyword_timeout_occurred = True
+
+ def any_timeout_occurred(self):
+ return self.timed_out() or self._keyword_timeout_occurred
+
+
+class KeywordTimeout(Timeout):
+ kind = "KEYWORD"
diff --git a/src/robot/running/timeouts/windows.py b/src/robot/running/timeouts/windows.py
index 14b576ff2ff..912f542ea12 100644
--- a/src/robot/running/timeouts/windows.py
+++ b/src/robot/running/timeouts/windows.py
@@ -15,57 +15,70 @@
import ctypes
import time
-from threading import current_thread, Lock, Timer
+from threading import current_thread, Timer
+from robot.errors import DataError, TimeoutExceeded
-class Timeout:
+from .runner import Runner
- def __init__(self, timeout, error):
+
+class WindowsRunner(Runner):
+
+ def __init__(
+ self,
+ timeout: float,
+ timeout_error: TimeoutExceeded,
+ data_error: "DataError|None" = None,
+ ):
+ super().__init__(timeout, timeout_error, data_error)
self._runner_thread_id = current_thread().ident
- self._timer = Timer(timeout, self._timed_out)
- self._error = error
- self._timeout_occurred = False
- self._finished = False
- self._lock = Lock()
+ self._timeout_pending = False
- def execute(self, runnable):
+ def _run(self, runnable):
+ timer = Timer(self.timeout, self._timeout_exceeded)
+ timer.start()
try:
- self._start_timer()
- try:
- result = runnable()
- finally:
- self._cancel_timer()
- self._wait_for_raised_timeout()
- return result
+ result = runnable()
+ except TimeoutExceeded:
+ self._timeout_pending = False
+ raise
finally:
- if self._timeout_occurred:
- raise self._error
+ timer.cancel()
+ self._wait_for_pending_timeout()
+ return result
- def _start_timer(self):
- self._timer.start()
+ def _timeout_exceeded(self):
+ self.exceeded = True
+ if not self.paused:
+ self._timeout_pending = True
+ self._raise_async_timeout()
- def _cancel_timer(self):
- with self._lock:
- self._finished = True
- self._timer.cancel()
+ def _raise_async_timeout(self):
+ # See the following for the original recipe and API docs.
+ # https://code.activestate.com/recipes/496960-thread2-killable-threads/
+ # https://docs.python.org/3/c-api/init.html#c.PyThreadState_SetAsyncExc
+ tid = ctypes.c_ulong(self._runner_thread_id)
+ error = ctypes.py_object(type(self.timeout_error))
+ modified = ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, error)
+ # This should never happen. Better anyway to check the return value
+ # and report the very unlikely error than ignore it.
+ if modified != 1:
+ raise ValueError(
+ f"Expected 'PyThreadState_SetAsyncExc' to return 1, got {modified}."
+ )
- def _wait_for_raised_timeout(self):
- if self._timeout_occurred:
- while True:
+ def _wait_for_pending_timeout(self):
+ # Wait for asynchronously raised timeout that hasn't yet been received.
+ # This can happen if a timeout occurs at the same time when the executed
+ # function returns. If the execution ever gets here, the timeout should
+ # happen immediately. The while loop shouldn't need a limit, but better
+ # to have it to avoid a deadlock even if our code had a bug.
+ if self._timeout_pending:
+ self._timeout_pending = False
+ end = time.time() + 1
+ while time.time() < end:
time.sleep(0)
- def _timed_out(self):
- with self._lock:
- if self._finished:
- return
- self._timeout_occurred = True
- self._raise_timeout()
-
- def _raise_timeout(self):
- # See, for example, http://tomerfiliba.com/recipes/Thread2/
- # for more information about using PyThreadState_SetAsyncExc
- tid = ctypes.c_long(self._runner_thread_id)
- error = ctypes.py_object(type(self._error))
- while ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, error) > 1:
- ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, None)
- time.sleep(0) # give time for other threads
+ def pause(self):
+ super().pause()
+ self._wait_for_pending_timeout()
diff --git a/src/robot/running/usererrorhandler.py b/src/robot/running/usererrorhandler.py
deleted file mode 100644
index 38c6f3b0d42..00000000000
--- a/src/robot/running/usererrorhandler.py
+++ /dev/null
@@ -1,74 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from robot.model import Tags
-from robot.result import Keyword as KeywordResult
-from robot.variables import VariableAssignment
-
-from .arguments import ArgumentSpec
-from .statusreporter import StatusReporter
-
-
-class UserErrorHandler:
- """Created if creating handlers fail -- running raises DataError.
-
- The idea is not to raise DataError at processing time and prevent all
- tests in affected test case file from executing. Instead UserErrorHandler
- is created and if it is ever run DataError is raised then.
- """
-
- def __init__(self, error, name, libname=None, source=None, lineno=None):
- """
- :param robot.errors.DataError error: Occurred error.
- :param str name: Name of the affected keyword.
- :param str libname: Name of the affected library or resource.
- :param str source: Path to the source file.
- :param int lineno: Line number of the failing keyword.
- """
- self.error = error
- self.name = name
- self.libname = libname
- self.source = source
- self.lineno = lineno
- self.arguments = ArgumentSpec()
- self.timeout = None
- self.tags = Tags()
-
- @property
- def longname(self):
- return '%s.%s' % (self.libname, self.name) if self.libname else self.name
-
- @property
- def doc(self):
- return '*Creating keyword failed:* %s' % self.error
-
- @property
- def shortdoc(self):
- return self.doc.splitlines()[0]
-
- def create_runner(self, name):
- return self
-
- def run(self, kw, context, run=True):
- result = KeywordResult(kwname=self.name,
- libname=self.libname,
- args=kw.args,
- assign=tuple(VariableAssignment(kw.assign)),
- type=kw.type)
- with StatusReporter(kw, result, context, run):
- if run:
- raise self.error
-
- dry_run = run
diff --git a/src/robot/running/userkeyword.py b/src/robot/running/userkeyword.py
deleted file mode 100644
index 725aac0096c..00000000000
--- a/src/robot/running/userkeyword.py
+++ /dev/null
@@ -1,111 +0,0 @@
-# Copyright 2008-2015 Nokia Networks
-# Copyright 2016- Robot Framework Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os
-
-from robot.errors import DataError
-from robot.output import LOGGER
-from robot.utils import getshortdoc
-
-from .arguments import EmbeddedArguments, UserKeywordArgumentParser
-from .handlerstore import HandlerStore
-from .userkeywordrunner import UserKeywordRunner, EmbeddedArgumentsRunner
-from .usererrorhandler import UserErrorHandler
-
-
-class UserLibrary:
- TEST_CASE_FILE_TYPE = HandlerStore.TEST_CASE_FILE_TYPE
- RESOURCE_FILE_TYPE = HandlerStore.RESOURCE_FILE_TYPE
-
- def __init__(self, resource, source_type=RESOURCE_FILE_TYPE):
- source = resource.source
- basename = os.path.basename(source) if source else None
- self.name = os.path.splitext(basename)[0] \
- if source_type == self.RESOURCE_FILE_TYPE else None
- self.doc = resource.doc
- self.handlers = HandlerStore(basename, source_type)
- self.source = source
- self.source_type = source_type
- for kw in resource.keywords:
- try:
- handler = self._create_handler(kw)
- except DataError as error:
- handler = UserErrorHandler(error, kw.name, self.name, source, kw.lineno)
- self._log_creating_failed(handler, error)
- embedded = isinstance(handler, EmbeddedArgumentsHandler)
- try:
- self.handlers.add(handler, embedded)
- except DataError as error:
- self._log_creating_failed(handler, error)
-
- def _create_handler(self, kw):
- if kw.error:
- raise DataError(kw.error)
- embedded = EmbeddedArguments(kw.name)
- if not embedded:
- return UserKeywordHandler(kw, self.name)
- if kw.args:
- raise DataError('Keyword cannot have both normal and embedded arguments.')
- return EmbeddedArgumentsHandler(kw, self.name, embedded)
-
- def _log_creating_failed(self, handler, error):
- LOGGER.error(f"Error in file '{self.source}' on line {handler.lineno}: "
- f"Creating keyword '{handler.name}' failed: {error.message}")
-
-
-# TODO: Should be merged with running.model.UserKeyword
-
-class UserKeywordHandler:
-
- def __init__(self, keyword, libname):
- self.name = keyword.name
- self.libname = libname
- self.doc = keyword.doc
- self.source = keyword.source
- self.lineno = keyword.lineno
- self.tags = keyword.tags
- self.arguments = UserKeywordArgumentParser().parse(tuple(keyword.args),
- self.longname)
- self._kw = keyword
- self.timeout = keyword.timeout
- self.body = keyword.body
- self.return_value = tuple(keyword.return_)
- self.teardown = keyword.teardown
-
- @property
- def longname(self):
- return '%s.%s' % (self.libname, self.name) if self.libname else self.name
-
- @property
- def shortdoc(self):
- return getshortdoc(self.doc)
-
- def create_runner(self, name):
- return UserKeywordRunner(self)
-
-
-class EmbeddedArgumentsHandler(UserKeywordHandler):
-
- def __init__(self, keyword, libname, embedded):
- UserKeywordHandler.__init__(self, keyword, libname)
- self.keyword = keyword
- self.embedded_name = embedded.name
- self.embedded_args = embedded.args
-
- def matches(self, name):
- return self.embedded_name.match(name) is not None
-
- def create_runner(self, name):
- return EmbeddedArgumentsRunner(self, name)
diff --git a/src/robot/running/userkeywordrunner.py b/src/robot/running/userkeywordrunner.py
index 7516e2f4716..89367bb3cb9 100644
--- a/src/robot/running/userkeywordrunner.py
+++ b/src/robot/running/userkeywordrunner.py
@@ -13,241 +13,297 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from itertools import chain
+from typing import TYPE_CHECKING
-from robot.errors import (BreakLoop, ContinueLoop, DataError, ExecutionFailed,
- ExecutionPassed, ExecutionStatus, PassExecution,
- ReturnFromKeyword, UserKeywordExecutionFailed, VariableError)
+from robot.errors import (
+ DataError, ExecutionFailed, ExecutionPassed, ExecutionStatus, PassExecution,
+ ReturnFromKeyword, UserKeywordExecutionFailed, VariableError
+)
+from robot.model import Tags
from robot.result import Keyword as KeywordResult
-from robot.utils import getshortdoc, DotDict, prepr, split_tags_from_doc
+from robot.utils import DotDict, getshortdoc, prepr, split_tags_from_doc
from robot.variables import is_list_variable, VariableAssignment
-from .arguments import DefaultValue
+from .arguments import ArgumentSpec, DefaultValue
from .bodyrunner import BodyRunner, KeywordRunner
+from .model import Keyword as KeywordData
from .statusreporter import StatusReporter
from .timeouts import KeywordTimeout
+if TYPE_CHECKING:
+ from .resourcemodel import UserKeyword
-class UserKeywordRunner:
-
- def __init__(self, handler, name=None):
- self._handler = handler
- self.name = name or handler.name
-
- @property
- def longname(self):
- libname = self._handler.libname
- return '%s.%s' % (libname, self.name) if libname else self.name
-
- @property
- def libname(self):
- return self._handler.libname
- @property
- def arguments(self):
- """:rtype: :py:class:`robot.running.arguments.ArgumentSpec`"""
- return self._handler.arguments
+class UserKeywordRunner:
- def run(self, kw, context, run=True):
- assignment = VariableAssignment(kw.assign)
- result = self._get_result(kw, assignment, context.variables)
- with StatusReporter(kw, result, context, run):
+ def __init__(self, keyword: "UserKeyword", name: "str|None" = None):
+ self.keyword = keyword
+ self.name = name or keyword.name
+ self.pre_run_messages = ()
+
+ def run(self, data: KeywordData, result: KeywordResult, context, run=True):
+ kw = self.keyword.bind(data)
+ assignment = VariableAssignment(data.assign)
+ self._config_result(result, data, kw, assignment, context.variables)
+ with StatusReporter(data, result, context, run, implementation=kw):
+ self._validate(kw)
+ if kw.private:
+ context.warn_on_invalid_private_call(kw)
+ if not run:
+ return None
with assignment.assigner(context) as assigner:
- if run:
- return_value = self._run(context, kw.args, result)
- assigner.assign(return_value)
- return return_value
-
- def _get_result(self, kw, assignment, variables):
- handler = self._handler
- doc = variables.replace_string(handler.doc, ignore_errors=True)
- doc, tags = split_tags_from_doc(doc)
- tags = variables.replace_list(handler.tags, ignore_errors=True) + tags
- return KeywordResult(kwname=self.name,
- libname=handler.libname,
- doc=getshortdoc(doc),
- args=kw.args,
- assign=tuple(assignment),
- tags=tags,
- type=kw.type)
-
- def _run(self, context, args, result):
+ return_value = self._run(data, kw, result, context)
+ assigner.assign(return_value)
+ return return_value
+
+ def _config_result(
+ self,
+ result: KeywordResult,
+ data: KeywordData,
+ kw: "UserKeyword",
+ assignment,
+ variables,
+ ):
+ args = tuple(data.args)
+ if data.named_args:
+ args += tuple(f"{n}={v}" for n, v in data.named_args.items())
+ doc, doc_tags = split_tags_from_doc(kw.doc)
+ tags = Tags(kw.tags)
+ tags.add(doc_tags, remove_negated=True)
+ result.config(
+ name=self.name,
+ owner=kw.owner.name,
+ doc=getshortdoc(variables.replace_string(doc, ignore_errors=True)),
+ args=args,
+ assign=tuple(assignment),
+ tags=variables.replace_list(tags, ignore_errors=True),
+ type=data.type,
+ )
+
+ def _validate(self, kw: "UserKeyword"):
+ if kw.error:
+ raise DataError(kw.error)
+ if not kw.name:
+ raise DataError("User keyword name cannot be empty.")
+ if not kw.body:
+ raise DataError("User keyword cannot be empty.")
+
+ def _run(
+ self,
+ data: KeywordData,
+ kw: "UserKeyword",
+ result: KeywordResult,
+ context,
+ ):
+ if self.pre_run_messages:
+ for message in self.pre_run_messages:
+ context.output.message(message)
variables = context.variables
- args = self._resolve_arguments(args, variables)
- with context.user_keyword(self._handler):
- self._set_arguments(args, context)
- timeout = self._get_timeout(variables)
- if timeout is not None:
- result.timeout = str(timeout)
- with context.timeout(timeout):
- exception, return_ = self._execute(context)
+ positional, named = self._resolve_arguments(data, kw, variables)
+ with context.user_keyword(kw):
+ self._set_arguments(kw, positional, named, context)
+ if kw.timeout:
+ timeout = KeywordTimeout(kw.timeout, variables)
+ result.timeout = str(timeout) if timeout else None
+ else:
+ timeout = None
+ with context.keyword_timeout(timeout):
+ exception, return_value = self._execute(kw, result, context)
if exception and not exception.can_continue(context):
+ if context.in_teardown and exception.keyword_timeout:
+ # Allow execution to continue on teardowns after timeout.
+ # https://github.com/robotframework/robotframework/issues/3398
+ exception.keyword_timeout = False
raise exception
- return_value = self._get_return_value(variables, return_)
+ return_value = self._handle_return_value(return_value, variables)
if exception:
exception.return_value = return_value
raise exception
return return_value
- def _get_timeout(self, variables=None):
- timeout = self._handler.timeout
- return KeywordTimeout(timeout, variables) if timeout else None
+ def _resolve_arguments(self, data: KeywordData, kw: "UserKeyword", variables=None):
+ return kw.resolve_arguments(data.args, data.named_args, variables)
- def _resolve_arguments(self, arguments, variables=None):
- return self.arguments.resolve(arguments, variables)
-
- def _set_arguments(self, arguments, context):
- positional, named = arguments
+ def _set_arguments(self, kw: "UserKeyword", positional, named, context):
variables = context.variables
- args, kwargs = self.arguments.map(positional, named,
- replace_defaults=False)
- self._set_variables(args, kwargs, variables)
- context.output.trace(lambda: self._trace_log_args_message(variables))
-
- def _set_variables(self, positional, kwargs, variables):
- spec = self.arguments
- args, varargs = self._split_args_and_varargs(positional)
- kwonly, kwargs = self._split_kwonly_and_kwargs(kwargs)
- for name, value in chain(zip(spec.positional, args), kwonly):
+ positional, named = kw.args.map(positional, named, replace_defaults=False)
+ self._set_variables(kw.args, positional, named, variables)
+ context.output.trace(
+ lambda: self._trace_log_args_message(kw, variables), write_if_flat=False
+ )
+
+ def _set_variables(self, spec: ArgumentSpec, positional, named, variables):
+ positional, var_positional = self._separate_positional(spec, positional)
+ named_only, var_named = self._separate_named(spec, named)
+ for name, value in (*zip(spec.positional, positional), *named_only):
if isinstance(value, DefaultValue):
value = value.resolve(variables)
- variables['${%s}' % name] = value
+ info = spec.types.get(name)
+ if info:
+ value = info.convert(value, name, kind="Default value for argument")
+ variables[f"${{{name}}}"] = value
if spec.var_positional:
- variables['@{%s}' % spec.var_positional] = varargs
+ variables[f"@{{{spec.var_positional}}}"] = var_positional
if spec.var_named:
- variables['&{%s}' % spec.var_named] = DotDict(kwargs)
-
- def _split_args_and_varargs(self, args):
- if not self.arguments.var_positional:
- return args, []
- positional = len(self.arguments.positional)
- return args[:positional], args[positional:]
-
- def _split_kwonly_and_kwargs(self, all_kwargs):
- kwonly = []
- kwargs = []
- for name, value in all_kwargs:
- target = kwonly if name in self.arguments.named_only else kwargs
+ variables[f"&{{{spec.var_named}}}"] = DotDict(var_named)
+
+ def _separate_positional(self, spec: ArgumentSpec, positional):
+ if not spec.var_positional:
+ return positional, []
+ count = len(spec.positional)
+ return positional[:count], positional[count:]
+
+ def _separate_named(self, spec: ArgumentSpec, named):
+ named_only = []
+ var_named = []
+ for name, value in named:
+ target = named_only if name in spec.named_only else var_named
target.append((name, value))
- return kwonly, kwargs
-
- def _trace_log_args_message(self, variables):
- args = ['${%s}' % arg for arg in self.arguments.positional]
- if self.arguments.var_positional:
- args.append('@{%s}' % self.arguments.var_positional)
- if self.arguments.var_named:
- args.append('&{%s}' % self.arguments.var_named)
- return self._format_trace_log_args_message(args, variables)
+ return named_only, var_named
+
+ def _trace_log_args_message(self, kw: "UserKeyword", variables):
+ return self._format_trace_log_args_message(
+ self._format_args_for_trace_logging(kw.args), variables
+ )
+
+ def _format_args_for_trace_logging(self, spec: ArgumentSpec):
+ args = [f"${{{arg}}}" for arg in spec.positional]
+ if spec.var_positional:
+ args.append(f"@{{{spec.var_positional}}}")
+ if spec.named_only:
+ args.extend(f"${{{arg}}}" for arg in spec.named_only)
+ if spec.var_named:
+ args.append(f"&{{{spec.var_named}}}")
+ return args
def _format_trace_log_args_message(self, args, variables):
- args = ['%s=%s' % (name, prepr(variables[name])) for name in args]
- return 'Arguments: [ %s ]' % ' | '.join(args)
-
- def _execute(self, context):
- handler = self._handler
- if not (handler.body or handler.return_value):
- raise DataError("User keyword '%s' contains no keywords." % self.name)
- if context.dry_run and 'robot:no-dry-run' in handler.tags:
+ args = " | ".join(f"{name}={prepr(variables[name])}" for name in args)
+ return f"Arguments: [ {args} ]"
+
+ def _execute(self, kw: "UserKeyword", result: KeywordResult, context):
+ if context.dry_run and kw.tags.robot("no-dry-run"):
return None, None
- error = return_ = pass_ = None
+ error = success = return_value = None
+ if kw.setup:
+ error = self._run_setup_or_teardown(kw.setup, result.setup, context)
try:
- BodyRunner(context).run(handler.body)
+ BodyRunner(context, run=not error).run(kw, result)
except ReturnFromKeyword as exception:
- return_ = exception
+ return_value = exception.return_value
error = exception.earlier_failures
- except (BreakLoop, ContinueLoop) as exception:
- pass_ = exception
except ExecutionPassed as exception:
- pass_ = exception
+ success = exception
error = exception.earlier_failures
if error:
error.continue_on_failure = False
except ExecutionFailed as exception:
error = exception
- with context.keyword_teardown(error):
- td_error = self._run_teardown(context)
+ if kw.teardown:
+ with context.keyword_teardown(error):
+ td_error = self._run_setup_or_teardown(
+ kw.teardown, result.teardown, context
+ )
+ if context.timeouts and not (error or td_error):
+ td_error = self._handle_timeout_exceeded_during_teardown(context)
+ else:
+ td_error = None
if error or td_error:
error = UserKeywordExecutionFailed(error, td_error)
- return error or pass_, return_
+ return error or success, return_value
+
+ def _handle_timeout_exceeded_during_teardown(self, context):
+ timeout = min(context.timeouts)
+ if timeout.timed_out():
+ return ExecutionFailed(
+ timeout.get_message(),
+ test_timeout=timeout.kind == "TEST",
+ keyword_timeout=timeout.kind == "KEYWORD",
+ )
+ return None
- def _get_return_value(self, variables, return_):
- ret = self._handler.return_value if not return_ else return_.return_value
- if not ret:
+ def _handle_return_value(self, return_value, variables):
+ if not return_value:
return None
- contains_list_var = any(is_list_variable(item) for item in ret)
+ contains_list_var = any(is_list_variable(item) for item in return_value)
try:
- ret = variables.replace_list(ret)
+ return_value = variables.replace_list(return_value)
except DataError as err:
- raise VariableError('Replacing variables from keyword return '
- 'value failed: %s' % err.message)
- if len(ret) != 1 or contains_list_var:
- return ret
- return ret[0]
-
- def _run_teardown(self, context):
- if not self._handler.teardown:
- return None
+ raise VariableError(
+ f"Replacing variables from keyword return value failed: {err}"
+ )
+ if len(return_value) != 1 or contains_list_var:
+ return return_value
+ return return_value[0]
+
+ def _run_setup_or_teardown(self, data: KeywordData, result: KeywordResult, context):
try:
- name = context.variables.replace_string(self._handler.teardown.name)
- except DataError as err:
- if context.dry_run:
- return None
- return ExecutionFailed(err.message, syntax=True)
- if name.upper() in ('', 'NONE'):
- return None
- try:
- KeywordRunner(context).run(self._handler.teardown, name)
+ KeywordRunner(context).run(data, result, setup_or_teardown=True)
except PassExecution:
return None
except ExecutionStatus as err:
return err
return None
- def dry_run(self, kw, context):
- assignment = VariableAssignment(kw.assign)
- result = self._get_result(kw, assignment, context.variables)
- with StatusReporter(kw, result, context):
+ def dry_run(self, data: KeywordData, result: KeywordResult, context):
+ kw = self.keyword.bind(data)
+ assignment = VariableAssignment(data.assign)
+ self._config_result(result, data, kw, assignment, context.variables)
+ with StatusReporter(data, result, context, implementation=kw):
+ self._validate(kw)
assignment.validate_assignment()
- self._dry_run(context, kw.args, result)
-
- def _dry_run(self, context, args, result):
- self._resolve_arguments(args)
- with context.user_keyword(self._handler):
- timeout = self._get_timeout()
- if timeout:
+ self._dry_run(data, kw, result, context)
+
+ def _dry_run(
+ self,
+ data: KeywordData,
+ kw: "UserKeyword",
+ result: KeywordResult,
+ context,
+ ):
+ if self.pre_run_messages:
+ for message in self.pre_run_messages:
+ context.output.message(message)
+ self._resolve_arguments(data, kw)
+ with context.user_keyword(kw):
+ if kw.timeout:
+ timeout = KeywordTimeout(kw.timeout, context.variables)
result.timeout = str(timeout)
- error, _ = self._execute(context)
+ error, _ = self._execute(kw, result, context)
if error:
raise error
class EmbeddedArgumentsRunner(UserKeywordRunner):
- def __init__(self, handler, name):
- UserKeywordRunner.__init__(self, handler, name)
- match = handler.embedded_name.match(name)
- if not match:
- raise ValueError('Does not match given name')
- self.embedded_args = list(zip(handler.embedded_args, match.groups()))
-
- def _resolve_arguments(self, args, variables=None):
- # Validates that no arguments given.
- self.arguments.resolve(args, variables)
- if not variables:
- return []
- return [(n, variables.replace_scalar(v)) for n, v in self.embedded_args]
-
- def _set_arguments(self, embedded_args, context):
+ def __init__(self, keyword: "UserKeyword", name: str):
+ super().__init__(keyword, name)
+ self.embedded_args = keyword.embedded.parse_args(name)
+
+ def _resolve_arguments(self, data: KeywordData, kw: "UserKeyword", variables=None):
+ result = super()._resolve_arguments(data, kw, variables)
+ if variables:
+ embedded = [variables.replace_scalar(e) for e in self.embedded_args]
+ self.embedded_args = kw.embedded.map(embedded)
+ return result
+
+ def _set_arguments(self, kw: "UserKeyword", positional, named, context):
variables = context.variables
- for name, value in embedded_args:
- variables['${%s}' % name] = value
- context.output.trace(lambda: self._trace_log_args_message(variables))
+ for name, value in self.embedded_args:
+ variables[f"${{{name}}}"] = value
+ super()._set_arguments(kw, positional, named, context)
- def _trace_log_args_message(self, variables):
- args = ['${%s}' % arg for arg, _ in self.embedded_args]
+ def _trace_log_args_message(self, kw: "UserKeyword", variables):
+ args = [f"${{{arg}}}" for arg in kw.embedded.args]
+ args += self._format_args_for_trace_logging(kw.args)
return self._format_trace_log_args_message(args, variables)
- def _get_result(self, kw, assignment, variables):
- result = UserKeywordRunner._get_result(self, kw, assignment, variables)
- result.sourcename = self._handler.name
- return result
+ def _config_result(
+ self,
+ result: KeywordResult,
+ data: KeywordData,
+ kw: "UserKeyword",
+ assignment,
+ variables,
+ ):
+ super()._config_result(result, data, kw, assignment, variables)
+ result.source_name = kw.name
diff --git a/src/robot/testdoc.py b/src/robot/testdoc.py
index 0f62d7b4a25..81e61ccbc10 100755
--- a/src/robot/testdoc.py
+++ b/src/robot/testdoc.py
@@ -29,22 +29,23 @@
that can be used programmatically. Other code is for internal usage.
"""
-import os.path
import sys
import time
+from pathlib import Path
-# Allows running as a script. __name__ check needed with multiprocessing:
-# https://github.com/robotframework/robotframework/issues/1137
-if 'robot' not in sys.modules and __name__ == '__main__':
- import pythonpathsetter
+if __name__ == "__main__" and "robot" not in sys.modules:
+ from pythonpathsetter import set_pythonpath
+
+ set_pythonpath()
from robot.conf import RobotSettings
-from robot.htmldata import HtmlFileWriter, ModelWriter, JsonWriter, TESTDOC
+from robot.htmldata import HtmlFileWriter, JsonWriter, ModelWriter, TESTDOC
+from robot.output import LOGGER
from robot.running import TestSuiteBuilder
-from robot.utils import (abspath, Application, file_writer, get_link_path,
- html_escape, html_format, is_string, secs_to_timestr,
- seq2str2, timestr_to_secs, unescape)
-
+from robot.utils import (
+ abspath, Application, file_writer, get_link_path, html_escape, html_format,
+ is_list_like, secs_to_timestr, seq2str2, timestr_to_secs, unescape
+)
USAGE = """robot.testdoc -- Robot Framework test data documentation tool
@@ -57,6 +58,10 @@
metadata of each test suite and test case, as well as the top-level keywords
and their arguments.
+WARNING: Testdoc is deprecated and will be removed in Robot Framework 8.0.
+ Use the external Testdoc tool instead:
+ https://marvkler.github.io/robotframework-testdoc
+
Options
=======
@@ -120,17 +125,22 @@ def main(self, datasources, title=None, **options):
outfile = abspath(datasources.pop())
suite = TestSuiteFactory(datasources, **options)
self._write_test_doc(suite, outfile, title)
+ LOGGER.warn(
+ "The built-in Testdoc tool has been deprecated in favor of the new and "
+ "enhanced external Testdoc tool. Learn more about the new tool at "
+ "https://marvkler.github.io/robotframework-testdoc/."
+ )
self.console(outfile)
def _write_test_doc(self, suite, outfile, title):
- with file_writer(outfile, usage='Testdoc output') as output:
+ with file_writer(outfile, usage="Testdoc output") as output:
model_writer = TestdocModelWriter(output, suite, title)
HtmlFileWriter(output, model_writer).write(TESTDOC)
def TestSuiteFactory(datasources, **options):
settings = RobotSettings(options)
- if is_string(datasources):
+ if not is_list_like(datasources):
datasources = [datasources]
suite = TestSuiteBuilder(process_curdir=False).build(*datasources)
suite.configure(**settings.suite_config)
@@ -141,22 +151,22 @@ class TestdocModelWriter(ModelWriter):
def __init__(self, output, suite, title=None):
self._output = output
- self._output_path = getattr(output, 'name', None)
+ self._output_path = getattr(output, "name", None)
self._suite = suite
- self._title = title.replace('_', ' ') if title else suite.name
+ self._title = title.replace("_", " ") if title else suite.name
def write(self, line):
self._output.write('\n')
+ self._output.write("\n")
def write_data(self):
model = {
- 'suite': JsonConverter(self._output_path).convert(self._suite),
- 'title': self._title,
- 'generated': int(time.time() * 1000)
+ "suite": JsonConverter(self._output_path).convert(self._suite),
+ "title": self._title,
+ "generated": int(time.time() * 1000),
}
- JsonWriter(self._output).write_json('testdoc = ', model)
+ JsonWriter(self._output).write_json("testdoc = ", model)
class JsonConverter:
@@ -169,24 +179,26 @@ def convert(self, suite):
def _convert_suite(self, suite):
return {
- 'source': suite.source or '',
- 'relativeSource': self._get_relative_source(suite.source),
- 'id': suite.id,
- 'name': self._escape(suite.name),
- 'fullName': self._escape(suite.longname),
- 'doc': self._html(suite.doc),
- 'metadata': [(self._escape(name), self._html(value))
- for name, value in suite.metadata.items()],
- 'numberOfTests': suite.test_count ,
- 'suites': self._convert_suites(suite),
- 'tests': self._convert_tests(suite),
- 'keywords': list(self._convert_keywords((suite.setup, suite.teardown)))
+ "source": str(suite.source or ""),
+ "relativeSource": self._get_relative_source(suite.source),
+ "id": suite.id,
+ "name": self._escape(suite.name),
+ "fullName": self._escape(suite.full_name),
+ "doc": self._html(suite.doc),
+ "metadata": [
+ (self._escape(name), self._html(value))
+ for name, value in suite.metadata.items()
+ ],
+ "numberOfTests": suite.test_count,
+ "suites": self._convert_suites(suite),
+ "tests": self._convert_tests(suite),
+ "keywords": list(self._convert_keywords((suite.setup, suite.teardown))),
}
def _get_relative_source(self, source):
if not source or not self._output_path:
- return ''
- return get_link_path(source, os.path.dirname(self._output_path))
+ return ""
+ return get_link_path(source, Path(self._output_path).parent)
def _escape(self, item):
return html_escape(item)
@@ -206,23 +218,21 @@ def _convert_test(self, test):
if test.teardown:
test.body.append(test.teardown)
return {
- 'name': self._escape(test.name),
- 'fullName': self._escape(test.longname),
- 'id': test.id,
- 'doc': self._html(test.doc),
- 'tags': [self._escape(t) for t in test.tags],
- 'timeout': self._get_timeout(test.timeout),
- 'keywords': list(self._convert_keywords(test.body))
+ "name": self._escape(test.name),
+ "fullName": self._escape(test.full_name),
+ "id": test.id,
+ "doc": self._html(test.doc),
+ "tags": [self._escape(t) for t in test.tags],
+ "timeout": self._get_timeout(test.timeout),
+ "keywords": list(self._convert_keywords(test.body)),
}
def _convert_keywords(self, keywords):
for kw in keywords:
if not kw:
continue
- if kw.type == kw.SETUP:
- yield self._convert_keyword(kw, 'SETUP')
- elif kw.type == kw.TEARDOWN:
- yield self._convert_keyword(kw, 'TEARDOWN')
+ if kw.type in kw.KEYWORD_TYPES:
+ yield self._convert_keyword(kw)
elif kw.type == kw.FOR:
yield self._convert_for(kw)
elif kw.type == kw.WHILE:
@@ -231,48 +241,57 @@ def _convert_keywords(self, keywords):
yield from self._convert_if(kw)
elif kw.type == kw.TRY_EXCEPT_ROOT:
yield from self._convert_try(kw)
- else:
- yield self._convert_keyword(kw, 'KEYWORD')
+ elif kw.type == kw.VAR:
+ yield self._convert_var(kw)
def _convert_for(self, data):
- name = '%s %s %s' % (', '.join(data.variables), data.flavor,
- seq2str2(data.values))
- return {'type': 'FOR', 'name': self._escape(name), 'arguments': ''}
+ name = f"{', '.join(data.assign)} {data.flavor} {seq2str2(data.values)}"
+ return {"type": "FOR", "name": self._escape(name), "arguments": ""}
def _convert_while(self, data):
- return {'type': 'WHILE', 'name': self._escape(data.condition), 'arguments': ''}
+ return {"type": "WHILE", "name": self._escape(data.condition), "arguments": ""}
def _convert_if(self, data):
for branch in data.body:
- yield {'type': branch.type,
- 'name': self._escape(branch.condition or ''),
- 'arguments': ''}
+ yield {
+ "type": branch.type,
+ "name": self._escape(branch.condition or ""),
+ "arguments": "",
+ }
def _convert_try(self, data):
for branch in data.body:
if branch.type == branch.EXCEPT:
- patterns = ', '.join(branch.patterns)
- as_var = f'AS {branch.variable}' if branch.variable else ''
- name = f'{patterns} {as_var}'.strip()
+ patterns = ", ".join(branch.patterns)
+ as_var = f"AS {branch.assign}" if branch.assign else ""
+ name = f"{patterns} {as_var}".strip()
else:
- name = ''
- yield {'type': branch.type, 'name': name, 'arguments': ''}
+ name = ""
+ yield {"type": branch.type, "name": name, "arguments": ""}
+
+ def _convert_var(self, data):
+ if data.name[0] == "$" and len(data.value) == 1:
+ value = data.value[0]
+ else:
+ value = "[" + ", ".join(data.value) + "]"
+ return {"type": "VAR", "name": f"{data.name} = {value}"}
- def _convert_keyword(self, kw, kw_type):
+ def _convert_keyword(self, kw):
return {
- 'type': kw_type,
- 'name': self._escape(self._get_kw_name(kw)),
- 'arguments': self._escape(', '.join(kw.args))
+ "type": kw.type,
+ "name": self._escape(self._get_kw_name(kw)),
+ "arguments": self._escape(", ".join(kw.args)),
}
def _get_kw_name(self, kw):
if kw.assign:
- return '%s = %s' % (', '.join(a.rstrip('= ') for a in kw.assign), kw.name)
+ assign = ", ".join(a.rstrip("= ") for a in kw.assign)
+ return f"{assign} = {kw.name}"
return kw.name
def _get_timeout(self, timeout):
if timeout is None:
- return ''
+ return ""
try:
tout = secs_to_timestr(timestr_to_secs(timeout))
except ValueError:
@@ -313,5 +332,5 @@ def testdoc(*arguments, **options):
TestDoc().execute(*arguments, **options)
-if __name__ == '__main__':
+if __name__ == "__main__":
testdoc_cli(sys.argv[1:])
diff --git a/src/robot/utils/__init__.py b/src/robot/utils/__init__.py
index 442ffa4f31a..2780d0f68aa 100644
--- a/src/robot/utils/__init__.py
+++ b/src/robot/utils/__init__.py
@@ -33,76 +33,221 @@
assert Matcher('H?llo').match('Hillo')
"""
-from .argumentparser import ArgumentParser, cmdline2list
-from .application import Application
-from .compress import compress_text
-from .connectioncache import ConnectionCache
-from .dotdict import DotDict
-from .encoding import (CONSOLE_ENCODING, SYSTEM_ENCODING, console_decode,
- console_encode, system_decode, system_encode)
-from .error import (get_error_message, get_error_details, ErrorDetails)
-from .escaping import escape, glob_escape, unescape, split_from_equals
-from .etreewrapper import ET, ETSource
-from .filereader import FileReader
-from .frange import frange
-from .markuputils import html_format, html_escape, xml_escape, attribute_escape
-from .markupwriters import HtmlWriter, XmlWriter, NullMarkupWriter
-from .importer import Importer
-from .match import eq, Matcher, MultiMatcher
-from .misc import isatty, plural_or_not, printable_name,seq2str, seq2str2, test_or_task
-from .normalizing import normalize, normalize_whitespace, NormalizedDict
-from .platform import PY_VERSION, PYPY, UNIXY, WINDOWS, RERAISED_EXCEPTIONS
-from .recommendations import RecommendationFinder
-from .robotenv import get_env_var, set_env_var, del_env_var, get_env_vars
-from .robotinspect import is_init
-from .robotio import binary_file_writer, create_destination_directory, file_writer
-from .robotpath import abspath, find_file, get_link_path, normpath
-from .robottime import (elapsed_time_to_string, format_time, get_elapsed_time,
- get_time, get_timestamp, secs_to_timestamp,
- secs_to_timestr, timestamp_to_secs, timestr_to_secs,
- parse_time)
-from .robottypes import (FALSE_STRINGS, TRUE_STRINGS, is_bytes, is_dict_like, is_falsy,
- is_integer, is_list_like, is_number, is_pathlike, is_string,
- is_truthy, is_union, type_name, type_repr, typeddict_types)
-from .setter import setter, SetterAwareType
-from .sortable import Sortable
-from .text import (cut_assign_value, cut_long_message, format_assign_message,
- get_console_length, getdoc, getshortdoc, pad_console_length,
- split_tags_from_doc, split_args_from_name_or_path)
-from .unic import prepr, safe_str
+import warnings
+
+from .application import Application as Application
+from .argumentparser import (
+ ArgumentParser as ArgumentParser,
+ cmdline2list as cmdline2list,
+)
+from .compress import compress_text as compress_text
+from .connectioncache import ConnectionCache as ConnectionCache
+from .dotdict import DotDict as DotDict
+from .encoding import (
+ console_decode as console_decode,
+ console_encode as console_encode,
+ CONSOLE_ENCODING as CONSOLE_ENCODING,
+ system_decode as system_decode,
+ system_encode as system_encode,
+ SYSTEM_ENCODING as SYSTEM_ENCODING,
+)
+from .error import (
+ ErrorDetails as ErrorDetails,
+ get_error_details as get_error_details,
+ get_error_message as get_error_message,
+)
+from .escaping import (
+ escape as escape,
+ glob_escape as glob_escape,
+ split_from_equals as split_from_equals,
+ unescape as unescape,
+)
+from .etreewrapper import ETSource as ETSource
+from .filereader import FileReader as FileReader, Source as Source
+from .frange import frange as frange
+from .importer import Importer as Importer
+from .json import JsonDumper as JsonDumper, JsonLoader as JsonLoader
+from .markuputils import (
+ attribute_escape as attribute_escape,
+ html_escape as html_escape,
+ html_format as html_format,
+ xml_escape as xml_escape,
+)
+from .markupwriters import (
+ HtmlWriter as HtmlWriter,
+ NullMarkupWriter as NullMarkupWriter,
+ XmlWriter as XmlWriter,
+)
+from .match import eq as eq, Matcher as Matcher, MultiMatcher as MultiMatcher
+from .misc import (
+ classproperty as classproperty,
+ isatty as isatty,
+ parse_re_flags as parse_re_flags,
+ plural_or_not as plural_or_not,
+ printable_name as printable_name,
+ seq2str as seq2str,
+ seq2str2 as seq2str2,
+ test_or_task as test_or_task,
+)
+from .normalizing import (
+ normalize as normalize,
+ normalize_whitespace as normalize_whitespace,
+ NormalizedDict as NormalizedDict,
+)
+from .notset import NOT_SET as NOT_SET, NotSet as NotSet
+from .platform import (
+ PY_VERSION as PY_VERSION,
+ PYPY as PYPY,
+ UNIXY as UNIXY,
+ WINDOWS as WINDOWS,
+)
+from .recommendations import RecommendationFinder as RecommendationFinder
+from .robotenv import (
+ del_env_var as del_env_var,
+ get_env_var as get_env_var,
+ get_env_vars as get_env_vars,
+ set_env_var as set_env_var,
+)
+from .robotinspect import is_init as is_init
+from .robotio import (
+ binary_file_writer as binary_file_writer,
+ create_destination_directory as create_destination_directory,
+ file_writer as file_writer,
+)
+from .robotpath import (
+ abspath as abspath,
+ find_file as find_file,
+ get_link_path as get_link_path,
+ normpath as normpath,
+)
+from .robottime import (
+ elapsed_time_to_string as elapsed_time_to_string,
+ format_time as format_time,
+ get_elapsed_time as get_elapsed_time,
+ get_time as get_time,
+ get_timestamp as get_timestamp,
+ parse_time as parse_time,
+ parse_timestamp as parse_timestamp,
+ secs_to_timestamp as secs_to_timestamp,
+ secs_to_timestr as secs_to_timestr,
+ timestamp_to_secs as timestamp_to_secs,
+ timestr_to_secs as timestr_to_secs,
+)
+from .robottypes import (
+ has_args as has_args,
+ is_dict_like as is_dict_like,
+ is_falsy as is_falsy,
+ is_list_like as is_list_like,
+ is_truthy as is_truthy,
+ is_union as is_union,
+ type_name as type_name,
+ type_repr as type_repr,
+ typeddict_types as typeddict_types,
+)
+from .secret import Secret as Secret
+from .setter import setter as setter, SetterAwareType as SetterAwareType
+from .sortable import Sortable as Sortable
+from .text import (
+ cut_assign_value as cut_assign_value,
+ cut_long_message as cut_long_message,
+ expand_variables as expand_variables,
+ format_assign_message as format_assign_message,
+ get_console_length as get_console_length,
+ getdoc as getdoc,
+ getshortdoc as getshortdoc,
+ pad_console_length as pad_console_length,
+ split_args_from_name_or_path as split_args_from_name_or_path,
+ split_tags_from_doc as split_tags_from_doc,
+)
+from .typehints import (
+ copy_signature as copy_signature,
+ KnownAtRuntime as KnownAtRuntime,
+)
+from .unic import prepr as prepr, safe_str as safe_str
def read_rest_data(rstfile):
from .restreader import read_rest_data
- return read_rest_data(rstfile)
-
-
-# Deprecated Python 2/3 compatibility layer. Not needed by Robot Framework itself
-# anymore because Python 2 support was dropped in RF 5. Preserved at least until
-# RF 5.2 to avoid breaking external libraries and tools that use it. There's also
-# `PY2` in the `platform` submodule.
-# https://github.com/robotframework/robotframework/issues/4150
-
-from io import StringIO
-
-PY3 = True
-PY2 = JYTHON = IRONPYTHON = False
-is_unicode = is_string
-unicode = str
-unic = safe_str
-roundup = round
-
-
-def py2to3(cls):
- """Deprecated since RF 5.0. Use Python 3 features directly instead."""
- if hasattr(cls, '__unicode__'):
- cls.__str__ = lambda self: self.__unicode__()
- if hasattr(cls, '__nonzero__'):
- cls.__bool__ = lambda self: self.__nonzero__()
- return cls
+ return read_rest_data(rstfile)
-def py3to2(cls):
- """Deprecated since RF 5.0. Never done anything when used on Python 3."""
- return cls
+def unic(item):
+ # Cannot be deprecated using '__getattr__' because a module with same name exists.
+ warnings.warn(
+ "'robot.utils.unic' is deprecated and will be removed in Robot Framework 9.0.",
+ DeprecationWarning,
+ )
+ return safe_str(item)
+
+
+def __getattr__(name):
+ # Deprecated utils mostly related to the old Python 2/3 compatibility layer.
+ # See also 'unic' above and 'PY2' in 'platform.py'.
+ # https://github.com/robotframework/robotframework/issues/4501
+
+ from io import StringIO
+ from os import PathLike
+ from xml.etree import ElementTree as ET
+
+ from .robottypes import FALSE_STRINGS, TRUE_STRINGS
+
+ def py2to3(cls):
+ if hasattr(cls, "__unicode__"):
+ cls.__str__ = lambda self: self.__unicode__()
+ if hasattr(cls, "__nonzero__"):
+ cls.__bool__ = lambda self: self.__nonzero__()
+ return cls
+
+ def py3to2(cls):
+ return cls
+
+ def is_integer(item):
+ return isinstance(item, int)
+
+ def is_number(item):
+ return isinstance(item, (int, float))
+
+ def is_bytes(item):
+ return isinstance(item, (bytes, bytearray))
+
+ def is_string(item):
+ return isinstance(item, str)
+
+ def is_pathlike(item):
+ return isinstance(item, PathLike)
+
+ deprecated = {
+ "RERAISED_EXCEPTIONS": (KeyboardInterrupt, SystemExit, MemoryError),
+ "FALSE_STRINGS": FALSE_STRINGS,
+ "TRUE_STRINGS": TRUE_STRINGS,
+ "ET": ET,
+ "StringIO": StringIO,
+ "PY3": True,
+ "PY2": False,
+ "JYTHON": False,
+ "IRONPYTHON": False,
+ "is_number": is_number,
+ "is_integer": is_integer,
+ "is_pathlike": is_pathlike,
+ "is_bytes": is_bytes,
+ "is_string": is_string,
+ "is_unicode": is_string,
+ "unicode": str,
+ "roundup": round,
+ "py2to3": py2to3,
+ "py3to2": py3to2,
+ }
+
+ if name in deprecated:
+ # TODO: Change DeprecationWarning to more visible UserWarning in RF 8.0.
+ # https://github.com/robotframework/robotframework/issues/4501
+ # Remember also 'unic' above '__getattr__' and 'PY2' in 'platform.py'.
+ warnings.warn(
+ f"'robot.utils.{name}' is deprecated and will be removed in "
+ f"Robot Framework 9.0.",
+ DeprecationWarning,
+ )
+ return deprecated[name]
+
+ raise AttributeError(f"'robot.utils' has no attribute '{name}'.")
diff --git a/src/robot/utils/application.py b/src/robot/utils/application.py
index 88752d31fa5..5f54a149499 100644
--- a/src/robot/utils/application.py
+++ b/src/robot/utils/application.py
@@ -15,8 +15,9 @@
import sys
-from robot.errors import (INFO_PRINTED, DATA_ERROR, STOPPED_BY_USER,
- FRAMEWORK_ERROR, Information, DataError)
+from robot.errors import (
+ DATA_ERROR, DataError, FRAMEWORK_ERROR, Information, STOPPED_BY_USER
+)
from .argumentparser import ArgumentParser
from .encoding import console_encode
@@ -25,10 +26,25 @@
class Application:
- def __init__(self, usage, name=None, version=None, arg_limits=None,
- env_options=None, logger=None, **auto_options):
- self._ap = ArgumentParser(usage, name, version, arg_limits,
- self.validate, env_options, **auto_options)
+ def __init__(
+ self,
+ usage,
+ name=None,
+ version=None,
+ arg_limits=None,
+ env_options=None,
+ logger=None,
+ **auto_options,
+ ):
+ self._ap = ArgumentParser(
+ usage,
+ name,
+ version,
+ arg_limits,
+ self.validate,
+ env_options,
+ **auto_options,
+ )
self._logger = logger or DefaultLogger()
def main(self, arguments, **options):
@@ -39,7 +55,7 @@ def validate(self, options, arguments):
def execute_cli(self, cli_arguments, exit=True):
with self._logger:
- self._logger.info('%s %s' % (self._ap.name, self._ap.version))
+ self._logger.info(f"{self._ap.name} {self._ap.version}")
options, arguments = self._parse_arguments(cli_arguments)
rc = self._execute(arguments, options)
if exit:
@@ -53,12 +69,12 @@ def console(self, msg):
def _parse_arguments(self, cli_args):
try:
options, arguments = self.parse_arguments(cli_args)
- except Information as msg:
- self._report_info(msg.message)
+ except Information as info:
+ self._report_info(info)
except DataError as err:
self._report_error(err.message, help=True, exit=True)
else:
- self._logger.info('Arguments: %s' % ','.join(arguments))
+ self._logger.info(f"Arguments: {','.join(arguments)}")
return options, arguments
def parse_arguments(self, cli_args):
@@ -73,7 +89,7 @@ def parse_arguments(self, cli_args):
def execute(self, *arguments, **options):
with self._logger:
- self._logger.info('%s %s' % (self._ap.name, self._ap.version))
+ self._logger.info(f"{self._ap.name} {self._ap.version}")
return self._execute(list(arguments), options)
def _execute(self, arguments, options):
@@ -82,25 +98,31 @@ def _execute(self, arguments, options):
except DataError as err:
return self._report_error(err.message, help=True)
except (KeyboardInterrupt, SystemExit):
- return self._report_error('Execution stopped by user.',
- rc=STOPPED_BY_USER)
- except:
+ return self._report_error("Execution stopped by user.", rc=STOPPED_BY_USER)
+ except Exception:
error, details = get_error_details(exclude_robot_traces=False)
- return self._report_error('Unexpected error: %s' % error,
- details, rc=FRAMEWORK_ERROR)
+ return self._report_error(
+ f"Unexpected error: {error}", details, rc=FRAMEWORK_ERROR
+ )
else:
return rc or 0
- def _report_info(self, message):
- self.console(message)
- self._exit(INFO_PRINTED)
-
- def _report_error(self, message, details=None, help=False, rc=DATA_ERROR,
- exit=False):
+ def _report_info(self, info):
+ self.console(info.message)
+ self._exit(info.rc)
+
+ def _report_error(
+ self,
+ message,
+ details=None,
+ help=False,
+ rc=DATA_ERROR,
+ exit=False,
+ ):
if help:
- message += '\n\nTry --help for usage information.'
+ message += "\n\nTry --help for usage information."
if details:
- message += '\n' + details
+ message += "\n" + details
self._logger.error(message)
if exit:
self._exit(rc)
diff --git a/src/robot/utils/argumentparser.py b/src/robot/utils/argumentparser.py
index fa26a896e62..1e6905a562b 100644
--- a/src/robot/utils/argumentparser.py
+++ b/src/robot/utils/argumentparser.py
@@ -19,68 +19,85 @@
import re
import shlex
import sys
-import string
import warnings
+from pathlib import Path
+from string import ascii_letters
-from robot.errors import DataError, Information, FrameworkError
+from robot.errors import DataError, FrameworkError, Information
from robot.version import get_full_version
from .encoding import console_decode, system_decode
from .filereader import FileReader
-from .misc import plural_or_not
-from .robottypes import is_falsy, is_integer, is_string
+from .misc import plural_or_not as s
+from .robottypes import is_truthy
+from .text import expand_variables
def cmdline2list(args, escaping=False):
+ if isinstance(args, Path):
+ return [str(args)]
lexer = shlex.shlex(args, posix=True)
- if is_falsy(escaping):
- lexer.escape = ''
- lexer.escapedquotes = '"\''
- lexer.commenters = ''
+ if not escaping:
+ lexer.escape = ""
+ lexer.escapedquotes = "\"'"
+ lexer.commenters = ""
lexer.whitespace_split = True
try:
return list(lexer)
except ValueError as err:
- raise ValueError("Parsing '%s' failed: %s" % (args, err))
+ raise ValueError(f"Parsing '{args}' failed: {err}")
class ArgumentParser:
- _opt_line_re = re.compile(r'''
- ^\s{1,4} # 1-4 spaces in the beginning of the line
- ((-\S\s)*) # all possible short options incl. spaces (group 1)
- --(\S{2,}) # required long option (group 3)
- (\s\S+)? # optional value (group 4)
- (\s\*)? # optional '*' telling option allowed multiple times (group 5)
- ''', re.VERBOSE)
-
- def __init__(self, usage, name=None, version=None, arg_limits=None,
- validator=None, env_options=None, auto_help=True,
- auto_version=True, auto_pythonpath='DEPRECATED',
- auto_argumentfile=True):
+ _opt_line_re = re.compile(
+ r"""
+ ^\s{1,4} # 1-4 spaces in the beginning of the line
+ ((-\S\s)*) # all possible short options incl. spaces (group 1)
+ --(\S{2,}) # required long option (group 3)
+ (\s\S+)? # optional value (group 4)
+ (\s\*)? # optional '*' telling option allowed multiple times (group 5)
+ """,
+ re.VERBOSE,
+ )
+
+ def __init__(
+ self,
+ usage,
+ name=None,
+ version=None,
+ arg_limits=None,
+ validator=None,
+ env_options=None,
+ auto_help=True,
+ auto_version=True,
+ auto_pythonpath="DEPRECATED",
+ auto_argumentfile=True,
+ ):
"""Available options and tool name are read from the usage.
Tool name is got from the first row of the usage. It is either the
whole row or anything before first ' -- '.
"""
if not usage:
- raise FrameworkError('Usage cannot be empty')
- self.name = name or usage.splitlines()[0].split(' -- ')[0].strip()
+ raise FrameworkError("Usage cannot be empty")
+ self.name = name or usage.splitlines()[0].split(" -- ")[0].strip()
self.version = version or get_full_version()
self._usage = usage
self._arg_limit_validator = ArgLimitValidator(arg_limits)
self._validator = validator
self._auto_help = auto_help
self._auto_version = auto_version
- # TODO: Change DeprecationWarning to more loud UserWarning in RF 5.1.
- if auto_pythonpath == 'DEPRECATED':
+ if auto_pythonpath == "DEPRECATED":
auto_pythonpath = False
else:
- warnings.warn("ArgumentParser option 'auto_pythonpath' is deprecated "
- "since Robot Framework 5.0.", DeprecationWarning)
+ warnings.warn(
+ "ArgumentParser option 'auto_pythonpath' is deprecated "
+ "since Robot Framework 5.0.",
+ )
self._auto_pythonpath = auto_pythonpath
self._auto_argumentfile = auto_argumentfile
self._env_options = env_options
- self._short_opts = ''
+ self._short_opts = ""
self._long_opts = []
self._multi_opts = []
self._flag_opts = []
@@ -134,9 +151,11 @@ def parse_args(self, args):
if self._auto_argumentfile:
args = self._process_possible_argfile(args)
opts, args = self._parse_args(args)
- if self._auto_argumentfile and opts.get('argumentfile'):
- raise DataError("Using '--argumentfile' option in shortened format "
- "like '--argumentf' is not supported.")
+ if self._auto_argumentfile and opts.get("argumentfile"):
+ raise DataError(
+ "Using '--argumentfile' option in shortened format "
+ "like '--argumentf' is not supported."
+ )
opts, args = self._handle_special_options(opts, args)
self._arg_limit_validator(args)
if self._validator:
@@ -151,41 +170,37 @@ def _get_env_options(self):
return []
def _handle_special_options(self, opts, args):
- if self._auto_help and opts.get('help'):
- self._raise_help()
- if self._auto_version and opts.get('version'):
- self._raise_version()
- if self._auto_pythonpath and opts.get('pythonpath'):
- sys.path = self._get_pythonpath(opts['pythonpath']) + sys.path
- for auto, opt in [(self._auto_help, 'help'),
- (self._auto_version, 'version'),
- (self._auto_pythonpath, 'pythonpath'),
- (self._auto_argumentfile, 'argumentfile')]:
- if auto and opt in opts:
- opts.pop(opt)
+ if self._auto_help and opts.pop("help", False):
+ self._raise_help(opts.get("statusrc"))
+ if self._auto_version and opts.pop("version", False):
+ self._raise_version(opts.get("statusrc"))
+ if self._auto_pythonpath:
+ sys.path = self._get_pythonpath(opts.pop("pythonpath", [])) + sys.path
+ if self._auto_argumentfile:
+ opts.pop("argumentfile", None)
return opts, args
def _parse_args(self, args):
- args = [self._lowercase_long_option(a) for a in args]
+ args = [self._normalize_long_option(a) for a in args]
try:
opts, args = getopt.getopt(args, self._short_opts, self._long_opts)
except getopt.GetoptError as err:
raise DataError(err.msg)
return self._process_opts(opts), self._glob_args(args)
- def _lowercase_long_option(self, opt):
- if not opt.startswith('--'):
+ def _normalize_long_option(self, opt):
+ if not opt.startswith("--"):
return opt
- if '=' not in opt:
- return opt.lower()
- opt, value = opt.split('=', 1)
- return '%s=%s' % (opt.lower(), value)
+ if "=" not in opt:
+ return f"--{opt.lower().replace('-', '')}"
+ opt, value = opt.split("=", 1)
+ return f"--{opt.lower().replace('-', '')}={value}"
def _process_possible_argfile(self, args):
- options = ['--argumentfile']
+ options = ["--argumentfile"]
for short_opt, long_opt in self._short_to_long.items():
- if long_opt == 'argumentfile':
- options.append('-'+short_opt)
+ if long_opt == "argumentfile":
+ options.append("-" + short_opt)
return ArgFileParser(options).process(args)
def _process_opts(self, opt_tuple):
@@ -196,7 +211,7 @@ def _process_opts(self, opt_tuple):
opts[name].append(value)
elif name in self._flag_opts:
opts[name] = True
- elif name.startswith('no') and name[2:] in self._flag_opts:
+ elif name.startswith("no") and name[2:] in self._flag_opts:
opts[name[2:]] = False
else:
opts[name] = value
@@ -205,8 +220,8 @@ def _process_opts(self, opt_tuple):
def _get_default_opts(self):
defaults = {}
for opt in self._long_opts:
- opt = opt.rstrip('=')
- if opt.startswith('no') and opt[2:] in self._flag_opts:
+ opt = opt.rstrip("=")
+ if opt.startswith("no") and opt[2:] in self._flag_opts:
continue
defaults[opt] = [] if opt in self._multi_opts else None
return defaults
@@ -222,7 +237,7 @@ def _glob_args(self, args):
return temp
def _get_name(self, name):
- name = name.lstrip('-')
+ name = name.lstrip("-")
try:
return self._short_to_long[name]
except KeyError:
@@ -232,41 +247,43 @@ def _create_options(self, usage):
for line in usage.splitlines():
res = self._opt_line_re.match(line)
if res:
- self._create_option(short_opts=[o[1] for o in res.group(1).split()],
- long_opt=res.group(3).lower(),
- takes_arg=bool(res.group(4)),
- is_multi=bool(res.group(5)))
+ self._create_option(
+ short_opts=[o[1] for o in res.group(1).split()],
+ long_opt=res.group(3).lower().replace("-", ""),
+ takes_arg=bool(res.group(4)),
+ is_multi=bool(res.group(5)),
+ )
def _create_option(self, short_opts, long_opt, takes_arg, is_multi):
self._verify_long_not_already_used(long_opt, not takes_arg)
for sopt in short_opts:
if sopt in self._short_to_long:
- self._raise_option_multiple_times_in_usage('-' + sopt)
+ self._raise_option_multiple_times_in_usage("-" + sopt)
self._short_to_long[sopt] = long_opt
if is_multi:
self._multi_opts.append(long_opt)
if takes_arg:
- long_opt += '='
- short_opts = [sopt+':' for sopt in short_opts]
+ long_opt += "="
+ short_opts = [sopt + ":" for sopt in short_opts]
else:
- if long_opt.startswith('no'):
+ if long_opt.startswith("no"):
long_opt = long_opt[2:]
- self._long_opts.append('no' + long_opt)
+ self._long_opts.append("no" + long_opt)
self._flag_opts.append(long_opt)
self._long_opts.append(long_opt)
- self._short_opts += (''.join(short_opts))
+ self._short_opts += "".join(short_opts)
def _verify_long_not_already_used(self, opt, flag=False):
if flag:
- if opt.startswith('no'):
+ if opt.startswith("no"):
opt = opt[2:]
self._verify_long_not_already_used(opt)
- self._verify_long_not_already_used('no' + opt)
- elif opt in [o.rstrip('=') for o in self._long_opts]:
- self._raise_option_multiple_times_in_usage('--' + opt)
+ self._verify_long_not_already_used("no" + opt)
+ elif opt in [o.rstrip("=") for o in self._long_opts]:
+ self._raise_option_multiple_times_in_usage("--" + opt)
def _get_pythonpath(self, paths):
- if is_string(paths):
+ if isinstance(paths, str):
paths = [paths]
temp = []
for path in self._split_pythonpath(paths):
@@ -275,22 +292,22 @@ def _get_pythonpath(self, paths):
def _split_pythonpath(self, paths):
# paths may already contain ':' as separator
- tokens = ':'.join(paths).split(':')
- if os.sep == '/':
+ tokens = ":".join(paths).split(":")
+ if os.sep == "/":
return tokens
# Fix paths split like 'c:\temp' -> 'c', '\temp'
ret = []
- drive = ''
+ drive = ""
for item in tokens:
- item = item.replace('/', '\\')
- if drive and item.startswith('\\'):
- ret.append('%s:%s' % (drive, item))
- drive = ''
+ item = item.replace("/", "\\")
+ if drive and item.startswith("\\"):
+ ret.append(f"{drive}:{item}")
+ drive = ""
continue
if drive:
ret.append(drive)
- drive = ''
- if len(item) == 1 and item in string.ascii_letters:
+ drive = ""
+ if len(item) == 1 and item in ascii_letters:
drive = item
else:
ret.append(item)
@@ -298,17 +315,21 @@ def _split_pythonpath(self, paths):
ret.append(drive)
return ret
- def _raise_help(self):
+ def _raise_help(self, status_rc=True):
usage = self._usage
if self.version:
- usage = usage.replace('', self.version)
- raise Information(usage)
+ usage = usage.replace("", self.version)
+ if status_rc is None:
+ status_rc = True
+ raise Information(usage, status_rc)
- def _raise_version(self):
- raise Information('%s %s' % (self.name, self.version))
+ def _raise_version(self, status_rc=True):
+ if status_rc is None:
+ status_rc = True
+ raise Information(f"{self.name} {self.version}", status_rc)
def _raise_option_multiple_times_in_usage(self, opt):
- raise FrameworkError("Option '%s' multiple times in usage" % opt)
+ raise FrameworkError(f"Option '{opt}' multiple times in usage")
class ArgLimitValidator:
@@ -319,7 +340,7 @@ def __init__(self, arg_limits):
def _parse_arg_limits(self, arg_limits):
if arg_limits is None:
return 0, sys.maxsize
- if is_integer(arg_limits):
+ if isinstance(arg_limits, int):
return arg_limits, arg_limits
if len(arg_limits) == 1:
return arg_limits[0], sys.maxsize
@@ -330,20 +351,19 @@ def __call__(self, args):
self._raise_invalid_args(self._min_args, self._max_args, len(args))
def _raise_invalid_args(self, min_args, max_args, arg_count):
- min_end = plural_or_not(min_args)
if min_args == max_args:
- expectation = "%d argument%s" % (min_args, min_end)
+ expectation = f"Expected {min_args} argument{s(min_args)}"
elif max_args != sys.maxsize:
- expectation = "%d to %d arguments" % (min_args, max_args)
+ expectation = f"Expected {min_args} to {max_args} arguments"
else:
- expectation = "at least %d argument%s" % (min_args, min_end)
- raise DataError("Expected %s, got %d." % (expectation, arg_count))
+ expectation = f"Expected at least {min_args} argument{s(min_args)}"
+ raise DataError(f"{expectation}, got {arg_count}.")
class ArgFileParser:
- def __init__(self, options):
- self._options = options
+ def __init__(self, config):
+ self.config = config
def process(self, args):
while True:
@@ -354,60 +374,71 @@ def process(self, args):
return args
def _get_index(self, args):
- for opt in self._options:
- start = opt + '=' if opt.startswith('--') else opt
+ for conf in self.config:
+ long = conf.startswith("--")
for index, arg in enumerate(args):
- normalized_arg = arg.lower() if opt.startswith('--') else arg
+ normalized = "--" + arg.lower().replace("-", "") if long else arg
# Handles `--argumentfile foo` and `-A foo`
- if normalized_arg == opt and index + 1 < len(args):
- return args[index+1], slice(index, index+2)
- # Handles `--argumentfile=foo` and `-Afoo`
- if normalized_arg.startswith(start):
- return arg[len(start):], slice(index, index+1)
+ if normalized == conf and index + 1 < len(args):
+ return args[index + 1], slice(index, index + 2)
+ # Handles `--argumentfile=foo`
+ elif long and normalized.startswith(conf + "="):
+ return arg[len(conf) + 1 :], slice(index, index + 1)
+ # Handles `-Afoo`
+ elif not long and normalized.startswith(conf):
+ return arg[len(conf) :], slice(index, index + 1)
return None, -1
def _get_args(self, path):
- if path.upper() != 'STDIN':
- content = self._read_from_file(path)
- else:
+ if path.upper() == "STDIN":
content = self._read_from_stdin()
- return self._process_file(content)
+ else:
+ content = self._read_from_file(path)
+ try:
+ return self._process_file(content)
+ except ValueError as err:
+ raise DataError(f"Processing argument file '{path}' failed: {err}")
+
+ def _read_from_stdin(self):
+ return console_decode(sys.__stdin__.read())
def _read_from_file(self, path):
try:
with FileReader(path) as reader:
return reader.read()
except (IOError, UnicodeError) as err:
- raise DataError("Opening argument file '%s' failed: %s"
- % (path, err))
-
- def _read_from_stdin(self):
- return console_decode(sys.__stdin__.read())
+ raise DataError(f"Opening argument file '{path}' failed: {err}")
def _process_file(self, content):
args = []
+ if self._parse_expandvars_pragma(content):
+ content = expand_variables(content)
for line in content.splitlines():
line = line.strip()
- if line.startswith('-'):
+ if line.startswith("-"):
args.extend(self._split_option(line))
- elif line and not line.startswith('#'):
+ elif line and not line.startswith("#"):
args.append(line)
return args
- def _split_option(self, line):
- separator = self._get_option_separator(line)
+ def _parse_expandvars_pragma(self, content):
+ match = re.match(r"#\s*expandvars:\s*(.*)\s*\n", content, flags=re.IGNORECASE)
+ return is_truthy(match.group(1)) if match else False
+
+ def _split_option(self, option):
+ separator = self._get_option_separator(option)
if not separator:
- return [line]
- option, value = line.split(separator, 1)
- if separator == ' ':
+ return [option]
+ name, value = option.split(separator, 1)
+ if separator == " ":
value = value.strip()
- return [option, value]
+ return [name, value]
- def _get_option_separator(self, line):
- if ' ' not in line and '=' not in line:
+ def _get_option_separator(self, option):
+ if " " not in option and "=" not in option:
return None
- if '=' not in line:
- return ' '
- if ' ' not in line:
- return '='
- return ' ' if line.index(' ') < line.index('=') else '='
+ if "=" not in option:
+ return " "
+ if " " not in option:
+ return "="
+ return " " if option.index(" ") < option.index("=") else "="
diff --git a/src/robot/utils/asserts.py b/src/robot/utils/asserts.py
index 4ee028eeddb..939e5416626 100644
--- a/src/robot/utils/asserts.py
+++ b/src/robot/utils/asserts.py
@@ -117,23 +117,23 @@ def assert_true(expr, msg=None):
def assert_not_none(obj, msg=None, values=True):
"""Fail the test if given object is None."""
- _msg = 'is None'
+ _msg = "is None"
if obj is None:
if msg is None:
msg = _msg
elif values is True:
- msg = '%s: %s' % (msg, _msg)
+ msg = f"{msg}: {_msg}"
_report_failure(msg)
def assert_none(obj, msg=None, values=True):
"""Fail the test if given object is not None."""
- _msg = '%r is not None' % obj
+ _msg = f"{obj!r} is not None"
if obj is not None:
if msg is None:
msg = _msg
elif values is True:
- msg = '%s: %s' % (msg, _msg)
+ msg = f"{msg}: {_msg}"
_report_failure(msg)
@@ -153,38 +153,37 @@ def assert_raises(exc_class, callable_obj, *args, **kwargs):
except exc_class as err:
return err
else:
- if hasattr(exc_class,'__name__'):
+ if hasattr(exc_class, "__name__"):
exc_name = exc_class.__name__
else:
exc_name = str(exc_class)
- _report_failure('%s not raised' % exc_name)
+ _report_failure(f"{exc_name} not raised")
-def assert_raises_with_msg(exc_class, expected_msg, callable_obj, *args,
- **kwargs):
+def assert_raises_with_msg(exc_class, expected_msg, callable_obj, *args, **kwargs):
"""Similar to fail_unless_raises but also checks the exception message."""
try:
callable_obj(*args, **kwargs)
except exc_class as err:
- assert_equal(expected_msg, str(err), 'Correct exception but wrong message')
+ assert_equal(expected_msg, str(err), "Correct exception but wrong message")
else:
- if hasattr(exc_class,'__name__'):
+ if hasattr(exc_class, "__name__"):
exc_name = exc_class.__name__
else:
exc_name = str(exc_class)
- _report_failure('%s not raised' % exc_name)
+ _report_failure(f"{exc_name} not raised")
def assert_equal(first, second, msg=None, values=True, formatter=safe_str):
"""Fail if given objects are unequal as determined by the '==' operator."""
- if not first == second:
- _report_inequality(first, second, '!=', msg, values, formatter)
+ if not first == second: # noqa: SIM201
+ _report_inequality(first, second, "!=", msg, values, formatter)
def assert_not_equal(first, second, msg=None, values=True, formatter=safe_str):
"""Fail if given objects are equal as determined by the '==' operator."""
if first == second:
- _report_inequality(first, second, '==', msg, values, formatter)
+ _report_inequality(first, second, "==", msg, values, formatter)
def assert_almost_equal(first, second, places=7, msg=None, values=True):
@@ -196,8 +195,8 @@ def assert_almost_equal(first, second, places=7, msg=None, values=True):
significant digits (measured from the most significant digit).
"""
if round(second - first, places) != 0:
- extra = 'within %r places' % places
- _report_inequality(first, second, '!=', msg, values, extra=extra)
+ extra = f"within {places} places"
+ _report_inequality(first, second, "!=", msg, values, extra=extra)
def assert_not_almost_equal(first, second, places=7, msg=None, values=True):
@@ -208,32 +207,39 @@ def assert_not_almost_equal(first, second, places=7, msg=None, values=True):
Note that decimal places (from zero) are usually not the same as
significant digits (measured from the most significant digit).
"""
- if round(second-first, places) == 0:
- extra = 'within %r places' % places
- _report_inequality(first, second, '==', msg, values, extra=extra)
+ if round(second - first, places) == 0:
+ extra = f"within {places!r} places"
+ _report_inequality(first, second, "==", msg, values, extra=extra)
def _report_failure(msg):
if msg is None:
- raise AssertionError()
+ raise AssertionError
raise AssertionError(msg)
-def _report_inequality(obj1, obj2, delim, msg=None, values=False, formatter=safe_str,
- extra=None):
+def _report_inequality(
+ obj1,
+ obj2,
+ delim,
+ msg=None,
+ values=False,
+ formatter=safe_str,
+ extra=None,
+):
+ _msg = _format_message(obj1, obj2, delim, formatter)
if not msg:
- msg = _format_message(obj1, obj2, delim, formatter)
+ msg = _msg
elif values:
- msg = '%s: %s' % (msg, _format_message(obj1, obj2, delim, formatter))
+ msg = f"{msg}: {_msg}"
if values and extra:
- msg += ' ' + extra
+ msg += " " + extra
raise AssertionError(msg)
def _format_message(obj1, obj2, delim, formatter=safe_str):
str1 = formatter(obj1)
str2 = formatter(obj2)
- if delim == '!=' and str1 == str2:
- return '%s (%s) != %s (%s)' % (str1, type_name(obj1),
- str2, type_name(obj2))
- return '%s %s %s' % (str1, delim, str2)
+ if delim == "!=" and str1 == str2:
+ return f"{str1} ({type_name(obj1)}) != {str2} ({type_name(obj2)})"
+ return f"{str1} {delim} {str2}"
diff --git a/src/robot/utils/charwidth.py b/src/robot/utils/charwidth.py
index cbd344ef428..76d486a2c72 100644
--- a/src/robot/utils/charwidth.py
+++ b/src/robot/utils/charwidth.py
@@ -18,123 +18,89 @@
Some East Asian characters have width of two on console, and combining
characters themselves take no extra space.
-See issue 604 [1] for more details about East Asian characters. The issue also
-contains `generate_wild_chars.py` script that was originally used to create
-`_EAST_ASIAN_WILD_CHARS` mapping. An updated version of the script is attached
-to issue 1096. Big thanks for xieyanbo for the script and the original patch.
-
-Python's `unicodedata` module was not used here because importing it took
-several seconds on Jython. That could possibly be changed now.
-
-[1] https://github.com/robotframework/robotframework/issues/604
-[2] https://github.com/robotframework/robotframework/issues/1096
+For more details about East Asian characters and the associated problems see:
+https://github.com/robotframework/robotframework/issues/604
"""
def get_char_width(char):
char = ord(char)
- if _char_in_map(char, _COMBINING_CHARS):
+ if _char_in_map(char, COMBINING_CHARS):
return 0
- if _char_in_map(char, _EAST_ASIAN_WILD_CHARS):
+ if _char_in_map(char, EAST_ASIAN_WILD_CHARS):
return 2
return 1
+
def _char_in_map(char, map):
for begin, end in map:
if char < begin:
- break
- if begin <= char <= end:
+ return False
+ if char <= end:
return True
return False
-_COMBINING_CHARS = [(768, 879)]
-
-_EAST_ASIAN_WILD_CHARS = [
- (888, 889), (895, 899), (907, 907), (909, 909), (930, 930),
- (1316, 1328), (1367, 1368), (1376, 1376), (1416, 1416),
- (1419, 1424), (1480, 1487), (1515, 1519), (1525, 1535),
- (1540, 1541), (1564, 1565), (1568, 1568), (1631, 1631),
- (1806, 1806), (1867, 1868), (1970, 1983), (2043, 2304),
- (2362, 2363), (2382, 2383), (2389, 2391), (2419, 2426),
- (2432, 2432), (2436, 2436), (2445, 2446), (2449, 2450),
- (2473, 2473), (2481, 2481), (2483, 2485), (2490, 2491),
- (2501, 2502), (2505, 2506), (2511, 2518), (2520, 2523),
- (2526, 2526), (2532, 2533), (2555, 2560), (2564, 2564),
- (2571, 2574), (2577, 2578), (2601, 2601), (2609, 2609),
- (2612, 2612), (2615, 2615), (2618, 2619), (2621, 2621),
- (2627, 2630), (2633, 2634), (2638, 2640), (2642, 2648),
- (2653, 2653), (2655, 2661), (2678, 2688), (2692, 2692),
- (2702, 2702), (2706, 2706), (2729, 2729), (2737, 2737),
- (2740, 2740), (2746, 2747), (2758, 2758), (2762, 2762),
- (2766, 2767), (2769, 2783), (2788, 2789), (2800, 2800),
- (2802, 2816), (2820, 2820), (2829, 2830), (2833, 2834),
- (2857, 2857), (2865, 2865), (2868, 2868), (2874, 2875),
- (2885, 2886), (2889, 2890), (2894, 2901), (2904, 2907),
- (2910, 2910), (2916, 2917), (2930, 2945), (2948, 2948),
- (2955, 2957), (2961, 2961), (2966, 2968), (2971, 2971),
- (2973, 2973), (2976, 2978), (2981, 2983), (2987, 2989),
- (3002, 3005), (3011, 3013), (3017, 3017), (3022, 3023),
- (3025, 3030), (3032, 3045), (3067, 3072), (3076, 3076),
- (3085, 3085), (3089, 3089), (3113, 3113), (3124, 3124),
- (3130, 3132), (3141, 3141), (3145, 3145), (3150, 3156),
- (3159, 3159), (3162, 3167), (3172, 3173), (3184, 3191),
- (3200, 3201), (3204, 3204), (3213, 3213), (3217, 3217),
- (3241, 3241), (3252, 3252), (3258, 3259), (3269, 3269),
- (3273, 3273), (3278, 3284), (3287, 3293), (3295, 3295),
- (3300, 3301), (3312, 3312), (3315, 3329), (3332, 3332),
- (3341, 3341), (3345, 3345), (3369, 3369), (3386, 3388),
- (3397, 3397), (3401, 3401), (3406, 3414), (3416, 3423),
- (3428, 3429), (3446, 3448), (3456, 3457), (3460, 3460),
- (3479, 3481), (3506, 3506), (3516, 3516), (3518, 3519),
- (3527, 3529), (3531, 3534), (3541, 3541), (3543, 3543),
- (3552, 3569), (3573, 3584), (3643, 3646), (3676, 3712),
- (3715, 3715), (3717, 3718), (3721, 3721), (3723, 3724),
- (3726, 3731), (3736, 3736), (3744, 3744), (3748, 3748),
- (3750, 3750), (3752, 3753), (3756, 3756), (3770, 3770),
- (3774, 3775), (3781, 3781), (3783, 3783), (3790, 3791),
- (3802, 3803), (3806, 3839), (3912, 3912), (3949, 3952),
- (3980, 3983), (3992, 3992), (4029, 4029), (4045, 4045),
- (4053, 4095), (4250, 4253), (4294, 4303), (4349, 4447),
- (4515, 4519), (4602, 4607), (4681, 4681), (4686, 4687),
- (4695, 4695), (4697, 4697), (4702, 4703), (4745, 4745),
- (4750, 4751), (4785, 4785), (4790, 4791), (4799, 4799),
- (4801, 4801), (4806, 4807), (4823, 4823), (4881, 4881),
- (4886, 4887), (4955, 4958), (4989, 4991), (5018, 5023),
- (5109, 5120), (5751, 5759), (5789, 5791), (5873, 5887),
- (5901, 5901), (5909, 5919), (5943, 5951), (5972, 5983),
- (5997, 5997), (6001, 6001), (6004, 6015), (6110, 6111),
- (6122, 6127), (6138, 6143), (6159, 6159), (6170, 6175),
- (6264, 6271), (6315, 6399), (6429, 6431), (6444, 6447),
- (6460, 6463), (6465, 6467), (6510, 6511), (6517, 6527),
- (6570, 6575), (6602, 6607), (6618, 6621), (6684, 6685),
- (6688, 6911), (6988, 6991), (7037, 7039), (7083, 7085),
- (7098, 7167), (7224, 7226), (7242, 7244), (7296, 7423),
- (7655, 7677), (7958, 7959), (7966, 7967), (8006, 8007),
- (8014, 8015), (8024, 8024), (8026, 8026), (8028, 8028),
- (8030, 8030), (8062, 8063), (8117, 8117), (8133, 8133),
- (8148, 8149), (8156, 8156), (8176, 8177), (8181, 8181),
- (8191, 8191), (8293, 8297), (8306, 8307), (8335, 8335),
- (8341, 8351), (8374, 8399), (8433, 8447), (8528, 8530),
- (8585, 8591), (9001, 9002), (9192, 9215), (9255, 9279),
- (9291, 9311), (9886, 9887), (9917, 9919), (9924, 9984),
- (9989, 9989), (9994, 9995), (10024, 10024), (10060, 10060),
- (10062, 10062), (10067, 10069), (10071, 10071), (10079, 10080),
- (10133, 10135), (10160, 10160), (10175, 10175), (10187, 10187),
- (10189, 10191), (11085, 11087), (11093, 11263), (11311, 11311),
- (11359, 11359), (11376, 11376), (11390, 11391), (11499, 11512),
- (11558, 11567), (11622, 11630), (11632, 11647), (11671, 11679),
- (11687, 11687), (11695, 11695), (11703, 11703), (11711, 11711),
- (11719, 11719), (11727, 11727), (11735, 11735), (11743, 11743),
- (11825, 12350), (12352, 19903), (19968, 42239), (42540, 42559),
- (42592, 42593), (42612, 42619), (42648, 42751), (42893, 43002),
- (43052, 43071), (43128, 43135), (43205, 43213), (43226, 43263),
- (43348, 43358), (43360, 43519), (43575, 43583), (43598, 43599),
- (43610, 43611), (43616, 55295), (63744, 64255), (64263, 64274),
- (64280, 64284), (64311, 64311), (64317, 64317), (64319, 64319),
- (64322, 64322), (64325, 64325), (64434, 64466), (64832, 64847),
- (64912, 64913), (64968, 65007), (65022, 65023), (65040, 65055),
- (65063, 65135), (65141, 65141), (65277, 65278), (65280, 65376),
- (65471, 65473), (65480, 65481), (65488, 65489), (65496, 65497),
- (65501, 65511), (65519, 65528), (65534, 65535),
- ]
+COMBINING_CHARS = [(768, 879)]
+EAST_ASIAN_WILD_CHARS = [
+ (888, 889), (895, 899), (907, 907), (909, 909), (930, 930), (1316, 1328),
+ (1367, 1368), (1376, 1376), (1416, 1416), (1419, 1424), (1480, 1487), (1515, 1519),
+ (1525, 1535), (1540, 1541), (1564, 1565), (1568, 1568), (1631, 1631), (1806, 1806),
+ (1867, 1868), (1970, 1983), (2043, 2304), (2362, 2363), (2382, 2383), (2389, 2391),
+ (2419, 2426), (2432, 2432), (2436, 2436), (2445, 2446), (2449, 2450), (2473, 2473),
+ (2481, 2481), (2483, 2485), (2490, 2491), (2501, 2502), (2505, 2506), (2511, 2518),
+ (2520, 2523), (2526, 2526), (2532, 2533), (2555, 2560), (2564, 2564), (2571, 2574),
+ (2577, 2578), (2601, 2601), (2609, 2609), (2612, 2612), (2615, 2615), (2618, 2619),
+ (2621, 2621), (2627, 2630), (2633, 2634), (2638, 2640), (2642, 2648), (2653, 2653),
+ (2655, 2661), (2678, 2688), (2692, 2692), (2702, 2702), (2706, 2706), (2729, 2729),
+ (2737, 2737), (2740, 2740), (2746, 2747), (2758, 2758), (2762, 2762), (2766, 2767),
+ (2769, 2783), (2788, 2789), (2800, 2800), (2802, 2816), (2820, 2820), (2829, 2830),
+ (2833, 2834), (2857, 2857), (2865, 2865), (2868, 2868), (2874, 2875), (2885, 2886),
+ (2889, 2890), (2894, 2901), (2904, 2907), (2910, 2910), (2916, 2917), (2930, 2945),
+ (2948, 2948), (2955, 2957), (2961, 2961), (2966, 2968), (2971, 2971), (2973, 2973),
+ (2976, 2978), (2981, 2983), (2987, 2989), (3002, 3005), (3011, 3013), (3017, 3017),
+ (3022, 3023), (3025, 3030), (3032, 3045), (3067, 3072), (3076, 3076), (3085, 3085),
+ (3089, 3089), (3113, 3113), (3124, 3124), (3130, 3132), (3141, 3141), (3145, 3145),
+ (3150, 3156), (3159, 3159), (3162, 3167), (3172, 3173), (3184, 3191), (3200, 3201),
+ (3204, 3204), (3213, 3213), (3217, 3217), (3241, 3241), (3252, 3252), (3258, 3259),
+ (3269, 3269), (3273, 3273), (3278, 3284), (3287, 3293), (3295, 3295), (3300, 3301),
+ (3312, 3312), (3315, 3329), (3332, 3332), (3341, 3341), (3345, 3345), (3369, 3369),
+ (3386, 3388), (3397, 3397), (3401, 3401), (3406, 3414), (3416, 3423), (3428, 3429),
+ (3446, 3448), (3456, 3457), (3460, 3460), (3479, 3481), (3506, 3506), (3516, 3516),
+ (3518, 3519), (3527, 3529), (3531, 3534), (3541, 3541), (3543, 3543), (3552, 3569),
+ (3573, 3584), (3643, 3646), (3676, 3712), (3715, 3715), (3717, 3718), (3721, 3721),
+ (3723, 3724), (3726, 3731), (3736, 3736), (3744, 3744), (3748, 3748), (3750, 3750),
+ (3752, 3753), (3756, 3756), (3770, 3770), (3774, 3775), (3781, 3781), (3783, 3783),
+ (3790, 3791), (3802, 3803), (3806, 3839), (3912, 3912), (3949, 3952), (3980, 3983),
+ (3992, 3992), (4029, 4029), (4045, 4045), (4053, 4095), (4250, 4253), (4294, 4303),
+ (4349, 4447), (4515, 4519), (4602, 4607), (4681, 4681), (4686, 4687), (4695, 4695),
+ (4697, 4697), (4702, 4703), (4745, 4745), (4750, 4751), (4785, 4785), (4790, 4791),
+ (4799, 4799), (4801, 4801), (4806, 4807), (4823, 4823), (4881, 4881), (4886, 4887),
+ (4955, 4958), (4989, 4991), (5018, 5023), (5109, 5120), (5751, 5759), (5789, 5791),
+ (5873, 5887), (5901, 5901), (5909, 5919), (5943, 5951), (5972, 5983), (5997, 5997),
+ (6001, 6001), (6004, 6015), (6110, 6111), (6122, 6127), (6138, 6143), (6159, 6159),
+ (6170, 6175), (6264, 6271), (6315, 6399), (6429, 6431), (6444, 6447), (6460, 6463),
+ (6465, 6467), (6510, 6511), (6517, 6527), (6570, 6575), (6602, 6607), (6618, 6621),
+ (6684, 6685), (6688, 6911), (6988, 6991), (7037, 7039), (7083, 7085), (7098, 7167),
+ (7224, 7226), (7242, 7244), (7296, 7423), (7655, 7677), (7958, 7959), (7966, 7967),
+ (8006, 8007), (8014, 8015), (8024, 8024), (8026, 8026), (8028, 8028), (8030, 8030),
+ (8062, 8063), (8117, 8117), (8133, 8133), (8148, 8149), (8156, 8156), (8176, 8177),
+ (8181, 8181), (8191, 8191), (8293, 8297), (8306, 8307), (8335, 8335), (8341, 8351),
+ (8374, 8399), (8433, 8447), (8528, 8530), (8585, 8591), (9001, 9002), (9192, 9215),
+ (9255, 9279), (9291, 9311), (9886, 9887), (9917, 9919), (9924, 9984), (9989, 9989),
+ (9994, 9995), (10024, 10024), (10060, 10060), (10062, 10062), (10067, 10069),
+ (10071, 10071), (10079, 10080), (10133, 10135), (10160, 10160), (10175, 10175),
+ (10187, 10187), (10189, 10191), (11085, 11087), (11093, 11263), (11311, 11311),
+ (11359, 11359), (11376, 11376), (11390, 11391), (11499, 11512), (11558, 11567),
+ (11622, 11630), (11632, 11647), (11671, 11679), (11687, 11687), (11695, 11695),
+ (11703, 11703), (11711, 11711), (11719, 11719), (11727, 11727), (11735, 11735),
+ (11743, 11743), (11825, 12350), (12352, 19903), (19968, 42239), (42540, 42559),
+ (42592, 42593), (42612, 42619), (42648, 42751), (42893, 43002), (43052, 43071),
+ (43128, 43135), (43205, 43213), (43226, 43263), (43348, 43358), (43360, 43519),
+ (43575, 43583), (43598, 43599), (43610, 43611), (43616, 55295), (63744, 64255),
+ (64263, 64274), (64280, 64284), (64311, 64311), (64317, 64317), (64319, 64319),
+ (64322, 64322), (64325, 64325), (64434, 64466), (64832, 64847), (64912, 64913),
+ (64968, 65007), (65022, 65023), (65040, 65055), (65063, 65135), (65141, 65141),
+ (65277, 65278), (65280, 65376), (65471, 65473), (65480, 65481), (65488, 65489),
+ (65496, 65497), (65501, 65511), (65519, 65528), (65534, 65535)
+] # fmt: skip
diff --git a/src/robot/utils/compress.py b/src/robot/utils/compress.py
index 6c531bf21e2..5544f5c0ccd 100644
--- a/src/robot/utils/compress.py
+++ b/src/robot/utils/compress.py
@@ -18,5 +18,5 @@
def compress_text(text):
- compressed = zlib.compress(text.encode('UTF-8'), 9)
- return base64.b64encode(compressed).decode('ASCII')
+ compressed = zlib.compress(text.encode("UTF-8"), 9)
+ return base64.b64encode(compressed).decode("ASCII")
diff --git a/src/robot/utils/connectioncache.py b/src/robot/utils/connectioncache.py
index cc3057093a2..5056856b8c8 100644
--- a/src/robot/utils/connectioncache.py
+++ b/src/robot/utils/connectioncache.py
@@ -13,42 +13,48 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from typing import Generic, Iterator, Literal, NoReturn, TypeVar
+
from .normalizing import NormalizedDict
-from .robottypes import is_string
+
+C = TypeVar("C")
-class ConnectionCache:
+class ConnectionCache(Generic[C]):
"""Cache for libraries to use with concurrent connections, processes, etc.
The cache stores the registered connections (or other objects) and allows
- switching between them using generated indices or user given aliases.
- This is useful with any library where there's need for multiple concurrent
- connections, processes, etc.
+ switching between them using generated indices, user given aliases or
+ connection objects themselves. This is useful with any library having a need
+ for multiple concurrent connections, processes, etc.
This class is used also outside the core framework by SeleniumLibrary,
SSHLibrary, etc. Backwards compatibility is thus important when doing changes.
"""
- def __init__(self, no_current_msg='No open connection.'):
+ def __init__(self, no_current_msg: str = "No open connection."):
self._no_current = NoConnection(no_current_msg)
- self.current = self._no_current #: Current active connection.
- self._connections = []
- self._aliases = NormalizedDict()
+ self.current: C | NoConnection = self._no_current
+ self._connections: list[C] = []
+ self._aliases = NormalizedDict[int]()
@property
- def current_index(self):
+ def current_index(self) -> "int | None":
if not self:
return None
for index, conn in enumerate(self):
if conn is self.current:
return index + 1
+ return None
@current_index.setter
- def current_index(self, index):
- self.current = self._connections[index - 1] \
- if index is not None else self._no_current
+ def current_index(self, index: "int | None"):
+ if index is None:
+ self.current = self._no_current
+ else:
+ self.current = self._connections[index - 1]
- def register(self, connection, alias=None):
+ def register(self, connection: C, alias: "str | None" = None) -> int:
"""Registers given connection with optional alias and returns its index.
Given connection is set to be the :attr:`current` connection.
@@ -62,52 +68,77 @@ def register(self, connection, alias=None):
self.current = connection
self._connections.append(connection)
index = len(self._connections)
- if is_string(alias):
+ if alias:
self._aliases[alias] = index
return index
- def switch(self, alias_or_index):
- """Switches to the connection specified by the given alias or index.
+ def switch(self, identifier: "int | str | C") -> C:
+ """Switches to the connection specified using the ``identifier``.
- Updates :attr:`current` and also returns its new value.
+ Identifier can be an index, an alias, or a registered connection.
+ Raises an error if no matching connection is found.
- Alias is whatever was given to :meth:`register` method and indices
- are returned by it. Index can be given either as an integer or
- as a string that can be converted to an integer. Raises an error
- if no connection with the given index or alias found.
+ Updates :attr:`current` and also returns its new value.
"""
- self.current = self.get_connection(alias_or_index)
+ self.current = self.get_connection(identifier)
return self.current
- def get_connection(self, alias_or_index=None):
- """Get the connection specified by the given alias or index..
-
- If ``alias_or_index`` is ``None``, returns the current connection
- if it is active, or raises an error if it is not.
+ def get_connection(
+ self,
+ identifier: "int | str | C | None" = None,
+ ) -> C:
+ """Returns the connection specified using the ``identifier``.
- Alias is whatever was given to :meth:`register` method and indices
- are returned by it. Index can be given either as an integer or
- as a string that can be converted to an integer. Raises an error
- if no connection with the given index or alias found.
+ Identifier can be an index (integer or string), an alias, a registered
+ connection or ``None``. If the identifier is ``None``, returns the
+ current connection if it is active and raises an error if it is not.
+ Raises an error also if no matching connection is found.
"""
- if alias_or_index is None:
+ if identifier is None:
if not self:
self.current.raise_error()
return self.current
try:
- index = self.resolve_alias_or_index(alias_or_index)
+ index = self.get_connection_index(identifier)
except ValueError as err:
raise RuntimeError(err.args[0])
- return self._connections[index-1]
+ return self._connections[index - 1]
- __getitem__ = get_connection
+ def get_connection_index(self, identifier: "int | str | C") -> int:
+ """Returns the index of the connection specified using the ``identifier``.
- def close_all(self, closer_method='close'):
- """Closes connections using given closer method and empties cache.
+ Identifier can be an index (integer or string), an alias, or a registered
+ connection.
+
+ New in Robot Framework 7.0. :meth:`resolve_alias_or_index` can be used
+ with earlier versions.
+ """
+ if isinstance(identifier, str) and identifier in self._aliases:
+ return self._aliases[identifier]
+ if identifier in self._connections:
+ return self._connections.index(identifier) + 1
+ try:
+ index = int(identifier)
+ except (ValueError, TypeError):
+ index = -1
+ if 0 < index <= len(self._connections):
+ return index
+ raise ValueError(f"Non-existing index or alias '{identifier}'.")
+
+ def resolve_alias_or_index(self, alias_or_index: "str | int") -> int:
+ """Deprecated in RF 7.0. Use :meth:`get_connection_index` instead."""
+ # This was initially added for SeleniumLibrary in RF 3.1.2.
+ # https://github.com/robotframework/robotframework/issues/3125
+ # The new method was added in RF 7.0. We can loudly deprecate this
+ # earliest in RF 8.0.
+ return self.get_connection_index(alias_or_index)
+
+ def close_all(self, closer_method: str = "close"):
+ """Closes connections using the specified closer method and empties cache.
If simply calling the closer method is not adequate for closing
connections, clients should close connections themselves and use
- :meth:`empty_cache` afterwards.
+ :meth:`empty_cache` afterward.
"""
for conn in self._connections:
getattr(conn, closer_method)()
@@ -123,53 +154,30 @@ def empty_cache(self):
self._connections = []
self._aliases = NormalizedDict()
- def __iter__(self):
+ __getitem__ = get_connection
+
+ def __iter__(self) -> Iterator[C]:
return iter(self._connections)
- def __len__(self):
+ def __len__(self) -> int:
return len(self._connections)
- def __bool__(self):
+ def __bool__(self) -> bool:
return self.current is not self._no_current
- def resolve_alias_or_index(self, alias_or_index):
- for resolver in self._resolve_alias, self._resolve_index, self._is_connection:
- try:
- return resolver(alias_or_index)
- except ValueError:
- pass
- raise ValueError(f"Non-existing index or alias '{alias_or_index}'.")
-
- def _resolve_alias(self, alias):
- if is_string(alias) and alias in self._aliases:
- return self._aliases[alias]
- raise ValueError
-
- def _resolve_index(self, index):
- try:
- index = int(index)
- except TypeError:
- raise ValueError
- if not 0 < index <= len(self._connections):
- raise ValueError
- return index
-
- def _is_connection(self, conn):
- return self._connections.index(conn) + 1
-
class NoConnection:
- def __init__(self, message):
+ def __init__(self, message: str):
self.message = message
- def __getattr__(self, name):
- if name.startswith('__') and name.endswith('__'):
+ def __getattr__(self, name: str) -> NoReturn:
+ if name.startswith("__") and name.endswith("__"):
raise AttributeError
self.raise_error()
- def raise_error(self):
+ def raise_error(self) -> NoReturn:
raise RuntimeError(self.message)
- def __bool__(self):
+ def __bool__(self) -> Literal[False]:
return False
diff --git a/src/robot/utils/dotdict.py b/src/robot/utils/dotdict.py
index 079de6d255c..cf3b64ca5ce 100644
--- a/src/robot/utils/dotdict.py
+++ b/src/robot/utils/dotdict.py
@@ -23,12 +23,13 @@ class DotDict(OrderedDict):
def __init__(self, *args, **kwds):
args = [self._convert_nested_initial_dicts(a) for a in args]
kwds = self._convert_nested_initial_dicts(kwds)
- OrderedDict.__init__(self, *args, **kwds)
+ super().__init__(*args, **kwds)
def _convert_nested_initial_dicts(self, value):
items = value.items() if is_dict_like(value) else value
- return OrderedDict((key, self._convert_nested_dicts(value))
- for key, value in items)
+ return OrderedDict(
+ (key, self._convert_nested_dicts(value)) for key, value in items
+ )
def _convert_nested_dicts(self, value):
if isinstance(value, DotDict):
@@ -46,7 +47,7 @@ def __getattr__(self, key):
raise AttributeError(key)
def __setattr__(self, key, value):
- if not key.startswith('_OrderedDict__'):
+ if not key.startswith("_OrderedDict__"):
self[key] = value
else:
OrderedDict.__setattr__(self, key, value)
@@ -60,8 +61,12 @@ def __delattr__(self, key):
def __eq__(self, other):
return dict.__eq__(self, other)
+ def __ne__(self, other):
+ return not self == other
+
def __str__(self):
- return '{%s}' % ', '.join('%r: %r' % (key, self[key]) for key in self)
+ items = ", ".join(f"{key!r}: {self[key]!r}" for key in self)
+ return f"{{{items}}}"
# Must use original dict.__repr__ to allow customising PrettyPrinter.
__repr__ = dict.__repr__
diff --git a/src/robot/utils/encoding.py b/src/robot/utils/encoding.py
index 3534a6ad0f5..d8c52961cc3 100644
--- a/src/robot/utils/encoding.py
+++ b/src/robot/utils/encoding.py
@@ -18,37 +18,40 @@
from .encodingsniffer import get_console_encoding, get_system_encoding
from .misc import isatty
-from .robottypes import is_string
from .unic import safe_str
-
CONSOLE_ENCODING = get_console_encoding()
SYSTEM_ENCODING = get_system_encoding()
-PYTHONIOENCODING = os.getenv('PYTHONIOENCODING')
+CUSTOM_ENCODINGS = {"CONSOLE": CONSOLE_ENCODING, "SYSTEM": SYSTEM_ENCODING}
+PYTHONIOENCODING = os.getenv("PYTHONIOENCODING")
def console_decode(string, encoding=CONSOLE_ENCODING):
"""Decodes bytes from console encoding to Unicode.
- By default uses the system console encoding, but that can be configured
+ Uses the system console encoding by default, but that can be configured
using the `encoding` argument. In addition to the normal encodings,
it is possible to use case-insensitive values `CONSOLE` and `SYSTEM` to
use the system console and system encoding, respectively.
If `string` is already Unicode, it is returned as-is.
"""
- if is_string(string):
+ if isinstance(string, str):
return string
- encoding = {'CONSOLE': CONSOLE_ENCODING,
- 'SYSTEM': SYSTEM_ENCODING}.get(encoding.upper(), encoding)
+ encoding = CUSTOM_ENCODINGS.get(encoding.upper(), encoding)
try:
return string.decode(encoding)
except UnicodeError:
return safe_str(string)
-def console_encode(string, encoding=None, errors='replace', stream=sys.__stdout__,
- force=False):
+def console_encode(
+ string,
+ encoding=None,
+ errors="replace",
+ stream=sys.__stdout__,
+ force=False,
+):
"""Encodes the given string so that it can be used in the console.
If encoding is not given, determines it based on the given stream and system
@@ -56,22 +59,23 @@ def console_encode(string, encoding=None, errors='replace', stream=sys.__stdout_
case-insensitive values `CONSOLE` and `SYSTEM` to use the system console
and system encoding, respectively.
- By default decodes bytes back to Unicode because Python 3 APIs in general
+ Decodes bytes back to Unicode by default, because Python 3 APIs in general
work with strings. Use `force=True` if that is not desired.
"""
+ if not isinstance(string, str):
+ string = safe_str(string)
if encoding:
- encoding = {'CONSOLE': CONSOLE_ENCODING,
- 'SYSTEM': SYSTEM_ENCODING}.get(encoding.upper(), encoding)
+ encoding = CUSTOM_ENCODINGS.get(encoding.upper(), encoding)
else:
encoding = _get_console_encoding(stream)
- if encoding != 'UTF-8':
+ if encoding.upper() != "UTF-8":
encoded = string.encode(encoding, errors)
return encoded if force else encoded.decode(encoding)
return string.encode(encoding, errors) if force else string
def _get_console_encoding(stream):
- encoding = getattr(stream, 'encoding', None)
+ encoding = getattr(stream, "encoding", None)
if isatty(stream):
return encoding or CONSOLE_ENCODING
if PYTHONIOENCODING:
@@ -80,8 +84,8 @@ def _get_console_encoding(stream):
def system_decode(string):
- return string if is_string(string) else safe_str(string)
+ return string if isinstance(string, str) else safe_str(string)
def system_encode(string):
- return string if is_string(string) else safe_str(string)
+ return string if isinstance(string, str) else safe_str(string)
diff --git a/src/robot/utils/encodingsniffer.py b/src/robot/utils/encodingsniffer.py
index f96cff7716c..0e37f358f47 100644
--- a/src/robot/utils/encodingsniffer.py
+++ b/src/robot/utils/encodingsniffer.py
@@ -13,33 +13,36 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import locale
import os
import sys
-import locale
from .misc import isatty
-from .platform import UNIXY, WINDOWS
-
+from .platform import PY_VERSION, UNIXY, WINDOWS
if UNIXY:
- DEFAULT_CONSOLE_ENCODING = 'UTF-8'
- DEFAULT_SYSTEM_ENCODING = 'UTF-8'
+ DEFAULT_CONSOLE_ENCODING = "UTF-8"
+ DEFAULT_SYSTEM_ENCODING = "UTF-8"
else:
- DEFAULT_CONSOLE_ENCODING = 'cp437'
- DEFAULT_SYSTEM_ENCODING = 'cp1252'
+ DEFAULT_CONSOLE_ENCODING = "cp437"
+ DEFAULT_SYSTEM_ENCODING = "cp1252"
def get_system_encoding():
- platform_getters = [(True, _get_python_system_encoding),
- (UNIXY, _get_unixy_encoding),
- (WINDOWS, _get_windows_system_encoding)]
+ platform_getters = [
+ (True, _get_python_system_encoding),
+ (UNIXY, _get_unixy_encoding),
+ (WINDOWS, _get_windows_system_encoding),
+ ]
return _get_encoding(platform_getters, DEFAULT_SYSTEM_ENCODING)
def get_console_encoding():
- platform_getters = [(True, _get_stream_output_encoding),
- (UNIXY, _get_unixy_encoding),
- (WINDOWS, _get_windows_console_encoding)]
+ platform_getters = [
+ (True, _get_stream_output_encoding),
+ (UNIXY, _get_unixy_encoding),
+ (WINDOWS, _get_windows_console_encoding),
+ ]
return _get_encoding(platform_getters, DEFAULT_CONSOLE_ENCODING)
@@ -53,54 +56,62 @@ def _get_encoding(platform_getters, default):
def _get_python_system_encoding():
- return locale.getpreferredencoding(False)
+ if PY_VERSION >= (3, 11):
+ return locale.getencoding()
+ # ValueError occurs with PyPy 3.10 if language config is invalid.
+ # https://foss.heptapod.net/pypy/pypy/-/issues/3975
+ try:
+ return locale.getpreferredencoding(False)
+ except ValueError:
+ return None
def _get_unixy_encoding():
- # Cannot use `locale.getdefaultlocale()` because it raises ValueError
- # if encoding is invalid. Using same environment variables here anyway.
+ # Cannot use `locale.getdefaultlocale()` because it is deprecated.
+ # Using same environment variables here anyway.
# https://docs.python.org/3/library/locale.html#locale.getdefaultlocale
- for name in 'LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE':
+ for name in "LC_ALL", "LC_CTYPE", "LANG", "LANGUAGE":
if name in os.environ:
# Encoding can be in format like `UTF-8` or `en_US.UTF-8`
- encoding = os.environ[name].split('.')[-1]
+ encoding = os.environ[name].split(".")[-1]
if _is_valid(encoding):
return encoding
return None
def _get_stream_output_encoding():
- # Python 3.6+ uses UTF-8 as encoding with output streams.
+ # Python uses UTF-8 as encoding with output streams.
# We want the real console encoding regardless the platform.
if WINDOWS:
return None
for stream in sys.__stdout__, sys.__stderr__, sys.__stdin__:
if isatty(stream):
- encoding = getattr(stream, 'encoding', None)
+ encoding = getattr(stream, "encoding", None)
if _is_valid(encoding):
return encoding
return None
def _get_windows_system_encoding():
- return _get_code_page('GetACP')
+ return _get_code_page("GetACP")
def _get_windows_console_encoding():
- return _get_code_page('GetConsoleOutputCP')
+ return _get_code_page("GetConsoleOutputCP")
def _get_code_page(method_name):
from ctypes import cdll
+
method = getattr(cdll.kernel32, method_name)
- return 'cp%s' % method()
+ return f"cp{method()}"
def _is_valid(encoding):
if not encoding:
return False
try:
- 'test'.encode(encoding)
+ "test".encode(encoding)
except LookupError:
return False
else:
diff --git a/src/robot/utils/error.py b/src/robot/utils/error.py
index 5d910533a1e..35cb19dfb50 100644
--- a/src/robot/utils/error.py
+++ b/src/robot/utils/error.py
@@ -19,10 +19,7 @@
from robot.errors import RobotError
-from .platform import RERAISED_EXCEPTIONS
-
-
-EXCLUDE_ROBOT_TRACES = not os.getenv('ROBOT_INTERNAL_TRACES')
+EXCLUDE_ROBOT_TRACES = not os.getenv("ROBOT_INTERNAL_TRACES")
def get_error_message():
@@ -37,8 +34,10 @@ def get_error_message():
def get_error_details(full_traceback=True, exclude_robot_traces=EXCLUDE_ROBOT_TRACES):
"""Returns error message and details of the last occurred exception."""
- details = ErrorDetails(full_traceback=full_traceback,
- exclude_robot_traces=exclude_robot_traces)
+ details = ErrorDetails(
+ full_traceback=full_traceback,
+ exclude_robot_traces=exclude_robot_traces,
+ )
return details.message, details.traceback
@@ -49,13 +48,18 @@ class ErrorDetails:
the message with possible generic exception name removed, `traceback` contains
the traceback and `error` contains the original error instance.
"""
- _generic_names = frozenset(('AssertionError', 'Error', 'Exception', 'RuntimeError'))
- def __init__(self, error=None, full_traceback=True,
- exclude_robot_traces=EXCLUDE_ROBOT_TRACES):
+ _generic_names = frozenset(("AssertionError", "Error", "Exception", "RuntimeError"))
+
+ def __init__(
+ self,
+ error=None,
+ full_traceback=True,
+ exclude_robot_traces=EXCLUDE_ROBOT_TRACES,
+ ):
if not error:
error = sys.exc_info()[1]
- if isinstance(error, RERAISED_EXCEPTIONS):
+ if isinstance(error, (KeyboardInterrupt, SystemExit, MemoryError)):
raise error
self.error = error
self._full_traceback = full_traceback
@@ -81,45 +85,48 @@ def _format_traceback(self, error):
if self._exclude_robot_traces:
self._remove_robot_traces(error)
lines = self._get_traceback_lines(type(error), error, error.__traceback__)
- return ''.join(lines).rstrip()
+ return "".join(lines).rstrip()
def _remove_robot_traces(self, error):
tb = error.__traceback__
while tb and self._is_robot_traceback(tb):
tb = tb.tb_next
error.__traceback__ = tb
+ if error.__context__:
+ self._remove_robot_traces(error.__context__)
+ if error.__cause__:
+ self._remove_robot_traces(error.__cause__)
def _is_robot_traceback(self, tb):
- module = tb.tb_frame.f_globals.get('__name__')
- return module and module.startswith('robot.')
+ module = tb.tb_frame.f_globals.get("__name__")
+ return module and module.startswith("robot.")
def _get_traceback_lines(self, etype, value, tb):
- prefix = 'Traceback (most recent call last):\n'
- empty_tb = [prefix, ' None\n']
+ prefix = "Traceback (most recent call last):\n"
+ empty_tb = [prefix, " None\n"]
if self._full_traceback:
- if tb:
+ if tb or value.__context__ or value.__cause__:
return traceback.format_exception(etype, value, tb)
- else:
- return empty_tb + traceback.format_exception_only(etype, value)
- else:
- if tb:
- return [prefix] + traceback.format_tb(tb)
- else:
- return empty_tb
+ return empty_tb + traceback.format_exception_only(etype, value)
+ if tb:
+ return [prefix, *traceback.format_tb(tb)]
+ return empty_tb
def _format_message(self, error):
- name = type(error).__name__.split('.')[-1] # Use only the last part
+ name = type(error).__name__.split(".")[-1] # Use only the last part
message = str(error)
if not message:
return name
if self._suppress_name(name, error):
return message
- if message.startswith('*HTML*'):
- name = '*HTML* ' + name
- message = message.split('*', 2)[-1].lstrip()
- return '%s: %s' % (name, message)
+ if message.startswith("*HTML*"):
+ name = "*HTML* " + name
+ message = message.split("*", 2)[-1].lstrip()
+ return f"{name}: {message}"
def _suppress_name(self, name, error):
- return (name in self._generic_names
- or isinstance(error, RobotError)
- or getattr(error, 'ROBOT_SUPPRESS_NAME', False))
+ return (
+ name in self._generic_names
+ or isinstance(error, RobotError)
+ or getattr(error, "ROBOT_SUPPRESS_NAME", False)
+ )
diff --git a/src/robot/utils/escaping.py b/src/robot/utils/escaping.py
index d394571f241..812936373f6 100644
--- a/src/robot/utils/escaping.py
+++ b/src/robot/utils/escaping.py
@@ -15,67 +15,67 @@
import re
-from .robottypes import is_string
-
-
-_CONTROL_WORDS = frozenset(('ELSE', 'ELSE IF', 'AND', 'WITH NAME'))
-_SEQUENCES_TO_BE_ESCAPED = ('\\', '${', '@{', '%{', '&{', '*{', '=')
+_CONTROL_WORDS = frozenset(("ELSE", "ELSE IF", "AND", "WITH NAME", "AS"))
+_SEQUENCES_TO_BE_ESCAPED = ("\\", "${", "@{", "%{", "&{", "*{", "=")
def escape(item):
- if not is_string(item):
+ if not isinstance(item, str):
return item
if item in _CONTROL_WORDS:
- return '\\' + item
+ return "\\" + item
for seq in _SEQUENCES_TO_BE_ESCAPED:
if seq in item:
- item = item.replace(seq, '\\' + seq)
+ item = item.replace(seq, "\\" + seq)
return item
def glob_escape(item):
# Python 3.4+ has `glob.escape()` but it has special handling for drives
# that we don't want.
- for char in '[*?':
+ for char in "[*?":
if char in item:
- item = item.replace(char, '[%s]' % char)
+ item = item.replace(char, f"[{char}]")
return item
class Unescaper:
- _escape_sequences = re.compile(r'''
+ _escape_sequences = re.compile(
+ r"""
(\\+) # escapes
- (n|r|t # n, r, or t
+ (n|r|t # n, r, or t
|x[0-9a-fA-F]{2} # x+HH
|u[0-9a-fA-F]{4} # u+HHHH
|U[0-9a-fA-F]{8} # U+HHHHHHHH
)? # optionally
- ''', re.VERBOSE)
+ """,
+ re.VERBOSE,
+ )
def __init__(self):
self._escape_handlers = {
- '': lambda value: value,
- 'n': lambda value: '\n',
- 'r': lambda value: '\r',
- 't': lambda value: '\t',
- 'x': self._hex_to_unichr,
- 'u': self._hex_to_unichr,
- 'U': self._hex_to_unichr
+ "": lambda value: value,
+ "n": lambda value: "\n",
+ "r": lambda value: "\r",
+ "t": lambda value: "\t",
+ "x": self._hex_to_unichr,
+ "u": self._hex_to_unichr,
+ "U": self._hex_to_unichr,
}
def _hex_to_unichr(self, value):
ordinal = int(value, 16)
# No Unicode code points above 0x10FFFF
if ordinal > 0x10FFFF:
- return 'U' + value
+ return "U" + value
# `chr` only supports ordinals up to 0xFFFF on narrow Python builds.
# This may not be relevant anymore.
if ordinal > 0xFFFF:
- return eval(r"'\U%08x'" % ordinal)
+ return eval(rf"'\U{ordinal:08x}'")
return chr(ordinal)
def unescape(self, item):
- if not (is_string(item) and '\\' in item):
+ if not isinstance(item, str) or "\\" not in item:
return item
return self._escape_sequences.sub(self._handle_escapes, item)
@@ -83,7 +83,7 @@ def _handle_escapes(self, match):
escapes, text = match.groups()
half, is_escaped = divmod(len(escapes), 2)
escapes = escapes[:half]
- text = text or ''
+ text = text or ""
if is_escaped:
marker, value = text[:1], text[1:]
text = self._escape_handlers[marker](value)
@@ -93,34 +93,37 @@ def _handle_escapes(self, match):
unescape = Unescaper().unescape
-def split_from_equals(string):
- from robot.variables import VariableIterator
- if not is_string(string) or '=' not in string:
- return string, None
- variables = VariableIterator(string, ignore_errors=True)
- if not variables and '\\' not in string:
- return tuple(string.split('=', 1))
+def split_from_equals(value):
+ from robot.variables import VariableMatches
+
+ if not isinstance(value, str) or "=" not in value:
+ return value, None
+ matches = VariableMatches(value, ignore_errors=True)
+ if not matches and "\\" not in value:
+ return tuple(value.split("=", 1))
try:
- index = _find_split_index(string, variables)
+ index = _find_split_index(value, matches)
except ValueError:
- return string, None
- return string[:index], string[index+1:]
+ return value, None
+ return value[:index], value[index + 1 :]
-def _find_split_index(string, variables):
+def _find_split_index(string, matches):
+ remaining = string
relative_index = 0
- for before, match, string in variables:
+ for match in matches:
try:
- return _find_split_index_from_part(before) + relative_index
+ return _find_split_index_from_part(match.before) + relative_index
except ValueError:
- relative_index += len(before) + len(match)
- return _find_split_index_from_part(string) + relative_index
+ remaining = match.after
+ relative_index += match.end
+ return _find_split_index_from_part(remaining) + relative_index
def _find_split_index_from_part(string):
index = 0
- while '=' in string[index:]:
- index += string[index:].index('=')
+ while "=" in string[index:]:
+ index += string[index:].index("=")
if _not_escaping(string[:index]):
return index
index += 1
@@ -128,5 +131,5 @@ def _find_split_index_from_part(string):
def _not_escaping(name):
- backslashes = len(name) - len(name.rstrip('\\'))
+ backslashes = len(name) - len(name.rstrip("\\"))
return backslashes % 2 == 0
diff --git a/src/robot/utils/etreewrapper.py b/src/robot/utils/etreewrapper.py
index c73a9f89f6e..51e9300a821 100644
--- a/src/robot/utils/etreewrapper.py
+++ b/src/robot/utils/etreewrapper.py
@@ -13,72 +13,64 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import re
from io import BytesIO
from os import fsdecode
-import re
-
-from .robottypes import is_bytes, is_pathlike, is_string
+from pathlib import Path
+from typing import IO, Union
-try:
- from xml.etree import cElementTree as ET
-except ImportError:
- try:
- from xml.etree import ElementTree as ET
- except ImportError:
- raise ImportError('No valid ElementTree XML parser module found')
+Source = Union[IO, Path, str, bytes, bytearray]
class ETSource:
- def __init__(self, source):
+ def __init__(self, source: Source):
self._source = source
- self._opened = None
+ self._opened: "BytesIO | None" = None
- def __enter__(self):
+ def __enter__(self) -> "IO | Path | str | bytes":
self._opened = self._open_if_necessary(self._source)
return self._opened or self._source
- def _open_if_necessary(self, source):
+ def _open_if_necessary(self, source: Source) -> "BytesIO | None":
if self._is_path(source) or self._is_already_open(source):
return None
- if is_bytes(source):
+ if isinstance(source, (bytes, bytearray)):
return BytesIO(source)
encoding = self._find_encoding(source)
return BytesIO(source.encode(encoding))
- def _is_path(self, source):
- if is_pathlike(source):
+ def _is_path(self, source: Source) -> bool:
+ if isinstance(source, Path):
return True
- elif is_string(source):
- prefix = '<'
- elif is_bytes(source):
- prefix = b'<'
- else:
- return False
- return not source.lstrip().startswith(prefix)
+ if isinstance(source, str):
+ return not source.lstrip().startswith("<")
+ if isinstance(source, bytes):
+ return not source.lstrip().startswith(b"<")
+ return False
- def _is_already_open(self, source):
- return not (is_string(source) or is_bytes(source))
+ def _is_already_open(self, source: Source) -> bool:
+ return not isinstance(source, (str, bytes, bytearray))
- def _find_encoding(self, source):
+ def _find_encoding(self, source: str) -> str:
match = re.match(r"\s*<\?xml .*encoding=(['\"])(.*?)\1.*\?>", source)
- return match.group(2) if match else 'UTF-8'
+ return match.group(2) if match else "UTF-8"
def __exit__(self, exc_type, exc_value, exc_trace):
if self._opened:
self._opened.close()
- def __str__(self):
+ def __str__(self) -> str:
source = self._source
if self._is_path(source):
return self._path_to_string(source)
- if hasattr(source, 'name'):
+ if hasattr(source, "name"):
return self._path_to_string(source.name)
- return ''
+ return ""
- def _path_to_string(self, path):
- if is_pathlike(path):
+ def _path_to_string(self, path: "Path | str | bytes") -> str:
+ if isinstance(path, Path):
return str(path)
- if is_bytes(path):
+ if isinstance(path, bytes):
return fsdecode(path)
return path
diff --git a/src/robot/utils/filereader.py b/src/robot/utils/filereader.py
index ba1132a1ea9..098add3e3c6 100644
--- a/src/robot/utils/filereader.py
+++ b/src/robot/utils/filereader.py
@@ -13,20 +13,21 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+from collections.abc import Iterator
from io import StringIO
-import os.path
+from pathlib import Path
+from typing import TextIO, Union
-from .robottypes import is_bytes, is_pathlike, is_string
+Source = Union[Path, str, TextIO]
-class FileReader:
- """Utility to ease reading different kind of files.
+class FileReader: # FIXME: Rename to SourceReader
+ """Utility to ease reading different kind of source files.
Supports different sources where to read the data:
- The source can be a path to a file, either as a string or as a
- ``pathlib.Path`` instance in Python 3. The file itself must be
- UTF-8 encoded.
+ ``pathlib.Path`` instance. The file itself must be UTF-8 encoded.
- Alternatively the source can be an already opened file object,
including a StringIO or BytesIO object. The file can contain either
@@ -39,35 +40,41 @@ class FileReader:
BOM removed.
"""
- def __init__(self, source, accept_text=False):
- self.file, self.name, self._opened = self._get_file(source, accept_text)
+ def __init__(self, source: Source, accept_text: bool = False):
+ self.file, self._opened = self._get_file(source, accept_text)
- def _get_file(self, source, accept_text):
+ def _get_file(self, source: Source, accept_text: bool) -> "tuple[TextIO, bool]":
path = self._get_path(source, accept_text)
if path:
- file = open(path, 'rb')
+ file = open(path, "rb")
opened = True
- elif is_string(source):
+ elif isinstance(source, str):
file = StringIO(source)
opened = True
else:
file = source
opened = False
- name = getattr(file, 'name', '')
- return file, name, opened
+ return file, opened
- def _get_path(self, source, accept_text):
- if is_pathlike(source):
+ def _get_path(self, source: Source, accept_text: bool):
+ if isinstance(source, Path):
return str(source)
- if not is_string(source):
+ if not isinstance(source, str):
return None
if not accept_text:
return source
- if '\n' in source:
+ if "\n" in source:
return None
- if os.path.isabs(source) or os.path.exists(source):
- return source
- return None
+ path = Path(source)
+ try:
+ is_path = path.is_absolute() or path.exists()
+ except OSError: # Can happen on Windows w/ Python < 3.10.
+ is_path = False
+ return source if is_path else None
+
+ @property
+ def name(self) -> str:
+ return getattr(self.file, "name", "")
def __enter__(self):
return self
@@ -76,25 +83,20 @@ def __exit__(self, *exc_info):
if self._opened:
self.file.close()
- def read(self):
+ def read(self) -> str:
return self._decode(self.file.read())
- def readlines(self):
+ def readlines(self) -> "Iterator[str]":
first_line = True
- for line in self.file.readlines():
+ for line in self.file:
yield self._decode(line, remove_bom=first_line)
first_line = False
- def _decode(self, content, remove_bom=True):
- if is_bytes(content):
- content = content.decode('UTF-8')
- if remove_bom and content.startswith('\ufeff'):
+ def _decode(self, content: "str|bytes", remove_bom: bool = True) -> str:
+ if isinstance(content, bytes):
+ content = content.decode("UTF-8")
+ if remove_bom and content.startswith("\ufeff"):
content = content[1:]
- if '\r\n' in content:
- content = content.replace('\r\n', '\n')
+ if "\r\n" in content:
+ content = content.replace("\r\n", "\n")
return content
-
- def _is_binary_file(self):
- mode = getattr(self.file, 'mode', '')
- encoding = getattr(self.file, 'encoding', 'ascii').lower()
- return 'r' in mode and encoding == 'ascii'
diff --git a/src/robot/utils/frange.py b/src/robot/utils/frange.py
index 680dc1c0454..162bff8cbaf 100644
--- a/src/robot/utils/frange.py
+++ b/src/robot/utils/frange.py
@@ -13,18 +13,16 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-from .robottypes import is_integer, is_string
-
def frange(*args):
"""Like ``range()`` but accepts float arguments."""
- if all(is_integer(arg) for arg in args):
+ if all(isinstance(arg, int) for arg in args):
return list(range(*args))
start, stop, step = _get_start_stop_step(args)
digits = max(_digits(start), _digits(stop), _digits(step))
factor = pow(10, digits)
- return [x / factor
- for x in range(round(start*factor), round(stop*factor), round(step*factor))]
+ scaled = range(round(start * factor), round(stop * factor), round(step * factor))
+ return [x / factor for x in scaled]
def _get_start_stop_step(args):
@@ -34,28 +32,28 @@ def _get_start_stop_step(args):
return args[0], args[1], 1
if len(args) == 3:
return args
- raise TypeError('frange expected 1-3 arguments, got %d.' % len(args))
+ raise TypeError(f"frange expected 1-3 arguments, got {len(args)}.")
def _digits(number):
- if not is_string(number):
+ if not isinstance(number, str):
number = repr(number)
- if 'e' in number:
+ if "e" in number:
return _digits_with_exponent(number)
- if '.' in number:
+ if "." in number:
return _digits_with_fractional(number)
return 0
def _digits_with_exponent(number):
- mantissa, exponent = number.split('e')
+ mantissa, exponent = number.split("e")
mantissa_digits = _digits(mantissa)
exponent_digits = int(exponent) * -1
return max(mantissa_digits + exponent_digits, 0)
def _digits_with_fractional(number):
- fractional = number.split('.')[1]
- if fractional == '0':
+ fractional = number.split(".")[1]
+ if fractional == "0":
return 0
return len(fractional)
diff --git a/src/robot/utils/htmlformatters.py b/src/robot/utils/htmlformatters.py
index 83b293ca34b..6562e8261c2 100644
--- a/src/robot/utils/htmlformatters.py
+++ b/src/robot/utils/htmlformatters.py
@@ -19,19 +19,22 @@
class LinkFormatter:
- _image_exts = ('.jpg', '.jpeg', '.png', '.gif', '.bmp', '.svg')
- _link = re.compile(r'\[(.+?\|.*?)\]')
- _url = re.compile(r'''
-((^|\ ) ["'(\[{]*) # begin of line or space and opt. any char "'([{
-([a-z][\w+-.]*://[^\s|]+?) # url
-(?=[)\]}"'.,!?:;|]* ($|\ )) # opt. any char )]}"'.,!?:;| and eol or space
-''', re.VERBOSE|re.MULTILINE|re.IGNORECASE)
+ _image_exts = (".jpg", ".jpeg", ".png", ".gif", ".bmp", ".svg")
+ _link = re.compile(r"\[(.+?\|.*?)]")
+ _url = re.compile(
+ r"""
+ ((^|\ ) ["'(\[{]*) # begin of line or space and opt. any char "'([{
+ ([a-z][\w+-.]*://[^\s|]+?) # url
+ (?=[)\]}"'.,!?:;|]* ($|\ )) # opt. any char )]}"'.,!?:;| and eol or space
+ """,
+ re.VERBOSE | re.MULTILINE | re.IGNORECASE,
+ )
def format_url(self, text):
return self._format_url(text, format_as_image=False)
def _format_url(self, text, format_as_image=True):
- if '://' not in text:
+ if "://" not in text:
return text
return self._url.sub(partial(self._replace_url, format_as_image), text)
@@ -43,23 +46,22 @@ def _replace_url(self, format_as_image, match):
return pre + self._get_link(url)
def _get_image(self, src, title=None):
- return '' \
- % (self._quot(src), self._quot(title or src))
+ return f''
def _get_link(self, href, content=None):
- return '%s' % (self._quot(href), content or href)
+ return f'{content or href}'
def _quot(self, attr):
- return attr if '"' not in attr else attr.replace('"', '"')
+ return attr if '"' not in attr else attr.replace('"', """)
def format_link(self, text):
# 2nd, 4th, etc. token contains link, others surrounding content
tokens = self._link.split(text)
formatters = cycle((self._format_url, self._format_link))
- return ''.join(f(t) for f, t in zip(formatters, tokens))
+ return "".join(f(t) for f, t in zip(formatters, tokens))
def _format_link(self, text):
- link, content = [t.strip() for t in text.split('|', 1)]
+ link, content = [t.strip() for t in text.split("|", 1)]
if self._is_image(content):
content = self._get_image(content, link)
elif self._is_image(link):
@@ -67,47 +69,58 @@ def _format_link(self, text):
return self._get_link(link, content)
def _is_image(self, text):
-
- return (text.startswith('data:image/')
- or text.lower().endswith(self._image_exts))
+ return text.startswith("data:image/") or text.lower().endswith(self._image_exts)
class LineFormatter:
- handles = lambda self, line: True
- newline = '\n'
- _bold = re.compile(r'''
-( # prefix (group 1)
- (^|\ ) # begin of line or space
- ["'(]* _? # optionally any char "'( and optional begin of italic
-) #
-\* # start of bold
-([^\ ].*?) # no space and then anything (group 3)
-\* # end of bold
-(?= # start of postfix (non-capturing group)
- _? ["').,!?:;]* # optional end of italic and any char "').,!?:;
- ($|\ ) # end of line or space
-)
-''', re.VERBOSE)
- _italic = re.compile(r'''
-( (^|\ ) ["'(]* ) # begin of line or space and opt. any char "'(
-_ # start of italic
-([^\ _].*?) # no space or underline and then anything
-_ # end of italic
-(?= ["').,!?:;]* ($|\ ) ) # opt. any char "').,!?:; and end of line or space
-''', re.VERBOSE)
- _code = re.compile(r'''
-( (^|\ ) ["'(]* ) # same as above with _ changed to ``
-``
-([^\ `].*?)
-``
-(?= ["').,!?:;]* ($|\ ) )
-''', re.VERBOSE)
+ newline = "\n"
+ _bold = re.compile(
+ r"""
+ ( # prefix (group 1)
+ (^|\ ) # begin of line or space
+ ["'(]* _? # opt. any char "'( and opt. start of italics
+ ) #
+ \* # start of bold
+ ([^\ ].*?) # no space and then anything (group 3)
+ \* # end of bold
+ (?= # start of postfix (non-capturing group)
+ _? ["').,!?:;]* # optional end of italic and any char "').,!?:;
+ ($|\ ) # end of line or space
+ )
+ """,
+ re.VERBOSE,
+ )
+ _italic = re.compile(
+ r"""
+ ( (^|\ ) ["'(]* ) # begin of line or space and opt. any char "'(
+ _ # start of italics
+ ([^\ _].*?) # no space or underline and then anything
+ _ # end of italics
+ (?= ["').,!?:;]* ($|\ ) ) # opt. any char "').,!?:; and end of line or space
+ """,
+ re.VERBOSE,
+ )
+ _code = re.compile(
+ r"""
+ ( (^|\ ) ["'(]* ) # same as above with _ changed to ``
+ ``
+ ([^\ `].*?)
+ ``
+ (?= ["').,!?:;]* ($|\ ) )
+ """,
+ re.VERBOSE,
+ )
def __init__(self):
- self._formatters = [('*', self._format_bold),
- ('_', self._format_italic),
- ('``', self._format_code),
- ('', LinkFormatter().format_link)]
+ self._formatters = [
+ ("*", self._format_bold),
+ ("_", self._format_italic),
+ ("``", self._format_code),
+ ("", LinkFormatter().format_link),
+ ]
+
+ def handles(self, line):
+ return True
def format(self, line):
for marker, formatter in self._formatters:
@@ -116,23 +129,25 @@ def format(self, line):
return line
def _format_bold(self, line):
- return self._bold.sub('\\1\\3', line)
+ return self._bold.sub("\\1\\3", line)
def _format_italic(self, line):
- return self._italic.sub('\\1\\3', line)
+ return self._italic.sub("\\1\\3", line)
def _format_code(self, line):
- return self._code.sub('\\1\\3', line)
+ return self._code.sub("\\1\\3", line)
class HtmlFormatter:
def __init__(self):
- self._formatters = [TableFormatter(),
- PreformattedFormatter(),
- ListFormatter(),
- HeaderFormatter(),
- RulerFormatter()]
+ self._formatters = [
+ TableFormatter(),
+ PreformattedFormatter(),
+ ListFormatter(),
+ HeaderFormatter(),
+ RulerFormatter(),
+ ]
self._formatters.append(ParagraphFormatter(self._formatters[:]))
self._current = None
@@ -141,7 +156,7 @@ def format(self, text):
for line in text.splitlines():
self._process_line(line, results)
self._end_current(results)
- return '\n'.join(results)
+ return "\n".join(results)
def _process_line(self, line, results):
if not line.strip():
@@ -204,79 +219,78 @@ def format_line(self, line):
class RulerFormatter(_SingleLineFormatter):
- match = re.compile('^-{3,}$').match
+ match = re.compile("^-{3,}$").match
def format_line(self, line):
- return ''
+ return ""
class HeaderFormatter(_SingleLineFormatter):
- match = re.compile(r'^(={1,3})\s+(\S.*?)\s+\1$').match
+ match = re.compile(r"^(={1,3})\s+(\S.*?)\s+\1$").match
def format_line(self, line):
level, text = self.match(line).groups()
level = len(level) + 1
- return '%s' % (level, text, level)
+ return f"{text}"
class ParagraphFormatter(_Formatter):
_format_line = LineFormatter().format
def __init__(self, other_formatters):
- _Formatter.__init__(self)
+ super().__init__()
self._other_formatters = other_formatters
def _handles(self, line):
- return not any(other.handles(line)
- for other in self._other_formatters)
+ return not any(other.handles(line) for other in self._other_formatters)
def format(self, lines):
- return '
Browser library is a browser automation library for Robot Framework.
\n
This is the keyword documentation for Browser library. For information about installation, support, and more please visit the project pages. For more information about Robot Framework itself, see robotframework.org.
Browser library works with three different layers that build on each other: Browser, Context and Page.
\n
Browsers
\n
A browser can be started with one of the three different engines Chromium, Firefox or Webkit.
\n
Supported Browsers
\n
\n
\n
Browser
\n
Browser with this engine
\n
\n
\n
chromium
\n
Google Chrome, Microsoft Edge (since 2020), Opera
\n
\n
\n
firefox
\n
Mozilla Firefox
\n
\n
\n
webkit
\n
Apple Safari, Mail, AppStore on MacOS and iOS
\n
\n
\n
Since Playwright comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.
\n
All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. There is no need for dedicated machines anymore.
\n
A browser process is started headless (without a GUI) by default. Run New Browser with specified arguments if a browser with a GUI is requested or if a proxy has to be configured. A browser process can contain several contexts.
\n
Contexts
\n
A context corresponds to a set of independent incognito pages in a browser that share cookies, sessions or profile settings. Pages in two separate contexts do not share cookies, sessions or profile settings. Compared to Selenium, these do not require their own browser process. To get a clean environment a test can just open a new context. Due to this new independent browser sessions can be opened with Robot Framework Browser about 10 times faster than with Selenium by just opening a New Context within the opened browser.
\n
To make pages in the same suite share state, use the same context by opening the context with New Context on suite setup.
\n
The context layer is useful e.g. for testing different user sessions on the same webpage without opening a whole new browser context. Contexts can also have detailed configurations, such as geo-location, language settings, the viewport size or color scheme. Contexts do also support http credentials to be set, so that basic authentication can also be tested. To be able to download files within the test, the acceptDownloads argument must be set to True in New Context keyword. A context can contain different pages.
\n
Pages
\n
A page does contain the content of the loaded web site and has a browsing history. Pages and browser tabs are the same.
Each Browser, Context and Page has a unique ID with which they can be addressed. A full catalog of what is open can be received by Get Browser Catalog as a dictionary.
\n
Automatic page and context closing
\n
Controls when contexts and pages are closed during the test execution.
\n
If automatic closing level is TEST, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.
\n
If automatic closing level is SUITE, all contexts and pages that are created during the test suite are closed when the suite teardown ends.
\n
If automatic closing level is MANUAL, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.
\n
If automatic closing level is KEEP, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.
\n
Automatic closing can be configured or switched off with the auto_closing_level library import parameter.
All keywords in the library that need to interact with an element on a web page take an argument typically named selector that specifies how to find the element. Keywords can find elements with strict mode. If strict mode is true and locator finds multiple elements from the page, keyword will fail. If keyword finds one element, keyword does not fail because of strict mode. If strict mode is false, keyword does not fail if selector points many elements. Strict mode is enabled by default, but can be changed in library importing or Set Strict Mode keyword. Keyword documentation states if keyword uses strict mode. If keyword does not state that strict mode is used, then strict mode is not applied for the keyword. For more details, see Playwright strict documentation.
\n
Selector strategies that are supported by default are listed in the table below.
\n
\n
\n
Strategy
\n
Match based on
\n
Example
\n
\n
\n
css
\n
CSS selector.
\n
css=.class > \\#login_btn
\n
\n
\n
xpath
\n
XPath expression.
\n
xpath=//input[@id="login_btn"]
\n
\n
\n
text
\n
Browser text engine.
\n
text=Login
\n
\n
\n
id
\n
Element ID Attribute.
\n
id=login_btn
\n
\n
\n
CSS Selectors can also be recorded with Record selector keyword.
\n
Explicit Selector Strategy
\n
The explicit selector strategy is specified with a prefix using syntax strategy=value. Spaces around the separator are ignored, so css=foo, css= foo and css = foo are all equivalent.
If selector does not contain one of the know explicit selector strategies, it is assumed to contain css selector.
\n
Selectors that are starting with // or .. are considered as xpath selectors.
\n
Selectors that are in quotes are considered as text selectors.
\n
Examples:
\n
\n# CSS selectors are default.\nClick span > button.some_class # This is equivalent\nClick css=span > button.some_class # to this.\n\n# // or .. leads to xpath selector strategy\nClick //span/button[@class="some_class"]\nClick xpath=//span/button[@class="some_class"]\n\n# "text" in quotes leads to exact text selector strategy\nClick "Login"\nClick text="Login"\n
\n
CSS
\n
As written before, the default selector strategy is css. See css selector for more information.
\n
Any malformed selector not starting with // or .. nor starting and ending with a quote is assumed to be a css selector.
\nClick span > button.some_class\nGet Text \\#username_field == George\n
\n
XPath
\n
XPath engine is equivalent to Document.evaluate. Example: xpath=//html/body//span[text()="Hello World"].
\n
Malformed selector starting with // or .. is assumed to be an xpath selector. For example, //html/body is converted to xpath=//html/body. More examples are displayed in Examples.
Text engine finds an element that contains a text node with the passed text. For example, Click text=Login clicks on a login button, and Wait For Elements State text="lazy loaded text" waits for the "lazy loaded text" to appear in the page.
\n
Text engine finds fields based on their labels in text inserting keywords.
\n
Malformed selector starting and ending with a quote (either " or \') is assumed to be a text selector. For example, Click "Login" is converted to Click text="Login". Be aware that these leads to exact matches only! More examples are displayed in Examples.
\n
Insensitive match
\n
By default, the match is case-insensitive, ignores leading/trailing whitespace and searches for a substring. This means text= Login matches <button>Button loGIN (click me)</button>.
\n
Exact match
\n
Text body can be escaped with single or double quotes for precise matching, insisting on exact match, including specified whitespace and case. This means text="Login " will only match <button>Login </button> with exactly one space after "Login". Quoted text follows the usual escaping rules, e.g. use \\" to escape double quote in a double-quoted string: text="foo\\"bar".
\n
RegEx
\n
Text body can also be a JavaScript-like regex wrapped in / symbols. This means text=/^hello .*!$/i or text=/^Hello .*!$/ will match <span>Hello Peter Parker!</span> with any name after Hello, ending with !. The first one flagged with i for case-insensitive. See https://regex101.com for more information about RegEx.
\n
Button and Submit Values
\n
Input elements of the type button and submit are rendered with their value as text, and text engine finds them. For example, text=Login matches <input type=button value="Login">.
\n
Cascaded selector syntax
\n
Browser library supports the same selector strategies as the underlying Playwright node module: xpath, css, id and text. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.
\n
A major advantage of Browser is that multiple selector engines can be used within one selector. It is possible to mix XPath, CSS and Text selectors while selecting a single element.
\n
Selectors are strings that consists of one or more clauses separated by >> token, e.g. clause1 >> clause2 >> clause3. When multiple clauses are present, next one is queried relative to the previous one\'s result. Browser library supports concatenation of different selectors separated by >>.
Each clause contains a selector engine name and selector body, e.g. engine=body. Here engine is one of the supported engines (e.g. css or a custom one). Selector body follows the format of the particular engine, e.g. for css engine it should be a css selector. Body format is assumed to ignore leading and trailing white spaces, so that extra whitespace can be added for readability. If the selector engine needs to include >> in the body, it should be escaped inside a string to not be confused with clause separator, e.g. text="some >> text".
\n
Selector engine name can be prefixed with * to capture an element that matches the particular clause instead of the last one. For example, css=article >> text=Hello captures the element with the text Hello, and *css=article >> text=Hello (note the *) captures the article element that contains some element with the text Hello.
\n
For convenience, selectors in the wrong format are heuristically converted to the right format. See Implicit Selector Strategy
\n
Examples
\n
\n# queries \'div\' css selector\nGet Element css=div\n\n# queries \'//html/body/div\' xpath selector\nGet Element //html/body/div\n\n# queries \'"foo"\' text selector\nGet Element text=foo\n\n# queries \'span\' css selector inside the result of \'//html/body/div\' xpath selector\nGet Element xpath=//html/body/div >> css=span\n\n# converted to \'css=div\'\nGet Element div\n\n# converted to \'xpath=//html/body/div\'\nGet Element //html/body/div\n\n# converted to \'text="foo"\'\nGet Element "foo"\n\n# queries the div element of every 2nd span element inside an element with the id foo\nGet Element \\#foo >> css=span:nth-child(2n+1) >> div\nGet Element id=foo >> css=span:nth-child(2n+1) >> div\n
\n
Be aware that using # as a starting character in Robot Framework would be interpreted as comment. Due to that fact a #id must be escaped as \\#id.
\n
iFrames
\n
By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select an element located inside an iframe or a frameset. For this use case, there is a special selector >>> which can be used to combine a selector for the frame and a selector for an element inside a frame.
Here\'s a keyword call that clicks the button inside the frame.
\n
\nClick id=iframe >>> id=btn\n
\n
The selectors on the left and right side of >>> can be any valid selectors. The selector clause directly before the frame opener >>> must select the frame element itself. Frame selection is the only place where Browser Library modifies the selector, as explained in above. In all cases, the library does not alter the selector in any way, instead it is passed as is to the Playwright side.
\n
If multiple keyword shall be performed inside a frame, it is possible to define a selector prefix with Set Selector Prefix. If this prefix is set to a frame/iframe it has similar behavior as SeleniumLibrary keyword Select Frame.
\n
WebComponents and Shadow DOM
\n
Playwright and so also Browser are able to do automatic piercing of Shadow DOMs and therefore are the best automation technology when working with WebComponents.
\n
Also other technologies claim that they can handle Shadow DOM and Web Components. However, none of them do pierce shadow roots automatically, which may be inconvenient when working with Shadow DOM and Web Components.
\n
For that reason, the css engine pierces shadow roots. More specifically, every Descendant combinator pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector.
\n
That means, it is not necessary to select each shadow host, open its shadow root and select the next shadow host until you reach the element that should be controlled.
\n
CSS:light
\n
css:light engine is equivalent to Document.querySelector and behaves according to the CSS spec. However, it does not pierce shadow roots.
\n
css engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.
\n
Examples:
\n
\n<article>\n <div>In the light dom</div>\n <div slot=\'myslot\'>In the light dom, but goes into the shadow slot</div>\n <open mode shadow root>\n <div class=\'in-the-shadow\'>\n <span class=\'content\'>\n In the shadow dom\n <open mode shadow root>\n <li id=\'target\'>Deep in the shadow</li>\n </open mode shadow root>\n </span>\n </div>\n <slot name=\'myslot\'></slot>\n </open mode shadow root>\n</article>\n
\n
Note that <open mode shadow root> is not an html element, but rather a shadow root created with element.attachShadow({mode: \'open\'}).
\n
\n
Both "css=article div" and "css:light=article div" match the first <div>In the light dom</div>.
\n
Both "css=article > div" and "css:light=article > div" match two div elements that are direct children of the article.
\n
"css=article .in-the-shadow" matches the <div class=\'in-the-shadow\'>, piercing the shadow root, while "css:light=article .in-the-shadow" does not match anything.
\n
"css:light=article div > span" does not match anything, because both light-dom div elements do not contain a span.
\n
"css=article div > span" matches the <span class=\'content\'>, piercing the shadow root.
\n
"css=article > .in-the-shadow" does not match anything, because <div class=\'in-the-shadow\'> is not a direct child of article
\n
"css:light=article > .in-the-shadow" does not match anything.
\n
"css=article li#target" matches the <li id=\'target\'>Deep in the shadow</li>, piercing two shadow roots.
\n
\n
text:light
\n
text engine open pierces shadow roots similarly to css, while text:light does not. Text engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.
\n
id, data-testid, data-test-id, data-test and their :light counterparts
\n
Attribute engines are selecting based on the corresponding attribute value. For example: data-test-id=foo is equivalent to css=[data-test-id="foo"], and id:light=foo is equivalent to css:light=[id="foo"].
\n
Element reference syntax
\n
It is possible to get a reference to a Locator by using Get Element and Get Elements keywords. Keywords do not save reference to an element in the HTML document, instead it saves reference to a Playwright Locator. In nutshell Locator captures the logic of how to retrieve that element from the page. Each time an action is performed, the locator re-searches the elements in the page. This reference can be used as a first part of a selector by using a special selector syntax element=. like this:
\n
\n${ref}= Get Element .some_class\n Click ${ref} >> .some_child # Locator searches an element from the page.\n Click ${ref} >> .other_child # Locator searches again an element from the page.\n
\n
The .some_child and .other_child selectors in the example are relative to the element referenced by ${ref}. Please note that frame piercing is not possible with element reference.
\n
Assertions
\n
Keywords that accept arguments assertion_operator <AssertionOperator> and assertion_expected can optionally assert that a specified condition holds. Keywords will return the value even when the assertion is performed by the keyword.
\n
Assert will retry and fail only after a specified timeout. See Importing and retry_assertions_for (default is 1 second) for configuring this timeout.
\n
Currently supported assertion operators are:
\n
\n
\n
Operator
\n
Alternative Operators
\n
Description
\n
Validate Equivalent
\n
\n
\n
==
\n
equal, equals, should be
\n
Checks if returned value is equal to expected value.
\n
value == expected
\n
\n
\n
!=
\n
inequal, should not be
\n
Checks if returned value is not equal to expected value.
\n
value != expected
\n
\n
\n
>
\n
greater than
\n
Checks if returned value is greater than expected value.
\n
value > expected
\n
\n
\n
>=
\n
\n
Checks if returned value is greater than or equal to expected value.
\n
value >= expected
\n
\n
\n
<
\n
less than
\n
Checks if returned value is less than expected value.
\n
value < expected
\n
\n
\n
<=
\n
\n
Checks if returned value is less than or equal to expected value.
\n
value <= expected
\n
\n
\n
*=
\n
contains
\n
Checks if returned value contains expected value as substring.
\n
expected in value
\n
\n
\n
\n
not contains
\n
Checks if returned value does not contain expected value as substring.
\n
expected in value
\n
\n
\n
^=
\n
should start with, starts
\n
Checks if returned value starts with expected value.
\n
re.search(f"^{expected}", value)
\n
\n
\n
$=
\n
should end with, ends
\n
Checks if returned value ends with expected value.
\n
re.search(f"{expected}$", value)
\n
\n
\n
matches
\n
\n
Checks if given RegEx matches minimum once in returned value.
\n
re.search(expected, value)
\n
\n
\n
validate
\n
\n
Checks if given Python expression evaluates to True.
\n
\n
\n
\n
evaluate
\n
then
\n
When using this operator, the keyword does return the evaluated Python expression.
\n
\n
\n
\n
Currently supported formatters for assertions are:
\n
\n
\n
Formatter
\n
Description
\n
\n
\n
normalize spaces
\n
Substitutes multiple spaces to single space from the value
\n
\n
\n
strip
\n
Removes spaces from the beginning and end of the value
\n
\n
\n
case insensitive
\n
Converts value to lower case before comparing
\n
\n
\n
apply to expected
\n
Applies rules also for the expected value
\n
\n
\n
Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If apply to expected formatter is defined, then formatters are then formatter are also applied to expected value.
\n
By default, keywords will provide an error message if an assertion fails. Default error messages can be overwritten with a message argument. The message argument accepts {value}, {value_type}, {expected} and {expected_type}format options. The {value} is the value returned by the keyword and the {expected} is the expected value defined by the user, usually the value in the assertion_expected argument. The {value_type} and {expected_type} are the type definitions from {value} and {expected} arguments. In similar fashion as Python type returns type definition. Assertions will retry until timeout has expired if they do not pass.
\n
The assertion assertion_expected value is not converted by the library and is used as is. Therefore when assertion is made, the assertion_expected argument value and value returned the keyword must have the same type. If types are not the same, assertion will fail. Example Get Text always returns a string and has to be compared with a string, even the returned value might look like a number.
\n
Other Keywords have other specific types they return. Get Element Count always returns an integer. Get Bounding Box and Get Viewport Size can be filtered. They return a dictionary without a filter and a number when filtered. These Keywords do automatic conversion for the expected value if a number is returned.
\n
* < less or greater > With Strings* Comparisons of strings with greater than or less than compares each character, starting from 0 regarding where it stands in the code page. Example: A < Z, Z < a, ac < dc It does never compare the length of elements. Neither lists nor strings. The comparison stops at the first character that is different. Examples: `\'abcde\' < \'abd\', \'100.000\' < \'2\' In Python 3 and therefore also in Browser it is not possible to compare numbers with strings with a greater or less operator. On keywords that return numbers, the given expected value is automatically converted to a number before comparison.
\n
The getters Get Page State and Get Browser Catalog return a dictionary. Values of the dictionary can directly asserted. Pay attention of possible types because they are evaluated in Python. For example:
\n
\nGet Page State validate 2020 >= value[\'year\'] # Comparison of numbers\nGet Page State validate "IMPORTANT MESSAGE!" == value[\'message\'] # Comparison of strings\n
\n
The \'then\' or \'evaluate\' closure
\n
Keywords that accept arguments assertion_operator and assertion_expected can optionally also use then or evaluate closure to modify the returned value with BuiltIn Evaluate. Actual value can be accessed with value.
\n# KeywordSelectorKeyAssertion OperatorAssertion Expected\nGet Title equal Page Title\nGet Title ^= Page\nGet Style //*[@id="div-element"] width > 100\nGet Title matches \\\\w+\\\\s\\\\w+\nGet Title validate value == "Login Page"\nGet Title evaluate value if value == "some value" else "something else"\n
\n
Implicit waiting
\n
Browser library and Playwright have many mechanisms to help in waiting for elements. Playwright will auto-wait before performing actions on elements. Please see Auto-waiting on Playwright documentation for more information.
\n
On top of Playwright auto-waiting Browser assertions will wait and retry for specified time before failing any Assertions. Time is specified in Browser library initialization with retry_assertions_for.
\n
Browser library also includes explicit waiting keywords such as Wait for Elements State if more control for waiting is needed.
\n
Experimental: Re-using same node process
\n
Browser library integrated nodejs and python. The NodeJS side can be also executed as a standalone process. Browser libraries running on the same machine can talk to that instead of starting new node processes. This can speed execution when running tests parallel. To start node side run on the directory when the Browser package is PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT.
\n
PORT is the port you want to use for the node process. To execute tests then with pabot for example do ROBOT_FRAMEWORK_BROWSER_NODE_PORT=PORT pabot ...
\n
Experimental: Provide parameters to node process
\n
Browser library is integrated with NodeJSand and Python. Browser library starts a node process, to communicate Playwright API in NodeJS side. It is possible to provide parameters for the started node process by defining ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS environment variable, before starting the test execution. Example: ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS=--inspect;robot path/to/tests. There can be multiple arguments defined in the environment variable and arguments must be separated with comma.
\n
Scope Setting
\n
Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the "live time" of that setting. Available Scopes are: Global, Suite and Test/Task See Scope. Is a scope finished, this scoped setting, like timeout, will no longer be used.
\n
Live Times:
\n
\n
A Global scope will live forever until it is overwritten by another Global scope. Or locally temporarily overridden by a more narrow scope.
\n
A Suite scope will locally override the Global scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with Global or same scope. Children suite does inherit the setting from the parent suite but also may have its own local Suite setting that then will be inherited to its children suites.
\n
A Test or Task scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.
\n
\n
A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a Suite scope from a test, will set that scope to the robot file suite where that test is and removes the Test scope that may have been in place.
\n
Extending Browser library with a JavaScript module
\n
Browser library can be extended with JavaScript. The module must be in CommonJS format that Node.js uses. You can translate your ES6 module to Node.js CommonJS style with Babel. Many other languages can be also translated to modules that can be used from Node.js. For example TypeScript, PureScript and ClojureScript just to mention few.
args: the rest of values from Robot Framework keyword call *args.
\n
logger: callback function that takes strings as arguments and writes them to robot log. Can be called multiple times.
\n
playwright: playwright module (* from \'playwright\'). Useful for integrating with Playwright features that Browser library doesn\'t support with it\'s own keywords. API docs
\n* Settings *\nLibrary Browser jsextension=${CURDIR}/module.js\n\n* Test Cases *\nHello\n New Page\n ${title}= myGoToKeyword https://playwright.dev\n Should be equal ${title} Playwright\n
\n
Also selector syntax can be extended with a custom selector using a js module
\n
Example module keyword for custom selector registering
\n
\nasync function registerMySelector(playwright) {\nplaywright.selectors.register("myselector", () => ({\n // Returns the first element matching given selector in the root\'s subtree.\n query(root, selector) {\n return root.querySelector(a[data-title="${selector}"]);\n },\n\n // Returns all elements matching given selector in the root\'s subtree.\n queryAll(root, selector) {\n return Array.from(root.querySelectorAll(a[data-title="${selector}"]));\n }\n}));\nreturn 1;\n}\nexports.__esModule = true;\nexports.registerMySelector = registerMySelector;\n
\n
Plugins
\n
Browser library offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating a new library or hacking the source code. See plugin API documentation for further details.
\n
Language
\n
Browser library offers possibility to translte keyword names and documentation to new language. If language is defined, Browser library will search from module search path Python packages starting with robotframework_browser_translation by using Python pluging API. Library is using naming convention to find Python plugins.
\n
The package must implement single API call, get_language without any arguments. Method must return a dictionary containing two keys: language and path. The language key value defines which language the package contains. Also value should match (case insentive) the library language import parameter. The path parameter value should be full path to the translation file.
\n
Translation file
\n
The file name or extension is not important, but data must be in json format. The keys of json are the methods names, not the keyword names, which implements keywords. Value of key is json object which contains two keys: name and doc. The name key contains the keyword translated name and doc contains translated documentation. Providing doc and name are optional, example translation json file can only provide translations to keyword names or only to documentatin. But it is always recomended to provide translation to both name and doc. Special key __intro__ is for class level documentation and __init__ is for init level documentation. These special values name can not be translated, instead name should be ketp same.
\n
Generating template translation file
\n
Template translation file, with English language can be created by running: rfbrowser translation /path/to/translation.json command. Command does not provide transltations to other languages, it only provides easy way to create full list kewyords and their documentation in correct format. It is also possible to add keywords from library plugins and js extenstions by providing --plugings and --jsextension arguments to command. Example: rfbrowser translation --plugings myplugin.SomePlugin --jsextension /path/ot/jsplugin.js /path/to/translation.json
Browser library can be taken into use with optional arguments:
\n
\n
\n
Argument
\n
Description
\n
\n
\n
auto_closing_level
\n
Configure context and page automatic closing. Default is TEST, for more details, see AutoClosingLevel
\n
\n
\n
enable_playwright_debug
\n
Enable low level debug information from the playwright to playwright-log.txt file. For more details, see PlaywrightLogTypes.
\n
\n
\n
enable_presenter_mode
\n
Automatic highlights the interacted components, slowMo and a small pause at the end. Can be enabled by giving True or can be customized by giving a dictionary: {"duration": "2 seconds", "width": "2px", "style": "dotted", "color": "blue"} Where duration is time format in Robot Framework format, defaults to 2 seconds. width is width of the marker in pixels, defaults the 2px. style is the style of border, defaults to dotted. color is the color of the marker, defaults to blue. By default, the call banner keyword is also enabled unless explicitly disabled.
\n
\n
\n
external_browser_executable
\n
Dict mapping name of browser to path of executable of a browser. Will make opening new browsers of the given type use the set executablePath. Currently only configuring of chromium to a separate executable (chrome, chromium and Edge executables all work with recent versions) works.
\n
\n
\n
jsextension
\n
Path to Javascript modules exposed as extra keywords. The modules must be in CommonJS. It can either be a single path, a comma-separated lists of path or a real list of strings
\n
\n
\n
playwright_process_port
\n
Experimental reusing of playwright process. playwright_process_port is preferred over environment variable ROBOT_FRAMEWORK_BROWSER_NODE_PORT. See Experimental: Re-using same node process for more details.
\n
\n
\n
plugins
\n
Allows extending the Browser library with external Python classes. Can either be a single class/module, a comma-separated list or a real list of strings
\n
\n
\n
retry_assertions_for
\n
Timeout for retrying assertions on keywords before failing the keywords. This timeout starts counting from the first failure. Global timeout will still be in effect. This allows stopping execution faster to assertion failure when element is found fast.
\n
\n
\n
run_on_failure
\n
Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword. If the keyword has arguments those must be separated with two spaces for example My keyword \\ arg1 \\ arg2. If no extra action should be done after a failure, set it to None or any other robot falsy value. Run on failure is not applied when library methods are executed directly from Python.
\n
\n
\n
selector_prefix
\n
Prefix for all selectors. This is useful when you need to use add an iframe selector before each selector.
\n
\n
\n
show_keyword_call_banner
\n
If set to True, will show a banner with the keyword name and arguments before the keyword is executed at the bottom of the page. If set to False, will not show the banner. If set to None, which is the default, will show the banner only if the presenter mode is enabled. Get Page Source and Take Screenshot will not show the banner, because that could negatively affect your test cases/tasks. This feature may be super helpful when you are debugging your tests and using tracing from New Context or Video recording features.
\n
\n
\n
strict
\n
If keyword selector points multiple elements and keywords should interact with one element, keyword will fail if strict mode is true. Strict mode can be changed individually in keywords or by `et Strict Mode`` keyword.
\n
\n
\n
timeout
\n
Timeout for keywords that operate on elements. The keywords will wait for this time for the element to appear into the page. Defaults to "10s" => 10 seconds.
\n
\n
\n
language
\n
Defines language which is used to translate keyword names and documentation.
Adds a cookie to currently active browser context.
\n
\n
\n
Arguments
\n
Description
\n
\n
\n
name
\n
Name of the cookie.
\n
\n
\n
value
\n
Given value for the cookie.
\n
\n
\n
url
\n
Given url for the cookie. Defaults to None. Either url or domain / path pair must be set.
\n
\n
\n
domain
\n
Given domain for the cookie. Defaults to None. Either url or domain / path pair must be set.
\n
\n
\n
path
\n
Given path for the cookie. Defaults to None. Either url or domain / path pair must be set.
\n
\n
\n
expires
\n
Given expiry for the cookie. Can be of date format or unix time. Supports the same formats as the DateTime library or an epoch timestamp. - example: 2027-09-28 16:21:35