Documentation around the Job file structure can be found at https://docs.guardrails.io/docs/category/job-file
Examples of Job files can be found at https://github.com/guardrailsio/runtime-resources/tree/main/jobs
- advanced-BrowserApp-job-example: This Job file targets the NodeGoat SUT, which we host using purpleteam-iac-sut. You can use this Job file and just update the
sutHost
to point to your hosted copy of NodeGoat as well as theusername
andpasswordBase64
properties - job_crAPI-example: This Job file targets the crAPI SUT, which our devops team hosts for us. If using this Job file, you will need to provide a valid
sutHost
property value. Theusername
andpasswordBase64
properties will need updating with the values you entered when you created your user in a hosted copy of the crAPI project. TheopenApi.importFileContentBase64
value will need to be updated - simple-BrowserApp-job-example: This Job file is good for most browser applications that don't require authentication. If using this Job file, you will need to provide a valid
sutHost
property value. As it is, it will inform the Application Testing Engine to scan the specified host from the root. If you want to be more specific, you can add routes to be scanned - simple-BrowserApp-job-fast-example: This Job file extends simple-BrowserApp-job-example by adding a single route, this will inform the Application Testing Engine to only scan the specified route of the specified host. You will need to provide a valid
sutHost
property value, and a validroute.id
property value. By using this Job, the Test Run should be faster because it is not scanning from the root
If you are using a forwarding proxy, between the engine and your SUT, configure the forwardingProxy
object properties with valid values. If you are not using a fowarding proxy, just remove the forwardingProxy
object