generate-test-playbook

Generate Cortex XSOAR or Cortex XSIAM test playbooks from integration or script YAML files.

This command generates a test playbook from integration/script YAML arguments.

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 .../Packs/<pack_name>/Integrations, the output is saved under .../Packs/<pack_nam>/TestPlaybooks. If no folder in the input hierarchy is named Packs, the output is saved in the current directory.
-n, --name	Specifies the test playbook name. The output file name is playbook-<name>_Test.yml.
--no-outputs	Skips generating verification conditions for each output contextPath. Use when you want to determine which outputs to verify.
-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 and ignores the rest of the commands. For example, xdr-get-incidents,xdr-update-incident.
-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: -e '!ConvertFile entry_id=<entry_id>'.
-u, --upload	Whether to upload the test playbook after the generation.

Examples

• demisto-sdk generate-test-playbook -i Integrations/PaloAltoNetworks_XDR/PaloAltoNetworks_XDR.yml -n TestXDRPlaybook -o TestPlaybooks

  Creates a test playbook in TestPlaybook folder, with filename playbook-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 filename playbook-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 filename playbook-TestXDRPlaybook_Test.yml and generates tasks for only the xdr-get-incidents,xdr-update-incident commands written in the command_examples file, and also uploads the test playbook to Cortex XSOAR/XSIAM.