From f5b07eecb9d1098e48c71788a8430754146ec424 Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Thu, 25 Apr 2024 16:16:38 +0530 Subject: [PATCH] Updated TS IP Whitelisting & New doc for HAR File --- src/left-nav-title.json | 6 ++ src/pages/docs/runs/adhoc-runs.md | 4 + .../runs/test-locally-hosted-applications.md | 44 +++++++--- src/pages/docs/runs/test-plan-executions.md | 3 +- .../web-apps/collecting-har-file.md | 86 +++++++++++++++++++ 5 files changed, 130 insertions(+), 13 deletions(-) create mode 100644 src/pages/docs/troubleshooting/web-apps/collecting-har-file.md diff --git a/src/left-nav-title.json b/src/left-nav-title.json index 6d0ae845..56b4b80e 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -649,5 +649,11 @@ }, "sf-test-cases":{ "/docs/salesforce-testing/sf-test-cases/": " Build Test Cases: Manual+Live" + }, + "collecting-har-file": { + "/docs/troubleshooting/web-apps/collecting-har-file/": "Collecting HAR File" + }, + "chrome-settings": { + "/docs/troubleshooting/web-apps/chrome-settings/": "Missing Elements in Recorder" } } \ No newline at end of file diff --git a/src/pages/docs/runs/adhoc-runs.md b/src/pages/docs/runs/adhoc-runs.md index 45c839bb..202b14ee 100644 --- a/src/pages/docs/runs/adhoc-runs.md +++ b/src/pages/docs/runs/adhoc-runs.md @@ -55,6 +55,10 @@ Before using the Ad-hoc Run, you must understand specific concepts such as creat 5. The Ad-hoc Run overlay will be automatically pre-filled with the saved configuration for your next runs when selected. 6. In the **Test Case Details** page, click **Ad-Hoc Runs** in the right Navigation Bar to open the right sidebar. This will enable you to view the history and details of Ad-Hoc Run results for the Test Case. ![View History of Ad-Hoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/view_adhocrundetails.png) + +[[info | **NOTE**:]] +| Whitelisting of Testsigma IP addresses is necessary to ensure that the Testsigma servers and lab environments can securely interact with your applications and systems for testing activities. For more information, refer to [whitelisting Testsigma IP addresses](https://testsigma.com/docs/runs/test-locally-hosted-applications/#whitelisting-testsigma-ip-addresses) + --- ## **Web Application** diff --git a/src/pages/docs/runs/test-locally-hosted-applications.md b/src/pages/docs/runs/test-locally-hosted-applications.md index fb001475..db7aaf28 100644 --- a/src/pages/docs/runs/test-locally-hosted-applications.md +++ b/src/pages/docs/runs/test-locally-hosted-applications.md @@ -1,10 +1,19 @@ --- title: "Access Locally Hosted Applications" -metadesc: "How to access the locally hosted applications." +metadesc: "When Testsigma servers are unable to access your locally hosted applications, you need to whitelist Testsigma IP addresses or access through secure Tunnel/VPN" noindex: false order: 9.51 page_id: "Access Locally Hosted Applications" warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Whitelisting Testsigma IP Addresses" + url: "#whitelisting-testsigma-ip-addresses" +- type: link + name: "Secure Tunnel/VPN" + url: "#secure-tunnelvpn" --- --- @@ -12,30 +21,41 @@ 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. +## **Whitelisting Testsigma IP Addresses** -Testsigma Labs has reserved the following IP blocks for our services. Please whitelist these IP addresses to allow traffic in a restricted network setting. +Whitelisting of Testsigma IP addresses is necessary to ensure that the Testsigma servers and lab environments can securely interact with your applications and systems for testing activities. It's a security practice to prevent unauthorized access, and only trusted and verified computers or networks can connect to and interact with the Testsigma environment. This article discusses the whitelisting of Testsigma IPs. -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/tsipaddress.png) ---- +### **Testsigma IP Addresses** + +Login to https://app.testsigma.com and go to **Settings > Testsigma IP** info to see the IP range to whitelist. + +![Testsigma IPs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ipwhitelisting.png) + +- **Testsigma Server IP:** Whitelisting this IP will allow you to access the Testsigma server where the testing activities are hosted. +- **Testsigma Lab IPs:** Whitelisting these IP ranges will allow you to access Testsigma Labs, where test executions happen. + + + +### **How to Whitelist Testsigma IPs?** + +The whitelisting process involves adding Testsigma IP addresses to a list of allowed IPs in your organization's firewall or network security settings. This will ensure that traffic from these IPs will be allowed through the network's security barriers. -### Hybrid Execution +Connect with your *Network Administrator* or *Infosec Team* to whitelist the necessary Testsigma IP addresses. -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'. +For more information, see [Guide to IP Whitelisting](https://www.linkedin.com/pulse/ip-whitelisting-definitive-guide-joshua-oyelalu-2knjf/). -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 +## **Secure Tunnel/VPN** -Contact support **[(support@testsigma.com)](mailto:support@testsigma.com)** to learn more about this. Our team will set up this for you. +Contact support **support@testsigma.com** to learn more about this. Our team will set up this for you. --- \ No newline at end of file diff --git a/src/pages/docs/runs/test-plan-executions.md b/src/pages/docs/runs/test-plan-executions.md index 46edef7e..d25d2494 100644 --- a/src/pages/docs/runs/test-plan-executions.md +++ b/src/pages/docs/runs/test-plan-executions.md @@ -62,7 +62,8 @@ This article guides the user to prepare and execute test plans in Testsigma plat 1. Click on the **Run Now** to start the test plan execution. ![Test plan execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/rntptpexe.png) - +[[info | **NOTE**:]] +| Whitelisting of Testsigma IP addresses is necessary to ensure that the Testsigma servers and lab environments can securely interact with your applications and systems for testing activities. For more information, refer to [whitelisting Testsigma IP addresses](https://testsigma.com/docs/runs/test-locally-hosted-applications/#whitelisting-testsigma-ip-addresses) --- diff --git a/src/pages/docs/troubleshooting/web-apps/collecting-har-file.md b/src/pages/docs/troubleshooting/web-apps/collecting-har-file.md new file mode 100644 index 00000000..89d8b70e --- /dev/null +++ b/src/pages/docs/troubleshooting/web-apps/collecting-har-file.md @@ -0,0 +1,86 @@ +--- +title: "Collecting HAR File for Support Tickets" +metadesc: "A HAR file will help in identifying and diagnosing product performance or latency issues in the application. This article discusses the collecting HAR file" +noindex: false +order: 23.7 +page_id: "Collecting HAR File" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Steps to Collect HAR File" + url: "#steps-to-collect-har-file" +- type: link + name: "Required Files to Raise Support Ticket" + url: "#required-files-to-raise-support-ticket" +--- + +--- + +To capture a HAR (HTTP Archive) file, you can use the developer tools available in web browsers. These tools track the network activities and help export this data as a HAR file. A HAR file is important in identifying and diagnosing product performance or latency issues. It is advisable to procure this data before raising a bug. This article discusses collecting the HAR file for a web page. + +--- + +## **Steps to Collect HAR File** + +### **1. Access Developer Tools** +- To **Open Developer Tools** in **Google Chrome**: + - **Windows/Linux:** Press F12 or Ctrl+Shift+I + - **Mac:** Cmd+Option+I + Alternatively, right-click on the page and select **Inspect**. + +- In **Mozilla Firefox:** Press F12 or Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (Mac) to open the **Developer Tools**. You can also right-click on the page and select **Inspect Element**. + +- In **Microsoft Edge:** Press F12 or Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (Mac) to open the **Developer Tools**. Alternatively, right-click on the page and select **Inspect**. + +### **2. Navigate to the Network Tab** + +- On the **Developer Tools,** click on **Network** to access network monitoring tools. + +- On the **Network** tab, reload the web page for which you want to capture network activity. This will start recording all network requests and responses. + +### **3. Export HAR File** +- **Google Chrome:** Right-click anywhere within the **Network** tab and select **Save all as HAR with content**. +- **Mozilla Firefox:** Right-click anywhere within the **Network** tab and select **Save All as HAR**. +- **Microsoft Edge:** Right-click anywhere within the **Network** tab and select **Save as HAR with Content**. + +Save the HAR file to the desired location on your computer. + +Here’s a quick GIF demonstrating how to download a HAR file in Edge. +![HAR File GIF](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/harfile.gif) + +--- + +## **Required Files to Raise Support Ticket** + +Now that you're familiar with the process of procuring the HAR file, you can follow the steps below while collecting the HAR file to address the specific issue you're facing. This file is required to raise a support ticket in Testsigma. + +### **In Case of Execution Failures:** + +1. **Sign out** of the application. + +2. Navigate to **Developers Tools > Network** tab to record all requests. + +3. **Sign in** to the application. + +4. Navigate to the execution that has encountered the error. + +5. Return to the **Network** tab, which will still be recording, and export the HAR file as mentioned in the above section. + +6. If you're using a Local Agent, **collect the logs** from the local agent. + +### **In Case of UI Functionality Issues:** + +1. **Sign out** of the application. + +2. Navigate to **Developers Tools > Network** tab to record all requests. + +3. **Sign in** to the application. + +4. Go to the page where the error or functionality glitch is present. + +5. Return to the **Network** tab, which will still be recording, and export the HAR file as mentioned in the above section. + + +--- \ No newline at end of file