Robot Framework

Pass camel exchanges to acceptance test written in Robot DSL.

Metadata

Property	Value
Scheme	`robotframework`
Support Level	Stable
Labels	testing
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-robotframework</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`resourceUri`	string	✓		Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod.
`allowContextMapAll`	boolean		`false`	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.
`allowTemplateFromHeader`	boolean		`false`	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.
`argumentFiles`	string			A text String to read more arguments from.
`combinedTagStats`	string			Creates combined statistics based on tags. Use the format tags:title List
`contentCache`	boolean		`false`	Sets whether to use resource content cache or not
`criticalTags`	string			Tests that have the given tags are considered critical. List
`debugFile`	string			A debug String that is written during execution.
`document`	string			Sets the documentation of the top-level tests suites.
`dryrun`	boolean		`false`	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.
`excludes`	string			Selects the tests cases by tags. List
`exitOnFailure`	boolean		`false`	Sets robot to stop execution immediately if a critical test fails.
`includes`	string			Selects the tests cases by tags. List
`listener`	string			Sets a single listener for monitoring tests execution
`listeners`	string			Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List
`log`	string			Sets the path to the generated log String.
`logLevel`	string			Sets the threshold level for logging.
`logTitle`	string			Sets a title for the generated tests log.
`metadata`	string			Sets free metadata for the top level tests suites. comma seperated list of string resulting as List
`monitorColors`	string			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)
`monitorWidth`	string		`78`	Width of the monitor output. Default is 78.
`name`	string			Sets the name of the top-level tests suites.
`nonCriticalTags`	string			Tests that have the given tags are not critical. List
`noStatusReturnCode`	boolean		`false`	If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally.
`output`	string			Sets the path to the generated output String.
`outputDirectory`	string			Configures where generated reports are to be placed.
`randomize`	string			Sets the test execution order to be randomized. Valid values are all, suite, and test
`report`	string			Sets the path to the generated report String.
`reportBackground`	string			Sets background colors for the generated report and summary.
`reportTitle`	string			Sets a title for the generated tests report.
`runEmptySuite`	boolean		`false`	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.
`runFailed`	string			Re-run failed tests, based on output.xml String.
`runMode`	string			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.
`skipTeardownOnExit`	boolean		`false`	Sets whether the teardowns are skipped if the test execution is prematurely stopped.
`splitOutputs`	string			Splits output and log files.
`suites`	string			Selects the tests suites by name. List
`suiteStatLevel`	string			Defines how many levels to show in the Statistics by Suite table in outputs.
`summaryTitle`	string			Sets a title for the generated summary report.
`tagDocs`	string			Adds documentation to the specified tags. List
`tags`	string			Sets the tags(s) to all executed tests cases. List
`tagStatExcludes`	string			Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List
`tagStatIncludes`	string			Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List
`tagStatLinks`	string			Adds external links to the Statistics by Tag table in outputs. Use the format pattern🔗title List
`tests`	string			Selects the tests cases by name. List
`timestampOutputs`	boolean		`false`	Adds a timestamp to all output files.
`variableFiles`	string			Sets variables using variables files. Use the format path:args List
`variables`	string			Sets individual variables. Use the format name:value List
`warnOnSkippedFiles`	boolean		`false`	Show a warning when an invalid String is skipped.
`xunitFile`	string			Sets the path to the generated XUnit compatible result String, relative to outputDirectory. The String is in xml format. By default, the String name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.