Package 

Class RebotRobotConfiguration

    • Constructor Detail

      • RebotRobotConfiguration

        RebotRobotConfiguration(Project project)

    • Method Detail

      • getMerge

         final Property<Boolean> getMerge()

        When combining results, merge outputs together instead of putting them under a new top level suite. Default-value=false.

      • getProcessEmptySuite

         final Property<Boolean> getProcessEmptySuite()

        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.

      • getExpandKeywords

         final List<String> getExpandKeywords()

        Syntax: name:&lt;pattern&gt;|tag:&lt;pattern&gt;

        Matching keywords will be automatically expanded in the log file. Matching against keyword name or tags work using same rules as with removeKeywords.

        Examples:

        expandkeywords = listOf("name:BuiltIn.Log")
expandkeywords = listOf("tag:expand")

      • setExpandKeywords

         final Unit setExpandKeywords(List<String> expandKeywords)

        Syntax: name:&lt;pattern&gt;|tag:&lt;pattern&gt;

        Matching keywords will be automatically expanded in the log file. Matching against keyword name or tags work using same rules as with removeKeywords.

        Examples:

        expandkeywords = listOf("name:BuiltIn.Log")
expandkeywords = listOf("tag:expand")

      • getStartTime

         final Property<String> getStartTime()

        Set execution start time. Timestamp must be given in format 2007-10-01 15:12:42.268 where all separators are optional (e.g. 20071001151242268 is ok too) and parts from milliseconds to hours can be omitted if they are zero (e.g. 2007-10-01). This can be used to override start time of a single suite or to set start time for a combined suite, which would otherwise be N/A.

      • setStartTime

         final Unit setStartTime(Property<String> startTime)

        Set execution start time. Timestamp must be given in format 2007-10-01 15:12:42.268 where all separators are optional (e.g. 20071001151242268 is ok too) and parts from milliseconds to hours can be omitted if they are zero (e.g. 2007-10-01). This can be used to override start time of a single suite or to set start time for a combined suite, which would otherwise be N/A.

      • getEndTime

         final Property<String> getEndTime()

        Same as startTime but for end time. If both options are used, elapsed time of the suite is calculated based on them. For combined suites, it is otherwise calculated by adding elapsed times of the combined suites together.

      • setEndTime

         final Unit setEndTime(Property<String> endTime)

        Same as startTime but for end time. If both options are used, elapsed time of the suite is calculated based on them. For combined suites, it is otherwise calculated by adding elapsed times of the combined suites together.

      • getRpa

         final Property<Boolean> getRpa()

        Turn on the generic automation mode (aka Robot Process Automation). Mainly affects terminology so that "test" is replaced with "task" in logs and reports. By default the mode is got from the processed output files.

      • setRpa

         final Unit setRpa(Property<Boolean> rpa)

        Turn on the generic automation mode (aka Robot Process Automation). Mainly affects terminology so that "test" is replaced with "task" in logs and reports. By default the mode is got from the processed output files.

      • getDoc

         final Property<String> getDoc()

        Set the documentation of the top level suite. Simple formatting is supported (e.g. &#42;bold&#42;). If the documentation contains spaces, it must be quoted.

            doc = "Very *good* example"

      • setDoc

         final Unit setDoc(Property<String> doc)

        Set the documentation of the top level suite. Simple formatting is supported (e.g. &#42;bold&#42;). If the documentation contains spaces, it must be quoted.

            doc = "Very *good* example"

      • getMetaData

         final Map<String, String> getMetaData()

        Set metadata of the top level suite. Value can contain formatting similarly as doc.

            metaData = mapOf("Version" to "1.2")

      • setMetaData

         final Unit setMetaData(Map<String, String> metaData)

        Set metadata of the top level suite. Value can contain formatting similarly as doc.

            metaData = mapOf("Version" to "1.2")

      • getTest

         final List<String> getTest()

        Select tests by name or by long name containing also parent suite name like Parent.Test. Name is case and space insensitive and it can also be a simple pattern where * matches anything, ? matches any single character, and [chars] matches one character in brackets.

      • setTest

         final Unit setTest(List<String> test)

        Select tests by name or by long name containing also parent suite name like Parent.Test. Name is case and space insensitive and it can also be a simple pattern where * matches anything, ? matches any single character, and [chars] matches one character in brackets.

      • getSuite

         final List<String> getSuite()

        Select suites by name. When this option is used with test, include or exclude, only tests in matching suites and also matching other filtering criteria are selected. Name can be a simple pattern similarly as with test and it can contain parent name separated with a dot. For example, suite = "X.Y" selects suite Y only if its parent is X.

      • setSuite

         final Unit setSuite(List<String> suite)

        Select suites by name. When this option is used with test, include or exclude, only tests in matching suites and also matching other filtering criteria are selected. Name can be a simple pattern similarly as with test and it can contain parent name separated with a dot. For example, suite = "X.Y" selects suite Y only if its parent is X.

      • getInclude

         final List<String> getInclude()

        Select tests by tag. Similarly as name with test, tag is case and space insensitive and it is possible to use patterns with *, ? and [] as wildcards. Tags and patterns can also be combined together with AND, OR, and NOT operators.

            include = listOf("foo", "bar*")
    include = "fooANDbar*"

      • setInclude

         final Unit setInclude(List<String> include)

        Select tests by tag. Similarly as name with test, tag is case and space insensitive and it is possible to use patterns with *, ? and [] as wildcards. Tags and patterns can also be combined together with AND, OR, and NOT operators.

            include = listOf("foo", "bar*")
    include = "fooANDbar*"

      • getExclude

         final List<String> getExclude()

        Specify tests not to be included by tag. They are not selected even if included with include. Tags are matched using same rules as with include.

      • setExclude

         final Unit setExclude(List<String> exclude)

        Specify tests not to be included by tag. They are not selected even if included with include. Tags are matched using same rules as with include.

      • getOutputDir

         final DirectoryProperty getOutputDir()

        Where to create output files. The given path is considered relative to command execution directory unless it is absolute.

        Default: ${project.buildDir}/reports/robotframework.

      • getOutput

         final File getOutput()

        XML output file. Not created unless this option is specified. Given path, similarly as paths given to log, report and xUnit, is relative to outputDir unless given as an absolute path.

      • setOutput

         final Unit setOutput(File output)

        XML output file. Not created unless this option is specified. Given path, similarly as paths given to log, report and xUnit, is relative to outputDir unless given as an absolute path.

      • getLog

         final File getLog()

        HTML log file. Can be disabled by passing null.

        Default: log.html

            log = "mylog.html"
    log = null

      • setLog

         final Unit setLog(File log)

        HTML log file. Can be disabled by passing null.

        Default: log.html

            log = "mylog.html"
    log = null

      • getReport

         final File getReport()

        HTML report file. Can be disabled by passing null similarly as log.

        Default: report.html

      • setReport

         final Unit setReport(File report)

        HTML report file. Can be disabled by passing null similarly as log.

        Default: report.html

      • getXUnit

         final File getXUnit()

        xUnit compatible result file. Not created unless this option is specified. Will be stored under outputDir. Default: robot-xunit-results.xml

      • setXUnit

         final Unit setXUnit(File xUnit)

        xUnit compatible result file. Not created unless this option is specified. Will be stored under outputDir. Default: robot-xunit-results.xml

      • getXUnitSkipNonCritical

         final Property<Boolean> getXUnitSkipNonCritical()

        Has no effect anymore.

        Mark non-critical tests in xUnit output as skipped.

        Default: disabled (false)

      • setXUnitSkipNonCritical

         final Unit setXUnitSkipNonCritical(@Deprecated(message = Since RF 4.0) Property<Boolean> xUnitSkipNonCritical)

        Has no effect anymore.

        Mark non-critical tests in xUnit output as skipped.

        Default: disabled (false)

      • getTimestampOutputs

         final Property<Boolean> getTimestampOutputs()

        When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension.

            timestampOutputs = true
    output = "output.xml"
    report = "report.html"
    log = null

        creates files like output-20070503-154410.xml and report-20070503-154410.html.

        Default: false

      • setTimestampOutputs

         final Unit setTimestampOutputs(Property<Boolean> timestampOutputs)

        When this option is used, timestamp in a format YYYYMMDD-hhmmss is added to all generated output files between their basename and extension.

            timestampOutputs = true
    output = "output.xml"
    report = "report.html"
    log = null

        creates files like output-20070503-154410.xml and report-20070503-154410.html.

        Default: false

      • getSplit

         final Property<Boolean> getSplit()

        Split the log file into smaller pieces that open in browsers transparently.

        Default: false

      • setSplit

         final Unit setSplit(Property<Boolean> split)

        Split the log file into smaller pieces that open in browsers transparently.

        Default: false

      • getLogTitle

         final Property<String> getLogTitle()

        Title for the generated log file. The default title is <SuiteName> Test Log.

      • setLogTitle

         final Unit setLogTitle(Property<String> logTitle)

        Title for the generated log file. The default title is <SuiteName> Test Log.

      • getReportTitle

         final Property<String> getReportTitle()

        Title for the generated report file. The default title is <SuiteName> Test Report.

      • setReportTitle

         final Unit setReportTitle(Property<String> reportTitle)

        Title for the generated report file. The default title is <SuiteName> Test Report.

      • getReportBackground

         final Property<String> getReportBackground()

        Background colors to use in the report file. Order is passed:failed:skipped. Both color names and codes work. skipped can be omitted.

            reportBackground = "green:red:yellow"
    reportBackground = "#00E:#E00"

      • setReportBackground

         final Unit setReportBackground(Property<String> reportBackground)

        Background colors to use in the report file. Order is passed:failed:skipped. Both color names and codes work. skipped can be omitted.

            reportBackground = "green:red:yellow"
    reportBackground = "#00E:#E00"

      • getLogLevel

         final Property<String> getLogLevel()

        The threshold level for logging. Threshold for selecting messages. Available levels: TRACE (default), DEBUG, INFO, WARN, NONE (no msgs). Use syntax LOGLEVEL:DEFAULT to define the default visible log level in log files.

            logLevel = "DEBUG"
    logLevel = "DEBUG:INFO"

      • setLogLevel

         final Unit setLogLevel(Property<String> logLevel)

        The threshold level for logging. Threshold for selecting messages. Available levels: TRACE (default), DEBUG, INFO, WARN, NONE (no msgs). Use syntax LOGLEVEL:DEFAULT to define the default visible log level in log files.

            logLevel = "DEBUG"
    logLevel = "DEBUG:INFO"

      • getSuiteStatLevel

         final Property<Integer> getSuiteStatLevel()

        How many levels to show in Statistics by Suite in log and report. By default all suite levels are shown.

            suiteStatLevel = 3

      • setSuiteStatLevel

         final Unit setSuiteStatLevel(Property<Integer> suiteStatLevel)

        How many levels to show in Statistics by Suite in log and report. By default all suite levels are shown.

            suiteStatLevel = 3

      • getTagStatInclude

         final List<String> getTagStatInclude()

        Include only matching tags in Statistics by Tag in log and report. By default all tags are shown. Given tag can be a pattern like with include.

      • setTagStatInclude

         final Unit setTagStatInclude(List<String> tagStatInclude)

        Include only matching tags in Statistics by Tag in log and report. By default all tags are shown. Given tag can be a pattern like with include.

      • getTagStatCombine

         final Map<String, String> getTagStatCombine()

        Create combined statistics based on tags. These statistics are added into Statistics by Tag. If the optional name is not given, name of the combined tag is got from the specified tags. Tags are matched using the same rules as with include.

            tagstatcombine = mapOf("requirement-*" to null)
    tagstatcombine = mapOf("tag1ANDtag2" to "My_name")

      • setTagStatCombine

         final Unit setTagStatCombine(Map<String, String> tagStatCombine)

        Create combined statistics based on tags. These statistics are added into Statistics by Tag. If the optional name is not given, name of the combined tag is got from the specified tags. Tags are matched using the same rules as with include.

            tagstatcombine = mapOf("requirement-*" to null)
    tagstatcombine = mapOf("tag1ANDtag2" to "My_name")

      • getTagDoc

         final Map<String, String> getTagDoc()

        Add documentation to tags matching the given 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.

            tagDoc = mapOf("mytag" to "Example")
    tagDoc = mapOf("owner-*" to "Original author")

      • setTagDoc

         final Unit setTagDoc(Map<String, String> tagDoc)

        Add documentation to tags matching the given 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.

            tagDoc = mapOf("mytag" to "Example")
    tagDoc = mapOf("owner-*" to "Original author")

      • getTagStatLink

         final List<String> getTagStatLink()

        Add external links into Statistics by Tag. Pattern can use *, ? and [] as wildcards like test. Characters matching to * and ? wildcards can be used in link and title with syntax %N, where N is index of the match (starting from 1).

            tagStatLink = listOf("mytag:http://my.domain:Title")
    tagStatLink = listOf("bug-*:http://url/id=%1:Issue Tracker")

      • setTagStatLink

         final Unit setTagStatLink(List<String> tagStatLink)

        Add external links into Statistics by Tag. Pattern can use *, ? and [] as wildcards like test. Characters matching to * and ? wildcards can be used in link and title with syntax %N, where N is index of the match (starting from 1).

            tagStatLink = listOf("mytag:http://my.domain:Title")
    tagStatLink = listOf("bug-*:http://url/id=%1:Issue Tracker")

      • getRemoveKeywords

         final List<String> getRemoveKeywords()

        Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.

        • ALL - Remove data from all keywords unconditionally.

        • PASSED -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.

        • FOR - Remove all passed iterations from for loops except the last one.

        • WUKS - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.

        • NAME:<pattern> - Remove data from all keywords matching the given pattern regardless the keyword status.

        • TAG:<pattern> - Remove data from keywords with tags that match the given pattern.

        The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.

      • setRemoveKeywords

         final Unit setRemoveKeywords(List<String> removeKeywords)

        Remove keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#removing-keywords.

        • ALL - Remove data from all keywords unconditionally.

        • PASSED -Remove keyword data from passed test cases. In most cases, log files created using this option contain enough information to investigate possible failures.

        • FOR - Remove all passed iterations from for loops except the last one.

        • WUKS - Remove all failing keywords inside BuiltIn keyword 'Wait Until Keyword Succeeds' except the last one.

        • NAME:<pattern> - Remove data from all keywords matching the given pattern regardless the keyword status.

        • TAG:<pattern> - Remove data from keywords with tags that match the given pattern.

        The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.

      • getFlattenKeywords

         final List<String> getFlattenKeywords()

        Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.

        • FOR - Flatten for loops fully.

        • FORITEM - Flatten individual for loop iterations.

        • NAME:<pattern> - Flatten keywords matching the given pattern.

        • TAG:<pattern> - Flatten keywords with tags matching the given pattern.

        The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.

      • setFlattenKeywords

         final Unit setFlattenKeywords(List<String> flattenKeywords)

        Flatten keywords and their messages altogether. Instructions at http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#flattening-keywords.

        • FOR - Flatten for loops fully.

        • FORITEM - Flatten individual for loop iterations.

        • NAME:<pattern> - Flatten keywords matching the given pattern.

        • TAG:<pattern> - Flatten keywords with tags matching the given pattern.

        The <pattern> is case, space, and underscore insensitive, and it supports simple patterns with * and ? as wildcards.

      • getNoStatusSrc

         final Property<Boolean> getNoStatusSrc()

        Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.

      • setNoStatusSrc

         final Unit setNoStatusSrc(Property<Boolean> noStatusSrc)

        Sets the return code to zero regardless of failures in test cases. Error codes are returned normally.

      • getConsoleColors

         final Property<String> getConsoleColors()

        Use colors on console output or not.

        • auto: use colors when output not redirected (default)

        • on: always use colors

        • ansi: like on but use ANSI colors also on Windows

        • off: disable colors altogether Note that colors do not work with Jython on Windows.

      • setConsoleColors

         final Unit setConsoleColors(Property<String> consoleColors)

        Use colors on console output or not.

        • auto: use colors when output not redirected (default)

        • on: always use colors

        • ansi: like on but use ANSI colors also on Windows

        • off: disable colors altogether Note that colors do not work with Jython on Windows.

      • getArgumentFiles

         final List<String> getArgumentFiles()

        Text file to read more arguments from. Use special path STDIN to read contents from the standard input stream. File can have both options and input files or directories, one per line. Contents do not need to be escaped but spaces in the beginning and end of lines are removed. Empty lines and lines starting with a hash character (#) are ignored.

            --include regression
    --name Regression Tests
    # This is a comment line
    my_tests.robot
    path/to/test/directory/
            argumentFile = "argfile.txt"
    argumentFile = "STDIN"

      • setArgumentFiles

         final Unit setArgumentFiles(List<String> argumentFiles)

        Text file to read more arguments from. Use special path STDIN to read contents from the standard input stream. File can have both options and input files or directories, one per line. Contents do not need to be escaped but spaces in the beginning and end of lines are removed. Empty lines and lines starting with a hash character (#) are ignored.

            --include regression
    --name Regression Tests
    # This is a comment line
    my_tests.robot
    path/to/test/directory/
            argumentFile = "argfile.txt"
    argumentFile = "STDIN"

      • getName

         final Property<String> getName()

        Sets the name of the documented library or resource.

      • getAdditionalPythonPaths

         final ConfigurableFileCollection getAdditionalPythonPaths()

        Additional locations where to search for libraries and resources. e.g. src/main/java/com/test/

      • setAdditionalPythonPaths

         final Unit setAdditionalPythonPaths(ConfigurableFileCollection additionalPythonPaths)

        Additional locations where to search for libraries and resources. e.g. src/main/java/com/test/