Add a warning if the computed hiera data directory is not found

Author: Kevin Paulisse

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

@@ -208,6 +208,14 @@ def install_hiera_config(logger, options)
           end
           rexp2 = Regexp.new('%{(::)?environment}')
           obj[key.to_sym][:datadir].sub!(rexp2, 'production')
+
+          # Make sure the dirctory exists. If not, log a warning. This is *probably* a setup error, but we don't
+          # want it to be fatal in case (for example) someone is doing an octocatalog-diff to verify moving this
+          # directory around or even setting up Hiera for the very first time.
+          unless File.directory?(obj[key.to_sym][:datadir])
+            message = "WARNING: Hiera datadir for #{key} doesn't seem to exist at #{obj[key.to_sym][:datadir]}"
+            logger.warn message
+          end
         end
 
         # Write properly formatted hiera config file into temporary directory

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

@@ -192,13 +192,14 @@
           hiera_config: OctocatalogDiff::Spec.fixture_path('repos/default/config/hiera.yaml'),
           hiera_path_strip: '/var/lib/puppet'
         )
-        logger, _logger_str = OctocatalogDiff::Spec.setup_logger
+        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'))
+        expect(logger_str.string).not_to match(/Hiera datadir for yaml doesn't seem to exist/)
       end
     end
 
@@ -213,6 +214,23 @@
         end.to raise_error(ArgumentError, /Called install_hiera_config with a Symbol argument/)
       end
     end
+
+    context 'warning if directory not found' do
+      it 'should warn about not finding the hiera data directory' do
+        options = default_options.merge(
+          hiera_config: OctocatalogDiff::Spec.fixture_path('repos/default/config/hiera.yaml'),
+          hiera_path: 'aksdfjlkfjk'
+        )
+        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', 'aksdfjlkfjk'))
+        expect(logger_str.string).to match(%r{WARNING: Hiera datadir for yaml.+/environments/production/aksdfjlkfjk})
+      end
+    end
   end
 
   describe '#install_fact_file' do