Module: RspecPuppetFacts
- Defined in:
- lib/rspec-puppet-facts.rb,
lib/rspec-puppet-facts/version.rb
Overview
The purpose of this module is to simplify the Puppet module’s RSpec tests by looping through all supported OS’es and their facts data which is received from the FacterDB.
Defined Under Namespace
Modules: Version
Class Method Summary collapse
-
.augeas? ⇒ Boolean
private
Determine if the Augeas gem is available.
-
.common_facts ⇒ Hash <Symbol => String>
private
These facts are common for all OS’es and will be added to the facts retrieved from the FacterDB.
-
.down_facter_version(version, minor_subtractor = 1) ⇒ String
private
Subtracts from the minor version passed and returns a string representing the next minor version down.
-
.facter_version_to_filter(version) ⇒ String
private
Generates a JGrep statement expression for a specific facter version.
-
.mcollective? ⇒ Boolean
private
Determine if the mcollective gem is available :nocov:.
-
.meta_supported_os ⇒ Array<Hash>
private
Get the “operatingsystem_support” structure from the parsed metadata.json file in the metadata.
-
.metadata ⇒ Hash
private
Read the metadata file and parse its JSON content.
-
.metadata_file ⇒ String
private
This file contains the Puppet module’s metadata.
-
.register_custom_fact(name, value, options) ⇒ Object
private
Adds a custom fact to the @custom_facts variable.
-
.reset ⇒ Object
private
Reset the memoization to make the saved structures be generated again.
-
.spec_facts_os_filter ⇒ nil, String
private
If provided this filter can be used to limit the set of retrieved facts only to the matched OS names.
-
.spec_facts_strict? ⇒ Boolean
private
If SPEC_FACTS_STRICT is set to ‘yes`, RspecPuppetFacts will error on missing FacterDB entries, instead of warning & skipping the tests, or using an older facter version.
-
.warning(message) ⇒ Object
private
Print a warning message to the console.
-
.with_custom_facts(os, facts) ⇒ Hash
private
Adds any custom facts according to the rules defined for the operating system with the given facts.
Instance Method Summary collapse
-
#add_custom_fact(name, value, options = {}) ⇒ Object
Register a custom fact that will be included in the facts hash.
-
#on_supported_os(opts = {}) ⇒ Hash <String => Hash>
Use the provided options or the data from the metadata.json file to find a set of matching facts in the FacterDB.
- #stringify_keys(hash) ⇒ Object
Class Method Details
.augeas? ⇒ Boolean
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.
Determine if the Augeas gem is available. :nocov:
260 261 262 263 264 265 266 |
# File 'lib/rspec-puppet-facts.rb', line 260 def self.augeas? require 'augeas' true rescue LoadError => e RspecPuppetFacts.warning "Failed to retrieve Augeas version: #{e}" false end |
.common_facts ⇒ Hash <Symbol => String>
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.
These facts are common for all OS’es and will be added to the facts retrieved from the FacterDB
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/rspec-puppet-facts.rb', line 239 def self.common_facts return @common_facts if @common_facts @common_facts = { :puppetversion => Puppet.version, :rubysitedir => RbConfig::CONFIG['sitelibdir'], :rubyversion => RUBY_VERSION, } @common_facts[:mco_version] = MCollective::VERSION if mcollective? if augeas? @common_facts[:augeasversion] = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD).get('/augeas/version') end @common_facts end |
.down_facter_version(version, minor_subtractor = 1) ⇒ String
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.
Subtracts from the minor version passed and returns a string representing the next minor version down
346 347 348 349 350 |
# File 'lib/rspec-puppet-facts.rb', line 346 def self.down_facter_version(version, minor_subtractor = 1) major, minor, z = version.split('.') minor = (minor.to_i - minor_subtractor).to_s "#{major}.#{minor}.#{z}" end |
.facter_version_to_filter(version) ⇒ String
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.
Generates a JGrep statement expression for a specific facter version
336 337 338 339 |
# File 'lib/rspec-puppet-facts.rb', line 336 def self.facter_version_to_filter(version) major, minor = version.split('.') "/\\A#{major}\\.#{minor}\\./" end |
.mcollective? ⇒ Boolean
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.
Determine if the mcollective gem is available :nocov:
273 274 275 276 277 278 |
# File 'lib/rspec-puppet-facts.rb', line 273 def self.mcollective? require 'mcollective' true rescue LoadError false end |
.meta_supported_os ⇒ Array<Hash>
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.
Get the “operatingsystem_support” structure from the parsed metadata.json file in the metadata
287 288 289 290 291 292 |
# File 'lib/rspec-puppet-facts.rb', line 287 def self. unless ['operatingsystem_support'].is_a? Array fail StandardError, 'Unknown operatingsystem support in the metadata file!' end ['operatingsystem_support'] end |
.metadata ⇒ Hash
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.
Read the metadata file and parse its JSON content.
299 300 301 302 303 304 305 306 |
# File 'lib/rspec-puppet-facts.rb', line 299 def self. return @metadata if @metadata unless File.file? fail StandardError, "Can't find metadata.json... dunno why" end content = File.read @metadata = JSON.parse content end |
.metadata_file ⇒ String
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.
This file contains the Puppet module’s metadata
311 312 313 |
# File 'lib/rspec-puppet-facts.rb', line 311 def self. 'metadata.json' end |
.register_custom_fact(name, value, options) ⇒ Object
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.
Adds a custom fact to the @custom_facts variable.
194 195 196 197 |
# File 'lib/rspec-puppet-facts.rb', line 194 def self.register_custom_fact(name, value, ) @custom_facts ||= {} @custom_facts[name.to_s] = {:options => , :value => value} end |
.reset ⇒ Object
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.
Reset the memoization to make the saved structures be generated again
326 327 328 329 330 |
# File 'lib/rspec-puppet-facts.rb', line 326 def self.reset @custom_facts = nil @common_facts = nil @metadata = nil end |
.spec_facts_os_filter ⇒ nil, String
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.
If provided this filter can be used to limit the set of retrieved facts only to the matched OS names. The value is being taken from the SPEC_FACTS_OS environment variable and
224 225 226 |
# File 'lib/rspec-puppet-facts.rb', line 224 def self.spec_facts_os_filter ENV['SPEC_FACTS_OS'] end |
.spec_facts_strict? ⇒ Boolean
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.
If SPEC_FACTS_STRICT is set to ‘yes`, RspecPuppetFacts will error on missing FacterDB entries, instead of warning & skipping the tests, or using an older facter version.
231 232 233 |
# File 'lib/rspec-puppet-facts.rb', line 231 def self.spec_facts_strict? ENV['SPEC_FACTS_STRICT'] == 'yes' end |
.warning(message) ⇒ Object
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.
Print a warning message to the console
318 319 320 |
# File 'lib/rspec-puppet-facts.rb', line 318 def self.warning() STDERR.puts end |
.with_custom_facts(os, facts) ⇒ Hash
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.
Adds any custom facts according to the rules defined for the operating system with the given facts.
205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/rspec-puppet-facts.rb', line 205 def self.with_custom_facts(os, facts) return facts unless @custom_facts @custom_facts.each do |name, fact| next if fact[:options][:confine] && !fact[:options][:confine].include?(os) next if fact[:options][:exclude] && fact[:options][:exclude].include?(os) facts[name] = fact[:value].respond_to?(:call) ? fact[:value].call(os, facts) : fact[:value] end facts end |
Instance Method Details
#add_custom_fact(name, value, options = {}) ⇒ Object
Register a custom fact that will be included in the facts hash. If it should be limited to a particular OS, pass a :confine option that contains the operating system(s) to confine to. If it should be excluded on a particular OS, use :exclude.
179 180 181 182 183 184 |
# File 'lib/rspec-puppet-facts.rb', line 179 def add_custom_fact(name, value, = {}) [:confine] = [[:confine]] if [:confine].is_a?(String) [:exclude] = [[:exclude]] if [:exclude].is_a?(String) RspecPuppetFacts.register_custom_fact(name, value, ) end |
#on_supported_os(opts = {}) ⇒ Hash <String => Hash>
Use the provided options or the data from the metadata.json file to find a set of matching facts in the FacterDB. OS names and facts can be used in the Puppet RSpec tests to run the examples against all supported facts combinations.
The list of received OS facts can also be filtered by the SPEC_FACTS_OS environment variable. For example, if the variable is set to “debian” only the OS names which start with “debian” will be returned. It allows a user to quickly run the tests only on a single facts set without any file modifications.
select facts from, e.g.: ‘3.6’ will be used instead of the “operatingsystem_support” section if the metadata file even if the file is missing.
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 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 123 124 125 126 127 128 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 |
# File 'lib/rspec-puppet-facts.rb', line 34 def on_supported_os(opts = {}) opts[:hardwaremodels] ||= ['x86_64'] opts[:hardwaremodels] = [opts[:hardwaremodels]] unless opts[:hardwaremodels].is_a? Array opts[:supported_os] ||= RspecPuppetFacts. opts[:facterversion] ||= RSpec.configuration.default_facter_version unless (facterversion = opts[:facterversion]) =~ /\A\d+\.\d+(?:\.\d+)*\z/ raise ArgumentError, ":facterversion must be in the format 'n.n' or " \ "'n.n.n' (n is numeric), not '#{facterversion}'" end facter_version_filter = RspecPuppetFacts.facter_version_to_filter(facterversion) db = FacterDB.get_facts({ :facterversion => facter_version_filter }) version = facterversion while db.empty? && version !~ /\d+\.0\.\d+/ version = RspecPuppetFacts.down_facter_version(version) facter_version_filter = RspecPuppetFacts.facter_version_to_filter(version) db = FacterDB.get_facts({ :facterversion => facter_version_filter}) end filter = [] opts[:supported_os].map do |os_sup| if os_sup['operatingsystemrelease'] Array(os_sup['operatingsystemrelease']).map do || opts[:hardwaremodels].each do |hardwaremodel| os_release_filter = "/^#{.split(' ')[0]}/" if os_sup['operatingsystem'] =~ /BSD/i hardwaremodel = 'amd64' elsif os_sup['operatingsystem'] =~ /Solaris/i hardwaremodel = 'i86pc' elsif os_sup['operatingsystem'] =~ /AIX/i hardwaremodel = '/^IBM,.*/' os_release_filter = if =~ /\A(\d+)\.(\d+)\Z/ "/^#{$~[1]}#{$~[2]}00-/" else "/^#{}-/" end elsif os_sup['operatingsystem'] =~ /Windows/i hardwaremodel = version =~ /^[12]\./ ? 'x64' : 'x86_64' os_sup['operatingsystem'] = os_sup['operatingsystem'].downcase = [/\A(?:Server )?(.+)/i, 1] # force quoting because windows releases can contain spaces os_release_filter = "\"#{}\"" if == '2016' && Puppet::Util::Package.versioncmp(version, '3.4') < 0 os_release_filter = '/^10\\.0\\./' end end filter << { :operatingsystem => os_sup['operatingsystem'], :operatingsystemrelease => os_release_filter, :hardwaremodel => hardwaremodel, } end end else opts[:hardwaremodels].each do |hardwaremodel| filter << { :operatingsystem => os_sup['operatingsystem'], :hardwaremodel => hardwaremodel, } end end end # FacterDB may have newer versions of facter data for which it contains a subset of all possible # facter data (see FacterDB 0.5.2 for Facter releases 3.8 and 3.9). In this situation we need to # cycle through and downgrade Facter versions per platform type until we find matching Facter data. filter.each do |filter_spec| facter_version_filter = RspecPuppetFacts.facter_version_to_filter(facterversion) db = FacterDB.get_facts(filter_spec.merge({ :facterversion => facter_version_filter })) version = facterversion while db.empty? && version !~ /\d+\.0($|\.\d+)/ version = RspecPuppetFacts.down_facter_version(version) facter_version_filter = RspecPuppetFacts.facter_version_to_filter(version) db = FacterDB.get_facts(filter_spec.merge({ :facterversion => facter_version_filter })) end next if db.empty? unless version == facterversion if RspecPuppetFacts.spec_facts_strict? raise ArgumentError, "No facts were found in the FacterDB for Facter v#{facterversion}, aborting" else RspecPuppetFacts.warning "No facts were found in the FacterDB for Facter v#{facterversion}, using v#{version} instead" end end filter_spec[:facterversion] = facter_version_filter end received_facts = FacterDB::get_facts(filter) unless received_facts.any? RspecPuppetFacts.warning "No facts were found in the FacterDB for: #{filter.inspect}" return {} end os_facts_hash = {} received_facts.map do |facts| # Fix facter bug if facts[:operatingsystem] == 'Ubuntu' = facts[:operatingsystemrelease].split('.')[0..1].join('.') elsif facts[:operatingsystem] == 'OpenBSD' = facts[:operatingsystemrelease] elsif facts[:operatingsystem] == 'windows' && facts[:operatingsystemrelease].start_with?('10.0.') = '2016' else if facts[:operatingsystemmajrelease].nil? = facts[:operatingsystemrelease].split('.')[0] else = facts[:operatingsystemmajrelease] end end os = "#{facts[:operatingsystem].downcase}-#{}-#{facts[:hardwaremodel]}" next unless os.start_with? RspecPuppetFacts.spec_facts_os_filter if RspecPuppetFacts.spec_facts_os_filter facts.merge! RspecPuppetFacts.common_facts os_facts_hash[os] = RspecPuppetFacts.with_custom_facts(os, facts) end return stringify_keys(os_facts_hash) if RSpec.configuration.facterdb_string_keys os_facts_hash end |
#stringify_keys(hash) ⇒ Object
164 165 166 |
# File 'lib/rspec-puppet-facts.rb', line 164 def stringify_keys(hash) Hash[hash.collect { |k,v| [k.to_s, v.is_a?(Hash) ? stringify_keys(v) : v] }] end |