Rychlý start: Řešení potíží s testy pomocí microsoft Playwright Testing Preview

Článek
12/04/2024

V tomto rychlém startu se dozvíte, jak snadno řešit potíže s testy Playwright pomocí sestav a artefaktů publikovaných ve verzi Microsoft Playwright Testing Preview. Tato příručka navíc ukazuje, jak využívat funkci generování sestav bez ohledu na to, jestli spouštíte testy v prohlížečích hostovaných v cloudu poskytované službou.

Po dokončení tohoto rychlého startu budete mít pracovní prostor Microsoft Playwright Testing k zobrazení výsledků testů a artefaktů na portálu služby.

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.

Pozadí

Služba Microsoft Playwright Testing umožňuje:

Zrychlete kanály sestavení paralelním spouštěním testů pomocí prohlížečů hostovaných v cloudu.
Zjednodušte řešení potíží publikováním výsledků testů a artefaktů do služby, aby byly přístupné prostřednictvím portálu služby.

Tyto dvě funkce služby je možné používat nezávisle nebo společně a každý z nich má svůj vlastní cenový plán. Máte flexibilitu pro:

Urychlte testovací běhy a zjednodušte řešení potíží pomocí obou funkcí: spouštění testů v prohlížečích hostovaných v cloudu a publikování výsledků do služby.
Testy můžete spouštět jenom v prohlížečích hostovaných v cloudu, aby se testovací běhy dokončily rychleji.
Výsledky testů publikujte do služby a současně pokračujte v místním spouštění testů, abyste mohli efektivně řešit potíže.

Poznámka:

Tento článek se zaměřuje na to, jak můžete publikovat výsledky testů do služby bez použití prohlížečů hostovaných v cloudu. Pokud se chcete dozvědět, jak také zrychlit testovací běhy, projděte si rychlý start: spuštění testů Playwright ve velkém měřítku.

Požadavky

Účet Azure s aktivním předplatným. Pokud ještě nemáte předplatné Azure, vytvořte si napřed bezplatný účet.
Váš účet Azure potřebuje roli vlastníka, přispěvatele nebo některé z klasických rolí správce.
Projekt playwright. Pokud projekt nemáte, vytvořte si ho pomocí úvodní dokumentace playwright nebo použijte ukázkový projekt Microsoft Playwright Testing.
Rozhraní příkazového řádku Azure. Pokud azure CLI nemáte, přečtěte si téma Instalace Azure CLI.

Vytvoření pracovního prostoru

Pokud chcete začít s publikováním výsledků testů ve službě Playwright Testing, nejprve vytvořte pracovní prostor Microsoft Playwright Testing na portálu Playwright.

Přihlaste se k portálu Playwright pomocí svého účtu Azure.
Pokud už pracovní prostor máte, vyberte existující pracovní prostor a přejděte k dalšímu kroku.

Tip

Pokud máte více pracovních prostorů, můžete přepnout do jiného pracovního prostoru tak, že v horní části stránky vyberete název pracovního prostoru a pak vyberete Spravovat všechny pracovní prostory.

Pokud ještě pracovní prostor nemáte, vyberte + Nový pracovní prostor a zadejte následující informace:

Pole	Popis
Název pracovního prostoru	Zadejte jedinečný název pro identifikaci pracovního prostoru. Název se může skládat pouze z alfanumerických znaků a má délku mezi 3 a 64 znaky.
Předplatné Azure	Vyberte předplatné Azure, které chcete použít pro tento pracovní prostor Microsoft Playwright Testing.
Oblast	Vyberte zeměpisné umístění pro hostování vašeho pracovního prostoru. Toto je umístění, kde jsou data testovacího spuštění uložená pro pracovní prostor.

Výběrem možnosti Vytvořit pracovní prostor vytvořte pracovní prostor ve vašem předplatném.

Během vytváření pracovního prostoru se ve vašem předplatném Azure vytvoří nová skupina prostředků a prostředek Microsoft Playwright Testing Azure.

Po dokončení vytváření pracovního prostoru budete přesměrováni do průvodce nastavením.

Instalace balíčku Microsoft Playwright Testing

Chcete-li použít službu, nainstalujte balíček Microsoft Playwright Testing.

npm init @azure/microsoft-playwright-testing@latest

Poznámka:

Ujistěte se, že váš projekt používá @playwright/test verzi 1.47 nebo vyšší.

Tento příkaz vygeneruje playwright.service.config.ts soubor, který slouží k:

Nasměrujte klienta Playwright a ověřte ho do služby Microsoft Playwright Testing.
Přidá reportér pro publikování výsledků testu a artefaktů.

Pokud už tento soubor máte, výzva vás vyzve k jeho přepsání.

Pokud chcete pro testovací běh používat jenom funkci vytváření sestav, zakažte prohlížeče hostované v cloudu nastavením useCloudHostedBrowsers false.

export default defineConfig(
  config,
  getServiceConfig(config, {
    timeout: 30000,
    os: ServiceOS.LINUX,
	useCloudHostedBrowsers: false // Do not use cloud hosted browsers
  }),
  {
    reporter: [['list'], ['@azure/microsoft-playwright-testing/reporter']], // Reporter for Microsoft Playwright Testing service
  }
);

Nastavení hodnoty tak, aby false se zajistilo, že se ke spouštění testů nepoužívají prohlížeče hostované v cloudu. Testy se spouští na místním počítači, ale výsledky a artefakty se publikují ve službě.

Chcete-li použít službu, nainstalujte balíček Microsoft Playwright Testing.

dotnet add package Azure.Developer.MicrosoftPlaywrightTesting.NUnit --prerelease

Poznámka:

Ujistěte se, že váš projekt používá Microsoft.Playwright.NUnit verzi 1.47 nebo vyšší.

Pokud chcete použít pouze funkci vytváření sestav, aktualizujte v .runsettings souboru projektu následující:

Zakažte prohlížeče hostované v cloudu nastavením useCloudHostedBrowsers false.
Přidejte protokolovací nástroj Microsoft Playwright Testing v části Protokolovací nástroje.

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
    <TestRunParameters>        
        <!--Select if you want to use cloud-hosted browsers to run your Playwright tests.-->
        <Parameter name="UseCloudHostedBrowsers" value="true" />
        <!--Select the authentication method you want to use with Entra-->
    </TestRunParameters> 
 .
 .
 .
    <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>

Tip

Pokud chcete zrychlit testovací běh pomocí prohlížeče hostovaného v cloudu, můžete nastavit useCloudHostedBrowsers jako true. Tím se spustí testy v prohlížečích spravovaných službou.

Konfigurace koncového bodu oblasti služby

V nastavení musíte zadat koncový bod služby specifické pro danou oblast. Koncový bod závisí na oblasti Azure, kterou jste vybrali při vytváření pracovního prostoru.

Pokud chcete získat adresu URL koncového bodu služby, proveďte následující kroky:

V části Přidat koncový bod oblasti v nastavení zkopírujte koncový bod oblasti pro váš pracovní prostor.

Adresa URL koncového bodu odpovídá oblasti Azure, kterou jste vybrali při vytváření pracovního prostoru. Ujistěte se, že je tato adresa URL dostupná v PLAYWRIGHT_SERVICE_URL proměnné prostředí.

Nastavení prostředí

Pokud chcete nastavit prostředí, musíte nakonfigurovat PLAYWRIGHT_SERVICE_URL proměnnou prostředí s hodnotou, kterou jste získali v předchozích krocích.

Ke správě prostředí doporučujeme použít dotenv modul. V dotenvsouboru .env definujete proměnné prostředí.

Přidejte modul dotenv do projektu:
```
npm i --save-dev dotenv
```
Vytvořte .env soubor společně se souborem playwright.config.ts v projektu Playwright:
```
PLAYWRIGHT_SERVICE_URL={MY-REGION-ENDPOINT}
```
Nezapomeňte zástupný text nahradit {MY-REGION-ENDPOINT} hodnotou, kterou jste zkopírovali dříve.

Nastavení konfigurace služby

V kořenovém adresáři vytvořte soubor PlaywrightServiceSetup.cs s následujícím obsahem.

using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;

namespace PlaywrightTests; // Remember to change this as per your project namespace

[SetUpFixture]
public class PlaywrightServiceSetup : PlaywrightServiceNUnit {};

Poznámka:

Ujistěte se, že váš projekt používá Microsoft.Playwright.NUnit verzi 1.47 nebo vyšší.

Nastavení ověřování

Pokud chcete publikovat výsledky testů a artefakty do pracovního prostoru Microsoft Playwright Testing, musíte ověřit klienta Playwright, ve kterém testy spouštíte ve službě. Klientem může být místní vývojový počítač nebo počítač CI.

Služba nabízí dvě metody ověřování: Microsoft Entra ID a přístupové tokeny.

Microsoft Entra ID používá vaše přihlašovací údaje Azure, které vyžadují přihlášení k vašemu účtu Azure pro zabezpečený přístup. Případně můžete vygenerovat přístupový token z pracovního prostoru Playwright a použít ho v nastavení.

Nastavení ověřování pomocí Microsoft Entra ID

Id Microsoft Entra je výchozí a doporučené ověřování pro službu. Z místního vývojového počítače můžete k přihlášení použít Azure CLI .

az login

Poznámka:

Pokud jste součástí více tenantů Microsoft Entra, ujistěte se, že se přihlásíte k tenantovi, do kterého patří váš pracovní prostor. ID tenanta můžete získat z webu Azure Portal. Další informace najdete v tématu Vyhledání tenanta Microsoft Entra. Jakmile získáte ID, přihlaste se pomocí příkazu. az login --tenant <TenantID>

Nastavení ověřování pomocí přístupových tokenů

Přístupový token můžete vygenerovat z pracovního prostoru Playwright Testing a použít ho v nastavení. Kvůli rozšířenému zabezpečení však důrazně doporučujeme microsoft Entra ID pro ověřování. Přístupové tokeny, zatímco pohodlné, fungují jako dlouhodobá hesla a jsou náchylnější k ohrožení zabezpečení.

Ověřování pomocí přístupových tokenů je ve výchozím nastavení zakázané. Pokud chcete použít, povolte ověřování na základě přístupového tokenu.
Nastavení ověřování pomocí přístupových tokenů

Upozornění

Důrazně doporučujeme pro ověřování ve službě použít MICROSOFT Entra ID. Pokud používáte přístupové tokeny, přečtěte si téma Správa přístupových tokenů.

Povolení artefaktů v nastavení Playwright

playwright.config.ts V souboru projektu se ujistěte, že shromažďujete všechny požadované artefakty.

  use: {
    trace: 'on-first-retry',
    video:'retain-on-failure',
    screenshot:'on'
  }

Povolte artefakty, jako jsou snímky obrazovky, videa a trasování, které má playwright zachytit.

Snímky obrazovky najdete v tématu zachycení snímků obrazovky.
Videa najdete v záznamech videí pro vaše testy.
Trasování najdete v záznamu trasování.

Jakmile tyto artefakty shromáždíte, připojte je k nim, abyste měli jistotu TestContext , že jsou dostupné v testovacích sestavách. Další informace najdete v našem ukázkovém projektu pro NUnit.

Spuštění testů a publikování výsledků na webu Microsoft Playwright Testing

Teď jste připravili konfiguraci pro publikování výsledků testů a artefaktů pomocí microsoft Playwright Testing. Spusťte testy pomocí nově vytvořeného playwright.service.config.ts souboru a publikujte výsledky testů a artefakty do služby.

   npx playwright test --config=playwright.service.config.ts

Poznámka:

Pro funkci Vytváření sestav microsoft Playwright Testing se vám bude účtovat poplatky na základě publikovaných čísel výsledků testu. Pokud jste uživatelem poprvé nebo začínáte s bezplatnou zkušební verzí, můžete začít publikováním jednoho výsledku testu místo úplné sady testů, abyste se vyhnuli vyčerpání bezplatných zkušebních limitů.

Po dokončení testu můžete zobrazit stav testu v terminálu.

Running 6 test using 2 worker
    5 passed, 1 failed (20.2s)

Test report: https://playwright.microsoft.com/workspaces/<workspace-id>/runs/<run-id>

Teď jste připravili konfiguraci pro publikování výsledků testů a artefaktů pomocí microsoft Playwright Testing. Spusťte testy pomocí .runsettings souboru a publikujte výsledky testů a artefakty do služby.

dotnet test --settings:.runsettings

Nastavení testovacího spuštění jsou definována v .runsettings souboru. Další informace najdete v tématu použití možností balíčku služby.

Poznámka:

Po dokončení testovacího spuštění můžete zobrazit stav testu v terminálu.

Starting test execution, please wait...

Initializing reporting for this test run. You can view the results at: https://playwright.microsoft.com/workspaces/<workspace-id>/runs/<run-id>

A total of 100 test files matched the specified pattern.

Test Report: https://playwright.microsoft.com/workspaces/<workspace-id>/runs/<run-id>

Passed!  - Failed:     0, Passed:     100, Skipped:     0, Total:     100, Duration: 10 m - PlaywrightTestsNUnit.dll (net7.0)

Workload updates are available. Run `dotnet workload list` for more information.

Upozornění

V závislosti na velikosti testovací sady se vám můžou účtovat další poplatky za výsledky testů nad rámec přidělených bezplatných výsledků testů.

Zobrazení testovacích spuštění a výsledků na portálu Playwright

Nyní můžete řešit potíže s neúspěšnými testovacími případy na portálu Playwright.

Po dokončení testovacího spuštění se vygeneruje odkaz na portál Playwright. Otevřením tohoto odkazu zobrazíte podrobné výsledky testů a přidružené artefakty. Portál zobrazuje základní informace, mezi které patří:
- Podrobnosti o sestavení CI
- Celkový stav testovacího spuštění
- ID potvrzení propojené s testovacím spuštěním
Portál Playwright poskytuje všechny potřebné informace pro řešení potíží. Můžete provádět následující akce:
- Přepínání mezi opakovanými pokusy
- Prohlédněte si podrobné protokoly chyb, testovací kroky a připojené artefakty, jako jsou snímky obrazovky nebo videa.
- Pokud chcete provést hlubší analýzu, přejděte přímo do prohlížeče trasování.
Prohlížeč trasování umožňuje vizuálně procházet provádění testů. Můžete provádět následující akce:
- Časovou osu použijte k najetí myší na jednotlivé kroky a zobrazte stav stránky před a po každé akci.
- Pro každý krok zkontrolujte podrobné protokoly, snímky DOM, síťovou aktivitu, chyby a výstup konzoly.

Po dokončení testovacího spuštění získáte odkaz na portál Playwright v terminálu. Otevřením tohoto odkazu zobrazíte podrobné výsledky testů a přidružené artefakty. Portál zobrazuje základní informace, mezi které patří:
- Podrobnosti o sestavení CI
- Celkový stav testovacího spuštění
- ID potvrzení propojené s testovacím spuštěním
Portál Playwright poskytuje všechny potřebné informace pro řešení potíží. Můžete provádět následující akce:
- Prohlédněte si podrobné protokoly chyb a připojené artefakty, jako jsou snímky obrazovky nebo videa.
- Pokud chcete provést hlubší analýzu, přejděte přímo do prohlížeče trasování.

Poznámka:

Některá metadata, jako je vlastník, popis a kategorie, se v současné době na řídicím panelu služby nezobrazují. Pokud máte další informace, které byste chtěli zahrnout, odešlete problém gitHubu v našem úložišti.

Prohlížeč trasování umožňuje vizuálně procházet provádění testů. Můžete provádět následující akce:
- Časovou osu použijte k najetí myší na jednotlivé kroky a zobrazte stav stránky před a po každé akci.
- Pro každý krok zkontrolujte podrobné protokoly, snímky DOM, síťovou aktivitu, chyby a výstup konzoly.

Tip

Službu Microsoft Playwright Testing můžete také použít k paralelnímu spouštění testů pomocí prohlížečů hostovaných v cloudu. Generování sestav i prohlížeče hostované v cloudu jsou nezávislé funkce a účtují se samostatně. Můžete použít některou z těchto možností nebo obojí. Podrobnosti najdete v tématu Použití funkcí služby.

Poznámka:

Výsledky testu a artefakty, které publikujete, se zachovají ve službě po dobu 90 dnů. Potom se automaticky odstraní.

Další krok

Úspěšně jste vytvořili pracovní prostor Microsoft Playwright Testing na portálu Playwright a spustili testy Playwright v cloudových prohlížečích.

Přejděte k dalšímu rychlému startu a nastavte průběžné kompletní testování spuštěním testů Playwright v pracovním postupu CI/CD.

Nastavení průběžného kompletního testování v CI/CD

Sdílet prostřednictvím

Rychlý start: Řešení potíží s testy pomocí microsoft Playwright Testing Preview

Pozadí

Požadavky

Vytvoření pracovního prostoru

Instalace balíčku Microsoft Playwright Testing

Konfigurace koncového bodu oblasti služby

Nastavení prostředí

Nastavení konfigurace služby

Nastavení ověřování

Nastavení ověřování pomocí Microsoft Entra ID

Nastavení ověřování pomocí přístupových tokenů

Povolení artefaktů v nastavení Playwright

Spuštění testů a publikování výsledků na webu Microsoft Playwright Testing

Zobrazení testovacích spuštění a výsledků na portálu Playwright

Další krok

Váš názor

Další materiály