diff --git a/src/components/navcards.jsx b/src/components/navcards.jsx index ec562851..3d166c57 100644 --- a/src/components/navcards.jsx +++ b/src/components/navcards.jsx @@ -156,6 +156,18 @@ const data = [ }, { id: 26, + title: "Salesforce Testing", + description: "Learn how to test applications built on Salesforce using Testsigma.", + path: "/docs/salesforce-testing/introduction/", + }, + { + id: 27, + title: "Windows Automation", + description: "Learn a comprehensive approach for Windows Automation using Testsigma.", + path: "/docs/windows-automation/introduction/", + }, + { + id: 28, title: "Best Practices", description: "Best Practices to follow for Testsigma Automation", path: "/docs/best-practices/best-practices/", @@ -170,11 +182,11 @@ const Card = ({ title, description, path }) => { {description}
- +
- + - +
); diff --git a/src/left-nav-title.json b/src/left-nav-title.json index eaa63334..06ab2a97 100644 --- a/src/left-nav-title.json +++ b/src/left-nav-title.json @@ -682,5 +682,11 @@ "add-test-cases-for-mobile-web-app": {"/docs/test-cases/manage/add-test-cases-for-mobile-web-app/": "Test Cases (Mobile Web App)" }, "most-common-issues": { "/docs/troubleshooting/salesforce-testing/most-common-issues/": "Most Common Issues" }, "developer-mode-for-ios": {"/docs/troubleshooting/mobile-apps/developer-mode-for-ios/": "Developer Mode (iOS 16 & Above)" }, - "mock-apis": {"/docs/test-cases/create-steps-restapi/mock-apis/": "Mock API Support" } + "mock-apis": {"/docs/test-cases/create-steps-restapi/mock-apis/": "Mock API Support" }, + "testsigma-on-prem-architecture": {"/docs/on-premise-setup/pre-installation/testsigma-on-prem-architecture/": "On-Premise System Architecture" }, + "prerequisites-and-machine-configurations": {"/docs/on-premise-setup/pre-installation/prerequisites-and-machine-configurations/": "Prerequisites" }, + "setup": {"/docs/on-premise-setup/installation-process/setup/": "Installation Steps" }, + "post-installation-checklist": {"/docs/on-premise-setup/post-installation/post-installation-checklist/": "Post-Installation Checklist" }, + "troubleshooting": {"/docs/on-premise-setup/post-installation/troubleshooting/": "Troubleshooting" }, + "faqs": {"/docs/on-premise-setup/post-installation/faqs/": "FAQs" } } \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/smtp-configuration.md b/src/pages/docs/configuration/smtp-configuration.md similarity index 80% rename from src/pages/docs/on-premise-setup/smtp-configuration.md rename to src/pages/docs/configuration/smtp-configuration.md index eccd45c2..506bf3a6 100644 --- a/src/pages/docs/on-premise-setup/smtp-configuration.md +++ b/src/pages/docs/configuration/smtp-configuration.md @@ -1,6 +1,6 @@ --- title: "SMTP Configuration in Testsigma" -order: 26.6 +order: 19.7 page_id: "SMTP Configuration Setup" metadesc: "This article discusses a step-by-step guide to setup Simple Mail Transfer Protocol (SMTP) to trigger emails from a configured email address." noindex: false @@ -40,24 +40,15 @@ You'll need the following for SMTP Configuration: ## **Steps to Configure SMTP in Testsigma** 1. Navigate to **Settings > SMTP Configuration**. -![SMTP Configuration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/smtp.png) - 2. Turn on the **SMTP Configuration** toggle. -![SMTP Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/smtp_toggle.png) - [[info | **NOTE**:]] | You will stop getting emails if you turn off the SMTP Configuration toggle. - 3. Select **@own**, and enter all the details. -![Own](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SMTP_details.png) - 4. Click on **Save**. -![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Save.png) - [[info | **NOTE**:]] |If you select Testsigma, the mails will go with default email. For **@own** configuration, you need to enter the following details:
@@ -97,7 +88,7 @@ Here’s a quick GIF demonstrating how to generate the password. [[info | **NOTE**:]] -|These steps are specific for generating an app password in a Google account. The process may be different for other email clients/services. +| These steps are specific for generating an app password in a Google account. The process may be different for other email clients/services. diff --git a/src/pages/docs/debugging/debugging-localdevices-web.md b/src/pages/docs/debugging/debugging-localdevices-web.md index 39092450..306809bb 100644 --- a/src/pages/docs/debugging/debugging-localdevices-web.md +++ b/src/pages/docs/debugging/debugging-localdevices-web.md @@ -1,105 +1,95 @@ --- -title: "Debug results on local devices (Web applications)" +title: "Debugging Results on Local Devices for Web Applications" +pagetitle: "Debugging Web Application Results on Local Devices" +metadesc: "Learn how to debug test cases on local devices for web applications, using detailed steps and troubleshooting tips to ensure accurate and efficient testing." +noindex: false order: 10.3 -page_id: "Debug Results on Local Devices" -metadesc: "Debugging issues in complex tests might require enhanced techniques. This article discusses in detail step-by-step guide on how to debug results on local devices in Testsigma." +page_id: "debugging-results-local-devices-web-applications" search_keyword: "" warning: false contextual_links: - type: section name: "Contents" - type: link - name: "Steps to execute test cases in debugger mode" - url: "#steps-to-execute-test-cases-in-debugger-mode" + name: "Prerequisites" + url: "#prerequisites" - type: link - name: "Adding debug points to debug the test" - url: "#adding-debug-points-to-debug-the-test" + name: "Executing Test Cases in Debugger Mode" + url: "#executing-test-cases-in-debugger-mode" - type: link - name: "Fixing an error using debugging feature" - url: "#fixing-an-error-using-debugging-feature" ---- + name: "Adding Debug Points" + url: "#adding-debug-points" +- type: link + name: "Interacting with Debug Points" + url: "#interacting-with-debug-points" +- type: link + name: "Identifying and Fixing Errors During Test Case Execution" + url: "#identifying-and-fixing-errors-during-test-case-execution" +- type: link + name: "Troubleshooting Element Not Found Error" + url: "#troubleshooting-element-not-found-error" --- -Debugging issues in complex test cases might require enhanced techniques. This article describes Testsigma's interactive debugging feature for web applications that will not only fix test step issues but also save a good amount of debugging time. - -[[info | **NOTE**:]] -|This feature is available in beta version only. Contact [support](mailto:support@testsigma.com) for enabling the feature in your account. --- - -## **Steps to execute test cases in debugger mode** - -1. Navigate to the test case you want to debug and interact with.
-[[info | **NOTE**:]] -|If the test case uses a test data profile, users can choose only one data profile to use the debugging feature. -2. On the test case details page, click the drop-down arrow beside the **Run** button. - -3. Select **Run in debug mode** from the drop-down list. ![Run in debug mode](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/run_in_debug_mode.png)
Optionally you can select **Record in debug mode** to capture screen shots during test execution for each UI-interactive action. Looking at the screen shots it is easier to identify where your test cases failed. -![Record in debug mode](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/record_in_debug_mode.png) -4. On the **Ad-hoc run** overlay window, - 1. Specify the test lab. The default test lab in debugging mode for web applications is **Local Device**. - 2. Select the checkbox **Run only if the configured browser version is available in the Agent machine**. - 3. Select your local test machine. To run tests on your local machine you need to set up a Testsigma agent. *For more information, refer to [set up Testsigma agent](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/)*. - 4. If you want to execute the test steps until the failed step, select the toggle **Run till failed step**. If this toggle button is disabled, the test case will be executed from start to end. Thereby, identifying the test step that is failing would be difficult. - 5. If you want to execute the step till a particular step (that is setting a debug point), select the step from the **Run till step** drop-down list. For more information on debug points, refer to the section debug points. - 6. Click **Run now** to execute the test case. +Debugging in Testsigma helps identify and resolve errors in test cases through its interactive debugging feature. This feature lets you execute tests step-by-step, pausing at specific points to inspect behaviour. It provides users with detailed resources like step results, metadata, screenshots, source codes, and step settings to pinpoint failures accurately, thus saving time and enhancing the reliability of test executions. --- -## **Adding debug points to debug the test** +## **Prerequisites** -Debug points are locations in your test steps where you want the test step to start or pause test case executions. This helps to observe the behavior of the test case. Multiple debug points can be added in a test case. Breaking up test execution this way ensures that you can carefully investigate each of the steps for potential bugs, instead of using a more inconvenient alternative. For example, letting the test case run at once and then trying to figure out in which step the things went wrong. -To add debug points to your test case, follow the below steps: +Before you begin debugging in Testsigma, ensure the following: -1. To add a debug point, click on the **Show more** icon next to the test step. - -2. Select **Add debug point** from the drop-down list. When the test case is executed, the execution is performed until the debug point. Multiple debug points can be added as and when desired. -![Add debug points](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/add_debug_point.png) +- The Testsigma Agent is started and active. +- Debugging can only be done through a Local Device. +- If the test case uses a test data profile, only one test data profile can be selected for debugging. --- -## **Fixing an error using debugging feature** - -On the execution of the test case, a user can visually view the execution move from step to step. Thus, it is easy to understand the execution workflow. -The execution is paused when an error is encountered or at a debug point. On the test steps window, Testsigma highlights the step that failed and caused the execution to stop. -With the execution paused, the debugging feature offers various resources to help you debug the error in the test step. +## **Executing Test Cases in Debugger Mode** -### **Debug resources** +1. Navigate to the test case you want to debug. +2. On the test case details page, click the **Launch Debugger** button in the top right corner of the screen. +3. On the Run in Debug Overlay, ensure the **Test Lab** is set to **Local Device** and that the **Agent** is in **Active Status** for debugging. +4. To execute the test steps until a failed step, enable the **Run till failed step toggle** and set a debug point by selecting the test step from the dropdown. If this toggle is disabled, the test case will execute from start to end. +5. Click **Debug now** to execute the test case. ![click launch debugger in test case details page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/launch_debugger_in_web_application.gif) -The debug resources provide a detailed and interactive analysis of the issue. The debugging resources include step results, metadata, screenshots, source codes, and step settings. These resources are available for all test steps including passed and failed test steps. - -1. To view the debugging resources, click **More**. -![view debugging resources](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/debugging_resources_more.png) -2. Hover the mouse over each icon to find the details related to step results, metadata, screenshots, source codes, and step settings. +--- -### **Troubleshoot ‘element not found error’** +## **Adding Debug Points** -A common failure while executing test cases is that a particular element is not found during test execution. In some cases, the element is visibly available on the page but is still reported as not found by Testsigma. In such cases, follow the below steps to debug the error. +Debug points are specific locations in your test steps where you want the execution to start or pause. These points help you observe the behaviour of the test case more closely. -1. **Explore debug resources**: To explore debug resources, click on **More** next to the failed step. The debug resources provide a detailed analysis of the issue.![explore debug resources](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/element_not_found_error_2.png) +1. A new window with the webpage's URL provided will open to debug the test steps. +2. In the Testsigma Debugger overlay, hover over the yet to execute test step and click the **Place Debug Point** icon to add a debug point. +3. To add multiple debug points, hover over the test step and click on the corresponding debug point that appears to enable it. +4. Execution will pause when it reaches an enabled debug point. ![add debug point in debugger mode](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/adding_debugging_point_in_web_applications.gif) -2. **Check the UI element**: To check the UI element which cannot be found, click **Show more**>**Element search** next to the test step. The relevant element is highlighted for 2 sec. You can compare the properties of the saved element with that of the element displayed on the screen. +--- -3. **Edit element**: To edit an element, click on **Show more**>**Edit step** next to the failed step. - 1. Click on the saved element. +## **Interacting with Debug Points** - 2. You can add the element from the list of elements provided. +1. When the test execution pauses at a debug point, you can perform the following actions by clicking **Options** for the test step that has yet to be executed and selecting the option from the dropdown: + - **Resume Execution**: Continue the test execution. + - **Run this Step**: Execute the current step. + - **Step Over**: Skip the current step. +2. Interact with the page to skip the failed test step, click **Step Over** to skip the current step, and continue the executions. ![interact with debug points in web](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/interact_debugg_web_application.gif) - 3. Optionally, you can create a new element. To create an element, click on **Create element**.![create an element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/create_elements_debugger.png) +--- - 4. Click on your desired element to automatically populate the element details field.![create element 2](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/debugging/debugging-localdevices-web/capture_element_webdebugger.png) - - 5. Click **Create**. +## **Identifying and Fixing Errors During Test Case Execution** - 6. Optionally, you can add element details and click **Verify** to view the element highlighted on the page. +During test case execution, you can visually follow each step. If an error occurs or a debug point is reached, execution pauses, and Testsigma highlights the problematic step. Various resources are provided to help you debug the error, offering a detailed and interactive analysis. - 7. Click **Update**, to update the test step. +- Hover over the Step **Options** for Executed Test Step and then click **Step Result** to view the outcome of each test step. ![identifying and fixing errors during test case execution](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/identifing_error_teststep_debug.gif) -4. **Test Execution**: To re-execute, the test step after editing, click **Show more > Re-run**. -5. To resume the execution of a test case from the previously paused test step, click **Show more**>**Resume**. +--- - +## **Troubleshooting Element Not Found Error** - +A common issue during test execution is the "Element Not Found" error, where an element visible on the page is still reported as not found. To debug this issue, follow these steps: +- View the message for the test step. If the element is not found, click **Element** to view its properties, analyse the issue, and [update the element](https://testsigma.com/docs/elements/web-apps/create-manually/). +- After updating the element, click **Options** and select **Resume Execution** from the previously paused step. ![troubleshoot element not found error](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/troubleshooting_element_error.gif) +--- diff --git a/src/pages/docs/on-premise-setup/custom-domain.md b/src/pages/docs/on-premise-setup/custom-domain.md deleted file mode 100644 index 0093ce6c..00000000 --- a/src/pages/docs/on-premise-setup/custom-domain.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Configure Custom Domains" -order: 26.7 -page_id: "Configure Custom Domains" -metadesc: "This article discusses how to configure custom domains for Docker setup. Custom domains ensures data security, builds user trust, improves SEO, and presents a professional image" -noindex: false -search_keyword: "" -warning: false -contextual_links: -- type: section - name: "Contents" -- type: link - name: "Steps to Configure Custom Domains" - url: "#steps-to-configure-custom-domains" ---- - - ---- - -Configuring custom domains for Docker setup ensures data security, builds user trust, improves SEO rankings, and presents a professional and branded image to your customers. In this article, we will discuss the steps to configure custom domains. - ---- - -## **Steps to Configure Custom Domains** - - - -1. By default, builds are generated with ***.testsigmaprivate.com** ssl certs embedded. If you want to use your own domain (**Ex:** automation.customdomain.com), you must procure certificates for ***.customdomain.com** or the following subdomains. - - automation.customdomain.com - - automation-id.customdomain.com - - automation-addon.customdomain.com - - automation-visual.customdomain.com - - -[[info | **NOTE**:]] -| Subdomains can be configurable, but the customer has to let us know the subdomains, so that we build docker images accordingly. - - -2. Create a new folder in the server where the docker instance is running and navigate to it. - -``` -mkdir ssl_config -cd ssl_config -``` - -
- -3. Create a sub-folder named certificates under the ```ssl_config``` folder. Copy your certificate **(*.crt)** and key **(*.key)** files to the certificates folder. - - -4. Copy ***ssl.conf*** file from here ([ssl.conf](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SSL.txt)) and place it under ***ssl_config*** folder, and change the replace the URLs, SSL certificate paths accordingly for all VirtualHost entries. - - - - -5. Example below shows a VirtualHost entry for **automation.customdomain.com**. - - If your URL is **automation.example.com**. You need to replace all occurrences of **automation.customdomain.com** with **automation.example.com**. - - Change the **SSLCertificateFile** and **SSLCertificateKeyFile** names (Do not change the directory structure, only file name has to be changed). The directory structure is referenced in *docker-compose.yml*. - -``` - - DocumentRoot "/usr/local/apache2/htdocs" - ServerName automation.customdomain.com - ServerAlias www.automation.customdomain.com - ServerAdmin admin@testsigma.com - SSLCertificateFile "/usr/local/apache2/ssl/.crt" - SSLCertificateKeyFile "/usr/local/apache2/ssl/.key" - - RewriteEngine On - - # App server configuration - - RewriteCond %{HTTP_HOST} "automation.customdomain.com" - RewriteCond %{REQUEST_URI} "^/$" - RewriteRule .* https://automation.customdomain.com/ui/ [L,R=301] -``` - -
- -6. In docker-compose.yml file, scroll to ***load_balancer*** entry and add the volumes for ***ssl.conf*** and certificates. - - -In the Below example, <DIRECTORY\_PATH> should be replaced with the ***ssl_config*** directory path. - - -``` -# Global HTTPD Server - testsigma_load_balancer: - container_name: testsigma-load-balancer - image: testsigmainc/onprem:load-balancer--india-v351_3 - ports: - - "443:443" - networks: - - testsigma-network - volumes: - - ./data/ts_load_balancer_data:/opt/app/ts_load_balancer_data - - /ssl.conf:/usr/local/apache2/conf.d/ssl.conf - - /certs:/usr/local/apache2/ssl -``` - -
- -7. Once all above changes are done, we can start the ```docker-compose```. - ---- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/install-docker-on-uzure-infra.md b/src/pages/docs/on-premise-setup/install-docker-on-uzure-infra.md deleted file mode 100644 index 84c5d114..00000000 --- a/src/pages/docs/on-premise-setup/install-docker-on-uzure-infra.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Install Docker on an Unix OS in Azure Infrastructure" -order: 26.5 -page_id: "Install Docker on Azure infrastructure" -metadesc: "This article discusses in detail a step-by-step guide to installing and verifying docker on a Unix-based OS within Azure infrastructure." -noindex: false -search_keyword: "" -warning: false -contextual_links: -- type: section - name: "Contents" -- type: link - name: "Steps to Install Docker on an Unix OS in Azure Infrastructure" - url: "#steps-to-install-docker-on-an-unix-os-in-azure-infrastructure" ---- - - ---- - -This article discusses a step-by-step guide to installing Docker on a Unix-based OS within Azure infrastructure. - ---- - -## **Steps to Install Docker on an Unix OS in Azure Infrastructure** - -1. Connect to your Azure virtual machine. - - -2. Update the package manager with the following command. - -``` -sudo apt-get update -``` - -3. Run the following commands to install Docker. - -``` -sudo apt-get install apt-transport-https ca-certificates curl software-properties-common -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - -sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" -sudo apt-get update -sudo apt-get install docker-ce docker-ce-cli containerd.io -``` - -4. Install Docker Compose - -``` -curl -L https://github.com/docker/compose/releases/download//docker-compose-$(uname -s)-$(uname -m) > /usr/local/bin/docker-compose -chmod +x /usr/local/bin/docker-compose -``` - -5. Verify the Docker and docker-compose installation with the following command: - -``` -docker --version -docker-compose –version -``` - - -6. Once docker setup is done, run the following command in the folder where our docker-compose.yml is present, - -``` -docker-compose up -``` - - - -In case if you see the following error, - -[[info | **ERROR**:]] -|Version in "./docker-compose.yml" is unsupported. You might be seeing this error because you're using the wrong Compose file version. Either specify a supported version (e.g "2.2" or "3.3") and place your service definitions under theserviceskey, or omit theversionkey and place your service definitions at the root of the file to use version 1. For more on the Compose file format versions, see https://docs.docker.com/compose/compose-file/. - -docker-compose installed is not compatible with the docker. You can try installing an older version of docker-compose. Usually, versions 1.1.0 or 1.27.4 are suitable for Unix on azure infra. - - -Refer to this page https://github.com/datahub-project/datahub/issues/2020 for available docker-compose versions. - - - - - - ---- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/installation-process/domain-configuration.md b/src/pages/docs/on-premise-setup/installation-process/domain-configuration.md new file mode 100644 index 00000000..6c095f66 --- /dev/null +++ b/src/pages/docs/on-premise-setup/installation-process/domain-configuration.md @@ -0,0 +1,57 @@ +--- +title: "Custom Domain Configuration" +order: 26.22 +page_id: "Custom Domain Configuration" +metadesc: "This article discusses how to configure custom domains for Docker setup. Custom domains ensures data security, builds user trust, improves SEO, and presents a professional image" +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Steps to Configure Custom Domains" + url: "#steps-to-configure-custom-domains" +--- + +--- + + +Configuring custom domains for Docker setup ensures data security, builds user trust, improves SEO rankings, and presents a professional and branded image to your customers. If you have the custom domain requirements ready, follow the steps in this article to configure custom domains. + +--- + + +## **Steps to Configure Custom Domains** + +1. Request the Docker image with the new domain names from Testgigma using GitHub Actions. + +2. Replace the HTTPS certificate in the **testsigma-load-balancer** container. For this, store the public key and private key files on the host machine and specify them as volumes in the **docker-compose file**. + + **For Example:** + + ```yaml + version: '3.9' + services: + testsigma_load_balancer: + container_name: testsigma-load-balancer + image: testsigmainc/onprem:load-balancer--trial-v120 + ports: + - "443:443" + networks: + - testsigma-network + volumes: + - ./data/ts_load_balancer_data:/opt/app/ts_load_balancer_data + - /path/to/new/server.crt:/usr/local/apache2/ssl/server.crt + - /path/to/new/server.key:/usr/local/apache2/ssl/server.key + + +
+ +- Here, replace ***/path/to/new/server.crt*** with the path to the new ***server.crt*** file on your host machine, and replace ***/path/to/new/server.key*** with the path to the new ***server.key*** file on your host machine. + +- When you run ***docker-compose up***, the ***server.crt*** and ***server.key*** files in the container will be replaced with the new files from the host machine. + + + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/setup.md b/src/pages/docs/on-premise-setup/installation-process/setup.md similarity index 65% rename from src/pages/docs/on-premise-setup/setup.md rename to src/pages/docs/on-premise-setup/installation-process/setup.md index 5121f4d2..b98424bb 100644 --- a/src/pages/docs/on-premise-setup/setup.md +++ b/src/pages/docs/on-premise-setup/installation-process/setup.md @@ -1,8 +1,8 @@ --- -title: "On-Premise Setup with Docker-compose File" -order: 26.3 -page_id: "Onprem Installation Steps" -metadesc: "This article discusses steps to deploy the docker compose file for Testsigma On-prem setup, how to access the application, how to stop and remove the containers, and more." +title: "On-Premise Installation Steps" +order: 26.21 +page_id: "On-premise setup" +metadesc: "Learn how to setup Testsigma On-premise using docker compose file | Steps to Deploy Docker Compose File for Testsigma's on-prem setup" noindex: false search_keyword: "" warning: false @@ -21,11 +21,8 @@ contextual_links: - type: link name: "Containers Defined in the Docker Compose File" url: "#containers-defined-in-the-docker-compose-file" -- type: link - name: "How to Change the Domain Name" - url: "#how-to-change-the-domain-name" ---- +--- --- @@ -35,29 +32,30 @@ You'll receive ***docker-compose.yml*** files based on your requested configurat ## **Steps to Deploy Docker Compose File** -1. Install Docker and Docker Compose on your system. +1. Install **Docker** and **Docker Compose** on your system. -2. Open a terminal and navigate to the directory where the docker-compose.yml file is located. +2. Open the **Terminal** and navigate to the directory where the **docker-compose.yml** file is located. -3. Run the command ***docker-compose up*** to start the containers defined in the docker-compose.yml file given by Testsigma. This will start all the services in the background and keep them running even if you close the terminal window. +3. Run the command ***docker-compose up*** to start the containers defined in the **docker-compose.yml** file given by Testsigma. This will start all the services in the background and keep them running even if you close the terminal window. --- ## **Accessing Application** + Along with the given docker-compose files you will receive a list of URLs for accessing the application. **Example:**
--addon.testsigmaprivate.com
--addon.testsigmaprivate.com
--testsigmaprivate.com
--visualtesting.testsigmaprivate.com. +- **-addon.testsigmaprivate.com** +- **-addon.testsigmaprivate.com** +- **-testsigmaprivate.com** +- **-visualtesting.testsigmaprivate.com** You will have to add the mapping in the ‘hosts’ file. Once the application is up and running, you can access it using the IP address of your on-premise server and the port number specified in your docker-compose file. -For Example, the sample **docker-compose.yml** file mentions that the web service is accessible on port 80. You can access it by navigating to **http://<server-ip>80** in your web browser. +> For Example, the sample **docker-compose.yml** file mentions that the web service is accessible on port 80. You can access it by navigating to **http://<server-ip>80** in your web browser. --- @@ -110,39 +108,6 @@ TS_APP_SERVER_PROTOCOL: https - The WebApp server is named **testsigma\_app\_server\_ui**. The container is pre-configured with the necessary software and settings for hosting web applications and capturing screenshots. [[info | **NOTE**:]] -|All services will connect to a custom network named ***testsigma-network***. Each service will have a health check specified with different intervals, timeouts, and retries, depending on the service. - ---- - - -## **How to Change the Domain Name** - -1. From testsigma request the docker image with new domain names using Github Actions. -2. Customer need to replace the HTTPS Certificate in **testsigma-load-balancer** container. -For this they can keep the public key and private key files in the host machine and specify it as volume in the ***'docker-compose'*** file. - -**For Example:** - -``` -version: '3.9' -services: -testsigma_load_balancer: -container_name: testsigma-load-balancer -image: testsigmainc/onprem:load-balancer-samsung-trial-v120 -ports: -"443:443" -networks: -testsigma-network -volumes: -./data/ts_load_balancer_data:/opt/app/ts_load_balancer_data -/path/to/new/server.crt:/usr/local/apache2/ssl/server.crt -/path/to/new/server.key:/usr/local/apache2/ssl/server.key -``` - -- Here, replace ***'/path/to/new/server.crt'*** with the path to the new ***'server.crt'*** file on your host machine, and replace ***'/path/to/new/server.key'*** with the path to the new ***'server.key'*** file on your host machine. - -- When you run ***docker-compose up***, the ***'server.crt'*** and ***'server.key'*** files in the container will be replaced with the new files from the host machine. - - +| All services will connect to a custom network named ***testsigma-network***. Each service will have a health check specified with different intervals, timeouts, and retries, depending on the service. --- diff --git a/src/pages/docs/on-premise-setup/post-installation/faqs.md b/src/pages/docs/on-premise-setup/post-installation/faqs.md new file mode 100644 index 00000000..7bd151b4 --- /dev/null +++ b/src/pages/docs/on-premise-setup/post-installation/faqs.md @@ -0,0 +1,72 @@ +--- +title: "On-Premise: FAQs" +order: 26.32 +page_id: "On-premise setup FAQs" +metadesc: "Learn what are the frequently asked questions if you're opting for Testsigma on-premise installation | FAQs about Testsigma on-premise specifications and installation " +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Software, Hardware, and other Requirements" + url: "#software-hardware-and-other-requirements" +--- + +--- + +**1. Why are so many ports required for Testsigma, and what are they used for?**
+**Ans:** Testsigma uses multiple ports to support different micro-services running as Docker containers. Each port is dedicated to a specific micro-service that handles different aspects of the Testsigma application. Refer to the ports list and service used in the port below: +- 3306: Used by MySQL (though Testsigma uses port 3307 internally) +- 7010: Used by Visual Testing Server +- 8080: Used by App Server +- 8082: Used by Addon Server +- 8084: Used by ID Server +- 9090: Used by Audit Server +- 9095: Used by ID Server +- 9096: Used by App Server +- 9097: Used by Addon Server +- 4200: Not listed in Testsigma documentation +- 4201: Used by Addon Server UI +- 4203: Used by ID Server UI +- 4210: Not listed in Testsigma documentation +- 4211: Used by Groot UI +- 4220: Not listed in Testsigma documentation +- 4230: Used by Audit UI + +--- + +**2. What are the system requirements and recommendations for installing Testsigma?**
+**Ans:**
+**1. Operating System Recommendations:** +- **Preferred OS:** Ubuntu or RHEL 9.x + +[[info | **NOTE**:]] +| If not using Ubuntu, RHEL 9.x is recommended. RHEL 8 is also supported. Refer to the [Docker installation guide](https://docs.docker.com/engine/install/rhel/) for RHEL for detailed instructions. + +**2. Machine Specifications:** +- CPU: 16 Core +- RAM: 64 GB or more +- Storage: + - Option 1: 512GB - 2TB Single Storage + - Option 2: 256GB for OS + 1TB or larger mounted disk + +[[info | **NOTE**:]] +| Scheduled image backups are recommended for both storage options. + +**3. Database Specifications:** +- **CPU**: 4 Core +- **RAM**: 32 GB +- **RDBS**: MySQL +- **Version**: 8.0.x + +Note: Testsigma provides a MySQL Docker container. If opting for a hosted MySQL, ensure it meets the above specifications. + +- **Additional Notes**: + - For accurate storage & memory needs, consult with the vendor to confirm the memory and number of vCPUs. + + +For more information, refer to [Prerequisites & Machine Configurations](https://testsigma.com/docs/on-premise-setup/pre-installation/prerequisites-and-machine-configurations/). + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/post-installation-checklist.md b/src/pages/docs/on-premise-setup/post-installation/post-installation-checklist.md similarity index 71% rename from src/pages/docs/on-premise-setup/post-installation-checklist.md rename to src/pages/docs/on-premise-setup/post-installation/post-installation-checklist.md index c4b95ffa..d4fe737b 100644 --- a/src/pages/docs/on-premise-setup/post-installation-checklist.md +++ b/src/pages/docs/on-premise-setup/post-installation/post-installation-checklist.md @@ -1,8 +1,8 @@ --- -title: "Post-Installation Checklist for On-Premise Setup" -order: 26.4 -page_id: "Post-installation checklist" -metadesc: "Post-installation checklist for On-premise setup by Testsigma | Refer and verify this checklist once the On-premise setup is done by Testsigma" +title: "On-Premise: Post-Installation Checklist" +order: 26.31 +page_id: "Post-Installation Checklist" +metadesc: "This checklist helps you verify that your Testsigma on-premise setup is installed, configured, and functioning as expected a few mandatory action items post upgrade" noindex: false search_keyword: "" warning: false @@ -10,22 +10,21 @@ contextual_links: - type: section name: "Contents" - type: link - name: "Refer to the checklist below after the on-premise setup" - url: "#refer-to-the-checklist-below-after-the-on-premise-setup" + name: "Refer to the Checklist below:" + url: "#refer-to-the-checklist-below" - type: link - name: "Mandatory action items post upgrade" + name: "Mandatory Action Items Post Upgrade:" url: "#mandatory-action-items-post-upgrade" --- - --- -Post-installation of an on-premise setup, it's important to check whether everything is configured correctly and functioning as expected. +This article discusses the checklist to verify that your Testsigma on-premise setup is installed, configured, and functioning as expected. --- -## **Refer to the checklist below after the on-premise setup:** +## **Refer to the Checklist below:** 1. Check whether the recorder setup properly captures actions during the testing process. @@ -49,7 +48,7 @@ Post-installation of an on-premise setup, it's important to check whether everyt --- -## **Mandatory action items post upgrade:** +## **Mandatory Action Items Post Upgrade:** 1. Stop the old agent and make sure it is no longer active. @@ -61,3 +60,4 @@ Post-installation of an on-premise setup, it's important to check whether everyt 5. Check the agent's current status and version number to ensure the update was successful. +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/post-installation/troubleshooting.md b/src/pages/docs/on-premise-setup/post-installation/troubleshooting.md new file mode 100644 index 00000000..5a46c0a2 --- /dev/null +++ b/src/pages/docs/on-premise-setup/post-installation/troubleshooting.md @@ -0,0 +1,133 @@ +--- +title: "On-Premise: Troubleshooting" +order: 26.33 +page_id: "On-premise setup prerequisites" +metadesc: "This guide will help you resolve issues while installing on-premise setup | Troubleshooting guide for general & network issues while installing Testsigma's on-premise" +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "General Issues" + url: "#general-issues" +- type: link + name: "Network Issues" + url: "#network-issues" +--- + +--- + +This article provides troubleshooting guide for general and network issues related to accessing the on-premise domains. Follow these steps to quickly identify and resolve issues. + +--- + +## **General Issues** + +### **1. Application Not Accessible** + + ![IP List](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/OnPrem_Trobleshooting_IPList.png) + +**Host Configuration:** +- Open the **/etc/hosts** file on the server using a text editor. +- Add the **<system-Ip-address> <domain>** mapping pairs.
+ + **For Example:** + ```yaml + 192.168.0.1 dev.testsigmaprivate.com + 192.168.0.1 dev-id.testsigmaprivate.com + 192.168.0.1 dev-addon.testsigmaprivate.com + 192.168.0.1 dev-visualtesting.testsigmaprivate.com + 192.168.0.1 dev-audit.testsigmaprivate.com + 192.168.0.1 dev-mobilerecorder.testsigmaprivate.com + +- Save the changes and close the editor. + +--- + +### **2. Server Refused to Connect:** + + ![Server Refused to Connect](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/OnPrem_Troubleshooting_Server_Refused.png) + +**a. Check if the Server is Running:** +- Connect to the server machine. +- Navigate to the Testsigma installation folder. +- Check the Testsigma server status by running: + - ***docker ps -a*** +- Ensure all containers are Up. + ![Servers Up](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/OnPrem_ServersUp.png) + +**b. If Any Container is Shown as "Exited"** +- Get the logs of that container and check the reason for failure. +- Restart the exited containers by running: + - ***docker compose up -d*** + +If you're still facing the issue, contact **support@testsigma.com**. + +--- + +### **3. Checking the Logs of the Containers:** + +- Choose the container name as mentioned in the image below: + ![Check Logs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Onprem_Testsigma_Server.png) + +- Execute the following command to check and print all the server logs in the command line: + - ***docker logs -f testsigma-app-server*** + +- Press **CTRL + C** to exit the log view. + +--- + +### **4. Sharing the Logs with the Testsigma Team:** + +- Choose the container name as mentioned in the image below: + ![Check Logs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Onprem_Testsigma_Server.png) + +- Execute the following command to copy the logs from the container to the server by replacing **<destination_location>** with the desired directory path on the server: + - ***docker cp testsigma-app-server:/opt/logs /*** + +- Pull the Logs from the Server Machine and send the logs to **support@testsigma.com** for further help. + +--- + +## **Network Issues** + +**1. Associated IP List** + +**Retrieve the IP Address:** + +- Use the dig command to find the IP address associated with the domain:

+ **For Example:** ```dig app-testsigma.de.youcompany.com``` + ![IP Address](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/IPListOnprem.png) + +- Alternatively, you use the **nslookup** command:

+ **For Example:** ```dig app-testsigma.de.youcompany.com``` + ![IP Address from NS Lookup](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/IPListNSLookUPOnprem.png) + + +--- + +**2. Check the Connection** +- Use the **nc -vz <ip-address> 443** command to check the connection to the retrieved IP address on port 443:

+ + **For Example:** ```nc -vz 18.215.41.231 443```

+ ![Check Connection](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/OnpremConnection.png) + + This command will confirm if the connection to the specified IP address and port is successful. + + +**3. Curl Check** +- Use the curl command to check the HTTP response from the IP address:
+ + ``` + curl -H "Host: http://app-testsigma.de.bosch.com" http://:/ + ``` +
+ + **For Example:**

+ ```curl -H "Host: http://app.testsigma.com" http://52.1.167.174:80/``` + + ![CURL Check](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/OnpremCURLcheck.png) + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/pre-installation/custom-domain-requirements.md b/src/pages/docs/on-premise-setup/pre-installation/custom-domain-requirements.md new file mode 100644 index 00000000..e12fa4a6 --- /dev/null +++ b/src/pages/docs/on-premise-setup/pre-installation/custom-domain-requirements.md @@ -0,0 +1,49 @@ +--- +title: "Custom Domain Requirements" +order: 26.13 +page_id: "On-premise setup prerequisites" +metadesc: "This detailed guide will help you understand the required services and url details for creating custom domains | Know these details before configuring custom domains" +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Required Services and URL Details" + url: "#required-services-and-url-details" +--- + +--- + +To set up custom domains, Testsigma requires URL details for the following services and the corresponding SSL certificates (.crt). This article discusses the requirements to generate custom domains. + +--- + + +## **Required Services and URL Details** + +The URL details are required for the following services: +- **Identity Service:** id-testsigma.<customer-test-domain> +- **App Service:** app-testsigma.<customer-test-domain> +- **Kibbutz/addon Service:** kibbutz-testsigma.<customer-test-domain> +- **Visual Service:** visual-testsigma.<customer-test-domain> +- **Audit Service:** audit-testsigma.<customer-test-domain> +- **Mobile Recorder Service:** mobilerecorder-testsigma.<customer-test-domain> + + +### **For Example:** +If the **<customer-test-domain>** is **lowcode.com**, then the certificates will be required for the wildcard domain or the individual sub-domains as follows: +- id-testsigma.lowcode.com +- app-testsigma.lowcode.com +- kibbutz-testsigma.lowcode.com +- visual-testsigma.lowcode.com +- audit-testsigma.lowcode.com +- mobilerecorder-testsigma.lowcode.com + + +[[info | **NOTE**:]] +| Do not share the **SSL Certificates key (.key)** files with any parties of the Testsigma team, as Testsigma will not ask for these at any point. + + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/pre-installation/prerequisites-and-machine-configurations.md b/src/pages/docs/on-premise-setup/pre-installation/prerequisites-and-machine-configurations.md new file mode 100644 index 00000000..f4cd9920 --- /dev/null +++ b/src/pages/docs/on-premise-setup/pre-installation/prerequisites-and-machine-configurations.md @@ -0,0 +1,217 @@ +--- +title: "Prerequisites for On-Premise Installation" +order: 26.12 +page_id: "On-premise setup prerequisites" +metadesc: "This detailed guide will help you understand the prerequisites for Testsigma On-premise setup | Know these details before getting started with Testsigma on-premise setup" +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Detailed Specifications & Pre-Checks" + url: "#detailed-specifications--pre-checks" +--- + +--- + +Testsigma recommends hardware, software, and server specifications for smooth installation. This article provides these specifications, necessary dependencies, and pre-checks for installing Testsigma on-premises. + + +--- + +## **Detailed Specifications & Pre-Checks** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RequirementsDetails
Machine Specifications:
CPU16 Core
RAM64 GB & above
StorageOption 1: 512GB - 2TB single storage
Option 2: 256GB + 1TB & above mounted disk

Note: For both storage options, scheduled image backups are recommended.
Database Requirements:
CPU4 Core
RAM32 GB
RDBMSMySQL
Version8.0.x
Note: Testsigma provides a MySQL Docker container. If you want a hosted MySQL, ensure it meets the above specifications.
Machine Configuration:
OSInstall Ubuntu at the root with a 256GB machine.
Additional StorageMount a 2TB (or above, based on usage) hard disk for storage.
Software InstallationAll required software will be installed at the root, with storage configurations set to utilize the mounted disk.
Mount PointMount the external disk at /data.
File SystemYou can choose any file system available based on expertise and requirements.
Hard Disk PerformanceImproved using RAID configuration (optional).
Backup Recommendations:
FrequencyBackup every 24 hours.
RetentionMaintain backups for 1 week.
CleanupPeriodically clean up old data to maintain disk health and space. Additional hardware may be required for longer data retention, which can be attached to the existing mount point using LVM.
Note: Recommendations are subject to adjustment based on customer requirements, and installation costs may vary based on these adjustments.
Pre-Checks:
Internet ConnectionEnsure an active internet connection to the server machine.
Firewall ConfigurationIf a firewall is enabled, whitelist the following domains:
*.docker.com
*.amazon.com
*.amazonaws.com
*.maven.org

For using Testsigma's mail service, whitelist *.sendgrid.com.
Unblock PortsUnblock the following ports if they are blocked: 3307, 7010, 8080, 8082, 8084, 9090, 9095, 9096, 9097, 4201, 4203, 4211, 4230.

Testsigma services use these ports for internal communication. (Details Below)
Ports Required by Testsigma Micro-Services:
testsigma_mysql3307
testsigma_id_server8084, 9095
testsigma_id_server_ui4203
testsigma_app_server8080, 9096
testsigma_groot_ui4211
testsigma_addon_server8082, 9097
testsigma_addon_server_ui4201
testsigma_audit_server9090
testsigma_audit_ui4230
testsigma_visual_testing_server7010
Additional Requirements:
Agent Operating SystemDepending on user preference, the agent can run on Linux, Windows, or Mac machines.
Final Storage LocationThe final storage location for screenshots, apps, and other permanent files is the host server where Testsigma containers run.
Temporary FilesTemporary files like screenshots may need periodic cleaning depending on usage and disk space availability.
Windows MachinesThe server operation does not require any Windows machines.
Data BackupsCustomer IT teams must regularly perform data backups through regular disk or specific data folder backups.
Hypervisor-based InstallationTestsigma On-Prem Server is not a hypervisor-based installation.
Domain Name Customization
  • By default, the customer would be provided URLs ending with testsigmaprivate.com (like https://cx.testsigmaprivate.com).

  • If the customer desires to have these pointed to their domain name (like cx.com), then we need the following:
    +
  • Inform Testsigma before the On-prem build is generated.
  • +
  • Get the SSL certificates of the domain in interest and copy them to the server where installation would happen.
  • Testsigma Recorder InstallationFor installing Testsigma Recorder on Chrome browsers:
    +
  • We need the ability to enable developer mode and install the Testsigma recorder in unpacked mode.
  • SMTP SettingsCustomers need to produce their SMTP settings in case they desire to use their internal SMTP instead of Testsigma SMTP servers.
    + + + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/pre-installation/testsigma-on-prem-architecture.md b/src/pages/docs/on-premise-setup/pre-installation/testsigma-on-prem-architecture.md new file mode 100644 index 00000000..143048c5 --- /dev/null +++ b/src/pages/docs/on-premise-setup/pre-installation/testsigma-on-prem-architecture.md @@ -0,0 +1,126 @@ +--- +title: "Testsigma's On-Premise Architecture" +order: 26.11 +page_id: "Testsigma's On-premise Architecture" +metadesc: "Learn how Testsigma on-premise system architecture provides a secure environment for creating and executing automated tests within your organization's local infrastructure" +noindex: false +search_keyword: "" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Important Components" + url: "#important-components" +- type: link + name: "Interactions" + url: "#interactions" +- type: link + name: "Testsigma Central Server Architecture" + url: "#testsigma-central-server-architecture" +--- + +--- + +The Testsigma On-Premise System Architecture provides a secure environment for creating and executing automated tests within your organization's local infrastructure. This article discusses Testsigma's On-Premise System Architecture. + +This architecture includes three main components: +1. Client Systems +2. Central Server +3. Database + +Here’s a high level illustration of Testsigma’s On-prem Architecture: + +![Architecture](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tsarchitecture.png) + +--- + +## **Important Components** + +### **1. Client Systems:** +- **Agents:** + - Software programs that are installed on each client system for test creation and execution. + - These Agents communicate with test browsers and mobile devices to execute tests, using various ports, including 8383, 8484, 8100, and 5037, and a range from 10000 to 65535. + - The Agents send test results to the Central Server. + +- **Browsers:** + - Browsers on the Client Systems provide users access to the Testsigma application via a web interface for seamless interaction. + +### **2. Central Server:** + - The Central Server is the main hub of the Testsigma On-Premise System Architecture. + - It processes and stores all data received from the Agents. + - It provides a web interface to access the Testsigma application. + - It communicates with the Database to store and retrieve data and ensures that retrieved data is organized. + - It also offers storage capabilities for data and test results. + +### **3. Database:** + - The Database is the backbone of data storage within the Testsigma On-Premise System Architecture. + - It stores all relevant information, including test results, user data, and other necessary details. The Database communicates with the Central Server using TCP on port 3307. + +--- + +## **Interactions** + +Here's the detailed explanation of communication between components: + +![Detailed Communication](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DetailedArchitecture.png) + +### **1. Client Access** +- Clients access the Testsigma application using web browsers and interact with the application's features and functionalities. +- Communication between the Client and the Central Server happens via HTTPS protocol. + +### **2. Agent Communication** +- The Agent on client machines executes tests on browsers and mobile devices by communicating with the Central Server using HTTPS. +- The Agent also handles the test execution process and returns the results to the Central Server. + +### **3. Central Server to Database** +- The Central Server communicates with the Database using TCP on port 3307 to store and retrieve necessary data. + +--- + +## **Testsigma Central Server Architecture** + +The Testsigma Central Server Architecture is designed within a Docker environment, providing containerization benefits such as isolation, scalability, and easy deployment. The architecture consists of servers responsible for specific tasks and a MySQL database to manage data storage. + +![Central Server Architecture](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/CentralServerAchitecture.png) + +### **Components** + +**1. Load Balancer** +- **Role:** Acts as the entry point to the system, distributing incoming traffic among multiple servers to prevent any single server from becoming a bottleneck. + +**2. ID Server** +- **Role:** Handles user identity, authentication, and authorization services. +- **Ports:** 8084, 9095, 4203 + +**3. App Server** +- **Role:** Manages the main application logic and user requests. +- **Ports:** 8080, 9096, 4211 + +**4. Addon Server** +- **Role:** Supports additional features or plugins that extend the main application functionality. +- **Ports:** 8082, 9097, 4201 + +**5. Audit Server** +- **Role:** Manages logging, monitoring, and auditing of system activities and transactions. +- **Ports:** 9090, 4230 + +**6. Visual Testing Server** +- **Role:** Handles visual testing tasks, such as UI validation and automated visual regression testing. +- **Port:** 7010 + +**7. MySQL Database** +- **Roles:** + - Stores all the application data, including user information, transactions, logs, etc. + - Communicates with all servers to provide necessary data access. +- **Port:** 3307 + + +### **Interactions** +**1. Load Balancer:** +- Routes traffic to the ID, App, Addon, Audit, and Visual Testing servers. + +**2. Servers:** +- Each server interacts with the MySQL database to store and retrieve data as needed. + +--- \ No newline at end of file diff --git a/src/pages/docs/on-premise-setup/prerequisites.md b/src/pages/docs/on-premise-setup/prerequisites.md deleted file mode 100644 index fb659548..00000000 --- a/src/pages/docs/on-premise-setup/prerequisites.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "On-Premise Setup Prerequisites" -order: 26.1 -page_id: "On-premise setup prerequisites" -metadesc: "This detailed guide will help you understand the prerequisites for Testsigma On-premise setup | Know these details before installing Testsigma On-premise setup" -noindex: false -search_keyword: "" -warning: false -contextual_links: -- type: section - name: "Contents" -- type: link - name: "Software, Hardware, and other Requirements" - url: "#software-hardware-and-other-requirements" ---- - ---- - - -This article outlines the essential steps and requirements for a successful on-premise setup. Understanding these prerequisites before installing the software is important to ensure a smooth installation process. So, follow the recommendations and requirements given in this document to avoid any issues during the installation process. - - ---- - - - -## **Software, Hardware, and other Requirements** - - -|**Requirements**|**Details**| -|---|---| -|**Server Configuration**|
  • **OS**: Ubuntu (22.04 LTS) or higher
  • **CPU**: 24 core
  • **RAM**: 64 GB
  • **DISK**: 1 TB - 2 TB (Depending on usage)| -|**Software Requirements**|
  • Internet connectivity on server
  • Docker installation capability on server
  • Root privileges on server
  • Permissions to install/Start the following libraries/executables on customer employee machines:
    - Java/JVM
    - Appium
    - ADB from android
    - Ability to run xcrun on mac os machines
    - Ability to run xattr on mac os machines| -|**Machine Configuration**|
  • It is recommended to install Ubuntu at the root with a 256GB machine.
  • Additionally, it is advised to mount a 2TB and above (based on the usage) hard disk for storage.
  • All required software will be installed at the root, and storage configurations will be set to utilize the mounted disk.| -|**Network Requirements**|
  • If the firewall enabled, *.docker.com, *.amazon.com, *.amazonaws.com, *.maven.org, these should be whitelisted.
  • If they wanted to use the Testsigma mail service, *.sendgrid.com needs to be whitelisted. | -|**Database Requirements**|
  • MySQL database would be installed by default.
  • The user must use only MySQL version 5.7
  • If the customer is going to use a MySQL installation, then we need to install the following commands to setup DB:

    *CREATE DATABASE IF NOT EXISTS tstmp;*
    *CREATE DATABASE IF NOT EXISTS identity;*
    *CREATE DATABASE IF NOT EXISTS master;*
    *CREATE DATABASE IF NOT EXISTS tenant1;*
    *CREATE DATABASE IF NOT EXISTS kibbutz;*

    *SET session sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';*

    *SET global sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';*

  • For cloud databases like AWS RDS if the setting of sql_mode is not allowed the provider-specific option can be used like AWS RDS parameter groups.
  • For external databases we would be encouraged to have disk space of 512GB - 1TB depending on customer usage.| -|**Backup information**|Customers would be responsible for taking backup of the Database.| -|**SMTP Requirements**|Customers need to produce their SMTP settings in case they desire to use their internal SMTP instead of Testsigma SMTP servers.| -|**Additional Requirements**|
  • Depending on user preference, the agent can run on Linux, Windows, or Mac machines.
  • The final storage location for screenshots, apps, and other permanent files is the host server where Testsigma containers run.
  • Temporary files like screenshots may need periodic cleaning depending on usage and disk space availability.
  • The server operation does not require any Windows machines.
  • Customer IT teams must regularly perform data backups through regular disk or specific data folder backups.
  • Testsigma On-Prem Server is not a hypervisor-based installation.
  • By default, the customer would be provided URLs ending with testsigmaprivate.com (like https://cutomername.testsigmaprivate.com)
  • If the customer desires to have these pointed to their domain name (like customername.com), then we need the following:
    - Inform Testsigma before the Onprem build is generated.
    - Get the SSL certificates of the domain in interest and copy them to the server where installation would happen.
  • For installing Testsigma Recorder on chrome browsers,
    - We need the ability to enable developer mode.
    - We need the ability to install the Testsigma recorder in unpacked mode.| -|**Additional Checks**|
  • Check the internet connection to the server machine.
  • Please unblock the ports if blocked. Ports: 3306, 7010, 8080, 8082, 8084, 9090, 9095, 9096, 9097, 4200, 4201, 4203, 4210, 4211, 4220, 4230.| - -[[info | **NOTE**:]] -| - Testsigma will provide a MySQL docker container; if you want to use the hosted MySQL, please acquire one with the above specification. -| - It is recommended to have a scheduled image backup. -| - Admin access is necessary for On-Prem installation. - - - ---- \ No newline at end of file diff --git a/src/pages/docs/salesforce-testing/connected-app.md b/src/pages/docs/salesforce-testing/connected-app.md index 20ff29e2..810a2d67 100644 --- a/src/pages/docs/salesforce-testing/connected-app.md +++ b/src/pages/docs/salesforce-testing/connected-app.md @@ -81,5 +81,11 @@ Creating a connected app is important to link external applications and the Sale 4. For Security Token, go to **My Personal Information > Reset My Security Token** and click on **Reset Security Token**. A new token will be sent to admin mail. ![Reset Security Token](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sfcarst.png) +
    + + + +> Refer to this [Salesforce troubleshooting]((https://testsigma.com/docs/troubleshooting/salesforce-testing/most-common-issues/)) guide for the most common issues while creating a connected app. + --- \ No newline at end of file diff --git a/src/pages/docs/test-cases/manage/update-test-case-results-in-a-test-plan.md b/src/pages/docs/test-cases/manage/update-test-case-results-in-a-test-plan.md index 0fec7ee4..4c28a94b 100644 --- a/src/pages/docs/test-cases/manage/update-test-case-results-in-a-test-plan.md +++ b/src/pages/docs/test-cases/manage/update-test-case-results-in-a-test-plan.md @@ -1,9 +1,9 @@ --- -title: "Update Test Case result in a Test Plan" -metadesc: "This article explains how to update Test Case result in a Test Plan" +title: "Update Test Case Result in a Test Plan" +metadesc: "Change the status of test cases in test plan reports to ignore test case result of known issues | This article discusses how to update the status of a test case in a test plan" noindex: false order: 4.17 -page_id: "Update Test Case result in a Test Plan" +page_id: "Update Test Case Result in a Test Plan" warning: false contextual_links: - type: section @@ -13,32 +13,57 @@ contextual_links: url: "#steps-to-update-test-case-results" --- -
    -In Testsigma, you can change the status of Test Cases in Test Plan reports. This article discusses how to update the status of a Test Case in a Test Plan. +--- -Here is a quick GIF demonstrating how to update Test Case results in Test Plans in Testsigma. +
    +
    + 🔴 Flagged Feature: +

    + This feature is currently flagged. Please get in touch with Testsigma support to enable this feature. +
    -![GIF to update TC](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/updatingtcresult.gif) -[[info | **NOTE**:]] -|Test Plan results will be automatically updated as per the changes in the test case results. For information on how to update Test Case results using REST API, refer to update Test Case run results using API. -## **Steps to Update Test Case results** -1. Navigate to **Test Development > Run Results**. -![Run Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/runresults.png) -2. Hover over to the Test Plans and click on **View reports**. -![View Reports](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/hovertotp.png) +In Testsigma, you can change the status of test cases in test plan reports. This article discusses how to update the status of a test case in a test plan. + +--- + + +## **Steps to Update Test Case Results** + +1. From the left-side navbar, go to **Test Plans**. + + ![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/TestPlansNavigation.png) + + +2. Select the test plan in which you want to update the test case result and click **View Reports**. + + ![View Reports](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/View_Reports_Test_Plans.png) + + +3. Hover over the test case result of which you want to change the status and click on the result you want to update from the dropdown menu. + + ![Result Dropdown](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Dropdown_TestCase_Result.png) + + +4. On the **Add Comments** dialog, add a comment and click on **Save**. + + ![Add Comments](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Add_Comments_Result_Update.png) + +5. Hover over the same test case result to see the updated status and comment. + + ![Updated Status](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Updated_Test_Result.png) + +[[info | **NOTE**:]] +| Test plan results will be automatically updated as per the changes in the test case results. For information on how to update test case results using Rest API, refer to [update test case run results using API](https://testsigma.com/docs/api/examples/update-test-case-results-using-API/). + +
    -3. On the result type dropdown menu, click on **Test Case Results**. -![TC Results](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tcresults.png) +Here is a quick GIF demonstrating how to update test case results in a test plan. -4. Hover over the Test case result of which you want to change the status and click on the result you want to update. -![Hover](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/hoverovertc.png) +![Update Test Case Result](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/UpdateTestCaseResult.gif) -5. On **Add comments** prompt, add a comment and click on **Update**. -![Update](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prompt.png) -6. Hover over the same Test Case to see the updated status and comment. -![Same TC](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/status.png) +--- \ No newline at end of file diff --git a/src/pages/docs/test-data/data-generators/datefunctions-function-type.md b/src/pages/docs/test-data/data-generators/datefunctions-function-type.md index 477dc71a..5f8ad79e 100644 --- a/src/pages/docs/test-data/data-generators/datefunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/datefunctions-function-type.md @@ -603,19 +603,19 @@ Here's a comprehensive example using the provided code template. The examples fo Outputs - At most: 30
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 16/06/2024 - At most: 60
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 17/05/2024 - At most: 90
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 17/04/2024 - At most: 45
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 01/06/2024 @@ -671,19 +671,19 @@ Here's a comprehensive example using the provided code template. The examples fo Outputs - At most: 30
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 15/08/2024 - At most: 60
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 14/09/2024 - At most: 90
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 14/10/2024 - At most: 45
    Unit: DAYS
    Format: dd/MM/yyyy + Unit: DAYS
    Format: dd/MM/yyyy 30/08/2024 @@ -739,7 +739,7 @@ Here's a comprehensive example using the provided code template. The examples fo Outputs - At most: 30
    Unit: DAYS
    Reference Date: 10/07/2024
    Format: dd/MM/yyyy + Unit: DAYS
    Reference Date: 10/07/2024
    Format: dd/MM/yyyy 10/06/2024 diff --git a/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md b/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md index 505d22f8..30d6d757 100644 --- a/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md +++ b/src/pages/docs/test-data/data-generators/phonenumberfunctions-function-type.md @@ -100,7 +100,7 @@ Before utilising the different data generator functions, it's essential to under Select Phone Number
    Timeout: 30 - OTP: 1234 + 1234 @@ -118,7 +118,7 @@ Before utilising the different data generator functions, it's essential to under Select Phone Number
    Timeout: 120 - OTP: 4982, 789012 + 4982, 789012 @@ -127,7 +127,7 @@ Before utilising the different data generator functions, it's essential to under Select Phone Number
    Timeout: 45 - OTP: 45178 + 45178 diff --git a/src/templates/page.scss b/src/templates/page.scss index f056c149..f36e38f2 100644 --- a/src/templates/page.scss +++ b/src/templates/page.scss @@ -660,32 +660,156 @@ table{ } // Cookie banner -#hs-banner-parent{ - .hs-cookie-notification-position-bottom{ - width: calc(min(28em, 100%)) !important; - left: calc(min(15em, 100%)) !important; +#hs-banner-parent { + a { + color: #09c0a1 !important; + &:hover { + color: #007d85 !important; + text-decoration: underline !important; + } + } + .hs-cookie-notification-position-bottom { + width: calc(min(26.5em, 100%)) !important; + left: calc(min(18.7em, 100%)) !important; @media only screen and (max-width: 767px) { - left: 3%; - bottom: 2%; - width: 95%; - } - @media only screen and (min-width:768px) and (max-width: 1023px) { - left: 20%; - bottom: 10%; - width: 35%; - } - #hs-eu-cookie-confirmation-inner{ - @apply p-8; - #hs-eu-policy-wording{ - @apply mr-0 mb-4; + left: 3% !important; + bottom: 2% !important; + max-width: 95% !important; + } + @media only screen and (min-width: 768px) and (max-width: 1023px) { + left: 20% !important; + bottom: 10% !important; + max-width: 35% !important; + } + #hs-eu-cookie-confirmation-inner { + padding: 2rem; + #hs-eu-policy-wording { + strong { + margin: 0 0 1rem 0; + font-size: 14px !important; + line-height: 24px !important; + color: #5f5f5f !important; + font-weight: 300 !important; + } + } + #hs-eu-cookie-confirmation-buttons-area { + justify-content: center; + margin-right: 0; + #hs-eu-confirmation-button-group { + flex-flow: row; + #hs-eu-cookie-settings-button { + padding: 10px 25px !important; + text-align: center !important; + font-size: 14px !important; + line-height: 20px !important; + border: 0.5px solid #d0d5dd !important; + color: #0a1a2a !important; + min-width: 12em !important; + text-decoration: none !important; + } + #hs-eu-confirmation-button, + #hs-eu-cookie-settings-button { + font-weight: 600 !important; + border-radius: 5px !important; + &:hover { + color: white !important; + background-color: #007d85 !important; + border-color: #007d85 !important; + } + } + } + } + #hs-eu-decline-button { + display: none; } - #hs-eu-cookie-confirmation-buttons-area{ - @apply justify-center mr-0; - #hs-eu-decline-button{ - @apply hidden; + } + } +} +#hs-modal { + a { + color: #09c0a1 !important; + } + #hs-modal-introduction { + font-size: 16px !important; + } + #hs-modal-introduction-description { + p { + font-size: 14px !important; + line-height: 24px !important; + font-weight: 400 !important; + color: #5f5f5f !important; + } + } + #hs-modal-body-container{ + gap: 0 !important; + } + #hs-categories-container { + padding-top: 20px !important; + .hs-category-row { + border-top: #d0d5ddbd !important; + border-style: solid !important; + border-width: 1px 0 0 0 !important; + padding: 15px 10px 0 !important; + .hs-toggle-switch { + width: calc(34px + 2px) !important; + height: calc(18px + 2px) !important; + .hs-toggle-switch-nob{ + height: 14px !important; + width: 14px !important; + } + } + .hs-toggle-selected-flag{ + .hs-toggle-switch-nob{ + left: 56% !important; } } + .hs-category-label{ + gap: 5px !important; + } + } + #hs-category-analytics, + #hs-category-necessary, + #hs-category-advertisement, + #hs-category-functionality { + span { + font-size: 18px !important; + line-height: 24px !important; + font-weight: 600 !important; + } } + .hs-category-description { + font-size: 14px !important; + line-height: 20px !important; + font-weight: 400 !important; + color: #5f5f5f !important; + } + .visible { + padding-top: 15px; + padding-left: 20px !important; + } + } + .hs-always-active-label { + font-size: 14px !important; + line-height: 20px !important; + font-weight: 600 !important; + color: #09c0a1 !important; + } + #hs-modal-footer-container { + #hs-modal-accept-all { + order: 2 !important; + } + #hs-modal-accept-all, + #hs-modal-save-settings { + font-weight: 600 !important; + &:hover { + background-color: #007d85 !important; + border: #007d85 !important; + color: white !important; + } + } + } + #hs-modal-footer{ + padding-top: 12px !important; } }