Merge pull request #8990 from mhashizume/PUP-11621/main/drop-hiera-3

(PUP-11621) Hiera 3 deprecation

Author: joshcooper

.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |s|
   s.summary = "Puppet, an automated configuration management tool"
   s.specification_version = 3
   s.add_runtime_dependency(%q<facter>, [">= 2.4.0", "< 5"])
-  s.add_runtime_dependency(%q<hiera>, [">= 3.2.1", "< 4"])
   s.add_runtime_dependency(%q<semantic_puppet>, "~> 1.0")
   s.add_runtime_dependency(%q<fast_gettext>, ">= 2.1", "< 3")
   s.add_runtime_dependency(%q<locale>, "~> 2.1")

Gemfile

@@ -14,12 +14,12 @@ end
 
 # override .gemspec deps - may issue warning depending on Bundler version
 gem "facter", :git => 'https://github.com/puppetlabs/facter'
-gem "hiera", *location_for(ENV['HIERA_LOCATION']) if ENV.has_key?('HIERA_LOCATION')
 gem "semantic_puppet", *location_for(ENV['SEMANTIC_PUPPET_LOCATION'] || ["~> 1.0"])
 gem "puppet-resource_api", *location_for(ENV['RESOURCE_API_LOCATION'] || ["~> 1.5"])
 
 group(:features) do
   gem 'diff-lcs', '~> 1.3', require: false
+  gem "hiera", *location_for(ENV['HIERA_LOCATION']) if ENV.has_key?('HIERA_LOCATION')
   gem 'hiera-eyaml', *location_for(ENV['HIERA_EYAML_LOCATION'])
   gem 'hocon', '~> 1.0', require: false
   # requires native libshadow headers/libs

ext/project_data.yaml

@@ -19,7 +19,6 @@ gem_required_ruby_version: '>= 2.5.0'
 gem_required_rubygems_version: '> 1.3.1'
 gem_runtime_dependencies:
   facter: ['> 2.0.1', '< 5']
-  hiera: ['>= 3.2.1', '< 4']
   semantic_puppet: '~> 1.0'
   fast_gettext: ['>= 1.1', '< 3']
   locale: '~> 2.1'

install.rb

@@ -44,7 +44,7 @@
   $haverdoc = false
 end
 
-PREREQS = %w{openssl facter cgi hiera}
+PREREQS = %w{openssl facter cgi}
 MIN_FACTER_VERSION = 1.5
 
 InstallOptions = OpenStruct.new

lib/hiera_puppet.rb

@@ -1,4 +1,4 @@
-require 'hiera'
+Puppet.features.hiera?
 require 'hiera/scope'
 require_relative 'puppet'
 

lib/puppet/pops/lookup/hiera_config.rb

@@ -282,8 +282,9 @@ def name
   end
 
   def create_hiera3_backend_provider(name, backend, parent_data_provider, datadir, paths, hiera3_config)
-    # Custom backend. Hiera v3 must be installed, it's logger configured, and it must be made aware of the loaded config
-    require 'hiera'
+    # Custom backend. Hiera 3 must be installed, its logger configured, and it must be made aware of the loaded config
+    raise Puppet::DataBinding::LookupError, 'Hiera 3 is not installed' if !Puppet.features.hiera?
+
     if Hiera::Config.instance_variable_defined?(:@config) && (current_config = Hiera::Config.instance_variable_get(:@config)).is_a?(Hash)
       current_config.each_pair do |key, val|
         case key

spec/unit/functions/hiera_spec.rb

@@ -161,7 +161,7 @@ def func(*args, &block)
     with_scope { |scope| the_func.call(scope, *args, &block) }
   end
 
-  context 'hiera' do
+  context 'hiera', :if => Puppet.features.hiera? do
     it 'should require a key argument' do
       expect { func([]) }.to raise_error(ArgumentError)
     end
@@ -195,7 +195,7 @@ def func(*args, &block)
       expect(func('datasources', nil, 'the_override')).to eql(['the_override', 'first', 'second'])
     end
 
-    it 'a hiera v3 scope is used' do
+    it 'a hiera v3 scope is used', :if => Puppet.features.hiera? do
       expect(eval_and_collect_notices(<<-PUPPET, node)).to eql(['-- testing --', '-- mod::foo --', '-- mod/foo --', '-- mod --', '-- mod --'])
       class testing () {
          notice(hiera('class_name'))
@@ -266,7 +266,7 @@ class testing () {
     end
   end
 
-  context 'hiera_array' do
+  context 'hiera_array', :if => Puppet.features.hiera? do
     let(:the_func) { Puppet.lookup(:loaders).puppet_system_loader.load(:function, 'hiera_array') }
 
     it 'should require a key argument' do
@@ -299,7 +299,7 @@ class testing () {
     end
   end
 
-  context 'hiera_hash' do
+  context 'hiera_hash', :if => Puppet.features.hiera? do
     let(:the_func) { Puppet.lookup(:loaders).puppet_system_loader.load(:function, 'hiera_hash') }
 
     it 'should require a key argument' do
@@ -336,7 +336,7 @@ class testing () {
     end
   end
 
-  context 'hiera_include' do
+  context 'hiera_include', :if => Puppet.features.hiera? do
     let(:the_func) { Puppet.lookup(:loaders).puppet_system_loader.load(:function, 'hiera_include') }
 
     it 'should require a key argument' do
@@ -365,7 +365,7 @@ class testing () {
     end
   end
 
-  context 'with custom backend and merge_behavior declared in hiera.yaml' do
+  context 'with custom backend and merge_behavior declared in hiera.yaml', :if => Puppet.features.hiera? do
     let(:merge_behavior) { 'deeper' }
 
     let(:hiera_yaml) do
@@ -468,7 +468,7 @@ class testing () {
       end
     end
 
-    context 'hiera_array' do
+    context 'hiera_array', :if => Puppet.features.hiera? do
       let(:the_func) { Puppet.lookup(:loaders).puppet_system_loader.load(:function, 'hiera_array') }
 
       it 'declared merge_behavior is ignored' do

spec/unit/functions/lookup_spec.rb

@@ -3,7 +3,6 @@
 require 'puppet_spec/files'
 require 'puppet/pops'
 require 'deep_merge/core'
-require 'hiera'
 
 describe "The lookup function" do
   include PuppetSpec::Compiler
@@ -1652,7 +1651,7 @@ def uri_test_func(options, context)
         end
       end
 
-      context 'version 3' do
+      context 'version 3', :if => Puppet.features.hiera? do
         it 'finds data in in global layer and reports deprecation warnings for hiera.yaml' do
           expect(lookup('a')).to eql('value a (from global)')
           expect(warnings).to include(/Use of 'hiera.yaml' version 3 is deprecated. It should be converted to version 5/)
@@ -1697,6 +1696,14 @@ def uri_test_func(options, context)
           expect(lookup('datasources')).to eql(['common', 'example.com'])
         end
 
+        it 'backend specific options are propagated to custom backend' do
+          expect(lookup('other_option')).to eql('value of other_option')
+        end
+
+        it 'dotted keys are passed down to custom backend' do
+          expect(lookup('dotted.key')).to eql('custom backend received request for dotted.key value')
+        end
+        
         it 'delegates configured hocon backend to hocon_data function' do
           expect(explain('xs')).to match(/Hierarchy entry "hocon"\n.*\n.*\n.*"common"\n\s*Found key: "xs"/m)
         end
@@ -1705,6 +1712,18 @@ def uri_test_func(options, context)
           expect(lookup('xs.subkey')).to eql('value xs.subkey (from global hocon)')
         end
 
+        it 'multiple hiera3_backend declarations can be used and are merged into the generated config' do
+          expect(lookup(['datasources', 'other_option'])).to eql([['common', 'example.com'], 'value of other_option'])
+          expect(Hiera::Config.instance_variable_get(:@config)).to eql(
+            {
+              :backends => ['custom', 'other'],
+              :hierarchy => ['common', '%{domain}'],
+              :custom => { :datadir => "#{code_dir}/hieradata" },
+              :other => { :other_option => 'value of other_option', :datadir=>"#{code_dir}/hieradata" },
+              :logger => 'puppet'
+            })
+        end
+
         context 'with a module data provider' do
           let(:module_files) do
             {
@@ -2041,18 +2060,6 @@ def uri_test_func(options, context)
               paths:
                 - common.conf
                 - "%{domain}.conf"
-            - name: Custom
-              hiera3_backend: custom
-              paths:
-                - common.custom
-                - "%{domain}.custom"
-            - name: Other
-              hiera3_backend: other
-              options:
-                other_option: value of other_option
-              paths:
-                - common.other
-                - "%{domain}.other"
               YAML
         end
 
@@ -2067,7 +2074,6 @@ def uri_test_func(options, context)
           expect(explanation).to include('Hierarchy entry "Yaml"')
           expect(explanation).to include('Hierarchy entry "Json"')
           expect(explanation).to include('Hierarchy entry "Hocon"')
-          expect(explanation).to include('Hierarchy entry "Custom"')
           expect(explanation).to include('Found key: "a" value: "value a (from global)"')
         end
 
@@ -2079,35 +2085,10 @@ def uri_test_func(options, context)
                   'caa' => 'value hash_c.hash_ca.caa (from environment)',
                   'cab' => 'value hash_c.hash_ca.cab (from global)',
                   'cac' => 'value hash_c.hash_ca.cac (from global json)',
-                  'cad' => 'value hash_c.hash_ca.cad (from global custom)'
                 }
             })
         end
 
-        it 'backend data sources are propagated to custom backend' do
-          expect(lookup('datasources')).to eql(['common', 'example.com'])
-        end
-
-        it 'backend specific options are propagated to custom backend' do
-          expect(lookup('other_option')).to eql('value of other_option')
-        end
-
-        it 'dotted keys are passed down to custom backend' do
-          expect(lookup('dotted.key')).to eql('custom backend received request for dotted.key value')
-        end
-
-        it 'multiple hiera3_backend declarations can be used and are merged into the generated config' do
-          expect(lookup(['datasources', 'other_option'])).to eql([['common', 'example.com'], 'value of other_option'])
-          expect(Hiera::Config.instance_variable_get(:@config)).to eql(
-            {
-              :backends => ['custom', 'other'],
-              :hierarchy => ['common', '%{domain}'],
-              :custom => { :datadir => "#{code_dir}/hieradata" },
-              :other => { :other_option => 'value of other_option', :datadir=>"#{code_dir}/hieradata" },
-              :logger => 'puppet'
-            })
-        end
-
         it 'provides a sensible error message when the hocon library is not loaded' do
           allow(Puppet.features).to receive(:hocon?).and_return(false)
 
@@ -2156,7 +2137,7 @@ def uri_test_func(options, context)
             end
           end
 
-          context 'and eyaml_lookup_key function' do
+          context 'and eyaml_lookup_key function', :if => Puppet.features.hiera_eyaml? do
             let(:hiera_yaml) { <<-YAML.unindent }
               version: 5
               hierarchy:
@@ -2171,7 +2152,7 @@ def uri_test_func(options, context)
         end
       end
 
-      context 'with a hiera3_backend that has no paths' do
+      context 'with a hiera3_backend that has no paths', :if => Puppet.features.hiera? do
         let(:hiera_yaml) do
           <<-YAML.unindent
           ---
@@ -2215,7 +2196,7 @@ def uri_test_func(options, context)
           expect { lookup('mod_a::b') }.to raise_error(Puppet::DataBinding::LookupError, /did not find a value for the name 'mod_a::b'/)
         end
 
-        context 'with a Hiera v3 configuration' do
+        context 'with a Hiera v3 configuration', :if => Puppet.features.hiera?  do
           let(:mod_a_files) do
             {
               'mod_a' => {
@@ -2992,7 +2973,7 @@ def ruby_dig(segments, options, context)
       end
     end
 
-    context 'and an eyaml lookup_key function' do
+    context 'and an eyaml lookup_key function', :if => Puppet.features.hiera_eyaml? do
       let(:private_key_name) { 'private_key.pkcs7.pem' }
       let(:public_key_name) { 'public_key.pkcs7.pem' }
 
@@ -3294,7 +3275,7 @@ def ruby_dig(segments, options, context)
         expect(lookup('array_a')).to eql(['array_a[0]', 'array_a[1]'])
       end
 
-      context 'declared in global scope as a Hiera v3 backend' do
+      context 'declared in global scope as a Hiera v3 backend', :if => Puppet.features.hiera? do
         let(:environment_files) { {} }
         let(:data_file_content) { <<-YAML.unindent }
           a: >

spec/unit/hiera_puppet_spec.rb

@@ -2,7 +2,7 @@
 require 'hiera_puppet'
 require 'puppet_spec/scope'
 
-describe 'HieraPuppet' do
+describe 'HieraPuppet', :if => Puppet.features.hiera? do
   include PuppetSpec::Scope
 
   after(:all) do

spec/unit/indirector/hiera_spec.rb

@@ -1,9 +1,14 @@
 require 'spec_helper'
 require 'puppet/data_binding'
 require 'puppet/indirector/hiera'
-require 'hiera/backend'
 
-describe Puppet::Indirector::Hiera do
+begin
+  require 'hiera/backend'
+rescue LoadError => e
+  Puppet.warning(_("Unable to load Hiera 3 backend: %{message}") % {message: e.message})
+end
+
+describe Puppet::Indirector::Hiera, :if => Puppet.features.hiera? do
 
   module Testing
     module DataBinding