Integration

Introduction to Integration in Avo Assure

Integration with external tools is done in two ways; either with the Avo Assure API or inbuilt integration with Avo Assure. For all the integration using Avo Assure API, the below three steps need to be followed.

1. Token Generation

2. Export of Mindmaps Data

3. Execution of JSON

Token Generation

1. Log in as an admin user and navigate to the Tokens section.

2. Select the ICE type for which the token has to be generated.

3. Select the user for which the token has to be generated. Fill in the following details:

   • Token name

   • Token expiry date, and time

4. On click of ‘Generate’, the token will be created.

Export of Mindmaps Data

1. Log in to Avo Assure as an end-user with access to Mindmaps.

2. Navigate to Mindmaps. Select the Module from the Assign Module page. For more information, refer to Designing a Test Flow.

3. Export the Mindmap in JSON Format and click the ‘Export’ button. Execution-related Module information is exported as a JSON file.

Exporting Module Information from Mindmaps

Execution JSON

1. Module Information has the test suite and test Scenario details to execute.

Module Information File

{
    "batchInfo": [{
        "testsuiteName": "Dummy_Test",
        "testsuiteId": "5ef4728c4f1df4328436833b",
        "versionNumber": 0,
        "appType": "Web",
        "domainName": "Manufacturing",
        "projectName": "Web",
        "projectId": "5de4e4aed9cdd57f4061bca5",
        "releaseId": "R1",
        "cycleName": "C1",
        "cycleId": "5de4e4aed9cdd57f4061c354",
        "suiteDetails": [{
            "condition": 0,
            "dataparam": [" "],
            "scenarioId": "5ef471d44f1df43284368333",
            "scenarioName": "Dummy_Test"
        }]
    }]
}

2. The execution template is divided into two parts: Execution Data and User Info.

3. Copy Module Info data extracted in the previous section into the Execution Template.

4. In the User Info section of the Execution Template, fill the details of Generated Token hash, Token name, ICE name, and Pool name.

5. Multi-user execution is also supported, i.e. Executions for multiple users can also be triggered in one request. To achieve that, combine different execution request data in one list.

Multi-User Execution Request Data

{
    "executionData": [{
        "source": "api",
        "executionMode": "serial",
        "executionEnv": "default",
        "browserType": ["1"],
        "integration"{
            "alm": {...},
            "qtest": {...},
            "zephyr": {...}
        },
        "batchInfo": [{...}],
        "userInfo": {...}
    }, {
        "source": "api",
        "executionMode": "serial",
        "executionEnv": "default",
        "browserType": ["1"],
        "integration": {
            "alm": {...},
            "qtest": {...},
            "zephyr": {...}
        },
        "batchInfo": [{...}],
        "userInfo": {...}
    }
    .
    .
    .
    {
        "source": "api",
        "executionMode": "serial",
        "execcutionEnv": "default",
        "browserType": ["1"],
        "integration": {
            "alm": {...},
            "qtest": {...},
            "zephyr": {...}
        },
        "batchInfo": [{...}],
        "userInfo": {...}
    }]
}