TestProf

Ruby 测试的分析和优化工具箱。

TestProf 是一个分析你的测试套件性能的不同工具集。

为什么测试套件性能如此重要？ 首先，测试是开发者反馈环的一部分（参看 @searls talk）。其次，它是部署周期的一部分。

简单来说，慢测试浪费你的时间，让你效率低下。

TestProf 工具箱旨在帮你识别测试套件的瓶颈。它包含：

• 常规 Ruby 分析器（ruby-prof, stackprof）即插即用的整合。

• 对 Factories 的使用采用了分析器。

• ActiveSupport 所支持的分析器。

• RSpec 和 minitest 的 帮助方法 以编写更快的测试。

• RuboCop 的支持。

• 更多……

📑 Documentation

## TestProf 的用户

• Discourse 减少了 他们测试套件约 27% 的耗时
• Gitlab 减少了 他们 API 测试 39% 的耗时
• Mastodon
• Dev.to
• CodeTriage
• Open Project
• 其他……

资源

• From slow to go: Rails test profiling hands-on

• Profiling Ruby tests with Swiss precision

• TestProf: Ruby慢测试的“良医圣手”

• TestProf II: Ruby测试的“工厂疗法”

• TestProf III：引导式及自动化的Ruby测试分析

• 一万年太久，只争朝夕

• Paris.rb, 2018, “慢测试的99个问题” 演讲 [视频, slides]

• BalkanRuby, 2018, “带你的慢测试去看‘良医’” 演讲 [视频], slides]

• RailsClub, Moscow, 2017, “更快的测试” 演讲 [视频 (俄语), slides]

• RubyConfBy, 2017, “测试跑跑跑” 演讲 [视频, slides]

• 提升你测试套件速度的技巧 演讲者：Benoit Tigeot

安装

把 test-prof gem 添加到你的应用：

group :test do
  gem "test-prof"
end

就行了！

所支持的 Ruby 版本：

• Ruby (MRI) >= 2.5.0（注意： 对于 Ruby 2.2 请使用 TestProf < 0.7.0，Ruby 2.3 请使用 TestProf ~> 0.7.0，Ruby 2.4 请使用 TestProf <0.12.0）

• JRuby >= 9.1.0.0 （注意 refinements-dependent 特性可能需要 9.2.7+）

所支持的 RSpec 版本（仅 RSpec 特性）: >= 3.5.0（对较旧版本 RSpec 请使用 TestProf < 0.8.0）。

所支持的 Rails 版本（仅适用于 Rails 功能）：>= 5.2.0（对较旧版本 Rails 请使用 TestProf < 1.0）。

使用 RuboCop RSpec 进行 Lint

当使用 rubocop-rspec 对 RSpec spec 文件进行 lint 检查时，它将无法正确检测 TestProf 定义的 let_it_be 和 before_all 这些 RSpec constructs。确保使用 rubocop-rspec 2.0 或更新版本，并将以下内容添加到 .rubocop.yml 中：

inherit_gem:
  test-prof: config/rubocop-rspec.yml

分析器

• RubyProf 的整合

• StackProf 的整合

• Event 分析器（比如，ActiveSupport 的 notifications）

• Tag 分析器

• Factory 医生

• Factory 分析器

• RSpecDissect 分析器

配方

我们也期望分享一些小的代码技巧，可以帮助你改进测试套件的性能和效率：

• before_all Hook

• let_it_be 帮助方法

• AnyFixture

• FactoryDefault

• FactoryAllStub

• RSpec Stamp

• Tests Sampling

• Active Record Shared Connection

• Rails 日志记录

其他工具

• RuboCop cops

下一步

有好的想法？提交一个功能需求吧!

已经在使用 TestProf 了？分享你的故事吧

许可协议

根据 MIT License 条款，本 gem 可开源使用。