Create Rest method for your test suite( CI/CD)

QAautoMATER allows you to create custom test suites where you can link test scripts. Afterward, you can create RESTful services for these test suites, enabling you to execute the test scripts through REST API calls. These REST services can be seamlessly integrated into any CI/CD pipeline or Windows scheduler for automated testing.

Create Test suite from Test Suite & CICD page

Update Test script order or sequence

Using drag-and-drop feature on the Test Suite page you can update the test sequence of the test scripts

Create your account for test suite

To run a test suite from REST services, you need a special account. This account holds your expiration time based on its validity. If you are an admin of the account, you can directly create a special account

If your account name is "spacecraft," then the user email should be [e-mail]. The domain name can be changed, and accounts can be created from the "Add User Profile" section.

Once you log in to the application using the special account, we need to retrieve the access token for this account. We can obtain the access token from the network console.

Rest details for Web test suite execution

baseurl : The base URL will be your backend-hosted URL.

endpoint :

cicd/ui/project/:projectName

http method : Post

Request header

{
    "Authorization": "Bearer accessToken",
    "userEmail": "[e-mail]",
    "userselectedaccount": "Spacecraft",
    "accountlabel": "QaBunch"
}

Body

{"testSuiteName":"Smoke"}

Curl Command Example

curl --location 'https://localhost:3001/cicd/ui/project/Spacecraft' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--header 'userEmail: [e-mail]' \
--header 'accountlabel: QaBunch' \
--header 'userselectedaccount: Spacecraft' \
--data '{
    "testSuiteName": "Smoke"
}'

Please Note

We can also pass additional data in body section

{ "environment": "Prod", "threadCount": "2", "deviceName": "Chrome", "screenName": "Desktop", "applicationUrl": "https://google.com","recipientEmail","[e-mail]" }

Powershell script (for schduler)

We can create PowerShell scripts for executing test scripts using the same POST method to trigger them. These PowerShell scripts can be useful for scheduling tasks on Windows.

/# Define your POST request parameters
$body = @{
    testSuiteName = "smoke"
}

# Convert the body to JSON
$jsonBody = $body | ConvertTo-Json

# Define the URL you want to send the request to
$url = "https://localhost:3001/cicd/ui/project/Spacecraft"

# Define your headers
$headers = @{
    "Authorization" = "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNwYWNlY3JhZnRjaWNkdXNlckBxYWJ1bmNoLmNvbSIsImlhdCI6MTcxNDcyNjE1NSwiZXhwIjoxNzM1NTQ4NTU1fQ.uoByMB2dKjCHiujpXBiChQ-t72foyQrpZul-KENpWdM"
    "Content-Type" = "application/json"
    "userEmail"="[e-mail]"
    "userselectedaccount"="Spacecraft"
}

# Disable certificate validation temporarily
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}

try {
    # Send the POST request
    $response = Invoke-RestMethod -Uri $url -Method Post -Body $jsonBody -Headers $headers

    # Output the response
    $response

    # Once you get a response, do something with it
    Write-Host "Response received: $response"
} catch {
    Write-Error "An error occurred while sending the request: $_"
    exit 1  # Exit the script with a non-zero exit code to indicate failure
} finally {
    # Re-enable certificate validation
    [System.Net.ServicePointManager]::ServerCertificateValidationCallback = $null
}