jenkins_api_client 0.14.1 → 1.0.0

data/lib/jenkins_api_client/view.rb

@@ -20,6 +20,8 @@
 # THE SOFTWARE.
 #
 
+require 'jenkins_api_client/urihelper'
+
 module JenkinsApi
   class Client
     # This class communicates with Jenkins "/view" API and used to create,
@@ -27,6 +29,7 @@ module JenkinsApi
     # API.
     #
     class View
+      include JenkinsApi::UriHelper
 
       # Initializes a new view object
       #
@@ -150,7 +153,7 @@ module JenkinsApi
         post_params.merge!("filterExecutors" => "on") if params[:filter_executors]
         post_params.merge!("useincluderegex" => "on",
                            "includeRegex" => params[:regex]) if params[:regex]
-        @client.api_post_request("/view/#{params[:name]}/configSubmit",
+        @client.api_post_request("/view/#{path_encode params[:name]}/configSubmit",
                                  post_params)
       end
 
@@ -160,7 +163,7 @@ module JenkinsApi
       #
       def delete(view_name)
         @logger.info "Deleting view '#{view_name}'"
-        @client.api_post_request("/view/#{view_name}/doDelete")
+        @client.api_post_request("/view/#{path_encode view_name}/doDelete")
       end
 
       # Deletes all views (except the All view) in Jenkins.
@@ -211,7 +214,7 @@ module JenkinsApi
         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 = @client.api_get_request("/view/#{path_encode view_name}")
         response_json["jobs"].each do |job|
           job_names << job["name"]
         end
@@ -225,7 +228,7 @@ module JenkinsApi
       #
       def add_job(view_name, job_name)
         @logger.info "Adding job '#{job_name}' to view '#{view_name}'"
-        post_msg = "/view/#{view_name}/addJobToView?name=#{job_name}"
+        post_msg = "/view/#{path_encode view_name}/addJobToView?name=#{form_encode job_name}"
         @client.api_post_request(post_msg)
       end
 
@@ -236,7 +239,7 @@ module JenkinsApi
       #
       def remove_job(view_name, job_name)
         @logger.info "Removing job '#{job_name}' from view '#{view_name}'"
-        post_msg = "/view/#{view_name}/removeJobFromView?name=#{job_name}"
+        post_msg = "/view/#{path_encode view_name}/removeJobFromView?name=#{form_encode job_name}"
         @client.api_post_request(post_msg)
       end
 
@@ -246,7 +249,7 @@ module JenkinsApi
       #
       def get_config(view_name)
         @logger.info "Obtaining the configuration of view '#{view_name}'"
-        @client.get_config("/view/#{view_name}")
+        @client.get_config("/view/#{path_encode view_name}")
       end
 
       # Post the configuration of a view given the view name and the config.xml
@@ -256,7 +259,7 @@ module JenkinsApi
       #
       def post_config(view_name, xml)
         @logger.info "Posting the configuration of view '#{view_name}'"
-        @client.post_config("/view/#{view_name}/config.xml", xml)
+        @client.post_config("/view/#{path_encode view_name}/config.xml", xml)
       end
 
     end

data/lib/jenkins_api_client.rb

@@ -28,6 +28,7 @@ require 'jenkins_api_client/node'
 require 'jenkins_api_client/system'
 require 'jenkins_api_client/view'
 require 'jenkins_api_client/build_queue'
+require 'jenkins_api_client/plugin_manager'
 require 'jenkins_api_client/user'
 
 require 'jenkins_api_client/cli/helper'

data/scripts/login_with_pry.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby1.9.1
+# 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.
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'jenkins_api_client'
+require 'yaml'
+require 'pry'
+
+def prompt_for_username
+  get_from_stdin("Username: ", false)
+end
+
+def prompt_for_password
+  get_from_stdin("Password: ", true)
+end
+
+def get_from_stdin(prompt, mask = false)
+  $stdout.write(prompt)
+  
+  begin
+    Kernel::system "stty -echo" if mask == true
+    ret = gets.chomp!
+  ensure
+    if mask == true
+      Kernel::system "stty echo"
+      puts ""
+    end
+  end
+
+  ret
+end
+
+if ARGV.empty?
+  config_file = '~/.jenkins_api_client/spec.yml'
+else
+  config_file = ARGV.shift
+end
+
+begin
+  client_opts = YAML.load_file(File.expand_path(config_file))
+  unless client_opts.has_key?(:username)
+    client_opts[:username] = prompt_for_username()
+  end
+  unless client_opts.has_key?(:password) or client_opts.has_key?(:password_base64)
+    client_opts[:password] = prompt_for_password()
+  end
+  
+  @client = JenkinsApi::Client.new(client_opts)
+  puts "logged-in to the Jenkins API, use the '@client' variable to use the client"
+end
+
+Pry.start

data/spec/func_tests/client_spec.rb

@@ -66,9 +66,9 @@ describe JenkinsApi::Client do
         end
       end
 
-      describe "#get_server_date" do
-        it "Should return the server date" do
-          @client.get_server_date.class.should == String
+      describe "#exec_script" do
+        it "Should execute the provided groovy script" do
+          @client.exec_script('println("hi")').should == "hi\n"
         end
       end
     end

data/spec/func_tests/job_spec.rb

@@ -481,6 +481,14 @@ describe JenkinsApi::Client::Job do
       end
 
       describe "#build" do
+
+        def wait_for_job_to_finish(job_name)
+          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
+
         it "Should build the specified job" do
           @client.job.get_current_build_status(
             @job_name
@@ -489,14 +497,89 @@ describe JenkinsApi::Client::Job do
           # As of Jenkins version 1.519 the job build responds with a 201
           # status code.
           @valid_post_responses.should include(response.to_i)
-          # Sleep for 6 seconds so we don't hit the Jenkins quiet period (5
+          # Sleep for 10 seconds so we don't hit the Jenkins quiet period (5
           # seconds)
-          sleep 6
+          sleep 10
           @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
+          wait_for_job_to_finish(@job_name)
+        end
+
+        it "Should build the specified job (wait for start)" do
+          @client.job.get_current_build_status(
+            @job_name
+          ).should_not == "running"
+          expected_build_id = (@client.job.get_current_build_number(@job_name) || 0) + 1
+
+          build_opts = {
+            'build_start_timeout' => 10,
+            'progress_proc' => lambda do |max_wait, curr_wait, poll_count|
+              puts "Waited #{curr_wait}s of #{max_wait}s max - poll count = #{poll_count}"
+            end,
+            'completion_proc' => lambda do |build_number, cancelled|
+              if build_number
+                puts "Wait over: build #{build_number} started"
+              else
+                puts "Wait over: build not started, build #{cancelled ? "" : "NOT "} cancelled"
+              end
+            end
+          }
+          build_id = @client.job.build(@job_name, {}, build_opts)
+          build_id.should_not be_nil
+          build_id.should eql(expected_build_id)
+          @client.job.get_current_build_status(@job_name).should == "running"
+          wait_for_job_to_finish(@job_name)
+        end
+
+        # This build doesn't start in time, but we don't cancel it, so it will run if
+        # Jenkins gets to it
+        it "Should build the specified job (wait for start - but not long enough)" do
+          @client.job.get_current_build_status(
+            @job_name
+          ).should_not == "running"
+
+          build_opts = {
+            'build_start_timeout' => 1,
+            'progress_proc' => lambda do |max_wait, curr_wait, poll_count|
+              puts "Waited #{curr_wait}s of #{max_wait}s max - poll count = #{poll_count}"
+            end,
+            'completion_proc' => lambda do |build_number, cancelled|
+              if build_number
+                puts "Wait over: build #{build_number} started"
+              else
+                puts "Wait over: build not started, build #{cancelled ? "" : "NOT "}cancelled"
+              end
+            end
+          }
+          expect( lambda { @client.job.build(@job_name, {}, build_opts) } ).to raise_error(Timeout::Error)
+          # Sleep for 10 seconds so we don't hit the Jenkins quiet period (5
+          # seconds)
+          sleep 10
+          @client.job.get_current_build_status(@job_name).should == "running"
+          wait_for_job_to_finish(@job_name)
+        end
+
+        # This build doesn't start in time, and we will attempt to cancel it so it
+        # doesn't run
+        it "Should build the specified job (wait for start - but not long enough, cancelled)" do
+          @client.job.get_current_build_status(
+            @job_name
+          ).should_not == "running"
+
+          build_opts = {
+            'build_start_timeout' => 1,
+            'cancel_on_build_start_timeout' => true,
+            'progress_proc' => lambda do |max_wait, curr_wait, poll_count|
+              puts "Waited #{curr_wait}s of #{max_wait}s max - poll count = #{poll_count}"
+            end,
+            'completion_proc' => lambda do |build_number, cancelled|
+              if build_number
+                puts "Wait over: build #{build_number} started"
+              else
+                puts "Wait over: build not started, build #{cancelled ? "" : "NOT "}cancelled"
+              end
+            end
+          }
+          expect( lambda { @client.job.build(@job_name, {}, build_opts) } ).to raise_error(Timeout::Error)
         end
       end
 
@@ -527,7 +610,7 @@ describe JenkinsApi::Client::Job do
             @job_name
           ).should_not == "running"
           @client.job.build(@job_name)
-          sleep 6
+          sleep 10
           @client.job.get_current_build_status(@job_name).should == "running"
           sleep 5
           @valid_post_responses.should include(

data/spec/func_tests/{node_spec.rb → node_spec.rb.pending}

@@ -21,7 +21,7 @@ describe JenkinsApi::Client::Node do
         puts e.message
       end
 
-      @client.node.create_dump_slave(
+      @client.node.create_dumb_slave(
         :name => "slave",
         :slave_host => "10.0.0.1",
         :private_key_file => "/root/.ssh/id_rsa"
@@ -43,12 +43,12 @@ describe JenkinsApi::Client::Node do
         end
       end
 
-      describe "#create_dump_slave" do
+      describe "#create_dumb_slave" do
 
         def test_and_validate(params)
           name = params[:name]
           @valid_post_responses.should include(
-            @client.node.create_dump_slave(params).to_i
+            @client.node.create_dumb_slave(params).to_i
           )
           @client.node.list(name).include?(name).should be_true
           @valid_post_responses.should include(
@@ -79,7 +79,7 @@ describe JenkinsApi::Client::Node do
             :private_key_file => "/root/.ssh/id_rsa"
           }
           expect(
-            lambda{ @client.node.create_dump_slave(params) }
+            lambda{ @client.node.create_dumb_slave(params) }
           ).to raise_error(ArgumentError)
         end
         it "fails if slave_host is missing" do
@@ -88,7 +88,7 @@ describe JenkinsApi::Client::Node do
             :private_key_file => "/root/.ssh/id_rsa"
           }
           expect(
-            lambda{ @client.node.create_dump_slave(params) }
+            lambda{ @client.node.create_dumb_slave(params) }
           ).to raise_error(ArgumentError)
         end
         it "fails if private_key_file is missing" do
@@ -97,7 +97,7 @@ describe JenkinsApi::Client::Node do
             :slave_host => "10.10.10.10"
           }
           expect(
-            lambda{ @client.node.create_dump_slave(params) }
+            lambda{ @client.node.create_dumb_slave(params) }
           ).to raise_error(ArgumentError)
         end
         it "fails if the slave already exists in Jenkins" do
@@ -107,10 +107,10 @@ describe JenkinsApi::Client::Node do
             :private_key_file => "/root/.ssh/id_rsa"
           }
           @valid_post_responses.should include(
-            @client.node.create_dump_slave(params).to_i
+            @client.node.create_dumb_slave(params).to_i
           )
           expect(
-            lambda{ @client.node.create_dump_slave(params) }
+            lambda{ @client.node.create_dumb_slave(params) }
           ).to raise_error(JenkinsApi::Exceptions::NodeAlreadyExists)
           @valid_post_responses.should include(
             @client.node.delete(params[:name]).to_i
@@ -126,7 +126,7 @@ describe JenkinsApi::Client::Node do
             :private_key_file => "/root/.ssh/id_rsa"
           }
           @valid_post_responses.should include(
-            @client.node.create_dump_slave(params).to_i
+            @client.node.create_dumb_slave(params).to_i
           )
           @valid_post_responses.should include(
             @client.node.delete(params[:name]).to_i

data/spec/func_tests/plugin_spec.rb

@@ -0,0 +1,148 @@
+#
+# Specifying JenkinsApi::Client::PluginManager class capabilities
+# Author Kannan Manickam <arangamani.kannan@gmail.com>
+#
+
+require File.expand_path('../spec_helper', __FILE__)
+require 'yaml'
+
+describe JenkinsApi::Client::PluginManager do
+  context "With properly initialized client" do
+    before(:all) do
+      @creds_file = '~/.jenkins_api_client/spec.yml'
+      @valid_post_responses = [200, 201, 302]
+      @test_plugin = "scripttrigger"
+      @test_plugins = ["text-finder", "terminal", "warnings"]
+      begin
+        @client = JenkinsApi::Client.new(
+          YAML.load_file(File.expand_path(@creds_file, __FILE__))
+        )
+        @client.init_update_center
+        sleep 30
+      rescue Exception => e
+        puts "WARNING: Credentials are not set properly."
+        puts e.message
+      end
+    end
+
+    describe "InstanceMethods" do
+      describe "#list_installed" do
+        it "lists all installed plugins in jenkins" do
+          @client.plugin.list_installed.class.should == Hash
+        end
+        supported_filters = [
+          :active, :bundled, :deleted, :downgradable, :enabled,
+          :hasUpdate, :pinned
+        ]
+        supported_filters.each do |filter|
+          it "lists all installed plugins matching filter '#{filter}'" do
+            @client.plugin.list_installed(filter => true).class.should == Hash
+          end
+        end
+        it "raises an error if unsupported filter is specified" do
+          expect(
+            lambda { @client.plugin.list_installed(:unsupported => true) }
+          ).to raise_error(ArgumentError)
+        end
+      end
+
+      describe "#list_available" do
+        it "lists all available plugins in jenkins update center" do
+          @client.plugin.list_available.class.should == Hash
+        end
+      end
+
+      describe "#list_updates" do
+        it "lists all available plugin updates in jenkins update center" do
+          @client.plugin.list_updates.class.should == Hash
+        end
+      end
+
+      describe "#install, #restart_required?" do
+        it "installs a single plugin given as a string" do
+          @client.plugin.install(@test_plugin)
+          # Plugin installation might take a bit
+          sleep 5
+          @client.system.restart(true) if @client.plugin.restart_required?
+          @client.system.wait_for_ready
+          @client.plugin.list_installed.keys.should include(@test_plugin)
+        end
+        it "installs multiple plugins given as an array" do
+          @client.plugin.install(@test_plugins)
+          # Plugin installation might take a bit
+          sleep 15
+          @client.system.restart(true) if @client.plugin.restart_required?
+          @client.system.wait_for_ready
+          installed = @client.plugin.list_installed.keys
+          @test_plugins.all? { |plugin| installed.include?(plugin) }.
+            should == true
+        end
+      end
+
+      describe "#disable, #restart_required?" do
+        it "disables a single plugin given as a string" do
+          @client.plugin.disable(@test_plugin)
+          # Plugin installation might take a bit
+          sleep 5
+          @client.system.restart(true)
+          @client.system.wait_for_ready
+          @client.plugin.list_installed(:active => false).keys.
+            should include(@test_plugin)
+        end
+        it "disables multiple plugins given as an array" do
+          @client.plugin.disable(@test_plugins)
+          # Plugin installation might take a bit
+          sleep 5
+          @client.system.restart(true)
+          @client.system.wait_for_ready
+          installed = @client.plugin.list_installed(:active => false).keys
+          @test_plugins.all? { |plugin| installed.include?(plugin) }.
+            should == true
+        end
+      end
+
+      describe "#enable, #restart_required?" do
+        it "enables a single plugin given as a string" do
+          @client.plugin.enable(@test_plugin)
+          # Plugin installation might take a bit
+          sleep 5
+          @client.system.restart(true)
+          @client.system.wait_for_ready
+          @client.plugin.list_installed(:active => true).keys.
+            should include(@test_plugin)
+        end
+        it "enables multiple plugins given as an array" do
+          @client.plugin.enable(@test_plugins)
+          # Plugin installation might take a bit
+          sleep 5
+          @client.system.restart(true)
+          @client.system.wait_for_ready
+          installed = @client.plugin.list_installed(:active => true).keys
+          @test_plugins.all? { |plugin| installed.include?(plugin) }.
+            should == true
+        end
+      end
+
+      describe "#uninstall, #restart_required?" do
+        it "uninstalls a single plugin given as a string" do
+          @client.plugin.uninstall(@test_plugin)
+          # Plugin uninstallation might take a bit
+          sleep 5
+          @client.system.restart(true) if @client.plugin.restart_required?
+          @client.system.wait_for_ready
+          @client.plugin.list_installed.keys.should_not include(@test_plugin)
+        end
+        it "uninstalls multiple plugins given as an array" do
+          @client.plugin.uninstall(@test_plugins)
+          # Plugin uninstallation might take a bit
+          sleep 5
+          @client.system.restart(true) if @client.plugin.restart_required?
+          @client.system.wait_for_ready
+          installed = @client.plugin.list_installed.keys
+          @test_plugins.all? { |plugin| installed.include?(plugin) }.
+            should == false
+        end
+      end
+    end
+  end
+end