Introduce Playwright for simple integration tests #2455

lightswitch05 · 2022-12-10T17:33:47Z

What does this PR aim to accomplish?:

I've been playing around with Playwright E2E testing at work, and I thought it might be fun to see if I could add some tests here. I have absolutely no idea if this appeals to anyone here, and I realize that I didn't really discuss it first, but perhaps we can discuss it now, and no hard feelings if it isn't really inline with the project.

How does this PR accomplish the above?:

There is a lot in here, and so I'm going to make a bunch of comments on the individual files to perhaps make it more clear. The overall idea is to start up a Pihole docker container with this repo volume-mounted within it. Next, startup a playwright docker container to run tests against the Pihole. Playwright does not have to be ran from docker, but I thought it made networking simple in this case.

There are only two tests in here at the moment, and they are very basic. The majority of this PR is just all setup, if y'all like this PR and accept the changes, then it wouldn't be much more work to expand out the tests to hit more pages.

What documentation changes (if any) are needed to support this PR?:

n/a, or perhaps make a note about having docker-compose and running ./tests/run

By submitting this pull request, I confirm the following:

I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
I have commented my proposed changes within the code and I have tested my changes.
I am willing to help maintain this change if there are issues with it later.
It is compatible with the EUPL 1.2 license
I have squashed any insignificant commits. (git rebase)

I have read the above and my PR is ready for review. Check this box to confirm

lightswitch05 · 2022-12-10T17:34:34Z

tests/docker-compose.yml

+  dev-pihole:
+    image: ghcr.io/pi-hole/pihole:latest
+    volumes:
+      - ../:/var/www/html/admin:ro


To have functional frontend tests, you need a backend too. I achieved this by using the official docker image and overlaying the repo code.

lightswitch05 · 2022-12-10T17:35:21Z

tests/global-setup.ts

+  // Save signed-in state to 'storageState.json'.
+  await page.context().storageState({ path: 'storageState.json' });
+  await browser.close();
+}


All this setup does is log into the Pihole a single time and then extracts the cookies so that the different browsers and tests do not also have to login multiple times

tests/playwright.config.ts

tests/run

tests/admin-pages.ts

tests/docker-compose.yml

…sons Signed-off-by: Daniel <daniel@developerdan.com>