Run Tests on Private Grid

Testsigma Private Grid helps run parallel tests across multiple browsers, operating systems, and machines. This can boost the execution time of even the largest test suites and save minutes, hours, or days.

Hub
The Hub is the main controller in Private Grid. Once it receives the test requests, it distributes them to different machines called Nodes. The Hub knows what each Node can do. It evaluates the test requirements against the capabilities of the available Nodes to select the best match and forwards the tests to the selected Nodes.

Nodes
Like Test Machines in Testsigma, Nodes are the machines that run the tests in Private Grid. They can have multiple browsers and operating systems. A session is created when the Node receives a test request from the client. Any commands sent to this Node will then be executed, and the response will be returned to the client. Nodes can handle multiple test sessions simultaneously, depending on their configuration and resource capacity.

This article discusses executing tests in Testsigma Private Grid.

Prerequisites

• Testsigma Agent
• Core Java (OpenJDK 18)
• Testsigma Private Grid Folder
• Ngrok Setup

Create Dynamic Agent Through API

Use the following Endpoint to create Dynamic Agents with Private Grid configuration in Testsigma using REST API.

{
    "name": "<Unique Agent Name>",
    "agentType": "TRANSIENT",
    "externalConfig": {
        "url": "http://localhost:4444",
        "authenticationEnabled": true,
        "userName": "root",
        "password": "root",
        "type": "SELENIUM",
        "browserList": ["Chrome", "Safari"]
    }
 }

{
 "id": 9,
 "uniqueId": "a3cceab7-5bc9-41d1-a905-e54e0a23c677",
 "jwtApiKey": "<Unique JWT Token>",
 "agentVersion": null,
 "createdById": 2,
 "updatedById": 2,
 "createdDate": 1719222650559,
 "updatedDate": 1719222650559,
 "system": {
 "title": "Dynamic Agent",
 "id": 21,
 "protocol": "http",
 "port": null,
 "httpsPort": null,
 "ipAddress": "127.0.0.1",
 "hostName": null,
 "osType": null,
 "osVersion": null,
 "systemType": 4
 },
 "browserList": [],
 "currentAgentVersion": "5.9.0",
 "status": "REGISTERED",
 "isActive": false
}

Here’s a quick GIF demonstrating how to create a Dynamic Agent through API with the above mentioned endpoint.

Start Dynamic Agent Using jwtApiKey

Open the terminal in the Testsigma Agent directory and use the following command to start the Dynamic Agent:

For Mac/Linux

<agent_dir>./start.sh --TS_ACTIVATION_KEY=<JWT_KEY>

For Windows

<agent_dir>./start.bat --TS_ACTIVATION_KEY=<JWT_KEY>

Where <JWT_KEY> is jwtApiKey from the above response.

Here’s a quick GIF demonstrating how to start Dynamic Agent using jwtApiKey with the above command.

Start the Private Grid Hub & Web Nodes

To start the Private Grid Hub, open the Terminal at Private Grid folder and use the following command:

java -jar selenium-server-4.13.0.jar hub

Once the Private Grid starts, open http://localhost:4444

To start the Web Nodes, open the new tab on the same Terminal and use the following command:

java -jar selenium-server-4.13.0.jar node --config node.json --selenium-manager true

Once the command runs, the registered Nodes will be added to the Private Grid.

Here’s a quick GIF demonstrating the steps to start the Private Grid Hub and add Web Nodes.

Execute Tests in Private Grid using REST API

Use the following Endpoint to execute the Testsigma’s test plan in Private Grid using REST API.

 {
   "executionId" : <Test Plan Exe ID>,
   "testDevices" : [
       {
           "title" : "Dynamic Machine",
           "targetMachine" : 27,
           "browser" : "CHROME",
           "executionLabType" : "Hybrid",
           "suiteIds" : [<Suite IDs>],
           "isHeadless" : false,
           "runTestSuitesInParallel": true,
           "runTestCasesInParallel": true,
           "createSessionAtCaseLevel": true
       }
   ]
}

{
    "id": 581,
    "execution": null,
    "executionId": 346,
    "startTime": 1719400027825,
    "endTime": null,
    "duration": null,
    "result": "QUEUED",
    "status": "STATUS_CREATED",
    "message": "Test Plan execution message",
    "executedBy": 29,
    "buildNo": null,
    "environmentId": null,
    "totalCount": null,
    "failedCount": null,
    "passedCount": null,
    "stoppedCount": null,
    "notExecutedCount": null,
    "queuedCount": null,
    "runningCount": null,
    "visualTestResult": null,
    "environment": null,
    "childResult": null,
    "reRunParentId": null,
    "triggeredType": "API",
    "totalRunningCount": 0,
    "executionDetails": {
        "page_timeout": 30,
        "element_timeout": 30,
        "recovery_action": "Run_Next_Testcase",
        "on_aborted_action": "Reuse_Session",
        "screenshot_option": "ALL_TYPES",
        "screenshot_mode": null,
        "group_prerequisite_fail": "Abort",
        "test_case_prerequisite_fail": "Abort",
        "test_step_prerequisite_fail": "Run_Next_Testcase",
        "global_param_name": null
    },
    "totalQueuedCount": 0,
    "mobileInspectionId": null,
    "environmentResultsDTO": [],
    "executionResultConfig": null,
    "isReRunEnabled": false,
    "consolidatedResult": "QUEUED",
    "consolidatedStatus": "STATUS_CREATED",
    "resultType": "ORIGINAL",
    "consolidatedDuration": null,
    "runTestCasesInParallel": false,
    "runTestSuitesInParallel": false,
    "scheduledId": null,
    "testPlanHookResults": null,
    "reRunType": null,
    "consolidatedPlanTotalCount": null,
    "consolidatedPlanFailedCount": null,
    "consolidatedPlanPassedCount": null,
    "consolidatedPlanStoppedCount": null,
    "consolidatedPlanNotExecutedCount": null,
    "consolidatedPlanQueuedCount": null,
    "consolidatedPlanRunningCount": null,
    "testDevicesNames": null,
    "latestResult": null,
    "testPlanResultMetric": null,
    "activeExecutionResultCount": 0
}

Here’s a quick GIF demonstrating how to execute tests through a Dynamic Agent through API with the above mentioned endpoint.

Execute Tests in Private Grid from Application

a. Integrating Testsigma with Private Grid

1. From the left navigation bar, go to Settings > Integrations and choose the Test Lab tab.
2. Enable the toggle on the Private Grid widget. A popup screen will display the details for the Private Grid lab.

3. On Private Grid details,

   • If there is authentication enabled in ngrok platform, select Authentication Enabled and enter Username and Password.
   • Enter the Private Hub URL and select applications to use with your Private Grid framework.
4. Click on Add Details.

b. Execute Tests in Private Grid

1. For test case execution, select Private Grid as Test Lab on Ad-hoc Run overlay.

   Here’s a quick GIF demonstrating how to execute a test case in Private Grid.

2. For test plan execution, add Private Grid while creating test machine profiles for execution. You need to go to Add Test Suites & Link Machine Profiles > Select test machine profiles > Add Machine and add Private Grid as Test Lab.

   Here’s a quick GIF demonstrating how to execute a test plan in Private Grid.