Move fact source and retrieval errors to error class

Author: Kevin Paulisse

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

@@ -2,6 +2,7 @@
 
 require_relative 'pe/v1'
 require_relative '../../util/httparty'
+require_relative '../../errors'
 require_relative '../facts'
 
 module OctocatalogDiff
@@ -87,7 +88,7 @@ def facts(logger)
           begin
             result = facts_obj.facts
             logger.debug "Success retrieving facts for #{@node} from #{self.class}"
-          rescue OctocatalogDiff::Facts::FactRetrievalError, OctocatalogDiff::Facts::FactSourceError => exc
+          rescue OctocatalogDiff::Errors::FactRetrievalError, OctocatalogDiff::Errors::FactSourceError => exc
             @content = nil
             @error_message = "Fact retrieval failed: #{exc.class} - #{exc.message}"
             logger.error @error_message

lib/octocatalog-diff/errors.rb

@@ -10,5 +10,9 @@ class ConfigurationFileContentError < RuntimeError; end
     # Error classes for building catalogs
     class BootstrapError < RuntimeError; end
     class CatalogError < RuntimeError; end
+
+    # Error classes for retrieving facts
+    class FactSourceError < RuntimeError; end
+    class FactRetrievalError < RuntimeError; end
   end
 end

lib/octocatalog-diff/facts.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'errors'
 require_relative 'facts/json'
 require_relative 'facts/yaml'
 require_relative 'facts/puppetdb'
@@ -119,9 +120,5 @@ def override(key, value)
         @facts['values'][key] = value
       end
     end
-
-    # Separate classes to handle errors we throw explicitly
-    class FactSourceError < RuntimeError; end
-    class FactRetrievalError < RuntimeError; end
   end
 end

lib/octocatalog-diff/facts/puppetdb.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../errors'
 require_relative '../facts'
 require_relative '../puppetdb'
 require 'yaml'
@@ -42,21 +43,21 @@ def self.fact_retriever(options = {}, node)
             result.map { |x| facts[x['name']] = x['value'] }
             if facts.empty?
               message = "Unable to retrieve facts for node #{node} from PuppetDB (empty or nil)!"
-              raise OctocatalogDiff::Facts::FactRetrievalError, message
+              raise OctocatalogDiff::Errors::FactRetrievalError, message
             end
 
             # Create a structure compatible with YAML fact files.
             obj_to_return = { 'name' => node, 'values' => {} }
             facts.each { |k, v| obj_to_return['values'][k.sub(/^::/, '')] = v }
             break # Not return, to avoid LocalJumpError in Ruby 2.2
           rescue OctocatalogDiff::PuppetDB::ConnectionError => exc
-            exception_class = OctocatalogDiff::Facts::FactSourceError
+            exception_class = OctocatalogDiff::Errors::FactSourceError
             exception_message = "Fact retrieval failed (#{exc.class}) (#{exc.message})"
           rescue OctocatalogDiff::PuppetDB::NotFoundError => exc
-            exception_class = OctocatalogDiff::Facts::FactRetrievalError
+            exception_class = OctocatalogDiff::Errors::FactRetrievalError
             exception_message = "Node #{node} not found in PuppetDB (#{exc.message})"
           rescue OctocatalogDiff::PuppetDB::PuppetDBError => exc
-            exception_class = OctocatalogDiff::Facts::FactRetrievalError
+            exception_class = OctocatalogDiff::Errors::FactRetrievalError
             exception_message = "Fact retrieval failed for node #{node} from PuppetDB (#{exc.message})"
           end
         end

spec/octocatalog-diff/tests/catalog-util/enc/pe_spec.rb

@@ -200,7 +200,7 @@
         @logger, @logger_str = OctocatalogDiff::Spec.setup_logger
 
         fact_obj = double('OctocatalogDiff::CatalogUtil::Facts')
-        allow(fact_obj).to receive(:facts).and_raise(OctocatalogDiff::Facts::FactRetrievalError, 'Fact Error')
+        allow(fact_obj).to receive(:facts).and_raise(OctocatalogDiff::Errors::FactRetrievalError, 'Fact Error')
         allow(OctocatalogDiff::CatalogUtil::Facts).to receive(:new).and_return(fact_obj)
 
         opts = { node: 'foo', pe_enc_url: 'https://localhost:4433/classifier-api' }
@@ -213,15 +213,15 @@
       end
 
       it 'should set error message' do
-        answer = 'Fact retrieval failed: OctocatalogDiff::Facts::FactRetrievalError - Fact Error'
+        answer = 'Fact retrieval failed: OctocatalogDiff::Errors::FactRetrievalError - Fact Error'
         expect(@testobj.error_message).to eq(answer)
       end
 
       it 'should log messages' do
         log = @logger_str.string
         expect(log).to match(/DEBUG.+Beginning OctocatalogDiff::CatalogUtil::ENC::PE#execute for foo/)
         expect(log).to match(/DEBUG.+Start retrieving facts for foo from OctocatalogDiff::CatalogUtil::ENC::PE/)
-        expect(log).to match(/ERROR.+Fact retrieval failed: OctocatalogDiff::Facts::FactRetrievalError - Fact Error/)
+        expect(log).to match(/ERROR.+Fact retrieval failed: OctocatalogDiff::Errors::FactRetrievalError - Fact Error/)
       end
     end
   end

spec/octocatalog-diff/tests/facts/puppetdb_spec.rb

@@ -2,6 +2,7 @@
 
 require_relative '../spec_helper'
 require_relative '../../mocks/puppetdb'
+require OctocatalogDiff::Spec.require_path('/errors')
 require OctocatalogDiff::Spec.require_path('/facts/puppetdb')
 
 describe OctocatalogDiff::Facts::PuppetDB do
@@ -27,7 +28,7 @@
         node = 'fjoaewjroisajdfoisdjfaojeworjsdofjsdofawejr'
         expect do
           OctocatalogDiff::Facts::PuppetDB.fact_retriever(@opts, node)
-        end.to raise_error(OctocatalogDiff::Facts::FactRetrievalError)
+        end.to raise_error(OctocatalogDiff::Errors::FactRetrievalError)
       end
     end
   end
@@ -85,7 +86,7 @@
         allow(OctocatalogDiff::PuppetDB).to receive(:new) { |*_arg| obj }
         expect do
           OctocatalogDiff::Facts::PuppetDB.fact_retriever(opts, node)
-        end.to raise_error(OctocatalogDiff::Facts::FactSourceError, /Fact retrieval failed \(.*ConnectionError\) \(test/)
+        end.to raise_error(OctocatalogDiff::Errors::FactSourceError, /Fact retrieval failed \(.*ConnectionError\) \(test/)
       end
 
       it 'should handle OctocatalogDiff::PuppetDB::NotFoundError' do
@@ -94,7 +95,7 @@
         allow(OctocatalogDiff::PuppetDB).to receive(:new) { |*_arg| obj }
         expect do
           OctocatalogDiff::Facts::PuppetDB.fact_retriever(opts, node)
-        end.to raise_error(OctocatalogDiff::Facts::FactRetrievalError, /Node valid-facts not found in PuppetDB \(test/)
+        end.to raise_error(OctocatalogDiff::Errors::FactRetrievalError, /Node valid-facts not found in PuppetDB \(test/)
       end
 
       it 'should handle OctocatalogDiff::PuppetDB::PuppetDBError' do
@@ -103,7 +104,7 @@
         allow(OctocatalogDiff::PuppetDB).to receive(:new) { |*_arg| obj }
         expect do
           OctocatalogDiff::Facts::PuppetDB.fact_retriever(opts, node)
-        end.to raise_error(OctocatalogDiff::Facts::FactRetrievalError, /Fact retrieval failed for node valid-facts from PuppetDB/)
+        end.to raise_error(OctocatalogDiff::Errors::FactRetrievalError, /Fact retrieval failed for node valid-facts/)
       end
     end
   end