Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: fix the timing to define rules for tests #8082

Merged
merged 1 commit into from Feb 16, 2017

Conversation

mysticatea
Copy link
Member

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

[X] Other, please explain:

What changes did you make? (Give an overview)

This PR changes the timing to define rules for tests.

Because tests/lib/rules.js resets rules in beforeEach handler, RuleTester.define does not work the following case.

$ mocha "tests/lib/rules.js" "tests/lib/rules/no-unused-vars.js" --reporter progress
Result:
 [▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬]

  207 passing (888ms)
  3 failing

  1) no-unused-vars valid /*eslint use-every-a:1*/ var a;:
     Error: undefined line 1:
        Configuration for rule "use-every-a" is invalid:
Cannot read property 'meta' of undefined
      at Object.validateRuleOptions (C:\Users\starc\Documents\GitHub\eslint\lib\config\config-validator.js:109:15)
      at Object.keys.forEach.name (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:368:39)
      at Array.forEach (native)
      at ast.comments.forEach.comment (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:365:44)
      at Array.forEach (native)
      at modifyConfigsFromComments (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:331:18)
      at EventEmitter.module.exports.api.verify (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:833:26)
      at runRuleForItem (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:380:38)
      at testValidTemplate (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:413:28)
      at Context.RuleTester.it (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:511:25)
      at callFn (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:326:21)
      at Test.Runnable.run (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:319:7)
      at Runner.runTest (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:422:10)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:528:12
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:342:14)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:352:7
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:284:14)
      at Immediate._onImmediate (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:320:5)

  2) no-unused-vars valid /*eslint use-every-a:1*/ !function(a) { return 1; }:
     Error: undefined line 1:
        Configuration for rule "use-every-a" is invalid:
Cannot read property 'meta' of undefined
      at Object.validateRuleOptions (C:\Users\starc\Documents\GitHub\eslint\lib\config\config-validator.js:109:15)
      at Object.keys.forEach.name (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:368:39)
      at Array.forEach (native)
      at ast.comments.forEach.comment (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:365:44)
      at Array.forEach (native)
      at modifyConfigsFromComments (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:331:18)
      at EventEmitter.module.exports.api.verify (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:833:26)
      at runRuleForItem (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:380:38)
      at testValidTemplate (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:413:28)
      at Context.RuleTester.it (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:511:25)
      at callFn (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:326:21)
      at Test.Runnable.run (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:319:7)
      at Runner.runTest (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:422:10)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:528:12
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:342:14)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:352:7
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:284:14)
      at Immediate._onImmediate (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:320:5)

  3) no-unused-vars valid /*eslint use-every-a:1*/ !function() { var a; return 1 }:
     Error: undefined line 1:
        Configuration for rule "use-every-a" is invalid:
Cannot read property 'meta' of undefined
      at Object.validateRuleOptions (C:\Users\starc\Documents\GitHub\eslint\lib\config\config-validator.js:109:15)
      at Object.keys.forEach.name (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:368:39)
      at Array.forEach (native)
      at ast.comments.forEach.comment (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:365:44)
      at Array.forEach (native)
      at modifyConfigsFromComments (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:331:18)
      at EventEmitter.module.exports.api.verify (C:\Users\starc\Documents\GitHub\eslint\lib\eslint.js:833:26)
      at runRuleForItem (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:380:38)
      at testValidTemplate (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:413:28)
      at Context.RuleTester.it (C:\Users\starc\Documents\GitHub\eslint\lib\testers\rule-tester.js:511:25)
      at callFn (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:326:21)
      at Test.Runnable.run (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runnable.js:319:7)
      at Runner.runTest (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:422:10)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:528:12
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:342:14)
      at C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:352:7
      at next (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:284:14)
      at Immediate._onImmediate (C:\Users\starc\nodist\bin\node_modules\mocha\lib\runner.js:320:5)

.

  1. tests/lib/rules/no-unused-vars.js defines use-every-a rule on the top.
  2. tests/lib/rules.js set the beforeEach handler to reset rules.
  3. It runs the beforeEach handler, then it removes use-every-a rule.
  4. The testcases of tests/lib/rules/no-unused-vars.js use use-every-a rule, but it's not defined.

So this PR moves the timing which defines rules to "before each test".

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

Nothing in particular.

@mysticatea mysticatea added accepted There is consensus among the team that this change meets the criteria for inclusion bug ESLint is working incorrectly chore This change is not user-facing labels Feb 15, 2017
@mention-bot
Copy link

@mysticatea, thanks for your PR! By analyzing the history of the files in this pull request, we identified @nzakas, @platinumazure and @gyandeeps to be potential reviewers.

@eslintbot
Copy link

LGTM

@vitorbal vitorbal merged commit 55ac302 into master Feb 16, 2017
@mysticatea mysticatea deleted the fix-timing-of-defining-rule-to-test branch February 16, 2017 13:47
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly chore This change is not user-facing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants