arangamani/jenkins_api_client

#
# Copyright (c) 2012-2013 Kannan Manickam <arangamani.kannan@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#

require 'timeout'

module JenkinsApi
  class Client
    # This class is used to communicate with Jenkins and performing some admin
    # level operations such as restarting and reloading Jenkins.
    #
    class System

      # Initializes a new System object.
      #
      # @param client [Client] the client object
      #
      # @return [System] the system object
      #
      def initialize(client)
        @client = client
        @logger = @client.logger
        @timeout = @client.timeout
      end

      # Returns a string representation of System class.
      #
      def to_s
        "#<JenkinsApi::Client::System>"
      end

      # Sends a quiet down request to the server.
      #
      def quiet_down
        @logger.info "Performing a quiet down of jenkins..."
        @client.api_post_request("/quietDown")
      end

      # Cancels the quiet down request sent to the server.
      #
      def cancel_quiet_down
        @logger.info "Cancelling jenkins form quiet down..."
        @client.api_post_request("/cancelQuietDown")
      end

      # Checks if server is in quiet down mode.
      #
      def check_quiet_down?
        @logger.info "Checking if jenkins is in quiet down mode..."
        @client.root.quieting_down?
      end

      # Restarts the Jenkins server
      #
      # @param [Boolean] force whether to force restart or wait till all
      #               jobs are completed.
      #
      def restart(force = false)
        if force
          @logger.info "Performing a force restart of jenkins..."
          @client.api_post_request("/restart")
        else
          @logger.info "Performing a safe restart of jenkins..."
          @client.api_post_request("/safeRestart")
        end
      end

      # Performs a force restart of Jenkins server
      #
      def restart!
        restart(true)
      end

      # Reload the Jenkins server
      #
      def reload
        @logger.info "Reloading jenkins..."
        @client.api_post_request("/reload")
      end

      # List all users known to Jenkins by their Full Name
      #
      def list_users
        warn "DEPRECATION: System#list_users is deprecated. Please use User#list instead"
        @logger.info "Obtaining the list of users from jenkins"
        users = @client.api_get_request("/asynchPeople")
        names = []
        users['users'].each { |user|
          names << user['user']['fullName']
        } unless users.nil?
        return names
      end

      # This method waits till the server becomes ready after a start
      # or restart.
      #
      def wait_for_ready
        Timeout::timeout(@timeout) do
          while true do
            response = @client.get_root
            @logger.info "Waiting for jenkins to restart..."
            if (response.body =~ /Please wait while Jenkins is restarting/ ||
              response.body =~ /Please wait while Jenkins is getting ready to work/)
              sleep 30
              redo
            else
              return true
            end
          end
        end
        false
      end

    end
  end
end