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

[Fix #279] Add new Minitest/NonExecutableTestMethod cop #280

Merged

Conversation

koic
Copy link
Member

@koic koic commented Dec 14, 2023

Resolves #279.

This PR adds new Minitest/NonExecutableTestMethod cop, which checks for the use of test methods outside of a test class. Test methods should be defined within a test class to ensure their execution.

NOTE: This cop assumes that classes whose superclass name includes the word "Test" are test classes, in order to prevent false positives.

# bad
class FooTest < Minitest::Test
end
def test_method_should_be_inside_test_class
end

# good
class FooTest < Minitest::Test
  def test_method_should_be_inside_test_class
  end
end

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

Resolves rubocop#279.

This PR adds new `Minitest/NonExecutableTestMethod` cop, which checks for
the use of test methods outside of a test class.
Test methods should be defined within a test class to ensure their execution.

NOTE: This cop assumes that classes whose superclass name includes the word
"`Test`" are test classes, in order to prevent false positives.

```ruby
# bad
class FooTest < Minitest::Test
end
def test_method_should_be_inside_test_class
end

# good
class FooTest < Minitest::Test
  def test_method_should_be_inside_test_class
  end
end
```
@koic koic merged commit a31118d into rubocop:master Dec 15, 2023
12 checks passed
@koic koic deleted the add_new_minitest_non_executable_test_method_cop branch December 15, 2023 16:54
@yahonda
Copy link
Contributor

yahonda commented Dec 17, 2023

Thanks for implementing the Minitest/NonExecutableTestMethod cop. I have opened rails/rails#50379 to enable this cop at Rails.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

test_* method out of ActiveSupport::TestCase subclasses
2 participants