jenkins_api_client 0.6.2 → 0.7.0

data/lib/jenkins_api_client/node.rb

@@ -37,7 +37,7 @@ module JenkinsApi
         "busyExecutors",
         "displayName",
         "totalExecutors"
-      ]
+      ].freeze
 
       # Properties of a node.
       # The following methods are defined to be called on the node object
@@ -57,7 +57,7 @@ module JenkinsApi
         "manualLaunchAllowed",
         "offline",
         "temporarilyOffline"
-      ]
+      ].freeze
 
       # Node specific attributes.
       # The following methods are defined using define_method.
@@ -79,7 +79,7 @@ module JenkinsApi
         "monitorData",
         "offlineCause",
         "oneOffExecutors"
-      ]
+      ].freeze
 
       # Initializes a new node object
       #
@@ -89,10 +89,91 @@ module JenkinsApi
         @client = client
       end
 
+      # Gives the string representation of the Object
+      #
       def to_s
         "#<JenkinsApi::Client::Node>"
       end
 
+      # Creates a new node with the specified parameters
+      #
+      # @param [Hash] params parameters for creating a dump slave
+      #  * +:name+ name of the slave
+      #  * +:description+ description of the new slave
+      #  * +:executors+ number of executors
+      #  * +:remote_fs+ Remote FS root
+      #  * +:labels+ comma separated list of labels
+      #  * +:mode+ mode of the slave: normal, exclusive
+      #  * +:slave_host+ Hostname/IP of the slave
+      #  * +:slave_port+ Slave port
+      #  * +:private_key_file+ Private key file of master
+      #
+      def create_dump_slave(params)
+
+        if list.include?(params[:name])
+          raise "The specified slave '#{params[:name]}' already exists."
+        end
+
+        unless params[:name] && params[:slave_host] && params[:private_key_file]
+          raise "Name, slave host, and private key file are required for" +
+            " creating a slave."
+        end
+
+        default_params = {
+          :description => "Automatically created through jenkins_api_client",
+          :executors => 2,
+          :remote_fs => "/var/jenkins",
+          :labels => params[:name],
+          :slave_port => 22,
+          :mode => "normal"
+        }
+
+        params = default_params.merge(params)
+        labels = params[:labels].split(/\s*,\s*/).join(" ")
+        mode = params[:mode].upcase
+
+        post_params = {
+          "name" => params[:name],
+          "type" => "hudson.slaves.DumbSlave$DescriptorImpl",
+          "json" => {
+            "name" => params[:name],
+            "nodeDescription" => params[:description],
+            "numExecutors" => params[:executors],
+            "remoteFS" => params[:remote_fs],
+            "labelString" => labels,
+            "mode" => mode,
+            "type" => "hudson.slaves.DumbSlave$DescriptorImpl",
+            "retentionStrategy" => {
+              "stapler-class" => "hudson.slaves.RetentionStrategy$Always"
+            },
+            "nodeProperties" => {
+              "stapler-class-bag" => "true"
+            },
+            "launcher" => {
+              "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
+              "host" => params[:slave_host],
+              "port" => params[:slave_port],
+              "username" => params[:slave_user],
+              "privatekey" => params[:private_key_file],
+            }
+          }.to_json
+        }
+
+        @client.api_post_request("/computer/doCreateItem", post_params)
+      end
+
+      # Deletes the specified node
+      #
+      # @params [String] node_name Name of the node to delete
+      #
+      def delete(node_name)
+        if list.include?(node_name)
+          @client.api_post_request("/computer/#{node_name}/doDelete")
+        else
+          raise "The specified node '#{node_name}' doesn't exist in Jenkins."
+        end
+      end
+
       # This method lists all nodes
       #
       # @param [String] filter a regex to filter node names
@@ -101,9 +182,11 @@ module JenkinsApi
       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
-        }
+        response_json["computer"].each do |computer|
+            if computer["displayName"] =~ /#{filter}/i
+              node_names << computer["displayName"]
+            end
+        end
         node_names
       end
 
@@ -113,9 +196,9 @@ module JenkinsApi
       #
       def index(node_name)
         response_json = @client.api_get_request("/computer")
-        response_json["computer"].each_with_index { |computer, index|
+        response_json["computer"].each_with_index do |computer, index|
           return index if computer["displayName"] == node_name
-        }
+        end
       end
 
       # Defines methods for general node attributes.
@@ -132,7 +215,8 @@ module JenkinsApi
       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
+          resp = response_json["computer"][index(node_name)]["#{meth_suffix}"]
+          resp =~ /False/i ? false : true
         end
       end
 
@@ -144,6 +228,40 @@ module JenkinsApi
         end
       end
 
+      # Changes the mode of a slave node in Jenkins
+      #
+      # @param [String] node_name name of the node to change mode for
+      # @param [String] mode mode to change to
+      #
+      def change_mode(node_name, mode)
+        mode = mode.upcase
+        xml = get_config(node_name)
+        n_xml = Nokogiri::XML(xml)
+        desc = n_xml.xpath("//mode").first
+        desc.content = "#{mode.upcase}"
+        xml_modified = n_xml.to_xml
+        post_config(node_name, xml_modified)
+      end
+
+      # Obtains the configuration of node from Jenkins server
+      #
+      # @param [String] node_name name of the node
+      #
+      def get_config(node_name)
+        node_name = "(master)" if node_name == "master"
+        @client.get_config("/computer/#{node_name}/config.xml")
+      end
+
+      # Posts the given config.xml to the Jenkins node
+      #
+      # @param [String] node_name name of the node
+      # @param [String] xml Config.xml of the node
+      #
+      def post_config(node_name, xml)
+        node_name = "(master)" if node_name == "master"
+        @client.post_config("/computer/#{node_name}/config.xml", xml)
+      end
+
     end
   end
-end 
+end

data/lib/jenkins_api_client/system.rb

@@ -54,7 +54,8 @@ module JenkinsApi
 
       # Restarts the Jenkins server
       #
-      # @param [Bool] force whether to force restart or wait till all jobs are completed.
+      # @param [Bool] force whether to force restart or wait till all
+      #               jobs are completed.
       #
       def restart(force = false)
         if force
@@ -64,7 +65,8 @@ module JenkinsApi
         end
       end
 
-      # This method waits till the server becomes ready after a start or restart.
+      # This method waits till the server becomes ready after a start
+      # or restart.
       #
       def wait_for_ready
         Timeout::timeout(120) do

data/lib/jenkins_api_client/version.rb

@@ -23,8 +23,8 @@
 module JenkinsApi
   class Client
     MAJOR   = 0
-    MINOR   = 6
-    TINY    = 2
+    MINOR   = 7
+    TINY    = 0
     PRE     = nil
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/lib/jenkins_api_client/view.rb

@@ -43,7 +43,10 @@ module JenkinsApi
       # @param [String] view_name
       #
       def create(view_name)
-        @client.api_post_request("/createView?name=#{view_name}&mode=hudson.model.ListView&json={\"name\":\"#{view_name}\",\"mode\":\"hudson.model.ListView\"}")
+        post_msg = "/createView?name=#{view_name}&"
+        post_msg << "mode=hudson.model.ListView&json={\"name\":\"#{view_name}}"
+        post_msg << "\",\"mode\":\"hudson.model.ListView\"}"
+        @client.api_post_request(post_msg)
       end
 
       # Delete a view
@@ -63,7 +66,11 @@ module JenkinsApi
         view_names = []
         response_json = @client.api_get_request("/")
         response_json["views"].each { |view|
-          view_names << view["name"] if view["name"] =~ /#{filter}/i
+          if ignorecase
+            view_names << view["name"] if view["name"] =~ /#{filter}/i
+          else
+            view_names << view["name"] if view["name"] =~ /#{filter}/
+          end
         }
         view_names
       end
@@ -80,8 +87,12 @@ module JenkinsApi
       #
       # @param [String] view_name
       #
+      # @return [Array] job_names list of jobs in the specified view
+      #
       def list_jobs(view_name)
         job_names = []
+        raise "The view #{view_name} doesn't exists on the server"\
+          unless exists?(view_name)
         response_json = @client.api_get_request("/view/#{view_name}")
         response_json["jobs"].each do |job|
           job_names << job["name"]
@@ -95,7 +106,8 @@ module JenkinsApi
       # @param [String] job_name
       #
       def add_job(view_name, job_name)
-        @client.api_post_request("/view/#{view_name}/addJobToView?name=#{job_name}")
+        post_msg = "/view/#{view_name}/addJobToView?name=#{job_name}"
+        @client.api_post_request(post_msg)
       end
 
       # Remove a job from view
@@ -104,7 +116,8 @@ module JenkinsApi
       # @param [String] job_name
       #
       def remove_job(view_name, job_name)
-        @client.api_post_request("/view/#{view_name}/removeJobFromView?name=#{job_name}")
+        post_msg = "/view/#{view_name}/removeJobFromView?name=#{job_name}"
+        @client.api_post_request(post_msg)
       end
 
       # Obtain the configuration stored in config.xml of a specific view

data/scripts/login_with_irb.rb

@@ -1,8 +1,9 @@
 # This script provides an easier way to login to Jenkins server API.
-# It logs you in with the credentials and server details you proided and then starts an IRB
-# session so you can interactively play with the API.
+# It logs you in with the credentials and server details you proided and then
+# starts an IRB session so you can interactively play with the API.
 
-require File.expand_path('../../lib/jenkins_api_client', __FILE__)
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'jenkins_api_client'
 require 'yaml'
 require 'irb'
 

data/spec/func_tests/client_spec.rb

@@ -0,0 +1,90 @@
+#
+# Specifying JenkinsApi::Client class capabilities
+# Author: Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client do
+  context "Given valid credentials and server information are given" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      # Grabbing just the server IP in a variable so we can check
+      # for wrong credentials
+      @server_ip = YAML.load_file(
+        File.expand_path(@creds_file, __FILE__)
+      )[:server_ip]
+      begin
+        @client = JenkinsApi::Client.new(
+          YAML.load_file(File.expand_path(@creds_file, __FILE__))
+        )
+      rescue Exception => e
+        puts "WARNING: Credentials are not set properly."
+        puts e.message
+      end
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#debug" do
+        it "Should be able to toggle the debug value" do
+          value = @client.debug
+          @client.toggle_debug.should_not == value
+        end
+      end
+
+      describe "#initialize" do
+        it "Should be able to initialize with valid credentials" do
+          client1 = JenkinsApi::Client.new(
+            YAML.load_file(File.expand_path(@creds_file, __FILE__))
+          )
+          client1.class.should == JenkinsApi::Client
+        end
+
+        it "Should accept a YAML argument when creating a new client" do
+          client3 = JenkinsApi::Client.new(
+            YAML.load_file(File.expand_path(@creds_file, __FILE__))
+          )
+          client3.class.should == JenkinsApi::Client
+        end
+
+        it "Should fail if wrong credentials are given" do
+          begin
+            client2 = JenkinsApi::Client.new(:server_ip => @server_ip,
+                                             :username => 'stranger',
+                                             :password => 'hacked')
+            client2.job.list_all
+          rescue Exception => e
+            e.class.should == JenkinsApi::Exceptions::UnautherizedException
+          end
+        end
+      end
+
+      describe "#job" do
+        it "Should return a job object on call" do
+          @client.job.class.should == JenkinsApi::Client::Job
+        end
+      end
+
+      describe "#node" do
+        it "Should return a node object on call" do
+          @client.node.class.should == JenkinsApi::Client::Node
+        end
+      end
+
+      describe "#view" do
+        it "Should return a view object on call" do
+          @client.view.class.should == JenkinsApi::Client::View
+        end
+      end
+
+      describe "#system" do
+        it "Should return a system object on call" do
+          @client.system.class.should == JenkinsApi::Client::System
+        end
+      end
+    end
+
+  end
+end

data/spec/func_tests/job_spec.rb

@@ -0,0 +1,348 @@
+#
+# Specifying JenkinsApi::Client::Job class capabilities
+# Author: Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::Job do
+  context "With properly initialized client" do
+    before(:all) do
+      @helper = JenkinsApiSpecHelper::Helper.new
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      @job_name_prefix = 'awesome_rspec_test_job'
+      @filter = "^#{@job_name_prefix}.*"
+      @job_name = ''
+      begin
+        @client = JenkinsApi::Client.new(
+          YAML.load_file(File.expand_path(@creds_file, __FILE__))
+        )
+      rescue Exception => e
+        puts "WARNING: Credentials are not set properly."
+        puts e.message
+      end
+      # Creating 10 jobs to run the spec tests on
+      begin
+        10.times do |num|
+          xml = @helper.create_job_xml
+          job = "#{@job_name_prefix}_#{num}"
+          @job_name = job if num == 0
+          @client.job.create(job, xml).to_i.should == 200
+        end
+      rescue Exception => e
+        puts "WARNING: Can't create jobs for preparing to spec tests"
+      end
+    end
+
+    describe "InstanceMethods" do
+
+      describe "#initialize" do
+        it "Initializes without any exception" do
+          expect(
+            lambda { job = JenkinsApi::Client::Job.new(@client) }
+          ).not_to raise_error
+        end
+        it "Raises an error if a reference of client is not passed" do
+          expect(
+            lambda { job = JenkinsApi::Client::Job.new() }
+          ).to raise_error
+        end
+      end
+
+      describe "#create" do
+        it "Should be able to create a job by getting an xml" do
+          xml = @helper.create_job_xml
+          @client.job.create("qwerty_nonexistent_job", xml).to_i.should == 200
+        end
+      end
+
+      describe "#create_freestyle" do
+        it "Should be able to create a simple freestyle job" do
+          params = {
+            :name => "test_job_name_using_params"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_name_using_params").to_i.should == 302
+        end
+        it "Should be able to create a freestyle job with shell command" do
+          params = {
+            :name => "test_job_using_params_shell",
+            :shell_command => "echo this is a free style project"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_using_params_shell").to_i.should == 302
+        end
+        it "Should accept Git SCM provider" do
+          params = {
+            :name => "test_job_with_git_scm",
+            :scm_provider => "git",
+            :scm_url => "git://github.com./arangamani/jenkins_api_client.git",
+            :scm_branch => "master"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_with_git_scm").to_i.should == 302
+        end
+        it "Should accept subversion SCM provider" do
+          params = {
+            :name => "test_job_with_subversion_scm",
+            :scm_provider => "subversion",
+            :scm_url => "http://svn.freebsd.org/base/",
+            :scm_branch => "master"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_with_subversion_scm").to_i.should == 302
+        end
+        it "Should accept CVS SCM provider with branch" do
+          params = {
+            :name => "test_job_with_cvs_scm_branch",
+            :scm_provider => "cvs",
+            :scm_url => "http://cvs.NetBSD.org",
+            :scm_module => "src",
+            :scm_branch => "MAIN"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_with_cvs_scm_branch").to_i.should == 302
+        end
+        it "Should accept CVS SCM provider with tag" do
+          params = {
+            :name => "test_job_with_cvs_scm_tag",
+            :scm_provider => "cvs",
+            :scm_url => "http://cvs.NetBSD.org",
+            :scm_module => "src",
+            :scm_tag => "MAIN"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_with_cvs_scm_tag").to_i.should == 302
+        end
+        it "Should fail if unsupported SCM is specified" do
+          params = {
+            :name => "test_job_unsupported_scm",
+            :scm_provider => "non-existent",
+            :scm_url => "http://non-existent.com/non-existent.non",
+            :scm_branch => "master"
+          }
+          expect(
+            lambda{ @client.job.create_freestyle(params) }
+          ).to raise_error
+        end
+        it "Should accept restricted_node option" do
+          params = {
+            :name => "test_job_restricted_node",
+            :restricted_node => "master"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_restricted_node").to_i.should == 302
+        end
+        it "Should accept block_build_when_downstream_building option" do
+          params = {
+            :name => "test_job_block_build_when_downstream_building",
+            :block_build_when_downstream_building => true,
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete(
+            "test_job_block_build_when_downstream_building"
+          ).to_i.should == 302
+        end
+        it "Should accept block_build_when_upstream_building option" do
+          params = {
+            :name => "test_job_block_build_when_upstream_building",
+            :block_build_when_upstream_building => true
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete(
+            "test_job_block_build_when_upstream_building"
+          ).to_i.should == 302
+        end
+        it "Should accept concurrent_build option" do
+          params = {
+            :name => "test_job_concurrent_build",
+            :concurrent_build => true
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_concurrent_build").to_i.should == 302
+        end
+        it "Should accept child projects option" do
+          params = {
+            :name => "test_job_child_projects",
+            :child_projects => @job_name,
+            :child_threshold => "success"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_child_projects").to_i.should == 302
+        end
+        it "Should accept notification_email option" do
+          params = {
+            :name => "test_job_notification_email",
+            :notification_email => "kannan@testdomain.com"
+          }
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.delete("test_job_notification_email").to_i.should == 302
+        end
+      end
+
+      describe "#recreate" do
+        it "Should be able to re-create a job" do
+          @client.job.recreate("qwerty_nonexistent_job").to_i.should == 200
+        end
+      end
+
+      describe "#change_description" do
+        it "Should be able to change the description of a job" do
+          @client.job.change_description("qwerty_nonexistent_job",
+            "The description has been changed by the spec test"
+          ).to_i.should == 200
+        end
+      end
+
+      describe "#delete" do
+        it "Should be able to delete a job" do
+          @client.job.delete("qwerty_nonexistent_job").to_i.should == 302
+        end
+      end
+
+      describe "#list_all" do
+        it "Should list all jobs" do
+          @client.job.list_all.class.should == Array
+        end
+      end
+
+      describe "#list" do
+        it "Should return job names based on the filter" do
+          names = @client.job.list(@filter)
+          names.class.should == Array
+          names.each { |name|
+            name.should match /#{@filter}/i
+          }
+        end
+      end
+
+      describe "#list_by_status" do
+        it "Should be able to list jobs by status" do
+          names = @client.job.list_by_status('success')
+          names.class.should == Array
+          names.each do |name|
+            status = @client.job.get_current_build_status(name)
+            status.should == 'success'
+          end
+        end
+      end
+
+      describe "#list_all_with_details" do
+        it "Should return all job names with details" do
+          @client.job.list_all_with_details.class.should == Array
+        end
+      end
+
+      describe "#list_details" do
+        it "Should list details of a particular job" do
+          job_name = @client.job.list(@filter)[0]
+          job_name.class.should == String
+          @client.job.list_details(job_name).class.should == Hash
+        end
+      end
+
+      describe "#get_upstream_projects" do
+        it "Should list upstream projects of the specified job" do
+          @client.job.get_upstream_projects(@job_name).class.should == Array
+        end
+      end
+
+      describe "#get_downstream_projects" do
+        it "Should list downstream projects of the specified job" do
+          @client.job.get_downstream_projects(@job_name).class.should == Array
+        end
+      end
+
+      describe "#get_builds" do
+        it "Should get builds of a specified job" do
+          @client.job.get_builds(@job_name).class.should == Array
+        end
+      end
+
+      describe "#get_current_build_status" do
+        it "Should obtain the current build status for the specified job" do
+          build_status = @client.job.get_current_build_status(@job_name)
+          build_status.class.should == String
+          valid_build_status = ["not_run",
+                                "aborted",
+                                "success",
+                                "failure",
+                                "unstable",
+                                "running"]
+          valid_build_status.include?(build_status).should be_true
+        end
+      end
+
+      describe "#build" do
+        it "Should build the specified job" do
+          @client.job.get_current_build_status(
+            @job_name
+          ).should_not == "running"
+          response = @client.job.build(@job_name)
+          response.to_i.should == 302
+          # Sleep for 6 seconds so we don't hit the Jenkins quiet period (5
+          # seconds)
+          sleep 6
+          @client.job.get_current_build_status(@job_name).should == "running"
+          while @client.job.get_current_build_status(@job_name) == "running" do
+            # Waiting for this job to finish so it doesn't affect other tests
+            sleep 10
+          end
+        end
+      end
+
+      describe "#stop" do
+        it "Should be able to abort a recent build of a running job" do
+          @client.job.get_current_build_status(
+            @job_name
+          ).should_not == "running"
+          @client.job.build(@job_name)
+          sleep 6
+          @client.job.get_current_build_status(@job_name).should == "running"
+          sleep 5
+          @client.job.stop_build(@job_name).to_i.should == 302
+          sleep 5
+          @client.job.get_current_build_status(@job_name).should == "aborted"
+        end
+      end
+
+      describe "#restrict_to_node" do
+        it "Should be able to restrict a job to a node" do
+          @client.job.restrict_to_node(@job_name, 'master').to_i.should == 200
+          # Run it again to make sure that the replace existing node works
+          @client.job.restrict_to_node(@job_name, 'master').to_i.should == 200
+        end
+      end
+
+      describe "#chain" do
+        it "Should be able to chain all jobs" do
+          # Filter jobs to be chained
+          jobs = @client.job.list(@filter)
+          jobs.class.should == Array
+          start_jobs = @client.job.chain(jobs, 'success', ["all"])
+          start_jobs.class.should == Array
+          start_jobs.length.should == 1
+        end
+        it "Should be able to chain jobs based on the specified criteria" do
+          jobs = @client.job.list(@filter)
+          jobs.class.should == Array
+          start_jobs = @client.job.chain(jobs,
+            'failure', ["not_run", "aborted", 'failure'], 3
+          )
+          start_jobs.class.should == Array
+          start_jobs.length.should == 3
+        end
+      end
+
+    end
+
+    after(:all) do
+      job_names = @client.job.list(@filter)
+      job_names.each { |job_name|
+        @client.job.delete(job_name)
+      }
+    end
+
+  end
+end