企业官网建设流程全解析

rubocop-github 测试驱动开发：用 Minitest 为自定义 Cop 编写单元测试

【免费下载链接】rubocop-githubCode style checking for GitHub's Ruby projects项目地址: https://gitcode.com/gh_mirrors/ru/rubocop-github

rubocop-github是 GitHub 官方维护的 Ruby 代码风格检查插件，为 Ruby 项目提供了一套推荐配置和大量自定义 Cop（检查规则）。如果你想为它贡献新的检查规则，或者想学习 RuboCop 插件开发的完整流程，那么用 Minitest 编写单元测试是绕不开的一步。本文将用通俗易懂的方式，带你从零开始为自定义 Cop 编写测试，掌握测试驱动开发（TDD）的核心套路。

为什么自定义 Cop 需要单元测试？🤔

写代码风格检查插件，最怕的是"误报"和"漏报"——该拦的没拦住，不该拦的误伤一片。GitHub 团队深谙此道，为rubocop-github里的每一个 Cop 都配了完整的 Minitest 测试。这些测试不仅仅是"跑得通"，更是规则行为的契约：每条 Cop 该抓什么、不该抓什么，都被明明白白写进了测试里。

更重要的是，RuboCop 的 Cop 基于 AST（抽象语法树）匹配，逻辑相当精巧，一个小小的正则或节点匹配错误，就可能影响成千上万个真实项目。单元测试是你修改 Cop 时最可靠的"安全带"。

测试基础设施：认识 CopTest 基类 🧱

打开test/cop_test.rb，你会看到一个简洁但极其重要的基类CopTest。它只有两个核心方法：

• investigate：把一段 Ruby 源码交给指定的 Cop 检查，返回所有违规（offenses）
• erb_investigate：把一段 ERB 模板先编译成 Ruby 源码再检查，专用于 View 类 Cop

def investigate(cop, src, filename = nil) processed_source = RuboCop::ProcessedSource.new(src, RUBY_VERSION.to_f, filename) team = RuboCop::Cop::Team.new([cop], cop.config, raise_error: true) report = team.investigate(processed_source) report.offenses end

这个基类帮你把"构建源码→跑检查→取违规"的流程封装好了，你写测试时只需要关注输入什么代码、期望几个违规。

第一步：按命名规范创建测试文件 📁

在test/目录下，测试文件与 Cop 文件一一对应，命名规则非常直观：

• Cop 源码：lib/rubocop/cop/github/insecure_hash_algorithm.rb
• 测试文件：test/test_insecure_hash_algorithm.rb

每个测试文件的结构也高度统一：

require_relative "cop_test" require "minitest/autorun" require "rubocop/cop/github/insecure_hash_algorithm" class TestInsecureHashAlgorithm < CopTest def cop_class RuboCop::Cop::GitHub::InsecureHashAlgorithm end # ...测试方法 end

注意cop_class方法——它告诉基类要测试哪个 Cop，所有测试方法都能通过cop访问到被测对象。测试类名使用Test+ Cop 名的驼峰形式，测试方法一律以test_开头，这是 Minitest 的约定。

第二步：编写"该报错"与"不该报错"的成对测试 ✅❌

测试驱动开发的精髓在于同时验证正反两个方向。以test/test_avoid_object_send_with_dynamic_method.rb为例，它测试的 Cop 是禁止用动态方法名调用send：

def test_offended_by_send_call offenses = investigate cop, <<-RUBY def my_method(foo) foo.send(@some_ivar) end RUBY assert_equal 1, offenses.size end def test_unoffended_by_other_method_calls offenses = investigate cop, <<-RUBY foo.bar(arg1, arg2) case @some_ivar when :foo then baz.foo end RUBY assert_equal 0, offenses.size end

测试的节奏非常清晰：

1. 违规用例：foo.send(@some_ivar)传的是变量，应该被判定为违规，断言违规数为 1
2. 安全用例：普通方法调用foo.bar不应该被误报，断言违规数为 0

除了数量，还可以断言违规消息的精确内容，确保文案也符合预期。比如test_insecure_hash_algorithm.rb中：

assert_equal "#{cop.name}: #{cop_class::MSG}", offenses.first.message

第三步：测试带配置项的 Cop ⚙️

很多 Cop 支持配置参数，测试时不能只用默认配置。以InsecureHashAlgorithm为例，它允许通过Allowed配置指定哪些哈希算法可以被豁免：

def make_cop(allowed:) config = RuboCop::Config.new({ "GitHub/InsecureHashAlgorithm" => { "Allowed" => allowed } }) cop_class.new(config) end def test_uuid_v3_with_md5_allowed cop = make_cop(allowed: %w[MD5]) offenses = investigate(cop, <<-RUBY) Digest::UUID.uuid_v3('anything', 'anything') RUBY assert_equal 0, offenses.count end

这是一个非常实用的测试模式：先构造一个make_cop辅助方法，再用不同的配置验证 Cop 的行为变化。比如配置只允许SHA512时SHA256就该报错，配置允许SHA1时uuid_v5就不该报错——边界情况全都被覆盖到了。

第四步：为 View 相关 Cop 测试 ERB 模板 📝

Rails 项目里很多代码写在 ERB 模板中，普通源码检查无法直接处理。rubocop-github的解决方案是erb_investigate：先把 ERB 编译成 Ruby，再交给 Cop 检查。

以test/test_rails_view_render_literal.rb为例：

def test_render_variable_offense offenses = erb_investigate cop, <<-ERB, "app/views/products/index.html.erb" <%= render magic_string %> <%= render partial: magic_string %> ERB assert_equal 2, offenses.count end

注意第二个参数传入了虚拟的文件名app/views/products/index.html.erb，这能让 Cop 正确识别上下文，也让测试更贴近真实场景。如果你想为 View 相关的 Cop 写测试，直接复用这个模式即可。

运行测试：一键验证你的 Cop 🚀

rubocop-github的测试运行非常简单，两种方式任选：

bundle install bundle exec rake test

或者直接执行项目自带的测试脚本：

script/test

Rakefile里已经配置好Rake::TestTask，会自动发现test/目录下所有测试文件并运行。默认任务还会同时执行 RuboCop 对代码本身的检查，确保你提交的代码风格也符合规范。

测试驱动开发的最佳实践清单 📋

结合rubocop-github的真实测试，总结几条新手友好、可直接照搬的经验：

• 先写失败测试再写 Cop：先用测试描述 Cop 应该有的行为，看着它变红，再实现 Cop 让它变绿，这是 TDD 的标准节奏
• 正反用例成对出现：每个"该抓"的场景，都配一个"不该抓"的场景，防止过度匹配
• 覆盖边界情况：符号 vs 字符串、链式调用、带接收者 vs 不带接收者、命名空间常量，test_unreliable_subclasses.rb里就有大量这样的边界用例
• 断言消息内容：不只断言违规数量，还要校验违规消息，防止文案漂移
• 为配置项写独立用例：Cop 有配置参数时，单独构造配置并验证行为变化

总结 ✨

为自定义 Cop 写测试，本质上就是回答三个问题：它该抓什么？它不该抓什么？配置变化时行为怎么变？借助test/cop_test.rb提供的基础设施和 Minitest 简洁的断言风格，你完全可以用测试驱动的方式，安全地开发、修改、重构自己的 RuboCop 插件。学会这套方法后，rubocop-github里test/目录下的每一个测试文件，都可以成为你学习 Cop 开发的活教材。

【免费下载链接】rubocop-githubCode style checking for GitHub's Ruby projects项目地址: https://gitcode.com/gh_mirrors/ru/rubocop-github