add-test-result.ts

import axios from "axios";
import config from "../../config.js";
import { z } from "zod";
import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
import { formatAxiosError } from "../../lib/error.js";
import { DOMAINS } from "../../lib/domains.js";
/**
 * Schema for adding a test result to a test run.
 */
export const AddTestResultSchema = z.object({
  project_identifier: z
    .string()
    .describe("Identifier of the project (Starts with 'PR-')"),
  test_run_id: z.string().describe("Identifier of the test run (e.g., TR-678)"),
  test_result: z.object({
    status: z
      .string()
      .describe("Status of the test result, e.g., 'passed', 'failed'."),
    description: z
      .string()
      .optional()
      .describe("Optional description of the test result."),
  }),
  test_case_id: z
    .string()
    .describe("Identifier of the test case, e.g., 'TC-13'."),
});

export type AddTestResultArgs = z.infer<typeof AddTestResultSchema>;

/**
 * Adds a test result to a specific test run via BrowserStack Test Management API.
 */
export async function addTestResult(
  rawArgs: AddTestResultArgs,
): Promise<CallToolResult> {
  try {
    const args = AddTestResultSchema.parse(rawArgs);
    const url = `${DOMAINS.TEST_MANAGEMENT}/api/v2/projects/${encodeURIComponent(
      args.project_identifier,
    )}/test-runs/${encodeURIComponent(args.test_run_id)}/results`;

    const body = {
      test_result: args.test_result,
      test_case_id: args.test_case_id,
    } as any;

    const response = await axios.post(url, body, {
      auth: {
        username: config.browserstackUsername,
        password: config.browserstackAccessKey,
      },
      headers: { "Content-Type": "application/json" },
    });

    const data = response.data;
    if (!data.success) {
      throw new Error(
        `API returned unsuccessful response: ${JSON.stringify(data)}`,
      );
    }

    return {
      content: [
        {
          type: "text",
          text: `Successfully added test result with ID=${data["test-result"].id}`,
        },
        { type: "text", text: JSON.stringify(data["test-result"], null, 2) },
      ],
    };
  } catch (err: any) {
    return formatAxiosError(err, "Failed to add test result to test run");
  }
}