jenkins_api_client 0.5.0 → 0.6.0

data/.travis.yml

@@ -6,7 +6,8 @@ before_install:
   - sudo sh -c 'echo deb http://pkg.jenkins-ci.org/debian binary/ > /etc/apt/sources.list.d/jenkins.list'
   - sudo apt-get update -qq
   - sudo apt-get install -qq jenkins
-  - echo `service jenkins status`
+  - echo `sudo service jenkins status`
+  - cat /var/log/jenkins/jenkins.log
   - echo `curl 10.0.2.15:8080`
   - echo `curl 10.0.2.15`
   - echo `curl localhost:8080`

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,41 +1,58 @@
-= CHANGELOG
+CHANGELOG
+=========
 
-===== v0.5.0  [22-DEC-2012]
+v0.6.0
+------
+* Added functionality to get progressive console output from Jenkins.
+* Added CLI command `console` for printing progressive console output on terminal.
+* Fixed a bug with `get_current_build_number` not returning the recent running build number.
+
+v0.5.0  [22-DEC-2012]
+---------------------
 * Added functionality to create jobs with params.
 * Added View class and added methods accessing List Views of Jenkins server.
 * Added functionality to abort a running job.
-* Deprecated list_running of Job class. list_by_status('running') is suggested.
+* Deprecated `list_running` of Job class. `list_by_status('running')` is suggested.
 
-===== v0.4.0  [07-DEC-2012]
+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.
+* The status `not run` is not returned as `not_run` from job status.
 
-===== v0.3.2  [17-NOV-2012]
+v0.3.2  [17-NOV-2012]
+---------------------
 * Added some new methods for Job class
 
-===== v0.3.1  [11-NOV-2012]
+v0.3.1  [11-NOV-2012]
+---------------------
 * Removed unnecessary debug statements
 
-===== v0.3.0  [11-NOV-2012]
+v0.3.0  [11-NOV-2012]
+---------------------
 * Added System class to support quietdown and restart functionality.
 * Added Node class to query the node interface of Jenkins server.
 * Added Command line interface for System and Node class.
 * Introduced terminal tables for displaying attributes in command line.
 
-===== v0.2.1  [02-NOV-2012]
+v0.2.1  [02-NOV-2012]
+---------------------
 * Added command line interface for basic operations
 
-===== v0.1.1  [30-OCT-2012]
+v0.1.1  [30-OCT-2012]
+---------------------
 * Updated gem dependencies to work with Ruby 1.8.7
 
-===== v0.1.0  [26-OCT-2012]
+v0.1.0  [26-OCT-2012]
+---------------------
 * Improved performance
 * Added job create feature, delete feature, chaining feature, and build feature
 * Added exception handling mechanism
 
-===== v0.0.2  [16-OCT-2012]
+v0.0.2  [16-OCT-2012]
+---------------------
 * Added documentation
 * Added some more smal features to Job class
 
-===== v0.0.1  [15-OCT-2012]
+v0.0.1  [15-OCT-2012]
+---------------------
 * Initial Release

data/lib/jenkins_api_client/cli/job.rb

@@ -76,6 +76,30 @@ module JenkinsApi
         puts @client.job.delete(job)
       end
 
+      desc "console JOB", "Print the progressive console output of a job"
+      method_option :sleep, :aliases => "-z", :desc => "Time to wait between querying the API for console output"
+      def console(job)
+        @client = Helper.setup(parent_options)
+        # If debug is enabled, disable it. It shouldn't interfere with console output.
+        debug_changed = false
+        if @client.debug == true
+          @client.debug = false
+          debug_changed = true
+        end
+
+        # Print progressive console output
+        response = @client.job.get_console_output(job)
+        puts response['output'] unless response['more']
+        while response['more']
+          size = response['size']
+          puts response['output'] unless response['output'].chomp.empty?
+          sleep options[:sleep].to_i if options[:sleep]
+          response = @client.job.get_console_output(job, 0, size)
+        end
+        # Change the debug back if we changed it now
+        @client.toggle_debug if debug_changed
+      end
+
       desc "restrict JOB", "Restricts a job to a specific node"
       method_option :node, :aliases => "-n", :desc => "Node to be restricted to"
       def restrict(job)

data/lib/jenkins_api_client/client.rb

@@ -112,16 +112,20 @@ module JenkinsApi
     #
     # @param [String] url_prefix
     #
-    def api_get_request(url_prefix, tree = nil)
+    def api_get_request(url_prefix, tree = nil, url_suffix ="/api/json")
       http = Net::HTTP.start(@server_ip, @server_port)
-      request = Net::HTTP::Get.new("#{url_prefix}/api/json")
-      puts "[INFO] GET #{url_prefix}/api/json" if @debug
-      request = Net::HTTP::Get.new("#{url_prefix}/api/json?#{tree}") if tree
+      request = Net::HTTP::Get.new("#{url_prefix}#{url_suffix}")
+      puts "[INFO] GET #{url_prefix}#{url_suffix}" if @debug
+      request = Net::HTTP::Get.new("#{url_prefix}#{url_suffix}?#{tree}") if tree
       request.basic_auth @username, @password
       response = http.request(request)
       case response.code.to_i
       when 200
-        return JSON.parse(response.body)
+        if url_suffix =~ /json/
+          return JSON.parse(response.body)
+        else
+          return response
+        end
       when 401
         raise Exceptions::UnautherizedException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
       when 404

data/lib/jenkins_api_client/job.rb

@@ -215,6 +215,41 @@ module JenkinsApi
         create(job_name, job_xml)
       end
 
+      # Get progressive console output from Jenkins server for a job
+      #
+      # @param [String] job_name Name of the Jenkins job
+      # @param [Number] build_number Specific build number to obtain the console output from. Default is the recent build
+      # @param [Number] start start offset to get only a portion of the text
+      # @param [String] mode Mode of text output. 'text' or 'html'
+      #
+      # @return [Hash] response
+      #   * +output+ Console output of the job
+      #   * +size+ Size of the text. This can be used as 'start' for the next call to get progressive output
+      #   * +more+ More data available for the job. 'true' if available and nil otherwise
+      #
+      def get_console_output(job_name, build_number = 0, start = 0, mode = 'text')
+        build_number = get_current_build_number(job_name) if build_number == 0
+        if build_number == 0
+          puts "No builds for this job '#{job_name}' yet."
+          return nil
+        end
+        if mode == 'text'
+          mode = 'Text'
+        elsif mode == 'html'
+          mode = 'Html'
+        else
+          raise "Mode should either be 'text' or 'html'. You gave: #{mode}"
+        end
+        api_response = @client.api_get_request("/job/#{job_name}/#{build_number}/logText/progressive#{mode}?start=#{start}", nil, nil)
+        #puts "Response: #{api_response.header['x-more-data']}"
+        response = {}
+        response['output'] = api_response.body
+        response['size'] = api_response.header['x-text-size']
+        response['more'] = api_response.header['x-more-data']
+
+        response
+      end
+
       # List all jobs on the Jenkins CI server
       #
       def list_all
@@ -348,8 +383,7 @@ module JenkinsApi
       # @param [String] job_name
       #
       def get_current_build_number(job_name)
-        builds = get_builds(job_name)
-        builds.length > 0 ? builds.first["number"] : nil
+        @client.api_get_request("/job/#{job_name}")['nextBuildNumber'] - 1
       end
 
       # This functions lists all jobs that are currently running on the Jenkins CI server

data/lib/jenkins_api_client/version.rb

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

data/spec/job_spec.rb

@@ -117,16 +117,16 @@ describe JenkinsApi::Client::Job do
       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 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.to_i == 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
       @client.job.restrict_to_node(@job_name, 'master').to_i.should == 200

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-22 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -181,12 +181,11 @@ email:
 executables:
 - jenkinscli
 extensions: []
-extra_rdoc_files:
-- CHANGELOG.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
 - LICENCE
 - README.md