Použití možností dostupných v balíčku služby s testováním Microsoft Playwright Ve verzi Preview

Článek
11/19/2024

V tomto článku se dozvíte, jak používat možnosti dostupné v playwright.service.config.ts souboru, který jste vygenerovali. Pokud tento soubor ve svém kódu nemáte, postupujte podle rychlého startu: Spuštění komplexních testů ve velkém měřítku pomocí microsoft Playwright Testing Preview

V tomto článku se dozvíte, jak používat možnosti dostupné v .runsettings souboru. Pokud tento soubor ve svém kódu nemáte, postupujte podle rychlého startu: Spuštění komplexních testů ve velkém měřítku pomocí microsoft Playwright Testing Preview

Důležité

Microsoft Playwright Testing je aktuálně ve verzi Preview. Právní podmínky, které se vztahují na funkce Azure, které jsou ve verzi beta, ve verzi Preview nebo které ještě nejsou vydány v obecné dostupnosti, najdete v dodatečných podmínkách použití pro verze Microsoft Azure Preview.

Požadavky

Postupujte podle pokynů k rychlému startu a nastavte projekt pro spuštění se službou Microsoft Playwright Testing. Viz rychlý start: Spuštění komplexních testů ve velkém měřítku pomocí microsoft Playwright Testing Preview

Tady je verze playwright.service.config.ts souboru se všemi dostupnými možnostmi:

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

export default defineConfig(
  config,
  getServiceConfig(config, {
    serviceAuthType:'ACCESS_TOKEN' // Use this option when you want to authenticate using access tokens. This mode of auth should be enabled for the workspace.
    os: ServiceOS.WINDOWS, // Select the operating system where you want to run tests.
    runId: new Date().toISOString(), // Set a unique ID for every test run to distinguish them in the service portal.
    credential: new AzureCliCredential(), // Select the authentication method you want to use with Entra.
    useCloudHostedBrowsers: true, // Select if you want to use cloud-hosted browsers to run your Playwright tests.
    exposeNetwork: '<loopback>', // Use this option to connect to local resources from your Playwright test code without having to configure additional firewall settings.
    timeout: 30000 // Set the timeout for your tests.
  }),
  {
    reporter: [
      ["list"],
      [
        "@azure/microsoft-playwright-testing/reporter",
        {
          enableGitHubSummary: true, // Enable/disable GitHub summary in GitHub Actions workflow.
        },
      ],
    ],
  },
);

Nastavení v `playwright.service.config.ts` souboru

serviceAuthType:
- Popis: Toto nastavení umožňuje zvolit metodu ověřování, kterou chcete použít pro testovací běh.
- Dostupné možnosti:
  - ACCESS_TOKEN pro použití přístupových tokenů. Pokud chcete použít tuto možnost, musíte povolit ověřování pomocí přístupových tokenů, viz správa ověřování.
  - ENTRA_ID k ověřování použijte ID Microsoft Entra. Jedná se o výchozí režim.
- Výchozí hodnota: ENTRA_ID
- Příklad:
```
serviceAuthType:'ENTRA_ID'
```
os:
- Popis: Toto nastavení umožňuje zvolit operační systém, ve kterém jsou hostované prohlížeče s testy Playwright.
- Dostupné možnosti:
  - ServiceOS.WINDOWS pro operační systém Windows.
  - ServiceOS.LINUX pro operační systém Linux.
- Výchozí hodnota: ServiceOS.LINUX
- Příklad:
```
os: ServiceOS.WINDOWS
```
runId:
- Popis: Toto nastavení umožňuje nastavit jedinečné ID pro každé testovací spuštění, aby se odlišily na portálu služby. Použití stejného id spuštění pro více testovacích běhů způsobí chybu. V případě horizontálního dělení ponechte toto stejné napříč všemi horizontálními oddíly.
- Příklad:
```
runId: new Date().toISOString()
```
credential:
- Popis: Toto nastavení umožňuje vybrat metodu ověřování, kterou chcete použít s ID Microsoft Entra.
- Příklad:
```
credential: new AzureCliCredential()
```
useCloudHostedBrowsers
- Popis: Toto nastavení umožňuje zvolit, jestli chcete ke spuštění testů Playwright použít prohlížeče hostované v cloudu nebo prohlížeče na klientském počítači. Pokud tuto možnost zakážete, testy se spustí v prohlížečích vašeho klientského počítače místo prohlížečů hostovaných v cloudu a neúčtují se vám žádné poplatky.
- Výchozí hodnota: true
- Příklad:
```
useCloudHostedBrowsers: true
```
exposeNetwork
- Popis: Toto nastavení umožňuje připojit se k místním prostředkům z testovacího kódu Playwright, aniž byste museli konfigurovat další nastavení brány firewall. Další informace najdete v tématu o testování místních aplikací.
- Příklad:
```
exposeNetwork: '<loopback>'
```
timeout
- Popis: Toto nastavení umožňuje nastavit časový limit pro testy, které se připojují k prohlížečům hostovaným v cloudu.
- Příklad:
```
timeout: 30000,
```
reporter
- Popis: Soubor playwright.service.config.ts rozšiřuje konfigurační soubor playwright vašeho nastavení. Tato možnost přepíše stávající reportéry a nastaví microsoft Playwright Testing reporter. Tento seznam můžete přidat nebo upravit tak, aby zahrnoval reportéry, které chcete použít. Pokud přidáte @azure/microsoft-playwright-testing/reportersestavu microsoft Playwright Testing, bude se vám účtovat vyúčtování microsoft Playwright Testing .
- Výchozí hodnota: ["@azure/microsoft-playwright-testing/reporter"]
- Příklad:
```
reporter: [
["list"],
["@azure/microsoft-playwright-testing/reporter"],
```
enableGitHubSummary:
- Popis: Toto nastavení umožňuje nakonfigurovat zpravodaje služby Microsoft Playwright Testing. Při spuštění v GitHub Actions můžete zvolit, jestli se má souhrn testovacího spuštění zahrnout do souhrnu GitHubu.
- Výchozí hodnota: true
- Příklad:
```
  reporter: [
    ["list"],
    [
      "@azure/microsoft-playwright-testing/reporter",
      {
        enableGitHubSummary: true,
      },
    ],
  ]
```

Tady je verze .runsettings souboru se všemi dostupnými možnostmi:

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
    <TestRunParameters>
        <!-- Use this option when you want to authenticate using access tokens. This mode of auth should be enabled for the workspace. -->
         <Parameter name="ServiceAuthType" value="EntraId" />
        <!-- Select the operating system where you want to run tests. -->
        <Parameter name="Os" value="linux" />
        <!-- Set a unique ID for every test run to distinguish them in the service portal.-->
        <Parameter name="RunId" value="sample-run-id1" />
        <!--Select if you want to use cloud-hosted browsers to run your Playwright tests.-->
        <Parameter name="UseCloudHostedBrowsers" value="true" />
        <!--Use this option to connect to local resources from your Playwright test code without having to configure additional firewall-->
        <Parameter name="ExposeNetwork" value="loopback" />
        <!--Select the authentication method you want to use with Entra-->
        <Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />
        <!--Enable/disable GitHub summary in GitHub Actions workflow.-->
        <Parameter name="EnableGitHubSummary" value="false" />
    </TestRunParameters>
  <!-- NUnit adapter -->  
  <NUnit>
    <!-- Adjust parallel workers, parallel worker would also be bound by number of unit test files -->
    <NumberOfTestWorkers>10</NumberOfTestWorkers>
  </NUnit>
  <!-- General run configuration -->
  <RunConfiguration>
    <EnvironmentVariables>
      <!-- For debugging selectors, it's recommend to set the following environment variable -->
      <DEBUG>pw:api</DEBUG>
    </EnvironmentVariables>
  </RunConfiguration>
  <!-- Playwright -->  
  <Playwright>
    <BrowserName>chromium</BrowserName>
    <!--Set the timeout for your tests.-->
    <ExpectTimeout>5000</ExpectTimeout>
    <LaunchOptions>
      <Headless>false</Headless>
      <!--Channel>msedge</Channel-->
    </LaunchOptions>
  </Playwright>
    <LoggerRunSettings>
        <Loggers>
            <!--microsoft playwright testing service logger for reporting -->
            <Logger friendlyName="microsoft-playwright-testing" enabled="true" />
            <!--could enable any logger additionally -->
            <Logger friendlyName="trx" enabled="false" />
        </Loggers>
    </LoggerRunSettings>
</RunSettings>

Možnosti konfigurace v `.runsettings` souboru

serviceAuthType:
- Popis: Toto nastavení umožňuje zvolit metodu ověřování, kterou chcete použít pro testovací běh.
- Dostupné možnosti:
  - AccessToken pro použití přístupových tokenů. Pokud chcete použít tuto možnost, musíte povolit ověřování pomocí přístupových tokenů, viz správa ověřování.
  - EntraId k ověřování použijte ID Microsoft Entra. Jedná se o výchozí režim.
- Výchozí hodnota: EntraId
- Příklad:
```
<Parameter name="ServiceAuthType" value="EntraId" />
```
os:
- Popis: Toto nastavení umožňuje zvolit operační systém, ve kterém jsou hostované prohlížeče s testy Playwright.
- Dostupné možnosti:
  - "windows" pro operační systém Windows.
  - Linux pro operační systém Linux.
- Výchozí hodnota: "linux"
- Příklad:
```
<Parameter name="Os" value="linux" />
```
RunId:
- Popis: Toto nastavení umožňuje nastavit jedinečné ID pro každé testovací spuštění, aby se odlišily na portálu služby. Použití stejného id spuštění pro více testovacích běhů způsobí chybu. Pokud ho nenastavíte, balíček služby vygeneruje jedinečné ID při každém spuštění testu. V případě horizontálního dělení ponechte toto stejné napříč všemi horizontálními oddíly.
- Příklad:
```
<Parameter name="RunId" value="sample-run-id1" />
```
AzureTokenCredentialType:
- Popis: Toto nastavení umožňuje vybrat metodu ověřování, kterou chcete použít s ID Microsoft Entra.
- Příklad:
```
<Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />
```
UseCloudHostedBrowsers
- Popis: Toto nastavení umožňuje zvolit, jestli chcete ke spuštění testů Playwright použít prohlížeče hostované v cloudu nebo prohlížeče na klientském počítači. Pokud tuto možnost zakážete, testy se spustí v prohlížečích vašeho klientského počítače místo prohlížečů hostovaných v cloudu a neúčtují se vám žádné poplatky.
- Výchozí hodnota: true
- Příklad:
```
<Parameter name="UseCloudHostedBrowsers" value="true" />
```
ExposeNetwork
- Popis: Toto nastavení umožňuje připojit se k místním prostředkům z testovacího kódu Playwright, aniž byste museli konfigurovat další nastavení brány firewall. Další informace najdete v tématu o testování místních aplikací.
- Příklad:
```
<Parameter name="ExposeNetwork" value="loopback" />
```
reporter
- Popis: Výsledky testu a artefakty můžete publikovat do služby pomocí microsoft-playwright-testing loggeru. Vytváření sestav můžete zakázat tak, že ho odeberete ze svého počítače nebo nastavíte .runsettings na false.
- Výchozí hodnota: true
- Příklad:
```
<Logger friendlyName="microsoft-playwright-testing" enabled="true" />
```
EnableGitHubSummary:
- Popis: Toto nastavení umožňuje nakonfigurovat zpravodaje služby Microsoft Playwright Testing. Při spuštění v GitHub Actions můžete zvolit, jestli se má souhrn testovacího spuštění zahrnout do souhrnu GitHubu.
- Výchozí hodnota: true
- Příklad:
```
  <Parameter name="EnableGitHubSummary" value="false" />
```

Sdílet prostřednictvím

Použití možností dostupných v balíčku služby s testováním Microsoft Playwright Ve verzi Preview

Požadavky

Nastavení v `playwright.service.config.ts` souboru

Možnosti konfigurace v `.runsettings` souboru

Váš názor

Další materiály

Sdílet prostřednictvím

Použití možností dostupných v balíčku služby s testováním Microsoft Playwright Ve verzi Preview

Požadavky

Nastavení v playwright.service.config.ts souboru

Možnosti konfigurace v .runsettings souboru

Váš názor

Další materiály

Nastavení v `playwright.service.config.ts` souboru

Možnosti konfigurace v `.runsettings` souboru