jenkins_api_client 0.2.1 → 0.3.0

data/lib/jenkins_api_client/cli/node.rb

@@ -0,0 +1,83 @@
+#
+# Copyright (c) 2012 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 'thor'
+require 'thor/group'
+require 'terminal-table'
+
+module JenkinsApi
+  module CLI
+    class Node < Thor
+      include Thor::Actions
+
+      desc "list", "List all nodes"
+      method_option :filter, :aliases => "-f", :desc => "Regular expression to filter jobs"
+      def list
+        @client = Helper.setup(parent_options)
+        if options[:filter]
+          puts @client.node.list(options[:filter])
+        else
+          puts @client.node.list
+        end
+      end
+
+      desc "print_general_attributes", "Prints general attributes of nodes"
+      def print_general_attributes
+        @client = Helper.setup(parent_options)
+        general_attributes = Client::Node::GENERAL_ATTRIBUTES
+        rows = []
+        general_attributes.each do |attr|
+          rows << [attr, @client.node.method("get_#{attr}").call]
+        end
+        table = Terminal::Table.new :headings => ['Attribute', 'Value'], :rows => rows
+        puts table
+      end
+
+      desc "print_node_attributes NODE", "Prints attributes specific to a node"
+      def print_node_attributes(node)
+        @client = Helper.setup(parent_options)
+        node_attributes = Client::Node::NODE_ATTRIBUTES
+        rows = []
+        node_attributes.each do |attr|
+          rows << [attr, @client.node.method("get_node_#{attr}").call(node)]
+        end
+        table = Terminal::Table.new :headings => ['Attribute', 'Value'], :rows => rows
+        puts "Node: #{node}"
+        puts table
+      end
+
+      desc "print_node_properties NODE", "Prints properties of a node"
+      def print_node_properties(node)
+        @client = Helper.setup(parent_options)
+        node_properties = Client::Node::NODE_PROPERTIES
+        rows = []
+        node_properties.each do |property|
+          rows << [property, @client.node.method("is_#{property}?").call(node)]
+        end
+        table = Terminal::Table.new :headings => ['Property', 'Value'], :rows => rows
+        puts "Node: #{node}"
+        puts table
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/cli/system.rb

@@ -0,0 +1,53 @@
+#
+# Copyright (c) 2012 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 'thor'
+require 'thor/group'
+
+module JenkinsApi
+  module CLI
+    class System < Thor
+      include Thor::Actions
+
+      desc "quietdown", "Puts the Jenkins server in Quiet down mode"
+      def quietdown
+        @client = Helper.setup(parent_options)
+        @client.system.quiet_down
+      end
+
+      desc "cancel_quietdown", "Cancels the Quiet down mode of Jenkins server"
+      def cancel_quietdown
+        @client = Helper.setup(parent_options)
+        @client.system.cancel_quiet_down
+      end
+
+      desc "restart", "Restarts the Jenkins server"
+      method_option :force, :type => :boolean, :aliases => "-s", :desc => "Force restart"
+      def restart
+        @client = Helper.setup(parent_options)
+        force = options[:force] ? true : false
+        @client.system.restart(force)
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/client.rb

@@ -31,6 +31,8 @@ require 'base64'
 require File.expand_path('../version', __FILE__)
 require File.expand_path('../exceptions', __FILE__)
 require File.expand_path('../job', __FILE__)
+require File.expand_path('../system', __FILE__)
+require File.expand_path('../node', __FILE__)
 
 module JenkinsApi
   class Client
@@ -61,18 +63,45 @@ module JenkinsApi
      @password = Base64.decode64(@password_base64).chomp if @password_base64
     end
 
-    # Creates an instance to the Job object by passing a reference to self
+    # This method toggles the debug parameter in run time
+    #
+    def toggle_debug
+      @debug = @debug == false ? true : false
+    end
+
+    # Creates an instance to the Job class by passing a reference to self
     #
     def job
       JenkinsApi::Client::Job.new(self)
     end
 
+    # Creates an instance to the System class by passing a reference to self
+    #
+    def system
+      JenkinsApi::Client::System.new(self)
+    end
+
+    # Creates an instance to the Node class by passing a reference to self
+    #
+    def node
+      JenkinsApi::Client::Node.new(self)
+    end
+
     # Returns a string representing the class name
     #
     def to_s
       "#<JenkinsApi::Client>"
     end
 
+    # Obtains the root of Jenkins server. This function is used to see if
+    # Jenkins is running
+    def get_root
+      http = Net::HTTP.start(@server_ip, @server_port)
+      request = Net::HTTP::Get.new("/")
+      request.basic_auth @username, @password
+      http.request(request)
+    end
+
     # Sends a GET request to the Jenkins CI server with the specified URL
     #
     # @param [String] url_prefix
@@ -80,6 +109,8 @@ module JenkinsApi
     def api_get_request(url_prefix, tree = nil)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Get.new("#{url_prefix}/api/json")
+      puts "[DEBUG] debug value is: #{@debug}"
+      puts "[INFO] GET #{url_prefix}/api/json" if @debug
       request = Net::HTTP::Get.new("#{url_prefix}/api/json?#{tree}") if tree
       request.basic_auth @username, @password
       response = http.request(request)
@@ -104,6 +135,7 @@ module JenkinsApi
     def api_post_request(url_prefix)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Post.new("#{url_prefix}")
+      puts "[INFO] PUT #{url_prefix}" if @debug
       request.basic_auth @username, @password
       response = http.request(request)
       case response.code.to_i
@@ -125,6 +157,7 @@ module JenkinsApi
     def get_config(url_prefix)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Get.new("#{url_prefix}/config.xml")
+      puts "[INFO] GET #{url_prefix}/config.xml" if @debug
       request.basic_auth @username, @password
       response = http.request(request)
       response.body
@@ -138,6 +171,7 @@ module JenkinsApi
     def post_config(url_prefix, xml)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Post.new("#{url_prefix}")
+      puts "[INFO] PUT #{url_prefix}" if @debug
       request.basic_auth @username, @password
       request.body = xml
       request.content_type = 'application/xml'

data/lib/jenkins_api_client/job.rb

@@ -124,15 +124,12 @@ module JenkinsApi
         response_json["builds"]
       end
 
-      # Obtain the current build status of the job
-      # By defaule Jenkins returns the color of the job status icon
-      # This function translates the color into a meaningful status
+      # This method maps the color to status of a job
       #
-      # @param [String] job_name
+      # @param [String] color color given by the API for a job
       #
-      def get_current_build_status(job_name)
-        response_json = @client.api_get_request("/job/#{job_name}")
-        case response_json["color"]
+      def color_to_status(color)
+        case color
         when "blue"
           "success"
         when "red"
@@ -145,16 +142,29 @@ module JenkinsApi
           "not run"
         when "aborted"
           "aborted"
+        else
+          "invalid"
         end
       end
 
+      # Obtain the current build status of the job
+      # By defaule Jenkins returns the color of the job status icon
+      # This function translates the color into a meaningful status
+      #
+      # @param [String] job_name
+      #
+      def get_current_build_status(job_name)
+        response_json = @client.api_get_request("/job/#{job_name}")
+        color_to_status(response_json["color"])
+      end
+
       # This functions lists all jobs that are currently running on the Jenkins CI server
       #
       def list_running
         xml_response = @client.api_get_request("", "tree=jobs[name,color]")
         running_jobs = []
         xml_response["jobs"].each { |job|
-          running_jobs << job["name"] if job["color"] =~ /anime/
+          running_jobs << job["name"] if color_to_status(job["color"]) == "running"
         }
         running_jobs
       end
@@ -292,6 +302,17 @@ module JenkinsApi
         post_config(job_name, xml_modified)
       end
 
+      # Unchain any existing chain between given job names
+      #
+      # @param [Array] job_names Array of job names to be unchained
+      #
+      def unchain(job_names)
+        job_names.each { |job|
+          puts "[INFO] Removing downstream projects for <#{job}>" if @client.debug
+          @client.job.remove_downstream_projects(job)
+        }
+      end
+
       # Chain the jobs given based on specified criteria
       #
       # @param [Array] job_names Array of job names to be chained
@@ -301,24 +322,19 @@ module JenkinsApi
       #
       def chain(job_names, threshold, criteria, parallel = 1)
         raise "Parallel jobs should be at least 1" if parallel < 1
-
-        job_names.each { |job|
-          puts "INFO: Removing downstream projects for <#{job}>" if @client.debug
-          @client.job.remove_downstream_projects(job)
-        }
-
+        unchain(job_names)
         filtered_job_names = []
         if criteria.include?("all") || criteria.empty?
           filtered_job_names = job_names
         else
-          puts "INFO: Criteria is specified. Filtering jobs..." if @client.debug
+          puts "[INFO] Criteria is specified. Filtering jobs..." if @client.debug
           job_names.each { |job|
             filtered_job_names << job if criteria.include?(@client.job.get_current_build_status(job))
           }
         end
         filtered_job_names.each_with_index { |job_name, index|
           break if index >= (filtered_job_names.length - parallel)
-          puts "INFO: Adding <#{filtered_job_names[index+1]}> as a downstream project to <#{job_name}> with <#{threshold}> as the threshold" if @client.debug
+          puts "[INFO] Adding <#{filtered_job_names[index+1]}> as a downstream project to <#{job_name}> with <#{threshold}> as the threshold" if @client.debug
           @client.job.add_downstream_projects(job_name, filtered_job_names[index + parallel], threshold, true)
         }
         parallel = filtered_job_names.length if parallel > filtered_job_names.length

data/lib/jenkins_api_client/node.rb

@@ -0,0 +1,149 @@
+#
+# Copyright (c) 2012 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.
+#
+
+module JenkinsApi
+  class Client
+    class Node
+
+      # General attributes of a node.
+      # This allows the following methods to be called on this node object.
+      # These methods are defined using define_method and are prefixed
+      # with get_.
+      #
+      # def get_busyExecutors
+      # def get_displayName
+      # def get_totalExecutors
+      #
+      GENERAL_ATTRIBUTES = [
+        "busyExecutors",
+        "displayName",
+        "totalExecutors"
+      ]
+
+      # Properties of a node.
+      # The following methods are defined to be called on the node object
+      # and are prefixed with is_ and end with ? as they return true or false.
+      #
+      # def is_idle?(node_name)
+      # def is_jnlpAgent?(node_name)
+      # def is_launchSupported?(node_name)
+      # def is_manualLaunchAllowed?(node_name)
+      # def is_offline?(node_name)
+      # def is_temporarilyOffline?(node_name)
+      #
+      NODE_PROPERTIES = [
+        "idle",
+        "jnlpAgent",
+        "launchSupported",
+        "manualLaunchAllowed",
+        "offline",
+        "temporarilyOffline"
+      ]
+
+      # Node specific attributes.
+      # The following methods are defined using define_method.
+      # These methods are prefixed with get_node_.
+      #
+      # def get_node_numExecutors(node_name)
+      # def get_node_icon(node_name)
+      # def get_node_displayName(node_name)
+      # def get_node_loadStatistics(node_name)
+      # def get_node_monitorData(node_name)
+      # def get_node_offlineCause(node_name)
+      # def get_node_oneOffExecutors(node_name)
+      #
+      NODE_ATTRIBUTES = [
+        "numExecutors",
+        "icon",
+        "displayName",
+        "loadStatistics",
+        "monitorData",
+        "offlineCause",
+        "oneOffExecutors"
+      ]
+
+      # Initializes a new node object
+      #
+      # @param [Object] client reference to Client
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      def to_s
+        "#<JenkinsApi::Client::Node>"
+      end
+
+      # This method lists all nodes
+      #
+      # @param [String] filter a regex to filter node names
+      # @param [Bool] ignorecase whether to be case sensitive or not
+      #
+      def list(filter = nil, ignorecase = true)
+        node_names = []
+        response_json = @client.api_get_request("/computer")
+        response_json["computer"].each { |computer|
+          node_names << computer["displayName"] if computer["displayName"] =~ /#{filter}/i
+        }
+        node_names
+      end
+
+      # Identifies the index of a node name in the array node nodes
+      #
+      # @param [String] node_name name of the node
+      #
+      def index(node_name)
+        response_json = @client.api_get_request("/computer")
+        response_json["computer"].each_with_index { |computer, index|
+          return index if computer["displayName"] == node_name
+        }
+      end
+
+      # Defines methods for general node attributes.
+      #
+      GENERAL_ATTRIBUTES.each do |meth_suffix|
+        define_method("get_#{meth_suffix}") do
+          response_json = @client.api_get_request("/computer")
+          response_json["#{meth_suffix}"]
+        end
+      end
+
+      # Defines methods for node properties.
+      #
+      NODE_PROPERTIES.each do |meth_suffix|
+        define_method("is_#{meth_suffix}?") do |node_name|
+          response_json = @client.api_get_request("/computer")
+          response_json["computer"][index(node_name)]["#{meth_suffix}"] =~ /False/i ? false : true
+        end
+      end
+
+      # Defines methods for node specific attributes.
+      NODE_ATTRIBUTES.each do |meth_suffix|
+        define_method("get_node_#{meth_suffix}") do |node_name|
+          response_json = @client.api_get_request("/computer")
+          response_json["computer"][index(node_name)]["#{meth_suffix}"]
+        end
+      end
+
+    end
+  end
+end