Chore: Improve Playwright documentation (#110022)

2025-08-28 17:16:19 +02:00
parent 7a8010be0c
commit b92f007894
5 changed files with 304 additions and 310 deletions
@@ -224,57 +224,19 @@ make test-go-integration-postgres

 ### Run end-to-end tests

-Grafana uses [Cypress](https://www.cypress.io/) to end-to-end test core features. Core plugins use [Playwright](https://playwright.dev/) to run automated end-to-end tests. You can find more information on how to add end-to-end tests to your core plugin [in our end-to-end testing style guide](./style-guides/e2e-plugins.md)
+- Grafana uses [Playwright](https://playwright.dev/) to run automated end-to-end tests. You can find more information [in our end-to-end testing style guide](./style-guides/e2e-playwright.md#playwright-for-plugins)

-#### Run Cypress tests
+- Each version of Playwright needs specific versions of browser binaries to operate. You need to use the Playwright CLI to install these browsers: `yarn playwright install chromium`.
+- Run tests with `yarn e2e:playwright [optional path to test file]`.

-To run all tests in a headless Chromium browser.
+- To open the last HTML report, you can run `yarn playwright show-report`. You can also open an arbitrary report with `yarn playwright show-report <reportLocation>`. The reports are also downloadable from CI by:
+  - Clicking through to _End-to-end tests_/_All Playwright tests complete_.
+  - Clicking _Summary_.
+  - Download the _playwright-html-<number>_ artifact.
+  - Unzip.
+  - Run `yarn playwright show-report <reportLocation>`

-```
-yarn e2e
-```
-
-By default, the end-to-end tests start a Grafana instance listening on `localhost:3001`. To use a different URL, set the `BASE_URL` environment variable:
-
-```
-BASE_URL=http://localhost:3333 yarn e2e
-```
-
-To follow all tests in the browser while they're running, use `yarn e2e:debug`
-
-```
-yarn e2e:debug
-```
-
-To choose a single test to follow in the browser as it runs, use `yarn e2e:dev`
-
-```
-yarn e2e:dev
-```
-
-#### To run the Playwright tests:
-
-**Note:** If you're using VS Code as your development editor, it's recommended to install the [Playwright test extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright). It allows you to run, debug and generate Playwright tests from within the editor. For more information about the extension and how to use reports to analyze failing tests, refer to the [Playwright documentation](https://playwright.dev/docs/getting-started-vscode).
-
-Each version of Playwright needs specific versions of browser binaries to operate. You need to use the Playwright CLI to install these browsers.
-
-```
-yarn playwright install chromium
-```
-
-The following script starts a Grafana [development server](https://github.com/grafana/grafana/blob/main/scripts/grafana-server/start-server) (same server that is being used when running e2e tests in CI) on port 3001 and runs all the Playwright tests. The development server is provisioned with the [devenv](https://github.com/grafana/grafana/blob/main/contribute/developer-guide.md#add-data-sources) dashboards, data sources and apps.
-
-```
-yarn e2e:playwright
-```
-
-You can run against an arbitrary instance by setting the `GRAFANA_URL` environment variable:
-
-```
-GRAFANA_URL=http://localhost:3000 yarn e2e:playwright
-```
-
-Note this will not start a development server, so you must ensure that Grafana is running and accessible at the specified URL.
+If you are curious about other commands, you can see the full list in [the Playwright documentation](https://playwright.dev/docs/test-cli#all-options).

 ## Configure Grafana for development