rspec-puppet-facts 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25dba2e8315cd00eabd5d471bfae20a617ac3cdb
-  data.tar.gz: 1362031f653c28534a8858edfb330218eb05d97a
+  metadata.gz: 67e267fa84f829a97dd7a211cd499b7916038eda
+  data.tar.gz: 1cae575348cca8a0483c935f68d58d1c315b7c84
 SHA512:
-  metadata.gz: 4f5f2ad99655433291c78064abe45919123be877124f9ec8f204cb5b08ca5bd698fd4cc482b3cdc186057e366d890ff253b3557449efba526defb6927f07ba90
-  data.tar.gz: 3ace83756a933a7d4d09e573dd0387d5cc80dcf1c4b12d2fcb1cea41ab06567d24edc8e020b948e2fecd5cf0168920b09f185c459fd8ecb46dc312393cf6ea45
+  metadata.gz: 817f91d0427e96c4d57a4d3524adc8374308c23fd805384718f803a13853c71b29383f146797654f168aa93a83483ee13efa83f89cdbbc707597978f1b6d23bf
+  data.tar.gz: 65220d4078595dad750393f9e3ea2725b638da129d6cabd71e823d2b03c73700ffdabb1defa5e5c250551b5a6b3a69bd24f38bed35154e9ac9f0ab6f96bf418d

data/.gitignore

@@ -5,3 +5,5 @@ Gemfile.lock
 .bundle/
 coverage/
 .idea
+doc
+.yardoc

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+##2016-05-17 - Release 1.6.0
+- Cleanup and refactor methods
+- Add YARD documentation
+- Refactor and fix rspec
+- Add the OS filter support
+
 ##2016-03-29 - Release 1.5.0
 - Add some Microsft Windows support
 

data/README.md

@@ -277,6 +277,18 @@ require 'rspec-puppet-facts'
 include RspecPuppetFacts
 ```
 
+Run the tests:
+
+```bash
+rake spec
+```
+
+Run the tests only on some of the facts sets:
+
+```bash
+SPEC_FACTS_OS='ubuntu-14' rake spec
+```
+
 Finaly, Add some `facter` version to test in your .travis.yml
 
 ```yaml

data/Rakefile

@@ -1,5 +1,7 @@
 begin
     require 'rspec/core/rake_task'
-      RSpec::Core::RakeTask.new(:spec)
+    require 'yard'
+    RSpec::Core::RakeTask.new(:spec)
+    YARD::Rake::YardocTask.new
 rescue LoadError
 end

data/lib/rspec-puppet-facts.rb

@@ -4,10 +4,30 @@ require 'facterdb'
 require 'json'
 require 'mcollective'
 
+# 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.
 module RspecPuppetFacts
-
-  def on_supported_os( opts = {} )
+  # 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.
+  #
+  # @return [Hash <String => Hash>]
+  # @param [Hash] opts
+  # @option opts [String,Array<String>] :hardwaremodels The OS architecture names, i.e. x86_64
+  # @option opts [Array<Hash>] :supported_os If this options is provided the data
+  # will be used instead of the "operatingsystem_support" section if the metadata file
+  # even if the file is missing.
+  def on_supported_os(opts = {})
     opts[:hardwaremodels] ||= ['x86_64']
+    opts[:hardwaremodels] = [opts[:hardwaremodels]] unless opts[:hardwaremodels].is_a? Array
     opts[:supported_os] ||= RspecPuppetFacts.meta_supported_os
 
     filter = []
@@ -25,57 +45,116 @@ module RspecPuppetFacts
             end
 
             filter << {
-              :facterversion          => "/^#{Facter.version[0..2]}/",
-              :operatingsystem        => os_sup['operatingsystem'],
-              :operatingsystemrelease => "/^#{operatingsystemmajrelease.split(" ")[0]}/",
-              :hardwaremodel          => hardwaremodel,
+                :facterversion          => "/^#{Facter.version[0..2]}/",
+                :operatingsystem        => os_sup['operatingsystem'],
+                :operatingsystemrelease => "/^#{operatingsystemmajrelease.split(' ')[0]}/",
+                :hardwaremodel          => hardwaremodel,
             }
           end
         end
       else
         opts[:hardwaremodels].each do |hardwaremodel|
           filter << {
-            :facterversion   => "/^#{Facter.version[0..2]}/",
-            :operatingsystem => os_sup['operatingsystem'],
-            :hardwaremodel   => hardwaremodel,
+              :facterversion   => "/^#{Facter.version[0..2]}/",
+              :operatingsystem => os_sup['operatingsystem'],
+              :hardwaremodel   => hardwaremodel,
           }
         end
       end
     end
 
-    h = {}
-    FacterDB::get_facts(filter).map do |facts|
-      facts.merge!({
+    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|
+      os = "#{facts[:operatingsystem].downcase}-#{facts[:operatingsystemrelease].split('.')[0]}-#{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] = facts
+    end
+    os_facts_hash
+  end
+
+  # 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 
+  # @return [nil,String]
+  # @api private
+  def self.spec_facts_os_filter
+    ENV['SPEC_FACTS_OS']
+  end
+
+  # These facts are common for all OS'es and will be
+  # added to the facts retrieved from the FacterDB
+  # @api private
+  # @return [Hash <Symbol => String>]
+  def self.common_facts
+    return @common_facts if @common_facts
+    @common_facts = {
         :mco_version   => MCollective::VERSION,
         :puppetversion => Puppet.version,
-        :rubysitedir   => RbConfig::CONFIG["sitelibdir"],
+        :rubysitedir   => RbConfig::CONFIG['sitelibdir'],
         :rubyversion   => RUBY_VERSION,
-      })
-      facts[:augeasversion] = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD).get('/augeas/version') if Puppet.features.augeas?
-      h["#{facts[:operatingsystem].downcase}-#{facts[:operatingsystemrelease].split('.')[0]}-#{facts[:hardwaremodel]}"] = facts
+    }
+    if Puppet.features.augeas?
+      @common_facts[:augeasversion] = Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD).get('/augeas/version')
     end
-    h
+    @common_facts
   end
 
+  # Get the "operatingsystem_support" structure from
+  # the parsed metadata.json file
+  # @raise [StandardError] if there is no "operatingsystem_support"
+  # in the metadata
+  # @return [Array<Hash>]
   # @api private
   def self.meta_supported_os
-    @meta_supported_os ||= get_meta_supported_os
-  end
-
-  # @api private
-  def self.get_meta_supported_os
-    metadata = get_metadata
-    if metadata['operatingsystem_support'].nil?
-      fail StandardError, "Unknown operatingsystem support"
+    unless metadata['operatingsystem_support'].is_a? Array
+      fail StandardError, 'Unknown operatingsystem support in the metadata file!'
     end
     metadata['operatingsystem_support']
   end
 
+  # Read the metadata file and parse
+  # its JSON content.
+  # @raise [StandardError] if the metadata file is missing
+  # @return [Hash]
   # @api private
-  def self.get_metadata
-    if ! File.file?('metadata.json')
+  def self.metadata
+    return @metadata if @metadata
+    unless File.file? metadata_file
       fail StandardError, "Can't find metadata.json... dunno why"
     end
-    JSON.parse(File.read('metadata.json'))
+    content = File.read metadata_file
+    @metadata = JSON.parse content
+  end
+
+  # This file contains the Puppet module's metadata
+  # @return [String]
+  # @api private
+  def self.metadata_file
+    'metadata.json'
   end
+
+  # Print a warning message to the console
+  # @param message [String]
+  # @api private
+  def self.warning(message)
+    STDERR.puts message
+  end
+
+  # Reset the memoization
+  # to make the saved structures
+  # be generated again
+  # @api private
+  def self.reset
+    @common_facts = nil
+    @metadata = nil
+  end
+
 end

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

@@ -1,5 +1,7 @@
 module RspecPuppetFacts
+  # This module contains the current version constant
   module Version
-    STRING = '1.5.0'
+    # The current version of this gem
+    STRING = '1.6.0'
   end
 end

data/rspec-puppet-facts.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   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'

data/spec/rspec_puppet_facts_spec.rb

@@ -1,58 +1,94 @@
 require 'spec_helper'
+require 'json'
 
-describe 'RspecPuppetFacts' do
+describe RspecPuppetFacts do
+  let(:metadata_file) do
+    'spec/fixtures/metadata.json'
+  end
 
   describe '#on_supported_os' do
 
-    context 'Without parameter' do
-      subject { on_supported_os() }
+    context 'Without specifying supported_os' do
+      subject { on_supported_os }
 
       context 'Without metadata.json' do
+        before(:each) do
+          expect(File).to receive(:file?).with('metadata.json').and_return false
+        end
+
         it { expect { subject }.to raise_error(StandardError, /Can't find metadata.json/) }
       end
 
       context 'With a metadata.json' do
-
-        context 'With a broken metadata.json' do
-
-          context 'With missing operatingsystem_support section' do
-            before :each do
-              fixture = File.read('spec/fixtures/metadata.json_with_missing_operatingsystem_support')
-              expect(File).to receive(:file?).with('metadata.json').and_return true
-              expect(File).to receive(:read).with('metadata.json').and_return fixture
-            end
-
-            it { expect { subject }.to raise_error(StandardError, /Unknown operatingsystem support/) }
-          end
+        it 'can load the metadata file' do
+          allow(RspecPuppetFacts).to receive(:metadata_file).and_return(metadata_file)
+          RspecPuppetFacts.reset
+          expect(RspecPuppetFacts.metadata).to be_a Hash
+          expect(RspecPuppetFacts.metadata['name']).to eq 'mcanevet-mymodule'
         end
 
         context 'With a valid metadata.json' do
+          let(:metadata) do
+            fixture = File.read(metadata_file)
+            JSON.parse fixture
+          end
+
           before :each do
-            fixture = File.read('spec/fixtures/metadata.json')
-            expect(File).to receive(:file?).with('metadata.json').and_return true
-            expect(File).to receive(:read).and_call_original
-            expect(File).to receive(:read).with('metadata.json').and_return fixture
+            allow(RspecPuppetFacts).to receive(:metadata).and_return(metadata)
           end
 
           it 'should return a hash' do
-            pending 'FIXME'
-            expect( on_supported_os().class ).to eq Hash
+            is_expected.to be_a Hash
           end
+
           it 'should have 5 elements' do
-            pending 'FIXME'
             expect(subject.size).to eq 5
           end
+
           it 'should return supported OS' do
-            pending 'FIXME'
-            expect(subject.keys.sort).to eq [
-              'debian-6-x86_64',
-              'debian-7-x86_64',
-              'redhat-5-x86_64',
-              'redhat-6-x86_64',
-              'redhat-7-x86_64',
-            ]
+            expect(subject.keys.sort).to eq %w(
+              debian-6-x86_64
+              debian-7-x86_64
+              redhat-5-x86_64
+              redhat-6-x86_64
+              redhat-7-x86_64
+            )
+          end
+
+          it 'should be able to filter the received OS facts' do
+            allow(RspecPuppetFacts).to receive(:spec_facts_os_filter).and_return('redhat')
+            expect(subject.keys.sort).to eq %w(
+              redhat-5-x86_64
+              redhat-6-x86_64
+              redhat-7-x86_64
+            )
           end
         end
+
+        context 'With a broken metadata.json' do
+          before :each do
+            allow(RspecPuppetFacts).to receive(:metadata).and_return(metadata)
+          end
+
+          context 'With a missing operatingsystem_support section' do
+            let(:metadata) do
+              {}
+            end
+
+            it { expect { subject }.to raise_error(StandardError, /Unknown operatingsystem support/) }
+          end
+
+          context 'With a wrong operatingsystem_support section' do
+            let(:metadata) do
+              {
+                  'operatingsystem_support' => 'Ubuntu',
+              }
+            end
+
+            it { expect { subject }.to raise_error(StandardError, /Unknown operatingsystem support/) }
+          end
+        end
+
       end
     end
 
@@ -79,19 +115,30 @@ describe 'RspecPuppetFacts' do
           }
         )
       }
+
       it 'should return a hash' do
-        expect(subject.class).to eq Hash
+        is_expected.to be_a Hash
       end
+
       it 'should have 4 elements' do
         expect(subject.size).to eq 4
       end
+
       it 'should return supported OS' do
-        expect(subject.keys.sort).to eq [
-          'debian-6-x86_64',
-          'debian-7-x86_64',
-          'redhat-5-x86_64',
-          'redhat-6-x86_64',
-        ]
+        expect(subject.keys.sort).to eq %w(
+          debian-6-x86_64
+          debian-7-x86_64
+          redhat-5-x86_64
+          redhat-6-x86_64
+        )
+      end
+
+      it 'should be able to filter the received OS facts' do
+        allow(RspecPuppetFacts).to receive(:spec_facts_os_filter).and_return('redhat')
+        expect(subject.keys.sort).to eq %w(
+          redhat-5-x86_64
+          redhat-6-x86_64
+        )
       end
     end
 
@@ -151,33 +198,59 @@ describe 'RspecPuppetFacts' do
       end
     end
 
-    unless Facter.version.to_f < 2.4
-      context 'When testing Windows 7' do
-        subject {
-          on_supported_os(
+    context 'When testing Solaris 11', :if => Facter.version.to_f >= 2.0 do
+      subject {
+        on_supported_os(
             {
-              :supported_os => [
-                {
-                  "operatingsystem" => "windows",
-                  "operatingsystemrelease" => [
-                    "7",
-                  ],
-                },
-              ],
+                :supported_os => [
+                    {
+                        "operatingsystem" => "Solaris",
+                        "operatingsystemrelease" => [
+                            "11",
+                        ],
+                    },
+                ],
             }
-          )
-        }
-        it 'should return a hash' do
-          expect(subject.class).to eq Hash
-        end
-        it 'should have 1 elements' do
-          expect(subject.size).to eq 1
-        end
-        it 'should return supported OS' do
-          expect(subject.keys.sort).to eq [
-            'windows-7-x64',
-          ]
-        end
+        )
+      }
+      it 'should return a hash' do
+        expect(subject.class).to eq Hash
+      end
+      it 'should have 1 elements' do
+        expect(subject.size).to eq 1
+      end
+      it 'should return supported OS' do
+        expect(subject.keys.sort).to eq %w(
+          solaris-11-i86pc
+        )
+      end
+    end
+
+    context 'When testing Windows 7', :if => Facter.version.to_f >= 2.4 do
+      subject {
+        on_supported_os(
+          {
+            :supported_os => [
+              {
+                "operatingsystem" => "windows",
+                "operatingsystemrelease" => [
+                  "7",
+                ],
+              },
+            ],
+          }
+        )
+      }
+      it 'should return a hash' do
+        expect(subject.class).to eq Hash
+      end
+      it 'should have 1 elements' do
+        expect(subject.size).to eq 1
+      end
+      it 'should return supported OS' do
+        expect(subject.keys.sort).to eq [
+          'windows-7-x64',
+        ]
       end
     end
 
@@ -226,8 +299,8 @@ describe 'RspecPuppetFacts' do
       }
 
       it 'should output warning message' do
-        pending "TODO: Show a warning when missing facts in database"
-        expect { subject }.to output(/Can't find facts for 'debian-4-x86_64'/).to_stderr
+        expect(RspecPuppetFacts).to receive(:warning).with(/No facts were found in the FacterDB/)
+        subject
       end
     end
 
@@ -257,11 +330,47 @@ describe 'RspecPuppetFacts' do
         expect(subject.size).to eq 2
       end
       it 'should return supported OS' do
-        expect(subject.keys.sort).to eq [
-          'archlinux-3-x86_64',
-          'debian-8-x86_64',
-        ]
+        expect(subject.keys.sort).to eq %w(
+          archlinux-3-x86_64
+          debian-8-x86_64
+        )
       end
     end
   end
+
+  context '#misc' do
+    it 'should have a common facts structure' do
+      RspecPuppetFacts.reset
+      expect(subject.common_facts).to be_a Hash
+      expect(subject.common_facts).not_to be_empty
+    end
+
+    it 'should not add "augeasversion" if Augeas is supported' do
+      allow(Puppet.features).to receive(:augeas?).and_return(false)
+      RspecPuppetFacts.reset
+      expect(subject.common_facts).not_to include :augeasversion
+    end
+
+    it 'should determine the Augeas version if Augeas is supported' do
+      module Augeas_stub
+        NO_MODL_AUTOLOAD = true
+        def self.open(*_args)
+          self
+        end
+        def self.get(*_args)
+          'my_version'
+        end
+      end
+
+      allow(Puppet.features).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
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-facts
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Mickaël Canévet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement