diff --git a/docs/modules/scriptless-automation/nav.adoc b/docs/modules/scriptless-automation/nav.adoc index 74637104c..1446f20bb 100644 --- a/docs/modules/scriptless-automation/nav.adoc +++ b/docs/modules/scriptless-automation/nav.adoc @@ -6,7 +6,6 @@ ** xref:get-a-session-id/using-the-kobiton-portal.adoc[] ** xref:get-a-session-id/using-the-kobiton-api.adoc[] -* xref:run-scriptless-with-the-kobiton-portal.adoc[] * xref:run-scriptless-with-the-kobiton-api.adoc[] * xref:automation-testing:scripting/auto-generate-an-appium-script.adoc[] * xref:scriptless-best-practices.adoc[] diff --git a/docs/modules/scriptless-automation/pages/create-a-baseline-session.adoc b/docs/modules/scriptless-automation/pages/create-a-baseline-session.adoc index 5ed99c100..b7dc29f61 100644 --- a/docs/modules/scriptless-automation/pages/create-a-baseline-session.adoc +++ b/docs/modules/scriptless-automation/pages/create-a-baseline-session.adoc @@ -1,7 +1,7 @@ = Create a baseline session for Scriptless Automation :navtitle: Create a baseline session -Learn how to create a baseline session for Scriptless Automation. After you create a baseline session, you can use the xref:run-scriptless-with-the-kobiton-portal.adoc[Kobiton portal] or xref:run-scriptless-with-the-kobiton-api.adoc[Kobiton API] to rerun your test steps on the same device or on completely different devices--_without_ writing any test scripts. +Learn how to create a baseline session for Scriptless Automation. You can use this session to xref:test-management:test-case/create-a-test-case.adoc[create a test case]. include::manual-testing:partial$start-a-manual-session.adoc[] @@ -47,4 +47,4 @@ Select *Exit Session*. image:exit-session-context.png[width=500,alt="Exit Session pop up"] -Now you can use this session to run Scriptless Automation using the xref:run-scriptless-with-the-kobiton-portal.adoc[Kobiton portal] or xref:run-scriptless-with-the-kobiton-api.adoc[Kobiton API]. +Now you can use this session to xref:test-management:test-case/create-a-test-case.adoc[create a test case]. diff --git a/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc b/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc deleted file mode 100644 index 03295ade3..000000000 --- a/docs/modules/scriptless-automation/pages/run-scriptless-with-the-kobiton-portal.adoc +++ /dev/null @@ -1,82 +0,0 @@ -= Run scriptless with the Kobiton portal -:navtitle: Run scriptless with the Kobiton portal - -Learn how to run Scriptless Automation using the Kobiton portal. - -== Before you start - -You'll need to complete the following: - -* xref:create-a-baseline-session.adoc[Create a baseline session]. -* xref:test-management:create-a-test-case.adoc[] using your baseline session. - -== Open Scriptless Automation - -In *Sessions*, search for your baseline session, then select the session. - -image:session-explorer:search-session-id-closeup.png[width=1000,alt="Session search screen"] - -[NOTE] -For more information, see xref:session-explorer:session-metadata.adoc[]. - -Select *Automated Test Case*. - -image:scriptless-automation:scriptless-automated-test-case-button.png[width=1000,alt="The session overview page with the Automated Test Case button"] - -Select *Rerun*. - -image:scriptless-automation:scriptless-rerun-button.png[width=1000,alt="Select Rerun in the Automated Test Case screen"] - -[TIP] -For best results, select Rerun when the message _Congratulations! Your test case is good to go now_ appears on screen. If a different message is showing, you may need to xref:test-management:remediation/annotate-a-test-step.adoc[annotate the test steps]. - -== Configure your scriptless session - -=== Device Bundles - -In the *Rerun Configurations* window, select *Device Bundles*. - -image:scriptless-automation:scriptless-rerun-configurations-device-bundles-context.png[width=600,alt="The select device bundles dropdown list"] - -Select the dropdown and choose a bundle. - -image:scriptless-automation:scriptless-select-device-bundles.png[width=600,alt="The select device bundles dropdown list"] - -If you'd like to remove any devices for this session, de-select the checkbox next to each device. - -image:scriptless-automation:scriptless-deselect-device-from-bundles.png[width=1000,alt="A device is de-selected from the device bundles"] - -[NOTE] -If you'd like to make more changes to this bundle, select *Configure Bundle*. For more information, see xref:organization:device-bundles/manage-device-bundles.adoc[]. - -=== Data driven testing - -Data-driven testing allows you to define custom data sets and replace values from your baseline session. In the *Rerun Configurations* window, select *Data Driven Testing*. - -image:scriptless-automation:rerun-configurations-data-driven-testing-context.png[width=1000,alt="The Data Driven Testing section under Rerun Configurations"] - -Select the *+* button to add new test data. - -image:scriptless-automation:data-driven-new-dataset.png[width=1000,alt="Select the plus icon to add new test data"] - -The new test data is only applied to a specific device in the bundle. Choose the device to apply by selecting it from the *Assign Device* dropdown. - -image:scriptless-automation:data-driven-assign-device.png[width=500,alt="The Assign Device dropdown"] - -To replace a value used for a specific test step, select the test step with a value input action, then enter a new value. - -image:scriptless-automation:data-driven-replace-value.png[width=500,alt="Replacing a value in a test step"] - -Once a value has been modified, it will be marked as *Edited*. - -image:scriptless-automation:data-driven-test-step-edited.png[width=500,alt="The value is marked as edited"] - -== Run Scriptless Automation - -When you're finished configuring your scriptless session, select *Rerun*. - -image:scriptless-automation:rerun-configurations-data-driven-testing-context.png[width=1000,alt="Select Rerun after finishing the configurations"] - -You'll be redirected to your test run where you can view live updates for your run. - -image:scriptless-automation:test-run-view.png[width=1000,alt="The test run view"] diff --git a/docs/modules/test-management/images/convert-to-test-case-context.png b/docs/modules/test-management/images/convert-to-test-case-context.png deleted file mode 100644 index e0dc2b150..000000000 Binary files a/docs/modules/test-management/images/convert-to-test-case-context.png and /dev/null differ diff --git a/docs/modules/test-management/images/convert-to-text-case-disabled.png b/docs/modules/test-management/images/convert-to-text-case-disabled.png new file mode 100644 index 000000000..cd2f3d79e Binary files /dev/null and b/docs/modules/test-management/images/convert-to-text-case-disabled.png differ diff --git a/docs/modules/test-management/images/create-and-manage-test-suite-choose-test-suite.PNG b/docs/modules/test-management/images/create-and-manage-test-suite-choose-test-suite.PNG new file mode 100644 index 000000000..660d4205f Binary files /dev/null and b/docs/modules/test-management/images/create-and-manage-test-suite-choose-test-suite.PNG differ diff --git a/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite-info.PNG b/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite-info.PNG new file mode 100644 index 000000000..770984276 Binary files /dev/null and b/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite-info.PNG differ diff --git a/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite.PNG b/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite.PNG new file mode 100644 index 000000000..58b0820f1 Binary files /dev/null and b/docs/modules/test-management/images/create-and-manage-test-suite-create-test-suite.PNG differ diff --git a/docs/modules/test-management/images/create-and-manage-test-suite-manage-test-suite.PNG b/docs/modules/test-management/images/create-and-manage-test-suite-manage-test-suite.PNG new file mode 100644 index 000000000..1c98da8f0 Binary files /dev/null and b/docs/modules/test-management/images/create-and-manage-test-suite-manage-test-suite.PNG differ diff --git a/docs/modules/test-management/images/create-and-manage-test-suite-test-suite-created.PNG b/docs/modules/test-management/images/create-and-manage-test-suite-test-suite-created.PNG new file mode 100644 index 000000000..c3d7bd85c Binary files /dev/null and b/docs/modules/test-management/images/create-and-manage-test-suite-test-suite-created.PNG differ diff --git a/docs/modules/test-management/images/manage-test-case-session-search.png b/docs/modules/test-management/images/manage-test-case-session-search.png new file mode 100644 index 000000000..4d1c73da3 Binary files /dev/null and b/docs/modules/test-management/images/manage-test-case-session-search.png differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-element-inspector.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-element-inspector.PNG new file mode 100644 index 000000000..c7005a860 Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-element-inspector.PNG differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-naigation-steps.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-naigation-steps.PNG new file mode 100644 index 000000000..dddb1ce90 Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-naigation-steps.PNG differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message-success.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message-success.PNG new file mode 100644 index 000000000..1a01ab1b4 Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message-success.PNG differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message.PNG new file mode 100644 index 000000000..f7a645a7c Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-test-steps-message.PNG differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-coordinates.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-coordinates.PNG new file mode 100644 index 000000000..b18a0b821 Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-coordinates.PNG differ diff --git a/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-steps.PNG b/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-steps.PNG new file mode 100644 index 000000000..d512d52ec Binary files /dev/null and b/docs/modules/test-management/images/remediation-remediate-element-selection-touch-action-steps.PNG differ diff --git a/docs/modules/test-management/images/remediation-resolve-a-blocker-baseline-revisit.PNG b/docs/modules/test-management/images/remediation-resolve-a-blocker-baseline-revisit.PNG new file mode 100644 index 000000000..1a475067e Binary files /dev/null and b/docs/modules/test-management/images/remediation-resolve-a-blocker-baseline-revisit.PNG differ diff --git a/docs/modules/test-management/images/remediation-resolve-a-blocker-blocker-remediation-popup.PNG b/docs/modules/test-management/images/remediation-resolve-a-blocker-blocker-remediation-popup.PNG new file mode 100644 index 000000000..1862d6603 Binary files /dev/null and b/docs/modules/test-management/images/remediation-resolve-a-blocker-blocker-remediation-popup.PNG differ diff --git a/docs/modules/test-management/images/remediation-resolve-a-blocker-navigation-buttons.PNG b/docs/modules/test-management/images/remediation-resolve-a-blocker-navigation-buttons.PNG new file mode 100644 index 000000000..22c1b93b3 Binary files /dev/null and b/docs/modules/test-management/images/remediation-resolve-a-blocker-navigation-buttons.PNG differ diff --git a/docs/modules/test-management/images/remediation-resolve-a-blocker-needs-action-status.PNG b/docs/modules/test-management/images/remediation-resolve-a-blocker-needs-action-status.PNG new file mode 100644 index 000000000..bc09b57e9 Binary files /dev/null and b/docs/modules/test-management/images/remediation-resolve-a-blocker-needs-action-status.PNG differ diff --git a/docs/modules/test-management/images/remediation-resolve-a-blocker-session-explorer.PNG b/docs/modules/test-management/images/remediation-resolve-a-blocker-session-explorer.PNG new file mode 100644 index 000000000..7e132906b Binary files /dev/null and b/docs/modules/test-management/images/remediation-resolve-a-blocker-session-explorer.PNG differ diff --git a/docs/modules/test-management/images/search-for-a-session-context.png b/docs/modules/test-management/images/search-for-a-session-context.png deleted file mode 100644 index 260f0c5e9..000000000 Binary files a/docs/modules/test-management/images/search-for-a-session-context.png and /dev/null differ diff --git a/docs/modules/test-management/images/select-session-for-conversion.png b/docs/modules/test-management/images/select-session-for-conversion.png new file mode 100644 index 000000000..90367359f Binary files /dev/null and b/docs/modules/test-management/images/select-session-for-conversion.png differ diff --git a/docs/modules/test-management/images/session-explorer-convert-to-test-case.png b/docs/modules/test-management/images/session-explorer-convert-to-test-case.png new file mode 100644 index 000000000..e44cb8c45 Binary files /dev/null and b/docs/modules/test-management/images/session-explorer-convert-to-test-case.png differ diff --git a/docs/modules/test-management/images/session-explorer-view-test-case.png b/docs/modules/test-management/images/session-explorer-view-test-case.png new file mode 100644 index 000000000..5e571fdbc Binary files /dev/null and b/docs/modules/test-management/images/session-explorer-view-test-case.png differ diff --git a/docs/modules/test-management/images/test-case-conversion-success.png b/docs/modules/test-management/images/test-case-conversion-success.png new file mode 100644 index 000000000..d7520cdce Binary files /dev/null and b/docs/modules/test-management/images/test-case-conversion-success.png differ diff --git a/docs/modules/test-management/images/test-case-conversion-unsuccessful.png b/docs/modules/test-management/images/test-case-conversion-unsuccessful.png new file mode 100644 index 000000000..45b744717 Binary files /dev/null and b/docs/modules/test-management/images/test-case-conversion-unsuccessful.png differ diff --git a/docs/modules/test-management/images/test-case-details-general.png b/docs/modules/test-management/images/test-case-details-general.png new file mode 100644 index 000000000..aa67ba3d9 Binary files /dev/null and b/docs/modules/test-management/images/test-case-details-general.png differ diff --git a/docs/modules/test-management/images/test-case-list-empty.png b/docs/modules/test-management/images/test-case-list-empty.png new file mode 100644 index 000000000..24bda7cdf Binary files /dev/null and b/docs/modules/test-management/images/test-case-list-empty.png differ diff --git a/docs/modules/test-management/images/test-case-list.png b/docs/modules/test-management/images/test-case-list.png new file mode 100644 index 000000000..abc51dad0 Binary files /dev/null and b/docs/modules/test-management/images/test-case-list.png differ diff --git a/docs/modules/test-management/images/test-case-ready-to-go-context.png b/docs/modules/test-management/images/test-case-ready-to-go-context.png deleted file mode 100644 index 0b4ba4d26..000000000 Binary files a/docs/modules/test-management/images/test-case-ready-to-go-context.png and /dev/null differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-application-versions.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-application-versions.PNG new file mode 100644 index 000000000..79ec9d8f6 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-application-versions.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-case-details.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-case-details.PNG new file mode 100644 index 000000000..5be7d0572 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-case-details.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-device-bundle.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-device-bundle.PNG new file mode 100644 index 000000000..351c3a7a6 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-device-bundle.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-case.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-case.PNG new file mode 100644 index 000000000..8bda0f55e Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-case.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-suite.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-suite.PNG new file mode 100644 index 000000000..ad70192aa Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-customize-test-suite.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-allocation-strategy.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-allocation-strategy.PNG new file mode 100644 index 000000000..227271210 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-allocation-strategy.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-bundle-or-individual-devices.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-bundle-or-individual-devices.PNG new file mode 100644 index 000000000..2419ad236 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-device-bundle-or-individual-devices.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-execute-test-run.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-execute-test-run.PNG new file mode 100644 index 000000000..b048aaa08 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-execute-test-run.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-list-individual-devices.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-list-individual-devices.PNG new file mode 100644 index 000000000..da8702638 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-list-individual-devices.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-manage-a-test-run.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-manage-a-test-run.PNG new file mode 100644 index 000000000..f609bdb3d Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-manage-a-test-run.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-new-test-run.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-new-test-run.PNG new file mode 100644 index 000000000..b191c40e1 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-new-test-run.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-rerun-test-run.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-rerun-test-run.PNG new file mode 100644 index 000000000..a97a4dfdf Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-rerun-test-run.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-run-test-suite.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-run-test-suite.PNG new file mode 100644 index 000000000..1c70164bf Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-run-test-suite.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-case-or-test-suite.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-case-or-test-suite.PNG new file mode 100644 index 000000000..41d4a982c Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-case-or-test-suite.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-created-success-message.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-created-success-message.PNG new file mode 100644 index 000000000..52a9f3e65 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-created-success-message.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-setup.PNG b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-setup.PNG new file mode 100644 index 000000000..7286db015 Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-manage-test-run-test-run-setup.PNG differ diff --git a/docs/modules/test-management/images/test-run-create-and-mange-test-run-view-test-run.PNG b/docs/modules/test-management/images/test-run-create-and-mange-test-run-view-test-run.PNG new file mode 100644 index 000000000..9fd0e9eee Binary files /dev/null and b/docs/modules/test-management/images/test-run-create-and-mange-test-run-view-test-run.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-id-from-test-runs.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-id-from-test-runs.PNG new file mode 100644 index 000000000..dc502d716 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-id-from-test-runs.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-3dot-icon.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-3dot-icon.PNG new file mode 100644 index 000000000..918769b57 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-3dot-icon.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-show-button.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-show-button.PNG new file mode 100644 index 000000000..99b050bb1 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-more-actions-show-button.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-camera-roll.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-camera-roll.PNG new file mode 100644 index 000000000..28b7858bc Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-camera-roll.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-sensitive-data-indicator.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-sensitive-data-indicator.PNG new file mode 100644 index 000000000..3100b23b5 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-sensitive-data-indicator.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-tast-case-results.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-tast-case-results.PNG new file mode 100644 index 000000000..e49e8fb67 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results-tast-case-results.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results.PNG new file mode 100644 index 000000000..a2008344f Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-revisit-execution-results.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-individual-sections.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-individual-sections.PNG new file mode 100644 index 000000000..bf7e3c346 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-individual-sections.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-view-camera-roll.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-view-camera-roll.PNG new file mode 100644 index 000000000..c0defa04b Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-overview-view-camera-roll.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results-general-information.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results-general-information.PNG new file mode 100644 index 000000000..c2f77fc99 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results-general-information.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results.PNG new file mode 100644 index 000000000..5e5b62b4d Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-test-run-results.PNG differ diff --git a/docs/modules/test-management/images/test-run-review-test-run-results-view-test-run.PNG b/docs/modules/test-management/images/test-run-review-test-run-results-view-test-run.PNG new file mode 100644 index 000000000..8c41b42f2 Binary files /dev/null and b/docs/modules/test-management/images/test-run-review-test-run-results-view-test-run.PNG differ diff --git a/docs/modules/test-management/nav.adoc b/docs/modules/test-management/nav.adoc index e473df2e2..8d2066e64 100644 --- a/docs/modules/test-management/nav.adoc +++ b/docs/modules/test-management/nav.adoc @@ -1,14 +1,23 @@ -.xref:index.adoc[] -* xref:test-management:create-a-test-case.adoc[] -* xref:test-management:manage-test-steps.adoc[] - -* xref:test-management:validation/index.adoc[] -** xref:test-management:validation/performance-validation.adoc[] -** xref:test-management:validation/color-text-validation.adoc[] -** xref:test-management:validation/text-validation.adoc[] - -* xref:test-management:remediation/index.adoc[] -** xref:test-management:remediation/annotate-a-test-step.adoc[] -** xref:test-management:remediation/crash-remediation.adoc[] -** xref:test-management:remediation/element-selection-remediation.adoc[] -** xref:test-management:remediation/ignore-remediation.adoc[] +.xref:index.adoc[] + +* Test case +** xref:test-case/create-a-test-case.adoc[] +** xref:test-case/manage-test-steps.adoc[] + +* Test suite +** xref:test-management:test-suite/create-and-manage-test-suite.adoc[] + +* Test run +** xref:test-management:test-run/create-and-manage-test-run.adoc[] +** xref:test-management:test-run/review-test-run-results.adoc[] + +* xref:test-management:validation/index.adoc[] +** xref:test-management:validation/performance-validation.adoc[] +** xref:test-management:validation/color-text-validation.adoc[] +** xref:test-management:validation/text-validation.adoc[] + +* xref:test-management:remediation/index.adoc[] +** xref:test-management:remediation/annotate-a-test-step.adoc[] +** xref:test-management:remediation/crash-remediation.adoc[] +** xref:test-management:remediation/element-selection-remediation.adoc[] +** xref:test-management:remediation/ignore-remediation.adoc[] diff --git a/docs/modules/test-management/pages/create-a-test-case.adoc b/docs/modules/test-management/pages/create-a-test-case.adoc deleted file mode 100644 index 8d3c434b8..000000000 --- a/docs/modules/test-management/pages/create-a-test-case.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Create a test case -:navtitle: Create a test case - -Learn how to create a test case so you can run xref:scriptless-automation:index.adoc[Scriptless Automation]. - -== Before you start - -You'll need to complete the following: - -* xref:scriptless-automation:create-a-baseline-session.adoc[Create a baseline session]. -* If applicable, xref:remediation/annotate-a-test-step.adoc[annotate any flagged test steps]. - -== Create a test case - -In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a session], then select a session. - -image:search-for-a-session-context.png[width=1000,alt="Select Sessions and search for a session"] - -Select *Automated Test Case*. - -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] - -If your test case has any issues, you'll need to xref:remediation/annotate-a-test-step.adoc[annotate your flagged test steps] first. When your test case is good to go, you'll see the following message: - -image:test-case-ready-to-go-context.png[width=1000,alt="Test case after all annotating"] - -When you're ready, select *Convert to Test Case*. - -image:convert-to-test-case-context.png[width=1000,alt="Click Convert to Test case"] - -If you'd like to make changes to your test case before running Scriptless Automation, see xref:manage-test-steps.adoc[]. diff --git a/docs/modules/test-management/pages/manage-test-steps.adoc b/docs/modules/test-management/pages/manage-test-steps.adoc deleted file mode 100644 index 3b3b6f72b..000000000 --- a/docs/modules/test-management/pages/manage-test-steps.adoc +++ /dev/null @@ -1,34 +0,0 @@ -= Manage test steps -:navtitle: Manage test steps - -Learn how to manage the test steps, so you can improve your test case before running Scriptless Automation. - -== Before you start - -You'll need to xref:test-management:create-a-test-case.adoc[create a test case] from a baseline session. - -== Open a test case - -In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a session], then select a session. - -image:select-a-session-context.png[width=1000,alt="Search and select a session"] - -Select *Automation Test Case*. - -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] - -== Manage the test step - -=== Delete the test step - -You can delete one or more test steps at a time. Select the checkbox next to each test step you'd like to delete. - -image:delete-test-steps-context.png[width=1000,alt="Delete test steps"] - -When you're ready, select *Delete*. - -[IMPORTANT] -Deleting a test step cannot be undone. - -image:delete-test-step-popup-context.png[width=1000,alt=""] - diff --git a/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc b/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc index c76d6c5ae..63eba3e59 100644 --- a/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc +++ b/docs/modules/test-management/pages/remediation/annotate-a-test-step.adoc @@ -1,37 +1,73 @@ -= Annotate a test step for Scriptless Automation -:navtitle: Annotate a test step += Remediate element selection +:navtitle: Remediate element selection -Learn how to annotate a test step from your xref:scriptless-automation:create-a-baseline-session.adoc[baseline session], so you can... +Learn how to remediate element selection when the AI is not confident that it can accurately identify elements due to complex layout or overlapping elements. Remediation ensures that all test steps are correct, improving the reliability and success rate of automated test runs. + +== What is element selection remediation? + +When you complete the baseline session, Kobiton's AI Engine analyzes the performed actions and identifies which visual elements were interacted with. However, there are cases where multiple visual elements overlap, causing the AI Engine to return low confidence in selecting the correct element. + +In these cases, the AI requires user input to select the correct element. + +NOTE: You can only remediate steps with Touch action. + +NOTE: Element selection remediation is optional but recommended. Without remediation, the AI may select the wrong element during a test run, decreasing the likelihood of success. == Before you start -You'll need to xref:scriptless-automation:create-a-baseline-session.adoc[create a baseline session]. +* Create a baseline session. +* Convert the baseline session to test case. + +== Remediate element selection + +After converting a session to a test case, if any steps needs remediation, the following message appears next to Test Steps: + +image:test-management:remediation-remediate-element-selection-test-steps-message.PNG[width=750,alt="Remediation required message with warning that a specific number of steps require remediation"] + +Select the *Remediate test steps* button. + +The *Element Selection Remediation* popup appears as shown for steps with touch action: + +image:test-management:remediation-remediate-element-selection-touch-action-steps.PNG[width=750,alt="Steps with touch action"] + +In this popup, you are provided with the following tools to assist in remediating: + +* Navigation buttons to switch between test step: + +image:test-management:remediation-remediate-element-selection-naigation-steps.PNG[width=300,atl="Next page and previous page buttons"] -== Annotate a test step +* The element inspector with element hierarchy and attributes: -In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a session], then select the session. +image:test-management:remediation-remediate-element-selection-element-inspector.PNG[width=750,alt="element inspector with element hierarchy and attributes"] -image:select-a-session-context.png[width=1000,alt="Search and select a session"] +* Screenshot of the test step with the selected element highlighted, and the dot showing the coordinates of the touch action: -Select *Automation Test Case*. +image:test-management:remediation-remediate-element-selection-touch-action-coordinates.PNG[width=300,alt="dot showing the coordinates of the touch action"] -image:select-automated-test-case-context.png[width=1000,alt="Select Automated Test Case"] +To remediate a test step: -If one of your test steps were flagged, you'll see a warning similar to the following: +. Navigate to the test step using the navigation buttons. +. Select an element from either the element hierarchy or the screenshot. Refer to the https://kobiton.atlassian.net/wiki/spaces/KOBITON/pages/3640131693/Remediate+element+selection+Review#Remediation-guidelines[remediation guidelines] when selecting the element. ++ +NOTE: You can hover the mouse over the screenshot to highlight the element closest to it. +. When finished, select *Submit*. ++ +CAUTION: Once you submit, you cannot remediate the same test step again. Proceed with caution. -image:annotate-warning-context.png[width=1000,alt="Test steps are flagged with the below warning"] +Repeat these steps for all test steps that need remediation. Once all test steps have been remediated, the following message will appear: -Scroll through your test steps and look for any steps highlighted in red with the option to annotate. +image:test-management:remediation-remediate-element-selection-test-steps-message-success.PNG[width=750,alt="Remediation steps completion popup, success message"] -image:select-annotate-closeup.png[width=900,alt="Select Annotate"] +Select the *Save* button to save the changes to a new test case version. -Select *Annotate*. +CAUTION: Changes will not be automatically saved. -image:test-case-ready-to-go-context.png[width=1000,alt="Test cases are ready to go"] +At this point, the test case is fully prepared and ready for test runs. -== Annotation options +== Remediation guidelines -These are the different options for annotating a test step: +When remediating, follow these guidelines: -** xref:test-management:remediation/crash-remediation.adoc[] -** xref:test-management:remediation/element-selection-remediation.adoc[] +* Select the element that is as low in the hierarchy as possible, while ensuring it is still the correct element. +* Chose the element closest to the original touch action. +* Whenever possible, select an element with a unique attribute. \ No newline at end of file diff --git a/docs/modules/test-management/pages/remediation/element-selection-remediation.adoc b/docs/modules/test-management/pages/remediation/element-selection-remediation.adoc index 54328d979..9e27c4bf9 100644 --- a/docs/modules/test-management/pages/remediation/element-selection-remediation.adoc +++ b/docs/modules/test-management/pages/remediation/element-selection-remediation.adoc @@ -1,12 +1,70 @@ -= Element selection remediation -:navtitle: Element selection remediation += Resolve a blocker +:navtitle: Resolve a blocker -The User Interface (UI) of an element often changes across multiple devices. This can interrupt revisits on different devices because it's challenging to manage the appearance of an element through various device ratios, like 18:9, 17:9, and 16:9. But, with Scriptless Automation, you can easily handle these challenges through the UI without any scripting. +Learn how to resolve a blocker using Blocker Remediation, so you can execute the test run successfully. -image:scriptless-automation:ui-remediation-window.png[width=700,alt="UI Remediation window"] +== What is a blocker? -When revisiting on a Galaxy J5, a blocker is raised because a UI change covers and makes the **Login** button un-clickable. You can resolve this by manually selecting the **Login** button in the Scriptless Automation Remediation. This selection becomes the new 'baseline' for the test case, ensuring smooth execution. +In test steps that use the touch action, the user interface (UI) of an element often changes across multiple devices. If the difference is significant, the AI will raise a blocker and is unable to select the element. -image:scriptless-automation:ui-remediation2.png[width=700,alt="Another view of UI Remediation window"] +This situation can disrupt revisits on different devices due to difficulties in managing element appearance across various screen ratios, such as 18:9, 17:9, and 16:9. However, you can easily resolve these issues in Test Management without scripting by using Blocker Remediation. -In situations where different screen ratios crop a list view cell, making it undetectable, this would typically result in a failed test case with other “Record & Playback” technologies. However, with Scriptless Automation, you can select the correct list view cell and submit the remediation to continue the test. +== Resolve a blocker + +When a blocker is encountered, the *Test Run Results* page will display the *Needs Actions* status: + +image:test-management:remediation-resolve-a-blocker-needs-action-status.PNG[width=750] + +Select the *Needs Actions* status to go to the *Session Explorer* page. + +In the Session Timeline, the step with the blocker is marked with a red icon. Select this icon, then choose *Resolve Blocker*. + +image:test-management:remediation-resolve-a-blocker-session-explorer.PNG[width=750,alt="Session timeline with blocker marked with a red icon."] + +The *Blocker Remediation* popup appears: + +image:test-management:remediation-resolve-a-blocker-blocker-remediation-popup.PNG[width=750,alt="Blocker Remediation popup with Baseline and Revisit screens"] + +The following tools will help you remediate: + +* Navigation buttons to switch between test steps. + +image:test-management:remediation-resolve-a-blocker-navigation-buttons.PNG[width=750,alt="Navigation buttons to switch between test steps"] + +* The original screenshot of the baseline session is shown alongside the screenshot of the revisit session. +** The selected element is highlighted in the *Baseline* screenshot. +** Hover the mouse over the *Revisit* screenshot to highlight the element closest to it. + +image:test-management:remediation-resolve-a-blocker-baseline-revisit.PNG[width=750,alt="Selected element is highlighted. Hover over the Revisit screenshot to highlight the element."] + +To remediate a test step: + +. Navigate to the desired test step using the navigation buttons. ++ +NOTE: You can only navigate to test steps that use the touch action +. Select an element from the Revisit screenshot. +. When finished, select Submit. + +NOTE: You can only resolve blocker for one test step in one revisit session. If a test run has many test steps that require Blocker Remediation, rerun the test run again, resolve the next blocker, and repeat until there is no blocker left. + +CAUTION: Once you submit, you cannot resolve the blocker for the current session again. Proceed with caution. + +After submitting, the submitted test step will be set as the new baseline when running the same test case on any device with the same model and OS version. To verify, rerun the test run again on any device with the same model and OS version. + +== Notes + +Blocker Remediation does not work in the following cases: + +* The element does not involve a touch action, such as swiping or scrolling. +* The element’s position and appearance is not static, such as: +** Floating element. +** Element that can hide or display based on user behavior (playback button in videos player). +** Element with animations. +* The element cannot be identified via Appium Inspector, such as _label_ or _xPath_, and requires touching on an exact coordinate on the screen. For example, an object in a mobile game. +* The element is outside the current view and requires additional actions to be visible, such as scrolling vertically more than 5 pages, scrolling horizontally, or swiping left/right. ++ +NOTE: The AI can automatically find the element by scrolling vertically within a 5-page range. +* The element is not selectable due to a bug. +* An in-app pop-up (that did not appear in the baseline session) blocks the element from being selected. + +NOTE: System pop-ups, such as software update notices, are automatically dismissed by the AI. \ No newline at end of file diff --git a/docs/modules/test-management/pages/test-case/create-a-test-case.adoc b/docs/modules/test-management/pages/test-case/create-a-test-case.adoc new file mode 100644 index 000000000..f7107f31e --- /dev/null +++ b/docs/modules/test-management/pages/test-case/create-a-test-case.adoc @@ -0,0 +1,75 @@ += Create a test case +:page-aliases: test-management:create-a-test-case.adoc + +:navtitle: Create a test case + +Learn how to create a test case from a baseline session. A test case serves as a template, capturing the test steps performed in the baseline session. You can use this test case to generate an Appium script or rerun it using Scriptless Automation. + +Just like test sessions, test cases are organized by team. If you are a member of multiple teams in your organization, be sure to select the proper team in the left-hand navigation before creating your baseline session. + +== Before you start + +You'll need to complete the following: + +* xref:scriptless-automation:create-a-baseline-session.adoc[Create a baseline session for Scriptless Automation] + +== Create a new test case + +You can create a test case in two ways: from Session Explorer or the Test Case List. This section explains both methods. + +=== Create a test case from an existing session in Session Explorer + +Access Session Explorer page via one of the following ways: + +* Automatic redirection after completing a manual session. +* Select a session from the Session List. + +In the *Test Result Analysis* insights panel, select *Convert to Test Case*. + +image:session-explorer-convert-to-test-case.png[width=1000,alt="The Convert to Test Case button in the Session Explorer page"] + +Once the conversion is complete, the *Convert to Test Case* button changes to *View Test Case*. Select it to access the test case details. + +image:session-explorer-view-test-case.png[width=1000,alt="The View Test Case button in the Session Explorer page"] + +[NOTE] +==== + +* If a baseline session does not meet minimum requirements to become a test case (e.g. no actions performed), the button will not be clickable. +* If your session just ended, you may see a tooltip when you select the button asking you to wait a few moments for the session to complete processing before trying again. + +image:convert-to-text-case-disabled.png[width=600,alt="The Convert to Test Case button disabled as the session is still being processed"] + +==== + +=== Create a test case from the list of available sessions in Test Management + +Select *Test Management* from the left-hand menu and choose the *Test Cases* tab. Select *New Test Case*. + +image:test-case-list-empty.png[width=1000,alt="The Test Case list with the New Test Case button"] + +Search for and choose a baseline session from the list. Only sessions that qualify for scriptless and have not already been converted to a test case appear here. Select *Convert*. + +image:select-session-for-conversion.png[width=800,alt="Select a session from the list to convert"] + +If the AI analysis is complete, a success message with an option to *View Test Case* displays. To navigate to the test case details, you can either: + +* Select *View Test Case* from the message. +* Select the new *ID* from the Test Cases List. + +image:test-case-conversion-success.png[width=1000,alt="The test case list with the test case conversion success message"] + +[NOTE] +==== + +If the AI is still analyzing, a message displays explaining the session is still being processed and to try again shortly. + +image:test-case-conversion-unsuccessful.png[width=600,alt="The test case conversion unsuccessful message"] + +==== + +Here are some things you can do with your new test case: + +* xref:test-case/manage-test-steps.adoc[Manage test case] - update test steps, create new versions +* xref:test-run/create-and-manage-test-run.adoc[Create a test run] - create a test run with your new test case +* xref:test-suite/create-and-manage-test-suite.adoc[Add test case to a test suite] - add your test case to a new or existing test suite diff --git a/docs/modules/test-management/pages/test-case/manage-test-steps.adoc b/docs/modules/test-management/pages/test-case/manage-test-steps.adoc new file mode 100644 index 000000000..44a526c93 --- /dev/null +++ b/docs/modules/test-management/pages/test-case/manage-test-steps.adoc @@ -0,0 +1,116 @@ += Manage test case +:page-aliases: test-management:manage-test-steps.adoc + +:navtitle: Manage test case + +Learn how to maintain a test case created by you or your team. + +== Before you start + +* Create a baseline session for Scriptless Automation. +* Convert a session into a test case. + +== Navigate to Test Case Details + +Find a test case and view its details using one of the following methods. + +In *Session Explorer*, select *View Test Case* if the session has been converted to a test case. + +image:session-explorer-view-test-case.png[width=1000,alt="The View Test Case button in the Session Explorer page"] + +In *Sessions*, xref:session-explorer:search-for-a-session.adoc[search for a session], then select the Test Case ID from that row. If a session does not have a Test Case ID, then it does not have an associated test case. + +image:manage-test-case-session-search.png[width=1000,alt="Search for a session and select test case link"] + +In *Test Management*, select *Test Cases* where you will see a list of test cases and can select an ID to navigate to the *Test Case Details*. + +image:test-case-list.png[width=1000,alt="View list of test cases"] + +You can perform the following actions and review the following information on the *Test Cases* page: + +* *Search Test Cases*: Search for test cases via app name and Test Case Name. +* *New Test Case*: Create new test case via this button. +* *Source*: icon indicating the session type of the baseline session (manual or automation). +* *ID*: the unique identifier assigned to the test case. Select to navigate to the test case details. +* *Name*: includes tags for the applications included in the test case and the name of the test case. +* *Last Updated*: indicates when the test case steps were last updated. +* *Last Run*: displays date timestamp and navigates to the most recent test run for the test case. +* *Test Runs*: Navigate to a list of test runs for the test case. +* *Test Suites*: Navigate to a list of test suites that include the test case. +* *Actions*: +** Run the test case. +** Clone (or copy) the test case. +** Delete the test case. + +== View test case details + +After selecting a test case using any of the methods above, the *Test Case Details* page will appear. + +image:test-case-details-general.png[width=1000,alt="View and maintain general test case details"] + +You can review the following information: + +* *Tags*: the name of the applications being tested. +* *Test Case ID*: the unique identifier assigned to the test case. +* *Source*: link to the baseline session from which the test case was converted. +* *Source Type*: the session type of the baseline session (manual or automation). +* *Creator*: the user who created the test case. +* *Created on*: the date and time the test case was created. + +You can update the following details: + +* *Name*: the name of the test case. This name is useful for searching for a test case and is displayed in test run details. +* *Test Suite*: assign or remove the test case to or from an existing test suite(s). If there are no test suites, * xref:test-suite/create-and-manage-test-suite.adoc[create a test suite] first. +* *Test Case Version*: choose the version of the test case from the version history. As changes to test steps are made and saved, new test case versions are created. +* *Description*: description of the test case. + +You can perform the following actions via the icons in the top right of the page: + +* *Generate Appium Script* allows you to create an Appium script in a selected programming language. +* *Run Test Case* takes you to the Test Run Details page to configure and initiate a test run for the test case. +* *Clone Test Case* creates a copy of the current test case. This is useful if you want to modify test steps to create a new test case. Only the currently selected test case version can be cloned. +* *Delete Test Case* when you no longer want to keep a test case. After a test case is deleted, it is removed from all currently assigned test suites. All test runs created from a deleted test case are still accessible, but they can no longer be rerun. + +== Manage test steps + +The *Test Steps* section displays descriptions and screenshots of the steps in the test case. + +The following details are included in each test steps: + +* The sequence number of the action +* The action performed +* The screenshot +* The touch point or the swipe action on the screen +* The bounding box of the element + +=== Delete test steps + +In a manual sessions, there may be unwanted or redundant steps performed by mistake. To remove a step, select the *check box* for that step. You can select multiple test steps at the same time. + +image:delete-test-steps-context.png[width=1000,alt="Delete test steps"] + +Select the *Trash* icon to remove the selected steps, then select *Save*. + +[IMPORTANT] + +* Deleting a test step cannot be undone. +* Changes will not take effect if you do not select *Save*. + +The changes are saved to a new version of the test case. You can always go back to previous versions of the test case by selecting it in the Test Case Version dropdown. + +=== Remediate test steps + +For Touch actions, there are cases where the AI returns low confidence in selecting the element, and user input is needed to select the correct element. This process is referred to as remediation. + +Follow this guide when remediating test steps xref:remediation/annotate-a-test-step.adoc[here]. + +The remediation changes are saved to a new version of the test case. You can always go back to previous versions of the test case by selecting it in the Test Case Version dropdown. + +== Planned enhancements for managing test cases + +We have a number of enhancements planned for test cases. The following features are in progress: + +* *Assertions*: the ability to add checks to test steps. +* *Conditional logic*: the ability to alter behavior based on test run results. +* *Data-driven testing*: the ability to provide multiple datasets for a test run. +* *Edit text*: Ability to update the text entries in test steps. diff --git a/docs/modules/test-management/pages/test-run/create-and-manage-test-run.adoc b/docs/modules/test-management/pages/test-run/create-and-manage-test-run.adoc new file mode 100644 index 000000000..7b41c5c2f --- /dev/null +++ b/docs/modules/test-management/pages/test-run/create-and-manage-test-run.adoc @@ -0,0 +1,167 @@ += Create and manage test run +:page-aliases: scriptless-automation:run-scriptless-with-the-kobiton-portal.adoc + +:navtitle: Create and manage test run + +Learn how to create and manage test runs to efficiently execute tests across multiple devices. + +== What is a test run? + +A test run consists of one or more sessions in which the AI performs the test steps from a test case or test suite on one or more devices. This type of session is called a revisit execution. + +Things to note regarding test runs: + +* The revisit session appears in the sessions list with the *Type* as Appium and the *Name* as `Revisit execution ` . +* A revisit session only executes one test case on one device. If a test run includes multiple test cases (a test suite) or multiple devices, it will generate multiple revisit sessions. + +== Before you start + +* Create a baseline session +* Create a test case +* (Optional) Remediate test steps +* (Optional) Create a test suite + +== Create a Test Run + +From the menu, select the *Test Management* icon. Then select *Test Runs*. + +Select *New Test Run*. + +image:test-management:test-run-create-and-manage-test-run-new-test-run.PNG[width=700,alt="Selecting New Test Run by going to Test Management and then Test Runs"] + +The *Test Run Setup* screen displays. + +image:test-management:test-run-create-and-manage-test-run-test-run-setup.PNG[width=700,alt="The Test Run Setup screen is displayed in Test Management section"] + +In this screen, input the following: + +* Name +* Description (optional) + +Follow the next sections to configure: + +* Test Case or Test Suite +* Application Versions +* Device Bundle or Individual Devices +* Device Allocation Strategy + +=== Test Case or Test Suite + +On *Test Run Setup* page, you can choose either *Test Case* or *Test Suite*, then choose one test case or one test suite from the dropdown list. + +image:test-management:test-run-create-and-manage-test-run-test-case-or-test-suite.PNG[width=700,alt="Choose either Test Case or Test Suite"] + +Optionally, you can select *Customize* to customize the test case or test suite. + +* For Test Case, you can select the version to run. By default, the latest version is selected. ++ +image:test-management:test-run-create-and-manage-test-run-customize-test-case.PNG[width=300,alt="Select the specific version to run for the test case"] +* For Test Suite, you can select or deselect the individual test cases to run, as well as the version to run for each test case. ++ +image:test-management:test-run-create-and-manage-test-run-customize-test-suite.PNG[width=700,alt="For the given Test Suite, select or deselect test cases and version that you want to run"] + +After customizing, select *Save* to confirm the changes. + +=== Application Versions + +After selecting a test suite or test case, the available *Application Versions* for the test case or test suite will be displayed. If an application has multiple versions, you can choose the specific version using the dropdown. + +image:test-management:test-run-create-and-manage-test-run-application-versions.PNG[width=700,alt="Select the application version for the test suite or test case"] + +=== Device Bundle or Individual Devices + +After selecting an application version, choose either *Device Bundle* or *Individual Devices* to run the test case or test suite on. + +You can select either: + +* One device bundle, ++ +image:test-management:test-run-create-and-manage-test-run-device-bundle-or-individual-devices.PNG[width=700,alt="Device bubdle or individual devices selection options"] ++ +NOTE: The NOVA Recommended Devices bundle is automatically created by the system. To create a custom bundle, follow https://docs.kobiton.com/organization/device-bundles/create-a-device-bundle[this guide]. +* Or at least one device in the dropdown list for *Individual Devices*, which includes all public and private devices assigned to your current team. ++ +image:test-management:test-run-create-and-manage-test-run-list-individual-devices.PNG[width=700,alt="Dropdown list of individual devices for selection"] ++ +NOTE: Only online devices in the portal are available for selection in the *Individual Devices* list. + +If *Device Bundle* is selected, select *Customize* to choose the devices to run in that bundle, then choose *Save*. + +image:test-management:test-run-create-and-manage-test-run-customize-device-bundle.PNG[width=700,alt="Select the Customize option to choose the devices to run in the bundle"] + +=== Device Allocation Strategy + +Next, choose a *Device Allocation Strategy*. This only applies when running a test suite. + +image:test-management:test-run-create-and-manage-test-run-device-allocation-strategy.PNG[width=700,alt="When running a test suite, choose the Device Allocation Strategy"] + +=== Execute the test run + +After filling in all required fields, select *Run* to create and execute the test run. + +image:test-management:test-run-create-and-manage-test-run-execute-test-run.PNG[width=700,alt="Selecting the Run option to create and execute the test run"] + +Once the test run is created, the success message appears with the option to *View Test Run*. + +image:test-management:test-run-create-and-manage-test-run-test-run-created-success-message.PNG[width=700,alt="Success message appears once the run is created"] + +Either select *View Test Run* on the success message, or select the newly created test run *ID* in the *Test Runs* list to view the test run results. + +image:test-management:test-run-create-and-mange-test-run-view-test-run.PNG[width=700,alt="Viewing the test run results"] + +Alternatively, you can create a test run from a test case or a test suite. + +== Run a test case or test suite + +To create a test run from a test case, go to *Test Management → Test Cases*, then either: + +* Select the *Play* icon in the *Test Case Details* page. ++ +image:test-management:test-run-create-and-manage-test-run-case-details.PNG[width=700,alt="Running is test case or test suite via the Test Case Details page"] +* Choose the *3-dot* icon under *Actions* in the Test Case list, then select *Run Test Case*. + +To create a test run from a test suite, go to *Test Management → Test Suite*, choose the *3-dot* icon, then select *Run Test Suite*. + +image:test-management:test-run-create-and-manage-test-run-run-test-suite.PNG[width=700,alt="Creating a test run from a test suite"] + +The *Test Run Setup* displays with the following information pre-filled: + +* Test Case or Test Suite +* Application Versions + +Choose the *Device Bundle* or *Individual Devices* to run on and *Device Allocation Strategy* (if needed), then select *Run* to create and execute the test run. + +== Rerun a test run + +After creating a test Run, you can quickly create a new test run with the same setup. This is called a rerun. + +To do this, select the *3-dot* icon in the *Test Runs* list or *Test Run Results* page, then select *Rerun Test Run*. + +image:test-management:test-run-create-and-manage-test-run-rerun-test-run.PNG[width=700,alt="Rerunning a test run via the Test Run Results page"] + +The *Test Run Setup* uses the last run’s configuration, pre-filling the following information with the same values selected in the original test run: + +* Test Case or Test Suite +* Application Versions +* Individual Devices or Device Bundle +* Device Allocation Strategy + +Select *Run* to create and execute the test run. + +== Manage a test run + +To manage a test run, select the *Test Management* icon from the menu, then select *Test Runs*. + +The Test Run list page displays. + +image:test-management:test-run-create-and-manage-test-run-manage-a-test-run.PNG[width=700,alt="Managing test runs via the Test Run page"] + +On this page, you can do the following: + +* Search for test run by name, tags, OS, created by, and created on. +* Open the *Test Run Results* page by selecting the test run *ID*. +* Select the *3-dot* icon, then: +** *Rerun Test Run* to create a new test run with the same setup. +** *Terminate Test Run* to terminate all running revisit session(s). +** *Delete Test Run* to delete the test run. + diff --git a/docs/modules/test-management/pages/test-run/review-test-run-results.adoc b/docs/modules/test-management/pages/test-run/review-test-run-results.adoc new file mode 100644 index 000000000..c6543c418 --- /dev/null +++ b/docs/modules/test-management/pages/test-run/review-test-run-results.adoc @@ -0,0 +1,102 @@ += Review test run results +:navtitle: Review test run results + +Learn how to review the results of test run after creating it to identify any crashes, errors, accessibility issues, and verify that all test have passed. Test run results help you detect the over app quality and detect any potential bugs. + +== Navigate to test run results + +After creating a test run, you can view the test run results using one of the following methods: + +* After creating a test run, select *View Test Run* from the success notification. + +image:test-management:test-run-review-test-run-results-view-test-run.PNG[width=700,alt="Selecting the View Test Run options from the success notification popup"] + +* Select the test run *ID* from the *Test Runs* page. + +image:test-management:test-run-review-test-run-results-id-from-test-runs.PNG[width=700,alt="Selecting the test run ID from the Test Runs page"] + +== Test Run Results + +The following is an example of the Test Run Results page: + +image:test-management:test-run-review-test-run-results-test-run-results.PNG[width=700,alt="A view of the Test Run Results page"] + +The *Test Run Results* page contains: + +* General information +* More actions +* Revisit execution results + +=== General information + +The following details displayed on the *Test Run Results* page provide an overview of the test run’s key information: + +image:test-management:test-run-review-test-run-results-test-run-results-general-information.PNG[width=700,alt="A view of the details on the Test Run Results page"] + +* *App version*: the app version used for the test run. +* *Test*: the name of the test run. +* *Test Run ID*: the unique identifier assigned to the test run. +* *Creator*: the user who created the test run. +* The icon representing the OS (Android or iOS) and number of devices being tested. +* *Created on*: the date and time the test run was created. +* *Elapsed*: the total time that has passed since the test run began. +* *Crash*: number of instances where an app crash is detected. You can select this button to filter revisit executions that contains Crash instances. +* *Accessibility*: number of instances where an Accessibility Validation is raised. You can select this button to filter revisit executions that contains Accessibility instances. + +=== More actions + +By selecting the *3-dot icon*, you can select the following actions for the test run: + +image:test-management:test-run-review-test-run-results-more-actions-3dot-icon.PNG[width=700,alt="A view of action that can be performed by clicking the 3-dot icon"] + +* *Rerun Test Run*: create a new test run with the same setup. +* *Terminate Test Run*: terminate all running revisit execution(s). +* *Delete Test Run*: delete the test run. + +Selecting the *Show* button will open a dialog to filter the revisit executions by status: + +image:test-management:test-run-review-test-run-results-more-actions-show-button.PNG[width=700,alt="Filtering the revisit executions by status via the Show button"] + +=== Revisit execution results + +Below the general information, a grid displays the status of each test case’s revisit execution on each device, along with validation icons. + +NOTE: The latest status of the revisit executions and validation icons will be refreshed periodically. + +image:test-management:test-run-review-test-run-results-revisit-execution-results.PNG[width=700,alt="Revisiting the execution resutls"] + +Possible revisit execution statuses are: + +* *Running*: the revisit execution either has not started yet, or is in progress. +* *Success*: the revisit execution completed without error. +* *Failed*: the revisit execution failed because the app under test crashed. +* *Need Action*: the AI encountered a blocker and Blocker Remediation is required. +* *Error*: the revisit execution failed due to a Kobiton system issue. + +Once the revisit session is created, select the status to open the *Explorer* page of the revisit session. + +Next to each test case in the grid, there are several icons: + +* *Sensitive data indicator*: if the Test Case has sensitive data, a lock icon displays. ++ +image:test-management:test-run-review-test-run-results-revisit-execution-results-sensitive-data-indicator.PNG[width=500,alt="The sensitive data indicator and the helper text associated with it"] +* *View Test Case Details*: go to the Test Case Details screen. ++ +image:test-management:test-run-review-test-run-results-revisit-execution-results-tast-case-results.PNG[width=500,alt="The icon to view test case details"] +* *View Camera Roll*: see the Camera Roll section. ++ +image:test-management:test-run-review-test-run-results-revisit-execution-results-camera-roll.PNG[width=500,alt="The icon to view the camera roll"] + +== Test Run Overview (Camera Roll) + +Select *View Camera Roll* to compare the steps outlined in the test case with the steps executed during each test run session. + +image:test-management:test-run-review-test-run-results-test-run-overview-view-camera-roll.PNG[width=700,alt="Viewing the camera roll to compare the steps of the test case with the steps executed during each test run session"] + +To view the actual test steps for a device, expand the individual session. + +NOTE: Only completed sessions can be expanded to view the test steps. + +image:test-management:test-run-review-test-run-results-test-run-overview-individual-sections.PNG[width=700,alt="Viewing the actual test steps for a device"] + +If a blocker is encountered, select *Resolve Blocker* to remediate it. \ No newline at end of file diff --git a/docs/modules/test-management/pages/test-suite/create-and-manage-test-suite.adoc b/docs/modules/test-management/pages/test-suite/create-and-manage-test-suite.adoc new file mode 100644 index 000000000..37272e810 --- /dev/null +++ b/docs/modules/test-management/pages/test-suite/create-and-manage-test-suite.adoc @@ -0,0 +1,52 @@ += Create and manage test suites +:navtitle: Create and manage test suites + +Learn how to create and manage test suites to group your test cases and streamline your testing process. + +== What is a test suite? + +A test suite is a collection of test cases that are grouped together to: + +* Easily find and manage test cases. +* Rerun all test cases when creating a test run from a test suite. + +== Create a test suite + +Select **Test Management** from the menu, then choose **Test Suites**. + +Choose **New Test Suite**. + +image:test-management:create-and-manage-test-suite-create-test-suite.PNG[width=750,alt="Create and manage test suites in Kobiton. Test management screen"] + +In the **Create Test Suite** dialog, fill in the following: + +* **Operating System**: choose either iOS or Android. Once chosen, the test suite can only include test cases for that specific OS. +* **Name**: the name of the test suite. +* **Description** (Optional): add a description for the test suite. + +image:test-management:create-and-manage-test-suite-create-test-suite-info.PNG[width=300,alt="Diaglog box for the Create Test Suite action. Reuires the selection of operating system, name of the test suite, and an optional description"] + +Once complete, select **Next**. + +In the **Choose Test Case** dialog, search for and select the test cases to add to the test suite (optional). Select **Create** to create the test suite. + +image:test-management:create-and-manage-test-suite-choose-test-suite.PNG[width=750,alt="Choose test cases to add to the test suite"] + +== Manage test suites + +After you create the new test suite, it appears in the Test Suites list. + +image:test-management:create-and-manage-test-suite-test-suite-created.PNG[width=750,alt="Test suite created and it now appears in the list"] + +All the test cases assigned to the test suite are listed below it. You can collapse/expand the list of test cases for each test suite. + +To manage a test suite, select the 3-dot icon, then select an option: + +* **Run Test Suite**: create a test run from the test suite. +* **Edit Test Suite**: edit the name and description (operating system cannot be edited). +* **Choose Test Cases**: assign/remove test cases. +* **Delete Test Suite**: delete the test suite. + +NOTE: Test cases in the test suite are not deleted when deleting a test suite. + +image:test-management:create-and-manage-test-suite-manage-test-suite.PNG[width=750,alt="Manages test suite by clicking the three dots"] \ No newline at end of file