Merge pull request #45 from github/kpaulisse-environment-hiera

Make hiera configuration work for alternate environments too

Author: kpaulisse

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

@@ -13,7 +13,7 @@ module CatalogUtil
     # - Register a handler to remove the temporary directory upon exit
     # - Install needed configuration files within the directory (e.g. puppetdb.conf)
     # - Install the facts into the directory
-    # - Install 'environments/production' which is a symlink to the checkout of the puppet code
+    # - Install 'environments/(environment)' which is a symlink to the checkout of the puppet code
     class BuildDir
       # Allow the path to the temporary directory to be read
       attr_reader :tempdir, :enc, :fact_file
@@ -220,10 +220,10 @@ def install_hiera_config(logger, options)
         end
         file_src = if hiera_config.start_with? '/'
           hiera_config
-        elsif hiera_config =~ %r{^environments/production/}
+        elsif hiera_config =~ %r{^environments/#{Regexp.escape(environment)}/}
           File.join(@tempdir, hiera_config)
         else
-          File.join(@tempdir, 'environments', 'production', hiera_config)
+          File.join(@tempdir, 'environments', environment, hiera_config)
         end
         raise Errno::ENOENT, "hiera.yaml (#{file_src}) wasn't found" unless File.file?(file_src)
 
@@ -236,10 +236,10 @@ def install_hiera_config(logger, options)
             rexp1 = Regexp.new('^' + options[:hiera_path_strip])
             obj[key.to_sym][:datadir].sub!(rexp1, @tempdir)
           elsif options[:hiera_path].is_a?(String)
-            obj[key.to_sym][:datadir] = File.join(@tempdir, 'environments', 'production', options[:hiera_path])
+            obj[key.to_sym][:datadir] = File.join(@tempdir, 'environments', environment, options[:hiera_path])
           end
           rexp2 = Regexp.new('%{(::)?environment}')
-          obj[key.to_sym][:datadir].sub!(rexp2, 'production')
+          obj[key.to_sym][:datadir].sub!(rexp2, environment)
 
           # 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
@@ -327,6 +327,10 @@ def install_ssl_client_password(logger, password)
         File.open(password_outfile, 'w') { |f| f.write(password) }
         logger.debug "Installed SSL client key password in #{password_outfile}"
       end
+
+      def environment
+        @options[:preserve_environments] ? @options.fetch(:environment, 'production') : 'production'
+      end
     end
   end
 end

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/one/hiera.yaml

@@ -0,0 +1,9 @@
+---
+:backends:
+  - yaml
+:yaml:
+  :datadir: /var/lib/puppet/environments/%{::environment}/hieradata
+:hierarchy:
+  - common
+:merge_behavior: deeper
+:logger: console

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/one/hieradata/common.yaml

@@ -0,0 +1,2 @@
+---
+  bar::param: 'Value from one/hieradata/common.yaml'

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/one/modules/bar/manifests/init.pp

@@ -1,4 +1,6 @@
-class bar {
+class bar (
+  $param = '',
+) {
   include sitetest
 
   file { '/tmp/bar':
@@ -9,4 +11,8 @@
   file { '/tmp/bar-static.txt':
     source => 'puppet:///modules/bar/bar-static.txt',
   }
+
+  file { '/tmp/bar-param.txt':
+    content => "one ${param}",
+  }
 }

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/two/hiera.yaml

@@ -0,0 +1,9 @@
+---
+:backends:
+  - yaml
+:yaml:
+  :datadir: /var/lib/puppet/environments/%{::environment}/hieradata
+:hierarchy:
+  - common
+:merge_behavior: deeper
+:logger: console

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/two/hieradata/common.yaml

@@ -0,0 +1,2 @@
+---
+  bar::param: 'Value from two/hieradata/common.yaml'

spec/octocatalog-diff/fixtures/repos/preserve-environments/environments/two/modules/bar/manifests/init.pp

@@ -1,4 +1,6 @@
-class bar {
+class bar (
+  $param = '',
+) {
   include sitetest
 
   file { '/tmp/bar':
@@ -9,4 +11,8 @@
   file { '/tmp/bar-static.txt':
     source => 'puppet:///modules/bar/bar-static.txt',
   }
+
+  file { '/tmp/bar-param.txt':
+    content => "two ${param}",
+  }
 }

spec/octocatalog-diff/integration/preserve_environments_spec.rb

@@ -137,14 +137,17 @@
               '--preserve-environments',
               '--from-environment', 'one',
               '--to-environment', 'two',
-              '--create-symlinks', 'modules,site'
+              '--create-symlinks', 'modules,site',
+              '--hiera-config', 'hiera.yaml',
+              '--hiera-path-strip', '/var/lib/puppet'
             ]
           )
         end
 
         it 'should exit without error' do
           expect(@result.exitcode).to eq(2), OctocatalogDiff::Integration.format_exception(@result)
           expect(@result.exception).to be_nil, OctocatalogDiff::Integration.format_exception(@result)
+          expect(@result.diffs.any?).to eq(true), OctocatalogDiff::Integration.format_exception(@result)
         end
 
         it 'should display proper diffs' do
@@ -178,6 +181,13 @@
             )
           ).to eq(true)
         end
+
+        it 'should handle hieradata properly' do
+          h = @result.diffs.select { |x| x[1] == "File\f/tmp/bar-param.txt\fparameters\fcontent" }
+          expect(h.size).to eq(1), h.inspect
+          expect(h.first[2]).to eq('one Value from one/hieradata/common.yaml')
+          expect(h.first[3]).to eq('two Value from two/hieradata/common.yaml')
+        end
       end
 
       context 'to modules' do

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

@@ -283,6 +283,7 @@
         puppetdb_server_url_timeout: 120
       }
     end
+
     context 'with relative path' do
       it 'should install the hiera configuration file' do
         options = default_options.merge(hiera_config: 'config/hiera.yaml')
@@ -309,6 +310,74 @@
       end
     end
 
+    context 'with relevant path and an alternate environment' do
+      let(:alternate_opts) do
+        {
+          basedir: OctocatalogDiff::Spec.fixture_path('repos/preserve-environments'),
+          hiera_config: 'hiera.yaml',
+          preserve_environments: true,
+          environment: 'one'
+        }
+      end
+
+      it 'should install the hiera configuration file' do
+        options = default_options.merge(alternate_opts)
+        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: '/var/lib/puppet/environments/one/hieradata')
+      end
+
+      it 'should handle hiera_path_strip with respect to the environment' do
+        options = default_options.merge(alternate_opts.merge(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', 'one', 'hieradata'))
+        expect(logger_str.string).not_to match(/Hiera datadir for yaml doesn't seem to exist/)
+      end
+    end
+
+    context 'with relevant path including an alternate environment' do
+      let(:alternate_opts) do
+        {
+          basedir: OctocatalogDiff::Spec.fixture_path('repos/preserve-environments'),
+          hiera_config: 'environments/one/hiera.yaml',
+          preserve_environments: true,
+          environment: 'one'
+        }
+      end
+
+      it 'should install the hiera configuration file' do
+        options = default_options.merge(alternate_opts)
+        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: '/var/lib/puppet/environments/one/hieradata')
+      end
+
+      it 'should handle hiera_path_strip with respect to the environment' do
+        options = default_options.merge(alternate_opts.merge(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', 'one', 'hieradata'))
+        expect(logger_str.string).not_to match(/Hiera datadir for yaml doesn't seem to exist/)
+      end
+    end
+
     context 'with absolute path' do
       it 'should install the hiera configuration file' do
         options = default_options.merge(hiera_config: OctocatalogDiff::Spec.fixture_path('repos/default/config/hiera.yaml'))