Robot Framework Integrated Development Environment (RIDE)
robotide.lib.robot.running.builder.TestSuiteBuilder Class Reference

Creates executable :class:~robot.running.model.TestSuite objects. More...

Public Member Functions

def __init__ (self, include_suites=None, warn_on_skipped='DEPRECATED', extension=None, rpa=None)
 :param include_suites: List of suite names to include. More...
 
def build (self, *paths)
 :param paths: Paths to test data files or directories. More...
 

Public Attributes

 extensions
 
 include_suites
 
 rpa
 

Private Member Functions

def _build_setup (self, parent, data)
 
def _build_suite (self, data, parent_defaults=None)
 
def _build_teardown (self, parent, data)
 
def _build_test (self, suite, data, defaults)
 
def _check_deprecated_extensions (self, source)
 
def _get_extensions (self, extension)
 
def _get_metadata (self, settings)
 
def _get_template (self, template)
 
def _get_timeout (self, timeout)
 
def _parse (self, path)
 
def _parse_and_build (self, path)
 
def _set_execution_mode (self, data)
 

Private Attributes

 _build_step
 
 _build_steps
 
 _rpa_not_given
 

Detailed Description

Creates executable :class:~robot.running.model.TestSuite objects.

Suites are build based on existing test data on the file system.

See the overall documentation of the :mod:`robot.running` package for
more information and examples.

Definition at line 36 of file builder.py.

Constructor & Destructor Documentation

◆ __init__()

def robotide.lib.robot.running.builder.TestSuiteBuilder.__init__ (   self,
  include_suites = None,
  warn_on_skipped = 'DEPRECATED',
  extension = None,
  rpa = None 
)

:param include_suites: List of suite names to include.

If None or an empty list, all suites are included. When executing tests normally, these names are specified using the --suite option. :param warn_on_skipped: Deprecated. :param extension: Limit parsing test data to only these files. Files are specified as an extension that is handled case-insensitively. Same as --extension on the command line. :param rpa: Explicit test execution mode. True for RPA and False for test automation. By default mode is got from test data headers and possible conflicting headers cause an error.

Definition at line 50 of file builder.py.

Member Function Documentation

◆ _build_setup()

def robotide.lib.robot.running.builder.TestSuiteBuilder._build_setup (   self,
  parent,
  data 
)
private

Definition at line 167 of file builder.py.

◆ _build_suite()

def robotide.lib.robot.running.builder.TestSuiteBuilder._build_suite (   self,
  data,
  parent_defaults = None 
)
private

Definition at line 100 of file builder.py.

◆ _build_teardown()

def robotide.lib.robot.running.builder.TestSuiteBuilder._build_teardown (   self,
  parent,
  data 
)
private

Definition at line 171 of file builder.py.

◆ _build_test()

def robotide.lib.robot.running.builder.TestSuiteBuilder._build_test (   self,
  suite,
  data,
  defaults 
)
private

Definition at line 149 of file builder.py.

◆ _check_deprecated_extensions()

def robotide.lib.robot.running.builder.TestSuiteBuilder._check_deprecated_extensions (   self,
  source 
)
private

Definition at line 131 of file builder.py.

◆ _get_extensions()

def robotide.lib.robot.running.builder.TestSuiteBuilder._get_extensions (   self,
  extension 
)
private

Definition at line 64 of file builder.py.

◆ _get_metadata()

def robotide.lib.robot.running.builder.TestSuiteBuilder._get_metadata (   self,
  settings 
)
private

Definition at line 145 of file builder.py.

◆ _get_template()

def robotide.lib.robot.running.builder.TestSuiteBuilder._get_template (   self,
  template 
)
private

Definition at line 164 of file builder.py.

◆ _get_timeout()

def robotide.lib.robot.running.builder.TestSuiteBuilder._get_timeout (   self,
  timeout 
)
private

Definition at line 161 of file builder.py.

◆ _parse()

def robotide.lib.robot.running.builder.TestSuiteBuilder._parse (   self,
  path 
)
private

Definition at line 92 of file builder.py.

◆ _parse_and_build()

def robotide.lib.robot.running.builder.TestSuiteBuilder._parse_and_build (   self,
  path 
)
private

Definition at line 87 of file builder.py.

◆ _set_execution_mode()

def robotide.lib.robot.running.builder.TestSuiteBuilder._set_execution_mode (   self,
  data 
)
private

Definition at line 119 of file builder.py.

◆ build()

def robotide.lib.robot.running.builder.TestSuiteBuilder.build (   self,
paths 
)

:param paths: Paths to test data files or directories.

:return: :class:~robot.running.model.TestSuite instance.

Definition at line 76 of file builder.py.

Member Data Documentation

◆ _build_step

robotide.lib.robot.running.builder.TestSuiteBuilder._build_step
private

Definition at line 56 of file builder.py.

◆ _build_steps

robotide.lib.robot.running.builder.TestSuiteBuilder._build_steps
private

Definition at line 55 of file builder.py.

◆ _rpa_not_given

robotide.lib.robot.running.builder.TestSuiteBuilder._rpa_not_given
private

Definition at line 58 of file builder.py.

◆ extensions

robotide.lib.robot.running.builder.TestSuiteBuilder.extensions

Definition at line 53 of file builder.py.

◆ include_suites

robotide.lib.robot.running.builder.TestSuiteBuilder.include_suites

Definition at line 52 of file builder.py.

◆ rpa

robotide.lib.robot.running.builder.TestSuiteBuilder.rpa

Definition at line 57 of file builder.py.


The documentation for this class was generated from the following file: