Clean up resource converter

Author: kpaulisse

lib/octocatalog-diff/catalog.rb

@@ -100,11 +100,7 @@ def build(logger = Logger.new(StringIO.new))
       validate_references
       return unless valid?
 
-      if supports_compare_file_text?
-        convert_file_resources(logger)
-      elsif @options[:compare_file_text]
-        logger.debug "Disabling --compare-file-text; not supported by #{self.class}"
-      end
+      convert_file_resources if @options[:compare_file_text]
 
       true
     end
@@ -144,12 +140,10 @@ def compilation_dir=(dir)
       @override_compilation_dir = dir
     end
 
-    # Stub method for "convert_file_resources" to raise an error if the backend doesn't support this.
-    # Getting here is expected to be a bug condition.
-    def convert_file_resources(_logger = Logger.new(StringIO.new))
-      # :nocov:
-      raise "convert_file_resources was called on but is not supported by #{self.class}"
-      # :nocov:
+    # Stub method for "convert_file_resources" -- returns false because if the underlying class does
+    # not implement this method, it's not supported.
+    def convert_file_resources(_dry_run = false)
+      false
     end
 
     # Retrieve the error message.
@@ -211,12 +205,6 @@ def retries
       nil
     end
 
-    # By default, catalogs do not support converting and comparing file resources. This can be overridden
-    # by backends that do support it.
-    def supports_compare_file_text?
-      false
-    end
-
     # Determine if the catalog build was successful.
     # @return [Boolean] Whether the catalog is valid
     def valid?
@@ -332,16 +320,5 @@ def build_resource_hash
         end
       end
     end
-
-    # Private method: A common way of running convert_file_resources for backends that allow it.
-    def convert_file_resources_real(logger = Logger.new(StringIO.new))
-      return false unless @options[:compare_file_text]
-      if @options[:basedir]
-        OctocatalogDiff::CatalogUtil::FileResources.convert_file_resources(self, environment)
-      else
-        logger.debug "Disabling --compare-file-text; not supported by #{self.class} without basedir"
-        false
-      end
-    end
   end
 end

lib/octocatalog-diff/catalog/computed.rb

@@ -63,13 +63,11 @@ def environment
         @options.fetch(:environment, 'production')
       end
 
-      # Convert file source => ... to content => ... if a basedir is given.
-      def convert_file_resources(logger = Logger.new(StringIO.new))
-        convert_file_resources_real(logger)
-      end
-
-      def supports_compare_file_text?
-        true
+      # Convert file resources source => "puppet:///..." to content => "actual content of file".
+      def convert_file_resources(dry_run = false)
+        return @options.key?(:basedir) if dry_run
+        return false unless @options[:basedir]
+        OctocatalogDiff::CatalogUtil::FileResources.convert_file_resources(self, environment)
       end
 
       private

lib/octocatalog-diff/catalog/json.rb

@@ -29,13 +29,11 @@ def initialize(options)
         end
       end
 
-      # Convert file source => ... to content => ... if a basedir is given.
-      def convert_file_resources(logger = Logger.new(StringIO.new))
-        convert_file_resources_real(logger)
-      end
-
-      def supports_compare_file_text?
-        true
+      # Convert file resources source => "puppet:///..." to content => "actual content of file".
+      def convert_file_resources(dry_run = false)
+        return @options.key?(:basedir) if dry_run
+        return false unless @options[:basedir]
+        OctocatalogDiff::CatalogUtil::FileResources.convert_file_resources(self, environment)
       end
     end
   end

lib/octocatalog-diff/util/catalogs.rb

@@ -69,9 +69,9 @@ def build_catalog_parallelizer
 
         # Disable --compare-file-text if either (or both) of the chosen backends do not support it
         if @options.fetch(:compare_file_text, false)
-          result.each do |_key, val|
-            next if val.supports_compare_file_text?
-            @logger.debug "Disabling --compare-file-text; not supported by #{val.builder}"
+          result.each do |_key, builder_obj|
+            next if builder_obj.convert_file_resources(true)
+            @logger.debug "Disabling --compare-file-text; not supported by #{builder_obj.builder}"
             @options[:compare_file_text] = false
             catalog_tasks.map! do |x|
               x[1].args[:compare_file_text] = false