Module: RSpec::Puppet::Support

Included in:
ClassExampleGroup, DefineExampleGroup, FunctionExampleGroup, HostExampleGroup, TypeExampleGroup
Defined in:
lib/rspec-puppet/support.rb

Constant Summary collapse

@@cache = 
RSpec::Puppet::Cache.new

Instance Method Summary collapse

Instance Method Details

#build_4x_environment(name) ⇒ Object 



273
274
275
276
277
 
# File 'lib/rspec-puppet/support.rb', line 273

def build_4x_environment(name)
  modulepath = RSpec.configuration.module_path || File.join(Puppet[:environmentpath], 'fixtures', 'modules')
  manifest = RSpec.configuration.manifest || File.join(Puppet[:environmentpath], 'fixtures', 'manifests')
  Puppet::Node::Environment.create(name, [modulepath], manifest)
end

#build_catalog(*args) ⇒ Object 



240
241
242
243
244
 
# File 'lib/rspec-puppet/support.rb', line 240

def build_catalog(*args)
  @@cache.get(*args) do |*args|
    build_catalog_without_cache(*args)
  end
end

#build_catalog_without_cache(nodename, facts_val, hiera_config_val, code) ⇒ Object 



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

def build_catalog_without_cache(nodename, facts_val, hiera_config_val, code)

  # If we're going to rebuild the catalog, we should clear the cached instance
  # of Hiera that Puppet is using.  This opens the possibility of the catalog
  # now being rebuilt against a differently configured Hiera (i.e. :hiera_config
  # set differently in one example group vs. another).
  # It would be nice if Puppet offered a public API for invalidating their
  # cached instance of Hiera, but que sera sera.  We will go directly against
  # the implementation out of absolute necessity.
  HieraPuppet.instance_variable_set('@hiera', nil) if defined? HieraPuppet

  Puppet[:code] = code

  stub_facts! facts_val

  node_facts = Puppet::Node::Facts.new(nodename, facts_val.dup)

  node_obj = Puppet::Node.new(nodename, { :parameters => facts_val, :facts => node_facts })

  # trying to be compatible with 2.7 as well as 2.6
  if Puppet::Resource::Catalog.respond_to? :find
    Puppet::Resource::Catalog.find(node_obj.name, :use_node => node_obj)
  elsif Puppet.version.to_f >= 4.0
    env = build_4x_environment(environment)
    loader = Puppet::Environments::Static.new(env)
    Puppet.override({:environments => loader}, 'Setup test environment') do
      node_obj.environment = env
      Puppet::Resource::Catalog.indirection.find(node_obj.name, :use_node => node_obj)
    end
  else
    Puppet::Resource::Catalog.indirection.find(node_obj.name, :use_node => node_obj)
  end
end

#class_name ⇒ Object 



100
101
102
 
# File 'lib/rspec-puppet/support.rb', line 100

def class_name
  self.class.top_level_description.downcase
end

#environment ⇒ Object 



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

def environment
  # unfreeze PUPPETVERSION because of https://github.com/bundler/bundler/issues/3187
  ver = Gem::Version.new("#{Puppet::PUPPETVERSION}")
  # Since applying a fix for PUP-5522 (puppet 3.8.5 and 4.3.2) puppet symbolizes environment names
  # internally. The catalog cache needs to assume that the facts and other args do not change between
  # runs, so we have to mirror this here. Puppet versions before the change require a string as environment
  # name, or they fail with "Unsupported data type: 'Symbol' on node xyz"
  # See https://github.com/rodjek/rspec-puppet/pull/354 and PUP-5743 for discussion of this
  if (Gem::Version.new('3.8.5') <= ver && ver < Gem::Version.new('4.0.0')) || Gem::Version.new('4.3.2') <= ver
    :rp_env
  else
    'rp_env'
  end
end

#escape_special_chars(string) ⇒ Object 



260
261
262
263
 
# File 'lib/rspec-puppet/support.rb', line 260

def escape_special_chars(string)
  string.gsub!(/\$/, "\\$")
  string
end

#facts_hash(node) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/rspec-puppet/support.rb', line 116

def facts_hash(node)
  facts_val = {
    'clientversion' => Puppet::PUPPETVERSION,
    'environment'   => environment,
    'hostname'      => node.split('.').first,
    'fqdn'          => node,
    'domain'        => node.split('.', 2).last,
    'clientcert'    => node
  }

  if RSpec.configuration.default_facts.any?
    facts_val.merge!(munge_facts(RSpec.configuration.default_facts))
  end

  facts_val.merge!(munge_facts(facts)) if self.respond_to?(:facts)
  facts_val
end

#import_str ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rspec-puppet/support.rb', line 49

def import_str
  import_str = ""
  Puppet[:modulepath].split(File::PATH_SEPARATOR).each { |d|
    if File.exists?(File.join(d, 'manifests', 'init.pp'))
      path_to_manifest = File.join([
        d,
        'manifests',
        class_name.split('::')[1..-1]
      ].flatten)
      import_str = [
        "import '#{d}/manifests/init.pp'",
        "import '#{path_to_manifest}.pp'",
        '',
      ].join("\n")
      break
    elsif File.exists?(d)
      import_str = "import '#{Puppet[:manifest]}'\n"
      break
    end
  }

  import_str
end

#load_catalogue(type) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rspec-puppet/support.rb', line 26

def load_catalogue(type)
  vardir = setup_puppet

  if Puppet.version.to_f >= 4.0 or Puppet[:parser] == 'future'
    code = [pre_cond, test_manifest(type)].compact.join("\n")
  else
    code = [import_str, pre_cond, test_manifest(type)].compact.join("\n")
  end

  node_name = nodename(type)

  hiera_config_value = self.respond_to?(:hiera_config) ? hiera_config : nil

  catalogue = build_catalog(node_name, facts_hash(node_name), hiera_config_value, code)

  test_module = class_name.split('::').first
  RSpec::Puppet::Coverage.add_filter(type.to_s, self.class.description)
  RSpec::Puppet::Coverage.add_from_catalog(catalogue, test_module)

  FileUtils.rm_rf(vardir) if File.directory?(vardir)
  catalogue
end

#munge_facts(facts) ⇒ Object

Facter currently supports lower case facts. Bug FACT-777 has been submitted to support case sensitive facts.



248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/rspec-puppet/support.rb', line 248

def munge_facts(facts)
  return facts.reduce({}) do | memo, (k, v)|
    memo.tap { |m| m[k.to_s.downcase] = munge_facts(v) }
  end if facts.is_a? Hash

  return facts.reduce([]) do |memo, v|
    memo << munge_facts(v); memo
  end if facts.is_a? Array

  facts
end

#nodename(type) ⇒ Object 



91
92
93
94
95
96
97
98
 
# File 'lib/rspec-puppet/support.rb', line 91

def nodename(type)
  return node if self.respond_to?(:node)
  if [:class, :define, :function].include? type
    Puppet[:certname]
  else
    class_name
  end
end

#param_str ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/rspec-puppet/support.rb', line 134

def param_str
  params.keys.map do |r|
    param_val = params[r]
    param_val_str = if param_val == :undef
                      'undef'  # verbatim undef keyword
                    else
                      escape_special_chars(param_val.inspect)
                    end
    "#{r.to_s} => #{param_val_str}"
  end.join(', ')
end

#pre_cond ⇒ Object 



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

def pre_cond
  if self.respond_to?(:pre_condition) && !pre_condition.nil?
    if pre_condition.is_a? Array
      pre_condition.compact.join("\n")
    else
      pre_condition
    end
  else
    nil
  end
end

#rspec_compatibility ⇒ Object 



265
266
267
268
269
270
271
 
# File 'lib/rspec-puppet/support.rb', line 265

def rspec_compatibility
  if RSpec::Version::STRING < '3'
    # RSpec 2 compatibility:
    alias_method :failure_message_for_should, :failure_message
    alias_method :failure_message_for_should_not, :failure_message_when_negated
  end
end

#setup_puppet ⇒ Object 



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

def setup_puppet
  vardir = Dir.mktmpdir
  Puppet[:vardir] = vardir

  if Puppet.version.to_f >= 4.0
    settings = [
      [:modulepath, :module_path],
      [:environmentpath, :environmentpath],
      [:config, :config],
      [:confdir, :confdir],
      [:hiera_config, :hiera_config],
      [:strict_variables, :strict_variables],
    ]
  elsif Puppet.version.to_f >= 3.0
    settings = [
      [:modulepath, :module_path],
      [:manifestdir, :manifest_dir],
      [:manifest, :manifest],
      [:templatedir, :template_dir],
      [:config, :config],
      [:confdir, :confdir],
      [:hiera_config, :hiera_config],
      [:parser, :parser],
      [:trusted_node_data, :trusted_node_data],
      [:ordering, :ordering],
      [:stringify_facts, :stringify_facts],
      [:strict_variables, :strict_variables],
    ]
  else
    settings = [
      [:modulepath, :module_path],
      [:manifestdir, :manifest_dir],
      [:manifest, :manifest],
      [:templatedir, :template_dir],
      [:config, :config],
      [:confdir, :confdir],
    ]
  end
  settings.each do |a,b|
    value = self.respond_to?(b) ? self.send(b) : RSpec.configuration.send(b)
    begin
      Puppet[a] = value
    rescue ArgumentError
      Puppet.settings.setdefaults(:main, {a => {:default => value, :desc => a.to_s}})
    end
  end

  Puppet[:modulepath].split(File::PATH_SEPARATOR).map do |d|
    Dir["#{d}/*/lib"].entries
  end.flatten.each do |lib|
    $LOAD_PATH << lib
  end

  vardir
end

#stub_facts!(facts) ⇒ Object 



236
237
238
 
# File 'lib/rspec-puppet/support.rb', line 236

def stub_facts!(facts)
  facts.each { |k, v| Facter.add(k) { setcode { v } } }
end

#subject ⇒ Object 



7
8
9
 
# File 'lib/rspec-puppet/support.rb', line 7

def subject
  lambda { catalogue }
end

#test_manifest(type) ⇒ Object 



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

def test_manifest(type)
  if type == :class
    if !self.respond_to?(:params) || params == {}
      "include #{class_name}"
    else
      "class { '#{class_name}': #{param_str} }"
    end
  elsif type == :define
    if self.respond_to? :params
      "#{class_name} { '#{title}': #{param_str} }"
    else
      "#{class_name} { '#{title}': }"
    end
  elsif type == :host
    nil
  end
end