@azure/microsoft-playwright-testing package

Schnittstellen

MPTReporterConfig

Optionale Konfiguration für MPT Reporter.

Beispiel

import { defineConfig } from "@playwright/test";

export default defineConfig({
 reporter: [["@azure/microsoft-playwright-testing/reporter", {
  enableGitHubSummary: true
 }]],
});

Typaliase

AuthenticationType

Von Microsoft Playwright Testing unterstützte Authentifizierungstypen.
BrowserConnectOptions

Browserverbindungsoptionen für den Dienst. Dazu gehören Endpunktoptionen und Verbindungsoptionen.

Beispiel

import playwright, { test, expect, BrowserType } from "@playwright/test";
import { getConnectOptions, BrowserConnectOptions } from "@azure/microsoft-playwright-testing";

test("has title", async ({ browserName }) => {
 const { wsEndpoint, options } : BrowserConnectOptions = await getConnectOptions();
 const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
 const context = await browser.newContext();
 const page = await context.newPage();

 await page.goto("https://playwright.dev/");
 await expect(page).toHaveTitle(/Playwright/);

 await page.close();
 await context.close();
 await browser.close();
});
ConnectOptions

Verbinden von Optionen für den Dienst.
EndpointOptions

Endpunktoptionen für den Dienst.
OsType

Betriebssystemtypen, die von Microsoft Playwright-Tests unterstützt werden.
PlaywrightServiceAdditionalOptions

Zusätzliche Optionen für den Dienst.

Functions

getConnectOptions(Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">)

Abrufen von Verbindungsoptionen, die zum Herstellen einer Verbindung mit den in der Cloud gehosteten Browsern von Microsoft Playwright Testing erforderlich sind.

Beispiel

import playwright, { test, expect, BrowserType } from "@playwright/test";
import { getConnectOptions } from "@azure/microsoft-playwright-testing";

test('has title', async ({ browserName }) => {
 const { wsEndpoint, options } = await getConnectOptions();
 const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
 const context = await browser.newContext();
 const page = await context.newPage();

 await page.goto('https://playwright.dev/');
 await expect(page).toHaveTitle(/Playwright/);

 await page.close();
 await context.close();
 await browser.close();
});
getServiceConfig(PlaywrightTestConfig<{}, {}>, PlaywrightServiceAdditionalOptions)

Generieren Sie playwright-Konfiguration, die in Microsoft Playwright-Tests integriert ist.

Beispiel

import { defineConfig } from "playwright/test";
import { getServiceConfig } from "@azure/microsoft-playwright-testing";
import playwrightConfig from "./playwright.config";

export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));

Beispiel

import { defineConfig } from "playwright/test";
import { getServiceConfig, ServiceOS } from "@azure/microsoft-playwright-testing";
import playwrightConfig from "./playwright.config";

export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {
 runId: "custom run id",
 os: ServiceOS.WINDOWS
}));

Variablen

ServiceAuth

Authentifizierungstypen, die bei Microsoft Playwright Testing unterstützt werden
ServiceEnvironmentVariable

Umgebungsvariablen, die von Microsoft Playwright Testing verwendet werden
ServiceOS

Betriebssystemtypen, die auf Microsoft Playwright Testing cloud-gehosteten Browsern unterstützt werden

Details zur Funktion

getConnectOptions(Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">)

Abrufen von Verbindungsoptionen, die zum Herstellen einer Verbindung mit den in der Cloud gehosteten Browsern von Microsoft Playwright Testing erforderlich sind.

Beispiel

import playwright, { test, expect, BrowserType } from "@playwright/test";
import { getConnectOptions } from "@azure/microsoft-playwright-testing";

test('has title', async ({ browserName }) => {
 const { wsEndpoint, options } = await getConnectOptions();
 const browser = await (playwright[browserName] as BrowserType).connect(wsEndpoint, options);
 const context = await browser.newContext();
 const page = await context.newPage();

 await page.goto('https://playwright.dev/');
 await expect(page).toHaveTitle(/Playwright/);

 await page.close();
 await context.close();
 await browser.close();
});

function getConnectOptions(options?: Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">): Promise<BrowserConnectOptions>

Parameter

options

Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">

zusätzliche Optionen für den Dienst

Gibt zurück

Promise<BrowserConnectOptions>

BrowserConnectOptions

getServiceConfig(PlaywrightTestConfig<{}, {}>, PlaywrightServiceAdditionalOptions)

Generieren Sie playwright-Konfiguration, die in Microsoft Playwright-Tests integriert ist.

Beispiel

import { defineConfig } from "playwright/test";
import { getServiceConfig } from "@azure/microsoft-playwright-testing";
import playwrightConfig from "./playwright.config";

export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig));

Beispiel

import { defineConfig } from "playwright/test";
import { getServiceConfig, ServiceOS } from "@azure/microsoft-playwright-testing";
import playwrightConfig from "./playwright.config";

export default defineConfig(playwrightConfig, getServiceConfig(playwrightConfig, {
 runId: "custom run id",
 os: ServiceOS.WINDOWS
}));

function getServiceConfig(config: PlaywrightTestConfig<{}, {}>, options?: PlaywrightServiceAdditionalOptions): PlaywrightTestConfig<{}, {}>

Parameter

config

PlaywrightTestConfig<{}, {}>

Grundlegende Playwright-Konfiguration

options
PlaywrightServiceAdditionalOptions

zusätzliche Optionen für den Dienst

Gibt zurück

PlaywrightTestConfig<{}, {}>

PlaywrightConfig

Variable Details

ServiceAuth

Authentifizierungstypen, die bei Microsoft Playwright Testing unterstützt werden

ServiceAuth: { ACCESS_TOKEN: "ACCESS_TOKEN", ENTRA_ID: "ENTRA_ID" }

Typ

{ ACCESS_TOKEN: "ACCESS_TOKEN", ENTRA_ID: "ENTRA_ID" }

ServiceEnvironmentVariable

Umgebungsvariablen, die von Microsoft Playwright Testing verwendet werden

ServiceEnvironmentVariable: { PLAYWRIGHT_SERVICE_ACCESS_TOKEN: string, PLAYWRIGHT_SERVICE_EXPOSE_NETWORK_ENVIRONMENT_VARIABLE: string, PLAYWRIGHT_SERVICE_OS: string, PLAYWRIGHT_SERVICE_REPORTING_URL: string, PLAYWRIGHT_SERVICE_URL: string }

Typ

{ PLAYWRIGHT_SERVICE_ACCESS_TOKEN: string, PLAYWRIGHT_SERVICE_EXPOSE_NETWORK_ENVIRONMENT_VARIABLE: string, PLAYWRIGHT_SERVICE_OS: string, PLAYWRIGHT_SERVICE_REPORTING_URL: string, PLAYWRIGHT_SERVICE_URL: string }

ServiceOS

Betriebssystemtypen, die auf Microsoft Playwright Testing cloud-gehosteten Browsern unterstützt werden

ServiceOS: { LINUX: "linux", WINDOWS: "windows" }

Typ

{ LINUX: "linux", WINDOWS: "windows" }