Module: RSpec::Puppet::Support

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

Constant Summary collapse

@@cache = 
RSpec::Puppet::Cache.new
@@fixture_hiera_configs = 
Hash.new { |h, k| h[k] = nil }

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from GenericMatchers

#raise_error

Instance Attribute Details

#adapter ⇒ Class < RSpec::Puppet::Adapters::Base]

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Class < RSpec::Puppet::Adapters::Base].

Returns:



500
501
502
 
# File 'lib/rspec-puppet/support.rb', line 500

def adapter
  @adapter
end

Instance Method Details

#build_catalog(*args) ⇒ Object 



434
435
436
437
438
439
440
441
442
 
# File 'lib/rspec-puppet/support.rb', line 434

def build_catalog(*args)
  @@cache.get(*args) do |*args|
    if args.length == 1 && args.first.is_a?(Hash)
      build_catalog_without_cache_v2(**args.first)
    else
      build_catalog_without_cache(*args)
    end
  end
end

#build_catalog_without_cache(nodename, facts_val, trusted_facts_val, hiera_config_val, code, exported, node_params, *_) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/rspec-puppet/support.rb', line 368

def build_catalog_without_cache(nodename, facts_val, trusted_facts_val, hiera_config_val, code, exported,
                                node_params, *_)
  build_catalog_without_cache_v2({
                                   nodename: nodename,
                                   facts_val: facts_val,
                                   trusted_facts_val: trusted_facts_val,
                                   hiera_config_val: hiera_config_val,
                                   code: code,
                                   exported: exported,
                                   node_params: node_params,
                                   trusted_external: {},
                                 })
end

#build_catalog_without_cache_v2(nodename: nil, facts_val: nil, trusted_facts_val: nil, hiera_config_val: nil, code: nil, exported: nil, node_params: nil, trusted_external_data: nil, ignored_cache_params: {}) ⇒ Object 



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/rspec-puppet/support.rb', line 382

def build_catalog_without_cache_v2(
  nodename: nil,
  facts_val: nil,
  trusted_facts_val: nil,
  hiera_config_val: nil,
  code: nil,
  exported: nil,
  node_params: nil,
  trusted_external_data: nil,
  ignored_cache_params: {}
)

  # 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

  Puppet::Type.eachtype { |type| type.defaultprovider = nil }

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

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

  trusted_info = ['remote', nodename, trusted_facts_val]
  trusted_info.push(trusted_external_data)
  Puppet.push_context(
    {
      trusted_information: Puppet::Context::TrustedInformation.new(*trusted_info),
    },
    'Context for spec trusted hash',
  )

  node_obj.add_server_facts(server_facts_hash)

  adapter.catalog(node_obj, exported)
end

#build_code(type, manifest_opts) ⇒ Object 



23
24
25
 
# File 'lib/rspec-puppet/support.rb', line 23

def build_code(type, manifest_opts)
  [site_pp_str, pre_cond, test_manifest(type, manifest_opts), post_cond].compact.join("\n")
end

#class_name ⇒ Object 



181
182
183
 
# File 'lib/rspec-puppet/support.rb', line 181

def class_name
  self.class.top_level_description.downcase
end

#environment ⇒ Object 



19
20
21
 
# File 'lib/rspec-puppet/support.rb', line 19

def environment
  'rp_env'
end

#escape_special_chars(string) ⇒ Object 



460
461
462
 
# File 'lib/rspec-puppet/support.rb', line 460

def escape_special_chars(string)
  string.gsub('$', '\\$')
end

#facts_hash(node) ⇒ Object 



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/rspec-puppet/support.rb', line 205

def facts_hash(node)
  base_facts = {
    'clientversion' => Puppet::PUPPETVERSION,
    'environment' => environment.to_s,
  }

  node_facts = {
    'hostname' => node.split('.').first,
    'fqdn' => node,
    'domain' => node.split('.', 2).last,
    'clientcert' => node,
  }

  # Puppet 6.9.0 started setting a `serverip6` server fact which is set
  # using the value of the `ipaddress6` fact. If the fact set(s) provided
  # by FacterDB don't have an `ipaddress6` fact set, then the normal Facter
  # fact will be resolved, which can result in Ruby trying to load Windows
  # only gems on Linux. This is only a problem if facter is used.
  node_facts['ipaddress6'] = 'FE80:0000:0000:0000:AAAA:AAAA:AAAA' if RSpec.configuration.facter_implementation.to_sym == :facter

  networking_facts = {
    'hostname' => node_facts['hostname'],
    'fqdn' => node_facts['fqdn'],
    'domain' => node_facts['domain'],
  }

  result_facts = if RSpec.configuration.default_facts.any?
                   munge_facts(RSpec.configuration.default_facts)
                 else
                   {}
                 end

  # Merge in node facts so they always exist by default, but only if they
  # haven't been defined in `RSpec.configuration.default_facts`
  result_facts.merge!(munge_facts(node_facts)) { |_key, old_val, new_val| old_val.nil? ? new_val : old_val }
  (result_facts['networking'] ||= {}).merge!(networking_facts) do |_key, old_val, new_val|
    old_val.nil? ? new_val : old_val
  end

  # Merge in `let(:facts)` facts
  result_facts.merge!(munge_facts(base_facts))
  result_facts.merge!(munge_facts(facts)) if respond_to?(:facts)

  # Merge node facts again on top of `let(:facts)` facts, but only if
  # a node name is given with `let(:node)`
  if respond_to?(:node) && RSpec.configuration.derive_node_facts_from_nodename
    result_facts.merge!(munge_facts(node_facts))
    (result_facts['networking'] ||= {}).merge!(networking_facts)
  end

  # Facter currently supports lower case facts.  Bug FACT-777 has been submitted to support case sensitive
  # facts.
  result_facts.transform_keys(&:downcase)
end

#find_pretend_platform(test_facts) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rspec-puppet/support.rb', line 61

def find_pretend_platform(test_facts)
  from_value = lambda { |value|
    value.to_s.casecmp('windows').zero? ? :windows : :posix
  }

  %w[operatingsystem osfamily].each do |os_fact|
    return from_value.call(test_facts[os_fact]) if test_facts.key?(os_fact)
  end

  if test_facts.key?('os') && test_facts['os'].is_a?(Hash)
    %w[name family].each do |os_hash_key|
      return from_value.call(test_facts['os'][os_hash_key]) if test_facts['os'].key?(os_hash_key)
    end
  end

  nil
end

#fixture_spec_hiera_conf(mod) ⇒ Object 



464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/rspec-puppet/support.rb', line 464

def fixture_spec_hiera_conf(mod)
  return @@fixture_hiera_configs[mod.name] if @@fixture_hiera_configs.key?(mod.name)

  path = Pathname.new(mod.path)
  if path.join('spec').exist?
    path.join('spec').find do |file|
      Find.prune if %w[modules work-dir].any? do |dir|
        file.relative_path_from(path).to_s.start_with?("spec/fixtures/#{dir}")
      end
      return @@fixture_hiera_configs[mod.name] = file.to_s if file.basename.to_s.eql?(Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
    end
  end
  @@fixture_hiera_configs[mod.name]
end

#guess_type_from_path(path) ⇒ Object 



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

def guess_type_from_path(path)
  case path
  when %r{spec/defines}
    :define
  when %r{spec/classes}
    :class
  when %r{spec/functions}
    :function
  when %r{spec/hosts}
    :host
  when %r{spec/types}
    :type
  when %r{spec/type_aliases}
    :type_alias
  when %r{spec/provider}
    :provider
  else
    :unknown
  end
end

#load_catalogue(type, exported = false, manifest_opts = {}) ⇒ Object 



79
80
81
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
120
121
122
 
# File 'lib/rspec-puppet/support.rb', line 79

def load_catalogue(type, exported = false, manifest_opts = {})
  with_vardir do
    node_name = nodename(type)

    hiera_config_value = respond_to?(:hiera_config) ? hiera_config : nil
    hiera_data_value = respond_to?(:hiera_data) ? hiera_data : nil

    rspec_config_values = %i[
      disable_module_hiera
      use_fixture_spec_hiera
      fixture_hiera_configs
      fallback_to_default_hiera
    ].map { |setting| RSpec.configuration.send(setting) }

    build_facts = facts_hash(node_name)
    catalogue = build_catalog(
      nodename: node_name,
      facts_val: build_facts,
      trusted_facts_val: trusted_facts_hash(node_name),
      hiera_config_val: hiera_config_value,
      code: build_code(type, manifest_opts),
      exported: exported,
      node_params: node_params_hash,
      trusted_external_data: trusted_external_data_hash,
      ignored_cache_params: {
        hiera_data_value: hiera_data_value,
        rspec_config_values: rspec_config_values,
      },
    )

    test_module = (type == :host) ? nil : class_name.split('::').first
    if type == :define
      RSpec::Puppet::Coverage.add_filter(class_name, title)
    else
      RSpec::Puppet::Coverage.add_filter(type.to_s, class_name)
    end
    RSpec::Puppet::Coverage.add_from_catalog(catalogue, test_module)

    pretend_platform = find_pretend_platform(build_facts)
    Puppet::Util::Platform.pretend_to_be(pretend_platform) unless pretend_platform.nil?

    catalogue
  end
end

#munge_facts(facts) ⇒ Object 



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/rspec-puppet/support.rb', line 444

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

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

  facts
end

#node_params_hash ⇒ Object 



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

def node_params_hash
  params = RSpec.configuration.default_node_params
  if respond_to?(:node_params)
    params.merge(node_params)
  else
    params.dup
  end
end

#nodename(type) ⇒ Object 



171
172
173
174
175
176
177
178
179
 
# File 'lib/rspec-puppet/support.rb', line 171

def nodename(type)
  return node if respond_to?(:node)

  if %i[class define function].include? type
    Puppet[:certname]
  else
    class_name
  end
end

#param_str(params) ⇒ Object 



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

def param_str(params)
  param_str_from_hash(params)
end

#param_str_from_hash(params_hash) ⇒ Object 



340
341
342
343
344
345
346
 
# File 'lib/rspec-puppet/support.rb', line 340

def param_str_from_hash(params_hash)
  # the param_str has special quoting rules, because the top-level keys are the Puppet
  # params, which may not be quoted
  params_hash.collect do |k, v|
    "#{k} => #{str_from_value(v)}"
  end.join(', ')
end

#post_cond ⇒ Object 



195
196
197
198
199
200
201
202
203
 
# File 'lib/rspec-puppet/support.rb', line 195

def post_cond
  return unless respond_to?(:post_condition) && !post_condition.nil?

  if post_condition.is_a? Array
    post_condition.compact.join("\n")
  else
    post_condition
  end
end

#pre_cond ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/rspec-puppet/support.rb', line 185

def pre_cond
  return unless respond_to?(:pre_condition) && !pre_condition.nil?

  if pre_condition.is_a? Array
    pre_condition.compact.join("\n")
  else
    pre_condition
  end
end

#ref(type, title) ⇒ RSpec::Puppet::RawString

Helper to return a resource/node reference, so it gets translated in params to a raw string without quotes.

Parameters:

  • type (String) —

    reference type

  • title (String) —

    reference title

Returns:



485
486
487
 
# File 'lib/rspec-puppet/support.rb', line 485

def ref(type, title)
  RSpec::Puppet::RawString.new("#{type}['#{title}']")
end

#sanitise_resource_title(title) ⇒ Object 



167
168
169
 
# File 'lib/rspec-puppet/support.rb', line 167

def sanitise_resource_title(title)
  title.include?("'") ? title.inspect : "'#{title}'"
end

#sensitive(value) ⇒ RSpec::Puppet::Sensitive

Helper to return value wrapped in Sensitive type.

Parameters:

  • value (Object) —

    to wrap

Returns:



493
494
495
 
# File 'lib/rspec-puppet/support.rb', line 493

def sensitive(value)
  RSpec::Puppet::Sensitive.new(value)
end

#server_facts_hash ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/rspec-puppet/support.rb', line 291

def server_facts_hash
  server_facts = {}

  # Add our server version to the fact list
  server_facts['serverversion'] = Puppet.version.to_s

  # And then add the server name and IP
  { 'servername' => 'networking.fqdn', 'serverip' => 'networking.ip' }.each do |var, fact|
    if (value = Puppet.runtime[:facter].value(fact))
      server_facts[var] = value
    else
      warn "Could not retrieve fact #{fact}"
    end
  end

  if server_facts['servername'].nil?
    host = Puppet.runtime[:facter].value('networking.hostname')
    server_facts['servername'] = if (domain = Puppet.runtime[:facter].value('networking.domain'))
                                   [host, domain].join('.')
                                 else
                                   host
                                 end
  end
  server_facts
end

#setup_puppet ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/rspec-puppet/support.rb', line 348

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

  adapter.modulepath.map do |d|
    Dir["#{d}/*/lib"].entries
  end.flatten.each do |lib|
    $LOAD_PATH << lib
  end

  vardir
end

#site_pp_str ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rspec-puppet/support.rb', line 124

def site_pp_str
  return '' unless (path = adapter.manifest)

  if File.file?(path)
    File.read(path)
  elsif File.directory?(path)
    # Read and concatenate all .pp files.
    Dir[File.join(path, '*.pp')].map do |f|
      File.read(f)
    end.join("\n")
  else
    ''
  end
end

#str_from_value(value) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/rspec-puppet/support.rb', line 317

def str_from_value(value)
  case value
  when Hash
    kvs = value.collect do |k, v|
      "#{str_from_value(k)} => #{str_from_value(v)}"
    end.join(', ')
    "{ #{kvs} }"
  when Array
    vals = value.map do |v|
      str_from_value(v)
    end.join(', ')
    "[ #{vals} ]"
  when :default
    'default' # verbatim default keyword
  when :undef
    'undef' # verbatim undef keyword
  when Symbol
    str_from_value(value.to_s)
  else
    escape_special_chars(value.inspect)
  end
end

#stub_facts!(facts) ⇒ Object 



428
429
430
431
432
 
# File 'lib/rspec-puppet/support.rb', line 428

def stub_facts!(facts)
  Puppet.settings[:autosign] = false if Puppet.settings.include? :autosign
  Puppet.runtime[:facter].clear
  facts.each { |k, v| Puppet.runtime[:facter].add(k, weight: 999) { setcode { v } } }
end

#stub_file_consts(example) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rspec-puppet/support.rb', line 48

def stub_file_consts(example)
  type = if example.respond_to?(:metadata)
           example.metadata[:type]
         else
           guess_type_from_path(example.example.metadata[:file_path])
         end

  munged_facts = facts_hash(nodename(type))

  pretend_platform = find_pretend_platform(munged_facts)
  RSpec::Puppet::Consts.stub_consts_for(pretend_platform) unless pretend_platform.nil?
end

#subject ⇒ Object 



15
16
17
 
# File 'lib/rspec-puppet/support.rb', line 15

def subject
  -> { catalogue }
end

#test_manifest(type, opts = {}) ⇒ Object 



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

def test_manifest(type, opts = {})
  opts[:params] = params if respond_to?(:params)

  case type
  when :class
    if opts[:params].nil? || opts[:params] == {}
      "include #{class_name}"
    else
      "class { '#{class_name}': #{param_str(opts[:params])} }"
    end
  when :define
    title_str = if title.is_a?(Array)
                  '[' + title.map { |r| sanitise_resource_title(r) }.join(', ') + ']'
                else
                  sanitise_resource_title(title)
                end
    if opts.key?(:params)
      "#{class_name} { #{title_str}: #{param_str(opts[:params])} }"
    else
      "#{class_name} { #{title_str}: }"
    end
  when :host
    nil
  when :type_alias
    "$test = #{str_from_value(opts[:test_value])}\nassert_type(#{self.class.top_level_description}, $test)"
  end
end

#trusted_external_data_hash ⇒ Object 



282
283
284
285
286
287
288
289
 
# File 'lib/rspec-puppet/support.rb', line 282

def trusted_external_data_hash
  external_data = {}

  external_data.merge!(munge_facts(RSpec.configuration.default_trusted_external_data)) if RSpec.configuration.default_trusted_external_data.any?

  external_data.merge!(munge_facts(trusted_external_data)) if respond_to?(:trusted_external_data)
  external_data
end

#trusted_facts_hash(_node_name) ⇒ Object 



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

def trusted_facts_hash(_node_name)
  extensions = {}

  extensions.merge!(munge_facts(RSpec.configuration.default_trusted_facts)) if RSpec.configuration.default_trusted_facts.any?

  extensions.merge!(munge_facts(trusted_facts)) if respond_to?(:trusted_facts)
  extensions
end

#with_vardir ⇒ Object 



361
362
363
364
365
366
 
# File 'lib/rspec-puppet/support.rb', line 361

def with_vardir
  vardir = setup_puppet
  yield(vardir) if block_given?
ensure
  FileUtils.rm_rf(vardir) if vardir && File.directory?(vardir)
end