Szybki start: rozwiązywanie problemów z testami za pomocą programu Microsoft Playwright Testing Preview
Z tego przewodnika Szybki start dowiesz się, jak łatwo rozwiązywać problemy z testami dramaturgów przy użyciu raportów i artefaktów opublikowanych w wersji zapoznawczej testowania w programie Microsoft Playwright. Ponadto w tym przewodniku pokazano, jak korzystać z funkcji raportowania, niezależnie od tego, czy uruchamiasz testy w przeglądarkach hostowanych w chmurze udostępnianych przez usługę.
Po ukończeniu tego przewodnika Szybki start będziesz mieć obszar roboczy Testowanie dramaturgów firmy Microsoft, aby wyświetlić wyniki testów i artefakty w portalu usługi.
Ważne
Microsoft Playwright Testing jest obecnie w wersji zapoznawczej. Aby uzyskać postanowienia prawne dotyczące funkcji platformy Azure, które znajdują się w wersji beta, w wersji zapoznawczej lub w inny sposób nie zostały jeszcze wydane w wersji ogólnodostępnej, zobacz Dodatkowe warunki użytkowania dla wersji zapoznawczych platformy Microsoft Azure.
Tło
Usługa Microsoft Playwright Testing umożliwia:
- Przyspieszanie potoków kompilacji przez równoległe uruchamianie testów przy użyciu przeglądarek hostowanych w chmurze.
- Uprość rozwiązywanie problemów, publikując wyniki testów i artefakty w usłudze, udostępniając je za pośrednictwem portalu usługi.
Te dwie funkcje usługi mogą być używane niezależnie lub razem, a każdy z nich ma własny plan cenowy. Masz elastyczność:
- Przyspiesz przebiegi testów i usprawnij rozwiązywanie problemów przy użyciu obu funkcji: uruchamiania testów w przeglądarkach hostowanych w chmurze i publikowania wyników w usłudze.
- Uruchamianie testów tylko w przeglądarkach hostowanych w chmurze w celu szybszego przeprowadzania testów.
- Publikuj wyniki testów w usłudze, kontynuując uruchamianie testów lokalnie w celu wydajnego rozwiązywania problemów.
Uwaga
Ten artykuł koncentruje się na tym, jak można publikować wyniki testów w usłudze bez korzystania z przeglądarek hostowanych w chmurze. Jeśli chcesz dowiedzieć się, jak również przyspieszyć przebiegi testów, zobacz Szybki start: uruchamianie testów playwright na dużą skalę
Wymagania wstępne
- Konto platformy Azure z aktywną subskrypcją. Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.
- Twoje konto platformy Azure wymaga roli Właściciel, Współautor lub jeden z ról administratora klasycznego.
- Projekt Dramaturg. Jeśli nie masz projektu, utwórz go przy użyciu dokumentacji wprowadzającej playwright lub skorzystaj z naszego przykładowego projektu Microsoft Playwright Testing.
- Interfejs wiersza polecenia platformy Azure. Jeśli nie masz interfejsu wiersza polecenia platformy Azure, zobacz Instalowanie interfejsu wiersza polecenia platformy Azure.
Tworzenie obszaru roboczego
Aby rozpocząć publikowanie wyników testów w usłudze Playwright Testing, najpierw utwórz obszar roboczy Testowania dramaturgów firmy Microsoft w portalu Playwright.
Zaloguj się do portalu Playwright przy użyciu konta platformy Azure.
Jeśli masz już obszar roboczy, wybierz istniejący obszar roboczy i przejdź do następnego kroku.
Napiwek
Jeśli masz wiele obszarów roboczych, możesz przełączyć się do innego obszaru roboczego, wybierając nazwę obszaru roboczego w górnej części strony, a następnie wybierz pozycję Zarządzaj wszystkimi obszarami roboczymi.
Jeśli nie masz jeszcze obszaru roboczego, wybierz pozycję + Nowy obszar roboczy, a następnie podaj następujące informacje:
Pole opis Nazwa obszaru roboczego Wprowadź unikatową nazwę, aby zidentyfikować obszar roboczy.
Nazwa może składać się tylko z znaków alfanumerycznych i mieć długość od 3 do 64 znaków.Subskrypcja platformy Azure Wybierz subskrypcję platformy Azure, której chcesz użyć dla tego obszaru roboczego Testowanie dramaturgów firmy Microsoft. Region Wybierz lokalizację geograficzną do hostowania obszaru roboczego.
Jest to lokalizacja, w której są przechowywane dane przebiegu testu dla obszaru roboczego.Wybierz pozycję Utwórz obszar roboczy, aby utworzyć obszar roboczy w ramach subskrypcji.
Podczas tworzenia obszaru roboczego zostanie utworzona nowa grupa zasobów i zasób platformy Azure do testowania playwright firmy Microsoft w ramach subskrypcji platformy Azure.
Po zakończeniu tworzenia obszaru roboczego nastąpi przekierowanie do przewodnika konfiguracji.
Instalowanie pakietu Microsoft Playwright Testing
Aby korzystać z usługi, zainstaluj pakiet Microsoft Playwright Testing.
npm init @azure/microsoft-playwright-testing@latest
Uwaga
Upewnij się, że projekt używa @playwright/test
wersji 1.47 lub nowszej.
To polecenie generuje playwright.service.config.ts
plik, który służy do:
- Bezpośrednie i uwierzytelnianie klienta Playwright w usłudze Microsoft Playwright Testing.
- Dodaje reportera do publikowania wyników testów i artefaktów.
Jeśli masz już ten plik, zostanie wyświetlony monit o zastąpienie go.
Aby użyć tylko funkcji raportowania dla przebiegu testu, wyłącz przeglądarki hostowane w chmurze, ustawiając useCloudHostedBrowsers
wartość 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
}
);
Ustawienie wartości jako false
zapewnia, że przeglądarki hostowane w chmurze nie są używane do uruchamiania testów. Testy są uruchamiane na komputerze lokalnym, ale wyniki i artefakty są publikowane w usłudze.
Aby użyć usługi, zainstaluj pakiet Microsoft Playwright Testing.
dotnet add package Azure.Developer.MicrosoftPlaywrightTesting.NUnit --prerelease
Uwaga
Upewnij się, że projekt używa Microsoft.Playwright.NUnit
wersji 1.47 lub nowszej.
Aby użyć tylko funkcji raportowania, zaktualizuj następujące informacje w .runsettings
pliku projektu:
- Wyłącz przeglądarki hostowane w chmurze, ustawiając wartość
useCloudHostedBrowsers
false. - Dodaj rejestrator testów programu Microsoft Playwright w sekcji "Rejestratory".
<?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>
Napiwek
Jeśli chcesz przyspieszyć przebieg testu przy użyciu przeglądarki hostowanej w chmurze, możesz ustawić useCloudHostedBrowsers
wartość true. Spowoduje to uruchomienie testów w przeglądarkach zarządzanych przez usługę.
Konfigurowanie punktu końcowego regionu usługi
W konfiguracji należy podać punkt końcowy usługi specyficzny dla regionu. Punkt końcowy zależy od regionu świadczenia usługi Azure wybranego podczas tworzenia obszaru roboczego.
Aby uzyskać adres URL punktu końcowego usługi, wykonaj następujące kroki:
W obszarze Dodawanie punktu końcowego regionu w konfiguracji skopiuj punkt końcowy regionu dla obszaru roboczego.
Adres URL punktu końcowego jest zgodny z regionem świadczenia usługi Azure wybranym podczas tworzenia obszaru roboczego. Upewnij się, że ten adres URL jest dostępny w
PLAYWRIGHT_SERVICE_URL
zmiennej środowiskowej.
Konfigurowanie środowiska
Aby skonfigurować środowisko, należy skonfigurować zmienną PLAYWRIGHT_SERVICE_URL
środowiskową z wartością uzyskaną w poprzednich krokach.
Zalecamy użycie modułu dotenv
do zarządzania środowiskiem. Za pomocą dotenv
polecenia zdefiniujesz zmienne środowiskowe w .env
pliku .
dotenv
Dodaj moduł do projektu:npm i --save-dev dotenv
.env
Utwórz plik obokplaywright.config.ts
pliku w projekcie Playwright:PLAYWRIGHT_SERVICE_URL={MY-REGION-ENDPOINT}
Pamiętaj, aby zastąpić
{MY-REGION-ENDPOINT}
symbol zastępczy tekstu skopiowaną wcześniej wartością.
Konfigurowanie konfiguracji usługi
Utwórz plik PlaywrightServiceSetup.cs
w katalogu głównym z następującą zawartością.
using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;
namespace PlaywrightTests; // Remember to change this as per your project namespace
[SetUpFixture]
public class PlaywrightServiceSetup : PlaywrightServiceNUnit {};
Uwaga
Upewnij się, że projekt używa Microsoft.Playwright.NUnit
wersji 1.47 lub nowszej.
Konfigurowanie uwierzytelniania
Aby opublikować wyniki testów i artefakty w obszarze roboczym Testowanie w programie Microsoft Playwright, musisz uwierzytelnić klienta Playwright, w którym są uruchamiane testy z usługą. Klientem może być lokalny komputer deweloperski lub maszyna ciągłej integracji.
Usługa oferuje dwie metody uwierzytelniania: Microsoft Entra ID i Tokeny dostępu.
Identyfikator Entra firmy Microsoft używa poświadczeń platformy Azure, co wymaga zalogowania się do konta platformy Azure w celu uzyskania bezpiecznego dostępu. Alternatywnie możesz wygenerować token dostępu z obszaru roboczego Playwright i użyć go w konfiguracji.
Konfigurowanie uwierzytelniania przy użyciu identyfikatora Entra firmy Microsoft
Identyfikator Entra firmy Microsoft jest domyślnym i zalecanym uwierzytelnianiem dla usługi. Z lokalnego komputera deweloperskiego możesz użyć interfejsu wiersza polecenia platformy Azure do logowania
az login
Uwaga
Jeśli jesteś częścią wielu dzierżaw firmy Microsoft Entra, upewnij się, że logujesz się do dzierżawy, do której należy obszar roboczy. Identyfikator dzierżawy można uzyskać z witryny Azure Portal. Aby uzyskać więcej informacji, zobacz Znajdowanie dzierżawy firmy Microsoft Entra. Po otrzymaniu identyfikatora zaloguj się przy użyciu polecenia az login --tenant <TenantID>
Konfigurowanie uwierzytelniania przy użyciu tokenów dostępu
Możesz wygenerować token dostępu z obszaru roboczego Testowanie dramaturgu i użyć go w konfiguracji. Zdecydowanie zalecamy jednak używanie identyfikatora Entra firmy Microsoft do uwierzytelniania ze względu na jego zwiększone zabezpieczenia. Tokeny dostępu, choć wygodne, działają jak hasła długotrwałe i są bardziej podatne na naruszenie zabezpieczeń.
Uwierzytelnianie przy użyciu tokenów dostępu jest domyślnie wyłączone. Aby użyć, włącz uwierzytelnianie oparte na tokenach dostępu
Uwaga
Zdecydowanie zalecamy używanie identyfikatora Entra firmy Microsoft do uwierzytelniania w usłudze. Jeśli używasz tokenów dostępu, zobacz Jak zarządzać tokenami dostępu
Włączanie artefaktów w konfiguracji dramaturgu
playwright.config.ts
W pliku projektu upewnij się, że zbierasz wszystkie wymagane artefakty.
use: {
trace: 'on-first-retry',
video:'retain-on-failure',
screenshot:'on'
}
Włącz artefakty, takie jak zrzut ekranu, filmy wideo i ślady, które mają być przechwytywane przez dramaturga.
- Aby uzyskać zrzuty ekranu, zobacz przechwytywanie zrzutów ekranu
- Aby uzyskać informacje o filmach wideo, zobacz nagrywanie filmów wideo na potrzeby testów
- Aby uzyskać informacje o śladach, zobacz rejestrowanie śladu
Po zebraniu tych artefaktów dołącz je do TestContext
elementu , aby upewnić się, że są one dostępne w raportach testowych. Aby uzyskać więcej informacji, zobacz nasz przykładowy projekt dla NUnit
Uruchamianie testów i publikowanie wyników testów w programie Microsoft Playwright Testing
Teraz przygotowano konfigurację do publikowania wyników testów i artefaktów za pomocą testowania programu Microsoft Playwright. Uruchom testy przy użyciu nowo utworzonego playwright.service.config.ts
pliku i opublikuj wyniki testów i artefakty w usłudze.
npx playwright test --config=playwright.service.config.ts
Uwaga
W przypadku funkcji Raportowanie testowania dramaturgowego firmy Microsoft są naliczane opłaty na podstawie opublikowanych wyników testu liczbowego. Jeśli jesteś użytkownikiem po raz pierwszy lub rozpoczynasz pracę z bezpłatną wersją próbną, możesz zacząć od opublikowania pojedynczego wyniku testu zamiast pełnego pakietu testowego, aby uniknąć wyczerpania limitów bezpłatnej wersji próbnej.
Po zakończeniu testu możesz wyświetlić stan testu w terminalu.
Running 6 test using 2 worker
5 passed, 1 failed (20.2s)
Test report: https://playwright.microsoft.com/workspaces/<workspace-id>/runs/<run-id>
Teraz przygotowano konfigurację do publikowania wyników testów i artefaktów za pomocą testowania programu Microsoft Playwright. Uruchamianie testów przy użyciu .runsettings
pliku i publikowanie wyników testów i artefaktów w usłudze.
dotnet test --settings:.runsettings
Ustawienia przebiegu testowego są zdefiniowane w .runsettings
pliku. Aby uzyskać więcej informacji, zobacz , jak używać opcji pakietu usługi
Uwaga
W przypadku funkcji Raportowanie testowania dramaturgowego firmy Microsoft są naliczane opłaty na podstawie opublikowanych wyników testu liczbowego. Jeśli jesteś użytkownikiem po raz pierwszy lub rozpoczynasz pracę z bezpłatną wersją próbną, możesz zacząć od opublikowania pojedynczego wyniku testu zamiast pełnego pakietu testowego, aby uniknąć wyczerpania limitów bezpłatnej wersji próbnej.
Po zakończeniu przebiegu testu możesz wyświetlić stan testu w terminalu.
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.
Uwaga
W zależności od rozmiaru zestawu testów mogą zostać naliczone dodatkowe opłaty za wyniki testu wykraczające poza przydzielone wyniki bezpłatnego testu.
Wyświetlanie przebiegów testów i wyników w portalu Playwright
Teraz możesz rozwiązywać problemy z przypadkami testowym, które zakończyły się niepowodzeniem w portalu Playwright.
Po zakończeniu przebiegu testu zostanie wygenerowany link do portalu dramaturgu. Otwórz ten link, aby wyświetlić szczegółowe wyniki testu i skojarzone artefakty. W portalu są wyświetlane podstawowe informacje, w tym:
- Szczegóły kompilacji ciągłej integracji
- Ogólny stan przebiegu testu
- Identyfikator zatwierdzenia połączony z przebiegem testowym
Portal Dramaturg zawiera wszystkie niezbędne informacje dotyczące rozwiązywania problemów. Masz następujące możliwości:
- Przełączanie się między ponownych prób.
- Wyświetl szczegółowe dzienniki błędów, kroki testu i dołączone artefakty, takie jak zrzuty ekranu lub wideo.
- Przejdź bezpośrednio do przeglądarki śledzenia, aby uzyskać głębszą analizę.
Przeglądarka śledzenia umożliwia wizualne przechodzenie przez wykonywanie testów. Masz następujące możliwości:
- Użyj osi czasu, aby umieścić wskaźnik myszy na poszczególnych krokach, ujawniając stan strony przed i po każdej akcji.
- Sprawdź szczegółowe dzienniki, migawki DOM, aktywność sieci, błędy i dane wyjściowe konsoli dla każdego kroku.
Po zakończeniu przebiegu testu otrzymasz link do portalu Playwright w terminalu. Otwórz ten link, aby wyświetlić szczegółowe wyniki testu i skojarzone artefakty. W portalu są wyświetlane podstawowe informacje, w tym:
- Szczegóły kompilacji ciągłej integracji
- Ogólny stan przebiegu testu
- Identyfikator zatwierdzenia połączony z przebiegem testowym
Portal Dramaturg zawiera wszystkie niezbędne informacje dotyczące rozwiązywania problemów. Masz następujące możliwości:
- Wyświetl szczegółowe dzienniki błędów i dołączone artefakty, takie jak zrzuty ekranu lub filmy wideo.
- Przejdź bezpośrednio do przeglądarki śledzenia, aby uzyskać głębszą analizę.
Uwaga
Niektóre metadane, takie jak właściciel, opis i kategoria, nie są obecnie wyświetlane na pulpicie nawigacyjnym usługi. Jeśli masz dodatkowe informacje, które chcesz zobaczyć, prześlij problem z usługą GitHub w naszym repozytorium.
Przeglądarka śledzenia umożliwia wizualne przechodzenie przez wykonywanie testów. Masz następujące możliwości:
- Użyj osi czasu, aby umieścić wskaźnik myszy na poszczególnych krokach, ujawniając stan strony przed i po każdej akcji.
- Sprawdź szczegółowe dzienniki, migawki DOM, aktywność sieci, błędy i dane wyjściowe konsoli dla każdego kroku.
Napiwek
Możesz również użyć usługi Microsoft Playwright Testing, aby uruchamiać testy równolegle przy użyciu przeglądarek hostowanych w chmurze. Zarówno przeglądarki raportowania, jak i hostowane w chmurze są niezależnymi funkcjami i są rozliczane oddzielnie. Możesz użyć jednego z tych lub obu tych elementów. Aby uzyskać szczegółowe informacje, zobacz How to use service features (Jak korzystać z funkcji usługi)
Uwaga
Wyniki testów i artefakty, które publikujesz, są przechowywane w usłudze przez 90 dni. Następnie zostaną one automatycznie usunięte.
Następny krok
Pomyślnie utworzono obszar roboczy Microsoft Playwright Testing w portalu Playwright i uruchomiono testy playwrighta w przeglądarkach w chmurze.
Przejdź do następnego przewodnika Szybki start, aby skonfigurować ciągłe kompleksowe testowanie, uruchamiając testy playwright w przepływie pracy ciągłej integracji/ciągłego wdrażania.