summaryrefslogtreecommitdiff
path: root/spec/ruby/library/coverage/result_spec.rb
blob: 33276778e851b3c78ebf0f1a98816c5d27246c9d (plain)
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
require_relative '../../spec_helper'
require 'coverage'

describe 'Coverage.result' do
  before :all do
    @class_file = fixture __FILE__, 'some_class.rb'
    @config_file = fixture __FILE__, 'start_coverage.rb'
    @eval_code_file = fixture __FILE__, 'eval_code.rb'
  end

  before :each do
    Coverage.running?.should == false
  end

  after :each do
    $LOADED_FEATURES.delete(@class_file)
    $LOADED_FEATURES.delete(@config_file)
    $LOADED_FEATURES.delete(@eval_code_file)

    Coverage.result if Coverage.running?
  end

  it 'gives the covered files as a hash with arrays of count or nil' do
    Coverage.start
    require @class_file.chomp('.rb')
    result = Coverage.result

    result.should == {
      @class_file => [
        nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }
  end

  ruby_version_is "3.2" do
    it 'returns results for each mode separately when enabled :all modes' do
      Coverage.start(:all)
      require @class_file.chomp('.rb')
      result = Coverage.result

      result.should == {
        @class_file => {
          lines: [
            nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
          ],
          branches: {},
          methods: {
            [SomeClass, :some_method, 6, 2, 11, 5] => 0
          }
        }
      }
    end

    it 'returns results for each mode separately when enabled any mode explicitly' do
      Coverage.start(lines: true)
      require @class_file.chomp('.rb')
      result = Coverage.result

      result.should == {
        @class_file =>
          {
            lines: [
              nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
            ]
          }
      }
    end
  end

  it 'no requires/loads should give empty hash' do
    Coverage.start
    result = Coverage.result

    result.should == {}
  end

  it 'second call should give exception' do
    Coverage.start
    require @class_file.chomp('.rb')
    Coverage.result
    -> {
      Coverage.result
    }.should raise_error(RuntimeError, 'coverage measurement is not enabled')
  end

  it 'second run should give same result' do
    Coverage.start
    load @class_file
    result1 = Coverage.result

    Coverage.start
    load @class_file
    result2 = Coverage.result

    result2.should == result1
  end

  it 'second run without load/require should give empty hash' do
    Coverage.start
    require @class_file.chomp('.rb')
    Coverage.result

    Coverage.start
    result = Coverage.result

    result.should == {}
  end

  ruby_version_is ''...'3.1' do
    it 'second Coverage.start does nothing' do
      Coverage.start
      require @config_file.chomp('.rb')
      result = Coverage.result

      result.should == { @config_file => [1, 1, 1] }
    end
  end

  it 'does not include the file starting coverage since it is not tracked' do
    require @config_file.chomp('.rb')
    Coverage.result.should_not include(@config_file)
  end

  ruby_version_is '3.1'...'3.2' do
    it 'returns the correct results when eval is used' do
      Coverage.start
      require @eval_code_file.chomp('.rb')
      result = Coverage.result

      result.should == {
        @eval_code_file => [
          1, nil, 1, nil, 1, nil, nil, nil, nil, nil, 1
        ]
      }
    end
  end

  ruby_version_is '3.2' do
    it 'returns the correct results when eval coverage is enabled' do
      Coverage.supported?(:eval).should == true

      Coverage.start(lines: true, eval: true)
      require @eval_code_file.chomp('.rb')
      result = Coverage.result

      result.should == {
        @eval_code_file => {
          lines: [1, nil, 1, nil, 1, 1, nil, nil, nil, nil, 1]
        }
      }
    end

    it 'returns the correct results when eval coverage is disabled' do
      Coverage.supported?(:eval).should == true

      Coverage.start(lines: true, eval: false)
      require @eval_code_file.chomp('.rb')
      result = Coverage.result

      result.should == {
        @eval_code_file => {
          lines: [1, nil, 1, nil, 1, nil, nil, nil, nil, nil, 1]
        }
      }
    end
  end

  it "disables coverage measurement when stop option is not specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result
    Coverage.running?.should == false
  end

  it "disables coverage measurement when stop: true option is specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    -> {
      Coverage.result(stop: true)
    }.should complain(/warning: stop implies clear/)

    Coverage.running?.should == false
  end

  it "does not disable coverage measurement when stop: false option is specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: false)
    Coverage.running?.should == true
  end

  it "does not disable coverage measurement when stop option is not specified but clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(clear: true)
    Coverage.running?.should == true
  end

  it "does not disable coverage measurement when stop option is not specified but clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(clear: false)
    Coverage.running?.should == true
  end

  it "disables coverage measurement when stop: true and clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: true, clear: true)
    Coverage.running?.should == false
  end

  it "disables coverage measurement when stop: true and clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    -> {
      Coverage.result(stop: true, clear: false)
    }.should complain(/warning: stop implies clear/)

    Coverage.running?.should == false
  end

  it "does not disable coverage measurement when stop: false and clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: false, clear: true)
    Coverage.running?.should == true
  end

  it "does not disable coverage measurement when stop: false and clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: false, clear: false)
    Coverage.running?.should == true
  end

  it "resets counters (remove them) when stop: true specified but clear option is not specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    -> {
      Coverage.result(stop: true) # clears counters
    }.should complain(/warning: stop implies clear/)

    Coverage.start
    Coverage.peek_result.should == {}
  end

  it "resets counters (remove them) when stop: true and clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: true, clear: true) # clears counters

    Coverage.start
    Coverage.peek_result.should == {}
  end

  it "resets counters (remove them) when stop: true and clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    -> {
      Coverage.result(stop: true, clear: false) # clears counters
    }.should complain(/warning: stop implies clear/)

    Coverage.start
    Coverage.peek_result.should == {}
  end

  it "resets counters (remove them) when both stop and clear options are not specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result # clears counters

    Coverage.start
    Coverage.peek_result.should == {}
  end

  it "clears counters (sets 0 values) when stop is not specified but clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(clear: true) # clears counters

    Coverage.peek_result.should == {
      @class_file => [
        nil, nil, 0, nil, nil, 0, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }
  end

  it "does not clear counters when stop is not specified but clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    result = Coverage.result(clear: false) # doesn't clear counters
    result.should == {
      @class_file => [
        nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }

    Coverage.peek_result.should == result
  end

  it "does not clear counters when stop: false and clear is not specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    result = Coverage.result(stop: false) # doesn't clear counters
    result.should == {
      @class_file => [
        nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }

    Coverage.peek_result.should == result
  end

  it "clears counters (sets 0 values) when stop: false and clear: true specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    Coverage.result(stop: false, clear: true) # clears counters

    Coverage.peek_result.should == {
      @class_file => [
        nil, nil, 0, nil, nil, 0, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }
  end

  it "does not clear counters when stop: false and clear: false specified" do
    Coverage.start
    require @class_file.chomp('.rb')

    result = Coverage.result(stop: false, clear: false) # doesn't clear counters
    result.should == {
      @class_file => [
        nil, nil, 1, nil, nil, 1, nil, nil, 0, nil, nil, nil, nil, nil, nil, nil
      ]
    }

    Coverage.peek_result.should == result
  end
end