Implement preserve environments feature

Author: Kevin Paulisse

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

@@ -49,7 +49,7 @@ def initialize(options = {}, logger = nil)
 
         create_structure
 
-        if options[:preserve_environment]
+        if options[:preserve_environments]
           install_directory_symlink(logger, File.join(options[:basedir], 'environments'), 'environments')
           options.fetch(:create_symlinks, %w(modules manifests)).each do |x|
             install_directory_symlink(logger, File.join(options[:basedir], x), x)

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

@@ -73,9 +73,14 @@ def puppet_command
           --no-ca
           --color=false
           --config_version="/bin/echo catalogscript"
-          --environment=production
         )
 
+        # Add environment - only make this variable if preserve_environments is used.
+        # If preserve_environments is not used, the hard-coded 'production' here matches
+        # up with the symlink created under the temporary directory structure.
+        environ = @options[:preserve_environments] ? @options.fetch(:environment, 'production') : 'production'
+        cmdline << "--environment=#{Shellwords.escape(environ)}"
+
         # For people who aren't running hiera, a hiera-config will not be generated when @options[:hiera_config]
         # is nil. For everyone else, the hiera config was generated/copied/munged in the 'builddir' class
         # and was installed into the compile directory and named hiera.yaml.

lib/octocatalog-diff/catalog/computed.rb

@@ -181,11 +181,21 @@ def exec_puppet
         }
       end
 
+      # Private method: Make sure that the Puppet environment directory exists.
+      def assert_that_puppet_environment_directory_exists
+        environ = @opts[:preserve_environments] ? @opts.fetch(:environment, 'production') : 'production'
+        target_dir = File.join(@builddir.tempdir, 'environments', environ)
+        return if File.directory?(target_dir)
+        raise Errno::ENOENT, "Environment directory #{target_dir} does not exist"
+      end
+
       # Private method: Runs puppet on the command line to compile the catalog
       # Exit code is 0 if catalog generation was successful, non-zero otherwise.
       # @param logger [Logger] Logger object
       # @return [Hash] { stdout: <catalog as JSON>, stderr: <error messages>, exitcode: <hopefully 0> }
       def run_puppet(logger)
+        assert_that_puppet_environment_directory_exists
+
         # Run 'cmd' with environment 'env' from directory 'dir'
         # First line of a successful result needs to be stripped off. It will look like:
         # Notice: Compiled catalog for xxx in environment production in 27.88 seconds