Dela via

Använd tillgängliga alternativ i tjänstpaketet med förhandsversionen av Microsoft Playwright Testing

  • Artikel

Den här artikeln visar hur du använder de tillgängliga alternativen i playwright.service.config.ts filen som genererades åt dig. Om du inte har den här filen i koden följer du Snabbstart: Kör tester från slutpunkt till slutpunkt i stor skala med Microsoft Playwright Testing Preview

Den här artikeln visar hur du använder de tillgängliga alternativen i .runsettings filen. Om du inte har den här filen i koden följer du Snabbstart: Kör tester från slutpunkt till slutpunkt i stor skala med Microsoft Playwright Testing Preview

Viktigt!

Microsoft Playwright Testing är för närvarande i förhandsversion. Juridiska villkor som gäller för Azure-funktioner som är i betaversion, förhandsversion eller som ännu inte har släppts i allmän tillgänglighet finns i Kompletterande användningsvillkor för Förhandsversioner av Microsoft Azure.

Förutsättningar

Här är en version av playwright.service.config.ts filen med alla tillgängliga alternativ:

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.
        },
      ],
    ],
  },
);

Inställningar i playwright.service.config.ts filen

  • serviceAuthType:

    • Beskrivning: Med den här inställningen kan du välja den autentiseringsmetod som du vill använda för testkörningen.
    • Tillgängliga alternativ:
      • ACCESS_TOKEN för att använda åtkomsttoken. Du måste aktivera autentisering med hjälp av åtkomsttoken om du vill använda det här alternativet. Mer information finns i Hantera autentisering.
      • ENTRA_ID för att använda Microsoft Entra-ID för autentisering. Det är standardläget.
    • Standardvärde: ENTRA_ID
    • Exempel: 
      serviceAuthType:'ENTRA_ID'

  • os:

    • Beskrivning: Med den här inställningen kan du välja det operativsystem där webbläsarna som kör Playwright-tester finns.
    • Tillgängliga alternativ:
      • ServiceOS.WINDOWS för Windows OS.
      • ServiceOS.LINUX för Linux OS.
    • Standardvärde: ServiceOS.LINUX
    • Exempel: 
      os: ServiceOS.WINDOWS

  • runId:

    • Beskrivning: Med den här inställningen kan du ange ett unikt ID för varje testkörning för att särskilja dem i tjänstportalen. Om du använder samma runId för flera testkörningar resulterar det i fel. För horisontell partitionering behåller du samma sak för alla shards.
    • Exempel: 
      runId: new Date().toISOString()

  • credential:

    • Beskrivning: Med den här inställningen kan du välja den autentiseringsmetod som du vill använda med Microsoft Entra-ID.
    • Exempel: 
      credential: new AzureCliCredential()

  • useCloudHostedBrowsers

    • Beskrivning: Med den här inställningen kan du välja om du vill använda molnbaserade webbläsare eller webbläsare på klientdatorn för att köra dina Playwright-tester. Om du inaktiverar det här alternativet körs dina tester i webbläsaren på klientdatorn i stället för molnbaserade webbläsare, och du debiteras inga avgifter.
    • Standardvärde: true
    • Exempel: 
      useCloudHostedBrowsers: true

  • exposeNetwork

    • Beskrivning: Med den här inställningen kan du ansluta till lokala resurser från din Playwright-testkod utan att behöva konfigurera några andra brandväggsinställningar. Mer information finns i testa lokala program
    • Exempel: 
      exposeNetwork: '<loopback>'

  • timeout

    • Beskrivning: Med den här inställningen kan du ange tidsgräns för dina tester som ansluter till de molnbaserade webbläsarna.
    • Exempel: 
      timeout: 30000,

  • reporter

    • Beskrivning: Filen playwright.service.config.ts utökar konfigurationsfilen för dramatiker i konfigurationen. Det här alternativet åsidosätter befintliga reportrar och ställer in Microsoft Playwright Testing-reporter. Du kan lägga till eller ändra den här listan så att den innehåller de reportrar som du vill använda. Du debiteras för Microsoft Playwright Testing-rapportering om du lägger till @azure/microsoft-playwright-testing/reporter.
    • Standardvärde: ["@azure/microsoft-playwright-testing/reporter"]
    • Exempel: 
      reporter: [
["list"],
["@azure/microsoft-playwright-testing/reporter"],

  • enableGitHubSummary:

    • Beskrivning: Med den här inställningen kan du konfigurera Microsoft Playwright Testing Service-reportern. Du kan välja om du vill inkludera testkörningssammanfattningen i GitHub-sammanfattningen när du kör i GitHub Actions.
    • Standardvärde: true
    • Exempel:
      reporter: [
    ["list"],
    [
      "@azure/microsoft-playwright-testing/reporter",
      {
        enableGitHubSummary: true,
      },
    ],
  ]

Här är en version av .runsettings filen med alla tillgängliga alternativ:

<?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>

Konfigurationsalternativ i .runsettings filen

  • serviceAuthType:

    • Beskrivning: Med den här inställningen kan du välja den autentiseringsmetod som du vill använda för testkörningen.
    • Tillgängliga alternativ:
      • AccessToken för att använda åtkomsttoken. Du måste aktivera autentisering med hjälp av åtkomsttoken om du vill använda det här alternativet. Mer information finns i Hantera autentisering.
      • EntraId för att använda Microsoft Entra-ID för autentisering. Det är standardläget.
    • Standardvärde: EntraId
    • Exempel: 
      <Parameter name="ServiceAuthType" value="EntraId" />

  • os:

    • Beskrivning: Med den här inställningen kan du välja det operativsystem där webbläsarna som kör Playwright-tester finns.
    • Tillgängliga alternativ:
      • "windows" för Windows OS.
      • "linux" för Linux OS.
    • Standardvärde: "linux"
    • Exempel: 
      <Parameter name="Os" value="linux" />

  • RunId:

    • Beskrivning: Med den här inställningen kan du ange ett unikt ID för varje testkörning för att särskilja dem i tjänstportalen. Om du använder samma runId för flera testkörningar resulterar det i fel. Om du inte anger det genererar tjänstpaketet ett unikt ID varje gång du utlöser en testkörning. För horisontell partitionering behåller du samma sak för alla shards.
    • Exempel: 
      <Parameter name="RunId" value="sample-run-id1" />

  • AzureTokenCredentialType:

    • Beskrivning: Med den här inställningen kan du välja den autentiseringsmetod som du vill använda med Microsoft Entra-ID.
    • Exempel: 
      <Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />

  • UseCloudHostedBrowsers

    • Beskrivning: Med den här inställningen kan du välja om du vill använda molnbaserade webbläsare eller webbläsare på klientdatorn för att köra dina Playwright-tester. Om du inaktiverar det här alternativet körs dina tester i webbläsaren på klientdatorn i stället för molnbaserade webbläsare, och du debiteras inga avgifter.
    • Standardvärde: true
    • Exempel: 
      <Parameter name="UseCloudHostedBrowsers" value="true" />

  • ExposeNetwork

    • Beskrivning: Med den här inställningen kan du ansluta till lokala resurser från din Playwright-testkod utan att behöva konfigurera några andra brandväggsinställningar. Mer information finns i testa lokala program
    • Exempel: 
      <Parameter name="ExposeNetwork" value="loopback" />

  • reporter

    • Beskrivning: Du kan publicera dina testresultat och artefakter till tjänsten med hjälp av microsoft-playwright-testing logger. Du kan inaktivera rapportering genom att ta bort den från din .runsettings eller genom att ange den till false.
    • Standardvärde: true
    • Exempel: 
      <Logger friendlyName="microsoft-playwright-testing" enabled="true" />

  • EnableGitHubSummary:

    • Beskrivning: Med den här inställningen kan du konfigurera Microsoft Playwright Testing Service-reportern. Du kan välja om du vill inkludera testkörningssammanfattningen i GitHub-sammanfattningen när du kör i GitHub Actions.
    • Standardvärde: true
    • Exempel:
      <Parameter name="EnableGitHubSummary" value="false" />