Skip to content

Commit

Permalink
Created a new doc for Triggering Tests on Local Devices (#362)
Browse files Browse the repository at this point in the history
  • Loading branch information
bharathk08 authored Feb 22, 2024
1 parent 658624d commit 686c652
Show file tree
Hide file tree
Showing 8 changed files with 145 additions and 32 deletions.
14 changes: 13 additions & 1 deletion src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -601,5 +601,17 @@
},
"partial-test-plan-run-via-api":{
"/docs/test-management/test-plans/partial-test-plan-run-via-api/": "Execute Partial Test Plans via API"
},
"basic-authentication":{
"/docs/FAQs/web-apps/basic-authentication/": "Basic Authentication for Web"
},
"monday.com":{
"/docs/integrations/bug-reporting/monday.com/": "Monday.com"
},
"how-to-enter-non-text-keys-in-test-cases":{
"/docs/FAQs/web-apps/how-to-enter-non-text-keys-in-test-cases/": "Non-Text Keys in Test Cases"
},
"why-cloud-devices-cannot-access-local-apps":{
"/docs/FAQs/web-apps/why-cloud-devices-cannot-access-local-apps/": "Steps to Test Locally Hosted Apps"
}
}
}
41 changes: 41 additions & 0 deletions src/pages/docs/FAQs/web-apps/basic-authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Basic Authentication for Web Pages"
metadesc: "To perform basic authentication for web pages, pass the authentication details via URL. This article discusses performing basic authentication for web pages"
noindex: false
order: 24.15
page_id: "Perform Basic Authentication"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Passing Authentication Details via URL"
url: "#passing-authentication-details-via-url"
---

---

Basic Authentication is a simple and effective way to secure web pages. You can perform this easily by passing the authentication details directly via the URL. This article discusses how to perform basic authentication for web pages.

---

## **Passing Authentication Details via URL**

We can use the below format for Basic Authentication:

[[info | Format:]]
| **[protocol]://[username]:[password]@hostname** <br>
| <br>
| This format will have the protocol (HTTP or HTTPS), username, and password.



### **For Example:**

In the NLP, Navigate to **test data**, replace the **test data** with https://admin:[email protected].

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

When we navigate to the host URL, the browser automatically sends the credentials for Authentication. We need to use HTTPS to secure sensitive information.

---
1 change: 0 additions & 1 deletion src/pages/docs/agent/setup-on-windows-mac-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,6 @@ There are two ways of starting the testsigma local agent using docker:

---

## **Creating an Agent in Testsigma Application**
1. On the dashboard, click on **Agents**.
![Agents](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/agdashla.png)

Expand Down
74 changes: 74 additions & 0 deletions src/pages/docs/agent/trigger-tests-locally.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: "Triggering Tests on Local Devices"
metadesc: "Execute the tests on local agents from another device using the same Testsigma account | Learn how to trigger tests on local devices from different machines"
noindex: false
order: 11.81
page_id: "Trigger Tests Locally"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Steps to Trigger Tests on Local Devices"
url: "#steps-to-trigger-tests-on-local-devices"
---

---

With Testsigma, you can execute the tests on local devices from another device using the same Testsigma account. This article discusses how to trigger tests on the same local agent from different machines.

---

## **Prerequisites**

- You should have [Testsigma Agent installed & registered](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/) on the target machine.

- Before triggering the tests, you should [start the Testsigma Agent](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/#start-the-testsigma-agent-server-as-a-process) on the target machine.

- For CI/CD pipelines, you should integrate Testsigma commands to trigger test plans.

---

## **Steps to Trigger Tests on Local Devices**

1. Install and register **Testsigma Agent** on the target machine.
![Install Agent](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/laltsagins.png)

1. Navigate to **Test Plans** from the **Dashboard** and select the Test Plan where you want to add local machines.
![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalnavtp.png)

1. Click on **Edit**.
![Edit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/laledit.png)

1. On the **Add Test Suites & Link Machine Profiles** sections, click on **Link Test Machine**.
![Link Test Machines](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalltms.png)

1. On **Select test machine profiles** overlay, click on **Add Machine**.
![Add Machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalatm.png)

1. On **Add test machine/device profile** overlay, add **Name**, select **Local Devices**, active agent on **Connected Machine** dropdown, and **Browser**. Click on **Create Profile**.
![Create Profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalcp.png)

1. Click on **Save Selection**.
![Save Selection](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalss.png)

Now, your test plan is ready for execution from any machine.

[[info | NOTE:]]
| You can edit & add the local machines to test suites from any device, provided you have the agent active in the target machine.

8. Navigate to the same test plan from any machine with the same account and click on **Run Now** to execute the Test Plan.
![Run Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lalnmrn.png)


<br>


Here’s a quick GIF demonstrating triggering tests on local devices.
![Trigger Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TriggerTP.gif)


---
33 changes: 7 additions & 26 deletions src/pages/docs/agent/troubleshooting/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Send a Flare Request"
url: "#send-a-flare-request"
- type: link
name: "Send the Logs manually"
url: "#send-the-logs-manually"
Expand All @@ -22,29 +19,10 @@ contextual_links:

To execute Testsigma tests on your local machines, a small utility program named Testsigma Agent needs to be on each local machine. In this article, we will discuss how to get the log files for the Testsigma Agent. Providing these files to the Testsigma Support Team will help us resolve Execution issues quickly.

There are two ways you can provide the logs to the Testsigma Support team
1. Send a Flare Request (recommended).
2. Obtain the logs manually and send them manually.

<br>



---
## **Send a Flare Request**

Once the agent is started, you can see the Testsigma Agent icon on the status bar(Mac/Linux) or System Tray(Windows). Here’s a preview from Mac:

![Testsigma agent icon in the status bar once the agent is started](https://docs.testsigma.com/images/logs/testsigma-agent-icon-once-started-logs.png)

Click on the Testsigma Agent icon to reveal the menu and click on the **Send Flare Request** option to send the agent logs to the Testsigma Support team automatically.

Once the flare request is sent, follow up with the Support team to confirm delivery of the logs.

[[info | NOTE:]]
|Sending flare requests might fail if the Agent is not already registered or if there are restrictions in your network. In that case, follow the manual method of sending the logs as given in the next section.

---
## **Send the Logs manually**

You can find the Testsigma Agent logs folder for your machine as mentioned below:
Expand All @@ -66,16 +44,19 @@ There would be a logs folder in the above directory. Inside the **logs** directo

Please zip the **Agent** folder mentioned above and attach them in a mail to [email protected] describing the issue.

<br>
---

**Debugging Errors**

For a technical user, the logs will serve as a great tool for debugging the issues themselves. However, if you need an extra hand, we are always there for you. Just drop in a mail to [email protected] describing the issue and with the above-mentioned log files attached. Remember, adding as much detail as possible will help us resolve the issue in the shortest time.
For a technical user, the logs will serve as a great tool for debugging the issues themselves. However, if you need an extra hand, we are always there for you. Just drop in a mail to **[email protected]** describing the issue and with the above-mentioned log files attached. Remember, adding as much detail as possible will help us resolve the issue in the shortest time.




Please mention the following details in the mail:

* Project Name, Application Name, Test Case name, and Execution Name.
* Execution Type: Hybrid Web/ Hybrid Mobile. If it is Hybrid Mobile Execution, attaching the Appium Logs too will help. You can download the Appium logs from the Appium Server. Contact Support for more details.
* **Project Name**, **Application Name**, **Test Case Name**, and **Execution Name**.
* **Execution Type**: Hybrid Web/ Hybrid Mobile. If it is Hybrid Mobile Execution, attaching the Appium Logs too will help. You can download the Appium logs from the Appium Server. Contact Support for more details.


---
2 changes: 1 addition & 1 deletion src/pages/docs/desired-capabilities/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Desired Capabilities are a set of properties used for customizing the Test Envir

## **Desired Capabilities Format**
Desired Capabilities are entered as **key-value** pairs. Enter the details for Desired Capabilities as specified below:
- **Key:** Enter the name of the capability.
- **Key:** Specific properties or attributes that can be set for the test environment.
- **Data Type:** The data type of the value of the specific Desired Capability.
- **Value:** The value of the Desired Capability.
![Format](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/dcformat.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Entering Non-Text Keys in Test Cases"
page_title: "Efficiently enter Non-Text Keys in Test Cases for Testing"
metadesc: "Learn how to simulate non-text key inputs seamlessly in your test cases, ensuring precise testing outcomes. Explore the guide for effective testing strategies."
noindex: false
order: 24.2
order: 24.14
page_id: "Enter non-text keys in Test Cases"
warning: false
contextual_links:
Expand Down
10 changes: 8 additions & 2 deletions src/pages/docs/runs/test-locally-hosted-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,29 @@ warning: false
Testsigma’s access to applications deployed on your local machine/network is limited for security reasons. As a result, there may be times when Testsigma servers are unable to access your locally hosted applications. To prevent this, try one of the methods below.

---

### IP Whitelisting
In development/QA environments, it is common to keep your application hosted on servers with restricted Access from Unknown Sources. One of the ways you can use Testsigma Labs to execute tests is by whitelisting Testsigma IP Addresses on your server.

Testsigma Labs has reserved the following IP blocks for our services. Please whitelist these IP addresses to allow traffic in a restricted network setting.

Login to https://app.testsigma.com and go to **Settings > About** to see the IP range to whitelist
Login to https://app.testsigma.com and go to **Settings > Testsigma IP info** to see the IP range to whitelist.

![About Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/newips.png)
![About Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsipaddress.png)

---

### Hybrid Execution

Hybrid Executions are local executions that use your local machines to run the tests instead of devices available on the cloud. To perform this, you need to install the 'Testsigma Agent'.

The Testsigma Agent connects the Testsigma server to your local machine. Learn more about [Testsigma Agent](https://testsigma.com/docs/agent/overview/).

---

### Secure Tunnel/VPN

Contact support **[([email protected])](mailto:[email protected])** to learn more about this. Our team will set up this for you.


---

0 comments on commit 686c652

Please sign in to comment.