首页 > 解决方案 > 没有所有要求和方法定义的 Ruby 代码覆盖率?

问题描述

当使用超级简单的simplecov设置时

require 'simplecov'
SimpleCov.start

对于我正在运行的单个测试,我得到了大量“覆盖”的文件和代码,这些文件和代码根本没有真正“执行”(在任何意义上,我在查看特定测试的代码覆盖率时会关心)。

例如,所有在生成的覆盖率报告上加载的文件的所有requiremoduleclass、等都标记为绿色。我不关心那些,如果这些文件中没有执行“实际代码”,如果这些文件报告 0% 覆盖率,我会很高兴。defattr_accessor

end,rescue例如,评论被认为是不相关的,并且在任何文件中都没有标记为红色绿色。我希望上面列出的方法有类似的行为。

有没有办法获得真正只包括(和测量)我关心的正在执行的实际代码行的代码覆盖率?


第一个答案后更新:不幸的是,通过例如将所有其他代码标记为“不相关”# :nocov:不是一个选项,因为这会影响每个单独测试运行的数千个文件。

标签: rubysimplecov

解决方案


SimpleCov 只是向您展示 Ruby 的 Coverage 库收集了什么,正如您对问题的评论所说,这些事情已被执行,但我也觉得这令人沮丧 - 我不希望加载但未使用的类为 40 % 覆盖率。

我的解决方案是删除仅在加载过程中出现的覆盖范围。我们使用的是 Rails,所以我们首先加载应用程序中的每个文件(这在 Rails 中很容易,有一个 eager_load 配置);拍摄当时的报道快照;运行测试套件;然后最后在 simplecov 输出之前从最终结果中扣除快照。在加载快照中恰好覆盖一次并且在最终结果中恰好覆盖一次的任何行都将被删除。

下面是我不久前拼凑起来的一个自定义 SimpleCov 格式化程序,它可以完成这项工作。这有点像 hack,因为它与 gem 的内部结果对象混淆了,所以请注意,它对于新版本可能不稳定,但它适用于我们当前的 simplecov (0.16.1)。另请注意,由于它使用Coverage.peek_result需要 Ruby 2.3 或更高版本

通过将其设置SimpleCovWithoutLoadingFormatter为 simplecov 的格式化程序并在SimpleCovWithoutLoadingFormatter.take_load_snapshot加载应用程序的每个文件后立即在测试套件设置调用中使用它。

require 'simplecov'

class SimpleCovWithoutLoadingFormatter
  def self.take_load_snapshot
    @coverage_load_lines_mask = Coverage.peek_result
  end

  def self.coverage_load_lines_mask
    @coverage_load_lines_mask
  end

  def format(result)
    if self.class.coverage_load_lines_mask&.any?
      result_merge_count = result.command_name.split(',').count

      result.files.each do |source_file|
        _file, load_mask = self.class.coverage_load_lines_mask.detect { |file, _load_mask| file == source_file.filename }
        next unless load_mask

        source_file.coverage.each_with_index do |count, i|
          source_file.coverage[i] = nil if count&.positive? && count&.==(load_mask[i] * result_merge_count)
        end
      end
    end

    SimpleCov::Formatter::HTMLFormatter.new.format(result)
  end
end

推荐阅读