class RSpec::Puppet::ManifestMatchers::Compile

Public Class Methods

new() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 6
def initialize
  @failed_resource = ''
  @check_deps = false
  @cycles = []
  @error_msg = ''
end

Public Instance Methods

and_raise_error(error) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 18
def and_raise_error(error)
  @expected_error = error
  self
end
description() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 43
def description
  case @expected_error
  when nil
    'compile into a catalogue without dependency cycles'
  when Regexp
    "fail to compile and raise an error matching #{@expected_error.inspect}"
  else
    "fail to compile and raise the error #{@expected_error.inspect}"
  end
end
failure_message() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 54
def failure_message
  if @cycles.empty?
    if @error_msg.empty?
      case @expected_error
      when nil
        "expected that the catalogue would include #{@failed_resource}"
      when Regexp
        "expected that the catalogue would fail to compile and raise an error matching #{@expected_error.inspect}"
      else
        "expected that the catalogue would fail to compile and raise the error #{@expected_error.inspect}"
      end
    else
      "error during compilation: #{@error_msg}"
    end
  else
    "dependency cycles found: #{@cycles.join('; ')}"
  end
end
failure_message_when_negated() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 73
def failure_message_when_negated
  if @expected_error.nil?
    'expected that the catalogue would not compile but it does'
  else
    'expected that the catalogue would compile but it does not'
  end
end
matches?(catalogue) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 23
def matches?(catalogue)
  @catalogue = catalogue.call

  if cycles_found?
    false
  elsif @check_deps == true && missing_dependencies?
    false
  else
    @expected_error.nil?
  end
rescue Puppet::Error => e
  @error_msg = e.message
  if @expected_error.nil?
    false
  else
    method = @expected_error.is_a?(Regexp) ? :=~ : :==
    e.message.send(method, @expected_error)
  end
end
supports_block_expectations() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 81
def supports_block_expectations
  true
end
supports_value_expectations() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 85
def supports_value_expectations
  true
end
with_all_deps() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 13
def with_all_deps
  @check_deps = true
  self
end

Private Instance Methods

check_resource(res) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 124
def check_resource(res)
  if resource_hash[res.ref]
    true
  elsif res[:alias] && resource_hash["#{res.type}[#{res[:alias]}]"]
    true
  else
    false
  end
end
cycles_found?() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 143
def cycles_found?
  cat = @catalogue.to_ral.relationship_graph
  cat.write_graph(:resources)
  if cat.respond_to? :find_cycles_in_graph
    find_cycles(cat)
  else
    find_cycles_legacy(cat)
  end

  !@cycles.empty?
end
find_cycles(catalogue) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 155
def find_cycles(catalogue)
  cycles = catalogue.find_cycles_in_graph
  return unless cycles.length.positive?

  cycles.each do |cycle|
    paths = catalogue.paths_in_cycle(cycle)
    @cycles << (paths.map { |path| "(#{path.join(' => ')})" }.join("\n") + "\n")
  end
end
find_cycles_legacy(catalogue) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 165
def find_cycles_legacy(catalogue)
  catalogue.topsort
rescue Puppet::Error => e
  @cycles = [e.message.rpartition(';').first.partition(':').last]
end
missing_dependencies?() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 91
def missing_dependencies?
  retval = false

  resource_vertices = @catalogue.vertices.select { |v| v.is_a? Puppet::Resource }
  resource_vertices.each do |vertex|
    vertex.each do |param, value|
      next unless %i[require subscribe notify before].include? param

      value = [value] unless value.is_a? Array
      value.each do |val|
        retval = true if val.is_a?(Puppet::Resource) && !resource_exists?(val, vertex)
      end
    end
  end

  retval
end
resource_exists?(res, vertex) click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 134
def resource_exists?(res, vertex)
  if check_resource(res)
    true
  else
    @failed_resource = "#{res.ref} used at #{vertex.file}:#{vertex.line} in #{vertex.ref}"
    false
  end
end
resource_hash() click to toggle source
# File lib/rspec-puppet/matchers/compile.rb, line 109
def resource_hash
  @resource_hash ||= proc do
    res_hash = {}
    @catalogue.vertices.each do |vertex|
      next unless vertex.is_a? Puppet::Resource

      res_hash[vertex.ref] = 1
      res_hash["#{vertex.type}[#{vertex[:alias]}]"] = 1 if vertex[:alias]

      res_hash["#{vertex.type}[#{vertex.uniqueness_key.first}]"] = 1 if vertex.uniqueness_key != [vertex.title]
    end
    res_hash
  end.call
end