jenkins_api_client 0.3.2 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,5 +1,12 @@
 = CHANGELOG
 
+===== v0.4.0  [07-DEC-2012]
+* Added some methods for handling jobs.
+* The status 'not run' is not returned as 'not_run' from job status.
+
+===== v0.3.2  [17-NOV-2012]
+* Added some new methods for Job class
+
 ===== v0.3.1  [11-NOV-2012]
 * Removed unnecessary debug statements
 

data/README.md

@@ -1,7 +1,7 @@
 Jenkins API Client
 ==================
 
-Copyright © 2012, Kannan Manickam.
+Copyright © 2012, Kannan Manickam [![endorse](http://api.coderwall.com/arangamani/endorsecount.png)](http://coderwall.com/arangamani)
 
 Client libraries for communicating with a Jenkins CI server and programatically managing jobs.
 

data/lib/jenkins_api_client.rb

@@ -1,2 +1,6 @@
-Dir[File.dirname(__FILE__) + '/jenkins_api_client/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/jenkins_api_client/cli/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/jenkins_api_client/*.rb'].each do |file|
+  require file
+end
+Dir[File.dirname(__FILE__) + '/jenkins_api_client/cli/*.rb'].each do |file|
+  require file
+end

data/lib/jenkins_api_client/job.rb

@@ -53,6 +53,21 @@ module JenkinsApi
         @client.api_post_request("/job/#{job_name}/doDelete")
       end
 
+      # Stops a running build of a job
+      # This method will stop the current/most recent build if no build number
+      # is specified. The build will be stopped only if it was in 'running' state.
+      #
+      # @param [String] job_name
+      # @param [Number] build_number
+      #
+      def stop_build(job_name, build_number = 0)
+        build_number = get_current_build_number(job_name) if build_number == 0
+        raise "No builds for #{job_name}" unless build_number
+        # Check and see if the build is running
+        is_building = @client.api_get_request("/job/#{job_name}/#{build_number}")["building"]
+        @client.api_post_request("/job/#{job_name}/#{build_number}/stop") if is_building
+      end
+
       # Re-create the same job
       # This is a hack to clear any existing builds
       #
@@ -75,6 +90,14 @@ module JenkinsApi
         jobs.sort!
       end
 
+      # Checks if the given job exists in Jenkins
+      #
+      # @param [String] job_name
+      #
+      def exists?(job_name)
+        list(job_name).include?(job_name) ? true : false
+      end
+
       # List all Jobs matching the given status
       # You can optionally pass in jobs list to filter the status from
       #
@@ -166,7 +189,7 @@ module JenkinsApi
         when "grey_anime", "blue_anime", "red_anime"
           "running"
         when "grey"
-          "not run"
+          "not_run"
         when "aborted"
           "aborted"
         else
@@ -185,6 +208,16 @@ module JenkinsApi
         color_to_status(response_json["color"])
       end
 
+      # Obtain the current build number of the given job
+      # This function returns nil if there were no builds for the given job name.
+      #
+      # @param [String] job_name
+      #
+      def get_current_build_number(job_name)
+        builds = get_builds(job_name)
+        builds.length > 0 ? builds.first["number"] : nil
+      end
+
       # This functions lists all jobs that are currently running on the Jenkins CI server
       #
       def list_running

data/lib/jenkins_api_client/version.rb

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

data/spec/client_spec.rb

@@ -47,6 +47,6 @@ describe JenkinsApi::Client do
       client3 = JenkinsApi::Client.new(YAML.load_file(File.expand_path(@creds_file, __FILE__)))
       client3.class.should == JenkinsApi::Client
     end
-    
+
   end
 end

data/spec/job_spec.rb

@@ -96,7 +96,7 @@ describe JenkinsApi::Client::Job 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 = ["not_run", "aborted", "success", "failure", "unstable", "running"]
       valid_build_status.include?(build_status).should be_true
     end
 
@@ -108,6 +108,24 @@ describe JenkinsApi::Client::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 20 seconds so we don't hit the Jenkins quiet period
+      sleep 20
+      @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
+
+    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 20
+      @client.job.get_current_build_status(@job_name).should == "running"
+      sleep 20
+      @client.job.stop_build(@job_name).should == 302
+      sleep 20
+      @client.job.get_current_build_status(@job_name).should == "aborted"
     end
 
     it "Should be able to restrict a job to a node" do
@@ -124,9 +142,7 @@ describe JenkinsApi::Client::Job do
       start_jobs.class.should == Array
       start_jobs.length.should == 1
 
-      #
-      #
-      start_jobs = @client.job.chain(jobs, 'failure', ["not run", "aborted", 'failure'], 3)
+      start_jobs = @client.job.chain(jobs, 'failure', ["not_run", "aborted", 'failure'], 3)
       start_jobs.class.should == Array
       start_jobs.length.should == 3
     end

data/spec/spec_helper.rb

@@ -33,7 +33,7 @@ module JenkinsApiSpecHelper
           xml.concurrentBuild "false"
           xml.builders {
             xml.send("hudson.tasks.Shell") {
-              xml.command "\necho 'done'\necho 'done again'"
+              xml.command "\necho 'going to take a nice nap'\nsleep 120\necho 'took a nice nap'"
             }
           }
           xml.publishers

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jenkins_api_client
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kannan Manickam
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-18 00:00:00 Z
+date: 2012-12-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false