get-test-run-aggregate-data.js•2.47 kB
import dotenv from 'dotenv';
dotenv.config();
/**
* Function to get the aggregate report data for a specified test run (master).
*
* @param {Object} args - Arguments for the request.
* @param {string} args.masterId - The ID of the test run (master) to retrieve the aggregate report data for. (Required)
* @returns {Promise<Object>} - The aggregate report data for the specified test run (master).
*/
const executeFunction = async ({ masterId }) => {
const baseUrl = process.env.BASE_URL; // loaded from .env
const username = process.env.BZM_USERNAME; // loaded from .env
const password = process.env.BZM_PASSWORD; // loaded from .env
try {
// Construct the URL for the aggregate report data
const url = new URL(`${baseUrl}/api/v4/masters/${masterId}/reports/aggregatereport/data`);
// Set up headers for the request
const headers = {
'Authorization': 'Basic ' + Buffer.from(`${username}:${password}`).toString('base64'),
'Accept': 'application/json'
};
// Perform the fetch request
const response = await fetch(url.toString(), {
method: 'GET',
headers
});
// Check if the response was successful
if (!response.ok) {
let errorData;
try {
errorData = await response.json();
} catch (jsonErr) {
errorData = await response.text();
}
throw new Error(`HTTP ${response.status} ${response.statusText}: ${typeof errorData === 'string' ? errorData : JSON.stringify(errorData)}`);
}
// Parse and return the response data
const data = await response.json();
return data;
} catch (error) {
if (error instanceof Error) {
return { error: error.message };
} else {
return { error: 'Unknown error occurred while getting aggregate report data.' };
}
}
};
/**
* Tool configuration for getting the aggregate report data for a test run (master).
* @type {Object}
*/
const apiTool = {
function: executeFunction,
definition: {
type: 'function',
function: {
name: 'get_test_run_aggregate_data',
description: 'Get the aggregate report data for a specified test run (master).',
parameters: {
type: 'object',
properties: {
masterId: {
type: 'string',
description: 'The ID of the test run (master) to retrieve the aggregate report data for.'
}
},
required: ['masterId']
}
}
}
};
export { apiTool };