Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new docs for Testsigma Tunnel #526

Merged
merged 4 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/left-nav-title.json
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@
"/docs/test-data/types/mailbox/": "Mail Box"
},
"create-data-profiles": {
"/docs/test-data/create-data-profiles/": "Create Test Data [Parameter]"
"/docs/test-data/create-data-profiles/": "Create Test Data Profile"
},
"import-data-profiles": {
"/docs/test-data/import-data-profiles/": "Import TDP"
Expand Down Expand Up @@ -681,5 +681,6 @@
"element-learning": {"/docs/windows-lite-automation/element-learning/": "Element Learning with Test Recorder"},
"test-cases": {"/docs/windows-lite-automation/test-cases/": "Test Cases for Windows (Lite)" },
"copado-integration": {"/docs/continuous-integration/copado-integration/": "Copado CI/CD" },
"features-and-scenarios": {"/docs/test-cases/manage/features-and-scenarios/": "Features & Scenarios" }
"features-and-scenarios": {"/docs/test-cases/manage/features-and-scenarios/": "Features & Scenarios" },
"key-components": {"/docs/testsigma-tunnel/key-components/": "Components & Requirements" }
}
2 changes: 1 addition & 1 deletion src/pages/docs/best-practices/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Testsigma Automation Standards and Best Practices"
page_title: "Enhance Efficiency with Automated Testing Best Practices"
metadesc: "Explore best practices for enhancing efficiency and reliability in automated testing through modular design, dynamic waits, and data-driven testing."
noindex: false
order: 32.1
order: 33.1
page_id: "Best Practices to follow Testsigma Automation Standards"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Testsigma Docker Setup"
page_title: "Testsigma Community Edition Docker Setup"
metadesc: "Learn how to set up Testsigma Server and MySQL as docker containers using Docker Compose | Easiest way to set up Testsigma on your local machines"
noindex: false
order: 31.3
order: 32.3
page_id: "Testsigma Docker Setup"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/introduction-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Intro: Testsigma Community Edition"
metadesc: "Testsigma Community Edition is an open-source automation platform | This article discusses installing Testsigma on your workstation & start test automation"
noindex: false
order: 31.1
order: 32.1
page_id: "Introduction to Testsigma Community Edition"
warning: false
contextual_links:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/open-source-docs/reset-password.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Reset Password"
page_title: "How to reset password in Testsigma Community Edition"
order: 31.4
order: 32.4
page_id: "Reset password"
metadesc: "Learn steps in detail on how to reset username and password in Testsigma Community Edition. Follow these steps to reset username and password."
search_keyword: "Reset password"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Testsigma Community Cloud"
metadesc: "Integrate self-hosted open-source platform with Testsigma Community Cloud. This will provide free access to test labs, addons, visual testing, our discord, etc."
noindex: false
order: 31.2
order: 32.2
page_id: "Testsigma Community Cloud"
warning: false
contextual_links:
Expand Down
68 changes: 63 additions & 5 deletions src/pages/docs/test-data/create-data-profiles.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Create and Use Test Data Profiles"
title: "Create & Use Test Data Profiles"
pagetitle: "Create and Use Test Data Profiles"
metadesc: "This article discusses steps in detail on how to create test data profiles that can be used in a test cases in Testsigma application."
metadesc: "This article discusses steps in detail on how to create test data profiles that can be used in a test cases in Testsigma application"
noindex: false
order: 5.21
page_id: "Create Test Data Profiles"
Expand All @@ -28,8 +28,11 @@ contextual_links:
name: "Creating Data-Driven Test Cases with Dynamic Data Sets"
url: "#creating-data-driven-test-cases-with-dynamic-data-sets"
- type: link
name: "Additional Actions Possible on Test Data Set Name"
url: "#additional-actions-possible-on-test-data-set-name"
name: "Additional Actions on Test Data Set Name"
url: "#additional-actions-on-test-data-set-name"
- type: link
name: "Generate Test Data Profile Using Copilot"
url: "#generate-test-data-profile-using-copilot"
---

---
Expand Down Expand Up @@ -154,4 +157,59 @@ In data-driven testing, you can iterate values from start to end. To iterate fro

- **Store**: The test data set name associated with a test data profile can be stored in a variable for later use. The syntax for the Store NLP is **store-iteration-count-test-data-set-name**.

- **If Condition**: The test data set values from a test data profile can be used in an if condition. The screenshot below shows the NLP, which can be added as part of the "String Compare" add-on. Find the add-ons to use [here](https://testsigma.com/addons).
- **If Condition**: The test data set values from a test data profile can be used in an if condition. The screenshot below shows the NLP, which can be added as part of the "String Compare" add-on. Find the add-ons to use [here](https://testsigma.com/addons).

---

## **Generate Test Data Profile Using Copilot**

With Testsigma Copilot, you can quickly generate a Test Data Profile. This eliminates the need to manually create multiple test data sets and allows you to focus on more critical aspects while testing. This article discusses generating a Test Data Profile using Testsigma Copilot.


### **Prerequisites**

- Ensure you know how to create a test case using copilot in Testsigma.



### **Steps to Generate Test Data Profile Using Copilot**

1. From the left navigation bar, go to **Create Tests > Test Cases**.

2. Select the **+ icon** next to the **Scenario** where you want to add the test case.

3. On the dialog that opens, enter the test case name and click **Create**.

3. In the **Test Case Details** page, click **Record** to open the **Testsigma Test Recorder** in a new window.

4. Create test steps by performing actions or use **Copilot** to generate steps automatically. *For more information, see [Creating Test Cases Using Copilot](https://testsigma.com/docs/test-cases/create-test-steps/overview/#ai-test-automation-with-testsigma-copilot-).*
5. When you're done, click **Stop** to end the session. You will be redirected to the **Test Case Details** page.

6. A confirmation dialog will appear.

- Select **Convert** to generate a **Test Data Profile** and convert the test case to a data-driven one.
![Gen AI TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Copilot_TDP_SneakPeak.png)
- Once you are satisfied with the data, click **Create and Replace**.

[[info | **NOTE**:]]
| - You can click **Add more rows** to generate additional data.
| - You can also provide prompts to customize the data further. For example, we successfully changed the entire dataset to reflect the Indian context with a simple prompt.
| ![Prompt Update](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/GenAI_TDP_Prompt.png)



### **Steps to Generate Test Data Profile from Test Case Settings**

1. On the **Test Case Details** page, go to **Test Case Settings > Test Data Profile**.

2. Click the **Test Data Profile** dropdown menu.

3. Click **Generate TDP with AI**. This will open the **Test Data Generation** dialog.

4. In the **Test Data Generation** dialog, validate the **Field Names**, then click **Generate**.

5. Wait for the data to be generated. Once you are satisfied with the data, click **Create and Replace**.

6. Your test data in the test steps will be replaced with the generated data.

---
47 changes: 47 additions & 0 deletions src/pages/docs/testsigma-tunnel/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Intro: Testsigma Tunnel"
metadesc: "Learn how Testsigma Tunnel securely tests private server URLs or locally hosted web apps on real browsers and devices. This article is an introduction for Testsigma Tunnel"
noindex: false
order: 31.1
page_id: "Testsigma Tunnel"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Getting Started"
url: "#getting-started"
- type: link
name: "Getting Help"
url: "#getting-help"
---

---

Testsigma Tunnel allows you to securely test private server URLs or locally hosted web applications on real browsers and devices through Testsigma. Testsigma's tunnel binary can bypass the restrictions caused by corporate firewalls and proxy settings, ensuring a secure connection without IP whitelisting or public internet access.

Testsigma Tunnel establishes a secure connection between your system and Testsigma cloud servers using protocols like Web Socket, HTTPS, and SSH. This allows testing of locally hosted websites or web applications across multiple OS, browsers, and screen resolutions available on Testsigma. This article discusses key components, system requirements, and steps to execute Testsigma Tunnel for client connection.

---

## **Getting Started**

- [Key Components & System Requirements](https://testsigma.com/docs/testsigma-tunnel/key-components/)

- [Setup and Installation: Mac](https://testsigma.com//docs/testsigma-tunnel/setup-installation-mac/)

- [Setup and Installation: Windows](https://testsigma.com/docs/testsigma-tunnel/setup-installation-windows/)

- [Setup and Installation: Linux (Debian & RPM)](https://testsigma.com/docs/testsigma-tunnel/setup-installation-linux/)

- [Setup and Installation: Docker](https://testsigma.com/docs/testsigma-tunnel/setup-installation-docker/)

- [Using Testsigma Tunnel](https://testsigma.com/docs/testsigma-tunnel/using-tunnel/)

---

## **Getting Help**

- For inquiries or help, reach out to Testsigma support at **[email protected]**.

---
82 changes: 82 additions & 0 deletions src/pages/docs/testsigma-tunnel/key-components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: "Key Components & System Requirements"
metadesc: "Ensure seamless connection of Testsigma tunnel by understanding these key components and system requirements for testing locally hosted applications."
noindex: false
order: 31.2
page_id: "Testsigma Tunnel: Key Components"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Key Components"
url: "#key-components"
- type: link
name: "System Requirements"
url: "#system-requirements"
---
---

Before establishing a Testsigma Tunnel connection, understand the key components of Testsigma Tunnel Architecture and the system requirements to setup correctly. This helps ensure a seamless and secure connection for testing locally hosted applications.

---

## **Key Components**

There are five key components in the Testsigma Tunnel architecture:

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

**1. Testsigma Tunnel Client**
- The Testsigma Tunnel Client is a distributed binary that must be installed on the machine where you have access to locally hosted websites or applications.
- The tunnel application uses the provided key to authenticate with the Authentication Server when started.

**2. Authentication Server**
- The Authentication Server processes authentication requests from the Testsigma Tunnel Client.
- After successful authentication, it assigns a Tunnel Connect Server for testing.

**3. Testsigma Tunnel Server**
- The Testsigma Tunnel Server is a virtual machine (VM) or container running in the Testsigma data centers.
- It includes an HTTP/TCP proxy, which forwards requests from REST API executors or automation test case executors.
- The server hosts a TCP server that the Testsigma Tunnel Client uses to establish a tunnel.

**4. REST API Client/Browser (Automation Environment)**
- The REST API client or browser running automation uses the Testsigma Tunnel Server as a proxy to forward all requests to the Testsigma Tunnel Client.

**5. Remote Address**
- The remote address refers to the server URL, which could be localhost, a privately hosted site, or public websites.
- The Testsigma Tunnel Client establishes a bidirectional tunnel between the Testsigma application and the remote address.


---


## **System Requirements**

To use Testsigma Tunnel, your system must meet the following requirements:

**1. Operating System Requirements**

- **Windows:** XP or later

- **macOS:** 10.10 or later

- **Linux:** Ubuntu 12.04 or later

**2. Hardware Requirements**

- **CPU:** x64 architecture, ARM (32-bit and 64-bit) supported

- **RAM:** 2 GB or more recommended

- **Disk Space:** 100 MB free space for installation (500MB free space recommended)

**3. Network Requirements:**

- Ensure that you have a stable internet connection for tunnel communication.

**4. Firewall/Proxy Requirements:**

- Ensure that no firewall or security system restricts the Testsigma Tunnel Client's outbound network traffic.

---
62 changes: 62 additions & 0 deletions src/pages/docs/testsigma-tunnel/setup-installation-docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Setup and Installation: Docker"
metadesc: "Learn how to set up Testsigma Tunnel using Docker for testing of locally hosted applications across real browsers, bypassing firewalls & proxy restrictions."
noindex: false
order: 31.6
page_id: "Testsigma Tunnel"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Setup Testsigma Tunnel Using Docker"
url: "#setup-testsigma-tunnel-using-docker"
---

---

Setting up Testsigma Tunnel with Docker ensures secure and reliable connections for your test automation. This article discusses installing Testsigma Tunnel using Docker.

---

> ## **Prerequisites**
>
> - Ensure you have reviewed and have all the system requirements mentioned [here](https://testsigma.com/docs/testsigma-tunnel/key-components/).

---

## **Setup Testsigma Tunnel Using Docker**
1. Create a **docker-compose.yml** file in your project directory with the following content:

```yaml
services:
testsigma-tunnel:
image: testsigmainc/testsigma-tunnel:<arm64/amd64>-latest
container_name: testsigma-tunnel
environment:
- KEY=<API_KEY>
- TUNNEL_NAME=<NAME_OF_TUNNEL>
- CONNECTIONS=<NUMBER>
- INACTIVE_TIMEOUT=<NUMBER in seconds>
- VERBOSE=true/false
```

2. Replace the placeholder values in the **docker-compose.yml** file:
- **&lt;API\_KEY&gt;:** Your Testsigma authentication key.
- **&lt;NAME\_OF\_TUNNEL&gt;:** The name of your tunnel.
- **&lt;NUMBER&gt;:** The number of connections to establish.
- **&lt;NUMBER in seconds&gt;:** The inactive timeout duration.
- **true/false:** Set to ***true*** for verbose logging or ***false*** to disable it.

3. Run the following command to start the Testsigma Tunnel service: <br>
```docker compose up -d```

4. Once the service is running, logs will indicate that **Testsigma Tunnel** is active. Use the tunnel name for your automation tests.

5. To stop the service, use the following command: <br>
```docker compose down```

---
Loading
Loading