The generate-test-playbook creates a test playbook using integration/script YAML arguments.
This command generates a test playbook from integration/script YAML arguments.
Argument | Description |
---|---|
-i, --input | Specifies the integration/script YAML path. Must be a valid YAML file. |
-o, --output | Specifies the output directory or path. If not specified, and the input is located at |
-n, --name | Specifies the test playbook name. The output file name is |
--no-outputs | Skips generating verification conditions for each output |
-ab, --all-brands | Generates a test-playbook which calls commands using integrations of all available brands. When not used, the generated playbook calls commands using instances of the provided integration brand. |
-c, --commands | A comma-separated list of command names to generate playbook tasks for, ignores the rest of the commands. For example, |
-e, --examples | For integrations: The path to the file containing command examples. Each command should be in a separate line. For scripts: The script example surrounded by quotes. For example: |
-u, --upload | Whether to upload the test playbook after the generation. |
demisto-sdk generate-test-playbook -i Integrations/PaloAltoNetworks_XDR/PaloAltoNetworks_XDR.yml -n TestXDRPlaybook -o TestPlaybooks
Creates a test playbook in
TestPlaybook
folder, with filenameplaybook-TestXDRPlaybook_Test.yml
.demisto-sdk generate-test-playbook -i Packs/ExamplePack/Integrations/ExampleIntegration/integration.yml -n Example
Creates a test playbook in
Packs/ExamplePack/TestPlaybooks
, with filenameplaybook-Example_Test.yml
demisto-sdk generate-test-playbook -i Integrations/PaloAltoNetworks_XDR/PaloAltoNetworks_XDR.yml -n TestXDRPlaybook -o TestPlaybooks -e Integrations/PaloAltoNetworks_XDR/command_examples.txt -c xdr-get-incidents,xdr-update-incident -u
Creates a test playbook in
TestPlaybook
folder, with filenameplaybook-TestXDRPlaybook_Test.yml
and generates tasks for only thexdr-get-incidents
,xdr-update-incident
commands written in thecommand_examples
file, and also uploads the test playbook to Cortex XSOAR/XSIAM.