fix: rule tester ignore irrelevant test case properties #18235

DMartens · 2024-03-27T20:54:05Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain: Rule Tester

What changes did you make? (Give an overview)

Fixes #18173.
Ignore the properties name, errors and output as they are irrelevant when checking for duplicate test cases by using the replacer argument of the JSON stringifier.
Unfortunately the custom JSON stringifier does not support the array form of the JSON.stringify replacer.
Also normalized valid string test cases to the object form, as otherwise the following would not be detected:

ruleTester.run('Undetected', rule, {
	valid: [
		'same',
		{ code: 'same' },
	],
	invalid: [],
})

Is there anything you'd like reviewers to focus on?

Some additional duplicate test cases of core rules were flagged and I tried to resolve the errors the best I could.
For example some test cases checked only the location and later other properties were tested.
Rather than merging the test cases, I opted to change the identifier names to keep the intent of the test cases.

eslint-github-bot · 2024-03-27T20:54:10Z

Hi @DMartens!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

netlify · 2024-03-27T20:54:22Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`9a92dd1`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/660c7429efe8e80008304903

eslint-github-bot · 2024-03-27T21:45:27Z

Hi @DMartens!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

aladdin-add

just a question about the tests, otherwise LGTM! 👍

tests/lib/rules/accessor-pairs.js

tests/lib/rules/no-useless-backreference.js

mdjermanovic · 2024-03-28T08:26:30Z

lib/rule-tester/rule-tester.js

+ const normalizedItem = typeof item === "string" ? { code: item } : item;
+ const serializedTestCase = stringify(normalizedItem, { replacer: (key, value) => (!duplicationIgnoredParameters.has(key) ? value : void 0) });


We should only exclude top-level test case properties. Otherwise, if the rule has options with these names, test cases like the following would be mistakenly detected as duplicates:

{ code: "var foo;", options: [{ name: "bar" }] }, { code: "var foo;", options: [{ name: "baz" }] }

Good catch. I resolved this via checking whether the current context object this is the root test case object.

aladdin-add

LGTM, thanks! Would like another review before merging.

tests/lib/rules/no-object-constructor.js

tests/lib/rules/no-unused-vars.js

mdjermanovic

LGTM, thanks for contributing!

fix: ignore irrelevant test case properties for the duplication check

e62558d

DMartens requested a review from a team as a code owner March 27, 2024 20:54

github-actions bot added the core Relates to ESLint's core APIs and features label Mar 27, 2024

DMartens changed the title ~~fix(rule-tester): ignore irrelevant test case properties for the test case duplication check~~ fix: rule tester ignore irrelevant test case properties for the test case duplication check Mar 27, 2024

DMartens changed the title ~~fix: rule tester ignore irrelevant test case properties for the test case duplication check~~ fix: rule tester ignore irrelevant test case properties Mar 27, 2024

eslint-github-bot bot added the bug ESLint is working incorrectly label Mar 27, 2024

aladdin-add requested changes Mar 28, 2024

View reviewed changes

tests/lib/rules/accessor-pairs.js Show resolved Hide resolved

tests/lib/rules/accessor-pairs.js Show resolved Hide resolved

tests/lib/rules/no-useless-backreference.js Show resolved Hide resolved

aladdin-add added the accepted There is consensus among the team that this change meets the criteria for inclusion label Mar 28, 2024

mdjermanovic added the contributor pool label Mar 28, 2024

mdjermanovic requested changes Mar 28, 2024

View reviewed changes

fix: only ignore top-level test case properties

56d7198

aladdin-add previously approved these changes Apr 2, 2024

View reviewed changes

aladdin-add requested a review from mdjermanovic April 2, 2024 01:57

mdjermanovic reviewed Apr 2, 2024

View reviewed changes

tests/lib/rules/no-object-constructor.js Show resolved Hide resolved

tests/lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

chore: test case merge fixes

9a92dd1

DMartens dismissed aladdin-add’s stale review via 9a92dd1 April 2, 2024 21:09

mdjermanovic approved these changes Apr 2, 2024

View reviewed changes

mdjermanovic merged commit e508800 into eslint:main Apr 2, 2024
18 checks passed

Lessy97 mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 8.57.0 to 9.0.0 Lessy97/eslint#3

Open

danilvilh66 mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 8.57.0 to 9.0.0 danilvilh66/eslint#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: rule tester ignore irrelevant test case properties #18235

fix: rule tester ignore irrelevant test case properties #18235

DMartens commented Mar 27, 2024

eslint-github-bot bot commented Mar 27, 2024

netlify bot commented Mar 27, 2024 •

edited

eslint-github-bot bot commented Mar 27, 2024

aladdin-add left a comment

mdjermanovic Mar 28, 2024

DMartens Mar 28, 2024

aladdin-add left a comment •

edited

mdjermanovic left a comment

		const normalizedItem = typeof item === "string" ? { code: item } : item;
		const serializedTestCase = stringify(normalizedItem, { replacer: (key, value) => (!duplicationIgnoredParameters.has(key) ? value : void 0) });

fix: rule tester ignore irrelevant test case properties #18235

fix: rule tester ignore irrelevant test case properties #18235

Conversation

DMartens commented Mar 27, 2024

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

eslint-github-bot bot commented Mar 27, 2024

netlify bot commented Mar 27, 2024 • edited

✅ Deploy Preview for docs-eslint canceled.

eslint-github-bot bot commented Mar 27, 2024

aladdin-add left a comment

Choose a reason for hiding this comment

mdjermanovic Mar 28, 2024

Choose a reason for hiding this comment

DMartens Mar 28, 2024

Choose a reason for hiding this comment

aladdin-add left a comment • edited

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

netlify bot commented Mar 27, 2024 •

edited

aladdin-add left a comment •

edited