Class RobotFrameworkCamelConfiguration

  • All Implemented Interfaces:
    Cloneable

    @UriParams
    public class RobotFrameworkCamelConfiguration
    extends Object
    implements Cloneable
    • Constructor Detail

      • RobotFrameworkCamelConfiguration

        public RobotFrameworkCamelConfiguration()
    • Method Detail

      • getName

        public String getName()
      • getDocument

        public String getDocument()
      • getMetadata

        public String getMetadata()
      • getTags

        public String getTags()
      • getTests

        public String getTests()
      • getSuites

        public String getSuites()
      • getIncludes

        public String getIncludes()
      • getExcludes

        public String getExcludes()
      • getCriticalTags

        public String getCriticalTags()
      • getNonCriticalTags

        public String getNonCriticalTags()
      • getRunMode

        public String getRunMode()
      • isDryrun

        public boolean isDryrun()
      • isSkipTeardownOnExit

        public boolean isSkipTeardownOnExit()
      • isExitOnFailure

        public boolean isExitOnFailure()
      • getRandomize

        public String getRandomize()
      • getVariables

        public String getVariables()
      • getVariableFiles

        public String getVariableFiles()
      • getOutputDirectory

        public File getOutputDirectory()
      • getOutput

        public File getOutput()
      • getLog

        public File getLog()
      • getReport

        public File getReport()
      • getXunitFile

        public File getXunitFile()
      • getDebugFile

        public File getDebugFile()
      • isTimestampOutputs

        public boolean isTimestampOutputs()
      • getSplitOutputs

        public String getSplitOutputs()
      • getLogTitle

        public String getLogTitle()
      • getReportTitle

        public String getReportTitle()
      • getSummaryTitle

        public String getSummaryTitle()
      • getReportBackground

        public String getReportBackground()
      • getLogLevel

        public String getLogLevel()
      • getSuiteStatLevel

        public String getSuiteStatLevel()
      • getTagStatIncludes

        public String getTagStatIncludes()
      • getTagStatExcludes

        public String getTagStatExcludes()
      • getCombinedTagStats

        public String getCombinedTagStats()
      • getTagDocs

        public String getTagDocs()
      • getTagStatLinks

        public String getTagStatLinks()
      • getListeners

        public String getListeners()
      • getListener

        public String getListener()
      • isWarnOnSkippedFiles

        public boolean isWarnOnSkippedFiles()
      • getMonitorWidth

        public String getMonitorWidth()
      • getMonitorColors

        public String getMonitorColors()
      • getArgumentFile

        public File getArgumentFile()
      • isRunEmptySuite

        public boolean isRunEmptySuite()
      • getRunFailed

        public File getRunFailed()
      • isNoStatusReturnCode

        public boolean isNoStatusReturnCode()
      • setName

        public void setName​(String name)
        Sets the name of the top-level tests suites.
      • setDocument

        public void setDocument​(String document)
        Sets the documentation of the top-level tests suites.
      • setMetadata

        public void setMetadata​(String metadata)
        Sets free metadata for the top level tests suites. comma seperated list of string resulting as List
      • setTags

        public void setTags​(String tags)
        Sets the tags(s) to all executed tests cases. List
      • setTests

        public void setTests​(String tests)
        Selects the tests cases by name. List
      • setSuites

        public void setSuites​(String suites)
        Selects the tests suites by name. List
      • setIncludes

        public void setIncludes​(String includes)
        Selects the tests cases by tags. List
      • setExcludes

        public void setExcludes​(String excludes)
        Selects the tests cases by tags. List
      • setCriticalTags

        public void setCriticalTags​(String criticalTags)
        Tests that have the given tags are considered critical. List
      • setNonCriticalTags

        public void setNonCriticalTags​(String nonCriticalTags)
        Tests that have the given tags are not critical. List
      • setRunMode

        public void setRunMode​(String runMode)
        Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead.
      • setDryrun

        public void setDryrun​(boolean dryrun)
        Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax.
      • setSkipTeardownOnExit

        public void setSkipTeardownOnExit​(boolean skipTeardownOnExit)
        Sets whether the teardowns are skipped if the test execution is prematurely stopped.
      • setExitOnFailure

        public void setExitOnFailure​(boolean exitOnFailure)
        Sets robot to stop execution immediately if a critical test fails.
      • setRandomize

        public void setRandomize​(String randomize)
        Sets the test execution order to be randomized. Valid values are all, suite, and test
      • setVariables

        public void setVariables​(String variables)
        Sets individual variables. Use the format "name:value" List
      • setVariableFiles

        public void setVariableFiles​(String variableFiles)
        Sets variables using variables files. Use the format "path:args" List
      • setOutputDirectory

        public void setOutputDirectory​(File outputDirectory)
        Configures where generated reports are to be placed.
      • setOutput

        public void setOutput​(File output)
        Sets the path to the generated output file.
      • setLog

        public void setLog​(File log)
        Sets the path to the generated log file.
      • setReport

        public void setReport​(File report)
        Sets the path to the generated report file.
      • setXunitFile

        public void setXunitFile​(File xunitFile)
        Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores.
      • setDebugFile

        public void setDebugFile​(File debugFile)
        A debug file that is written during execution.
      • setTimestampOutputs

        public void setTimestampOutputs​(boolean timestampOutputs)
        Adds a timestamp to all output files.
      • setSplitOutputs

        public void setSplitOutputs​(String splitOutputs)
        Splits output and log files.
      • setLogTitle

        public void setLogTitle​(String logTitle)
        Sets a title for the generated tests log.
      • setReportTitle

        public void setReportTitle​(String reportTitle)
        Sets a title for the generated tests report.
      • setSummaryTitle

        public void setSummaryTitle​(String summaryTitle)
        Sets a title for the generated summary report.
      • setReportBackground

        public void setReportBackground​(String reportBackground)
        Sets background colors for the generated report and summary.
      • setLogLevel

        public void setLogLevel​(String logLevel)
        Sets the threshold level for logging.
      • setSuiteStatLevel

        public void setSuiteStatLevel​(String suiteStatLevel)
        Defines how many levels to show in the Statistics by Suite table in outputs.
      • setTagStatIncludes

        public void setTagStatIncludes​(String tagStatIncludes)
        Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List
      • setTagStatExcludes

        public void setTagStatExcludes​(String tagStatExcludes)
        Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List
      • setCombinedTagStats

        public void setCombinedTagStats​(String combinedTagStats)
        Creates combined statistics based on tags. Use the format "tags:title" List
      • setTagDocs

        public void setTagDocs​(String tagDocs)
        Adds documentation to the specified tags. List
      • setTagStatLinks

        public void setTagStatLinks​(String tagStatLinks)
        Adds external links to the Statistics by Tag table in outputs. Use the format "pattern:link:title" List
      • setListeners

        public void setListeners​(String listeners)
        Sets multiple listeners for monitoring tests execution. Use the format "ListenerWithArgs:arg1:arg2" or simply "ListenerWithoutArgs" List
      • setListener

        public void setListener​(String listener)
        Sets a single listener for monitoring tests execution
      • setWarnOnSkippedFiles

        public void setWarnOnSkippedFiles​(boolean warnOnSkippedFiles)
        Show a warning when an invalid file is skipped.
      • setMonitorWidth

        public void setMonitorWidth​(String monitorWidth)
        Width of the monitor output. Default is 78.
      • setMonitorColors

        public void setMonitorColors​(String monitorColors)
        Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'.
        • 'on' - use colors in unixes but not in Windows
        • 'off' - never use colors
        • 'force' - always use colors (also in Windows)
      • setArgumentFile

        public void setArgumentFile​(File argumentFile)
        A text file to read more arguments from.
      • setRunEmptySuite

        public void setRunEmptySuite​(boolean runEmptySuite)
        Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition.
      • setRunFailed

        public void setRunFailed​(File runFailed)
        Re-run failed tests, based on output.xml file.
      • setNoStatusReturnCode

        public void setNoStatusReturnCode​(boolean noStatusReturnCode)
        If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
      • isAllowTemplateFromHeader

        public boolean isAllowTemplateFromHeader()
      • setAllowTemplateFromHeader

        public void setAllowTemplateFromHeader​(boolean allowTemplateFromHeader)
        Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care.
      • isAllowContextMapAll

        public boolean isAllowContextMapAll()
      • setAllowContextMapAll

        public void setAllowContextMapAll​(boolean allowContextMapAll)
        Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API.