| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for robotframework |
| |
| == Spring Boot Auto-Configuration |
| |
| When using robotframework with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-robotframework-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 52 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.robotframework.allow-context-map-all* | 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. | false | Boolean |
| | *camel.component.robotframework.allow-template-from-header* | 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. | false | Boolean |
| | *camel.component.robotframework.argument-file* | A text file to read more arguments from. | | File |
| | *camel.component.robotframework.autowired-enabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
| | *camel.component.robotframework.bridge-error-handler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. | false | Boolean |
| | *camel.component.robotframework.combined-tag-stats* | Creates combined statistics based on tags. Use the format tags:title List | | String |
| | *camel.component.robotframework.configuration* | The configuration. The option is a org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration type. | | RobotFrameworkCamelConfiguration |
| | *camel.component.robotframework.critical-tags* | Tests that have the given tags are considered critical. List | | String |
| | *camel.component.robotframework.debug-file* | A debug file that is written during execution. | | File |
| | *camel.component.robotframework.document* | Sets the documentation of the top-level tests suites. | | String |
| | *camel.component.robotframework.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. | false | Boolean |
| | *camel.component.robotframework.enabled* | Whether to enable auto configuration of the robotframework component. This is enabled by default. | | Boolean |
| | *camel.component.robotframework.excludes* | Selects the tests cases by tags. List | | String |
| | *camel.component.robotframework.exit-on-failure* | Sets robot to stop execution immediately if a critical test fails. | false | Boolean |
| | *camel.component.robotframework.includes* | Selects the tests cases by tags. List | | String |
| | *camel.component.robotframework.lazy-start-producer* | 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. | false | Boolean |
| | *camel.component.robotframework.listener* | Sets a single listener for monitoring tests execution | | String |
| | *camel.component.robotframework.listeners* | Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List | | String |
| | *camel.component.robotframework.log* | Sets the path to the generated log file. | | File |
| | *camel.component.robotframework.log-level* | Sets the threshold level for logging. | | String |
| | *camel.component.robotframework.log-title* | Sets a title for the generated tests log. | | String |
| | *camel.component.robotframework.metadata* | Sets free metadata for the top level tests suites. comma seperated list of string resulting as List | | String |
| | *camel.component.robotframework.monitor-colors* | 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) | | String |
| | *camel.component.robotframework.monitor-width* | Width of the monitor output. Default is 78. | 78 | String |
| | *camel.component.robotframework.name* | Sets the name of the top-level tests suites. | | String |
| | *camel.component.robotframework.no-status-return-code* | If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. | false | Boolean |
| | *camel.component.robotframework.non-critical-tags* | Tests that have the given tags are not critical. List | | String |
| | *camel.component.robotframework.output* | Sets the path to the generated output file. | | File |
| | *camel.component.robotframework.output-directory* | Configures where generated reports are to be placed. | | File |
| | *camel.component.robotframework.randomize* | Sets the test execution order to be randomized. Valid values are all, suite, and test | | String |
| | *camel.component.robotframework.report* | Sets the path to the generated report file. | | File |
| | *camel.component.robotframework.report-background* | Sets background colors for the generated report and summary. | | String |
| | *camel.component.robotframework.report-title* | Sets a title for the generated tests report. | | String |
| | *camel.component.robotframework.run-empty-suite* | 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. | false | Boolean |
| | *camel.component.robotframework.run-failed* | Re-run failed tests, based on output.xml file. | | File |
| | *camel.component.robotframework.run-mode* | 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. | | String |
| | *camel.component.robotframework.skip-teardown-on-exit* | Sets whether the teardowns are skipped if the test execution is prematurely stopped. | false | Boolean |
| | *camel.component.robotframework.split-outputs* | Splits output and log files. | | String |
| | *camel.component.robotframework.suite-stat-level* | Defines how many levels to show in the Statistics by Suite table in outputs. | | String |
| | *camel.component.robotframework.suites* | Selects the tests suites by name. List | | String |
| | *camel.component.robotframework.summary-title* | Sets a title for the generated summary report. | | String |
| | *camel.component.robotframework.tag-docs* | Adds documentation to the specified tags. List | | String |
| | *camel.component.robotframework.tag-stat-excludes* | Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List | | String |
| | *camel.component.robotframework.tag-stat-includes* | Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List | | String |
| | *camel.component.robotframework.tag-stat-links* | Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List | | String |
| | *camel.component.robotframework.tags* | Sets the tags(s) to all executed tests cases. List | | String |
| | *camel.component.robotframework.tests* | Selects the tests cases by name. List | | String |
| | *camel.component.robotframework.timestamp-outputs* | Adds a timestamp to all output files. | false | Boolean |
| | *camel.component.robotframework.variable-files* | Sets variables using variables files. Use the format path:args List | | String |
| | *camel.component.robotframework.variables* | Sets individual variables. Use the format name:value List | | String |
| | *camel.component.robotframework.warn-on-skipped-files* | Show a warning when an invalid file is skipped. | false | Boolean |
| | *camel.component.robotframework.xunit-file* | 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. | | File |
| |=== |
| // spring-boot-auto-configure options: END |
