facterdb 2.0.1 → 3.0.0

data/lib/facterdb.rb

@@ -78,37 +78,6 @@ module FacterDB
     (external_fact_files + default_fact_files).uniq
   end
 
-  # @deprecated Use {.get_facts} instead.
-  def self.get_os_facts(facter_version = '*', filter = [])
-    if facter_version == '*'
-      if filter.is_a?(Array)
-        filter_str = filter.map { |f| f.map { |k, v| "#{k}=#{v}" }.join(' and ') }.join(' or ')
-      elsif filter.is_a?(Hash)
-        filter_str = filter.map { |k, v| "#{k}=#{v}" }.join(' and ')
-      elsif filter.is_a?(String)
-        filter_str = filter
-      else
-        raise 'filter must be either an Array a Hash or a String'
-      end
-    elsif filter.is_a?(Array)
-      filter_str = "facterversion=/^#{facter_version}/ and (#{filter.map do |f|
-                                                                f.map do |k, v|
-                                                                  "#{k}=#{v}"
-                                                                end.join(' and ')
-                                                              end.join(' or ')})"
-    elsif filter.is_a?(Hash)
-      filter_str = "facterversion=/^#{facter_version}/ and (#{filter.map { |k, v| "#{k}=#{v}" }.join(' and ')})"
-    elsif filter.is_a?(String)
-      filter_str = "facterversion=/^#{facter_version}/ and (#{filter})"
-    else
-      raise 'filter must be either an Array a Hash or a String'
-    end
-
-    warn "[DEPRECATION] `get_os_facts` is deprecated. Please use `get_facts(#{filter_str})` instead."
-
-    get_facts(filter_str)
-  end
-
   # @return [String] the string filter
   # @param filter [Object] The filter to convert to jgrep string
   def self.generate_filter_str(filter = nil)
@@ -137,13 +106,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

@@ -197,91 +197,6 @@ describe FacterDB do
     end
   end
 
-  describe '.get_os_facts' do
-    subject(:result) { FacterDB.get_os_facts(facter_version, filter) }
-
-    before do
-      object = defined?(Warning) ? Warning : Kernel
-      allow(object).to receive(:warn).and_call_original
-      allow(object).to receive(:warn).with(a_string_matching(/`get_os_facts` is deprecated/))
-    end
-
-    context 'without parameters' do
-      subject(:result) { FacterDB.get_os_facts }
-
-      include_examples 'returns a result'
-    end
-
-    context 'when matching all Facter versions' do
-      let(:facter_version) { '*' }
-
-      context 'with an Array filter' do
-        let(:filter) { [{ osfamily: 'Debian' }] }
-
-        include_examples 'returns a result'
-      end
-
-      context 'with a Hash filter' do
-        let(:filter) { { osfamily: 'Debian' } }
-
-        include_examples 'returns a result'
-      end
-
-      context 'with a String filter' do
-        let(:filter) { 'osfamily=Debian' }
-
-        include_examples 'returns a result'
-      end
-
-      context 'with a filter of an unsupported type' do
-        let(:filter) { true }
-
-        it 'raises an error' do
-          expect { result }.to raise_error(/filter must be either/)
-        end
-      end
-    end
-
-    context 'when matching a specific facter version' do
-      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(/^4\.0/)))
-        end
-      end
-
-      context 'with an Array filter' do
-        let(:filter) { [{ osfamily: 'Debian' }] }
-
-        include_examples 'returns a result'
-        include_examples 'returns only the specified version'
-      end
-
-      context 'with a Hash filter' do
-        let(:filter) { { osfamily: 'Debian' } }
-
-        include_examples 'returns a result'
-        include_examples 'returns only the specified version'
-      end
-
-      context 'with a String filter' do
-        let(:filter) { 'osfamily=Debian' }
-
-        include_examples 'returns a result'
-        include_examples 'returns only the specified version'
-      end
-
-      context 'with a filter of an unsupported type' do
-        let(:filter) { true }
-
-        it 'raises an error' do
-          expect { result }.to raise_error(/filter must be either/)
-        end
-      end
-    end
-  end
-
   describe '.valid_filters?' do
     it 'invalid and false' do
       expect(FacterDB.valid_filters?('and')).to be_falsey
@@ -302,11 +217,11 @@ describe FacterDB do
     end
 
     it 'with hash' do
-      expect(FacterDB.generate_filter_str({ osfamily: 'Debian' })).to eq('osfamily=Debian')
+      expect(FacterDB.generate_filter_str({ kernel: 'Linux' })).to eq('kernel=Linux')
     end
 
     it 'with Array' do
-      expect(FacterDB.generate_filter_str([osfamily: 'Debian'])).to eq('(osfamily=Debian)')
+      expect(FacterDB.generate_filter_str([kernel: 'Linux'])).to eq('(kernel=Linux)')
     end
 
     it 'empty' do
@@ -319,28 +234,49 @@ 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'] }
+      let(:filter) { [kernel: 'Linux'] }
 
       include_examples 'returns a result'
     end
 
     context 'with a Hash filter' do
-      let(:filter) { { osfamily: 'Debian' } }
+      let(:filter) { { kernel: 'Linux' } }
 
       include_examples 'returns a result'
     end
 
     context 'with a String filter' do
-      let(:filter) { 'osfamily=Debian' }
+      let(:filter) { 'kernel=Linux' }
 
       include_examples 'returns a result'
     end

data/spec/facts_spec.rb

@@ -98,8 +98,8 @@ describe 'Default Facts' do
         end
       end
 
-      it 'contains the legacy ipaddress fact' do
-        expect(content['ipaddress']).to not_be_nil.and not_be_empty
+      it 'does not contains the legacy ipaddress fact' do
+        expect(content['ipaddress']).to be_nil
       end
 
       it 'contains no facts from puppetlabs/stdlib' do
@@ -117,6 +117,28 @@ describe 'Default Facts' do
         expect(content['systemd_version']).to be_nil
         expect(content['systemd_internal_services']).to be_nil
       end
+
+      # 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
+
+      it 'does not contain a legacy hostname, domain and fqdn fact' do
+        expect(content['hostname']).to be_nil
+        expect(content['fqdn']).to be_nil
+        expect(content['domain']).to be_nil
+      end
+
+      it 'does not contain the legacy osfamily fact' do
+        expect(content['osfamily']).to be_nil
+      end
+
+      it 'does not contain the legacy operatingsystem fact' do
+        expect(content['operatingsystem']).to be_nil
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facterdb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -111,6 +111,7 @@ email:
 - voxpupuli@groups.io
 executables:
 - facterdb
+- legacy-facts-striper
 extensions: []
 extra_rdoc_files: []
 files:
@@ -130,6 +131,7 @@ files:
 - README.md
 - Rakefile
 - bin/facterdb
+- bin/legacy-facts-striper
 - database/list_arch_os_facter.md
 - database/list_facter_os_arch.md
 - database/list_os_arch_facter.md
@@ -152,15 +154,12 @@ files:
 - facterdb.gemspec
 - facts/4.0/almalinux-8-x86_64.facts
 - facts/4.0/almalinux-9-x86_64.facts
-- facts/4.0/centos-7-x86_64.facts
-- facts/4.0/centos-8-x86_64.facts
 - facts/4.0/debian-11-x86_64.facts
 - facts/4.0/freebsd-11-x86_64.facts
 - facts/4.0/freebsd-12-x86_64.facts
 - facts/4.0/freebsd-13-x86_64.facts
 - facts/4.0/opensuse-15-x86_64.facts
 - facts/4.0/oraclelinux-7-x86_64.facts
-- facts/4.0/redhat-7-x86_64.facts
 - facts/4.0/redhat-8-x86_64.facts
 - facts/4.0/rocky-8-x86_64.facts
 - facts/4.0/rocky-9-x86_64.facts
@@ -172,8 +171,6 @@ files:
 - facts/4.0/ubuntu-21.10-x86_64.facts
 - facts/4.1/almalinux-8-x86_64.facts
 - facts/4.1/almalinux-9-x86_64.facts
-- facts/4.1/centos-7-x86_64.facts
-- facts/4.1/centos-8-x86_64.facts
 - facts/4.1/debian-11-x86_64.facts
 - facts/4.1/freebsd-11-x86_64.facts
 - facts/4.1/freebsd-12-x86_64.facts
@@ -190,8 +187,6 @@ files:
 - facts/4.2/almalinux-9-x86_64.facts
 - facts/4.2/amazon-2022-x86_64.facts
 - facts/4.2/archlinux-x86_64.facts
-- facts/4.2/centos-7-x86_64.facts
-- facts/4.2/centos-8-x86_64.facts
 - facts/4.2/centos-9-x86_64.facts
 - facts/4.2/darwin-20-x86_64.facts
 - facts/4.2/debian-11-x86_64.facts
@@ -210,7 +205,6 @@ files:
 - facts/4.2/oraclelinux-8-x86_64.facts
 - facts/4.2/oraclelinux-9-x86_64.facts
 - facts/4.2/popos-21.10-x86_64.facts
-- facts/4.2/redhat-7-x86_64.facts
 - facts/4.2/redhat-8-x86_64.facts
 - facts/4.2/redhat-9-x86_64.facts
 - facts/4.2/rocky-8-x86_64.facts
@@ -237,8 +231,6 @@ files:
 - facts/4.3/almalinux-8-x86_64.facts
 - facts/4.3/almalinux-9-x86_64.facts
 - facts/4.3/archlinux-x86_64.facts
-- facts/4.3/centos-7-x86_64.facts
-- facts/4.3/centos-8-x86_64.facts
 - facts/4.3/centos-9-x86_64.facts
 - facts/4.3/debian-11-x86_64.facts
 - facts/4.3/debian-12-i386.facts
@@ -273,8 +265,6 @@ files:
 - facts/4.4/almalinux-8-x86_64.facts
 - facts/4.4/almalinux-9-x86_64.facts
 - facts/4.4/archlinux-x86_64.facts
-- facts/4.4/centos-7-x86_64.facts
-- facts/4.4/centos-8-x86_64.facts
 - facts/4.4/centos-9-x86_64.facts
 - facts/4.4/debian-11-x86_64.facts
 - facts/4.4/debian-12-i386.facts
@@ -310,8 +300,6 @@ files:
 - facts/4.5/almalinux-9-x86_64.facts
 - facts/4.5/amazon-2-x86_64.facts
 - facts/4.5/archlinux-x86_64.facts
-- facts/4.5/centos-7-x86_64.facts
-- facts/4.5/centos-8-x86_64.facts
 - facts/4.5/centos-9-x86_64.facts
 - facts/4.5/debian-11-x86_64.facts
 - facts/4.5/debian-12-x86_64.facts
@@ -339,7 +327,6 @@ files:
 - facts/4.6/almalinux-8-x86_64.facts
 - facts/4.6/almalinux-9-x86_64.facts
 - facts/4.6/archlinux-x86_64.facts
-- facts/4.6/centos-8-x86_64.facts
 - facts/4.6/centos-9-x86_64.facts
 - facts/4.6/debian-11-x86_64.facts
 - facts/4.6/debian-12-x86_64.facts
@@ -362,7 +349,6 @@ files:
 - facts/4.7/almalinux-8-x86_64.facts
 - facts/4.7/almalinux-9-x86_64.facts
 - facts/4.7/archlinux-x86_64.facts
-- facts/4.7/centos-8-x86_64.facts
 - facts/4.7/centos-9-x86_64.facts
 - facts/4.7/debian-11-x86_64.facts
 - facts/4.7/debian-12-x86_64.facts