From fd21c571243d0c9a8361c0cb04912dfa1a35d58b Mon Sep 17 00:00:00 2001 From: Jonah Paten Date: Sun, 18 Aug 2024 18:37:52 -0700 Subject: [PATCH] chore: corrected typos in testReadme.md (#4076) --- explorer/e2e/testReadme.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/explorer/e2e/testReadme.md b/explorer/e2e/testReadme.md index 7ef02e5d5..6cac798fd 100644 --- a/explorer/e2e/testReadme.md +++ b/explorer/e2e/testReadme.md @@ -7,33 +7,33 @@ Tests for a specific configuration are stored as `config_name/config_name-test_n that Playwright actually runs, most test code is stored in `e2e/testFunctions.ts`. These functions contain the code that runs for all tests, except for tests that are not reused between configurations and that only run in one tab. This allows tests to be repeated for different tabs in different configurations without reusing code, and means that information that tests -depend on can be stored in one place to make adjusting tests to changes in user facing content is straightforward. -Config specific constants used for tests are kept in the `config_name/config_name-tabs.ts`, and use interfaces and +depend on can be stored in one place to make adjusting tests to changes in user-facing content straightforward. +Config-specific constants used for tests are kept in the `config_name/config_name-tabs.ts`, and use interfaces and custom types in `testInterfaces.ts`. -### Running tests +### Running Tests #### Running Locally To run all tests locally, run `npm run test:anvil-cmg` or `npm run test:anvil-catalog`. If there is no server running on `localhost:3000`, this will create a dev build of the correct configuration and run the tests on Chromium, Firefox, and Webkit (Safari). The tests may be flaky -if run on the `dev:config` version instead of a dev build, as the site will run too slow and they may time out. Traces +if run on the `dev:` version instead of a dev build, as the site will run too slow and they may time out. Traces and screenshots from any tests that fail will be output to `explorer/playwright-report`. To manually run an individual test file, run `npx playwright test e2e/path-to/filename.spec.ts -c `. The available config files are `playwright_anvil.config.ts` and `playwright_anvil-catalog.config.ts`. To run an individual test, add the argument `-g `. More information about command line options for the test can be found in [Playwright's Documentation](https://playwright.dev/docs/test-cli). To debug or write tests, it can be useful to use Playwright's UI mode with `npx playwright test --ui`, which allows you -to easily run individual tests, and view the actions Playwright takes step by step in and their result. +to easily run individual tests, and view the actions Playwright takes step by step and their result. #### Running in GitHub -All tests are run automatically when a pull request is made, using GitHub Actions. These actions create a development build +All tests are run automatically when a pull request is made, using GitHub Actions. These actions create a dev build for each configuration, then run the test. When a test passes, it will become visible on GitHub. If one fails, screenshots and traces can be downloaded from GitHub. To view step by step what happened in the test, visit `trace.playwright.dev` in a web browser and upload the `trace.zip` file. This web app, which runs entirely in browser, allows you to step through the actions taken as part of the test and view the impact on the web page. -### Current tests +### Current Tests #### AnVIL-CMG @@ -42,20 +42,20 @@ through the actions taken as part of the test and view the impact on the web pag - This filter runs on all tabs in `anviltabs.ts` - Check that checking up to the first five entries in the first filter on the datasets tab works and that it does not remove all elements from the list of tabs - Check that selecting a filter causes the selected checkbox entries to remain selected across all tabs - - Currently uses the 4th filter and starts on the "files" tab + - Currently uses the fourth filter and starts on the "files" tab - Check that the counts next to the filter checkbox match the number of entries once the filter is selected - - Checks an arbitrary list of 6 filters on the datasets and activities tab - - Check that the blue filter buttons appear with the correct text when the filter is selected, and that they cause the filter to become deselected when clicked - - Checks an arbitrary list of 3 filters on the "files" and "biosamples" tabs + - Checks an arbitrary list of six filters on the datasets and activities tab + - Check that the filter tabs appear with the correct text when the filter is selected, and that they cause the filter to become deselected when clicked + - Checks an arbitrary list of three filters on the "files" and "biosamples" tabs - Check that the clear all button deselects all filters, after an arbitrary list is selected - - Uses an arbitrary list of 3 filters and runs on the "files tab" + - Uses an arbitrary list of three filters and runs on the "files tab" - Pagination (`anvil-pagination.spec.ts` and `anvil-pagination-content.spec.ts`) - Check that, on the first page, the back button is disabled and the forward button is enabled - Uses the "Donors" tab only - Check that paginating forward on the donors tab keeps the currently displayed page number correct, and that on the last page the back button is enabled and the front page is enabled - Uses the "Donors" tab only - NOTE: this test may be problematic because it assumes there is relatively short number of pages on the "Donors" tab. This could potentially be resolved by adding filters or by limiting the number of tests run - - Check that paginating forwards by up to 5 pages changes the content on the first row of the table, and that paginating backwards causes that text to remain the same + - Check that paginating forwards by up to five pages changes the content on the first row of the table, and that paginating backwards causes that text to remain the same - Uses the "BioSamples" tab only - Sort (`anvil-sort.spec.ts`) - Check that clicking each table header (the sort button) does not cause the first and last rows of the table to become empty @@ -69,7 +69,7 @@ through the actions taken as part of the test and view the impact on the web pag - Check that selecting a different tab changes the current url and that each tab has the correct data headers - Runs from "Datasets" to "Activities", "Activities" to "Datasets", "Datasets" to "Files", "Datasets" to "Donors", "Datasets" to "Biosamples" - `anvil-tabs-buttons.spec.ts` - - All tests rely on correct lists of tabs, columns, and filters in `testFunctions.ts` + - All tests rely on correct lists of tabs, columns, and filters in `anvil-tabs.ts` #### AnVIL-Catalog @@ -86,15 +86,16 @@ through the actions taken as part of the test and view the impact on the web pag - Runs on all tabs - Check that selecting all checkboxes in the Edit Columns menu adds the correct headets to the table - Only runs on the "Consortia" tab (other tabs do not have editable columns) +- All tests rely on correct lists of tabs, columns, and filters in `anvilcatalog-tabs.ts` ### Candidate Additional Tests (anvil-cmg): - File download - File copy button -- Top Counts (# activities, files, biosamples) +- Top counts (# activities, files, biosamples) - Sign in (probably smoke test / existence only for ease) - "Contact Us" form -- Edit Columns Button (already on AnVIL-Catalog) +- Edit columns Button (already on AnVIL-Catalog) - Datasets backpages - Check that "Dataset details" match relevant fields in the table - Check access control works properly