-
Notifications
You must be signed in to change notification settings - Fork 112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FAQ: New Automation section #2895
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
site/content/faq/how-can-i-set-variables-in-the-automation-framework.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: "How Can I set Variables in the Automation Framework?" | ||
type: faq | ||
category: Automation | ||
weight: 8 | ||
--- | ||
|
||
The [Automation Framework](/docs/automate/automation-framework/) supports | ||
[variables](/docs/desktop/addons/automation-framework/environment/#variables), which includes environment variables. | ||
You can use these to set values referenced in your plan from the command line, including secrets such as credentials. | ||
|
||
To see this in action download the | ||
[ScriptEnvVarAccess.yaml](https://github.com/zaproxy/community-scripts/blob/main/other/af-plans/ScriptEnvVarAccess.yaml) | ||
plan and store it in your current working directory. | ||
|
||
Edit the script and change `PATH` to `MyVar`. | ||
|
||
On Linux run: | ||
```bash | ||
export MyVar="Test 1 2 3" | ||
zap.sh -cmd -autorun ScriptEnvVarAccess.yaml | ||
``` | ||
|
||
On Windows run: | ||
```bash | ||
set MyVar=Test 1 2 3 | ||
zap.bat -cmd -autorun ScriptEnvVarAccess.yaml | ||
``` | ||
|
||
You may need to specify the full path to the relevant ZAP script on your computer. | ||
|
||
In both cases you shoud see output similar to: | ||
```bash | ||
Job script set action = add | ||
Job script set type = standalone | ||
Job script set engine = ECMAScript : Graal.js | ||
Job script set name = print-env-vars.js | ||
Job script set inline = print(Java.type("java.lang.System").getenv("MyVar")); | ||
|
||
Job script set action = run | ||
Job script set type = standalone | ||
Job script set name = print-env-vars.js | ||
Job script started | ||
Job: script Start action: add | ||
Job script finished, time taken: 00:00:00 | ||
Job script started | ||
Job: script Start action: run | ||
Test 1 2 3 | ||
Job script finished, time taken: 00:00:00 | ||
Automation plan succeeded! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,12 @@ | ||||||
--- | ||||||
title: "What is the Best Way to Automate ZAP?" | ||||||
type: faq | ||||||
category: Automation | ||||||
weight: 8 | ||||||
--- | ||||||
|
||||||
For most use cases, the best way to automate ZAP is using the | ||||||
[Automation Framework](/docs/automate/automation-framework/). | ||||||
|
||||||
For a comparison of the different automation options see | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[Automation Options](/docs/getting-further/automation/automation-options/). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.