Class: RSpec::Puppet::Coverage

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/rspec-puppet/coverage.rb

Defined Under Namespace

Classes: ResourceWrapper

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeCoverage

Returns a new instance of Coverage.


47
48
49
50
51
# File 'lib/rspec-puppet/coverage.rb', line 47

def initialize
  @collection = {}
  @filters = ['Stage[main]', 'Class[Settings]', 'Class[main]', 'Node[default]']
  @filters_regex = []
end

Class Attribute Details

.instanceObject


42
43
44
# File 'lib/rspec-puppet/coverage.rb', line 42

def instance
  @instance ||= new
end

Instance Attribute Details

#filtersObject

Returns the value of attribute filters


20
21
22
# File 'lib/rspec-puppet/coverage.rb', line 20

def filters
  @filters
end

#filters_regexObject

Returns the value of attribute filters_regex


20
21
22
# File 'lib/rspec-puppet/coverage.rb', line 20

def filters_regex
  @filters_regex
end

Instance Method Details

#add(resource) ⇒ Object


114
115
116
117
118
# File 'lib/rspec-puppet/coverage.rb', line 114

def add(resource)
  if !exists?(resource) && !filtered?(resource)
    @collection[resource.to_s] = ResourceWrapper.new(resource)
  end
end

#add_filter(type, title) ⇒ Object


120
121
122
123
124
125
126
127
128
# File 'lib/rspec-puppet/coverage.rb', line 120

def add_filter(type, title)
  type = capitalize_name(type)

  if type == 'Class'
    title = capitalize_name(title)
  end

  @filters << "#{type}[#{title}]"
end

#add_filter_regex(type, pattern) ⇒ Object

Raises:

  • (ArgumentError)

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
# File 'lib/rspec-puppet/coverage.rb', line 130

def add_filter_regex(type, pattern)
  raise ArgumentError.new('pattern argument must be a Regexp') unless pattern.is_a?(Regexp)

  type = capitalize_name(type)

  # avoid recompiling the regular expression during processing
  src = pattern.source

  # switch from anchors to wildcards since it is embedded into a larger pattern
  src = if src.start_with?('\\A', '^')
          src.gsub(/\A(?:\\A|\^)/, '')
        else
          # no anchor at the start
          ".*#{src}"
        end

  # match an even number of backslashes before the anchor - this indicates that the anchor was not escaped
  # note the necessity for the negative lookbehind `(?<!)` to assert that there is no backslash before this
  src = if src.match(/(?<!\\)(\\\\)*(?:\\[zZ]|\$)\z/)
          src.gsub(/(?:\\[zZ]|\$)\z/, '')
        else
          # no anchor at the end
          "#{src}.*"
        end

  @filters_regex << /\A#{Regexp.escape(type)}\[#{src}\]\z/
end

#add_from_catalog(catalog, test_module) ⇒ Object

add all resources from catalog declared in module test_module


159
160
161
162
163
164
# File 'lib/rspec-puppet/coverage.rb', line 159

def add_from_catalog(catalog, test_module)
  coverable_resources = catalog.to_a.reject { |resource| !test_module.nil? && filter_resource?(resource, test_module) }
  coverable_resources.each do |resource|
    add(resource)
  end
end

#cover!(resource) ⇒ Object


173
174
175
176
177
# File 'lib/rspec-puppet/coverage.rb', line 173

def cover!(resource)
  if !filtered?(resource) && (wrapper = find(resource))
    wrapper.touch!
  end
end

#coverage_test(coverage_desired, report) ⇒ Object


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
# File 'lib/rspec-puppet/coverage.rb', line 211

def coverage_test(coverage_desired, report)
  coverage_actual = report[:coverage]
  coverage_desired ||= 0

  if coverage_desired.is_a?(Numeric) && coverage_desired.to_f <= 100.00 && coverage_desired.to_f >= 0.0
    coverage_test = RSpec.describe("Code coverage")
    coverage_results = coverage_test.example("must cover at least #{coverage_desired}% of resources") do
      expect( coverage_actual.to_f ).to be >= coverage_desired.to_f
    end
    coverage_test.run(RSpec.configuration.reporter)

    status = if coverage_results.execution_result.respond_to?(:status)
               coverage_results.execution_result.status
             else
               coverage_results.execution_result[:status]
             end

    if status == :failed
      RSpec.world.non_example_failure = true
      RSpec.world.wants_to_quit = true
    end

    # This is not available on RSpec 2.x
    if coverage_results.execution_result.respond_to?(:pending_message)
      coverage_results.execution_result.pending_message = report[:text]
    end
  else
    puts "The desired coverage must be 0 <= x <= 100, not '#{coverage_desired.inspect}'"
  end
end

#filtered?(resource) ⇒ Boolean

Returns:

  • (Boolean)

166
167
168
169
170
171
# File 'lib/rspec-puppet/coverage.rb', line 166

def filtered?(resource)
  return true if filters.include?(resource.to_s)
  return true if filters_regex.any? { |f| resource.to_s =~ f }

  false
end

#load_filters(path) ⇒ Object


97
98
99
100
101
102
103
# File 'lib/rspec-puppet/coverage.rb', line 97

def load_filters(path)
  saved_filters = JSON.parse(File.read(path))
  saved_filters.each do |resource|
    @filters << resource
    @collection.delete(resource) if @collection.key?(resource)
  end
end

#load_filters_regex(path) ⇒ Object


105
106
107
108
109
110
111
112
# File 'lib/rspec-puppet/coverage.rb', line 105

def load_filters_regex(path)
  saved_regex_filters = JSON.parse(File.read(path))
  saved_regex_filters.each do |pattern|
    regex = Regexp.new(pattern)
    @filters_regex << regex
    @collection.delete_if { |resource, _| resource =~ regex }
  end
end

#load_results(path) ⇒ Object


89
90
91
92
93
94
95
# File 'lib/rspec-puppet/coverage.rb', line 89

def load_results(path)
  saved_results = JSON.parse(File.read(path))
  saved_results.each do |resource, data|
    add(resource)
    cover!(resource) if data['touched']
  end
end

#merge_filtersObject


74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/rspec-puppet/coverage.rb', line 74

def merge_filters
  pattern = File.join(Dir.tmpdir, "rspec-puppet-filter-#{Digest::MD5.hexdigest(Dir.pwd)}-*")
  regex_filter_pattern = File.join(Dir.tmpdir, "rspec-puppet-filter_regex-#{Digest::MD5.hexdigest(Dir.pwd)}-*")

  Dir[pattern].each do |result_file|
    load_filters(result_file)
    FileUtils.rm(result_file)
  end

  Dir[regex_filter_pattern].each do |result_file|
    load_filters_regex(result_file)
    FileUtils.rm(result_file)
  end
end

#merge_resultsObject


66
67
68
69
70
71
72
# File 'lib/rspec-puppet/coverage.rb', line 66

def merge_results
  pattern = File.join(Dir.tmpdir, "rspec-puppet-coverage-#{Digest::MD5.hexdigest(Dir.pwd)}-*")
  Dir[pattern].each do |result_file|
    load_results(result_file)
    FileUtils.rm(result_file)
  end
end

#parallel_tests?Boolean

Returns:

  • (Boolean)

194
195
196
# File 'lib/rspec-puppet/coverage.rb', line 194

def parallel_tests?
  !!ENV['TEST_ENV_NUMBER']
end

#report!(coverage_desired = nil) ⇒ Object


179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/rspec-puppet/coverage.rb', line 179

def report!(coverage_desired = nil)
  if parallel_tests?
    require 'parallel_tests'

    if ParallelTests.first_process?
      ParallelTests.wait_for_other_processes_to_finish
      run_report(coverage_desired)
    else
      save_results
    end
  else
    run_report(coverage_desired)
  end
end

#resultsObject


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
# File 'lib/rspec-puppet/coverage.rb', line 242

def results
  report = {}

  @collection.delete_if { |name, _| filtered?(name) }

  report[:total] = @collection.size
  report[:touched] = @collection.count { |_, resource| resource.touched? }
  report[:untouched] = report[:total] - report[:touched]

  coverage = report[:total].to_f > 0 ? ((report[:touched].to_f / report[:total].to_f) * 100) : 100.0
  report[:coverage] = "%5.2f" % coverage

  report[:resources] = Hash[*@collection.map do |name, wrapper|
    [name, wrapper.to_hash]
  end.flatten]

  text = [
    "Total resources:   #{report[:total]}",
    "Touched resources: #{report[:touched]}",
    "Resource coverage: #{report[:coverage]}%",
  ]

  if report[:untouched] > 0
    text += ['', 'Untouched resources:']
    untouched_resources = report[:resources].reject { |_, r| r[:touched] }
    text += untouched_resources.map { |name, _| "  #{name}" }.sort
  end
  report[:text] = text.join("\n")

  report
end

#run_report(coverage_desired = nil) ⇒ Object


198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/rspec-puppet/coverage.rb', line 198

def run_report(coverage_desired = nil)
  if parallel_tests?
    merge_filters
    merge_results
  end

  report = results

  coverage_test(coverage_desired, report)

  puts "\n\nCoverage Report:\n\n#{report[:text]}"
end

#save_resultsObject


53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/rspec-puppet/coverage.rb', line 53

def save_results
  slug = "#{Digest::MD5.hexdigest(Dir.pwd)}-#{Process.pid}"
  File.open(File.join(Dir.tmpdir, "rspec-puppet-filter-#{slug}"), 'w+') do |f|
    f.puts @filters.to_json
  end
  File.open(File.join(Dir.tmpdir, "rspec-puppet-filter_regex-#{slug}"), 'w+') do |f|
    f.puts @filters_regex.to_json
  end
  File.open(File.join(Dir.tmpdir, "rspec-puppet-coverage-#{slug}"), 'w+') do |f|
    f.puts @collection.to_json
  end
end