diff --git a/docs/docs/articles/run-tests-with-github-actions.md b/docs/docs/articles/run-tests-with-github-actions.md index b0f99a8c913..4a212a99e67 100644 --- a/docs/docs/articles/run-tests-with-github-actions.md +++ b/docs/docs/articles/run-tests-with-github-actions.md @@ -101,7 +101,7 @@ with: OTHER_ENV="${{ secrets.ExternalToken }}" ``` -#### Real-life examples +#### Real-life Examples `testkube-run-action` is also used for running Testkube internal tests with Testkube. Workflow for Testkube Dashboard E2E tests can be found [here](https://github.com/kubeshop/testkube-dashboard/blob/develop/.github/workflows/pr_checks.yml#L28) ## Inputs diff --git a/docs/docs/articles/scheduling-tests.mdx b/docs/docs/articles/scheduling-tests.mdx index 5d1c6fabc46..8defac25db1 100644 --- a/docs/docs/articles/scheduling-tests.mdx +++ b/docs/docs/articles/scheduling-tests.mdx @@ -23,9 +23,17 @@ This works similarly to scheduled Test and Test Suite executions done by externa In the Testkube Dashboard, when you have selected a Test or Test Suite, in the **Settings** tab, click on **Scheduling** to create a schedule for the Test or Test Suite. -![Schedule Tests](../img/schedule-tests.png) +## Tests -![Schedule Tests Test Suites](../img/schedule-test-suites.png) +![Schedule Tests](../img/schedule-tests-1.14.png) + +![Schedule Tests Options](../img/schedule-tests-options-1.14.png) + +## Test Suites + +![Schedule Test Suites](../img/schedule-test-suites-1.14.png) + +![Schedule Test Suites Options](../img/schedule-test-suites-options-1.14.png) diff --git a/docs/docs/articles/test-triggers.mdx b/docs/docs/articles/test-triggers.mdx index 1b91cd41d3b..f309c691c91 100644 --- a/docs/docs/articles/test-triggers.mdx +++ b/docs/docs/articles/test-triggers.mdx @@ -18,17 +18,17 @@ Watch our [video guide](#video-tutorial) on using Testkube Test Triggers to perf Click on the lightening bolt icon on the left of the Testkube IDE to open the dialog to create test triggers. Any current test triggers will be listed and the `Create a new trigger` button is at the top right of the screen. -![Trigger Screen](../img/trigger-screen.png) +![Trigger Screen](../img/trigger-screen-1.14.png) The `Create new trigger` dialog opens: -![Create Trigger](../img/create-trigger.png) +![Create Trigger](../img/create-trigger-1.14.png) Input the condition that will cause the trigger and click `Next`. Input the action that will be the result of the trigger condition happening and click `Create`. -![Create Trigger Action](../img/create-trigger-action.png) +![Create Trigger Action](../img/create-trigger-action-1.14.png) Get all the details in the video below! diff --git a/docs/docs/articles/testkube-dashboard-explore.md b/docs/docs/articles/testkube-dashboard-explore.md index 3b1e8b9f07c..22863e831a9 100644 --- a/docs/docs/articles/testkube-dashboard-explore.md +++ b/docs/docs/articles/testkube-dashboard-explore.md @@ -2,28 +2,28 @@ The Testkube Dashboard displays the current status of Tests and Test Suites executed in your environment. -![Test List](../img/test-list-1.6.png) +![Test List](../img/test-list-1.14.png) -![Test Suites List](../img/test-suite-list-1.6.png) +![Test Suites List](../img/test-suite-list-1.14.png) After selecting Tests or Test Suites in the left bar, the list of recent runs is displayed. At the top of the list, a Search field and filters for Labels and Status make finding tests in a large list easier: -![Search & Filter](../img/search-filter-1.6.png) +![Search & Filter](../img/search-filter-1.14.png) Select any Test or Test Suite to see the recent executions and their statuses. -![Execution Status](../img/execution-status-1.6.png) +![Execution Status](../img/execution-status-1.14.png) The execution statistics of the chosen Test or Test Suite are at the top of the screen, along with a graph of success or failure for the executions. The **Recent executions** tab has the list of executions. A green checkmark denotes a successful execution, a red 'x' denotes a failed execution and circling dots denotes a current run of a Test or Test Suite. -![Recent executions](../img/recent-executions-1.6.png) +![Recent executions](../img/recent-executions-1.14.png) The **CLI Commands** tab shows the commands used to perform the selected test: -![CLI Commands](../img/CLI-commands-1.6.png) +![CLI Commands](../img/CLI-commands-1.14.png) -The **Settings** tab contains 3 types of information about the Test or Test Suite. +Use the **Settings** to view or change the local settings of the Test or Test Suite. -![Setting](../img/settings-1.6.png) +![Setting](../img/settings-1.14.png) diff --git a/docs/docs/articles/testkube-dashboard-general-settings.md b/docs/docs/articles/testkube-dashboard-general-settings.md index 1e8ad89a2b7..baa8e778aba 100644 --- a/docs/docs/articles/testkube-dashboard-general-settings.md +++ b/docs/docs/articles/testkube-dashboard-general-settings.md @@ -2,30 +2,46 @@ Clicking the **General** box under the **Settings** tab displays the **Test name & description** and **Labels** for the Test or Test Suite: -![Settings General](../img/settings-general-1.9.png) +![Settings General](../img/settings-general-1.14.png) It is also the place to configure a Timeout or Failure Handling or delete a Test or Test Suite: -![Settings General Delete](../img/settings-general-delete-1.9.png) +![Settings General Delete](../img/settings-general-delete-1.14.png) ## Test Clicking **Test** will display more details for the selected Test: -![Settings Test](../img/settings-test-1.9.png) +![Settings Test](../img/settings-test-1.14.png) -If you have selected a Test Suite, the Tests contained in that Test Suite will be shown. +If you have selected a Test Suite, the Tests contained in that Test Suite will be shown. In this view, you will also see which test are run in parallel and which are run sequentially. Please see the [Scheduling Tests](./scheduling-tests.mdx) doc to learn more about how to schedule tests. -![Settings Test for Test Suite](../img/settings-test-suite-1.9.png) +![Settings Test for Test Suite](../img/settings-test-suite-1.14.png) + +## Execution + +Testkube allows for the Pre-Run or Post-Run of commands for a test. + +In the Execution section of the Settings tab, you can set up a command or a script (relative to your source root) which will be executed before or after the test itself is started. + +![Execution](../img/execution-1.14.png) ## Variables & Secrets -![Variable Tab](../img/variable-tab-1.6.png) +![Variable Tab](../img/variable-tab-1.14.png) + +Visit [Using Test Variables](./adding-tests-variables.md) for a description of adding Variables and Secrets. + +## Scheduling + +Add a cronjob-like schedule for your test which will then be executed automatically. + +![Scheduling](../img/scheduling-1.14.png) -Visit [Using Tests Variables](./adding-tests-variables.md) for a description of adding Variables and Secrets. +![Scheduling Options](../img/scheduling-options-1.14.png) ## Definition -Clicking the **Definition** box under the **Settings** tab allows the validation and export of the configuration for the Test or Test Suite: +Clicking the **Definition** section under the **Settings** tab allows the validation and export of the configuration for the Test or Test Suite: -![Settings Definition](../img/settings-definition-1.9.png) +![Settings Definition](../img/settings-definition-1.14.png) diff --git a/docs/docs/articles/testkube-dashboard.md b/docs/docs/articles/testkube-dashboard.md index 003a3da8d41..3fa61961ef3 100644 --- a/docs/docs/articles/testkube-dashboard.md +++ b/docs/docs/articles/testkube-dashboard.md @@ -2,7 +2,7 @@ The Testkube Dashboard provides a simple web-based user interface for monitoring Testkube test results via a web browser. -![img.png](../img/dashboard-1.6.png) +![img.png](../img/dashboard-1.14.png) The URL to access the Testkube Dashboard is [https://demo.testkube.io](https://demo.testkube.io), which, when first loaded, will prompt for the results endpoint of your Testkube installation. Click the **Settings** icon at the bottom left of the screen to return to change the Testkube API endpoint. diff --git a/docs/docs/articles/webhooks.mdx b/docs/docs/articles/webhooks.mdx index 075ff42849c..2c041df12ec 100644 --- a/docs/docs/articles/webhooks.mdx +++ b/docs/docs/articles/webhooks.mdx @@ -125,7 +125,7 @@ Webhook payload can be configured - in this example, `event id`: -Webhook payload can be configured in Webhook Settings->Action +When you have selected an existing Webhook, its payload can be configured in Webhook Settings->Action. ![Dashboard webhook - webhook settings action`](../img/dashboard-webhook-settings-action.png) diff --git a/docs/docs/img/CLI-commands-1.14.png b/docs/docs/img/CLI-commands-1.14.png new file mode 100644 index 00000000000..b635690255b Binary files /dev/null and b/docs/docs/img/CLI-commands-1.14.png differ diff --git a/docs/docs/img/create-trigger-1.14.png b/docs/docs/img/create-trigger-1.14.png new file mode 100644 index 00000000000..d488bb290f9 Binary files /dev/null and b/docs/docs/img/create-trigger-1.14.png differ diff --git a/docs/docs/img/create-trigger-action-1.14.png b/docs/docs/img/create-trigger-action-1.14.png new file mode 100644 index 00000000000..78964d1cba2 Binary files /dev/null and b/docs/docs/img/create-trigger-action-1.14.png differ diff --git a/docs/docs/img/dashboard-1.14.png b/docs/docs/img/dashboard-1.14.png new file mode 100644 index 00000000000..fc22c2fb166 Binary files /dev/null and b/docs/docs/img/dashboard-1.14.png differ diff --git a/docs/docs/img/execution-1.14.png b/docs/docs/img/execution-1.14.png new file mode 100644 index 00000000000..ad47a655028 Binary files /dev/null and b/docs/docs/img/execution-1.14.png differ diff --git a/docs/docs/img/execution-status-1.14.png b/docs/docs/img/execution-status-1.14.png new file mode 100644 index 00000000000..07ff7ef7806 Binary files /dev/null and b/docs/docs/img/execution-status-1.14.png differ diff --git a/docs/docs/img/recent-executions-1.14.png b/docs/docs/img/recent-executions-1.14.png new file mode 100644 index 00000000000..5682e6b3b59 Binary files /dev/null and b/docs/docs/img/recent-executions-1.14.png differ diff --git a/docs/docs/img/schedule-test-suites-1.14.png b/docs/docs/img/schedule-test-suites-1.14.png new file mode 100644 index 00000000000..c6d16623883 Binary files /dev/null and b/docs/docs/img/schedule-test-suites-1.14.png differ diff --git a/docs/docs/img/schedule-test-suites-options-1.14.png b/docs/docs/img/schedule-test-suites-options-1.14.png new file mode 100644 index 00000000000..8cce027913f Binary files /dev/null and b/docs/docs/img/schedule-test-suites-options-1.14.png differ diff --git a/docs/docs/img/schedule-tests-1.14.png b/docs/docs/img/schedule-tests-1.14.png new file mode 100644 index 00000000000..3aced40c46c Binary files /dev/null and b/docs/docs/img/schedule-tests-1.14.png differ diff --git a/docs/docs/img/schedule-tests-options-1.14.png b/docs/docs/img/schedule-tests-options-1.14.png new file mode 100644 index 00000000000..e761ac5829f Binary files /dev/null and b/docs/docs/img/schedule-tests-options-1.14.png differ diff --git a/docs/docs/img/scheduling-1.14.png b/docs/docs/img/scheduling-1.14.png new file mode 100644 index 00000000000..9b552f83a2f Binary files /dev/null and b/docs/docs/img/scheduling-1.14.png differ diff --git a/docs/docs/img/scheduling-options-1.14.png b/docs/docs/img/scheduling-options-1.14.png new file mode 100644 index 00000000000..1bd27fc01e1 Binary files /dev/null and b/docs/docs/img/scheduling-options-1.14.png differ diff --git a/docs/docs/img/search-filter-1.14.png b/docs/docs/img/search-filter-1.14.png new file mode 100644 index 00000000000..5b794974469 Binary files /dev/null and b/docs/docs/img/search-filter-1.14.png differ diff --git a/docs/docs/img/settings-1.14.png b/docs/docs/img/settings-1.14.png new file mode 100644 index 00000000000..107f3299060 Binary files /dev/null and b/docs/docs/img/settings-1.14.png differ diff --git a/docs/docs/img/settings-definition-1.14.png b/docs/docs/img/settings-definition-1.14.png new file mode 100644 index 00000000000..8b1fa39fc06 Binary files /dev/null and b/docs/docs/img/settings-definition-1.14.png differ diff --git a/docs/docs/img/settings-general-1.14.png b/docs/docs/img/settings-general-1.14.png new file mode 100644 index 00000000000..90201d5eebf Binary files /dev/null and b/docs/docs/img/settings-general-1.14.png differ diff --git a/docs/docs/img/settings-general-delete-1.14.png b/docs/docs/img/settings-general-delete-1.14.png new file mode 100644 index 00000000000..2ac943fa068 Binary files /dev/null and b/docs/docs/img/settings-general-delete-1.14.png differ diff --git a/docs/docs/img/settings-test-1.14.png b/docs/docs/img/settings-test-1.14.png new file mode 100644 index 00000000000..e367f442dc8 Binary files /dev/null and b/docs/docs/img/settings-test-1.14.png differ diff --git a/docs/docs/img/settings-test-suite-1.14.png b/docs/docs/img/settings-test-suite-1.14.png new file mode 100644 index 00000000000..51c530e679d Binary files /dev/null and b/docs/docs/img/settings-test-suite-1.14.png differ diff --git a/docs/docs/img/test-list-1.14.png b/docs/docs/img/test-list-1.14.png new file mode 100644 index 00000000000..b6a2463ebce Binary files /dev/null and b/docs/docs/img/test-list-1.14.png differ diff --git a/docs/docs/img/test-suite-list-1.14.png b/docs/docs/img/test-suite-list-1.14.png new file mode 100644 index 00000000000..5c08d08f6fd Binary files /dev/null and b/docs/docs/img/test-suite-list-1.14.png differ diff --git a/docs/docs/img/trigger-screen-1.14.png b/docs/docs/img/trigger-screen-1.14.png new file mode 100644 index 00000000000..d06bb1a8f3a Binary files /dev/null and b/docs/docs/img/trigger-screen-1.14.png differ diff --git a/docs/docs/img/variable-tab-1.14.png b/docs/docs/img/variable-tab-1.14.png new file mode 100644 index 00000000000..ed7613a5923 Binary files /dev/null and b/docs/docs/img/variable-tab-1.14.png differ diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000000..bc67ebf2bd4 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "testkube", + "lockfileVersion": 3, + "requires": true, + "packages": {} +}