Skip to content

Commit 649d582

Browse files
committed
Add new section
1 parent 15bbd16 commit 649d582

File tree

8 files changed

+26
-1
lines changed

8 files changed

+26
-1
lines changed

docs/platform-services/automation-service/automation-service-playbooks.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,32 @@ With the mechanism to import and export playbooks, you can move a playbook, alon
275275

276276
It is crucial that the file names inside the tar.gz adhere to the following format: `<unique_id>.<file_representing_name>.<file_type>.<file_extension>`, for example, `97ad7d6e.IP-Reputation.action.yaml`
277277

278-
## Test a playbook
278+
## Run tests on playbooks
279+
280+
### Test nodes in a playbook
281+
282+
The playbook **Test Node** toggle lets you test individual nodes of a playbook without needing to complete the entire flow. Testing individual nodes helps you improve your playbooks' reliability and shorten configuration time. You can provide mock values for variables used in the node, and run the results to see the output and any errors. The results provide informative messages to help you troubleshoot problems.
283+
284+
Keep in mind:
285+
* Before you can test a node, any node configuration changes need to be saved to the playbook draft.
286+
* You can test action, condition, user choice, and task nodes. You cannot test filter, nested playbook, start, or end nodes.
287+
* Testing nodes counts against your [action limit](/docs/platform-services/automation-service/about-automation-service/#actions-limit) quota.
288+
289+
To test a node:
290+
1. Select a playbook.
291+
1. Click the **Edit** button at the bottom of the screen to make a draft of the playbook.
292+
1. Click the **Edit** button on a node.
293+
1. Click the **Test Node** toggle at the top of the node dialog. An **Input** panel appears to the left, and an **Output** panel appears to the right. <br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-toggle.png')} alt="Playbook Test Node toggle" style={{border:'1px solid gray'}} width="800"/>
294+
1. In the **Input** panel, enter variables to test the node and then click **SAVE & RUN TEST**. Ensure that you enter valid variables for the kind of inputs you need to test. In the following example that uses input from insights, we provide an insight ID. <br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-variables.png')} alt="Playbook Test Node variables" style={{border:'1px solid gray'}} width="800"/>
295+
6. The **Output** panel shows results of the test run. Examine the results and take any action needed to troubleshoot node operation:
296+
* Click the information button <img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-info-icon.png')} alt="Playbook Test Node JSON info button" style={{border:'1px solid gray'}} width="30"/> to see information on the test run:<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-info-button.png')} alt="Playbook Test Node info" style={{border:'1px solid gray'}} width="300"/>
297+
* Click the **JSON details** button <img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-json-details-icon.png')} alt="Playbook Test Node JSON details button" style={{border:'1px solid gray'}} width="30"/> to see the JSON output. The button toggles to a **Table details** button <img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-table-details-icon.png')} alt="Playbook Test Node table details button" style={{border:'1px solid gray'}} width="30"/> so you can return to the table view. <br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-json-details.png')} alt="Playbook Test Node JSON details" style={{border:'1px solid gray'}} width="300"/>
298+
7. Continue testing the node and making changes as needed in the node's configuration. When done, click **Save**.
299+
8. Test each node in your playbook that has the **Test Node** button (action, condition, user choice, and task). In each node, enter variables in the **Input** panel and examine the results in the **Output** panel to ensure the node works correctly.
300+
301+
After you're done testing individual nodes, test the entire playbook to ensure it runs end-to-end (see [Test a playbook](#test-a-playbook)).
302+
303+
### Test a playbook
279304

280305
You can test a playbook to verify that it works properly. The test results show the outcome as if the playbook actually ran.
281306

64.7 KB
Loading
5.2 KB
Loading
5.58 KB
Loading
138 KB
Loading
4.3 KB
Loading
226 KB
Loading
265 KB
Loading

0 commit comments

Comments
 (0)