rspec-puppet-facts 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 187629e1d3599c172d3b0e23135f5d92ae04a8e2
-  data.tar.gz: 1205b765d9578ded7591cd1822943212404f9634
+  metadata.gz: 13500ef636b561fc94ded0be8be865f94f004b07
+  data.tar.gz: 515732b3aa600a4f4b6de18598d064972160944a
 SHA512:
-  metadata.gz: 3d28c8fc4e11155a4c96e1f4f22816913eee8220d824305022b5bb084ec7a95a4bc4961b436b56959975beab6ee9375a01ed732302fa7c4f07ddd71e53afde9c
-  data.tar.gz: 7fd003eb3d0808311230355ff22dd791089d6878d7841ec8b58814c94a1ce17c09e4965c9ae4f4fbc9a275e47795739bb663f9ae74034973c93e1f9ce3d27f8d
+  metadata.gz: 1495b667b0e488ac1c9bcf8ee6bfd89a01ec5e747ff31f97f0eca476325e4efb57141e8eef4341db9596ebcf2d9f5569292ed6baa12417643740466992b7336d
+  data.tar.gz: 2494c062b9d5e89c6fd94e0dd5b62c0e873c820e5bd14468114ce9ce4577afedf5c4c3674b1c9874bbc2d354176cafba10751b761727d89d1e75db56850be4b4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+##2016-09-16 - Release 1.7.0
+- Support custom facts defined by spec_helper
+
 ##2016-05-19 - Release 1.6.1
 - Fix a bug where not all specified Ubuntu or OpenBSD were captured
 

data/Gemfile

@@ -7,3 +7,9 @@ if facterversion = ENV['FACTER_GEM_VERSION']
 else
   gem 'facter', :require => false
 end
+
+platforms :ruby_18, :ruby_19 do
+  gem 'json', '~> 1.0'
+  gem 'json_pure', '~> 1.0'
+  gem 'tins', '~> 1.6.0'
+end

data/README.md

@@ -29,7 +29,7 @@ describe 'myclass' do
         :operatingsystemmajrelease => '7',
         ...
       }
-      
+
       it { is_expected.to compile.with_all_deps }
       ...
     end
@@ -43,12 +43,12 @@ describe 'myclass' do
         :operatingsystemmajrelease => '6',
         ...
       }
-      
+
       it { is_expected.to compile.with_all_deps }
       ...
     end
   end
-  
+
   ...
 end
 ```
@@ -65,7 +65,7 @@ describe 'myclass' do
       let(:facts) do
         facts
       end
-      
+
       it { is_expected.to compile.with_all_deps }
       ...
       case facts[:osfamily]
@@ -193,9 +193,9 @@ describe Puppet::Parser::Functions.function(:myfunction) do
         end
       end
     end
-    
+
     ...
-    
+
   end
 end
 ```
@@ -230,7 +230,7 @@ describe 'myclass' do
       let(:facts) do
         facts
       end
-      
+
       it { is_expected.to compile.with_all_deps }
       ...
     end
@@ -241,6 +241,8 @@ end
 Append some facts:
 ------------------
 
+1. In your spec
+
 ```ruby
 require 'spec_helper'
 
@@ -253,7 +255,7 @@ describe 'myclass' do
           :foo => 'bar',
         })
       end
-      
+
       it { is_expected.to compile.with_all_deps }
       ...
     end
@@ -261,6 +263,30 @@ describe 'myclass' do
 end
 ```
 
+2. In your `spec_helper.rb`
+  * Simple:
+
+    ```ruby
+    add_custom_fact 'foo', 'bar'
+    ```
+
+  * Confine to an OS:
+
+    ```ruby
+    add_custom_fact :root_home, '/root', :confine => 'redhat-7-x86_64'
+    ```
+
+  * Exclude an OS:
+
+    ```ruby
+    add_custom_fact :root_home, '/root', :exclude => 'redhat-7-x86_64'
+    ```
+  * Call a proc to get a value:
+
+    ```ruby
+    add_custom_fact :root_home, ->(_os,facts) { "/tmp/#{facts['hostname']}"
+    ```
+
 Usage
 -----
 

data/lib/rspec-puppet-facts.rb

@@ -86,15 +86,65 @@ module RspecPuppetFacts
       os = "#{facts[:operatingsystem].downcase}-#{operatingsystemmajrelease}-#{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
+      os_facts_hash[os] = RspecPuppetFacts.with_custom_facts(os, facts)
     end
     os_facts_hash
   end
 
+  # 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.
+  #
+  # @param [String]      name           Fact name
+  # @param [String,Proc] value          Fact value. If proc, takes 2 params: os and facts hash
+  # @param [Hash]        opts
+  # @option opts [String,Array<String>] :confine The applicable OS's
+  # @option opts [String,Array<String>] :exclude OS's to exclude
+  #
+  def add_custom_fact(name, value, options = {})
+    options[:confine] = [options[:confine]] if options[:confine].is_a?(String)
+    options[:exclude] = [options[:exclude]] if options[:exclude].is_a?(String)
+
+    RspecPuppetFacts.register_custom_fact(name, value, options)
+  end
+
+  # Adds a custom fact to the @custom_facts variable.
+  #
+  # @param [String]      name           Fact name
+  # @param [String,Proc] value          Fact value. If proc, takes 2 params: os and facts hash
+  # @param [Hash]        opts
+  # @option opts [String,Array<String>] :confine The applicable OS's
+  # @option opts [String,Array<String>] :exclude OS's to exclude
+  # @api private
+  def self.register_custom_fact(name, value, options)
+    @custom_facts ||= {}
+    @custom_facts[name.to_s] = {:options => options, :value => value}
+  end
+
+  # Adds any custom facts according to the rules defined for the operating
+  # system with the given facts.
+  # @param [String] os    Name of the operating system
+  # @param [Hash]   facts Facts hash
+  # @return [Hash]  facts Facts hash with custom facts added
+  # @api private
+  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
+
   # 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 
+  # variable and
   # @return [nil,String]
   # @api private
   def self.spec_facts_os_filter
@@ -165,6 +215,7 @@ module RspecPuppetFacts
   # be generated again
   # @api private
   def self.reset
+    @custom_facts = nil
     @common_facts = nil
     @metadata = nil
   end

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.6.1'
+    STRING = '1.7.0'
   end
 end

data/spec/rspec_puppet_facts_spec.rb

@@ -372,6 +372,50 @@ describe RspecPuppetFacts do
     end
   end
 
+  context '#add_custom_fact' do
+    subject {
+      on_supported_os(
+        {
+          :supported_os => [
+            {
+              "operatingsystem" => "RedHat",
+              "operatingsystemrelease" => [
+                "6",
+                "7"
+              ]
+            }
+          ]
+        }
+      )
+    }
+
+    before(:each) do
+      RspecPuppetFacts.reset
+    end
+
+    it 'adds a simple fact and value' do
+      add_custom_fact 'root_home', '/root'
+      expect(subject['redhat-7-x86_64']['root_home']).to eq '/root'
+    end
+
+    it 'confines a fact to a particular operating system' do
+      add_custom_fact 'root_home', '/root', :confine => 'redhat-7-x86_64'
+      expect(subject['redhat-7-x86_64']['root_home']).to eq '/root'
+      expect(subject['redhat-6-x86_64']['root_home']).to be_nil
+    end
+
+    it 'excludes a fact from a particular operating system' do
+      add_custom_fact 'root_home', '/root', :exclude => 'redhat-7-x86_64'
+      expect(subject['redhat-7-x86_64']['root_home']).to be_nil
+      expect(subject['redhat-6-x86_64']['root_home']).to eq '/root'
+    end
+
+    it 'takes a proc as a value' do
+      add_custom_fact 'root_home', ->(_os, _facts) { '/root' }
+      expect(subject['redhat-7-x86_64']['root_home']).to eq '/root'
+    end
+  end
+
   context '#misc' do
     it 'should have a common facts structure' do
       RspecPuppetFacts.reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-facts
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Mickaël Canévet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types