facterdb 1.27.0 → 2.1.0

data/facts/windows_get_facts.ps1

@@ -1,5 +1,5 @@
 param(
-  [array]$puppetAgentVersions = ('7.24.0','8.0.0','8.5.1','8.6.0'),
+  [string]$puppetAgentVersionList = 'X:\versions.txt',
   [string]$baseUrl = 'https://downloads.puppetlabs.com/windows/puppet{0}/puppet-agent-{1}-{2}.msi',
   [string]$fqdn = 'foo.example.com'
 )
@@ -25,6 +25,18 @@ net use X: \\VBOXSVR\vagrant
 $VagrantDataPath = 'X:\'
 $WorkingDirectory = 'C:\vagrant_working_directory\'
 
+# Check if version list is available and load it
+if (!(Test-Path $puppetAgentVersionList)) {
+  Write-Host -ForegroundColor Red "Can't find Puppet Agent Version list."
+  Exit 1
+}
+
+$puppetAgentVersions = Select-String -Path $puppetAgentVersionList '^\d+\.\d+\.\d+' -AllMatches |  Foreach-Object {$_.Line}
+if ($puppetAgentVersions.Count -eq 0) {
+  Write-Host -ForegroundColor Red "Puppet Agent version list seems to be empty."
+  Exit 1
+}
+
 # Make sure we have enough privs to install the things.
 $currentPrincipal = New-Object Security.Principal.WindowsPrincipal([Security.Principal.WindowsIdentity]::GetCurrent())
 if (! ($currentPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator))) {
@@ -40,6 +52,7 @@ if (!(Test-Path $WorkingDirectory)) {
 
 # Install each puppet version & collect facts.
 foreach ($pupAgentVer in $puppetAgentVersions) {
+  write-Host "Generating facts with `'$pupAgentVer`'"
 
   $agentUrl = $baseUrl -f $pupAgentVer[0], $pupAgentVer, "x64"
   $agentName = "puppet-agent-{1}-{2}.msi" -f $pupAgentVer[0], $pupAgentVer, "x64"

data/lib/facterdb/version.rb

@@ -1,5 +1,5 @@
 module FacterDB
   module Version
-    STRING = '1.27.0'
+    STRING = '2.1.0'
   end
 end

data/lib/facterdb.rb

@@ -137,13 +137,17 @@ module FacterDB
 
   # @return [Array[Hash[Symbol, Any]]] array of hashes of facts
   # @param filter [Object] The filter to convert to jgrep string
-  def self.get_facts(filter = nil, cache = true)
+  # @param symbolize_keys [Boolean]
+  #   Whether to symbolize the keys. Note this is only on the top level and not
+  #   on nested values.
+  def self.get_facts(filter = nil, cache = true, symbolize_keys: true)
     if cache && filter && filter == Thread.current[:facterdb_last_filter_seen]
       return Thread.current[:facterdb_last_facts_seen]
     end
 
     filter_str = generate_filter_str(filter)
-    result = JGrep.jgrep(database, filter_str).map { |hash| hash.map { |k, v| [k.to_sym, v] }.to_h }
+    result = JGrep.jgrep(database, filter_str)
+    result = result.map { |hash| hash.transform_keys(&:to_sym) } if symbolize_keys
     if cache
       Thread.current[:facterdb_last_filter_seen] = filter
       Thread.current[:facterdb_last_facts_seen] = result

data/spec/facter_db_spec.rb

@@ -15,10 +15,10 @@ describe FacterDB do
     end
   end
 
-  let(:facts_24_path)  { File.join(project_dir, 'facts', '2.4') }
-  let(:facts_24_count) { Dir.glob(File.join(facts_24_path, '*.facts')).count }
-  let(:facts_23_path)  { File.join(project_dir, 'facts', '2.3') }
-  let(:facts_23_count) { Dir.glob(File.join(facts_23_path, '*.facts')).count }
+  let(:facts_42_path)  { File.join(project_dir, 'facts', '4.2') }
+  let(:facts_42_count) { Dir.glob(File.join(facts_42_path, '*.facts')).count }
+  let(:facts_40_path)  { File.join(project_dir, 'facts', '4.0') }
+  let(:facts_40_count) { Dir.glob(File.join(facts_40_path, '*.facts')).count }
 
   describe '.use_defaultdb?' do
     subject { described_class.use_defaultdb? }
@@ -57,25 +57,25 @@ describe FacterDB do
 
     context 'when the FACTERDB_SEARCH_PATHS environment variable is set' do
       it 'supports a single path' do
-        ENV['FACTERDB_SEARCH_PATHS'] = facts_24_path
+        ENV['FACTERDB_SEARCH_PATHS'] = facts_42_path
 
-        expect(file_count).to eq(facts_24_count)
+        expect(file_count).to eq(facts_42_count)
       end
 
       it 'supports multiple paths delimited by the OS path separator' do
-        ENV['FACTERDB_SEARCH_PATHS'] = [facts_24_path, facts_23_path].join(File::PATH_SEPARATOR)
+        ENV['FACTERDB_SEARCH_PATHS'] = [facts_42_path, facts_40_path].join(File::PATH_SEPARATOR)
 
-        expect(file_count).to eq(facts_24_count + facts_23_count)
+        expect(file_count).to eq(facts_42_count + facts_40_count)
       end
 
       it 'ignores paths that are not a directory' do
-        ENV['FACTERDB_SEARCH_PATHS'] = [facts_24_path, non_directory_path].join(File::PATH_SEPARATOR)
+        ENV['FACTERDB_SEARCH_PATHS'] = [facts_42_path, non_directory_path].join(File::PATH_SEPARATOR)
 
         object = defined?(Warning) ? Warning : Kernel
         allow(object).to receive(:warn).and_call_original
         allow(object).to receive(:warn).with(a_string_matching(/is not a directory/))
 
-        expect(file_count).to eq(facts_24_count)
+        expect(file_count).to eq(facts_42_count)
       end
     end
 
@@ -84,30 +84,30 @@ describe FacterDB do
       subject(:file_count) { described_class.external_fact_files(fact_paths).count }
 
       context 'that is a single path' do
-        let(:fact_paths) { facts_24_path }
+        let(:fact_paths) { facts_42_path }
 
         it 'returns the paths to the fact sets in the specified path' do
-          expect(file_count).to eq(facts_24_count)
+          expect(file_count).to eq(facts_42_count)
         end
       end
 
       context 'that is multiple paths delimited by the OS path separator' do
-        let(:fact_paths) { [facts_24_path, facts_23_path].join(File::PATH_SEPARATOR) }
+        let(:fact_paths) { [facts_42_path, facts_40_path].join(File::PATH_SEPARATOR) }
 
         it 'returns the paths to the fact sets in all the specified paths' do
-          expect(file_count).to eq(facts_24_count + facts_23_count)
+          expect(file_count).to eq(facts_42_count + facts_40_count)
         end
       end
 
       context 'that contains a path that is not a directory' do
-        let(:fact_paths) { [facts_24_path, non_directory_path].join(File::PATH_SEPARATOR) }
+        let(:fact_paths) { [facts_42_path, non_directory_path].join(File::PATH_SEPARATOR) }
 
         it 'ignores the path that is not a directory' do
           object = defined?(Warning) ? Warning : Kernel
           allow(object).to receive(:warn).and_call_original
           allow(object).to receive(:warn).with(a_string_matching(/is not a directory/))
 
-          expect(file_count).to eq(facts_24_count)
+          expect(file_count).to eq(facts_42_count)
         end
       end
     end
@@ -123,7 +123,7 @@ describe FacterDB do
     context 'when FACTERDB_SKIP_DEFAULTDB environment variable is not set' do
       it 'returns the list of fact sets included in FacterDB' do
         # This test is a little naive but works
-        expect(default_fact_files.count).to be >= 1000
+        expect(default_fact_files.count).to be >= 192
       end
     end
 
@@ -148,7 +148,7 @@ describe FacterDB do
     end
 
     it 'returns the deduplicated combination of .default_fact_files and .external_fact_files' do
-      ENV['FACTERDB_SEARCH_PATHS'] = facts_24_path
+      ENV['FACTERDB_SEARCH_PATHS'] = facts_42_path
 
       expect(facterdb_fact_files.count).to eq(described_class.default_fact_files.count)
     end
@@ -243,11 +243,11 @@ describe FacterDB do
     end
 
     context 'when matching a specific facter version' do
-      let(:facter_version) { '2.4.0' }
+      let(:facter_version) { '4.0.52' }
 
       shared_examples 'returns only the specified version' do
         it 'only includes fact sets for the specified version' do
-          expect(result).to all(include(facterversion: match(/\A2\.4/)))
+          expect(result).to all(include(facterversion: match(/^4\.0/)))
         end
       end
 
@@ -319,14 +319,35 @@ describe FacterDB do
   end
 
   describe '.get_facts' do
-    subject(:result) { FacterDB.get_facts(filter) }
+    subject(:result) { FacterDB.get_facts(filter, symbolize_keys: symbolize_keys) }
 
     let(:filter) { nil }
+    let(:symbolize_keys) { nil }
 
     context 'without parameters' do
       include_examples 'returns a result'
     end
 
+    context 'with stringified output' do
+      let(:symbolize_keys) { false }
+
+      it 'returns strings as keys in factsets' do
+        result.each do |factset|
+          expect(factset.keys).to all(be_an_instance_of(String))
+        end
+      end
+    end
+
+    context 'with symbolized output' do
+      let(:symbolize_keys) { true }
+
+      it 'returns strings as keys in factsets' do
+        result.each do |factset|
+          expect(factset.keys).to all(be_an_instance_of(Symbol))
+        end
+      end
+    end
+
     context 'with an Array filter' do
       let(:filter) { [osfamily: 'Debian'] }
 

data/spec/facts_spec.rb

@@ -80,9 +80,18 @@ describe 'Default Facts' do
         expect(content['facterversion']).to have_facter_version(facter_dir_path, filepath)
       end
 
+      # when facts are generated with distro facter or rubygems facter the augeas bindings might be missing
+      # we need to ensure they exist
+      it 'contains the augeas.version fact' do
+        if content['kernel'] == 'Linux'
+          expect(content['augeas']['version']).to not_be_nil.and not_be_empty
+        end
+      end
+
       it 'contains newer networking facts hash' do
         if Gem::Version.new(content['facterversion']) >= Gem::Version.new('3.0.0')
           expect(content['networking']['ip']).to not_be_nil.and not_be_empty
+          expect(content['networking']['ip6']).to not_be_nil.and not_be_empty
           expect(content['networking']['hostname']).to eq('foo')
           expect(content['networking']['domain']).to eq('example.com')
           expect(content['networking']['fqdn']).to eq('foo.example.com')
@@ -109,25 +118,12 @@ describe 'Default Facts' do
         expect(content['systemd_internal_services']).to be_nil
       end
 
-      it 'contains a legacy hostname, domain and fqdn fact' do
-        expect(content['hostname']).to eq('foo')
-        expect(content['fqdn']).to eq('foo.example.com')
-        expect(content['domain']).to eq('example.com')
-      end
-
-      it 'contains the legacy osfamily fact' do
-        expect(content['osfamily']).not_to be_nil
-      end
-
-      it 'contains the legacy operatingsystem fact' do
-        expect(content['operatingsystem']).not_to be_nil
-      end
-
-      # the fact got introduced in 1.5.5 and is confined to kernel=linux
-      # https://github.com/puppetlabs/facter/blob/1.6.0/lib/facter/selinux.rb
-      # f94abfccfd6687a88f62703e4005c28ec04467a1 from facter
-      it 'contains the legacy selinux fact' do
-        expect(content['selinux']).not_to be_nil if content['kernel'] == 'Linux'
+      # those are used in newer rspec-puppet-facts versions
+      # by ensuring those facts exists, we can drop a huge amount of logic in rspec-puppet-facts
+      it 'contains the mandatory OS facts' do
+        expect(content['os']['release']['major']).to not_be_nil.and not_be_empty
+        expect(content['os']['name']).to not_be_nil.and not_be_empty
+        expect(content['os']['hardware']).to not_be_nil.and not_be_empty
       end
     end
   end