@azure/microsoft-playwright-testing package

介面

MPTReporterConfig

MPT 記者的選擇性設定。

範例

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

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

類型別名

AuthenticationType

Microsoft Playwright Testing 支援的驗證類型。
BrowserConnectOptions

服務的瀏覽器連線選項。 這包括端點選項和連線選項。

範例

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

線上服務的選項。
EndpointOptions

服務的端點選項。
OsType

Microsoft Playwright Testing 支援的 OS 類型。
PlaywrightServiceAdditionalOptions

服務的其他選項。

函式

getConnectOptions(Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">)

取得連線到 Microsoft Playwright Testing 雲端託管瀏覽器所需的連線選項。

範例

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)

產生與Microsoft劇作家測試整合的劇作家組態。

範例

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

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

範例

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
}));

變數

ServiceAuth

Microsoft Playwright 測試支援的認證類型
ServiceEnvironmentVariable

Microsoft Playwright 測試所使用的環境變數
ServiceOS

Microsoft Playwright 支援的作業系統類型測試雲端託管瀏覽器

函式詳細資料

getConnectOptions(Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">)

取得連線到 Microsoft Playwright Testing 雲端託管瀏覽器所需的連線選項。

範例

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>

參數

options

Omit<PlaywrightServiceAdditionalOptions, "serviceAuthType">

服務的其他選項

傳回

Promise<BrowserConnectOptions>

BrowserConnectOptions

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

產生與Microsoft劇作家測試整合的劇作家組態。

範例

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

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

範例

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<{}, {}>

參數

config

PlaywrightTestConfig<{}, {}>

基本劇作家設定

options
PlaywrightServiceAdditionalOptions

服務的其他選項

傳回

PlaywrightTestConfig<{}, {}>

PlaywrightConfig

Variable Details

ServiceAuth

Microsoft Playwright 測試支援的認證類型

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

類型

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

ServiceEnvironmentVariable

Microsoft Playwright 測試所使用的環境變數

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 }

類型

{ 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

Microsoft Playwright 支援的作業系統類型測試雲端託管瀏覽器

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

類型

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