1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
|
# frozen_string_literal: true
require "helper"
require "coverage"
describe SimpleCov do
describe ".result" do
before do
SimpleCov.clear_result
allow(Coverage).to receive(:result).once.and_return({})
end
context "with merging disabled" do
before do
allow(SimpleCov).to receive(:use_merging).once.and_return(false)
expect(SimpleCov).to_not receive(:wait_for_other_processes)
end
context "when not running" do
before do
allow(SimpleCov).to receive(:running).and_return(false)
end
it "returns nil" do
expect(SimpleCov.result).to be_nil
end
end
context "when running" do
before do
allow(SimpleCov).to receive(:running).and_return(true, false)
end
it "uses the result from Coverage" do
expect(Coverage).to receive(:result).once.and_return(__FILE__ => [0, 1])
expect(SimpleCov.result.filenames).to eq [__FILE__]
end
it "adds not-loaded-files" do
expect(SimpleCov).to receive(:add_not_loaded_files).once.and_return({})
SimpleCov.result
end
it "doesn't store the current coverage" do
expect(SimpleCov::ResultMerger).not_to receive(:store_result)
SimpleCov.result
end
it "doesn't merge the result" do
expect(SimpleCov::ResultMerger).not_to receive(:merged_result)
SimpleCov.result
end
it "caches its result" do
result = SimpleCov.result
expect(SimpleCov.result).to be(result)
end
end
end
context "with merging enabled" do
let(:the_merged_result) { double }
before do
allow(SimpleCov).to receive(:use_merging).once.and_return(true)
allow(SimpleCov::ResultMerger).to receive(:store_result).once
allow(SimpleCov::ResultMerger).to receive(:merged_result).once.and_return(the_merged_result)
expect(SimpleCov).to receive(:wait_for_other_processes)
end
context "when not running" do
before do
allow(SimpleCov).to receive(:running).and_return(false)
end
it "merges the result" do
expect(SimpleCov.result).to be(the_merged_result)
end
end
context "when running" do
before do
allow(SimpleCov).to receive(:running).and_return(true, false)
end
it "uses the result from Coverage" do
expect(Coverage).to receive(:result).once.and_return({})
SimpleCov.result
end
it "adds not-loaded-files" do
expect(SimpleCov).to receive(:add_not_loaded_files).once.and_return({})
SimpleCov.result
end
it "stores the current coverage" do
expect(SimpleCov::ResultMerger).to receive(:store_result).once
SimpleCov.result
end
it "merges the result" do
expect(SimpleCov.result).to be(the_merged_result)
end
it "caches its result" do
result = SimpleCov.result
expect(SimpleCov.result).to be(result)
end
end
end
end
describe ".exit_status_from_exception" do
context "when no exception has occurred" do
it "returns nil" do
expect(SimpleCov.exit_status_from_exception).to eq(nil)
end
end
context "when a SystemExit has occurred" do
it "returns the SystemExit status" do
raise SystemExit, 1
rescue SystemExit
expect(SimpleCov.exit_status_from_exception).to eq(1)
end
end
context "when a non SystemExit occurs" do
it "return SimpleCov::ExitCodes::EXCEPTION" do
raise "no system exit"
rescue StandardError
expect(SimpleCov.exit_status_from_exception).to eq(SimpleCov::ExitCodes::EXCEPTION)
end
end
end
describe ".process_result" do
let(:result) { SimpleCov::Result.new({}) }
context "when minimum coverage is 100%" do
before do
allow(SimpleCov).to receive(:minimum_coverage).and_return(line: 100)
allow(SimpleCov).to receive(:result?).and_return(true)
end
context "when actual coverage is almost 100%" do
before do
allow(result).to receive(:coverage_statistics).and_return(line: double("statistics", percent: 100 * 32_847.0 / 32_848))
end
it "return SimpleCov::ExitCodes::MINIMUM_COVERAGE" do
expect(
SimpleCov.process_result(result)
).to eq(SimpleCov::ExitCodes::MINIMUM_COVERAGE)
end
end
context "when actual coverage is exactly 100%" do
before do
allow(result).to receive(:covered_percent).and_return(100.0)
allow(result).to receive(:coverage_statistics).and_return(
line: double("statistics", percent: 100.0)
)
allow(result).to receive(:covered_percentages).and_return([])
allow(SimpleCov::LastRun).to receive(:read).and_return(nil)
end
it "return SimpleCov::ExitCodes::SUCCESS" do
expect(
SimpleCov.process_result(result)
).to eq(SimpleCov::ExitCodes::SUCCESS)
end
end
context "branch coverage" do
before do
allow(SimpleCov).to receive(:minimum_coverage).and_return(branch: 90)
allow(SimpleCov).to receive(:result?).and_return(true)
end
it "errors out when the coverage is too low" do
allow(result).to receive(:coverage_statistics).and_return(branch: double("statistics", percent: 89.99))
expect(
SimpleCov.process_result(result)
).to eq(SimpleCov::ExitCodes::MINIMUM_COVERAGE)
end
end
end
end
describe ".collate" do
let(:resultset1) do
{source_fixture("sample.rb") => {"lines" => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil]}}
end
let(:resultset2) do
{source_fixture("sample.rb") => {"lines" => [1, nil, 1, 1, nil, nil, 1, 1, nil, nil]}}
end
let(:resultset_path) { SimpleCov::ResultMerger.resultset_path }
let(:resultset_folder) { File.dirname(resultset_path) }
let(:merged_result) do
{
"result1, result2" => {
"coverage" => {
source_fixture("sample.rb") => {
"lines" => [1, 1, 2, 2, nil, nil, 2, 2, nil, nil]
}
}
}
}
end
let(:collated) do
JSON.parse(File.read(resultset_path)).transform_values { |v| v.reject { |k| k == "timestamp" } }
end
context "when no files to be merged" do
it "shows an error message" do
expect do
glob = Dir.glob("#{resultset_folder}/*.final", File::FNM_DOTMATCH)
SimpleCov.collate glob
end.to raise_error("There are no reports to be merged")
end
end
context "when files to be merged" do
before do
expect(SimpleCov).to receive(:run_exit_tasks!)
end
context "and a single report to be merged" do
before do
create_mergeable_report("result1", resultset1)
end
after do
clear_mergeable_reports
end
it "creates a merged report identical to the original" do
glob = Dir.glob("#{resultset_folder}/*.final", File::FNM_DOTMATCH)
SimpleCov.collate glob
expected = {"result1" => {"coverage" => resultset1}}
expect(collated).to eq(expected)
end
end
context "and multiple reports to be merged" do
before do
create_mergeable_report("result1", resultset1)
create_mergeable_report("result2", resultset2)
end
after do
clear_mergeable_reports
end
it "creates a merged report" do
glob = Dir.glob("#{resultset_folder}/*.final", File::FNM_DOTMATCH)
SimpleCov.collate glob
expect(collated).to eq(merged_result)
end
end
context "and multiple reports to be merged, one of them outdated" do
before do
create_mergeable_report("result1", resultset1)
create_mergeable_report("result2", resultset2, outdated: true)
end
after do
clear_mergeable_reports
end
it "ignores timeout by default creating a report with all values" do
glob = Dir.glob("#{resultset_folder}/*.final", File::FNM_DOTMATCH)
SimpleCov.collate glob
expect(collated).to eq(merged_result)
end
it "creates a merged report with only the results from the current resultset if ignore_timeout: false" do
glob = Dir.glob("#{resultset_folder}/*.final", File::FNM_DOTMATCH)
SimpleCov.collate glob, ignore_timeout: false
expected = {"result1" => {"coverage" => resultset1}}
expect(collated).to eq(expected)
end
end
private
def create_mergeable_report(name, resultset, outdated: false)
result = SimpleCov::Result.new(resultset)
result.command_name = name
result.created_at = Time.now - 172_800 if outdated
SimpleCov::ResultMerger.store_result(result)
FileUtils.mv resultset_path, "#{resultset_path}#{name}.final"
end
def clear_mergeable_reports
SimpleCov.clear_result
FileUtils.rm Dir.glob("#{resultset_path}*")
end
def expect_merged
expected = {"result1, result2" => {"coverage" => {source_fixture("sample.rb") => {"lines" => [1, 1, 2, 2, nil, nil, 2, 2, nil, nil]}}}}
expect(collated).to eq(expected)
end
end
end
# Normally wouldn't test private methods but just start has side effects that
# cause errors so for time this is pragmatic (tm)
describe ".start_coverage_measurement", if: SimpleCov.coverage_start_arguments_supported? do
after :each do
# SimpleCov is a Singleton/global object so once any test enables
# any kind of coverage data it stays there.
# Hence, we use clear_coverage_data to create a "clean slate" for these tests
SimpleCov.clear_coverage_criteria
end
it "starts coverage in lines mode by default" do
expect(Coverage).to receive(:start).with({lines: true})
SimpleCov.send :start_coverage_measurement
end
it "starts coverage with lines and branches if branches is activated" do
expect(Coverage).to receive(:start).with({lines: true, branches: true})
SimpleCov.enable_coverage :branch
SimpleCov.send :start_coverage_measurement
end
end
end
|