Move catalog compilation errors to errors class

Author: Kevin Paulisse

lib/octocatalog-diff/catalog.rb

@@ -9,6 +9,7 @@
 require_relative 'catalog/puppetdb'
 require_relative 'catalog/puppetmaster'
 require_relative 'catalog-util/fileresources'
+require_relative 'errors'
 
 module OctocatalogDiff
   # This class represents a catalog. Generation of the catalog is handled via one of the
@@ -18,11 +19,6 @@ class Catalog
     # Readable
     attr_reader :built, :catalog, :catalog_json
 
-    # Error classes that we can throw
-    class PuppetVersionError < RuntimeError; end
-    class CatalogError < RuntimeError; end
-    class ReferenceValidationError < RuntimeError; end
-
     # Constructor
     # @param :backend [Symbol] If set, this will force a backend
     # @param :json [String] JSON catalog content (will avoid running Puppet to compile catalog)
@@ -159,8 +155,8 @@ def resource(opts = {})
     # This is a compatibility layer for the resources, which are in a different place in Puppet 3.x and Puppet 4.x
     # @return [Array] Resource array
     def resources
-      raise CatalogError, 'Catalog does not appear to have been built' if !valid? && error_message.nil?
-      raise CatalogError, error_message unless valid?
+      raise OctocatalogDiff::Errors::CatalogError, 'Catalog does not appear to have been built' if !valid? && error_message.nil?
+      raise OctocatalogDiff::Errors::CatalogError, error_message unless valid?
       return @catalog['data']['resources'] if @catalog['data'].is_a?(Hash) && @catalog['data']['resources'].is_a?(Array)
       return @catalog['resources'] if @catalog['resources'].is_a?(Array)
       # This is a bug condition
@@ -183,7 +179,7 @@ def valid?
     end
 
     # Determine if all of the (before, notify, require, subscribe) targets are actually in the catalog.
-    # Raise a ReferenceValidationError for any found to be missing.
+    # Raise a OctocatalogDiff::Errors::ReferenceValidationError for any found to be missing.
     # Uses @options[:validate_references] to influence which references are checked.
     def validate_references
       # Skip out early if no reference validation has been requested.
@@ -223,7 +219,7 @@ def validate_references
       formatted_references.flatten!
       plural = formatted_references.size == 1 ? '' : 's'
       errors = formatted_references.join('; ')
-      raise ReferenceValidationError, "Catalog has broken reference#{plural}: #{errors}"
+      raise OctocatalogDiff::Errors::ReferenceValidationError, "Catalog has broken reference#{plural}: #{errors}"
     end
 
     private

lib/octocatalog-diff/errors.rb

@@ -10,6 +10,8 @@ class ConfigurationFileContentError < RuntimeError; end
     # Error classes for building catalogs
     class BootstrapError < RuntimeError; end
     class CatalogError < RuntimeError; end
+    class PuppetVersionError < RuntimeError; end
+    class ReferenceValidationError < RuntimeError; end
 
     # Error classes for retrieving facts
     class FactSourceError < RuntimeError; end

spec/octocatalog-diff/integration/integration_helper.rb

@@ -1,5 +1,6 @@
 require_relative '../tests/spec_helper'
 require OctocatalogDiff::Spec.require_path('/cli')
+require OctocatalogDiff::Spec.require_path('/errors')
 
 require 'json'
 require 'ostruct'

spec/octocatalog-diff/integration/reference_validation_spec.rb

@@ -99,7 +99,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -122,7 +122,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -141,7 +141,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -160,7 +160,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -220,7 +220,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -285,7 +285,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages' do
@@ -329,7 +329,7 @@ def self.catalog_contains_resource(result, type, title)
     end
 
     it 'should raise ReferenceValidationError' do
-      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Catalog::ReferenceValidationError)
+      expect(@result.exception).to be_a_kind_of(OctocatalogDiff::Errors::ReferenceValidationError)
     end
 
     it 'should have formatted error messages from to-catalog only' do

spec/octocatalog-diff/tests/catalog_spec.rb

@@ -4,6 +4,7 @@
 require_relative '../mocks/puppetdb'
 
 require OctocatalogDiff::Spec.require_path('/catalog')
+require OctocatalogDiff::Spec.require_path('/errors')
 
 describe OctocatalogDiff::Catalog do
   context 'backends' do
@@ -311,15 +312,15 @@
         it 'should raise error' do
           expect do
             @catalog.resource(type: 'System::User', title: 'alice')
-          end.to raise_error(OctocatalogDiff::Catalog::CatalogError, /Broken!/)
+          end.to raise_error(OctocatalogDiff::Errors::CatalogError, /Broken!/)
         end
       end
 
       describe '#resources' do
         it 'should throw an error' do
           expect do
             @catalog.resources
-          end.to raise_error(OctocatalogDiff::Catalog::CatalogError, /Broken!/)
+          end.to raise_error(OctocatalogDiff::Errors::CatalogError, /Broken!/)
         end
       end
 
@@ -476,7 +477,7 @@
         'exec[subscribe caller 2] -> subscribe[Exec[subscribe target 2]]',
         'exec[subscribe caller 3] -> subscribe[Exec[subscribe target]]'
       ].join('; ')
-      expect { catalog.validate_references }.to raise_error(OctocatalogDiff::Catalog::ReferenceValidationError, error_str)
+      expect { catalog.validate_references }.to raise_error(OctocatalogDiff::Errors::ReferenceValidationError, error_str)
     end
   end