Allow different directory names

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-diff/cli/catalogs.rb

@@ -198,7 +198,7 @@ def add_parallel_result(result, parallel_catalog_obj, key_task_tuple)
               # and remove the compilation directory (which is a tmpdir) to reveal only the relative
               # path to the files involved.
               dir = catalog.compilation_dir || ''
-              dir_regex = Regexp.new(Regexp.escape(dir) + '/environments/production/')
+              dir_regex = Regexp.new(Regexp.escape(dir) + '/environments/[^/]+/')
               error_display = catalog.error_message.split("\n").map do |line|
                 line.sub(/^Error:/, '[Puppet Error]').gsub(dir_regex, '')
               end.join("\n")

lib/octocatalog-diff/catalog-util/enc/script.rb

@@ -81,7 +81,7 @@ def execute(logger)
         def script_path(enc, tempdir)
           return enc if enc.start_with? '/'
           raise ArgumentError, 'OctocatalogDiff::CatalogUtil::ENC::Script#new requires :tempdir' unless tempdir.is_a?(String)
-          return File.join(tempdir, enc) if enc =~ %r{^environments/production/}
+          return File.join(tempdir, enc) if enc =~ %r{^environments/[^/]+/}
           File.join(tempdir, 'environments', 'production', enc)
         end
       end

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

@@ -13,9 +13,9 @@ class FileResources
       # Public method: Convert file resources to text. See the description of the class
       # just above for details.
       # @param obj [OctocatalogDiff::Catalog] Catalog object (will be modified)
-      def self.convert_file_resources(obj)
+      def self.convert_file_resources(obj, environment = 'production')
         return unless obj.valid? && obj.compilation_dir.is_a?(String) && !obj.compilation_dir.empty?
-        _convert_file_resources(obj.resources, obj.compilation_dir)
+        _convert_file_resources(obj.resources, obj.compilation_dir, environment)
         begin
           obj.catalog_json = ::JSON.generate(obj.catalog)
         rescue ::JSON::GeneratorError => exc
@@ -45,36 +45,39 @@ def self.file_path(src, modulepaths)
       end
 
       # Internal method: Parse environment.conf to find the modulepath
-      # @param compilation_dir [String] Compilation directory
+      # @param dir [String] Directory in which to look for environment.conf
       # @return [Array] Module paths
-      def self.module_path(compilation_dir)
-        environment_conf = File.join(compilation_dir, 'environment.conf')
-        unless File.file?(environment_conf)
-          return [File.join(compilation_dir, 'modules')]
-        end
+      def self.module_path(dir)
+        environment_conf = File.join(dir, 'environment.conf')
+        return [File.join(dir, 'modules')] unless File.file?(environment_conf)
 
         # This doesn't support multi-line, continuations with backslash, etc.
         # Does it need to??
         if File.read(environment_conf) =~ /^modulepath\s*=\s*(.+)/
-          Regexp.last_match(1).split(/:/).map(&:strip).reject { |x| x =~ /^\$/ }.map { |x| File.join(compilation_dir, x) }
+          result = []
+          Regexp.last_match(1).split(/:/).map(&:strip).each do |path|
+            next if path.start_with?('$')
+            result << File.expand_path(path, dir)
+          end
+          result
         else
-          [File.join(compilation_dir, 'modules')]
+          [File.join(dir, 'modules')]
         end
       end
 
       # Internal method: Static method to convert file resources. The compilation directory is
       # required, or else this is a no-op. The passed-in array of resources is modified by this method.
       # @param resources [Array<Hash>] Array of catalog resources
       # @param compilation_dir [String] Compilation directory (so files can be looked up)
-      def self._convert_file_resources(resources, compilation_dir)
+      def self._convert_file_resources(resources, compilation_dir, environment = 'production')
         # Calculate compilation directory. There is not explicit error checking here because
         # there is on-demand, explicit error checking for each file within the modification loop.
         return unless compilation_dir.is_a?(String) && compilation_dir != ''
 
-        # Making sure that compilation_dir/environments/production/modules exists (and by inference,
-        # that compilation_dir/environments/production is pointing at the right place). Otherwise, try to find
+        # Making sure that compilation_dir/environments/<env>/modules exists (and by inference,
+        # that compilation_dir/environments/<env> is pointing at the right place). Otherwise, try to find
         # compilation_dir/modules. If neither of those exist, this code can't run.
-        env_dir = File.join(compilation_dir, 'environments', 'production')
+        env_dir = File.join(compilation_dir, 'environments', environment)
         modulepaths = module_path(env_dir) + module_path(compilation_dir)
         modulepaths.select! { |x| File.directory?(x) }
         return if modulepaths.empty?

lib/octocatalog-diff/catalog.rb

@@ -74,10 +74,18 @@ def build(logger = Logger.new(StringIO.new))
       # Perform post-generation processing of the catalog
       return unless valid?
       unless @catalog_obj.respond_to?(:convert_file_resources) && @catalog_obj.convert_file_resources == false
-        OctocatalogDiff::CatalogUtil::FileResources.convert_file_resources(self) if @options.fetch(:compare_file_text, false)
+        if @options.fetch(:compare_file_text, false)
+          OctocatalogDiff::CatalogUtil::FileResources.convert_file_resources(self, environment)
+        end
       end
     end
 
+    # Compilation environment
+    # @return [String] Compilation environment (if set), else 'production' by default
+    def environment
+      @catalog_obj.respond_to?(:environment) ? @catalog_obj.environment : 'production'
+    end
+
     # For logging we may wish to know the backend being used
     # @return [String] Class of backend used
     def builder

lib/octocatalog-diff/catalog/computed.rb

@@ -78,6 +78,11 @@ def compilation_dir
         @builddir.tempdir
       end
 
+      # Environment used to compile catalog
+      def environment
+        @opts[:preserve_environments] ? @opts.fetch(:environment, 'production') : 'production'
+      end
+
       private
 
       # Private method: Clean up a checkout directory, if it exists
@@ -183,8 +188,7 @@ def exec_puppet
 
       # 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)
+        target_dir = File.join(@builddir.tempdir, 'environments', environment)
         return if File.directory?(target_dir)
         raise Errno::ENOENT, "Environment directory #{target_dir} does not exist"
       end