Integration of Wallarm FAST Orbs with CircleCI¶
This instruction describes the method to integrate FAST with CircleCI workflow via Wallarm FAST Orbs (plugin). An integration setup is performed in the
~/.circleci/config.yml configuration file. More details about CircleCI Orbs are available in official CircleCI documentation.
- CircleCI version 2.1
- Configured CircleCI workflow with an already recorded set of baseline requests
If you work with another version of CircleCI or need to add the step of request recording, then please check out the example of integration with CircleCI via FAST node.
Step 1: Passing FAST Node Token¶
Step 2: Connecting Wallarm FAST Orbs¶
To connect Wallarm FAST Orbs, set the following settings in the
Make sure CircleCI version 2.1 is specified in the file:
Initialize Wallarm FAST plugin in the
orbs: fast: email@example.com
Step 3: Configuring the Step of Security Testing¶
To configure security testing, add the separate step
fast/run_security_tests to your CircleCI workflow and define parameters listed below:
|test_record_id||Test record ID. Corresponds to TEST_RECORD_ID. |
Deafult value is the last test record created by used FAST node.
|app_host||The address of the test application. The value can be an IP address or a domain name. |
Default value is internal IP.
|app_port||The port of the test application. |
Default value is 80.
|policy_id||Test policy ID. |
Default value is
|stop_on_first_fail||The indicator to stop testing when an error occurs.||No|
|test_run_name||The name of the test run. |
By default, the value will be automatically generated from the date of the test run creation.
|test_run_desc||The description of the test run.||No|
|test_run_rps||A limit on the number of test requests (RPS, requests per second) to be sent to the target application. |
|wallarm_api_host||Address of the Wallarm API server. |
Default value is
|wallarm_fast_port||The port of the FAST node. |
Default value is 8080.
|wallarm_version||The version of the used Wallarm FAST Orbs. |
The versions list is available by clicking the link.
Default value is latest.
Example of ~/.circleci/config.yml
version: 2.1 jobs: build: machine: image: 'ubuntu-1604:201903-01' steps: - checkout - run: command: > docker run -d --name app-test -p 3000:3000 wallarm/fast-example-rails name: Run application - fast/run_security_tests: app_port: '3000' test_record_id: '9058' orbs: fast: 'wallarm/fast@dev:1.1.0'
If you have questions related to FAST integration, please contact us.