jenkins_api_client 1.0.0.alpha.2 → 1.0.0.beta.1

data/lib/jenkins_api_client/node.rb

@@ -124,8 +124,9 @@ module JenkinsApi
       #   )
       #
       def create_dump_slave(params)
-        unless params[:name] && params[:slave_host]
-          raise ArgumentError, "Name, slave host are required for creating a slave."
+        unless params[:name] && params[:slave_host] && params[:private_key_file]
+          raise ArgumentError, "Name, slave host, and private key file are" +
+            " required for creating a slave."
         end
 
         @logger.info "Creating a dump slave '#{params[:name]}'"
@@ -136,11 +137,7 @@ module JenkinsApi
           :remote_fs => "/var/jenkins",
           :labels => params[:name],
           :slave_port => 22,
-          :mode => "normal",
-          :credential_id => "",
-          :java_path => "",
-          :prefix_start_slave_cmd => "",
-          :suffix_start_slave_cmd => ""
+          :mode => "normal"
         }
 
         params = default_params.merge(params)
@@ -168,13 +165,8 @@ module JenkinsApi
               "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
               "host" => params[:slave_host],
               "port" => params[:slave_port],
-              "credentialsId" => params[:credential_id],
-              "javaPath" => params[:java_path],
-              "jvmOptions" => params[:jvm_options],
-              "prefixStartSlaveCmd" => params[:prefix_start_slave_cmd],
-              "suffixStartSlaveCmd" => params[:suffix_start_slave_cmd]
-              #"username" => params[:slave_user],
-              #"privatekey" => params[:private_key_file],
+              "username" => params[:slave_user],
+              "privatekey" => params[:private_key_file],
             }
           }.to_json
         }
@@ -302,37 +294,6 @@ module JenkinsApi
         @client.post_config("/computer/#{node_name}/config.xml", xml)
       end
 
-
-      def create_cred
-        post_params = {
-          "name" => "testcred",
-          "description" => "test cred description",
-          "json" => {
-            "domainCredentials" => {
-              "domain" => {
-                "name" => "",
-                "description" => "",
-              },
-              "credentials" => {
-                "scope" => "GLOBAL",
-                "id" => "",
-                "username" => "root",
-                "description" => "root users credential",
-                "privateKeySource" => {
-                  "value" => "0",
-                  "privateKey" => "blah blah blah",
-                  "stapler-class" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey$DirectEntryPrivateKeySource"
-                },
-                "passphrase" => "",
-                "stapler-class" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey",
-                "kind" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey"
-              }
-            }
-          }.to_json
-        }
-        @client.api_post_request("/credentials/configSubmit", post_params)
-      end
-
     end
   end
 end

data/lib/jenkins_api_client/urihelper.rb

@@ -0,0 +1,17 @@
+require 'uri'
+
+module JenkinsApi
+  module UriHelper
+    # Encode a string for using in the query part of an URL
+    #
+    def form_encode(string)
+      URI.encode_www_form_component string.encode(Encoding::UTF_8)
+    end
+
+    # Encode a string for use in the hiearchical part of an URL
+    #
+    def path_encode(path)
+      URI.escape(path.encode(Encoding::UTF_8))
+    end
+  end
+end

data/lib/jenkins_api_client/user.rb

@@ -21,6 +21,7 @@
 #
 
 require 'timeout'
+require 'jenkins_api_client/urihelper'
 
 module JenkinsApi
   class Client
@@ -31,6 +32,7 @@ module JenkinsApi
     # @since 0.14.0
     #
     class User
+      include JenkinsApi::UriHelper
 
       # Initializes a new User object.
       #
@@ -111,7 +113,7 @@ module JenkinsApi
       #   }
       #
       def get(user_id)
-        response = @client.api_get_request("/user/#{user_id}")
+        response = @client.api_get_request("/user/#{path_encode user_id}")
       end
 
     end

data/lib/jenkins_api_client/version.rb

@@ -29,7 +29,7 @@ module JenkinsApi
     # Tiny version of the gem used for patches
     TINY    = 0
     # Used for pre-releases
-    PRE     = 'alpha.2'
+    PRE     = 'beta.1'
     # Version String of Jenkins API Client.
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

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/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/unit_tests/client_spec.rb

@@ -142,75 +142,129 @@ describe JenkinsApi::Client do
     end
 
     describe "InstanceMethods" do
-      describe "#getroot" do
+      describe "#get_root" do
         it "is defined with no parameters" do
-          expect(
-            lambda { @client.get_root }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:get_root).should be_true
+          @client.method(:get_root).parameters.size.should == 0
         end
       end
 
       describe "#api_get_request" do
         it "defined and should accept url_prefix, tree, and url_suffix" do
-          expect(
-            lambda { @client.api_get_request("/some/prefix", "tree", "/json") }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:api_get_request).should be_true
+          @client.method(:api_get_request).parameters.size.should == 4
         end
       end
 
       describe "#api_post_request" do
         it "is defined and should accept url_prefix" do
-          expect(
-            lambda { @client.api_post_request("/some/prefix") }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:api_post_request).should be_true
+          @client.method(:api_post_request).parameters.size.should == 3
         end
       end
 
       describe "#get_config" do
         it "is defined and should accept url_prefix" do
-          expect(
-            lambda { @client.get_config("/some/prefix") }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:get_config).should be_true
+          @client.method(:get_config).parameters.size.should == 1
         end
       end
 
       describe "#post_config" do
         it "is defined and should accept url_prefix and xml" do
-          expect(
-            lambda { @client.post_config("/some/prefix", "<tag></tag>") }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:post_config).should be_true
+          @client.method(:post_config).parameters.size.should == 2
         end
       end
 
       describe "#get_jenkins_version" do
         it "is defined and accepts no parameters" do
-          expect(
-            lambda { @client.get_jenkins_version }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:get_jenkins_version).should be_true
+          @client.method(:get_jenkins_version).parameters.size.should == 0
         end
       end
 
       describe "#get_hudson_version" do
         it "is defined and accepts no parameters" do
-          expect(
-            lambda { @client.get_hudson_version }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:get_hudson_version).should be_true
+          @client.method(:get_hudson_version).parameters.size.should == 0
         end
       end
 
       describe "#get_server_date" do
         it "is defined and accepts no parameters" do
-          expect(
-            lambda { @client.get_server_date }
-          ).not_to raise_error(NoMethodError)
+          @client.respond_to?(:get_server_date).should be_true
+          @client.method(:get_server_date).parameters.size.should == 0
         end
       end
 
       describe "#exec_cli" do
         it "is defined and should execute the CLI" do
+          @client.respond_to?(:exec_cli).should be_true
+          @client.method(:exec_cli).parameters.size.should == 2
+        end
+      end
+
+      describe "#deconstruct_version_string" do
+        it "is defined and accepts a single param" do
+          @client.respond_to?(:deconstruct_version_string).should be_true
+          @client.method(:deconstruct_version_string).parameters.size.should == 1
+        end
+
+        it "takes a version string in the form 'a.b' and returns an array [a,b,c]" do
+          TEST_2_PART_VERSION_STRING = "1.002"
+          version = @client.deconstruct_version_string(TEST_2_PART_VERSION_STRING)
+          version.should_not be_nil
+          version.should_not be_empty
+          version.size.should eql 3
+          version[0].should eql 1
+          version[1].should eql 2
+          version[2].should eql 0
+        end
+
+        it "takes a version string in the form 'a.b.c' and returns an array [a,b]" do
+          TEST_3_PART_VERSION_STRING = "1.002.3"
+          version = @client.deconstruct_version_string(TEST_3_PART_VERSION_STRING)
+          version.should_not be_nil
+          version.should_not be_empty
+          version.size.should eql 3
+          version[0].should eql 1
+          version[1].should eql 2
+          version[2].should eql 3
+        end
+
+        it "should fail if parameter is not a string" do
           expect(
-            lambda { @client.exec_cli("version") }
-          ).not_to raise_error(NoMethodError)
+            lambda { @client.deconstruct_version_string(1) }
+          ).to raise_error(NoMethodError) # match for fixnum
+        end
+
+        it "should return nil if parameter is not a string in the form '\d+.\d+(.\d+)'" do
+          @client.deconstruct_version_string("A.B").should be_nil
+          @client.deconstruct_version_string("1").should be_nil
+          @client.deconstruct_version_string("1.").should be_nil
+          @client.deconstruct_version_string("1.2.3.4").should be_nil
+        end
+      end
+
+      describe "#compare_versions" do
+        it "is defined and accepts two params" do
+          @client.respond_to?(:compare_versions).should be_true
+          @client.method(:compare_versions).parameters.size.should == 2
+        end
+
+        it "should correctly compare version numbers" do
+          @client.compare_versions("1.0", "1.0").should eql(0)
+          @client.compare_versions("1.0", "1.1").should eql(-1)
+          @client.compare_versions("1.1", "1.0").should eql(1)
+          @client.compare_versions("2.0", "1.99").should eql(1)
+          @client.compare_versions("1.10", "1.2").should eql(1)
+
+          @client.compare_versions("1.0.0", "1.0.0").should eql(0)
+          @client.compare_versions("1.0", "1.0.1").should eql(-1)
+          @client.compare_versions("1.1", "1.0.1").should eql(1)
+          @client.compare_versions("2.0.0", "1.999.99").should eql(1)
+          @client.compare_versions("1.0.10", "1.0.2").should eql(1)
         end
       end
     end