hudson-remote-api 0.5.0 → 0.6.0

data/README

@@ -12,6 +12,9 @@ Hudson[:url] = 'http://localhost:8080'
 Hudson[:user] = 'hudson'
 Hudson[:password] = 'password'
 
+# To turn off checking for crumbIssuer
+Hudson[:crumb] = false
+
 # List all Hudson jobs
 Hudson::Job.list
 
@@ -26,3 +29,22 @@ puts j.last_build
 j.repository_url = { :url => 'https://github.com/beeplove/hudson-remote-api-mkhan.git', :branch => 'origin/master' }
 # or, only to change branch
 j.repository_url = { :branch => 'origin/master' }
+
+# Set build trigger
+j.triggers = { 'hudson.triggers.SCMTrigger' => '* * * * *'}
+# or, using shortcut
+j.triggers = { 'SCMTrigger' => '* * * * *', 'TimerTrigger' => '0 22 * * *'}
+
+# To add or update a trigger in existing triggers
+j.triggers = j.triggers.merge({ 'hudson.triggers.TimerTrigger' => '0 22 * * *'})
+# Avoid using shortcut form when to edit a trigger in existing triggers
+
+# To delete existing triggers
+j.triggers = {}
+# or,
+j.triggers = nil
+
+# To view current trigger
+j.triggers
+# would return hash containing trigger name in key and trigger spec in value.
+# Example of returned hash: {"hudson.triggers.TimerTrigger"=>"0 22 * * *", "hudson.triggers.SCMTrigger"=>"* * * * *"}

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/hudson-remote-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "hudson-remote-api"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dru Ibarra"]
-  s.date = "2012-06-26"
+  s.date = "2012-07-14"
   s.description = "Connect to Hudson's remote web API"
   s.email = "Druwerd@gmail.com"
   s.extra_rdoc_files = [

data/lib/hudson-remote-api.rb

@@ -105,24 +105,25 @@ module Hudson
     end
     
     def self.fetch_crumb
-      body = get_xml(url_for '/crumbIssuer/api/xml')
-      doc = REXML::Document.new(body)
-      
-      crumbValue = doc.elements['/defaultCrumbIssuer/crumb'] or begin
-        $stderr.puts "Failure fetching crumb value from server"
-        return
-      end
-      
-      crumbName = doc.elements['/defaultCrumbIssuer/crumbRequestField'] or begin
-        $stderr.puts "Failure fetching crumb field name from server"
-        return
+      if Hudson[:crumb]
+        body = get_xml(url_for '/crumbIssuer/api/xml')
+        doc  = REXML::Document.new(body)
+
+        crumbValue = doc.elements['/defaultCrumbIssuer/crumb'] or begin
+          $stderr.puts "Failure fetching crumb value from server"
+          return
+        end
+
+        crumbName = doc.elements['/defaultCrumbIssuer/crumbRequestField'] or begin
+          $stderr.puts "Failure fetching crumb field name from server"
+          return
+        end
+
+        @@apiCrumb = Struct.new(:name,:value).new(crumbName.text,crumbValue.text)
       end
-      
-      @@apiCrumb = Struct.new(:name,:value).new(crumbName.text,crumbValue.text)
     rescue
         $stderr.puts "Failure fetching crumb xml"
     end
-    
   end
 end
 

data/lib/hudson-remote-api/config.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/multicast.rb'
 
 module Hudson
   # set default settings
-  @@settings = {:url => 'http://localhost:8080', :user => nil, :password => nil, :version => nil}
+  @@settings = {:url => 'http://localhost:8080', :user => nil, :password => nil, :version => nil, :crumb => true}
   
   def self.[](param)
     return @@settings[param]

data/lib/hudson-remote-api/job.rb

@@ -1,10 +1,7 @@
 module Hudson
     # This class provides an interface to Hudson jobs
     class Job < HudsonObject
-
         attr_accessor :name, :config, :repository_url, :repository_urls, :repository_browser_location, :description
-        attr_reader :color, :last_build, :last_completed_build, :last_failed_build, :last_stable_build, :last_successful_build, :last_unsuccessful_build, :next_build_number
-        attr_reader :builds_list
         
 SVN_SCM_CONF = <<-SVN_SCM_STRING
   <scm class="hudson.scm.SubversionSCM">
@@ -23,59 +20,58 @@ SVN_SCM_CONF = <<-SVN_SCM_STRING
   </scm>
 SVN_SCM_STRING
         
-        
-        # List all Hudson jobs
-        def self.list()
-            xml = get_xml(@@hudson_xml_api_path)
-            
-            jobs = []
-            jobs_doc = REXML::Document.new(xml)
-            jobs_doc.each_element("hudson/job") do |job|
-                jobs << job.elements["name"].text
-            end
-            jobs
-        end
-        
-        # List all jobs in active execution
-        def self.list_active
-            xml = get_xml(@@hudson_xml_api_path)
-            
-            active_jobs = []
-            jobs_doc = REXML::Document.new(xml)
-            jobs_doc.each_element("hudson/job") do |job|
-                if job.elements["color"].text.include?("anime")
-                    active_jobs << job.elements["name"].text
-                end
-            end
-            active_jobs
-        end
-        
-        def self.get(job_name)
-          job_name.strip!
-          if list.include?(job_name)
-            Job.new(job_name)
-          else
-            nil
+        # Class methods
+        class <<self
+          # List all Hudson jobs
+          def list()
+              xml = get_xml(@@hudson_xml_api_path)
+
+              jobs = []
+              jobs_doc = REXML::Document.new(xml)
+              jobs_doc.each_element("hudson/job") do |job|
+                  jobs << job.elements["name"].text
+              end
+              jobs
+          end
+          
+          # List all jobs in active execution
+          def list_active
+              xml = get_xml(@@hudson_xml_api_path)
+
+              active_jobs = []
+              jobs_doc = REXML::Document.new(xml)
+              jobs_doc.each_element("hudson/job") do |job|
+                  if job.elements["color"].text.include?("anime")
+                      active_jobs << job.elements["name"].text
+                  end
+              end
+              active_jobs
+          end
+          
+          def get(job_name)
+            job_name.strip!
+            list.include?(job_name) ? Job.new(job_name) : nil
           end
+          
+          def create(name, config=nil)
+            config ||= File.open(File.dirname(__FILE__) + '/new_job_config.xml').read
+
+            response = send_post_request(@@xml_api_create_item_path, {:name=>name, :mode=>"hudson.model.FreeStyleProject", :config=>config})
+            raise(APIError, "Error creating job #{name}: #{response.body}") if response.class != Net::HTTPFound
+            Job.get(name)
+          end
+          
         end
-        
+
+        # Instance methods
         def initialize(name, config=nil)
             name.strip!
             Hudson::Job.fetch_crumb
-            if Job.list.include?(name) # job already in Jenkins
-              @name = name
-              load_xml_api
-              load_config
-              load_info
-              self
-            else
-              j = Job.create(name, config)
-              @name = j.name
-              load_xml_api
-              load_config
-              load_info
-              self
-            end
+            # Creates the job in Hudson if it doesn't already exist
+            @name = Job.list.include?(name) ? name : Job.create(name, config).name
+            load_xml_api
+            load_config
+            self
         end
         
         def load_xml_api
@@ -92,6 +88,9 @@ SVN_SCM_STRING
         def load_config
             @config = get_xml(@xml_api_config_path)
             @config_doc = REXML::Document.new(@config)
+            
+            @info = get_xml(@xml_api_path)
+            @info_doc = REXML::Document.new(@info)
 
             @repository_urls = []
             if @config_doc.elements["/project/description"]
@@ -123,25 +122,46 @@ SVN_SCM_STRING
             end
         end
         
-        def load_info()
-            @info = get_xml(@xml_api_path)
-            @info_doc = REXML::Document.new(@info)
-            
-            if @info_doc.elements["/freeStyleProject"]
-              @color = @info_doc.elements["/freeStyleProject/color"].text if @info_doc.elements["/freeStyleProject/color"]
-              @last_build = @info_doc.elements["/freeStyleProject/lastBuild/number"].text if @info_doc.elements["/freeStyleProject/lastBuild/number"]
-              @last_completed_build = @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"].text if @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"]
-              @last_failed_build = @info_doc.elements["/freeStyleProject/lastFailedBuild/number"].text if @info_doc.elements["/freeStyleProject/lastFailedBuild/number"]
-              @last_stable_build = @info_doc.elements["/freeStyleProject/lastStableBuild/number"].text if @info_doc.elements["/freeStyleProject/lastStableBuild/number"]
-              @last_successful_build = @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"].text if @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"]
-              @last_unsuccessful_build = @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"].text if @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"]
-              @next_build_number = @info_doc.elements["/freeStyleProject/nextBuildNumber"].text if @info_doc.elements["/freeStyleProject/nextBuildNumber"]
-            end
-            
-            if !@info_doc.elements["/freeStyleProject/build"].nil?
-                @builds_list = []
-                @info_doc.elements.each("/freeStyleProject/build"){|e| @builds_list << e.elements["number"].text }
-            end
+        def free_style_project?
+          !@info_doc.elements["/freeStyleProject"].nil?
+        end
+        
+        def color
+          @info_doc.elements["/freeStyleProject/color"].text if free_style_project? && @info_doc.elements["/freeStyleProject/color"]
+        end
+        
+        def last_build
+          @info_doc.elements["/freeStyleProject/lastBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastBuild/number"]
+        end
+        
+        def last_completed_build
+          @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"]
+        end
+        
+        def last_failed_build
+          @info_doc.elements["/freeStyleProject/lastFailedBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastFailedBuild/number"]
+        end
+        
+        def last_stable_build
+          @info_doc.elements["/freeStyleProject/lastStableBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastStableBuild/number"]
+        end
+        
+        def last_successful_build
+          @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"]
+        end
+        
+        def last_unsuccessful_build
+          @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"].text if free_style_project? && @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"]
+        end
+        
+        def next_build_number
+          @info_doc.elements["/freeStyleProject/nextBuildNumber"].text if free_style_project? && @info_doc.elements["/freeStyleProject/nextBuildNumber"]
+        end
+        
+        def builds_list
+          builds_list = []
+          @info_doc.elements.each("/freeStyleProject/build"){|e| builds_list << e.elements["number"].text } unless @info_doc.elements["/freeStyleProject/build"].nil?
+          builds_list
         end
         
         def active?
@@ -156,14 +176,6 @@ SVN_SCM_STRING
             end
         end
         
-        def self.create(name, config=nil)
-          config = File.open(File.dirname(__FILE__) + '/new_job_config.xml').read if config.nil?
-          
-          response = send_post_request(@@xml_api_create_item_path, {:name=>name, :mode=>"hudson.model.FreeStyleProject", :config=>config})
-          raise(APIError, "Error creating job #{name}: #{response.body}") if response.class != Net::HTTPFound
-          Job.get(name)
-        end
-        
         # Create a new job on Hudson server based on the current job object
         def copy(new_job=nil)
             new_job = "copy_of_#{@name}" if new_job.nil?
@@ -202,7 +214,6 @@ SVN_SCM_STRING
             end
 
             @config = @config_doc.to_s
-
             update
         end
         
@@ -242,6 +253,51 @@ SVN_SCM_STRING
             update
         end
 
+        def generate_trigger trigger, spec_text
+          spec = REXML::Element.new("spec")
+          spec.text = spec_text.to_s
+          trigger.elements << spec
+          trigger
+        end
+        private :generate_trigger
+
+        def triggers= opts={}
+          opts = {} if opts.nil?
+          if triggers = @config_doc.elements["/project/triggers[@class='vector']"]
+            triggers.elements.delete_all '*'
+            opts.each do |key, value|
+              trigger_name = key.to_s
+              trigger_name = 'hudson.triggers.' + trigger_name unless Regexp.new(/^hudson\.triggers\./).match(trigger_name)
+              if trigger = triggers.elements[trigger_name]
+                if spec = trigger.elements['spec']
+                  spec.text = value.to_s
+                else
+                  triggers.elements << generate_trigger(trigger, value)
+                end
+              else
+                triggers.elements << generate_trigger(REXML::Element.new(trigger_name), value)
+              end
+            end
+            # Todo: before calling update, @config need to be assigned with @config_doc.to_s,
+            #       let it be done by update.
+            @config = @config_doc.to_s
+            update
+          else
+            $stderr.puts "triggers not found in configuration, triggers assignment ignored."
+          end
+        end
+
+        def triggers
+          results = {}
+          if triggers = @config_doc.elements["/project/triggers[@class='vector']"]
+            triggers.elements.to_a.each do |trigger|
+              spec_text = trigger.elements['spec'].text
+              results[trigger.name.to_s] = spec_text.to_s
+            end
+          end
+          results
+        end
+
         def url
           File.join( Hudson[:url], 'job', name) + '/'
         end

data/test/test_hudson_config.rb

@@ -21,10 +21,17 @@ class TestHudsonConfig < Test::Unit::TestCase
     assert_equal(Hudson[:user], "test")
     assert_equal(Hudson[:password], "test")
     assert_equal(Hudson[:version], "1.00")
+    assert_equal(Hudson[:crumb], true)
   end
   
   def test_auto_config
     assert_nothing_thrown{ Hudson.auto_config }
   end
+
+  def test_when_crumb_is_false
+    new_settings = {:url => 'test.com', :user => 'test', :password => 'test', :version => '1.00', :crumb => false}
+    Hudson.settings = new_settings
+    assert_equal(Hudson[:crumb], false)
+  end
   
-end
+end

data/test/test_hudson_job.rb

@@ -22,6 +22,7 @@ class TestHudsonJob < Test::Unit::TestCase
     new_job = Hudson::Job.create(new_job_name)
     assert new_job
     assert_equal(new_job.name, new_job_name)
+    assert_equal(true, new_job.triggers.empty?, "New job should have empty triggers")
     assert new_job.delete
   end
   
@@ -81,4 +82,37 @@ class TestHudsonJob < Test::Unit::TestCase
     job = Hudson::Job.get("test_job")
     assert job.builds_list.kind_of?(Array)
   end
+
+  def test_triggers_set
+    job_name = 'build_triggers'
+    job = Hudson::Job.create(job_name)
+
+    job.triggers = { "hudson.triggers.SCMTrigger" => '* * * * *' }
+    assert_equal(1, job.triggers.size, "Failed to set triggers with 1 trigger.")
+    assert_equal({"hudson.triggers.SCMTrigger" => '* * * * *'}, job.triggers, "Failed to set triggers with 1 trigger.")
+
+    assert job.delete
+  end
+
+  def test_triggers_set_using_shortcut
+    job_name = 'build_triggers'
+    job = Hudson::Job.create(job_name)
+
+    job.triggers = { "SCMTrigger" => '* * * * *', 'TimerTrigger' => '0 22 * * *' }
+    assert_equal(2, job.triggers.size, "Failed to set triggers using shortcut.")
+    assert_equal({"hudson.triggers.SCMTrigger"=>"* * * * *", "hudson.triggers.TimerTrigger"=>"0 22 * * *"}, job.triggers, "Failed to set triggers using shortcut.")
+
+    assert job.delete
+  end
+
+  def test_triggers_delete
+    job_name = 'build_triggers'
+    job = Hudson::Job.create(job_name)
+
+    job.triggers = { "SCMTrigger" => '* * * * *', 'TimerTrigger' => '0 22 * * *' }
+    job.triggers = {}
+    assert_equal(true, job.triggers.empty?, "Failed to delete triggers.")
+
+    assert job.delete
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hudson-remote-api
 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-06-26 00:00:00.000000000 Z
+date: 2012-07-14 00:00:00.000000000 Z
 dependencies: []
 description: Connect to Hudson's remote web API
 email: Druwerd@gmail.com