Skip to content

Commit

Permalink
Updated the following docs as per new UI (#321)
Browse files Browse the repository at this point in the history
  • Loading branch information
bharathk08 authored Nov 8, 2023
1 parent 82884a1 commit 95812cc
Show file tree
Hide file tree
Showing 3 changed files with 159 additions and 72 deletions.
77 changes: 57 additions & 20 deletions src/pages/docs/test-management/test-plans/distributed-testing.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,88 @@
---
title: "Distributed testing"
title: "Distributed Testing"
page_title: "Distributed Testing in Testsigma"
metadesc: "Improve your testing efficiency with Testsigma's distributed testing. Learn how to execute tests across multiple machines and increase test coverage quickly."
noindex: false
order: 8.27
page_id: "Distributed Testing "
page_id: "Distributed Testing"
warning: false
contextual_links:
- type: section
name: "Contents"
name: "Contents"
- type: link
name: "Steps to enable distributed testing"
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Create Distributed Testing"
url: "#steps-to-enable-distributed-testing"
---


---


Distributed testing means that a test scenario is segmented into several parts, and each of them is performed on a separate machine, either sequentially or in parallel. It also suggests that the test parts interact with each other during a test run, which makes them coordinated and synchronized.

This type of testing is generally used to test distributed software — systems with components that run on different machines and interact with each other, such as a client-server system or an internet-based application web or intranet sites, with significant functional units running in multiple locations.

The goal of distributed testing is to know how different components of the system interact with each other. While multiple computers will run simultaneously during the test, each one will be running a different application component and playing a different role.

Distributed testing is achieved in Testsigma by splitting up test plan execution across multiple machines. To do this, Testsigma lets you select different test suites for each selected test machine, where each test suite encompasses one or more components of the application.

---

*Distributed testing* means that a test scenario is segmented into several parts and each of them is performed on a separate machine either sequentially or in parallel. It also suggests that the test parts interact with each other during a test run which make them coordinated and synchronized.

This type of testing is generally used to test distributed software — systems with
components which run on different machines, and interact with each other,
such as a client-server system, or an Internet-based application web or intranet sites, with major
functional units running in multiple locations.
## **Prerequisites**

The goal of distributed testing is to know how different components of the system interact with each other. While multiple computers will be running simultaneously during the test, each
one will be running a different component of the application, and will be
playing a different role.
- You should know [how to create a test suite](https://testsigma.com/docs/test-management/test-suites/overview/#creating-a-test-suite).

Distributed testing is achieved in Testsigma by splitting up test plan execution across multiple machines. To do this, Testsigma lets you select different test suites for each selected test machine where each test suite encompasses one or more component of the application.
- You should know [how to create a test plan](https://testsigma.com/docs/test-management/test-plans/overview/#steps-to-create-a-test-plan).

<br>
- You should know [how to manage test machines](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/).

---

## **Steps to enable distributed testing**

1. Navigate to **Test Plans** and click on **Create Test Plan**.

![Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditenav.png)

1. Navigate to **Test Machines & Suites Selection** under the **Create test plan** form. *If you are not familiar with creating a test plan, refer to [add, edit,delete a test plan](https://testsigma.com/docs/test-management/test-plans/overview/)*.
2. On the **Create Test Plan** page, select **Custom test plan** from **Test Plan Type**.

2. Under the **Test machines & suites selection** tab,select the test suite for which you want to add the test machine for test execution. *For more information refer to [adding test suites](https://testsigma.com/docs/test-management/test-plans/manage-test-suites/)*
![Create Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditecustomtp.png)

3. Once you have selected the test suites, select the test machines to run the coressponding test suite. *For more information refer to [add test machines](https://testsigma.com/docs/test-management/test-plans/manage-test-machines/)*.
[[info | Note:]]
|To enable distributed testing you have to select different test suites for different test machines.
3. Click on **Add Test Suites & Link Machine Profiles**.

See the below GIF to understand the workflow to enable distributed testing:![distributed testin](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/test-management/test-plans/distributed-testing/distributed_testing.gif)
![Link Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditelmachines.png)

4. Click on **Add Test Suites**.

![Add Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/diteaddts.png)

5. Select test suites and click on **Add to Plan**.

![Add to Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/diteatp.png)

6. Click on **Test Machine** to add test machines to run the test suite.

![Add Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditemachines.png)

7. On **Select test machine profiles** overlay, select test machines and click on **Save selections**.

![Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditetmoverlay.png)

[[info | **NOTE**:]]
| For distributed testing, you must select different test suites for different test machines. You can hover over the test suite and click on the test machine corresponding to it to add a different test machine to the test suite.

8. Go to **Test Plan Settings** and click on **Create**.
![Create](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ditecocreate.png)


<br>

Here’s a quick GIF demonstrating how to create distributed testing in Testsigma.

![Distributed Testing](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DistributedTesting.gif)

---
102 changes: 64 additions & 38 deletions src/pages/docs/test-management/test-plans/manage-test-suites.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Manage test suites in test plans"
title: "Manage Test Suites in Test Plans"
metadesc: "Managing test suites in Test Plans makes test execution more efficient. Learn how to add, remove, and organize test suites in test plans in Testsigma."
noindex: false
order: 8.23
Expand All @@ -9,68 +9,94 @@ contextual_links:
- type: section
name: "Contents"
- type: link
name: "Add or Edit a Test Suite via the Edit Test Plan Page"
url: "#add-or-edit-a-test-suite-via-the-edit-test-plan-page"
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Delete a test suite via the edit test plan page"
url: "#delete-a-test-suite-via-the-edit-test-plan-page"
name: "Editing Test Suites in a Test Plan"
url: "#editing-test-suites-in-a-test-plan"
- type: link
name: "Add or edit a test suite via the test plan details specific tab"
url: "#add-or-edit-a-test-suite-via-the-test-plan-details-specific-tab"
name: "Manage Test Suites from Test Plan Details Page"
url: "#manage-test-suites-from-test-plan-details-page"
---

---

As discussed under the [create test plan](https://testsigma.com/docs/test-management/test-plans/overview/) section, at least one *test suite* must be added to a test plan to develop it successfully.
While creating a test plan, you need to add at least one test suite to the test plan to develop it successfully. This article discusses how to manage test suites in test plans.

Here, we will discuss how to add, edit, or delete test suites in an existing test plan.

There are two ways to add or edit a test suite in a test plan:
---

1. Via the **Edit test plan** page
## **Prerequisites**

2. Via the **Test plan details specific** tab
- You need to know [how to create a test plan](https://testsigma.com/docs/test-management/test-plans/overview/#steps-to-create-a-test-plan).

---

## **Add or edit a test suite via the edit test plan page**
## **Editing Test Suites in a Test Plan**

1. Navigate to **Select project** > **Test development** > **Test plan**.
2. Click on an existing test plan. ![clicking Test plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_openingexistingtestplan.png)
3. Click **Edit** on the top right corner of the test plan page.![edit in test plan homepage](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_testplanedit.png)
4. On the **Edit test plan** page, go to the **Test machines & suites selection** tab.
5. Under the **Test machines & suites selection** tab - click **Add test suites**.![New Test Plan UI - add test suites area highlighted](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_addtestsuites.png)
[[info | NOTE:]]
| You should Associate Test Machine with Test Suites to create Test Plan
1. Navigate to **Test Plans**, create a test plan or click on any existing test plan.

6. The **Selected Test Suites** window will appear.![New Test Plan UI - selected test suites layover](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/test-management/test-plans/manage-test-suites/new-test-plan-ui-selected-test-suites-layover.png)
Under the **Filters** section, you can filter the test suites by name. You can enable end-to-end testing if you want to execute test suites across multiple platforms. You can add more test cases by clicking on the **+** icon, and you can remove test cases by clicking on the **-** icon.
7. Once the **Selected Test Suites** section contains the needed test suites, click **Add**.
![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matsnavtps.png)


2. Click on **Edit**.

![Edit Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpetp.png)

---

## **Delete a test suite via the edit test plan page**
3. On the **Edit Test Plan** page, there are 3 sections.
- **Basic Details**: You edit test plan Name, Labels and Test Plan Type on this section.
![Section 1](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpbd.png)

1. Go to the Edit Test Plan page, click **Test machines & suites** tab section.
2. Under the **Test machines & suites selection** tab, hover over the test suite you want to delete.![New Test Plan UI - delete test suite button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_testsuitesdelete.png)
3. Click **delete** corresponding to the test suite you want to delete, this will remove the entry from the **Test suites** section.
4. Click on **Next** and then **Update** to finalise the changes.
- **Add Test Suites & Link Machine Profiles**: You can add/remove test suites and test machines on this section.
![Section 2](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matps2.png)

- **Test Plan Settings**: You can edit **Additional Settings** on this section.
![Section 3](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matps3.png)


Here’s the GIF demonstrating how to manage test suites in test plans.
![Manage Test Suites from Edit Page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TestSuiteManage1.gif)


Alternatively, you can also add/remove test suites directly from the test plan details page.

---

## **Add or edit a test suite via the test plan details specific tab**
## **Manage Test Suites from Test Plan Details Page**

1. Navigate to Test Plans and click on any existing test plan.

![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matsnavtps.png)

2. On the test plan details page, hover over the test machine for which you want to add/remove test suites, click on **Kebab Menu**, and click on **Edit**.

![Edit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpdpedit.png)


3. On the **Edit test machine/device profile** overlay, click on **Add/Remove Test Suites**.

![Edit test machine profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpdpaddremove.png)

4. An overlay of **Add test suites to plan** opens.

![Add test suites to plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpdpatp.png)

5. To add a test suite, click on the ‘**+**’ button of the test suite of your choice from **Available Test Suites**.

![Add Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpavailablets.png)


6. To remove a test suite, click on the ‘**-**’ button of the test suite of your choice from **Selected for Test Plan**.

1. Navigate to **Select Project** > **Test Development** > **Test Plan**.
![Remove test suite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matpdpavailtsre.png)

2. Click on an existing test plan.![clicking Test plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_openingexistingtestplan.png)
3. Click **Edit** on the top right corner of the test plan page.![edit in test plan homepage](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_testplanedit.png)

4. The test plan details page should look something like this:![a test plan details page in Testsigma](https://docs.testsigma.com/images/manage-test-suites/test-plan-details-page-testsigma.png)
7. Once the Test Suites are added/removed from the test plan, click on **Update Machine** from **Edit test machine/device profile** overlay.

5. Go to the tab **Test machines & suites** on the test plan details page. A list of test suites will appear. You can **Edit** or **Delete** the test suites by hovering your mouse over the test suite. Click **Add New** to add test suites.![Test Suites Tab on Test Plan Details page in Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_testsuitesmachines.png)
![Update Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/matputestmachine.png)

6. **Select Test Machines** & **Selected Test Suites** overlay appear in the screen. Give the required details and click **Add Test Suties**. ![Selected Test Suites Button on Test Plan Details page in Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/ts_addtestsuitesnew.png)
Here’s the GIF demonstrating how to manage test suites in test plans from test plan details page.

7. The **Selected Test Suites** pop-up screen appears, and you can add or remove test suites as needed, and then click **Add** at the bottom right. Click **Create** to add new test suites.![Selected Test Suites layover in Testsigma](https://docs.testsigma.com/images/manage-test-suites/selected-test-suites-layover-testsigma.png)
![Workflow GIF](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ManageTestSuite2.gif)

---
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
---
title: "Test execution state is Queued for a long time"
metadesc: "Understand why your test execution state may be stuck in Queued state for an extended period | Know the possible reasons and solutions to resolve the issue"
title: "Test Execution State is Queued for a Long Time"
metadesc: "Understand why your test execution state may be stuck in Queued state for an extended period | Know the possible reasons why your test execution is Queued"
noindex: false
order: 23.6
page_id: "Troubleshooting “Test execution state is Queued for a long time” error"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Steps to Troubleshoot the Issue"
url: "#steps-to-troubleshoot-the-issue"
---

---


If the execution status for your tests has been in the state **Queued** for a long time then, one of the possible reasons is that the number of total parallel runs allowed on your license are already in use.


---

## **Steps to Troubleshoot the Issue**

1. On **Dashboard**, click on **Usage details**.

![Dashboard](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/udtails.png)

2. Check the number of **Parallel Tests**.

![Parallel Tests](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/udparalleltests.png)


Here, we have a license for 3 parallel executions & 3 allowed queues. We can set up a maximum of 3 test runs to run in parallel, which means executing up to 3 tests simultaneously. In addition to the 3 tests running in parallel, you can have up to 3 tests in the queue. The queued tests will execute once the ongoing parallel executions are complete.

In the above example, we have **Parallel Tests 2/3**, which means 2 tests are running in parallel, and 3 is the number of parallel runs allowed at a moment.

3. Suppose the number of parallel runs is equal to the number of parallel licenses for your Testsigma account. In that case, the tests in the queue will remain in the same status until the parallel test runs are completed.

If the execution status for your tests has been in the state "Queued" for a long time then, one of the possible reasons is that the number of total parallel runs allowed on your license are already in use. To check if this is the issue, follow below steps:
1. Click on the "Usage Details" button on the Left Navigation Menu, as also highlighted in the screenshot below:

![Usage details button](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/troubleshooting/web-apps/test-execution-queued-for-a-long-time/usage-details-button.png)
**You can take the following actions to fix the issue:**

2. Check the number of Parallel Tests.
- You can wait for other tests to complete execution.

![parallel tests usage](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/troubleshooting/web-apps/test-execution-queued-for-a-long-time/parallel-tests-usage.png)
- You can connect with Testsigma support (**support@testsigma.com**) to increase the number of parallel runs allowed on your license.

In this screenshot, 3/5 means - 3 tests are running in parallel and 5 is the number of parallel runs allowed at a moment.
<br>

3. If the number of parallel runs is equal to the number of parallel licenses for your Testsigma account then you can take following actions to fix the issue:
i. You can wait for other tests to complete execution.
ii. You can talk to Testsigma support to increase the number of parallel runs allowed on your license.
iii. You can click on the name of the test displayed in the Usage Details window and check its details. This can only be done if you have access to the test case.
![parallel run name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/troubleshooting/web-apps/test-execution-queued-for-a-long-time/parallel-run-name.png)
Here’s the GIF demonstrating how to check the usage details in Testsigma.
![Workflow GIF](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/UsageDetails.gif)

iv. If you have appropriate rights, you can also stop the execution of one of the test cases by clicking on the corresponding stop button.
---

0 comments on commit 95812cc

Please sign in to comment.