Use as opções disponíveis no pacote de serviço com a visualização do Microsoft Playwright Testing

Artigo
11/19/2024

Este artigo mostra como usar as opções disponíveis no playwright.service.config.ts arquivo que foi gerado para você. Se você não tiver esse arquivo em seu código, siga Guia de início rápido: execute testes de ponta a ponta em escala com o Microsoft Playwright Testing Preview

Este artigo mostra como usar as opções disponíveis no .runsettings arquivo. Se você não tiver esse arquivo em seu código, siga Guia de início rápido: execute testes de ponta a ponta em escala com o Microsoft Playwright Testing Preview

Importante

O Microsoft Playwright Testing está atualmente em pré-visualização. Para obter os termos legais que se aplicam aos recursos do Azure que estão em versão beta, em visualização ou ainda não lançados em disponibilidade geral, consulte os Termos de Uso Suplementares para Visualizações do Microsoft Azure.

Pré-requisitos

Siga o guia de início rápido e configure um projeto para ser executado com o serviço Microsoft Playwright Testing. Consulte Guia de início rápido: executar testes de ponta a ponta em escala com o Microsoft Playwright Testing Preview

Aqui está a playwright.service.config.ts versão do arquivo com todas as opções disponíveis:

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

Configurações no `playwright.service.config.ts` arquivo

serviceAuthType:
- Descrição: essa configuração permite que você escolha o método de autenticação que deseja usar para sua execução de teste.
- Opções disponíveis:
  - ACCESS_TOKEN para usar tokens de acesso. Você precisa habilitar a autenticação usando tokens de acesso se quiser usar essa opção, consulte Gerenciar autenticação.
  - ENTRA_ID para usar o Microsoft Entra ID para autenticação. É o modo padrão.
- Valor padrão: ENTRA_ID
- Exemplo:
```
serviceAuthType:'ENTRA_ID'
```
os:
- Descrição: Esta configuração permite que você escolha o sistema operacional onde os navegadores que executam testes Playwright estão hospedados.
- Opções disponíveis:
  - ServiceOS.WINDOWS para o sistema operacional Windows.
  - ServiceOS.LINUX para Linux OS.
- Valor padrão: ServiceOS.LINUX
- Exemplo:
```
os: ServiceOS.WINDOWS
```
runId:
- Descrição: essa configuração permite definir uma ID exclusiva para cada execução de teste para distingui-los no portal de serviço. Usar o mesmo runId para várias execuções de teste resulta em erro. Para fragmentação, mantenha isso mesmo em todos os fragmentos.
- Exemplo:
```
runId: new Date().toISOString()
```
credential:
- Descrição: Esta definição permite-lhe selecionar o método de autenticação que pretende utilizar com o Microsoft Entra ID.
- Exemplo:
```
credential: new AzureCliCredential()
```
useCloudHostedBrowsers
- Descrição: essa configuração permite que você escolha se deseja usar navegadores hospedados na nuvem ou os navegadores em sua máquina cliente para executar seus testes de Playwright. Se você desativar essa opção, seus testes serão executados nos navegadores da máquina cliente em vez de navegadores hospedados na nuvem, e você não incorrerá em nenhuma cobrança.
- Valor padrão: true
- Exemplo:
```
useCloudHostedBrowsers: true
```
exposeNetwork
- Descrição: Esta definição permite-lhe ligar a recursos locais a partir do seu código de teste Playwright sem ter de definir outras definições de firewall. Para saber mais, veja como testar aplicativos locais
- Exemplo:
```
exposeNetwork: '<loopback>'
```
timeout
- Descrição: essa configuração permite que você defina o tempo limite para seus testes de conexão com os navegadores hospedados na nuvem.
- Exemplo:
```
timeout: 30000,
```
reporter
- Descrição: O playwright.service.config.ts arquivo estende o arquivo de configuração de reprodução da sua configuração. Esta opção substitui os repórteres existentes e define o Microsoft Playwright Testing reporter. Você pode adicionar ou modificar essa lista para incluir os repórteres que deseja usar. Você será cobrado pelos relatórios do Microsoft Playwright Testing se adicionar @azure/microsoft-playwright-testing/reportero .
- Valor padrão: ["@azure/microsoft-playwright-testing/reporter"]
- Exemplo:
```
reporter: [
["list"],
["@azure/microsoft-playwright-testing/reporter"],
```
enableGitHubSummary:
- Descrição: Esta definição permite-lhe configurar o Microsoft Playwright Testing service reporter. Você pode escolher se deseja incluir o resumo da execução de teste no resumo do GitHub ao executar em Ações do GitHub.
- Valor padrão: true
- Exemplo:
```
  reporter: [
    ["list"],
    [
      "@azure/microsoft-playwright-testing/reporter",
      {
        enableGitHubSummary: true,
      },
    ],
  ]
```

Aqui está a .runsettings versão do arquivo com todas as opções disponíveis:

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

Opções de configuração no `.runsettings` arquivo

serviceAuthType:
- Descrição: essa configuração permite que você escolha o método de autenticação que deseja usar para sua execução de teste.
- Opções disponíveis:
  - AccessToken para usar tokens de acesso. Você precisa habilitar a autenticação usando tokens de acesso se quiser usar essa opção, consulte Gerenciar autenticação.
  - EntraId para usar o Microsoft Entra ID para autenticação. É o modo padrão.
- Valor padrão: EntraId
- Exemplo:
```
<Parameter name="ServiceAuthType" value="EntraId" />
```
os:
- Descrição: Esta configuração permite que você escolha o sistema operacional onde os navegadores que executam testes Playwright estão hospedados.
- Opções disponíveis:
  - "windows" para o sistema operacional Windows.
  - "linux" para Linux OS.
- Valor padrão: "linux"
- Exemplo:
```
<Parameter name="Os" value="linux" />
```
RunId:
- Descrição: essa configuração permite definir uma ID exclusiva para cada execução de teste para distingui-los no portal de serviço. Usar o mesmo runId para várias execuções de teste resulta em erro. Se você não defini-lo, o pacote de serviço gerará uma ID exclusiva toda vez que você acionar uma execução de teste. Para fragmentação, mantenha isso mesmo em todos os fragmentos.
- Exemplo:
```
<Parameter name="RunId" value="sample-run-id1" />
```
AzureTokenCredentialType:
- Descrição: Esta definição permite-lhe selecionar o método de autenticação que pretende utilizar com o Microsoft Entra ID.
- Exemplo:
```
<Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />
```
UseCloudHostedBrowsers
- Descrição: essa configuração permite que você escolha se deseja usar navegadores hospedados na nuvem ou os navegadores em sua máquina cliente para executar seus testes de Playwright. Se você desativar essa opção, seus testes serão executados nos navegadores da máquina cliente em vez de navegadores hospedados na nuvem, e você não incorrerá em nenhuma cobrança.
- Valor padrão: true
- Exemplo:
```
<Parameter name="UseCloudHostedBrowsers" value="true" />
```
ExposeNetwork
- Descrição: Esta definição permite-lhe ligar a recursos locais a partir do seu código de teste Playwright sem ter de definir outras definições de firewall. Para saber mais, veja como testar aplicativos locais
- Exemplo:
```
<Parameter name="ExposeNetwork" value="loopback" />
```
reporter
- Descrição: Você pode publicar os resultados do teste e os artefatos no serviço usando microsoft-playwright-testing o logger. Você pode desativar a geração de relatórios removendo-a do seu .runsettings ou definindo-a como false.
- Valor padrão: true
- Exemplo:
```
<Logger friendlyName="microsoft-playwright-testing" enabled="true" />
```
EnableGitHubSummary:
- Descrição: Esta definição permite-lhe configurar o Microsoft Playwright Testing service reporter. Você pode escolher se deseja incluir o resumo da execução de teste no resumo do GitHub ao executar em Ações do GitHub.
- Valor padrão: true
- Exemplo:
```
  <Parameter name="EnableGitHubSummary" value="false" />
```

Partilhar via

Use as opções disponíveis no pacote de serviço com a visualização do Microsoft Playwright Testing

Pré-requisitos

Configurações no `playwright.service.config.ts` arquivo

Opções de configuração no `.runsettings` arquivo

Comentários

Recursos adicionais

Partilhar via

Use as opções disponíveis no pacote de serviço com a visualização do Microsoft Playwright Testing

Pré-requisitos

Configurações no playwright.service.config.ts arquivo

Opções de configuração no .runsettings arquivo

Comentários

Recursos adicionais

Configurações no `playwright.service.config.ts` arquivo

Opções de configuração no `.runsettings` arquivo