Beschikbare opties gebruiken in servicepakket met Microsoft Playwright Testing Preview

In dit artikel leest u hoe u de opties gebruikt die beschikbaar zijn in het playwright.service.config.ts bestand dat voor u is gegenereerd. Als u dit bestand niet in uw code hebt, volgt u de quickstart: End-to-end-tests op schaal uitvoeren met Microsoft Playwright Testing Preview

In dit artikel leest u hoe u de opties gebruikt die beschikbaar zijn in het .runsettings bestand. Als u dit bestand niet in uw code hebt, volgt u de quickstart: End-to-end-tests op schaal uitvoeren met Microsoft Playwright Testing Preview

Belangrijk

Microsoft Playwright Testing is momenteel beschikbaar als preview-versie. Zie de aanvullende gebruiksvoorwaarden voor Microsoft Azure Previews voor juridische voorwaarden die van toepassing zijn op Azure-functies die in de bètaversie, in preview of anderszins nog niet zijn uitgebracht in algemene beschikbaarheid.

Vereisten

• Volg de snelstartgids en stel een project in dat moet worden uitgevoerd met de Microsoft Playwright Testing-service. Zie, quickstart: End-to-end-tests op schaal uitvoeren met Microsoft Playwright Testing Preview

Hier volgt een versie van het playwright.service.config.ts bestand met alle beschikbare opties:

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

Instellingen in playwright.service.config.ts bestand

• serviceAuthType:

  • Beschrijving: Met deze instelling kunt u de verificatiemethode kiezen die u wilt gebruiken voor de testuitvoering.
  • Beschikbare opties:
    • ACCESS_TOKEN om toegangstokens te gebruiken. U moet verificatie met toegangstokens inschakelen als u deze optie wilt gebruiken. Zie Verificatie beheren.
    • ENTRA_ID om Microsoft Entra-id te gebruiken voor verificatie. Dit is de standaardmodus.
  • Standaardwaarde: ENTRA_ID
  • Voorbeeld:

    serviceAuthType:'ENTRA_ID'
    

• os:

  • Beschrijving: Met deze instelling kunt u het besturingssysteem kiezen waarin de browsers waarop Playwright-tests worden uitgevoerd, worden gehost.
  • Beschikbare opties:
    • ServiceOS.WINDOWS voor het Windows-besturingssysteem.
    • ServiceOS.LINUX voor linux-besturingssysteem.
  • Standaardwaarde: ServiceOS.LINUX
  • Voorbeeld:

    os: ServiceOS.WINDOWS
    

• runId:

  • Beschrijving: Met deze instelling kunt u een unieke id instellen voor elke testuitvoering om deze te onderscheiden in de serviceportal. Het gebruik van dezelfde runId voor meerdere testuitvoeringen resulteert in een fout. Voor sharding houdt u dit hetzelfde voor alle shards.
  • Voorbeeld:

    runId: new Date().toISOString()
    

• credential:

  • Beschrijving: Met deze instelling kunt u de verificatiemethode selecteren die u wilt gebruiken met Microsoft Entra-id.
  • Voorbeeld:

    credential: new AzureCliCredential()
    

• useCloudHostedBrowsers

  • Beschrijving: Met deze instelling kunt u kiezen of u in de cloud gehoste browsers of de browsers op uw clientcomputer wilt gebruiken om uw Playwright-tests uit te voeren. Als u deze optie uitschakelt, worden uw tests uitgevoerd op de browsers van uw clientcomputer in plaats van in de cloud gehoste browsers en worden er geen kosten in rekening gebracht.
  • Standaardwaarde: true
  • Voorbeeld:

    useCloudHostedBrowsers: true
    

• exposeNetwork

  • Beschrijving: Met deze instelling kunt u vanuit de Playwright-testcode verbinding maken met lokale resources zonder dat u andere firewallinstellingen hoeft te configureren. Zie voor meer informatie hoe u lokale toepassingen kunt testen
  • Voorbeeld:

    exposeNetwork: '<loopback>'
    

• timeout

  • Beschrijving: Met deze instelling kunt u een time-out instellen voor uw tests die verbinding maken met de in de cloud gehoste browsers.
  • Voorbeeld:

    timeout: 30000,
    

• reporter

  • Beschrijving: Het playwright.service.config.ts bestand breidt het playwright-configuratiebestand van uw installatie uit. Met deze optie overschrijft u de bestaande reporters en stelt u microsoft Playwright Testing reporter in. U kunt deze lijst toevoegen of wijzigen om de rapportgevers op te nemen die u wilt gebruiken. U wordt gefactureerd voor Microsoft Playwright Testing-rapportage als u dit toevoegt @azure/microsoft-playwright-testing/reporter.
  • Standaardwaarde: ["@azure/microsoft-playwright-testing/reporter"]
  • Voorbeeld:

    reporter: [
    ["list"],
    ["@azure/microsoft-playwright-testing/reporter"],
    

• enableGitHubSummary:

  • Beschrijving: Met deze instelling kunt u de microsoft Playwright Testing Service Reporter configureren. U kunt kiezen of u de samenvatting van de testuitvoering wilt opnemen in de GitHub-samenvatting wanneer u deze uitvoert in GitHub Actions.
  • Standaardwaarde: true
  • Voorbeeld:

    reporter: [
      ["list"],
      [
        "@azure/microsoft-playwright-testing/reporter",
        {
          enableGitHubSummary: true,
        },
      ],
    ]
  

Hier volgt een versie van het .runsettings bestand met alle beschikbare opties:

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

Configuratieopties in .runsettings bestand

• serviceAuthType:

  • Beschrijving: Met deze instelling kunt u de verificatiemethode kiezen die u wilt gebruiken voor de testuitvoering.
  • Beschikbare opties:
    • AccessToken om toegangstokens te gebruiken. U moet verificatie met toegangstokens inschakelen als u deze optie wilt gebruiken. Zie Verificatie beheren.
    • EntraId om Microsoft Entra-id te gebruiken voor verificatie. Dit is de standaardmodus.
  • Standaardwaarde: EntraId
  • Voorbeeld:

    <Parameter name="ServiceAuthType" value="EntraId" />
    

• os:

  • Beschrijving: Met deze instelling kunt u het besturingssysteem kiezen waarin de browsers waarop Playwright-tests worden uitgevoerd, worden gehost.
  • Beschikbare opties:
    • 'windows' voor Windows-besturingssysteem.
    • 'linux' voor Linux-besturingssysteem.
  • Standaardwaarde: 'linux'
  • Voorbeeld:

    <Parameter name="Os" value="linux" />
    

• RunId:

  • Beschrijving: Met deze instelling kunt u een unieke id instellen voor elke testuitvoering om deze te onderscheiden in de serviceportal. Het gebruik van dezelfde runId voor meerdere testuitvoeringen resulteert in een fout. Als u dit niet instelt, genereert het servicepakket elke keer dat u een testuitvoering activeert een unieke id. Voor sharding houdt u dit hetzelfde voor alle shards.
  • Voorbeeld:

    <Parameter name="RunId" value="sample-run-id1" />
    

• AzureTokenCredentialType:

  • Beschrijving: Met deze instelling kunt u de verificatiemethode selecteren die u wilt gebruiken met Microsoft Entra-id.
  • Voorbeeld:

    <Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />
    

• UseCloudHostedBrowsers

  • Beschrijving: Met deze instelling kunt u kiezen of u in de cloud gehoste browsers of de browsers op uw clientcomputer wilt gebruiken om uw Playwright-tests uit te voeren. Als u deze optie uitschakelt, worden uw tests uitgevoerd op de browsers van uw clientcomputer in plaats van in de cloud gehoste browsers en worden er geen kosten in rekening gebracht.
  • Standaardwaarde: true
  • Voorbeeld:

    <Parameter name="UseCloudHostedBrowsers" value="true" />
    

• ExposeNetwork

  • Beschrijving: Met deze instelling kunt u vanuit de Playwright-testcode verbinding maken met lokale resources zonder dat u andere firewallinstellingen hoeft te configureren. Zie voor meer informatie hoe u lokale toepassingen kunt testen
  • Voorbeeld:

    <Parameter name="ExposeNetwork" value="loopback" />
    

• reporter

  • Beschrijving: U kunt uw testresultaten en artefacten publiceren naar de service met behulp van microsoft-playwright-testing logger. U kunt rapportage uitschakelen door deze uit uw .runsettings rapport te verwijderen of door deze in te stellen op false.
  • Standaardwaarde: true
  • Voorbeeld:

    <Logger friendlyName="microsoft-playwright-testing" enabled="true" />
    

• EnableGitHubSummary:

  • Beschrijving: Met deze instelling kunt u de microsoft Playwright Testing Service Reporter configureren. U kunt kiezen of u de samenvatting van de testuitvoering wilt opnemen in de GitHub-samenvatting wanneer u deze uitvoert in GitHub Actions.
  • Standaardwaarde: true
  • Voorbeeld:

    <Parameter name="EnableGitHubSummary" value="false" />