jenkins-capistrano 0.0.4 → 0.0.5

data/README.rst

@@ -51,6 +51,17 @@ deploy.rb::
 
   before 'deploy', 'jenkins:deploy_jobs'
 
+Want to disabling some jobs for specific environment?
+-----------------------------------------------------
+
+Since 0.0.5, you can disabling jobs using `disabled_jobs` option.
+Use this option with `multistage-extension <https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension>`_.
+
+Put the following line into `config/deploy/<env>.rb`::
+
+  set :disabled_jobs, %w(job1 job2)
+
+
 Node Configuration
 ~~~~~~~~~~~~~~~~~~
 

data/lib/jenkins-capistrano.rb

@@ -9,7 +9,7 @@ end
 
 # Capistrano task for Jenkins.
 #
-# Just add "require 'jenkins-capistrano'" in your Capistrano deploy.rb, and
+# Just add "require 'jenkins-capistrano'" in your Capistrano deploy.rb
 Capistrano::Configuration.instance(:must_exist).load do
 
   _cset(:jenkins_host) { abort "Please specify the host of your jenkins server, set :jenkins_host, 'http://localhost:8080'" }
@@ -20,6 +20,8 @@ Capistrano::Configuration.instance(:must_exist).load do
   _cset(:jenkins_job_config_dir) { 'config/jenkins/jobs' }
   _cset(:jenkins_node_config_dir) { 'config/jenkins/nodes' }
 
+  _cset(:disabled_jobs) { [] }
+
   def client
     @client ||= Jenkins::Client.new(jenkins_host, { :username => jenkins_username,  :password => jenkins_password})
   end
@@ -40,31 +42,48 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :jenkins do
 
     desc <<-DESC
-    Deploy the jobs to Jenkins server -- meaning create or update --
+      Deploy the jobs to Jenkins server -- meaning create or update --
+
+      Configuration
+      -------------
+      jenkins_job_config_dir
+          the directory path where the config.xml stored.
+          default: 'config/jenkins/jobs'
+
+      disabled_jobs
+          job names array which should be disabled after deployment.
+          default: []
 
-      set :jenkins_job_config_dir,      'config/jenkins/jobs'
-      set :jenkins_job_deploy_strategy, :clean | :merge
     DESC
     task :deploy_jobs do
-      strategy = fetch(:jenkins_job_deploy_strategy, :clean)
       logger.info "deploying jenkins jobs to #{jenkins_host}"
       logger.important "no job configs found." if job_configs.empty?
       job_configs.each do |file|
         name = File.basename(file, '.xml')
+        msg = StringIO.new
+
         client.create_or_update_job(name, File.read(file))
-        logger.trace "job #{name} created."
+        msg << "job #{name} created"
+
+        if disabled_jobs.include? name
+          client.disable_job(name)
+          msg << ", but was set to disabled"
+        end
+        msg << "."
+        logger.trace msg.string
       end
-
     end
 
     desc <<-DESC
-    Configure the nodes to Jenkins server -- meaning create or update --
+      Configure the nodes to Jenkins server -- meaning create or update --
 
-      set :jenkins_node_config_dir,      'config/jenkins/nodes'
-      set :jenkins_node_deploy_strategy, :clean | :merge
+      Configuration
+      -------------
+      jenkins_node_config_dir
+          the directory path where the node's configuration stored.
+          default: 'config/jenkins/nodes'
     DESC
     task :config_nodes do
-      strategy = fetch(:jenkins_node_deploy_strategy, :clean)
       logger.info "configuring jenkins nodes to #{jenkins_host}"
       logger.important "no node configs found." if node_configs.empty?
       node_configs.each do |file|

data/lib/jenkins-capistrano/client.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 require 'cgi/util'
 require 'json'
+require 'jenkins-capistrano/client/node'
+require 'jenkins-capistrano/client/job'
 
 module Jenkins
   class Client
@@ -16,137 +18,15 @@ module Jenkins
       self.class.basic_auth opts[:username], opts[:password] if opts[:username] and opts[:password]
     end
 
-    def create_job(name, config)
-      res = self.class.post("/createItem/api/xml?name=#{CGI.escape(name)}", xml_body(config))
-      raise ServerError, parse_error_message(res) unless res.code.to_i == 200
-    rescue => e
-      raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
-    end
-
-    def update_job(name, config)
-      res = self.class.post("/job/#{CGI.escape(name)}/config.xml", xml_body(config))
-      raise ServerError, parse_error_message(res) unless res.code.to_i == 200
-    rescue => e
-      raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
-    end
-
-    def create_or_update_job(name, config)
-      begin
-        create_job(name, config)
-      rescue ServerError => e
-        update_job(name, config)
-      end
-    end
-
-    def add_node(name, opts = {})
-      options = default_node_options.merge(opts)
-      options[:name] = name
-      options[:labels] = options[:labels].split(/\s*,\s*/).join(' ') if options[:labels]
-      options[:env_vars] = options[:env_vars].map { |k, v| { :key => k, :value => v } }
-
-      response = post_form("/computer/doCreateItem", node_form_fields(options))
-      case response
-      when Net::HTTPFound
-        { :name => name, :slave_host => options[:slave_host] }
-      else
-        raise ServerError, parse_error_message(response)
-      end
-    end
-
-    def update_node(name, opts = {})
-      options = default_node_options.merge(opts)
-      options[:name] = name
-      options[:labels] = options[:labels].split(/\s*,\s*/).join(' ') if options[:labels]
-      options[:env_vars] = options[:env_vars].map { |k, v| { :key => k, :value => v } }
-
-      response = post_form("/computer/#{CGI::escape(name)}/configSubmit", node_form_fields(options))
-      case response
-      when Net::HTTPFound
-        { :name => name, :slave_host => options[:slave_host] }
-      else
-        raise ServerError, parse_error_message(response)
-      end
-    end
-
-    def config_node(name, opts = {})
-      begin
-        add_node(name, opts)
-      rescue ServerError => e
-        update_node(name, opts)
-      end
-    end
-
-    private
-    def xml_body(xml_str)
-      {
-        :body => xml_str,
-        :format => :xml,
-        :headers => { 'content-type' => 'application/xml' }
-      }
-    end
-
     def parse_error_message(response)
       require "hpricot"
       doc = Hpricot(response.body)
       error_msg = doc.search("td#main-panel p")
-      error_msg.inner_text.empty? ? "Server error: code=#{response.code}, #{response.body}" : error_msg
+      error_msg.inner_text.empty? ? doc.search("body").text : error_msg
     end
 
-    def post_form(path, fields)
-      url = URI.parse("#{self.class.base_uri}/#{path}")
-      req = Net::HTTP::Post.new(url.path)
-
-      basic_auth = self.class.default_options[:basic_auth]
-      req.basic_auth basic_auth[:username], basic_auth[:password] if basic_auth
-
-      req.set_form_data(fields)
-      http = Net::HTTP.new(url.host, url.port)
-      http.request(req)
-    end
-
-    def default_node_options
-      {
-        :slave_port  => 22,
-        :slave_user  => 'jenkins',
-        :master_key  => "/var/lib/jenkins/.ssh/id_rsa",
-        :slave_fs    => "/data/jenkins-slave/",
-        :description => "Automatically created by capistrano-jenkins",
-        :executors   => 2,
-        :exclusive   => true
-      }
-    end
-
-    def node_form_fields(options = {})
-      {
-        "name" => options[:name],
-        "type" => "hudson.slaves.DumbSlave$DescriptorImpl",
-        "json" => {
-          "name"              => options[:name],
-          "type"              => "hudson.slaves.DumbSlave$DescriptorImpl",
-          "nodeDescription"   => options[:description],
-          "numExecutors"      => options[:executors],
-          "remoteFS"          => options[:slave_fs],
-          "labelString"       => options[:labels],
-          "mode"              => options[:exclusive] ? "EXCLUSIVE" : "NORMAL",
-          "retentionStrategy" => { "stapler-class"  => "hudson.slaves.RetentionStrategy$Always" },
-          "launcher"          => {
-            "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
-            "host"          => options[:slave_host],
-            "port"          => options[:slave_port],
-            "username"      => options[:slave_user],
-            "privatekey"    => options[:master_key],
-            "javaPath"      => options[:java_path],
-            "jvmOptions"    => options[:jvm_options]
-          },
-          "nodeProperties"    => {
-            "stapler-class-bag" => "true",
-            "hudson-slaves-EnvironmentVariablesNodeProperty" => {
-              "env" => options[:env_vars]
-            }
-          }
-        }.to_json
-      }
-    end
+    include Node
+    include Job
 
   end
 end

data/lib/jenkins-capistrano/client/job.rb

@@ -0,0 +1,47 @@
+
+module Jenkins
+  class Client
+    module Job
+
+      def job_names
+        self.class.get("/api/json")['jobs'].map {|job| job['name'] }
+      end
+
+      def create_job(name, config)
+        res = self.class.post("/createItem/api/xml?name=#{CGI.escape(name)}", xml_body(config))
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+      rescue => e
+        raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
+      end
+
+      def update_job(name, config)
+        res = self.class.post("/job/#{CGI.escape(name)}/config.xml", xml_body(config))
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+      rescue => e
+        raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
+      end
+
+      def create_or_update_job(name, config)
+        job_names.include?(name) ? update_job(name, config) : create_job(name, config)
+      end
+
+      def disable_job(name)
+        res = self.class.post("/job/#{CGI.escape(name)}/disable")
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+      rescue => e
+        raise ServerError, "Failed to create job: #{name}, make sure you have specified auth info properly"
+      end
+
+      private
+      def xml_body(xml_str)
+        {
+          :body => xml_str,
+          :format => :xml,
+          :headers => { 'content-type' => 'application/xml' }
+        }
+      end
+
+    end
+  end
+end
+

data/lib/jenkins-capistrano/client/node.rb

@@ -0,0 +1,103 @@
+
+module Jenkins
+  class Client
+    module Node
+
+      def node_names
+        self.class.get("/computer/api/json")['computer'].map {|computer| computer['displayName'] }
+      end
+
+      def add_node(name, opts = {})
+        options = default_node_options.merge(opts)
+        options[:name] = name
+        options[:labels] = options[:labels].split(/\s*,\s*/).join(' ') if options[:labels]
+        options[:env_vars] = options[:env_vars].map { |k, v| { :key => k, :value => v } }
+
+        response = post_form("/computer/doCreateItem", node_form_fields(options))
+        case response
+        when Net::HTTPFound
+          { :name => name, :slave_host => options[:slave_host] }
+        else
+          raise ServerError, parse_error_message(response)
+        end
+      end
+
+      def update_node(name, opts = {})
+        options = default_node_options.merge(opts)
+        options[:name] = name
+        options[:labels] = options[:labels].split(/\s*,\s*/).join(' ') if options[:labels]
+        options[:env_vars] = options[:env_vars].map { |k, v| { :key => k, :value => v } }
+
+        response = post_form("/computer/#{CGI::escape(name)}/configSubmit", node_form_fields(options))
+        case response
+        when Net::HTTPFound
+          { :name => name, :slave_host => options[:slave_host] }
+        else
+          raise ServerError, parse_error_message(response)
+        end
+      end
+
+      def config_node(name, opts = {})
+        node_names.include?(name) ? update_node(name, config) : add_node(name, config)
+      end
+
+      private
+      def post_form(path, fields)
+        url = URI.parse("#{self.class.base_uri}/#{path}")
+        req = Net::HTTP::Post.new(url.path)
+
+        basic_auth = self.class.default_options[:basic_auth]
+        req.basic_auth basic_auth[:username], basic_auth[:password] if basic_auth
+
+        req.set_form_data(fields)
+        http = Net::HTTP.new(url.host, url.port)
+        http.request(req)
+      end
+
+      def default_node_options
+        {
+          :slave_port  => 22,
+          :slave_user  => 'jenkins',
+          :master_key  => "/var/lib/jenkins/.ssh/id_rsa",
+          :slave_fs    => "/data/jenkins-slave/",
+          :description => "Automatically created by capistrano-jenkins",
+          :executors   => 2,
+          :exclusive   => true
+        }
+      end
+
+      def node_form_fields(options = {})
+        {
+          "name" => options[:name],
+          "type" => "hudson.slaves.DumbSlave$DescriptorImpl",
+          "json" => {
+            "name"              => options[:name],
+            "type"              => "hudson.slaves.DumbSlave$DescriptorImpl",
+            "nodeDescription"   => options[:description],
+            "numExecutors"      => options[:executors],
+            "remoteFS"          => options[:slave_fs],
+            "labelString"       => options[:labels],
+            "mode"              => options[:exclusive] ? "EXCLUSIVE" : "NORMAL",
+            "retentionStrategy" => { "stapler-class"  => "hudson.slaves.RetentionStrategy$Always" },
+            "launcher"          => {
+              "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
+              "host"          => options[:slave_host],
+              "port"          => options[:slave_port],
+              "username"      => options[:slave_user],
+              "privatekey"    => options[:master_key],
+              "javaPath"      => options[:java_path],
+              "jvmOptions"    => options[:jvm_options]
+            },
+            "nodeProperties"    => {
+              "stapler-class-bag" => "true",
+              "hudson-slaves-EnvironmentVariablesNodeProperty" => {
+                "env" => options[:env_vars]
+              }
+            }
+          }.to_json
+        }
+      end
+    end
+  end
+end
+

data/lib/jenkins-capistrano/version.rb

@@ -1,5 +1,5 @@
 module Jenkins
   module Capistrano
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins-capistrano
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-24 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -106,6 +106,8 @@ files:
 - jenkins-capistrano.gemspec
 - lib/jenkins-capistrano.rb
 - lib/jenkins-capistrano/client.rb
+- lib/jenkins-capistrano/client/job.rb
+- lib/jenkins-capistrano/client/node.rb
 - lib/jenkins-capistrano/version.rb
 homepage: https://github.com/cynipe/jenkins-capistrano
 licenses: []
@@ -119,18 +121,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2200036594680116764
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2200036594680116764
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -138,3 +134,4 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files: []
+has_rdoc: