Add filename and line into reference validation error

Author: Kevin Paulisse

lib/octocatalog-diff/catalog.rb

@@ -201,29 +201,47 @@ def validate_references
       end
       return if missing.empty?
 
-      # At this point there is at least one broken/missing reference. Format an error message and
-      # raise. Error message will look like this:
-      # ---
-      # Catalog has broken references: exec[subscribe caller 1] -> subscribe[Exec[subscribe target]];
-      # exec[subscribe caller 2] -> subscribe[Exec[subscribe target]]; exec[subscribe caller 2] ->
-      # subscribe[Exec[subscribe target 2]]
-      # ---
+      # At this point there is at least one broken/missing reference. Format an error message and raise.
+      errors = format_missing_references(missing)
+      plural = errors =~ /;/ ? 's' : ''
+      raise OctocatalogDiff::Errors::ReferenceValidationError, "Catalog has broken reference#{plural}: #{errors}"
+    end
+
+    private
+
+    # Private method: Format the missing references into human-readable text
+    # Error message will look like this:
+    # ---
+    # Catalog has broken references: exec[subscribe caller 1](file:line) -> subscribe[Exec[subscribe target]];
+    # exec[subscribe caller 2](file:line) -> subscribe[Exec[subscribe target]]; exec[subscribe caller 2](file:line) ->
+    # subscribe[Exec[subscribe target 2]]
+    # ---
+    # @param missing [Array] Array of missing references
+    # @return [String] Formatted references
+    def format_missing_references(missing)
+      unless missing.is_a?(Array) && missing.any?
+        raise ArgumentError, 'format_missing_references() requires a non-empty array as input'
+      end
+
       formatted_references = missing.map do |obj|
         # obj[:target_value] can be a string or an array. If it's an array, create a
         # separate error message per element of that array. This allows the total number
         # of errors to be correct.
-        src = "#{obj[:source]['type'].downcase}[#{obj[:source]['title']}]"
+        src_ref = "#{obj[:source]['type'].downcase}[#{obj[:source]['title']}]"
+        src_file = if obj[:source]['file'].nil? || obj[:source]['file'].empty?
+          ''
+        elsif compilation_dir && obj[:source]['file'].start_with?(compilation_dir)
+          "(#{obj[:source]['file'][compilation_dir.length..-1]}:#{obj[:source]['line']})"
+        else
+          "(#{obj[:source]['file']}:#{obj[:source]['line']})"
+        end
+
         target_val = obj[:target_value].is_a?(Array) ? obj[:target_value] : [obj[:target_value]]
-        target_val.map { |tv| "#{src} -> #{obj[:target_type].downcase}[#{tv}]" }
-      end
-      formatted_references.flatten!
-      plural = formatted_references.size == 1 ? '' : 's'
-      errors = formatted_references.join('; ')
-      raise OctocatalogDiff::Errors::ReferenceValidationError, "Catalog has broken reference#{plural}: #{errors}"
+        target_val.map { |tv| "#{src_ref}#{src_file} -> #{obj[:target_type].downcase}[#{tv}]" }
+      end.flatten
+      formatted_references.join('; ')
     end
 
-    private
-
     # Private method: Given a list of resources to check, return the references from
     # that list that are missing from the catalog. (An empty array returned would indicate
     # all references are present in the catalog.)

spec/octocatalog-diff/tests/catalog_spec.rb

@@ -471,11 +471,13 @@
         json: File.read(OctocatalogDiff::Spec.fixture_path('catalogs/reference-validation-broken.json'))
       }
       catalog = OctocatalogDiff::Catalog.new(opts)
+      catalog.compilation_dir = '/var/folders/dw/5ftmkqk972j_kw2fdjyzdqdw0000gn/T/d20161223-46780-x10xaf/environments/production'
       error_str = [
-        'Catalog has broken references: exec[subscribe caller 1] -> subscribe[Exec[subscribe target]]',
-        'exec[subscribe caller 2] -> subscribe[Exec[subscribe target]]',
-        'exec[subscribe caller 2] -> subscribe[Exec[subscribe target 2]]',
-        'exec[subscribe caller 3] -> subscribe[Exec[subscribe target]]'
+        'Catalog has broken references: exec[subscribe caller 1](/modules/test/manifests/subscribe_callers.pp:2)' \
+          ' -> subscribe[Exec[subscribe target]]',
+        'exec[subscribe caller 2](/modules/test/manifests/subscribe_callers.pp:7) -> subscribe[Exec[subscribe target]]',
+        'exec[subscribe caller 2](/modules/test/manifests/subscribe_callers.pp:7) -> subscribe[Exec[subscribe target 2]]',
+        'exec[subscribe caller 3](/modules/test/manifests/subscribe_callers.pp:15) -> subscribe[Exec[subscribe target]]'
       ].join('; ')
       expect { catalog.validate_references }.to raise_error(OctocatalogDiff::Errors::ReferenceValidationError, error_str)
     end