Jpaten/4076 add list of current and candidate tests #4077

jpaten · 2024-07-22T19:59:52Z

Ticket

Closes #4076 .

Reviewers

@MillenniumFalconMechanic .

Changes

Added a Readme file for tests, including a list of existing and candidate tests and information about how to run tests

Note: This PR should not be merged before #4071

MillenniumFalconMechanic

LGTM, thanks Jonah! I have added a couple of suggestions for your review. One nit: could you go through and standardize capitalization and quotation of tab names?

MillenniumFalconMechanic · 2024-08-13T21:05:17Z

explorer/e2e/testReadme.md

+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.


Suggested change

depend on can be stored in one place to make adjusting tests to changes in user facing content is straightforward.

depend on can be stored in one place to make adjusting tests to changes in user-facing content straightforward.

MillenniumFalconMechanic · 2024-08-13T21:05:33Z

explorer/e2e/testReadme.md

+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


Suggested change

Config specific constants used for tests are kept in the `config_name/config_name-tabs.ts`, and use interfaces and

Config-specific constants used for tests are kept in the `config_name/config_name-tabs.ts`, and use interfaces and

MillenniumFalconMechanic · 2024-08-13T21:05:42Z

explorer/e2e/testReadme.md

+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


Suggested change

### Running tests

### Running Tests

MillenniumFalconMechanic · 2024-08-13T21:06:59Z

explorer/e2e/testReadme.md

+and `playwright_anvil-catalog.config.ts`. To run an individual test, add the argument `-g <test_name>`. 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.


Suggested change

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.

MillenniumFalconMechanic · 2024-08-13T21:07:31Z

explorer/e2e/testReadme.md

+
+#### Running in GitHub
+
+All tests are run automatically when a pull request is made, using GitHub Actions. These actions create a development build


Suggested change

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

^ Keeps the language consistent with above?

MillenniumFalconMechanic · 2024-08-15T16:52:39Z

explorer/e2e/testReadme.md

+  - 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
+  - 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


Suggested change

- Checks an arbitrary list of 6 filters on the datasets and activities tab

- Checks an arbitrary list of six filters on the datasets and activities tab

MillenniumFalconMechanic · 2024-08-15T16:53:01Z

explorer/e2e/testReadme.md

+    - Currently uses the 4th 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


Suggested change

- 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

- Check that the blue filter tags appear with the correct text when the filter is selected, and that they cause the filter to become deselected when clicked

MillenniumFalconMechanic · 2024-08-15T16:53:10Z

explorer/e2e/testReadme.md

+  - 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


Suggested change

- Checks an arbitrary list of 3 filters on the "files" and "biosamples" tabs

- Checks an arbitrary list of three filters on the "files" and "biosamples" tabs

MillenniumFalconMechanic · 2024-08-15T16:53:23Z

explorer/e2e/testReadme.md

+  - 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
+  - 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"


Suggested change

- 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"

MillenniumFalconMechanic · 2024-08-15T16:54:22Z

explorer/e2e/testReadme.md

+  - 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


Suggested change

- 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

MillenniumFalconMechanic

LGTM, thanks Jonah!

(#4076)

jpaten requested a review from MillenniumFalconMechanic July 22, 2024 19:59

jpaten linked an issue Jul 22, 2024 that may be closed by this pull request

Add list of current and candidate tests #4076

Closed

github-actions bot added the canary Done by the Clever Canary team label Jul 22, 2024

MillenniumFalconMechanic requested changes Aug 15, 2024

View reviewed changes

jpaten force-pushed the jpaten/4076-add-list-of-current-and-candidate-tests branch from fd21c57 to bb86679 Compare August 19, 2024 01:54

jpaten requested a review from MillenniumFalconMechanic August 19, 2024 19:40

jpaten force-pushed the jpaten/4076-add-list-of-current-and-candidate-tests branch from bb86679 to 587cfc2 Compare August 19, 2024 19:42

MillenniumFalconMechanic approved these changes Aug 22, 2024

View reviewed changes

jpaten closed this Aug 23, 2024

jpaten force-pushed the jpaten/4076-add-list-of-current-and-candidate-tests branch from 587cfc2 to 7657375 Compare August 23, 2024 04:20

test: added test readme (#4076)

632bd7d

jpaten reopened this Aug 23, 2024

test: standardized capitalization of tabs in testReadme.md

c609221

(#4076)

jpaten merged commit b34f6e1 into main Aug 23, 2024
4 checks passed

jpaten deleted the jpaten/4076-add-list-of-current-and-candidate-tests branch August 23, 2024 04:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jpaten/4076 add list of current and candidate tests #4077

Jpaten/4076 add list of current and candidate tests #4077

jpaten commented Jul 22, 2024

MillenniumFalconMechanic left a comment

MillenniumFalconMechanic Aug 13, 2024

MillenniumFalconMechanic Aug 13, 2024

MillenniumFalconMechanic Aug 13, 2024

MillenniumFalconMechanic Aug 13, 2024

MillenniumFalconMechanic Aug 13, 2024

MillenniumFalconMechanic Aug 15, 2024

MillenniumFalconMechanic Aug 15, 2024

MillenniumFalconMechanic Aug 15, 2024

MillenniumFalconMechanic Aug 15, 2024

MillenniumFalconMechanic Aug 15, 2024

MillenniumFalconMechanic left a comment

	depend on can be stored in one place to make adjusting tests to changes in user facing content is straightforward.
	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
	Config-specific constants used for tests are kept in the `config_name/config_name-tabs.ts`, and use interfaces and

	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

	- Checks an arbitrary list of 6 filters on the datasets and activities tab
	- Checks an arbitrary list of six 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
	- Check that the blue filter tags 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 three filters on the "files" and "biosamples" tabs

	- 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"

	- 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

Jpaten/4076 add list of current and candidate tests #4077

Jpaten/4076 add list of current and candidate tests #4077

Conversation

jpaten commented Jul 22, 2024

Ticket

Reviewers

Changes

MillenniumFalconMechanic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MillenniumFalconMechanic left a comment

Choose a reason for hiding this comment