@azure/microsoft-playwright-testing 1.0.0-alpha.20250318.1 → 1.0.0-alpha.20250320.1

package/dist/commonjs/model/testResult.d.ts

@@ -0,0 +1,40 @@
+import type { RawTestStep } from "../common/types.js";
+export declare class TestResult {
+    testId: string;
+    testExecutionId: string;
+    testCombinationId: string;
+    runId: string;
+    shardId: string;
+    accountId: string;
+    suiteId: string;
+    testTitle: string;
+    suiteTitle: string;
+    fileName: string;
+    lineNumber: number;
+    retry: number;
+    status: string;
+    tags: string[];
+    annotations: string[];
+    webTestConfig: WebTestConfig;
+    resultsSummary: TestResultsSummary;
+    artifactsPath: string[];
+}
+export type WebTestConfig = {
+    jobName: string;
+    projectName: string;
+    browserType?: string;
+    os: string;
+};
+export type TestResultsSummary = {
+    status: string;
+    duration: number;
+    startTime: string;
+    attachmentsMetadata: string;
+};
+export type RawTestResult = {
+    steps?: RawTestStep[];
+    errors?: string;
+    stdErr?: string;
+    stdOut?: string;
+};
+//# sourceMappingURL=testResult.d.ts.map

package/dist/commonjs/model/testResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testResult.d.ts","sourceRoot":"","sources":["../../../src/model/testResult.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD,qBAAa,UAAU;IACrB,MAAM,EAAG,MAAM,CAAC;IAChB,eAAe,EAAG,MAAM,CAAC;IACzB,iBAAiB,EAAG,MAAM,CAAC;IAC3B,KAAK,EAAG,MAAM,CAAC;IACf,OAAO,EAAG,MAAM,CAAC;IACjB,SAAS,EAAG,MAAM,CAAC;IACnB,OAAO,EAAG,MAAM,CAAC;IACjB,SAAS,EAAG,MAAM,CAAC;IACnB,UAAU,EAAG,MAAM,CAAC;IACpB,QAAQ,EAAG,MAAM,CAAC;IAClB,UAAU,EAAG,MAAM,CAAC;IACpB,KAAK,EAAG,MAAM,CAAC;IACf,MAAM,EAAG,MAAM,CAAC;IAChB,IAAI,EAAG,MAAM,EAAE,CAAC;IAChB,WAAW,EAAG,MAAM,EAAE,CAAC;IACvB,aAAa,EAAG,aAAa,CAAC;IAC9B,cAAc,EAAG,kBAAkB,CAAC;IACpC,aAAa,EAAG,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/commonjs/model/testResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testResult.js","sourceRoot":"","sources":["../../../src/model/testResult.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAIlC,MAAa,UAAU;CAmBtB;AAnBD,gCAmBC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RawTestStep } from \"../common/types.js\";\n\nexport class TestResult {\n  testId!: string;\n  testExecutionId!: string;\n  testCombinationId!: string;\n  runId!: string;\n  shardId!: string;\n  accountId!: string;\n  suiteId!: string;\n  testTitle!: string;\n  suiteTitle!: string;\n  fileName!: string;\n  lineNumber!: number;\n  retry!: number;\n  status!: string;\n  tags!: string[];\n  annotations!: string[];\n  webTestConfig!: WebTestConfig;\n  resultsSummary!: TestResultsSummary;\n  artifactsPath!: string[];\n}\n\nexport type WebTestConfig = {\n  jobName: string;\n  projectName: string;\n  browserType?: string;\n  os: string;\n};\n\nexport type TestResultsSummary = {\n  status: string;\n  duration: number;\n  startTime: string;\n  attachmentsMetadata: string;\n};\n\nexport type RawTestResult = {\n  steps?: RawTestStep[];\n  errors?: string;\n  stdErr?: string;\n  stdOut?: string;\n};\n"]}

package/dist/commonjs/model/testRun.d.ts

@@ -0,0 +1,36 @@
+import type { ShardInfo } from "./shard.js";
+export declare class TestRun {
+    testRunId: string;
+    displayName: string;
+    creatorId: string;
+    creatorName?: string;
+    startTime: string;
+    ciConfig?: CIConfig;
+    testRunConfig?: TestRunConfig;
+    cloudReportingEnabled: string;
+}
+export type CIConfig = {
+    ciProviderName: string;
+    branch: string;
+    author: string;
+    commitId: string;
+    revisionUrl: string;
+};
+export type TestRunConfig = {
+    workers: number;
+    pwVersion: string;
+    timeout: number;
+    shards: ShardInfo;
+    retries?: number;
+    repeatEach?: number;
+    testFramework: TestFramework;
+    testType: string;
+    testSdkLanguage: string;
+    reporterPackageVersion: string;
+};
+export type TestFramework = {
+    name: string;
+    version: string;
+    runnerName: string;
+};
+//# sourceMappingURL=testRun.d.ts.map

package/dist/commonjs/model/testRun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testRun.d.ts","sourceRoot":"","sources":["../../../src/model/testRun.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,qBAAa,OAAO;IAClB,SAAS,EAAG,MAAM,CAAC;IACnB,WAAW,EAAG,MAAM,CAAC;IACrB,SAAS,EAAG,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAG,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAU;CACxC;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,sBAAsB,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/commonjs/model/testRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testRun.js","sourceRoot":"","sources":["../../../src/model/testRun.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAIlC,MAAa,OAAO;IAApB;QAQE,0BAAqB,GAAW,MAAM,CAAC,CAAC,8BAA8B;IACxE,CAAC;CAAA;AATD,0BASC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ShardInfo } from \"./shard.js\";\n\nexport class TestRun {\n  testRunId!: string;\n  displayName!: string;\n  creatorId!: string;\n  creatorName?: string;\n  startTime!: string;\n  ciConfig?: CIConfig;\n  testRunConfig?: TestRunConfig;\n  cloudReportingEnabled: string = \"true\"; // Default value set to 'true'\n}\n\nexport type CIConfig = {\n  ciProviderName: string;\n  branch: string;\n  author: string;\n  commitId: string;\n  revisionUrl: string;\n};\n\nexport type TestRunConfig = {\n  workers: number;\n  pwVersion: string;\n  timeout: number;\n  shards: ShardInfo;\n  retries?: number;\n  repeatEach?: number;\n  testFramework: TestFramework;\n  testType: string;\n  testSdkLanguage: string;\n  reporterPackageVersion: string;\n};\n\nexport type TestFramework = {\n  name: string;\n  version: string;\n  runnerName: string;\n};\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/reporter/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Microsoft Playwright Testing's Reporting
+ * feature to publish test results and related artifacts and
+ * view them in the service portal for faster and easier troubleshooting.
+ *
+ * @packageDocumentation
+ */
+import MPTReporter from "./mptReporter.js";
+export default MPTReporter;
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/reporter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/reporter/index.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AAEH,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAE3C,eAAe,WAAW,CAAC"}

package/dist/{reporter → commonjs/reporter}/index.js

@@ -10,6 +10,6 @@ const tslib_1 = require("tslib");
  *
  * @packageDocumentation
  */
-const mptReporter_1 = tslib_1.__importDefault(require("./mptReporter"));
-exports.default = mptReporter_1.default;
+const mptReporter_js_1 = tslib_1.__importDefault(require("./mptReporter.js"));
+exports.default = mptReporter_js_1.default;
 //# sourceMappingURL=index.js.map

package/dist/commonjs/reporter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/reporter/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC;;;;;;GAMG;AAEH,8EAA2C;AAE3C,kBAAe,wBAAW,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Microsoft Playwright Testing's Reporting\n * feature to publish test results and related artifacts and\n * view them in the service portal for faster and easier troubleshooting.\n *\n * @packageDocumentation\n */\n\nimport MPTReporter from \"./mptReporter.js\";\n\nexport default MPTReporter;\n"]}

package/{types/reporter/microsoft-playwright-testing.d.ts → dist/commonjs/reporter/mptReporter.d.ts}

@@ -1,150 +1,100 @@
-/**
- * Microsoft Playwright Testing's Reporting
- * feature to publish test results and related artifacts and
- * view them in the service portal for faster and easier troubleshooting.
- *
- * @packageDocumentation
- */
-
-import type { FullConfig } from '@playwright/test/reporter';
-import type { FullResult } from '@playwright/test/reporter';
-import type { Reporter } from '@playwright/test/reporter';
-import type { Suite } from '@playwright/test/reporter';
-import type { TestCase } from '@playwright/test/reporter';
-import type { TestResult } from '@playwright/test/reporter';
-
-/**
- * @public
- *
- * Extends Playwright's Reporter class to enable Microsoft Playwright Testing's Reporting
- * feature to publish test results and related artifacts and
- * view them in the service portal for faster and easier troubleshooting.
- *
- * @example
- *
- * ```
- * import { defineConfig } from "@playwright/test";
- *
- * export default defineConfig({
- *  reporter: [["@azure/microsoft-playwright-testing/reporter"]]
- * });
- * ```
- */
-declare class MPTReporter implements Reporter {
-    private isTokenValid;
-    private enableGitHubSummary;
-    private isRegionValid;
-    private shard;
-    private isTestRunStartSuccess;
-    private ciInfo;
-    private serviceClient;
-    private storageClient;
-    private reporterUtils;
-    private envVariables;
-    private testRawResults;
-    private promiseOnBegin;
-    private _testEndPromises;
-    private testResultBatch;
-    private errorMessages;
-    private informationalMessages;
-    private processedErrorMessageKeys;
-    private sasUri;
-    private uploadMetadata;
-    private numWorkers;
-    private testRunUrl;
-    private enableResultPublish;
-    constructor(config: Partial<ReporterConfiguration>);
-    private _addError;
-    private _addInformationalMessage;
-    private _addKeyToInformationMessage;
-    private _isInformationMessagePresent;
-    private _reporterFailureHandler;
-    /**
-     * @public
-     *
-     * Called once before running tests.
-     *
-     * @param config - Resolved configuration.
-     * @param suite - The root suite that contains all projects, files and test cases.
-     */
-    onBegin(config: FullConfig, suite: Suite): void;
-    /**
-     * @public
-     *
-     * Called after a test has been finished in the worker process.
-     *
-     * @param test - Test that has been finished.
-     * @param result - Result of the test run.
-     */
-    onTestEnd(test: TestCase, result: TestResult): void;
-    /**
-     * @public
-     *
-     * Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise]
-     * and Playwright Test will await it. Reporter is allowed to override the status and hence affect the exit code of the
-     * test runner.
-     *
-     * @param result - Result of the full test run, `status` can be one of:
-     * - `'passed'` - Everything went as expected.
-     * - `'failed'` - Any test has failed.
-     * - `'timedout'` - The
-     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-timeout | testConfig.globalTimeout} has
-     * been reached.
-     * - `'interrupted'` - Interrupted by the user.
-     */
-    onEnd(result: FullResult): Promise<void>;
-    private _onBegin;
-    private _onTestEnd;
-    private _onEnd;
-    private renewSasUriIfNeeded;
-    private _uploadTestResultAttachments;
-    private initializeMPTReporter;
-    private displayAdditionalInformation;
-    private processTestResult;
-    /**
-     * @public
-     *
-     * Whether this reporter uses stdio for reporting. When it does not, Playwright Test could add some output to enhance
-     * user experience. If your reporter does not print to the terminal, it is strongly recommended to return `false`.
-     */
-    printsToStdio(): boolean;
-}
-export default MPTReporter;
-
-/**
- * @public
- *
- * Optional configuration for MPT Reporter.
- *
- * @example
- *
- * ```
- * import { defineConfig } from "@playwright/test";
- *
- * export default defineConfig({
- *  reporter: [["@azure/microsoft-playwright-testing/reporter", {
- *   enableGitHubSummary: true
- *  }]],
- * });
- * ```
- */
-declare type ReporterConfiguration = {
-    /**
-     * @public
-     *
-     * Enable GitHub Actions annotations to diagnose test failures and deep link to MPT Portal.
-     *
-     * @defaultValue `true`
-     */
-    enableGitHubSummary?: boolean;
-    /**
-     * @public
-     *
-     * Enable result publishing for the test run. This will upload the test result and artifacts to the MPT Portal.
-     *
-     * @defaultValue `true`
-     */
-    enableResultPublish?: boolean;
-};
-
-export { }
+import type { FullResult, TestCase, TestResult, FullConfig, Reporter, Suite } from "@playwright/test/reporter";
+import type { ReporterConfiguration } from "../common/types.js";
+/**
+ * @public
+ *
+ * Extends Playwright's Reporter class to enable Microsoft Playwright Testing's Reporting
+ * feature to publish test results and related artifacts and
+ * view them in the service portal for faster and easier troubleshooting.
+ *
+ * @example
+ *
+ * ```
+ * import { defineConfig } from "@playwright/test";
+ *
+ * export default defineConfig({
+ *  reporter: [["@azure/microsoft-playwright-testing/reporter"]]
+ * });
+ * ```
+ */
+declare class MPTReporter implements Reporter {
+    private isTokenValid;
+    private enableGitHubSummary;
+    private isRegionValid;
+    private shard;
+    private isTestRunStartSuccess;
+    private ciInfo;
+    private serviceClient;
+    private storageClient;
+    private reporterUtils;
+    private envVariables;
+    private testRawResults;
+    private promiseOnBegin;
+    private _testEndPromises;
+    private testResultBatch;
+    private errorMessages;
+    private informationalMessages;
+    private processedErrorMessageKeys;
+    private sasUri;
+    private uploadMetadata;
+    private numWorkers;
+    private testRunUrl;
+    private enableResultPublish;
+    constructor(config: Partial<ReporterConfiguration>);
+    private _addError;
+    private _addInformationalMessage;
+    private _addKeyToInformationMessage;
+    private _isInformationMessagePresent;
+    private _reporterFailureHandler;
+    /**
+     * @public
+     *
+     * Called once before running tests.
+     *
+     * @param config - Resolved configuration.
+     * @param suite - The root suite that contains all projects, files and test cases.
+     */
+    onBegin(config: FullConfig, suite: Suite): void;
+    /**
+     * @public
+     *
+     * Called after a test has been finished in the worker process.
+     *
+     * @param test - Test that has been finished.
+     * @param result - Result of the test run.
+     */
+    onTestEnd(test: TestCase, result: TestResult): void;
+    /**
+     * @public
+     *
+     * Called after all tests have been run, or testing has been interrupted. Note that this method may return a [Promise]
+     * and Playwright Test will await it. Reporter is allowed to override the status and hence affect the exit code of the
+     * test runner.
+     *
+     * @param result - Result of the full test run, `status` can be one of:
+     * - `'passed'` - Everything went as expected.
+     * - `'failed'` - Any test has failed.
+     * - `'timedout'` - The
+     * {@link https://playwright.dev/docs/api/class-testconfig#test-config-global-timeout | testConfig.globalTimeout} has
+     * been reached.
+     * - `'interrupted'` - Interrupted by the user.
+     */
+    onEnd(result: FullResult): Promise<void>;
+    private _onBegin;
+    private _onTestEnd;
+    private _onEnd;
+    private renewSasUriIfNeeded;
+    private _uploadTestResultAttachments;
+    private initializeMPTReporter;
+    private displayAdditionalInformation;
+    private processTestResult;
+    /**
+     * @public
+     *
+     * Whether this reporter uses stdio for reporting. When it does not, Playwright Test could add some output to enhance
+     * user experience. If your reporter does not print to the terminal, it is strongly recommended to return `false`.
+     */
+    printsToStdio(): boolean;
+}
+export default MPTReporter;
+//# sourceMappingURL=mptReporter.d.ts.map

package/dist/commonjs/reporter/mptReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mptReporter.d.ts","sourceRoot":"","sources":["../../../src/reporter/mptReporter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACN,MAAM,2BAA2B,CAAC;AAqBnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAIhE;;;;;;;;;;;;;;;;GAgBG;AACH,cAAM,WAAY,YAAW,QAAQ;IACnC,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,mBAAmB,CAAQ;IACnC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,qBAAqB,CAAkB;IAC/C,OAAO,CAAC,MAAM,CAAsC;IACpD,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,YAAY,CAAwB;IAC5C,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,qBAAqB,CAAgB;IAC7C,OAAO,CAAC,yBAAyB,CAAgB;IACjD,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,cAAc,CAIpB;IACF,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,mBAAmB,CAAiB;gBAEhC,MAAM,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAQlD,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,wBAAwB,CAE9B;IAEF,OAAO,CAAC,2BAA2B,CAEjC;IAEF,OAAO,CAAC,4BAA4B,CAElC;IACF,OAAO,CAAC,uBAAuB,CAM7B;IACF;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAgB/C;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IAsBnD;;;;;;;;;;;;;;OAcG;IACG,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;YA4ChC,QAAQ;YAgCR,UAAU;YA6CV,MAAM;IAkBpB,OAAO,CAAC,mBAAmB,CAUzB;YACY,4BAA4B;IA0C1C,OAAO,CAAC,qBAAqB;IAwD7B,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,iBAAiB;IAsBzB;;;;;OAKG;IACH,aAAa,IAAI,OAAO;CAGzB;AACD,eAAe,WAAW,CAAC"}