Make hiera_path actually do what it's supposed to

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-util/builddir.rb

@@ -27,6 +27,7 @@ class BuildDir
       # :enc [String] ENC script file (can be relative or absolute path)
       # :pe_enc_url [String] ENC URL (for Puppet Enterprise node classification service)
       # :hiera_config [String] hiera configuration file (relative to base directory)
+      # :hiera_path [String] relative path to hiera data files (mutually exclusive with :hiera_path_strip)
       # :hiera_path_strip [String] string to strip off the beginning of :datadir
       # :puppetdb_ssl_ca [String] Path to SSL CA certificate
       # :puppetdb_ssl_client_key [String] String representation of SSL client key
@@ -52,9 +53,8 @@ def initialize(options = {}, logger = nil)
           install_puppetdb_conf(logger, options[:puppetdb_url], options[:puppetdb_server_url_timeout])
           install_routes_yaml(logger)
         end
-        unless options[:hiera_config].nil?
-          install_hiera_config(logger, options[:hiera_config], options[:hiera_path_strip])
-        end
+        install_hiera_config(logger, options) unless options[:hiera_config].nil?
+
         @fact_file = install_fact_file(logger, options) if @facts_terminus == 'yaml'
         @enc = install_enc(logger) unless options[:enc].nil? && options[:pe_enc_url].nil?
         install_ssl(logger, options) if options[:puppetdb_ssl_ca] || options[:puppetdb_ssl_client_cert]
@@ -179,10 +179,10 @@ def install_enc(logger)
       end
 
       # Install hiera config file
-      # @param hiera_config [String] Path to file, relative to checkout
-      # @param hiera_path_strip [String] Prefix to strip off when munging file
-      def install_hiera_config(logger, hiera_config, hiera_path_strip)
+      # @param options [Hash] Options hash
+      def install_hiera_config(logger, options)
         # Validate hiera config file
+        hiera_config = options[:hiera_config]
         unless hiera_config.is_a?(String)
           raise ArgumentError, "Called install_hiera_config with a #{hiera_config.class} argument"
         end
@@ -199,10 +199,12 @@ def install_hiera_config(logger, hiera_config, hiera_path_strip)
         obj = YAML.load_file(file_src)
         %w(yaml json).each do |key|
           next unless obj.key?(key.to_sym)
-          next if obj[key.to_sym][:datadir].nil?
-          unless hiera_path_strip.nil?
-            rexp1 = Regexp.new('^' + hiera_path_strip)
+          if options[:hiera_path_strip].is_a?(String)
+            next if obj[key.to_sym][:datadir].nil?
+            rexp1 = Regexp.new('^' + options[:hiera_path_strip])
             obj[key.to_sym][:datadir].sub!(rexp1, @tempdir)
+          elsif options[:hiera_path]
+            obj[key.to_sym][:datadir] = File.join(@tempdir, 'environments', 'production', options[:hiera_path])
           end
           rexp2 = Regexp.new('%{(::)?environment}')
           obj[key.to_sym][:datadir].sub!(rexp2, 'production')

spec/octocatalog-diff/tests/catalog-util/builddir_spec.rb

@@ -170,17 +170,35 @@
       end
     end
 
-    context 'with invalid options' do
-      it 'should raise argument error if called with non-string argument' do
-        options = {
-          basedir: OctocatalogDiff::Spec.fixture_path('repos/default'),
-          fact_file: OctocatalogDiff::Spec.fixture_path('facts/valid-facts.yaml'),
-          node: 'rspec-node.github.net'
-        }
+    context 'with hiera_path specified' do
+      it 'should install the hiera configuration file' do
+        options = default_options.merge(
+          hiera_config: OctocatalogDiff::Spec.fixture_path('repos/default/config/hiera.yaml'),
+          hiera_path: 'hieradata'
+        )
         logger, _logger_str = OctocatalogDiff::Spec.setup_logger
-        r = Regexp.new('Called install_hiera_config with a Symbol argument')
         testobj = OctocatalogDiff::CatalogUtil::BuildDir.new(options, logger)
-        expect { testobj.send(:install_hiera_config, logger, :chicken, nil) }.to raise_error(ArgumentError, r)
+        hiera_yaml = File.join(testobj.tempdir, 'hiera.yaml')
+        expect(File.file?(hiera_yaml)).to eq(true)
+        hiera_cfg = YAML.load_file(hiera_yaml)
+        expect(hiera_cfg[:backends]).to eq(['yaml'])
+        expect(hiera_cfg[:yaml]).to eq(datadir: File.join(testobj.tempdir, 'environments', 'production', 'hieradata'))
+      end
+    end
+
+    context 'with hiera_path_strip specified' do
+      it 'should install the hiera configuration file' do
+        options = default_options.merge(
+          hiera_config: OctocatalogDiff::Spec.fixture_path('repos/default/config/hiera.yaml'),
+          hiera_path_strip: '/var/lib/puppet'
+        )
+        logger, _logger_str = OctocatalogDiff::Spec.setup_logger
+        testobj = OctocatalogDiff::CatalogUtil::BuildDir.new(options, logger)
+        hiera_yaml = File.join(testobj.tempdir, 'hiera.yaml')
+        expect(File.file?(hiera_yaml)).to eq(true)
+        hiera_cfg = YAML.load_file(hiera_yaml)
+        expect(hiera_cfg[:backends]).to eq(['yaml'])
+        expect(hiera_cfg[:yaml]).to eq(datadir: File.join(testobj.tempdir, 'environments', 'production', 'hieradata'))
       end
     end
   end