Compartir a través de

Uso de opciones disponibles en el paquete de servicio con la versión preliminar de Microsoft Playwright Testing

  • Artículo

En este artículo se muestra cómo usar las opciones disponibles en el archivo playwright.service.config.ts que se generó automáticamente. Si no tiene este archivo en su código, consulte Inicio rápido: Ejecutar pruebas de extremo a extremo a gran escala con la versión preliminar de Microsoft Playwright Testing

En este artículo se muestra cómo usar las opciones disponibles en el archivo .runsettings. Si no tiene este archivo en su código, consulte Inicio rápido: Ejecutar pruebas de extremo a extremo a gran escala con la versión preliminar de Microsoft Playwright Testing

Importante

Microsoft Playwright Testing se encuentra actualmente en versión preliminar. Para conocer los términos legales que se aplican a las características de Azure que se encuentran en la versión beta, en versión preliminar o que todavía no se han publicado para que estén disponibles con carácter general, consulte los Términos de uso complementarios para las versiones preliminares de Microsoft Azure.

Requisitos previos

Esta es la versión del archivo playwright.service.config.ts con todas las opciones disponibles:

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

Configuración en playwright.service.config.ts archivo

  • serviceAuthType:

    • Descripción: esta configuración le permite elegir el método de autenticación que desea usar para la ejecución de pruebas.
    • Opciones disponibles:
      • ACCESS_TOKEN para usar tokens de acceso. Debe habilitar la autenticación mediante tokens de acceso si desea usar esta opción, consulte Administración de la autenticación.
      • ENTRA_ID para usar Microsoft Entra ID para la autenticación. Es el modo predeterminado.
    • Valor predeterminado: ENTRA_ID
    • Ejemplo: 
      serviceAuthType:'ENTRA_ID'

  • os:

    • Descripción: esta configuración le permite elegir el sistema operativo en el que se hospedan los exploradores que ejecutan las pruebas de Playwright.
    • Opciones disponibles:
      • ServiceOS.WINDOWS para el SO Windows.
      • ServiceOS.LINUX para el SO Linux.
    • Valor predeterminado: ServiceOS.LINUX
    • Ejemplo: 
      os: ServiceOS.WINDOWS

  • runId:

    • Descripción: esta configuración permite establecer un id. exclusivo para cada ejecución de prueba para distinguirlos en el portal de servicios. El uso del mismo runId para varias ejecuciones de pruebas produce un error. Para particionamiento, mantenga este mismo en todas las particiones.
    • Ejemplo: 
      runId: new Date().toISOString()

  • credential:

    • Descripción: esta configuración le permite seleccionar el método de autenticación que desea usar con Microsoft Entra ID.
    • Ejemplo: 
      credential: new AzureCliCredential()

  • useCloudHostedBrowsers

    • Descripción: esta configuración le permite elegir si desea utilizar exploradores hospedados en la nube o los exploradores de su equipo cliente para ejecutar las pruebas de Playwright. Si deshabilita esta opción, sus pruebas se ejecutarán en los exploradores de su equipo cliente en lugar de en los exploradores hospedados en la nube, y no incurrirá en ningún cargo.
    • Valor predeterminado: true
    • Ejemplo: 
      useCloudHostedBrowsers: true

  • exposeNetwork

    • Descripción: esta configuración permite conectarse a recursos locales desde el código de prueba de Playwright sin tener que configurar otros valores de firewall. Para más información, consulte Cómo probar aplicaciones locales
    • Ejemplo: 
      exposeNetwork: '<loopback>'

  • timeout

    • Descripción: esta configuración permite establecer el tiempo de espera de las pruebas que se conectan a los exploradores hospedados en la nube.
    • Ejemplo: 
      timeout: 30000,

  • reporter

    • Descripción: el archivo playwright.service.config.ts extiende el archivo de configuración de Playwright de la configuración. Esta opción invalida los reporteros existentes y establece el reportero de Microsoft Playwright Testing. Puede agregar o modificar esta lista para incluir los reporteros que desea usar. Se le facturan los informes de Microsoft Playwright Testing si agrega @azure/microsoft-playwright-testing/reporter.
    • Valor predeterminado: ["@azure/microsoft-playwright-testing/reporter"]
    • Ejemplo: 
      reporter: [
["list"],
["@azure/microsoft-playwright-testing/reporter"],

  • enableGitHubSummary:

    • Descripción: esta configuración le permite configurar el reportero del servicio Microsoft Playwright Testing. Puede elegir si se debe incluir el resumen de la ejecución de pruebas en el resumen de GitHub al ejecutarse en Acciones de GitHub.
    • Valor predeterminado: true
    • Ejemplo:
      reporter: [
    ["list"],
    [
      "@azure/microsoft-playwright-testing/reporter",
      {
        enableGitHubSummary: true,
      },
    ],
  ]

Esta es la versión del archivo .runsettings con todas las opciones disponibles:

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

Opciones de configuración en el archivo .runsettings

  • serviceAuthType:

    • Descripción: esta configuración le permite elegir el método de autenticación que desea usar para la ejecución de pruebas.
    • Opciones disponibles:
      • AccessToken para usar tokens de acceso. Debe habilitar la autenticación mediante tokens de acceso si desea usar esta opción, consulte Administración de la autenticación.
      • EntraId para usar Microsoft Entra ID para la autenticación. Es el modo predeterminado.
    • Valor predeterminado: EntraId
    • Ejemplo: 
      <Parameter name="ServiceAuthType" value="EntraId" />

  • os:

    • Descripción: esta configuración le permite elegir el sistema operativo en el que se hospedan los exploradores que ejecutan las pruebas de Playwright.
    • Opciones disponibles:
      • "windows" para el sistema operativo Windows.
      • "linux" para el sistema operativo Linux.
    • Valor predeterminado: "linux"
    • Ejemplo: 
      <Parameter name="Os" value="linux" />

  • RunId:

    • Descripción: esta configuración permite establecer un id. exclusivo para cada ejecución de prueba para distinguirlos en el portal de servicios. El uso del mismo runId para varias ejecuciones de pruebas produce un error. Si no lo establece, el paquete de servicio generará un identificador único cada vez que desencadene una ejecución de prueba. Para particionamiento, mantenga este mismo en todas las particiones.
    • Ejemplo: 
      <Parameter name="RunId" value="sample-run-id1" />

  • AzureTokenCredentialType:

    • Descripción: esta configuración le permite seleccionar el método de autenticación que desea usar con Microsoft Entra ID.
    • Ejemplo: 
      <Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />

  • UseCloudHostedBrowsers

    • Descripción: esta configuración le permite elegir si desea utilizar exploradores hospedados en la nube o los exploradores de su equipo cliente para ejecutar las pruebas de Playwright. Si deshabilita esta opción, sus pruebas se ejecutarán en los exploradores de su equipo cliente en lugar de en los exploradores hospedados en la nube, y no incurrirá en ningún cargo.
    • Valor predeterminado: true
    • Ejemplo: 
      <Parameter name="UseCloudHostedBrowsers" value="true" />

  • ExposeNetwork

    • Descripción: esta configuración permite conectarse a recursos locales desde el código de prueba de Playwright sin tener que configurar otros valores de firewall. Para más información, consulte Cómo probar aplicaciones locales
    • Ejemplo: 
      <Parameter name="ExposeNetwork" value="loopback" />

  • reporter

    • Descripción: puede publicar los resultados y artefactos de prueba en el servicio mediante el registrador microsoft-playwright-testing. Puede deshabilitar los informes quitando esto de .runsettings o estableciéndolo en false.
    • Valor predeterminado: true
    • Ejemplo: 
      <Logger friendlyName="microsoft-playwright-testing" enabled="true" />

  • EnableGitHubSummary:

    • Descripción: esta configuración le permite configurar el reportero del servicio Microsoft Playwright Testing. Puede elegir si se debe incluir el resumen de la ejecución de pruebas en el resumen de GitHub al ejecutarse en Acciones de GitHub.
    • Valor predeterminado: true
    • Ejemplo:
      <Parameter name="EnableGitHubSummary" value="false" />