Selenium Screenshots

Overview

As part of our end-to-end(E2E) test suite, we have the capability of taking screenshots on every test run. This is useful for verifying that the design of a page did not break as a result of changes in other parts of the site that are otherwise difficult to test using only XPath in JUnit. When running tests locally, they can be found in the target/screenshots directory after running the full test suite. Note that you will need a compatible version of Google Chrome installed and full administrative privileges on the system you are running on (MacOS may also require permissions to record your screen).

How To Access On GitHub Actions

1. Open a pull request on GitHub and wait for the PR checks to complete.

2. Click the Details link next to the Build / build (pull_request) entry in the checks field.
3. On the left, click Summary.

4. At the bottom of the page, there should be a section called Artifacts. Click the screenshots entry to download the ZIP file of the screen captures. Note that if you do not see any artifacts listed, it may be because artifacts are only hosted for three days after the pipeline job was run. You may need to re-run the job to see the artifacts appear again.

5. In the ZIP file, you should see an image for every page listed in the screenshot capture test.

How To Add Your Page

1. Navigate to src/test/java/com/virtudoc/web/E2EWalkthroughTest.java in your IDE of choice.
2. If your page is publicly accessible (i.e. does not require a login), add the relative URL to your page to the @ValueSource(...) annotation for the screenshotPublicPages(String) test. If your page requires authentication, you will need to create a new test that correctly goes through the login sequence before visiting your page. To take a screenshot, call the takeScreenshot(String) function.