rspec-puppet-facts 1.9.2 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,6 @@ require 'puppet'
2
2
  require 'facter'
3
3
  require 'facterdb'
4
4
  require 'json'
5
- require 'mcollective'
6
5
 
7
6
  # The purpose of this module is to simplify the Puppet
8
7
  # module's RSpec tests by looping through all supported
@@ -31,7 +30,7 @@ module RspecPuppetFacts
31
30
  opts[:hardwaremodels] ||= ['x86_64']
32
31
  opts[:hardwaremodels] = [opts[:hardwaremodels]] unless opts[:hardwaremodels].is_a? Array
33
32
  opts[:supported_os] ||= RspecPuppetFacts.meta_supported_os
34
- opts[:facterversion] ||= Facter.version
33
+ opts[:facterversion] ||= RSpec.configuration.default_facter_version
35
34
 
36
35
  unless (facterversion = opts[:facterversion]) =~ /\A\d+\.\d+(?:\.\d+)*\z/
37
36
  raise ArgumentError, ":facterversion must be in the format 'n.n' or " \
@@ -52,10 +51,10 @@ module RspecPuppetFacts
52
51
  filter = []
53
52
  opts[:supported_os].map do |os_sup|
54
53
  if os_sup['operatingsystemrelease']
55
- os_sup['operatingsystemrelease'].map do |operatingsystemmajrelease|
54
+ Array(os_sup['operatingsystemrelease']).map do |operatingsystemmajrelease|
56
55
  opts[:hardwaremodels].each do |hardwaremodel|
57
56
 
58
- os_release_filter = "/^#{operatingsystemmajrelease.split(' ')[0]}/"
57
+ os_release_filter = "/^#{Regexp.escape(operatingsystemmajrelease.split(' ')[0])}/"
59
58
  if os_sup['operatingsystem'] =~ /BSD/i
60
59
  hardwaremodel = 'amd64'
61
60
  elsif os_sup['operatingsystem'] =~ /Solaris/i
@@ -81,7 +80,6 @@ module RspecPuppetFacts
81
80
  end
82
81
 
83
82
  filter << {
84
- :facterversion => facter_version_filter,
85
83
  :operatingsystem => os_sup['operatingsystem'],
86
84
  :operatingsystemrelease => os_release_filter,
87
85
  :hardwaremodel => hardwaremodel,
@@ -91,7 +89,6 @@ module RspecPuppetFacts
91
89
  else
92
90
  opts[:hardwaremodels].each do |hardwaremodel|
93
91
  filter << {
94
- :facterversion => facter_version_filter,
95
92
  :operatingsystem => os_sup['operatingsystem'],
96
93
  :hardwaremodel => hardwaremodel,
97
94
  }
@@ -99,20 +96,39 @@ module RspecPuppetFacts
99
96
  end
100
97
  end
101
98
 
99
+ # FacterDB may have newer versions of facter data for which it contains a subset of all possible
100
+ # facter data (see FacterDB 0.5.2 for Facter releases 3.8 and 3.9). In this situation we need to
101
+ # cycle through and downgrade Facter versions per platform type until we find matching Facter data.
102
+ filter.each do |filter_spec|
103
+ facter_version_filter = RspecPuppetFacts.facter_version_to_filter(facterversion)
104
+ db = FacterDB.get_facts(filter_spec.merge({ :facterversion => facter_version_filter }))
105
+
106
+ version = facterversion
107
+ while db.empty? && version !~ /\A\d+\.0($|\.\d+)/
108
+ version = RspecPuppetFacts.down_facter_version(version)
109
+ facter_version_filter = RspecPuppetFacts.facter_version_to_filter(version)
110
+ db = FacterDB.get_facts(filter_spec.merge({ :facterversion => facter_version_filter }))
111
+ end
112
+
113
+ next if db.empty?
114
+
115
+ unless version == facterversion
116
+ if RspecPuppetFacts.spec_facts_strict?
117
+ raise ArgumentError, "No facts were found in the FacterDB for Facter v#{facterversion}, aborting"
118
+ else
119
+ RspecPuppetFacts.warning "No facts were found in the FacterDB for Facter v#{facterversion}, using v#{version} instead"
120
+ end
121
+ end
122
+
123
+ filter_spec[:facterversion] = facter_version_filter
124
+ end
125
+
102
126
  received_facts = FacterDB::get_facts(filter)
103
127
  unless received_facts.any?
104
128
  RspecPuppetFacts.warning "No facts were found in the FacterDB for: #{filter.inspect}"
105
129
  return {}
106
130
  end
107
131
 
108
- unless version == facterversion
109
- if RspecPuppetFacts.spec_facts_strict?
110
- raise ArgumentError, "No facts were found in the FacterDB for Facter v#{facterversion}, aborting"
111
- else
112
- RspecPuppetFacts.warning "No facts were found in the FacterDB for Facter v#{facterversion}, using v#{version} instead"
113
- end
114
- end
115
-
116
132
  os_facts_hash = {}
117
133
  received_facts.map do |facts|
118
134
  # Fix facter bug
@@ -134,9 +150,16 @@ module RspecPuppetFacts
134
150
  facts.merge! RspecPuppetFacts.common_facts
135
151
  os_facts_hash[os] = RspecPuppetFacts.with_custom_facts(os, facts)
136
152
  end
153
+
154
+ return stringify_keys(os_facts_hash) if RSpec.configuration.facterdb_string_keys
155
+
137
156
  os_facts_hash
138
157
  end
139
158
 
159
+ def stringify_keys(hash)
160
+ Hash[hash.collect { |k,v| [k.to_s, v.is_a?(Hash) ? stringify_keys(v) : v] }]
161
+ end
162
+
140
163
  # Register a custom fact that will be included in the facts hash.
141
164
  # If it should be limited to a particular OS, pass a :confine option
142
165
  # that contains the operating system(s) to confine to. If it should
@@ -211,12 +234,13 @@ module RspecPuppetFacts
211
234
  def self.common_facts
212
235
  return @common_facts if @common_facts
213
236
  @common_facts = {
214
- :mco_version => MCollective::VERSION,
215
- :puppetversion => Puppet.version,
216
- :rubysitedir => RbConfig::CONFIG['sitelibdir'],
217
- :rubyversion => RUBY_VERSION,
237
+ :puppetversion => Puppet.version,
238
+ :rubysitedir => RbConfig::CONFIG['sitelibdir'],
239
+ :rubyversion => RUBY_VERSION,
218
240
  }
219
241
 
242
+ @common_facts[:mco_version] = MCollective::VERSION if mcollective?
243
+
220
244
  if augeas?
221
245
  @common_facts[:augeasversion] = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD).get('/augeas/version')
222
246
  end
@@ -227,13 +251,26 @@ module RspecPuppetFacts
227
251
  # Determine if the Augeas gem is available.
228
252
  # @api private
229
253
  # @return [Boolean] true if the augeas gem could be loaded.
254
+ # :nocov:
230
255
  def self.augeas?
231
256
  require 'augeas'
232
257
  true
233
- rescue LoadError => e
234
- RspecPuppetFacts.warning "Failed to retrieve Augeas version: #{e}"
258
+ rescue LoadError
235
259
  false
236
260
  end
261
+ # :nocov:
262
+
263
+ # Determine if the mcollective gem is available
264
+ # @api private
265
+ # @return [Boolean] true if the mcollective gem could be loaded.
266
+ # :nocov:
267
+ def self.mcollective?
268
+ require 'mcollective'
269
+ true
270
+ rescue LoadError
271
+ false
272
+ end
273
+ # :nocov:
237
274
 
238
275
  # Get the "operatingsystem_support" structure from
239
276
  # the parsed metadata.json file
@@ -301,8 +338,50 @@ module RspecPuppetFacts
301
338
  # @param minor_subtractor [int] the value which to subtract by
302
339
  # @api private
303
340
  def self.down_facter_version(version, minor_subtractor = 1)
304
- major, minor, z = version.split('.')
305
- minor = (minor.to_i - minor_subtractor).to_s
306
- "#{major}.#{minor}.#{z}"
341
+ major, minor, z = version.split('.')
342
+ z = '0' if z.nil?
343
+ minor = (minor.to_i - minor_subtractor).to_s
344
+ "#{major}.#{minor}.#{z}"
345
+ end
346
+
347
+ def self.facter_version_for_puppet_version(puppet_version)
348
+ return Facter.version if puppet_version.nil?
349
+
350
+ json_path = File.expand_path(File.join(__dir__, '..', 'ext', 'puppet_agent_components.json'))
351
+ unless File.file?(json_path) && File.readable?(json_path)
352
+ warning "#{json_path} does not exist or is not readable, defaulting to Facter #{Facter.version}"
353
+ return Facter.version
354
+ end
355
+
356
+ fd = File.open(json_path, 'rb:UTF-8')
357
+ data = JSON.parse(fd.read)
358
+
359
+ version_map = data.map { |_, versions|
360
+ if versions['puppet'].nil? || versions['facter'].nil?
361
+ nil
362
+ else
363
+ [Gem::Version.new(versions['puppet']), versions['facter']]
364
+ end
365
+ }.compact
366
+
367
+ puppet_gem_version = Gem::Version.new(puppet_version)
368
+ applicable_versions = version_map.select { |p, _| puppet_gem_version >= p }
369
+ if applicable_versions.empty?
370
+ warning "Unable to find Puppet #{puppet_version} in #{json_path}, defaulting to Facter #{Facter.version}"
371
+ return Facter.version
372
+ end
373
+
374
+ applicable_versions.sort { |a, b| b.first <=> a.first }.first.last
375
+ rescue JSON::ParserError
376
+ warning "#{json_path} contains invalid JSON, defaulting to Facter #{Facter.version}"
377
+ Facter.version
378
+ ensure
379
+ fd.close if fd
307
380
  end
308
381
  end
382
+
383
+ RSpec.configure do |c|
384
+ c.add_setting :default_facter_version,
385
+ :default => RspecPuppetFacts.facter_version_for_puppet_version(Puppet.version)
386
+ c.add_setting :facterdb_string_keys, :default => false
387
+ end
@@ -1,26 +1,26 @@
1
1
  # -*- encoding: utf-8 -*-
2
- $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
3
- require "rspec-puppet-facts/version"
2
+
3
+ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
4
+ require 'rspec-puppet-facts/version'
4
5
 
5
6
  Gem::Specification.new do |s|
6
- s.name = "rspec-puppet-facts"
7
+ s.name = 'rspec-puppet-facts'
7
8
  s.version = RspecPuppetFacts::Version::STRING
8
- s.authors = ["Mickaël Canévet"]
9
- s.email = ["mickael.canevet@camptocamp.com"]
10
- s.homepage = "http://github.com/mcanevet/rspec-puppet-facts"
11
- s.summary = "Standard facts fixtures for Puppet"
12
- s.description = "Contains facts from many Facter version on many Operating Systems"
9
+ s.authors = ['Mickaël Canévet']
10
+ s.email = ['mickael.canevet@camptocamp.com']
11
+ s.homepage = 'http://github.com/mcanevet/rspec-puppet-facts'
12
+ s.summary = 'Standard facts fixtures for Puppet'
13
+ s.description = 'Contains facts from many Facter version on many Operating Systems'
13
14
  s.licenses = 'Apache-2.0'
14
15
 
16
+ # see .travis.yml for the supported ruby versions
17
+ s.required_ruby_version = '>= 2.1.0'
18
+
15
19
  s.files = `git ls-files`.split("\n")
16
20
  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
17
- s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
21
+ s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
18
22
 
19
- if RUBY_VERSION =~ /^1\./
20
- s.add_development_dependency 'mime-types', '< 3.0'
21
- else
22
- s.add_development_dependency 'mime-types'
23
- end
23
+ s.add_development_dependency 'mime-types'
24
24
  s.add_development_dependency 'coveralls'
25
25
  s.add_development_dependency 'rake'
26
26
  s.add_development_dependency 'rspec'
@@ -29,5 +29,4 @@ Gem::Specification.new do |s|
29
29
  s.add_runtime_dependency 'json'
30
30
  s.add_runtime_dependency 'facter'
31
31
  s.add_runtime_dependency 'facterdb', '>= 0.5.0'
32
- s.add_runtime_dependency 'mcollective-client'
33
32
  end