Move remaining errors

Author: Kevin Paulisse

lib/octocatalog-diff/catalog-diff/differ.rb

@@ -7,6 +7,7 @@
 require 'stringio'
 
 require_relative '../catalog'
+require_relative '../errors'
 require_relative 'filter'
 
 module OctocatalogDiff
@@ -55,10 +56,6 @@ module CatalogDiff
     # The heavy lifting is still handled by 'hashdiff' but we're pre-simplifying the input and post-processing
     # the output to make it easier to deal with later.
     class Differ
-      # This class is to distinguish handled errors from unhandled ones, for spec testing.
-      class DifferError < RuntimeError
-      end
-
       # Constructor
       # @param catalog1_in [OctocatalogDiff::Catalog] First catalog to compare
       # @param catalog2_in [OctocatalogDiff::Catalog] Second catalog to compare
@@ -594,7 +591,7 @@ def dig_out_key(hash_in, key_array)
       # @return [Hash] Internal simplified hash object
       def catalog_resources(catalog_in, name = 'Passed catalog')
         return catalog_in.resources if catalog_in.is_a?(OctocatalogDiff::Catalog)
-        raise DifferError, "#{name} is not a valid catalog (input datatype: #{catalog_in.class})"
+        raise OctocatalogDiff::Errors::DifferError, "#{name} is not a valid catalog (input datatype: #{catalog_in.class})"
       end
 
       # Turn array of resources into a hash by serialized keys. For consistency with 'hashdiff'

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

@@ -11,9 +11,6 @@ class ENC
       # Support the Puppet Enterprise classification API.
       # Documentation: https://docs.puppet.com/pe/latest/nc_index.html
       class PE
-        # Error class that can be caught
-        class ClassificationError < RuntimeError; end
-
         # Allow the main ENC object to retrieve these values
         attr_reader :content, :error_message
 
@@ -70,7 +67,7 @@ def execute(logger)
           begin
             @content = @api.result(response[:parsed], logger)
             @error_message = nil
-          rescue OctocatalogDiff::CatalogUtil::ENC::PE::ClassificationError => exc
+          rescue OctocatalogDiff::Errors::PEClassificationError => exc
             @error_message = exc.message
             logger.error "PE ENC failed: #{exc.message}"
             return

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

@@ -4,6 +4,8 @@
 require 'uri'
 require 'yaml'
 
+require_relative '../../../errors'
+
 module OctocatalogDiff
   module CatalogUtil
     class ENC
@@ -50,7 +52,7 @@ def result(parsed, logger)
             %w(classes parameters).each do |required_key|
               next if parsed[required_key]
               logger.debug parsed.keys.inspect
-              raise OctocatalogDiff::CatalogUtil::ENC::PE::ClassificationError, "Response missing: #{required_key}"
+              raise OctocatalogDiff::Errors::PEClassificationError, "Response missing: #{required_key}"
             end
 
             obj = { 'classes' => parsed['classes'], 'parameters' => parsed['parameters'] }

lib/octocatalog-diff/catalog-util/git.rb

@@ -6,15 +6,13 @@
 require 'shellwords'
 require 'tempfile'
 
+require_relative '../errors'
+
 module OctocatalogDiff
   module CatalogUtil
     # Class to perform a git checkout (via 'git archive') of a branch from the base git
     # directory into another targeted directory.
     class Git
-      # Trapped errors
-      class GitCheckoutError < RuntimeError
-      end
-
       # Check out a branch via 'git archive' from one directory into another.
       # @param options [Hash] Options hash:
       #          - :branch => Branch name to check out
@@ -28,8 +26,12 @@ def self.check_out_git_archive(options = {})
         logger = options.fetch(:logger)
 
         # Validate parameters
-        raise GitCheckoutError, "Source directory #{dir.inspect} does not exist" if dir.nil? || !File.directory?(dir)
-        raise GitCheckoutError, "Target directory #{path.inspect} does not exist" if dir.nil? || !File.directory?(path)
+        if dir.nil? || !File.directory?(dir)
+          raise OctocatalogDiff::Errors::GitCheckoutError, "Source directory #{dir.inspect} does not exist"
+        end
+        if dir.nil? || !File.directory?(path)
+          raise OctocatalogDiff::Errors::GitCheckoutError, "Target directory #{path.inspect} does not exist"
+        end
 
         # To get the options working correctly (-o pipefail in particular) this needs to run under
         # bash. It's just creating a script, rather than figuring out all the shell escapes...
@@ -44,7 +46,9 @@ def self.check_out_git_archive(options = {})
 
           logger.debug("Begin git archive #{dir}:#{branch} -> #{path}")
           output, status = Open3.capture2e(tmp_script.path, chdir: dir)
-          raise GitCheckoutError, "Git archive #{branch}->#{path} failed: #{output}" unless status.exitstatus.zero?
+          unless status.exitstatus.zero?
+            raise OctocatalogDiff::Errors::GitCheckoutError, "Git archive #{branch}->#{path} failed: #{output}"
+          end
           logger.debug("Success git archive #{dir}:#{branch}")
         ensure
           FileUtils.rm_f tmp_script.path if File.exist?(tmp_script.path)
@@ -58,7 +62,9 @@ def self.check_out_git_archive(options = {})
       def self.branch_sha(options = {})
         branch = options.fetch(:branch)
         dir = options.fetch(:basedir)
-        raise GitCheckoutError, "Git directory #{dir.inspect} does not exist" if dir.nil? || !File.directory?(dir)
+        if dir.nil? || !File.directory?(dir)
+          raise OctocatalogDiff::Errors::GitCheckoutError, "Git directory #{dir.inspect} does not exist"
+        end
         repo = Rugged::Repository.new(dir)
         repo.branches[branch].target_id
       end

lib/octocatalog-diff/cli/printer.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../catalog-diff/display'
+require_relative '../errors'
 
 module OctocatalogDiff
   class Cli
     # Wrapper around OctocatalogDiff::CatalogDiff::Display to set the options and
     # output to a file or the screen depending on selection.
     class Printer
-      # Class for thrown exceptions
-      class PrinterError < RuntimeError
-      end
-
       # Constructor
       # @param options [Hash] Options from cli/options
       # @param logger [Logger] Logger object
@@ -45,7 +42,7 @@ def output_to_file(diff_in)
         @logger.info "Wrote diff to #{@options[:output_file]}"
       rescue Errno::ENOENT, Errno::EACCES, Errno::EISDIR => exc
         @logger.error "Cannot write to #{@options[:output_file]}: #{exc}"
-        raise PrinterError, "Cannot write to #{@options[:output_file]}: #{exc}"
+        raise OctocatalogDiff::Errors::PrinterError, "Cannot write to #{@options[:output_file]}: #{exc}"
       end
     end
   end

lib/octocatalog-diff/errors.rb

@@ -12,6 +12,7 @@ class BootstrapError < RuntimeError; end
     class CatalogError < RuntimeError; end
     class PuppetVersionError < RuntimeError; end
     class ReferenceValidationError < RuntimeError; end
+    class GitCheckoutError < RuntimeError; end
 
     # Error classes for retrieving facts
     class FactSourceError < RuntimeError; end
@@ -21,5 +22,12 @@ class FactRetrievalError < RuntimeError; end
     class PuppetDBNodeNotFoundError < RuntimeError; end
     class PuppetDBGenericError < RuntimeError; end
     class PuppetDBConnectionError < RuntimeError; end
+
+    # Errors for Puppet Enterprise
+    class PEClassificationError < RuntimeError; end
+
+    # Miscellanous catalog-diff errors
+    class DifferError < RuntimeError; end
+    class PrinterError < RuntimeError; end
   end
 end

spec/octocatalog-diff/tests/catalog-diff/differ_spec.rb

@@ -3,6 +3,7 @@
 require_relative '../spec_helper'
 require OctocatalogDiff::Spec.require_path('/catalog')
 require OctocatalogDiff::Spec.require_path('/catalog-diff/differ')
+require OctocatalogDiff::Spec.require_path('/errors')
 require 'json'
 
 # Read this about the fixtures:
@@ -61,7 +62,7 @@
         it 'should raise exception when something other than a catalog is passed in' do
           expect do
             OctocatalogDiff::CatalogDiff::Differ.new(@options, 'This is not a catalog!', @empty_puppet_catalog)
-          end.to raise_error(OctocatalogDiff::CatalogDiff::Differ::DifferError)
+          end.to raise_error(OctocatalogDiff::Errors::DifferError)
         end
       end
 

spec/octocatalog-diff/tests/cli/printer_spec.rb

@@ -3,6 +3,7 @@
 require_relative '../spec_helper'
 
 require OctocatalogDiff::Spec.require_path('/cli/printer')
+require OctocatalogDiff::Spec.require_path('/errors')
 
 require 'json'
 require 'tempfile'
@@ -63,7 +64,7 @@
       testobj = OctocatalogDiff::Cli::Printer.new(opts, logger)
       expect do
         _result = testobj.printer(@diff)
-      end.to raise_error(OctocatalogDiff::Cli::Printer::PrinterError)
+      end.to raise_error(OctocatalogDiff::Errors::PrinterError)
 
       # Make sure log messages are correct
       expect(logger_str.string).to match(/DEBUG -- : Generating non-colored text output/)