rspec-puppet-facts 1.9.1 → 2.0.0

data/lib/rspec-puppet-facts/version.rb

@@ -2,6 +2,6 @@ module RspecPuppetFacts
   # This module contains the current version constant
   module Version
     # The current version of this gem
-    STRING = '1.9.1'
+    STRING = '2.0.0'
   end
 end

data/rspec-puppet-facts.gemspec

@@ -1,33 +1,31 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "rspec-puppet-facts/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'rspec-puppet-facts/version'
 
 Gem::Specification.new do |s|
-  s.name        = "rspec-puppet-facts"
+  s.name        = 'rspec-puppet-facts'
   s.version     = RspecPuppetFacts::Version::STRING
-  s.authors     = ["Mickaël Canévet"]
-  s.email       = ["mickael.canevet@camptocamp.com"]
-  s.homepage    = "http://github.com/mcanevet/rspec-puppet-facts"
-  s.summary     = "Standard facts fixtures for Puppet"
-  s.description = "Contains facts from many Facter version on many Operating Systems"
+  s.authors     = ['Mickaël Canévet']
+  s.email       = ['mickael.canevet@camptocamp.com']
+  s.homepage    = 'http://github.com/mcanevet/rspec-puppet-facts'
+  s.summary     = 'Standard facts fixtures for Puppet'
+  s.description = 'Contains facts from many Facter version on many Operating Systems'
   s.licenses    = 'Apache-2.0'
 
+  # see .travis.yml for the supported ruby versions
+  s.required_ruby_version = '>= 2.4.0'
+
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
 
-  if RUBY_VERSION =~ /^1\./
-    s.add_development_dependency 'mime-types', '< 3.0'
-  else
-    s.add_development_dependency 'mime-types'
-  end
+  s.add_development_dependency 'mime-types'
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'
   s.add_runtime_dependency 'puppet'
-  s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'facter'
   s.add_runtime_dependency 'facterdb', '>= 0.5.0'
-  s.add_runtime_dependency 'mcollective-client'
 end

data/spec/rspec_puppet_facts_spec.rb

@@ -1,12 +1,176 @@
 require 'spec_helper'
 require 'json'
+require 'stringio'
 
 describe RspecPuppetFacts do
   let(:metadata_file) do
     'spec/fixtures/metadata.json'
   end
 
+  describe '.facter_version_for_puppet_version' do
+    subject(:facter_version) do
+      described_class.facter_version_for_puppet_version(puppet_version)
+    end
+
+    let(:component_json_path) do
+      File.expand_path(File.join(__dir__, '..', 'ext', 'puppet_agent_components.json'))
+    end
+
+    let(:puppet_version) { Puppet.version }
+
+    context 'when the component JSON file does not exist' do
+      before(:each) do
+        allow(File).to receive(:file?).with(component_json_path).and_return(false)
+        allow(described_class).to receive(:warning)
+      end
+
+      it 'defaults to the currently installed Facter version' do
+        expect(facter_version).to eq(Facter.version)
+      end
+
+      it 'warns the user' do
+        msg = /does not exist or is not readable, defaulting to/i
+        expect(described_class).to receive(:warning).with(a_string_matching(msg))
+        facter_version
+      end
+    end
+
+    context 'when the component JSON file is unreadable' do
+      before(:each) do
+        allow(File).to receive(:readable?).with(component_json_path).and_return(false)
+        allow(described_class).to receive(:warning)
+      end
+
+      it 'defaults to the currently installed Facter version' do
+        expect(facter_version).to eq(Facter.version)
+      end
+
+      it 'warns the user' do
+        msg = /does not exist or is not readable, defaulting to/i
+        expect(described_class).to receive(:warning).with(a_string_matching(msg))
+        facter_version
+      end
+    end
+
+    context 'when the component JSON file is unparseable' do
+      before(:each) do
+        io = StringIO.new('this is not JSON!')
+        allow(File).to receive(:open).with(component_json_path, anything).and_return(io)
+        allow(described_class).to receive(:warning)
+      end
+
+      it 'defaults to the currently installed Facter version' do
+        expect(facter_version).to eq(Facter.version)
+      end
+
+      it 'warns the user' do
+        msg = /contains invalid json, defaulting to/i
+        expect(described_class).to receive(:warning).with(a_string_matching(msg))
+        facter_version
+      end
+    end
+
+    context 'when the passed puppet_version is nil' do
+      let(:puppet_version) { nil }
+
+      it 'defaults to the currently installed Facter version' do
+        expect(facter_version).to eq(Facter.version)
+      end
+    end
+
+    context 'when passed a Puppet version greater than any known version' do
+      let(:puppet_version) { '999.0.0' }
+
+      it 'returns the Facter version for the highest known Puppet version' do
+        known_facter_versions = JSON.parse(File.read(component_json_path)).map do |_, r|
+          r['facter']
+        end
+        sorted_facter_versions = known_facter_versions.compact.sort do |a, b|
+          Gem::Version.new(b) <=> Gem::Version.new(a)
+        end
+
+        expect(facter_version).to eq(sorted_facter_versions.first)
+      end
+    end
+
+    context 'when passed a known Puppet version' do
+      let(:puppet_version) { '5.2.0' }
+
+      it 'returns the Facter version for that Puppet version' do
+        expect(facter_version).to eq('3.9.0')
+      end
+    end
+
+    context 'when passed a Puppet version between two known versions' do
+      let(:puppet_version) { '5.2.5' }
+
+      it 'returns the Facter version for the lower Puppet version' do
+        expect(facter_version).to eq('3.9.0')
+      end
+    end
+
+    context 'when passed a Puppet version lower than any known version' do
+      let(:puppet_version) { '1.0.0' }
+
+      before(:each) do
+        allow(described_class).to receive(:warning)
+      end
+
+      it 'returns the currently installed Facter version' do
+        expect(facter_version).to eq(Facter.version)
+      end
+
+      it 'warns the user' do
+        msg = /unable to find puppet #{Regexp.escape(puppet_version)}.+?, defaulting to/i
+        expect(described_class).to receive(:warning).with(a_string_matching(msg))
+        facter_version
+      end
+    end
+  end
+
   describe '#on_supported_os' do
+    context 'With RSpec.configuration.facterdb_string_keys' do
+      subject(:result) do
+        on_supported_os(
+          {
+            :supported_os => [
+              {
+                "operatingsystem"        => "Debian",
+                "operatingsystemrelease" => ['7'],
+              },
+            ],
+          }
+        )
+      end
+
+      let(:get_keys) do
+        proc { |r| r.keys + r.select { |_,v| v.is_a?(Hash) }.map { |_,v| get_keys.call(v) }.flatten }
+      end
+
+      context 'set to true' do
+        before(:each) do
+          RSpec.configuration.facterdb_string_keys = true
+        end
+
+        after(:each) do
+          RSpec.configuration.facterdb_string_keys = false
+        end
+
+        it 'returns a fact set with all the keys as Strings' do
+          expect(get_keys.call(result['debian-7-x86_64'])).to all(be_a(String))
+        end
+      end
+
+      context 'set to false' do
+        before(:each) do
+          RSpec.configuration.facterdb_string_keys = false
+        end
+
+        it 'returns a fact set with all the keys as Symbols or Strings' do
+          expect(get_keys.call(result['debian-7-x86_64'])).to all(be_a(Symbol).or(be_a(String)))
+        end
+      end
+    end
 
     context 'Without specifying supported_os' do
       subject { on_supported_os }
@@ -142,6 +306,30 @@ describe RspecPuppetFacts do
       end
     end
 
+    context 'When specifying a supported_os with a single release as a String' do
+      subject(:factsets) do
+        on_supported_os(
+          {
+            :supported_os => [
+              { 'operatingsystem' => 'RedHat', 'operatingsystemrelease' => '7' },
+            ]
+          }
+        )
+      end
+
+      it 'returns a Hash' do
+        expect(factsets).to be_a(Hash)
+      end
+
+      it 'returns a single fact set' do
+        expect(factsets.size).to eq(1)
+      end
+
+      it 'returns a fact set for the specified release' do
+        expect(factsets).to include('redhat-7-x86_64' => include(:operatingsystemmajrelease => '7'))
+      end
+    end
+
     context 'When testing Ubuntu' do
       subject {
         on_supported_os(
@@ -161,17 +349,13 @@ describe RspecPuppetFacts do
       }
 
       let(:expected_fact_sets) do
-        if Facter.version.to_f < 1.7
-          ['ubuntu-12.04-x86_64', 'ubuntu-14.04-x86_64']
-        else
-          ['ubuntu-12.04-x86_64', 'ubuntu-14.04-x86_64', 'ubuntu-16.04-x86_64']
-        end
+        ['ubuntu-12.04-x86_64', 'ubuntu-14.04-x86_64', 'ubuntu-16.04-x86_64']
       end
 
       it 'should return a hash' do
         expect(subject.class).to eq Hash
       end
-      it 'should have 4 elements' do
+      it 'should have 3 elements' do
         expect(subject.size).to eq(expected_fact_sets.size)
       end
       it 'should return supported OS' do
@@ -306,16 +490,19 @@ describe RspecPuppetFacts do
                 'operatingsystemrelease' => release,
               }
             ],
+            :facterversion => facterversion,
           }
         )
       end
 
+      let(:facterversion) { '3.8.0' }
+
       context 'with a standard release' do
         let(:release) { ['7'] }
 
         it { is_expected.to be_a(Hash) }
         it { is_expected.to have_attributes(:size => 1) }
-        it { is_expected.to include('windows-7-x64' => an_instance_of(Hash)) }
+        it { is_expected.to include('windows-7-x86_64' => an_instance_of(Hash)) }
       end
 
       context 'with a revision release' do
@@ -323,7 +510,7 @@ describe RspecPuppetFacts do
 
         it { is_expected.to be_a(Hash) }
         it { is_expected.to have_attributes(:size => 1) }
-        it { is_expected.to include('windows-2012 R2-x64' => an_instance_of(Hash)) }
+        it { is_expected.to include('windows-2012 R2-x86_64' => an_instance_of(Hash)) }
       end
 
       context 'with a Server prefixed release' do
@@ -331,7 +518,7 @@ describe RspecPuppetFacts do
 
         it { is_expected.to be_a(Hash) }
         it { is_expected.to have_attributes(:size => 1) }
-        it { is_expected.to include('windows-2012-x64' => an_instance_of(Hash)) }
+        it { is_expected.to include('windows-2012-x86_64' => an_instance_of(Hash)) }
       end
 
       context 'with a 2016 release' do
@@ -339,7 +526,18 @@ describe RspecPuppetFacts do
 
         it { is_expected.to be_a(Hash) }
         it { is_expected.to have_attributes(:size => 1) }
-        it { is_expected.to include('windows-2016-x64' => an_instance_of(Hash)) }
+        it { is_expected.to include('windows-2016-x86_64' => an_instance_of(Hash)) }
+      end
+
+      context 'with a 2016 release and Facter < 3.4' do
+        let(:release) { ['2016'] }
+        let(:facterversion) { '3.3.0' }
+
+        it { is_expected.to be_a(Hash) }
+        it { is_expected.to have_attributes(:size => 1) }
+        it 'munges the operatingsystemmajrelease to 2016' do
+          is_expected.to include('windows-2016-x86_64' => an_instance_of(Hash))
+        end
       end
     end
 
@@ -420,17 +618,56 @@ describe RspecPuppetFacts do
         expect(subject.size).to eq 2
       end
       it 'should return supported OS' do
-        expect(subject.keys.sort).to eq %w(
-          archlinux-3-x86_64
-          debian-8-x86_64
+        expect(subject.keys.sort).to include(a_string_matching(/\Aarchlinux-\d+-x86_64/), 'debian-8-x86_64')
+      end
+    end
+
+    context 'When the operatingsystemrelease contains parens' do
+      subject do
+        on_supported_os(
+          {
+            :supported_os => [
+              {
+                'operatingsystem'        => 'IOS',
+                'operatingsystemrelease' => ['12.2(25)EWA9'],
+              }
+            ],
+          }
         )
       end
+
+      before(:each) do
+        allow(RspecPuppetFacts).to receive(:warning).with(a_string_matching(/no facts were found/i))
+        allow(FacterDB).to receive(:get_facts).and_call_original
+      end
+
+      it 'escapes the parens in the filter' do
+        filter = [
+          include(
+            :operatingsystem        => "IOS",
+            :operatingsystemrelease => "/^12\\.2\\(25\\)EWA9/",
+            :hardwaremodel          => "x86_64",
+          ),
+        ]
+
+        expect(FacterDB).to receive(:get_facts).with(filter)
+        subject
+      end
+
+      it 'does not raise an error' do
+        expect { subject }.not_to raise_error
+      end
     end
 
-    context 'Without a custom facterversion in the options hash' do
+    context 'With a default Facter version specified in the RSpec configuration' do
       before(:each) do
-        allow(Facter).to receive(:version).and_return('2.4.5')
+        RSpec.configuration.default_facter_version = '3.1.0'
+      end
+
+      after(:each) do
+        RSpec.configuration.default_facter_version = Facter.version
       end
+
       subject do
         on_supported_os(
           supported_os: [
@@ -439,10 +676,10 @@ describe RspecPuppetFacts do
         )
       end
 
-      it 'returns facts from the loaded facter version' do
+      it 'returns facts from the specified default Facter version' do
         is_expected.to match(
           'centos-7-x86_64' => include(
-            facterversion: /\A2\.4\./
+            :facterversion => /\A3\.1\./
           )
         )
       end
@@ -466,7 +703,7 @@ describe RspecPuppetFacts do
         major, minor = Facter.version.split('.')
         is_expected.to match(
           'centos-7-x86_64' => include(
-            facterversion: /\A#{major}\.[#{minor}#{minor.to_i + 1}]\./
+            :facterversion => /\A#{major}\.[#{minor}#{minor.to_i + 1}]\./
           )
         )
       end
@@ -493,7 +730,7 @@ describe RspecPuppetFacts do
 
       it 'returns facts from a facter version matching 3.1' do
         is_expected.to match(
-          'centos-7-x86_64' => include(facterversion: '3.1.6')
+          'centos-7-x86_64' => include(:facterversion => '3.1.6')
         )
       end
     end
@@ -510,7 +747,7 @@ describe RspecPuppetFacts do
 
       it 'returns facts from a facter version matching 3.1' do
         is_expected.to match(
-          'centos-7-x86_64' => include(facterversion: '3.1.6')
+          'centos-7-x86_64' => include(:facterversion => '3.1.6')
         )
       end
     end
@@ -527,7 +764,7 @@ describe RspecPuppetFacts do
 
       it 'returns facts from a facter version matching 3.3' do
         is_expected.to match(
-          'centos-7-x86_64' => include(facterversion: '3.3.0')
+          'centos-7-x86_64' => include(:facterversion => '3.3.0')
         )
       end
     end
@@ -544,7 +781,24 @@ describe RspecPuppetFacts do
 
       it 'returns facts from a facter version matching 3.3' do
         is_expected.to match(
-          'centos-7-x86_64' => include(facterversion: '3.3.0')
+          'centos-7-x86_64' => include(:facterversion => '3.3.0')
+        )
+      end
+    end
+
+    context 'When querying a fact set that does not have an operatingsystemmajrelease fact' do
+      subject do
+        on_supported_os(
+          supported_os: [
+            { 'operatingsystem' => 'SLES', 'operatingsystemrelease' => ['11'] }
+          ],
+          facterversion: '2.1.0'
+        )
+      end
+
+      it 'splits the operatingsystemrelease fact value to get the major release' do
+        is_expected.to match(
+          'sles-11-x86_64' => include(:operatingsystemrelease => '11.3')
         )
       end
     end
@@ -564,6 +818,36 @@ describe RspecPuppetFacts do
                                               /:facterversion must be in the /)
       end
     end
+
+    context 'Downgrades to a facter version with facts per OS' do
+      subject do
+        on_supported_os(
+          supported_os: [
+            { 'operatingsystem' => 'CentOS', 'operatingsystemrelease' => %w[7] },
+            { 'operatingsystem' => 'OpenSuSE', 'operatingsystemrelease' => %w[42] }
+          ],
+          facterversion: '3.9.5'
+        )
+      end
+
+      before(:each) do
+        allow(FacterDB).to receive(:get_facts).and_call_original
+        allow(FacterDB).to receive(:get_facts).with(
+          a_hash_including(facterversion: "/\\A3\\.9\\./", operatingsystem: 'CentOS')
+        ).and_return([])
+      end
+
+      it 'returns CentOS facts from a facter version matching 3.8' do
+        is_expected.to include(
+          'centos-7-x86_64' => include(:facterversion => '3.8.0')
+        )
+      end
+      it 'returns OpenSuSE facts from a facter version matching 3.9' do
+        is_expected.to include(
+          'opensuse-42-x86_64' => include(:facterversion => '3.9.2')
+        )
+      end
+    end
   end
 
   context '#add_custom_fact' do
@@ -618,9 +902,9 @@ describe RspecPuppetFacts do
     end
 
     it 'should not add "augeasversion" if Augeas is supported' do
-      allow(Puppet.features).to receive(:augeas?).and_return(false)
+      allow(described_class).to receive(:augeas?).and_return(false)
       RspecPuppetFacts.reset
-      expect(subject.common_facts).not_to include :augeasversion
+      expect(subject.common_facts).not_to include(:augeasversion)
     end
 
     it 'should determine the Augeas version if Augeas is supported' do
@@ -634,14 +918,37 @@ describe RspecPuppetFacts do
         end
       end
 
-      allow(Puppet.features).to receive(:augeas?).and_return(true)
+      allow(described_class).to receive(:augeas?).and_return(true)
       stub_const('Augeas', Augeas_stub)
       RspecPuppetFacts.reset
       expect(subject.common_facts[:augeasversion]).to eq 'my_version'
     end
 
-    it 'can output a warning message' do
-      expect { RspecPuppetFacts.warning('test') }.to output(/test/).to_stderr_from_any_process
+    context 'when mcollective is available' do
+      module MCollective_stub
+        VERSION = 'my_version'
+      end
+
+      before(:each) do
+        allow(described_class).to receive(:mcollective?).and_return(true)
+        stub_const('MCollective', MCollective_stub)
+        described_class.reset
+      end
+
+      it 'includes an "mco_version" fact' do
+        expect(subject.common_facts).to include(:mco_version => 'my_version')
+      end
+    end
+
+    context 'when mcollective is not available' do
+      before(:each) do
+        allow(described_class).to receive(:mcollective?).and_return(false)
+        described_class.reset
+      end
+
+      it 'does not include an "mco_version" fact' do
+        expect(subject.common_facts).not_to include(:mco_version)
+      end
     end
   end