Centralize errors to their own class

Author: Kevin Paulisse

lib/octocatalog-diff.rb

@@ -1,5 +1,5 @@
 # These are all the classes we believe people might want to call directly, so load
 # them in response to a 'require octocatalog-diff'.
 
-loads = %w(api/v1 bootstrap catalog cli facts puppetdb version)
+loads = %w(api/v1 bootstrap catalog cli errors facts puppetdb version)
 loads.each { |f| require_relative "octocatalog-diff/#{f}" }

lib/octocatalog-diff/api/v1/config.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'common'
+require_relative '../../errors'
 
 module OctocatalogDiff
   module API
     module V1
       # This class interacts with the configuration file typically named `.octocatalog-diff.cfg.rb`.
       class Config
-        # Error class for handled configuration file errors
-        class ConfigurationFileNotFoundError < RuntimeError; end
-        class ConfigurationFileContentError < RuntimeError; end
-
         # Default directory paths: These are the documented default locations that will be checked
         # for the configuration file.
         DEFAULT_PATHS = [
@@ -41,7 +38,7 @@ def self.config(options_in = {})
           # Can't find the configuration file?
           if config_file.nil?
             message = "Unable to find configuration file in #{paths.join(':')}"
-            raise ConfigurationFileNotFoundError, message if options[:test]
+            raise OctocatalogDiff::Errors::ConfigurationFileNotFoundError, message if options[:test]
             logger.debug message
             return {}
           end
@@ -89,18 +86,21 @@ def self.load_config_file(filename, logger)
           begin
             loaded_class = Kernel.const_get(:OctocatalogDiff).const_get(:Config)
           rescue NameError
-            raise ConfigurationFileContentError, 'Configuration must define OctocatalogDiff::Config!'
+            message = 'Configuration must define OctocatalogDiff::Config!'
+            raise OctocatalogDiff::Errors::ConfigurationFileContentError, message
           end
 
           unless loaded_class.respond_to?(:config)
-            raise ConfigurationFileContentError, 'Configuration must define OctocatalogDiff::Config.config!'
+            message = 'Configuration must define OctocatalogDiff::Config.config!'
+            raise OctocatalogDiff::Errors::ConfigurationFileContentError, message
           end
 
           # The configuration file looks like it defines the correct method, so read it.
           # Make sure it's a hash.
           options = loaded_class.config
           unless options.is_a?(Hash)
-            raise ConfigurationFileContentError, "Configuration must be Hash not #{options.class}!"
+            message = "Configuration must be Hash not #{options.class}!"
+            raise OctocatalogDiff::Errors::ConfigurationFileContentError, message
           end
 
           options

lib/octocatalog-diff/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OctocatalogDiff
+  # Contains error classes raised by this gem
+  class Errors
+    # Error class for handled configuration file errors
+    class ConfigurationFileNotFoundError < RuntimeError; end
+    class ConfigurationFileContentError < RuntimeError; end
+  end
+end

spec/octocatalog-diff/tests/api/v1/config_spec.rb

@@ -3,6 +3,7 @@
 require_relative '../../spec_helper'
 
 require OctocatalogDiff::Spec.require_path('/api/v1/config')
+require OctocatalogDiff::Spec.require_path('/errors')
 
 describe OctocatalogDiff::API::V1::Config do
   before(:each) do
@@ -28,7 +29,7 @@
           expect(File).to receive(:'file?').with(filename).and_return(false)
           expect do
             described_class.config(logger: @logger, filename: filename, test: true)
-          end.to raise_error(OctocatalogDiff::API::V1::Config::ConfigurationFileNotFoundError, pattern)
+          end.to raise_error(OctocatalogDiff::Errors::ConfigurationFileNotFoundError, pattern)
         end
       end
 
@@ -159,17 +160,17 @@
         pattern = Regexp.new('must define OctocatalogDiff::Config.config!')
         expect do
           described_class.load_config_file(filename, @logger)
-        end.to raise_error(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError, pattern)
+        end.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, pattern)
       end
 
       it 'should log fatal message' do
         exception = nil
         begin
           described_class.load_config_file(filename, @logger)
-        rescue OctocatalogDiff::API::V1::Config::ConfigurationFileContentError => exc
+        rescue OctocatalogDiff::Errors::ConfigurationFileContentError => exc
           exception = exc
         end
-        expect(exception).to be_a_kind_of(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError)
+        expect(exception).to be_a_kind_of(OctocatalogDiff::Errors::ConfigurationFileContentError)
         expect(exception.message).to eq('Configuration must define OctocatalogDiff::Config.config!')
         expect(@logger_str.string).to match(/Configuration must define OctocatalogDiff::Config.config!/)
       end
@@ -182,17 +183,17 @@
         pattern = Regexp.new('must define OctocatalogDiff::Config!')
         expect do
           described_class.load_config_file(filename, @logger)
-        end.to raise_error(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError, pattern)
+        end.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, pattern)
       end
 
       it 'should log fatal message' do
         exception = nil
         begin
           described_class.load_config_file(filename, @logger)
-        rescue OctocatalogDiff::API::V1::Config::ConfigurationFileContentError => exc
+        rescue OctocatalogDiff::Errors::ConfigurationFileContentError => exc
           exception = exc
         end
-        expect(exception).to be_a_kind_of(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError)
+        expect(exception).to be_a_kind_of(OctocatalogDiff::Errors::ConfigurationFileContentError)
         expect(exception.message).to eq('Configuration must define OctocatalogDiff::Config!')
         expect(@logger_str.string).to match(/Configuration must define OctocatalogDiff::Config!/)
       end
@@ -205,17 +206,17 @@
         pattern = Regexp.new('Configuration must be Hash not Array!')
         expect do
           described_class.load_config_file(filename, @logger)
-        end.to raise_error(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError, pattern)
+        end.to raise_error(OctocatalogDiff::Errors::ConfigurationFileContentError, pattern)
       end
 
       it 'should log fatal message' do
         exception = nil
         begin
           described_class.load_config_file(filename, @logger)
-        rescue OctocatalogDiff::API::V1::Config::ConfigurationFileContentError => exc
+        rescue OctocatalogDiff::Errors::ConfigurationFileContentError => exc
           exception = exc
         end
-        expect(exception).to be_a_kind_of(OctocatalogDiff::API::V1::Config::ConfigurationFileContentError)
+        expect(exception).to be_a_kind_of(OctocatalogDiff::Errors::ConfigurationFileContentError)
         expect(exception.message).to eq('Configuration must be Hash not Array!')
         expect(@logger_str.string).to match(/Configuration must be Hash not Array!/)
       end