testcollab-sdk

This SDK allows Test Collab clients to call API easily, build custom workflows, reports, and integrations with CI/CD pipelines and more.

Installation

To install the library, use npm:

npm install @testcollab/sdk

Usage Example

You'll need to authenticate the client before you can use any methods.

There are 2 possible authentication methods:

a) API key: To generate API key: login to your TestCollab account and go to 'My Profile Settings' and switch to API Token tab. Click on "Generate new API token".

b) Access token: This requires logging into API programmatically with this SDK using login method which will provide a auth token.

For the purpose of this documentation, we'll stick to the API key based authorization.

Authentication

API Key method:

import { createConfiguration, TestPlansApi, TestPlanTestCasesApi, TestPlansAssignmentApi, TestCasesApi } from '@testcollab/sdk';

const apiKey = '123456-abc';
const config = createConfiguration(apiKey);
const testPlansApi = new TestPlansApi(config);

If you need to override URL (for self-hosted setup or EU server residency), you can pass basePath as the second argument:

const config = createConfiguration(apiKey, {
    basePath: 'https://api-eu.testcollab.io'
});

Add Test Case

        const testCasesApi = new TestCasesApi(config);

        const createdTestCase = await testCasesApi.createTestCase({
            testCasePayload: {
                project: 1234,
                title: 'SDK generated test case',
                suite: 5678,
                priority: 1, // 0: Low, 1: Normal, 2: High
                description: '<p>Verify login flow works for valid user</p>',
                steps: [
                    { step: 'Open login page', expectedResult: 'Login form is visible' },
                    { step: 'Submit valid credentials', expectedResult: 'User lands on dashboard' }
                ],
                tags: [10, 11],
                customFields: []
            }
        });

        console.log('Test Case ID: ' + createdTestCase.id)

Test Plan Add

        const response = await testPlansApi.addTestPlan({
            testPlanPayload: {
                project: 1234,
                title: 'From SDK',
                description: 'This is a test plan is created using the Node.js SDK',
                status: 1,
                priority: 1,
                testPlanFolder: null,
                customFields: []

            }
        });

        // get the test plan id
        const testPlanId = response.id;
        console.log('Test Plan ID: ' + testPlanId)

Add New Test Cases to Test Plan

        const testPlanCases = new TestPlanTestCasesApi(config);

        const res2 = await testPlanCases.bulkAddTestPlanTestCases({
            testPlanTestCaseBulkAddPayload:
            {
                testplan: testPlanId,
                "testCaseCollection": {
                    testCases: [1, 2, 3],
                    selector: []
                }
            }
        });
        //console.log(res2)

Assign test cases to a tester in test plan

        const testPlanAssignment = new TestPlansAssignmentApi(config);
        const res3 = await testPlanAssignment.assignTestPlan({
            project: 1234,
            testplan: testPlanId,
            testPlanAssignmentPayload: {
                "executor": "me",
                "assignmentCriteria": "testCase",
                "assignmentMethod": "automatic",
                "assignment": {
                    "user": [2],
                    "testCases": {
                        "testCases": [],
                        "selector": []
                    },
                    "configuration": null
                },
                "project": 1234,
                "testplan": testPlanId
            }
        })
        console.log(res3)

API Documentation

Detailed API documentation is available at Test Collab OpenAPI specs.

Author

Test Collab Software LLC

Contact Information

For support, please contact us at support@testcollab.com.