User Description

Generating functional test scenarios using our AI based service Nova, through use case description. Below you can see how to generate test cases from description using both SDKs and APIs.

Usage 🚀

Refer to Setup Guide for installing dependecies for both Java and Python.

JAVA

There are 2 clients available with the Java SDK: SyncClient and AsyncClient

Java Client Code

# for async client 
import org.qyrus.ai_sdk.Clients.AsyncClient;
AsyncClient client = new AsyncClient(<API_TOKEN>, null);

# for sync client
import org.qyrus.ai_sdk.Clients.SyncClient;
SyncClient client = new SyncClient(<API_TOKEN>, null);

Using SyncClient

Here's an example of utilizing Nova via the user description to generate test scenarios with SyncClient.

Java SyncClient Code

private static void createTestScenariosWithDescription(){

    SyncClient client = new SyncClient(<API_TOKEN>, null);
    String use_case_description = <USE_CASE_DESCRIPTION>;

    try {
        NovaDescription.CreateScenariosResponse response = client.nova.from_description.create(use_case_description);
        System.out.println("Creation Status: " + response.isOk());
        System.out.println("Creation Status: " + response.getMessage());

        //Show all the scenarios generated
        if (response != null && response.isOk() == true && response.getScenarios() != null) {
            System.out.println("Creation Status: " + response.getNovaRequestId());

            List<NovaDescription.Scenario> scenarios = response.getScenarios();

            // Loop over the list and print out scenarios
            for (NovaDescription.Scenario scenario : scenarios) {
                System.out.println("Test Script Name: " + scenario.getTestScriptName());
                System.out.println("Test Script Objective: " + scenario.getTestScriptObjective());
                System.out.println("Reason to Test: " + scenario.getReasonToTest());
                System.out.println("Criticality Description: " + scenario.getCriticalityDescription());
                System.out.println("Criticality Score: " + scenario.getCriticalityScore());
                System.out.println("--------------------------------------");
            }
        }
        
        
    } catch (Exception e) {
        e.printStackTrace();
    }
}

Using AsyncClient

Here's an example of utilizing Nova via the user description to generate test scenarios with AsyncClient.

Java AsyncClient Code

private static void asyncCreateTestScenariosWithDescription(){

    AsyncClient client = new AsyncClient(<API_TOKEN>, null);
    String use_case_description = <USE_CASE_DESCRIPTION>


    int numberOfRequests = 2;

    long startTime = System.currentTimeMillis();

    List<CompletableFuture<AsyncNovaDescription.CreateScenariosResponse>> futures = new ArrayList<>();

    for (int i = 0; i < numberOfRequests; i++) {
    
        CompletableFuture<AsyncNovaDescription.CreateScenariosResponse> responseFuture = client.nova.from_description.create(use_case_description);

        responseFuture.thenAccept(response -> {
            if (response.isOk()) {
                System.out.println("Creation Status: " + response.getNovaRequestId());

                List<AsyncNovaDescription.Scenario> scenarios = response.getScenarios();

                // Loop over the list and print out scenarios
                for (AsyncNovaDescription.Scenario scenario : scenarios) {
                    System.out.println("Test Script Name: " + scenario.getTestScriptName());
                    System.out.println("Test Script Objective: " + scenario.getTestScriptObjective());
                    System.out.println("Reason to Test: " + scenario.getReasonToTest());
                    System.out.println("Criticality Description: " + scenario.getCriticalityDescription());
                    System.out.println("Criticality Score: " + scenario.getCriticalityScore());
                    System.out.println("--------------------------------------");
                }
            }
            else {
                System.out.println("Creation failed with message: " + response.getMessage());
            }
    }).exceptionally(ex -> {
        System.out.println("An error occurred: " + ex.getMessage());
        ex.printStackTrace();
        return null;
    });

    // Keep your program running until all futures are resolved
    // responseFuture.join(); // Block and wait for the future to complete
    futures.add(responseFuture);
    }

    CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).join();

    long endTime = System.currentTimeMillis();
    System.out.println("Asynchronous total time for Nova with Description" + numberOfRequests + " requests: " + (endTime - startTime) + " ms");
    
}

---

PYTHON

There are two clients available with the Python SDK: SyncQyrusAI and AsyncQyrusAI.

Python Client Code

# for sync client
from qyrusai import SyncQyrusAI
client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

# for async client
from qyrusai import AsyncQyrusAI
client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

Using SyncQyrusAI

Here's an example of utilizing Nova via the user description to generate test scenarios with SyncQyrusAI.

Python SyncQyrusAI Code

import os
import json
from qyrusai import SyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = SyncQyrusAI(api_key=QYRUS_API_TOKEN)

# user_description: provide user description to create tests.
op = client.nova.from_description.create(user_description="Create tests for login page")

# print(json.dumps(op.model_dump(), indent=4))
scenarios  = op.get("scenarios")
for scenario in scenarios:
    print(scenario["test_script_name"])
    print(scenario["test_script_objective"])
    print(scenario["reason_to_test"])
    print(scenario["criticality_description"])
    print(scenario["criticality_score"])

Using AsyncQyrusAI

Here's an example of utilizing Nova via the user description to generate test scenarios with AsyncQyrusAI.

Python AsyncQyrusAI Code

import os
import json
import asyncio
from qyrusai import AsyncQyrusAI

QYRUS_API_TOKEN = os.environ.get("QYRUS_API_TOKEN")

client = AsyncQyrusAI(api_key=QYRUS_API_TOKEN)

# user_description: provide user description to create tests.
async def main():
    op = await client.nova.from_description.create(user_description="Create tests for login page")
    # print(json.dumps(op.model_dump(), indent=4))
    scenarios  = op.get("scenarios")
    for scenario in scenarios:
        print(scenario["test_script_name"])
        print(scenario["test_script_objective"])
        print(scenario["reason_to_test"])
        print(scenario["criticality_description"])
        print(scenario["criticality_score"])

# Run the async function
asyncio.run(main())

---

Rest APIs

This API allows users to generate test scenarios based on provided user description.

• Endpoint

  • URL : POST {{GATEWAY_URL}}/nova-sdk/v1/api/nova_user

• Headers

  • Authorization: [Your Authorization Token]

  • Custom: [Your Custom Header Value]

• Request Body: { "user_description": "Create Tests for Login Page" }

• Response: