Header Assertion

Header Assertion: Submit your API response header to receive the corresponding tests for the response using both SDKs and REST 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 Header Assertion with SyncClient.

Java SyncClient Code

private static void testHeaderAssertion() {

        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");

        SyncClient client = new SyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        String responseHeaders = "Access-Control-Allow-Credentials: true Access-Control-Allow-Origin: * Content-Length: 166 Content-Type: application/json Date: Wed, 12 Jun 2024 10:29:06 GMT Server: awselb/2.0";

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;

        for (int i = 0; i < numberOfRequests; i++) {
            try {
                // Assuming `client.header_assertion` is available and `assert` method matches the described input
                HeaderAssertion.HeaderAssertionResponse response = client.api_assertions.headers.create(responseHeaders);

                // Process and print the assertions
                for (HeaderAssertion.HeaderAssertionItem item : response.getHeaderAssertions()) {
                    System.out.println(item.getAssertHeaderKey());
                    System.out.println(item.getAssertHeaderValue());
                    System.out.println(item.getAssertionDescription());
                }

            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        long endTime = System.currentTimeMillis();
        System.out.println("Synchronous Total time for Header Assertion request: " + (endTime - startTime) + " ms");
    }

Using AsyncClient

Here's an example of utilizing Header Assertion with AsyncClient.

Java AsyncClient Code

private static void asyncTestHeaderAssertion() {

        Dotenv dotenv = Dotenv.load();
        String QYRUS_AI_SDK_API_TOKEN = dotenv.get("QYRUS_AI_SDK_API_TOKEN");

        AsyncClient client = new AsyncClient(QYRUS_AI_SDK_API_TOKEN, null);
        String responseHeaders = "Access-Control-Allow-Credentials: true Access-Control-Allow-Origin: * Content-Length: 166 Content-Type: application/json Date: Wed, 12 Jun 2024 10:29:06 GMT Server: awselb/2.0";

        long startTime = System.currentTimeMillis();
        int numberOfRequests = 2;
        List<CompletableFuture<AsyncHeaderAssertion.HeaderAssertionResponse>> futures = new ArrayList<>();
        for (int i = 0; i < numberOfRequests; i++) {

            CompletableFuture<AsyncHeaderAssertion.HeaderAssertionResponse> responseFuture = 
                client.api_assertions.headers.create(responseHeaders);

            responseFuture.thenAccept(response -> {
                // Process and print the assertions
                for (AsyncHeaderAssertion.HeaderAssertionItem item : response.getHeaderAssertions()) {
                    System.out.println(item.getAssertHeaderKey());
                    System.out.println(item.getAssertHeaderValue());
                    System.out.println(item.getAssertionDescription());
                }
            }).exceptionally(ex -> {
                System.out.println("An error occurred: " + ex.getMessage());
                ex.printStackTrace();
                return null;
            });

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

        long endTime = System.currentTimeMillis();
        System.out.println("Asynchronous total time for Header Assertion" + 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 Header Assertion 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)

headers = """HTTP/1.1 200 OK
access-control-allow-origin: *
access-control-allow-credentials: true
Access-Control-Allow-Methods: GET
Access-Control-Allow-Headers: authorization,Access-Control-Allow-Origin,Content-Type,SOAPAction,Custom
Content-Type: application/json
Date: Wed, 12 Jun 2024 07:23:56 GMT
Transfer-Encoding: chunked
Connection: keep-alive
Timing-Allow-Origin: *
"""
op = client.api_assertions.headers.create(headers=headers)
print(json.dumps(op, indent=4))

Using AsyncQyrusAI

Here's an example of utilizing Header Assertion 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)

headers = """HTTP/1.1 200 OK
access-control-allow-origin: *
access-control-allow-credentials: true
Access-Control-Allow-Methods: GET
Access-Control-Allow-Headers: authorization,Access-Control-Allow-Origin,Content-Type,SOAPAction,Custom
Content-Type: application/json
Date: Wed, 12 Jun 2024 07:23:56 GMT
Transfer-Encoding: chunked
Connection: keep-alive
Timing-Allow-Origin: *
"""
async def main():
    op = await client.api_assertions.headers.create(headers=headers)
    print(json.dumps(op, indent=4))

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

---

REST APIs

This API allows users to create test based on provided API resonse header.

• Endpoint

  • URL : POST {{GATEWAY_URL}}/api-assertion-gpt-sdk/v1/api/assertion/headers

• Headers

  • Authorization: [Your Authorization Token]

  • Custom: [Your Custom Header Value]

• Request Body: { "headers": "Access-Control-Allow-Credentials: true Access-Control-Allow-Origin: * Content-Length: 166 Content-Type: application/json Date: Wed, 12 Jun 2024 10:29:06 GMT Server: awselb/2.0" }

• Response: