lhj-tools 0.1.25 → 0.1.26

data/lib/lhj/jenkins/exceptions.rb

@@ -0,0 +1,226 @@
+require 'logger'
+
+module Lhj
+  module JenkinsApi
+    # This module contains classes that define exceptions for various catories.
+    #
+    module Exceptions
+      # This is the base class for Exceptions that is inherited from
+      # RuntimeError.
+      #
+      class ApiException < RuntimeError
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          logger.add(log_level) { "#{self.class}: #{message}" }
+          super(message)
+        end
+      end
+
+      # This exception class handles cases where parameters are expected
+      # but not provided.
+      #
+      class NothingSubmitted < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "Nothing is submitted." if message.empty?
+          super(logger, message)
+        end
+      end
+
+      # This exception class handles cases where a job not able to be created
+      # because it already exists.
+      #
+      class JobAlreadyExists < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          super(logger, message)
+        end
+      end
+      # Support for backward compatibility
+      JobAlreadyExistsWithName = JobAlreadyExists
+
+      # This exception class handles cases where a view not able to be created
+      # because it already exists
+      #
+      class ViewAlreadyExists < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          super(logger, message)
+        end
+      end
+
+      # This exception class handles cases where a node not able to be created
+      # because it already exists
+      #
+      class NodeAlreadyExists < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          super(logger, message)
+        end
+      end
+
+      # This exception class handles cases where invalid credentials are provided
+      # to connect to the Jenkins.
+      #
+      class Unauthorized < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "Invalid credentials are provided." if message.empty?
+          super(logger, message, Logger::FATAL)
+        end
+      end
+      # Support for backward compatibility
+      UnauthorizedException = Unauthorized
+
+      # This exception class handles cases where invalid credentials are provided
+      # to connect to the Jenkins.
+      # While it is apparently used to indicate expiry of a Crumb, this is not
+      # the only cause of a forbidden error... maybe the user just isn't allowed
+      # to access the given url.  We should treat forbidden as a specific "you
+      # are not welcome here"
+      #
+      class Forbidden < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          msg = "Access denied. Please ensure that Jenkins is set up to allow" +
+            " access to this operation. #{message}"
+          super(logger, msg)
+        end
+      end
+      # Support for backward compatibility
+      ForbiddenException = Forbidden
+
+      # This exception should be thrown specifically when the caller has had
+      # a ForbiddenException and has been able to determine that a (valid)
+      # crumb was used, and the attempt still failed.
+      # This may require an interim attempt to re-acquire the crumb in order
+      # to confirm it has not expired.
+      #
+      # @example A condition where this exception would be raised
+      #   def operation
+      #     retried = false
+      #     begin
+      #       make_attempt
+      #     rescue Forbidden => e
+      #       refresh_crumbs(true)
+      #       if @crumbs_enabled
+      #         if !retried
+      #           retried = true
+      #           retry
+      #         else
+      #           raise ForbiddenWithCrumb.new(@logger, e.message)
+      #         end
+      #       else
+      #         raise
+      #       end
+      #     end
+      #   end
+      #
+      # @note the 'refresh_crumbs' method will update crumb enablement and the
+      #   stored crumb if called with 'true'
+      #
+      class ForbiddenWithCrumb < Forbidden
+        def initialize(logger, message = '', log_level = Logger::ERROR)
+          msg = "A crumb was used in attempt to access operation. #{message}"
+          super(logger, msg)
+        end
+      end
+
+      # This exception class handles cases where a requested page is not found on
+      # the Jenkins API.
+      #
+      class NotFound < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          msg = message.empty? ? "Requested component is not found on the" +
+            " Jenkins CI server." : message
+          super(logger, msg)
+        end
+      end
+      # Support for backward compatibility
+      NotFoundException = NotFound
+
+      # This exception class handles cases when Crumb Issues did not issue a
+      # crumb upon request.
+      #
+      class CrumbNotFound < NotFound
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "No crumb available on the server." if message.empty?
+          super(logger, message)
+        end
+      end
+      # Support for backward compatibility
+      CrumbNotFoundException = CrumbNotFound
+
+      # This exception class handles cases where the requested job does not exist
+      # in Jenkins.
+      #
+      class JobNotFound < NotFound
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          msg = message.empty? ? "The specified job is not found" : message
+          super(logger, msg)
+        end
+      end
+
+      # This exception class handles cases where the requested view does not exist
+      # in Jenkins.
+      #
+      class ViewNotFound < NotFound
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          msg = message.empty? ? "The specified view is not found" : message
+          super(logger, msg)
+        end
+      end
+
+      # This exception class handles cases where the requested node does not exist
+      # in Jenkins.
+      #
+      class NodeNotFound < NotFound
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          msg = msg.empty? ? "The specified node is not found" : message
+          super(logger, msg)
+        end
+      end
+
+      # This exception class handles cases where the Jenkins API returns with a
+      # 500 Internal Server Error.
+      #
+      class InternalServerError < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "Internal Server Error. Perhaps the in-memory configuration" +
+            " Jenkins is different from the disk configuration. Please try to" +
+            " reload the configuration" if message.nil? || message.empty?
+          super(logger, message)
+        end
+      end
+      # Support for backward compatibility
+      InternalServerErrorException = InternalServerError
+
+      # This exception class handles cases where the Jenkins is getting restarted
+      # or reloaded where the response code returned is 503
+      #
+      class ServiceUnavailable < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "Jenkins is being reloaded or restarted. Please wait till" +
+            " Jenkins is completely back online. This can be" +
+            " programatically achieved by System#wait_for_ready" if message.empty?
+          super(logger, message)
+        end
+      end
+      # Support for backward compatibility
+      ServiceUnavailableException = ServiceUnavailable
+
+      # Exception occurred while running java CLI commands
+      #
+      class CLIError < ApiException
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "Unable to execute the command." if message.empty?
+          super(logger, message)
+        end
+      end
+      # Support for backward compatibility
+      CLIException = CLIError
+
+      # Exception when a particular plugin is not found
+      #
+      class PluginNotFound < NotFound
+        def initialize(logger, message = "", log_level = Logger::ERROR)
+          message = "The specified plugin is not found" if message.empty?
+          super(logger, message)
+        end
+      end
+    end
+  end
+end