@testomatio/reporter 2.3.7 → 2.3.8-rc.1

package/types/types.d.ts

@@ -0,0 +1,364 @@
+declare module '@testomatio/reporter' {
+  /**
+   * Stores path to file as artifact and uploads it to the S3 storage
+   * @param data - path to file or object with path, type and name
+   * @param context - optional context parameter
+   */
+  export function artifact(data: string | ArtifactData, context?: any): void;
+
+  /**
+   * Attach log message(s) to the test report
+   * @param args - log messages
+   */
+  export function log(...args: any[]): void;
+
+  /**
+   * Similar to "log" function but marks message in report as a step
+   * @param message - step message
+   */
+  export function step(message: string): void;
+
+  /**
+   * Add key-value pair(s) to the test report
+   * @param keyValue - object { key: value } (multiple props allowed) or key (string)
+   * @param value - optional value when keyValue is a string
+   */
+  export function meta(keyValue: Record<string, string> | string, value?: string | null): void;
+
+  /**
+   * Add a single label to the test report
+   * @param key - label key (e.g. 'severity', 'feature', or just 'smoke' for labels without values)
+   * @param value - optional label value (e.g. 'high', 'login')
+   */
+  export function label(key: string, value?: string | null): void;
+
+  /**
+   * Add link(s) to the test report
+   * @param testIds - test IDs to link
+   */
+  export function linkTest(...testIds: string[]): void;
+
+  /**
+   * Add JIRA issue link(s) to the test report
+   * @param jiraIds - JIRA issue IDs to link
+   */
+  export function linkJira(...jiraIds: string[]): void;
+
+  /**
+   * Logger service for intercepting and managing logs
+   */
+  export const logger: Logger;
+
+  interface ArtifactData {
+    path: string;
+    type: string;
+    name: string;
+  }
+
+  interface Logger {
+    logLevel: string;
+    prettyObjects: boolean;
+
+    /**
+     * Define a step inside a test. Step name is attached to the report
+     * @param strings - template literal strings
+     * @param values - template literal values
+     */
+    step(strings: any, ...values: any[]): void;
+
+    /**
+     * Get logs for a specific context
+     * @param context - testId or test context from test runner
+     */
+    getLogs(context: string): string[];
+
+    /**
+     * Template literal log function
+     * @param strings - template literal strings or message
+     * @param args - arguments
+     */
+    _templateLiteralLog(strings: any, ...args: any[]): void;
+
+    // Console methods
+    assert(...args: any[]): void;
+    debug(...args: any[]): void;
+    error(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    trace(...args: any[]): void;
+    warn(...args: any[]): void;
+
+    /**
+     * Intercept user logger messages
+     * @param userLogger - user's logger instance
+     */
+    intercept(userLogger: any): void;
+
+    /**
+     * Stop logger interception
+     */
+    stopInterception(): void;
+
+    /**
+     * Configure logger settings
+     * @param config - configuration options
+     */
+    configure(config?: LoggerConfig): void;
+  }
+
+  interface LoggerConfig {
+    logLevel?: string;
+    prettyObjects?: boolean;
+  }
+
+  const _default: {
+    /**
+     * @deprecated Use `log` or `testomat.log`
+     */
+    testomatioLogger: Logger;
+    artifact: typeof artifact;
+    log: typeof log;
+    logger: Logger;
+    meta: typeof meta;
+    step: typeof step;
+    label: typeof label;
+    linkTest: typeof linkTest;
+    linkJira: typeof linkJira;
+  };
+
+  export default _default;
+}
+
+export interface FileType {
+  path: string;
+  type: string;
+  title?: string;
+  testId?: string;
+}
+
+/**
+ * Object representing a unit test result that can be sent to a reporting service.
+ */
+export interface TestData {
+  /** Unique ID of test report data to send to multiple times. */
+  rid?: string;
+
+  /** The title of the test case being reported. */
+  title?: string;
+
+  /** The title of the test suite to which the test case belongs. Required when creating a new test suite inside Testomat.io. */
+  suite_title?: string;
+
+  /** file in which test is located */
+  file?: string;
+
+  /** The unique identifier from Testomat.io of the test suite to which the test case belongs. */
+  suite_id?: string;
+
+  /** The unique identifier from Testomat.io of the test case. If provided, updates the existing test case with the given ID. */
+  test_id?: string;
+
+  /** An object representing an error that occurred during the execution of the test case. */
+  error?: Error;
+
+  /** The time it took to execute the test case, in milliseconds. */
+  time?: number;
+
+  /** Timestamp when the test was reported, in microseconds since Unix epoch. */
+  timestamp?: number;
+
+  /** Additional data associated with the test case. Used for parametrized tests. */
+  example?: any;
+
+  /** An array of file paths or objects representing files associated with the test case. */
+  files?: (string | FileType)[];
+
+  /** An array of `Buffer` objects representing files associated with the test case. */
+  filesBuffers?: Buffer[];
+
+  /** The steps taken or logs printed during the execution of the test case. */
+  steps?: Step[] | string;
+
+  /** The stack taken or logs printed during the execution of the test case. */
+  stack?: string;
+
+  tags?: string[];
+
+  /** The current source code of a test. Used only for JUnit or Newman reports, when we create tests from a run */
+  code?: string;
+
+  /** A one-line result message, usually error.message. */
+  message?: string;
+
+  /** Logs catched by logger */
+  logs?: string;
+
+  /** Manually attached artifacts */
+  manuallyAttachedArtifacts?: (string | { path: string; type: string })[];
+
+  /** Meta information (key: value) */
+  meta?: { [key: string]: any } | {};
+
+  /** Links array (e.g. [{test: 'TEST-123'}, {label: 'smoke'}]) */
+  links?: object[];
+
+  /** Whether to overwrite status of this test to avoid saving as retry (defaults to false) */
+  overwrite?: boolean;
+}
+
+/**
+ * Object representing a result of a Run.
+ */
+export interface RunData {
+  /** The status of the test run. */
+  status: RunStatus;
+
+  /** is this run a part of parallel run */
+  parallel: boolean;
+
+  /** mark tests not included in report as detached */
+  detach: boolean;
+
+  /** A boolean indicating whether new test cases should be created in Testomat.io when submitting the test run. */
+  create_tests?: boolean;
+
+  /** The total number of test cases in the test run. Used in JUnit report. */
+  tests_count?: number;
+
+  /** The number of test cases that passed in the test run. Used in JUnit report. */
+  passed_count?: number;
+
+  /** The number of test cases that failed in the test run. Used in JUnit report. */
+  failed_count?: number;
+
+  /** The number of test cases that were skipped in the test run. */
+  skipped_count?: number;
+
+  /** If duration is pre-set value as in XML tests set it */
+  duration?: number;
+
+  /**
+   * An array of `TestData` objects representing the individual test cases in the test run.
+   * Used for JUNit report when we don't send the tests in realtime but in a batch as a part of final result */
+  tests?: TestData[];
+}
+
+export enum TestStatus {
+  Passed = 'passed',
+  Failed = 'failed',
+  Skipped = 'skipped',
+}
+
+export enum RunStatus {
+  Passed = 'passed',
+  Failed = 'failed',
+  Finished = 'finished',
+}
+
+export interface Pipe {
+  isEnabled: boolean;
+  store: {};
+
+  /** starts run  */
+  createRun(): Promise<void>;
+
+  /** adds a test to the current run */
+  addTest(test: TestData): any;
+
+  /** ends the run */
+  finishRun(runParams: RunData): Promise<void>;
+
+  /** name of this pipe */
+  toString(): string;
+}
+
+export interface PipeResult {
+  /** Name of the pipe: Pipe.toString() */
+  pipe: string;
+
+  /** the result that pipe returned */
+  result?: any;
+}
+
+/**
+ * Represents a step in a test.
+ */
+interface Step {
+  category: string;
+  title: string;
+  duration: number;
+  steps?: Step[];
+  error?: any;
+}
+
+declare global {
+  namespace NodeJS {
+    interface Global {
+      testomatioArtifacts?: any;
+      testomatioDataStore?: any;
+      TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED?: boolean;
+      testomatioTestTitle?: string;
+    }
+  }
+}
+
+interface WebdriverIOError {
+  name: string;
+  message: string;
+  stack: string;
+}
+
+interface WebdriverIOBDDTest {
+  type: string;
+  start: string;
+  end: string;
+  _duration: number;
+  uid: string;
+  cid: string;
+  title: string;
+  fullTitle: string;
+  output: string[];
+  retries: number;
+  parent: string;
+  state: string;
+  errors: WebdriverIOError[];
+  error: WebdriverIOError;
+}
+
+interface WebdriverIOHook {
+  type: string;
+  start: string;
+  end: string;
+  _duration: number;
+  uid: string;
+  cid: string;
+  title: string;
+  parent: string;
+  errors: string[];
+}
+
+export interface WebdriverIOScenario {
+  type: string;
+  start: string;
+  end: string;
+  _duration: number;
+  uid: string;
+  cid: string;
+  file: string;
+  title: string;
+  fullTitle: string;
+  tags: { name: string; astNodeId: string }[];
+  tests: WebdriverIOBDDTest[];
+  hooks: WebdriverIOHook[];
+  suites: any[];
+  parent: string;
+  hooksAndTests: (WebdriverIOHook | WebdriverIOBDDTest)[];
+  description: string;
+}
+
+export type {
+  Suite as VitestSuite,
+  Test as VitestTest,
+  File as VitestTestFile,
+  TestLogs as VitestTestLogs,
+} from './vitest.types';

package/types/vitest.types.d.ts

@@ -0,0 +1,93 @@
+type RunMode = 'run' | 'skip' | 'only' | 'todo';
+type TaskState = RunMode | 'pass' | 'fail';
+type Task = Test | Suite | File;
+
+interface File extends Suite {
+  filepath: string;
+  collectDuration?: number;
+  setupDuration?: number;
+}
+
+interface Suite extends TaskBase {
+  type: 'suite';
+  tasks: Task[];
+  filepath?: string;
+  projectName: string;
+}
+
+type ErrorWithDiff = {
+  cause: string;
+  message: string;
+  name: string;
+  nameStr?: string;
+  stack?: string;
+  stackStr?: string;
+  stacks?: {
+    method: string;
+    file: string;
+    line: number;
+    column: number;
+  };
+  showDiff?: boolean;
+  actual?: any;
+  expected?: any;
+  operator?: string;
+  type?: string;
+  frame?: string;
+  diff?: string;
+  codeFrame?: string;
+};
+
+interface TaskResult {
+  state: TaskState;
+  duration?: number;
+  startTime?: number;
+  heap?: number;
+  errors?: ErrorWithDiff[];
+  htmlError?: string;
+  hooks?: Partial<Record<'beforeAll' | 'afterAll' | 'beforeEach' | 'afterEach', TaskState>>;
+  retryCount?: number;
+  repeatCount?: number;
+}
+
+interface TaskBase {
+  id: string;
+  name: string;
+  mode: RunMode;
+  meta: {};
+  each?: boolean;
+  concurrent?: boolean;
+  shuffle?: boolean;
+  suite?: Suite;
+  file?: File;
+  result?: TaskResult;
+  retry?: number;
+  repeats?: number;
+  location?: {
+    line: number;
+    column: number;
+  };
+}
+
+export type TestLogs = {
+  content: string;
+  size: number;
+  taskId: string;
+  time: number;
+  type: 'stdout' | 'stderr';
+};
+
+type FileResult = {
+  duration: number;
+  hooks: {
+    beforeEach: TaskState;
+    afterEach: TaskState;
+  };
+  startTime: number;
+  state: TaskState;
+};
+
+export type Test = TaskBase & {
+  logs: TestLogs[];
+  type: 'test';
+};