Class: ChefSpec::Coverage

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/chefspec/coverage.rb,
lib/chefspec/coverage/filters.rb

Defined Under Namespace

Classes: BerkshelfFilter, BlockFilter, Filter, RegexpFilter, ResourceWrapper, StringFilter

Constant Summary collapse

EXIT_FAILURE =
1
EXIT_SUCCESS =
0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeCoverage

Create a new coverage object singleton.


28
29
30
31
# File 'lib/chefspec/coverage.rb', line 28

def initialize
  @collection = {}
  @filters    = {}
end

Instance Attribute Details

#filtersObject (readonly)

Returns the value of attribute filters


23
24
25
# File 'lib/chefspec/coverage.rb', line 23

def filters
  @filters
end

Class Method Details

.method_added(name) ⇒ Object


9
10
11
12
13
14
15
16
17
18
# File 'lib/chefspec/coverage.rb', line 9

def method_added(name)
  # Only delegate public methods
  if method_defined?(name)
    instance_eval <<-EOH, __FILE__, __LINE__ + 1
      def #{name}(*args, &block)
        instance.public_send(:#{name}, *args, &block)
      end
    EOH
  end
end

Instance Method Details

#add(resource) ⇒ Object

Add a resource to the resource collection. Only new resources are added and only resources that match the given filter are covered (which is * by default).


78
79
80
81
82
# File 'lib/chefspec/coverage.rb', line 78

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

#add_filter(filter = nil, &block) ⇒ true

Add a filter to the converage analysis.


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/chefspec/coverage.rb', line 52

def add_filter(filter = nil, &block)
  id = "#{filter.inspect}/#{block.inspect}".hash

  @filters[id] = if filter.kind_of?(Filter)
                   filter
                 elsif filter.kind_of?(String)
                   StringFilter.new(filter)
                 elsif filter.kind_of?(Regexp)
                   RegexpFilter.new(filter)
                 elsif block
                   BlockFilter.new(block)
                 else
                   raise ArgumentError, 'Please specify either a string, ' \
                     'filter, or block to filter source files with!'
                 end

  true
end

#cover!(resource) ⇒ Object

Called when a resource is matched to indicate it has been tested.


89
90
91
92
93
# File 'lib/chefspec/coverage.rb', line 89

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

#filtered?(resource) ⇒ Boolean

Called to check if a resource belongs to a cookbook from the specified directories.


101
102
103
# File 'lib/chefspec/coverage.rb', line 101

def filtered?(resource)
  filters.any? { |_, filter| filter.matches?(resource) }
end

#report!Object

Generate a coverage report. This report *must* be generated at_exit or else the entire resource collection may not be complete!

Examples:

Generating a report


ChefSpec::Coverage.report!

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
# File 'lib/chefspec/coverage.rb', line 113

def report!
  # Borrowed from simplecov#41
  #
  # If an exception is thrown that isn't a "SystemExit", we need to capture
  # that error and re-raise.
  if $!
    exit_status = $!.is_a?(SystemExit) ? $!.status : EXIT_FAILURE
  else
    exit_status = EXIT_SUCCESS
  end

  report = {}.tap do |h|
    h[:total]     = @collection.size
    h[:touched]   = @collection.count { |_, resource| resource.touched? }
    h[:coverage]  = ((h[:touched]/h[:total].to_f)*100).round(2)
  end

  report[:untouched_resources] = @collection.collect do |_, resource|
    resource unless resource.touched?
  end.compact

  template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
  erb = Erubis::Eruby.new(File.read(template))
  puts erb.evaluate(report)

  # Ensure we exit correctly (#351)
  Kernel.exit(exit_status) if exit_status && exit_status > 0
end

#start!(&block) ⇒ Object

Start the coverage reporting analysis. This method also adds the the at_exit handler for printing the coverage report.


37
38
39
40
# File 'lib/chefspec/coverage.rb', line 37

def start!(&block)
  instance_eval(&block) if block
  at_exit { ChefSpec::Coverage.report! }
end