Page MenuHomePhabricator
Create Task
Maniphest T308520

Standardize JEST unit test names and definition
Closed, ResolvedPublic1 Estimated Story Points
Actions

Description

As a developer, I would like the unit test to be well structured so that I will easily be able to contribute and add more unit tests and/or modify existing one while working on codex.

Context
The current Jest unit test do not have a common structure and can be hard to contribute too. An example can be the lookup tests. This file is very well tested, but all tests are set in one big group. A developer would need to read all the tests to make sure he can add a new one without duplication.

Change proposes
A suggested change would be to separate the tests into different groups. This can easily be done using nested describes. Furthermore this will allow the test itself to also be simplified as it will allow setup tests to be added into its own group.

  • Break up tests into groups
  • Update the Documentation to explain how to write and breakup tests
  • Simplify tests by moving reusable setup

Details

Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 17 2022, 8:20 AM
DannyS712 subscribed.May 20 2022, 2:12 AM

Simplify tests by moving reusable setup

I have a patch pending, https://gerrit.wikimedia.org/r/c/design/codex/+/789841, that seeks to do this by adding shortcut expectations for common parts of a test, like that an element is visible. If you want to take a look

AnneT subscribed.Jun 6 2022, 7:52 PM
SimoneThisDot added a comment.Jun 15 2022, 10:09 AM

Thank you @DannyS712 , I was refering more to increase the use of "beforeEach" and "afterEach" to define standard components and props.

gerritbot added a comment.Jul 7 2022, 1:48 PM

Change 811997 had a related patch set uploaded (by Simone Cuomo; author: Simone Cuomo):

[design/codex@main] [POC] Standardize JEST unit test names and definition

https://gerrit.wikimedia.org/r/811997

gerritbot added a project: Patch-For-Review.Jul 7 2022, 1:48 PM
SimoneThisDot added a comment.Jul 7 2022, 1:49 PM

I have created a POC patch with updated documentation to be used as a discussion point in JEST writing standards.

The suggestions are very opinionated and should be agreed upon within the team (to be discussed during engineer enclave)

gerritbot added a comment.Jul 26 2022, 7:50 PM

Change 817370 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Reorganize Checkbox tests per new standards

https://gerrit.wikimedia.org/r/817370

gerritbot added a comment.Jul 26 2022, 7:50 PM

Change 817371 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: reorganize Lookup tests per new standards

https://gerrit.wikimedia.org/r/817371

AnneT added a comment.Jul 26 2022, 8:05 PM

I've pushed patches to demonstrate some of Simone's recommendations:

  • Checkbox: this is a pretty simple test file and the patch mostly shows how basic organization can help, and how the sentences formed by the "given, when, then" notation are nice both for test file readibility and pinpointing issues when a test fails
  • Lookup: this is a more complex test file and the reorganization led to a lot of significant changes and, IMO, improvements that allow you to get a clearer picture of what's being tested and what is covered by tests when you look at the file. I also updated all the tests that look at whether the menu is expanded to test the actual visibility of the menu, rather than the value of the expanded data property.

Some other notes:

  • There's a lot of leeway in terms of how closely we follow the "given, when, then" notation. For example, I decided not to have more than 3 describe blocks (including the first one, which just includes the name of the component), so in a couple of cases for Lookup, I included another "when" statement in the "then" part. Here's an example of that:
// '...' represents code removed for brevity
describe( 'Lookup', () => {
	describe( 'when the text input is focused', () => {
		...

		describe( 'and there are no menu items to show', () => {
			...

			it( 'if there is no-results slot content, opens menu and shows "no results" message', async () => {
				...
			} );
		} );
	} );
} );
  • One thing I haven't covered in these files is shared code in beforeEach and afterEach. TypeaheadSearch would be a good candidate for demonstrating that, as it already does this to some extent.
AnneT changed the task status from Open to In Progress.Aug 18 2022, 3:18 PM
AnneT claimed this task.
AnneT mentioned this in T311244: Lower the burden of contributing code to Codex.Aug 18 2022, 4:18 PM
gerritbot added a comment.Aug 24 2022, 10:02 PM

Change 811997 merged by jenkins-bot:

[design/codex@main] docs: Standardize JEST unit test names and structure

https://gerrit.wikimedia.org/r/811997

gerritbot added a comment.Aug 24 2022, 10:02 PM

Change 817370 merged by jenkins-bot:

[design/codex@main] tests: Reorganize Checkbox tests per new standards

https://gerrit.wikimedia.org/r/817370

gerritbot added a comment.Aug 24 2022, 10:07 PM

Change 817371 merged by jenkins-bot:

[design/codex@main] tests: reorganize Lookup tests per new standards

https://gerrit.wikimedia.org/r/817371

Maintenance_bot removed a project: Patch-For-Review.Aug 24 2022, 10:30 PM
gerritbot added a comment.Aug 30 2022, 8:04 PM

Change 828083 had a related patch set uploaded (by Catrope; author: Catrope):

[mediawiki/core@master] Update Codex from v0.1.0-alpha.10 to v0.1.0

https://gerrit.wikimedia.org/r/828083

gerritbot added a project: Patch-For-Review.Aug 30 2022, 8:04 PM
gerritbot added a comment.Aug 31 2022, 10:09 PM

Change 828083 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.1.0-alpha.10 to v0.1.1

https://gerrit.wikimedia.org/r/828083

Maintenance_bot removed a project: Patch-For-Review.Aug 31 2022, 10:30 PM
ldelench_wmf added a parent task: T311244: Lower the burden of contributing code to Codex.Sep 1 2022, 11:56 AM
ldelench_wmf triaged this task as High priority.Sep 1 2022, 12:19 PM
ldelench_wmf edited projects, added Design-System-Team (Design-System-Sprint); removed Design-System-Team.
ldelench_wmf moved this task from Committed to In Development on the Design-System-Team (Design-System-Sprint) board.
ldelench_wmf subscribed.

Hey @AnneT , moved this one into the sprint board since it appears to be in progress - feel free to adjust if that's not correct!

AnneT edited projects, added Design-System-Team; removed Design-System-Team (Design-System-Sprint).Sep 12 2022, 4:24 PM
AnneT moved this task from Inbox to Backlog on the Design-System-Team board.

Moving this to the backlog as we will continue converting existing test files to this format as we have time.

ldelench_wmf set the point value for this task to 1.Sep 19 2022, 3:37 PM
egardner lowered the priority of this task from High to Low.Jan 23 2023, 5:20 PM
ldelench_wmf moved this task from Backlog to Contributor Experience on the Codex board.Feb 17 2023, 4:20 PM
gerritbot added a comment.Feb 23 2023, 7:54 PM

Change 891613 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] code: Clean up TextInput files

https://gerrit.wikimedia.org/r/891613

gerritbot added a project: Patch-For-Review.Feb 23 2023, 7:54 PM
gerritbot added a comment.Feb 23 2023, 11:26 PM

Change 891613 merged by jenkins-bot:

[design/codex@main] code: Clean up TextInput files

https://gerrit.wikimedia.org/r/891613

Maintenance_bot removed a project: Patch-For-Review.Feb 23 2023, 11:30 PM
gerritbot added a comment.Feb 28 2023, 8:01 PM

Change 893051 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/core@master] Update Codex from v0.6.0 to v0.6.2

https://gerrit.wikimedia.org/r/893051

gerritbot added a project: Patch-For-Review.Feb 28 2023, 8:01 PM
gerritbot added a comment.Feb 28 2023, 8:39 PM

Change 893051 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.6.0 to v0.6.2

https://gerrit.wikimedia.org/r/893051

Maintenance_bot removed a project: Patch-For-Review.Feb 28 2023, 9:13 PM
gerritbot added a comment.Jun 17 2024, 9:51 PM

Change #1046782 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] Menu: Refactor tests using given-when-then structure

https://gerrit.wikimedia.org/r/1046782

gerritbot added a project: Patch-For-Review.Jun 17 2024, 9:51 PM
gerritbot added a comment.Jun 18 2024, 10:25 PM

Change #1046782 merged by jenkins-bot:

[design/codex@main] Menu: Refactor tests using given-when-then structure

https://gerrit.wikimedia.org/r/1046782

Maintenance_bot removed a project: Patch-For-Review.Jun 18 2024, 10:31 PM
gerritbot added a comment.Jun 25 2024, 9:23 PM

Change #1049640 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[mediawiki/core@master] Update Codex from 1.7.0 to 1.8.0

https://gerrit.wikimedia.org/r/1049640

gerritbot added a project: Patch-For-Review.Jun 25 2024, 9:23 PM
PatchDemoBot added a comment.Jun 25 2024, 9:34 PM

Test wiki created on Patch demo by EGardner (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/f74be9bc8e/w

gerritbot added a comment.Jun 25 2024, 10:25 PM

Change #1049640 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from 1.7.0 to 1.8.0

https://gerrit.wikimedia.org/r/1049640

Maintenance_bot removed a project: Patch-For-Review.Jun 25 2024, 10:31 PM
AnneT moved this task from Backlog to Hack Week on the Design-System-Team board.Aug 5 2024, 12:51 PM
CCiufo-WMF moved this task from Hack Week to Backlog on the Design-System-Team board.Aug 21 2024, 7:51 PM
Aklapper changed the task status from In Progress to Open.Mar 22 2025, 7:25 AM

Resetting task status from "In Progress" to "Open" as this task has been "in progress" for more than two years.

PatchDemoBot added a comment.May 20 2025, 12:12 PM

Test wiki on Patch demo by EGardner (WMF) using patch(es) linked to this task was deleted:

https://patchdemo-legacy.wmcloud.org/wikis/f74be9bc8e/w/

CCiufo-WMF moved this task from Contributor Experience to Backlog on the Codex board.May 30 2025, 6:52 PM
gerritbot added a comment.Jun 2 2025, 1:04 PM

Change #1152683 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Update tests in docs package

https://gerrit.wikimedia.org/r/1152683

gerritbot added a project: Patch-For-Review.Jun 2 2025, 1:04 PM

Change #1152684 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Update tests for composables

https://gerrit.wikimedia.org/r/1152684

gerritbot added a comment.Jun 2 2025, 1:23 PM

Change #1152689 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests, Combobox, MenuButton: Add snapshot tests

https://gerrit.wikimedia.org/r/1152689

gerritbot added a comment.Jun 2 2025, 1:26 PM

Change #1152691 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Fix snapshot test props, reorganize tests

https://gerrit.wikimedia.org/r/1152691

gerritbot added a comment.Jun 2 2025, 1:28 PM

Change #1152692 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Reorganize tests and remove unneeded ones

https://gerrit.wikimedia.org/r/1152692

gerritbot added a comment.Jun 2 2025, 1:30 PM

Change #1152695 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] tests: Reorganize unit tests

https://gerrit.wikimedia.org/r/1152695

AnneT changed the task status from Open to In Progress.Jun 2 2025, 1:38 PM
AnneT updated the task description. (Show Details)
AnneT moved this task from Backlog to DST-Housekeeping-Week (2025-05-27 to 2025-05-30) on the Design-System-Team board.
AnneT edited projects, added Design-System-Team (DST-Housekeeping-Week (2025-05-27 to 2025-05-30)); removed Design-System-Team.
gerritbot added a comment.Jun 2 2025, 1:41 PM

Change #1152683 merged by jenkins-bot:

[design/codex@main] tests: Update tests in docs package

https://gerrit.wikimedia.org/r/1152683

gerritbot added a comment.Jun 2 2025, 1:47 PM

Change #1152684 merged by jenkins-bot:

[design/codex@main] tests: Update tests for composables

https://gerrit.wikimedia.org/r/1152684

CCiufo-WMF moved this task from Backlog to In Progress on the Codex board.Jun 2 2025, 4:24 PM
gerritbot added a comment.Jun 2 2025, 4:58 PM

Change #1152778 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] Update Codex from v2.0.0-rc.2 to v2.0.0

https://gerrit.wikimedia.org/r/1152778

CCiufo-WMF moved this task from In Progress to Code Review on the Codex board.Jun 2 2025, 5:04 PM
CCiufo-WMF moved this task from DST-Housekeeping-Week (2025-05-27 to 2025-05-30) to Up Next on the Design-System-Team board.Jun 2 2025, 5:22 PM
CCiufo-WMF edited projects, added Design-System-Team; removed Design-System-Team (DST-Housekeeping-Week (2025-05-27 to 2025-05-30)).
gerritbot added a comment.Jun 2 2025, 6:23 PM

Change #1152778 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v2.0.0-rc.2 to v2.0.0

https://gerrit.wikimedia.org/r/1152778

gerritbot added a comment.Jun 5 2025, 9:16 PM

Change #1152692 merged by jenkins-bot:

[design/codex@main] tests: Reorganize tests and remove unneeded ones

https://gerrit.wikimedia.org/r/1152692

gerritbot added a comment.Wed, Jun 11, 4:51 PM

Change #1155734 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[mediawiki/core@master] Update Codex from v2.0.0 to v2.1.0

https://gerrit.wikimedia.org/r/1155734

PatchDemoBot added a comment.Wed, Jun 11, 4:55 PM

Test wiki created on Patch demo by BWang (WMF) using patch(es) linked to this task:
https://patchdemo.wmcloud.org/wikis/25f905bb47/w/

gerritbot added a comment.Wed, Jun 11, 8:12 PM

Change #1155734 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v2.0.0 to v2.1.0

https://gerrit.wikimedia.org/r/1155734

gerritbot added a comment.Mon, Jun 16, 8:57 PM

Change #1152695 merged by jenkins-bot:

[design/codex@main] tests: Reorganize unit tests

https://gerrit.wikimedia.org/r/1152695

gerritbot added a comment.Wed, Jun 18, 1:57 PM

Change #1152689 merged by jenkins-bot:

[design/codex@main] tests, Combobox, MenuButton: Add snapshot tests

https://gerrit.wikimedia.org/r/1152689

gerritbot added a comment.Wed, Jun 18, 4:46 PM

Change #1152691 merged by jenkins-bot:

[design/codex@main] tests: Fix snapshot test props, reorganize tests

https://gerrit.wikimedia.org/r/1152691

Maintenance_bot removed a project: Patch-For-Review.Wed, Jun 18, 5:30 PM
lwatson moved this task from Code Review to Pending Release on the Codex board.Mon, Jun 23, 4:37 PM
Aklapper removed AnneT as the assignee of this task.Tue, Jun 24, 12:04 PM

@AnneT Removing task assignee as this open task has been assigned for more than two years - See the email sent on 2025-05-22.
Please assign this task to yourself again if you still realistically [plan to] work on this task - it would be welcome!
If this task has been resolved in the meantime, or should not be worked on by anybody ("declined"), please update its task status via "Add Action… 🡒 Change Status".
Also see https://www.mediawiki.org/wiki/Bug_management/Assignee_cleanup for tips how to best manage your individual work in Phabricator. Thanks!

AnneT claimed this task.EditedTue, Jun 24, 1:10 PM

This task has been recently resolved and will be closed after the next Codex release

gerritbot added a comment.Tue, Jun 24, 8:28 PM

Change #1163459 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] Update Codex from v2.1.0 to v2.2.0

https://gerrit.wikimedia.org/r/1163459

gerritbot added a project: Patch-For-Review.Tue, Jun 24, 8:28 PM
gerritbot added a comment.Tue, Jun 24, 9:15 PM

Change #1163459 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v2.1.0 to v2.2.0

https://gerrit.wikimedia.org/r/1163459

Maintenance_bot removed a project: Patch-For-Review.Tue, Jun 24, 9:33 PM
AnneT closed this task as Resolved.Tue, Jun 24, 9:55 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits