robot.running.builder package

Submodules

robot.running.builder.builders module

class robot.running.builder.builders.TestSuiteBuilder(included_suites=None, included_extensions=('robot', ), rpa=None, allow_empty_suite=False, process_curdir=True)

Bases: object

Builder to construct TestSuite objects based on data on the disk.

The build() method constructs executable TestSuite objects based on test data files or directories. There are two main use cases for this API:

• Execute the created suite by using its run() method. The suite can be can be 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 parsing APIs but does not allow saving modified data back to the disk.

Both modifying the suite and inspecting what data it contains are easiest done by using the visitor interface.

This class is part of the public API and should be imported via the robot.api package.

Parameters:

• 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.
• included_extensions – List of extensions of files to parse. Same as –extension.
• 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.
• allow_empty_suite – Specify is it an error if the built suite contains no tests. Same as –runemptysuite.
• 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.

build(*paths)

Parameters:paths – Paths to test data files or directories. Returns:TestSuite instance.

class robot.running.builder.builders.SuiteStructureParser(included_extensions, rpa=None, process_curdir=True)

Bases: robot.parsing.suitestructure.SuiteStructureVisitor

parse(structure)

visit_file(structure)

start_directory(structure)

end_directory(structure)

visit_directory(structure)

class robot.running.builder.builders.ResourceFileBuilder(process_curdir=True)

Bases: object

build(source)

robot.running.builder.parsers module

class robot.running.builder.parsers.BaseParser

Bases: object

parse_init_file(source, defaults=None)

parse_suite_file(source, defaults=None)

parse_resource_file(source)

class robot.running.builder.parsers.RobotParser(process_curdir=True)

Bases: robot.running.builder.parsers.BaseParser

parse_init_file(source, defaults=None)

parse_suite_file(source, defaults=None)

build_suite(model, name=None, defaults=None)

parse_resource_file(source)

class robot.running.builder.parsers.RestParser(process_curdir=True)

Bases: robot.running.builder.parsers.RobotParser

build_suite(model, name=None, defaults=None)

parse_init_file(source, defaults=None)

parse_resource_file(source)

parse_suite_file(source, defaults=None)

class robot.running.builder.parsers.NoInitFileDirectoryParser

Bases: robot.running.builder.parsers.BaseParser

parse_init_file(source, defaults=None)

parse_resource_file(source)

parse_suite_file(source, defaults=None)

robot.running.builder.parsers.format_name(source)

class robot.running.builder.parsers.ErrorReporter(source)

Bases: ast.NodeVisitor

visit_Error(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

robot.running.builder.testsettings module

class robot.running.builder.testsettings.TestDefaults(parent=None)

Bases: object

setup

teardown

force_tags

timeout

class robot.running.builder.testsettings.TestSettings(defaults)

Bases: object

setup

teardown

timeout

template

tags

robot.running.builder.transformers module

class robot.running.builder.transformers.SettingsBuilder(suite, test_defaults)

Bases: ast.NodeVisitor

visit_Documentation(node)

visit_Metadata(node)

visit_SuiteSetup(node)

visit_SuiteTeardown(node)

visit_TestSetup(node)

visit_TestTeardown(node)

visit_TestTimeout(node)

visit_DefaultTags(node)

visit_ForceTags(node)

visit_TestTemplate(node)

visit_ResourceImport(node)

visit_LibraryImport(node)

visit_VariablesImport(node)

visit_VariableSection(node)

visit_TestCaseSection(node)

visit_KeywordSection(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.SuiteBuilder(suite, test_defaults)

Bases: ast.NodeVisitor

visit_SettingSection(node)

visit_Variable(node)

visit_TestCase(node)

visit_Keyword(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.ResourceBuilder(resource)

Bases: ast.NodeVisitor

visit_Documentation(node)

visit_LibraryImport(node)

visit_ResourceImport(node)

visit_VariablesImport(node)

visit_Variable(node)

visit_Keyword(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.TestCaseBuilder(suite, defaults)

Bases: ast.NodeVisitor

visit_TestCase(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

visit_TemplateArguments(node)

visit_Documentation(node)

visit_Setup(node)

visit_Teardown(node)

visit_Timeout(node)

visit_Tags(node)

visit_Template(node)

visit_KeywordCall(node)

visit_ReturnStatement(node)

visit_Continue(node)

visit_Break(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.KeywordBuilder(resource)

Bases: ast.NodeVisitor

visit_Keyword(node)

visit_Documentation(node)

visit_Arguments(node)

visit_Tags(node)

visit_Return(node)

visit_Timeout(node)

visit_Teardown(node)

visit_KeywordCall(node)

visit_ReturnStatement(node)

visit_Continue(node)

visit_Break(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.ForBuilder(parent)

Bases: ast.NodeVisitor

build(node)

visit_KeywordCall(node)

visit_TemplateArguments(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

visit_ReturnStatement(node)

visit_Continue(node)

visit_Break(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.IfBuilder(parent)

Bases: ast.NodeVisitor

build(node)

visit_KeywordCall(node)

visit_TemplateArguments(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

visit_ReturnStatement(node)

visit_Continue(node)

visit_Break(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.TryBuilder(parent)

Bases: ast.NodeVisitor

build(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

visit_ReturnStatement(node)

visit_Continue(node)

visit_Break(node)

visit_KeywordCall(node)

visit_TemplateArguments(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

class robot.running.builder.transformers.WhileBuilder(parent)

Bases: ast.NodeVisitor

build(node)

visit_KeywordCall(node)

visit_TemplateArguments(node)

visit_For(node)

visit_While(node)

visit_If(node)

visit_Try(node)

visit_ReturnStatement(node)

visit_Break(node)

visit_Continue(node)

generic_visit(node)

Called if no explicit visitor function exists for a node.

visit(node)

Visit a node.

robot.running.builder.transformers.format_error(errors)