Class: RSpec::Puppet::ManifestMatchers::CreateGeneric

Inherits:
Object
  • Object
show all
Includes:
Errors
Defined in:
lib/rspec-puppet/matchers/create_generic.rb

Instance Method Summary collapse

Constructor Details

#initialize(*args, &block) ⇒ CreateGeneric

Returns a new instance of CreateGeneric.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 9

def initialize(*args, &block)
  @exp_resource_type = args.shift.to_s.gsub(/^(create|contain)_/, '')
  @args = args
  @block = block
  @referenced_type = referenced_type(@exp_resource_type)
  @title = args[0]

  @errors = []
  @expected_params = []
  @expected_undef_params = []
  @notifies = []
  @subscribes = []
  @requires = []
  @befores = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 63

def method_missing(method, *args, &block)
  if method.to_s =~ /^with_/
    param = method.to_s.gsub(/^with_/, '')
    @expected_params << [param, args[0]]
    self
  elsif method.to_s =~ /^only_with_/
    param = method.to_s.gsub(/^only_with_/, '')
    @expected_params_count = (@expected_params_count || 0) + 1
    @expected_params << [param, args[0]]
    self
  elsif method.to_s =~ /^without_/
    param = method.to_s.gsub(/^without_/, '')
    @expected_undef_params << [param, args[0]]
    self
  else
    super
  end
end

Instance Method Details

#actual ⇒ Object 



184
185
186
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 184

def actual
  @errors.map {|e| e.actual if e.respond_to?(:actual)}.compact.join("\n\n")
end

#description ⇒ Object 



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
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 129

def description
  values = []
  value_str_prefix = "with"

  if @expected_params_count
    values << "exactly #{@expected_params_count} parameters"
  end

  if @expected_params.any?
    values.concat(generate_param_list(@expected_params, :should))
  end

  if @expected_undef_params.any?
    values.concat(generate_param_list(@expected_undef_params, :not))
  end

  if @notifies.any?
    value_str_prefix = "that notifies"
    values = @notifies
  end

  if @subscribes.any?
    value_str_prefix = "that subscribes to"
    values = @subscribes
  end

  if @requires.any?
    value_str_prefix = "that requires"
    values = @requires
  end

  if @befores.any?
    value_str_prefix = "that comes before"
    values = @befores
  end

  unless values.empty?
    if values.length == 1
      value_str = " #{value_str_prefix} #{values.first}"
    else
      value_str = " #{value_str_prefix} #{values[0..-2].join(", ")} and #{values[-1]}"
    end
  end

  "contain #{@referenced_type}[#{@title}]#{value_str}"
end

#diffable? ⇒ Boolean

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 176

def diffable?
  true
end

#expected ⇒ Object 



180
181
182
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 180

def expected
  @errors.map {|e| e.expected if e.respond_to?(:expected)}.compact.join("\n\n")
end

#failure_message ⇒ Object 



121
122
123
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 121

def failure_message
  "expected that the catalogue would contain #{@referenced_type}[#{@title}]#{errors}"
end

#failure_message_when_negated ⇒ Object 



125
126
127
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 125

def failure_message_when_negated
  "expected that the catalogue would not contain #{@referenced_type}[#{@title}]#{errors}"
end

#matches?(catalogue) ⇒ Boolean

Returns:

  • (Boolean) 


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
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 82

def matches?(catalogue)
  ret = true
  @catalogue = catalogue.is_a?(Puppet::Resource::Catalog) ? catalogue : catalogue.call
  resource = @catalogue.resource(@referenced_type, @title)

  if resource.nil?
    false
  else
    RSpec::Puppet::Coverage.cover!(resource)
    rsrc_hsh = resource.to_hash

    if resource.builtin_type?
      namevar = resource.resource_type.key_attributes.first.to_s
    else
      namevar = 'name'
    end

    unless @expected_params.any? { |param| param.first.to_s == namevar }
      rsrc_hsh.delete(namevar.to_sym) if rsrc_hsh.has_key?(namevar.to_sym)
    end

    if @expected_params_count
      unless rsrc_hsh.size == @expected_params_count
        ret = false
        (@errors ||= []) << "exactly #{@expected_params_count} parameters but the catalogue contains #{rsrc_hsh.size}"
      end
    end

    check_params(rsrc_hsh, @expected_params, :should) if @expected_params.any?
    check_params(rsrc_hsh, @expected_undef_params, :not) if @expected_undef_params.any?
    check_befores(@catalogue, resource) if @befores.any?
    check_requires(@catalogue, resource) if @requires.any?
    check_notifies(@catalogue, resource) if @notifies.any?
    check_subscribes(@catalogue, resource) if @subscribes.any?

    @errors.empty?
  end
end

#only_with(*args, &block) ⇒ Object 



31
32
33
34
35
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 31

def only_with(*args, &block)
  params = args.shift
  @expected_params_count = (@expected_params_count || 0) + params.select { |_, v| !v.nil? }.size
  self.with(params, &block)
end

#that_comes_before(resource) ⇒ Object 



58
59
60
61
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 58

def that_comes_before(resource)
  @befores.concat(Array(resource))
  self
end

#that_notifies(resource) ⇒ Object 



43
44
45
46
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 43

def that_notifies(resource)
  @notifies.concat(Array(resource))
  self
end

#that_requires(resource) ⇒ Object 



53
54
55
56
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 53

def that_requires(resource)
  @requires.concat(Array(resource))
  self
end

#that_subscribes_to(resource) ⇒ Object 



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

def that_subscribes_to(resource)
  @subscribes.concat(Array(resource))
  self
end

#with(*args, &block) ⇒ Object 



25
26
27
28
29
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 25

def with(*args, &block)
  params = args.shift
  @expected_params = @expected_params | params.to_a
  self
end

#without(*args, &block) ⇒ Object 



37
38
39
40
41
 
# File 'lib/rspec-puppet/matchers/create_generic.rb', line 37

def without(*args, &block)
  params = args.shift
  @expected_undef_params = @expected_undef_params | Array(params)
  self
end