jenkins-capistrano 0.0.5.2 → 0.0.6

data/README.rst

@@ -2,7 +2,12 @@
 jenkins-capistrano
 ==================
 
-The capistrano tasks for Jenkins CI Server
+The capistrano tasks for Jenkins CI Server. Supports to manage following things:
+
+* Job
+* Node
+* View
+* Plugins(Experimental)
 
 Installation
 ============
@@ -110,10 +115,94 @@ deploy.rb::
 
   before 'deploy', 'jenkins:config_nodes'
 
+View Configuration
+~~~~~~~~~~~~~~~~~~
+
+config directory structure(name your json file as a node name)::
+
+  config
+  ├── deploy.rb
+  └── jenkins
+       └── views
+           ├── view1.xml
+           ├── view2.xml
+           └── view3.xml
+
+sample view configuration::
+
+    <listView>
+      <name>view1</name>
+      <filterExecutors>false</filterExecutors>
+      <filterQueue>false</filterQueue>
+      <properties class="hudson.model.View$PropertyList"/>
+      <jobNames class="tree-set">
+        <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+      </jobNames>
+      <jobFilters/>
+      <columns>
+        <hudson.views.StatusColumn/>
+        <hudson.views.WeatherColumn/>
+        <hudson.views.JobColumn/>
+        <hudson.views.LastSuccessColumn/>
+        <hudson.views.LastFailureColumn/>
+        <hudson.views.LastDurationColumn/>
+        <hudson.views.BuildButtonColumn/>
+      </columns>
+      <includeRegex>job.*</includeRegex>
+    </listView>
+
+deploy.rb::
+
+  set :application, "your-awesome-app"
+  set :scm, :git
+  set :repository,  "https://github.com/your/repository.git"
+
+  set :jenkins_host, 'http://localhost:8080'
+  # set :jenkins_username, '' # default empty
+  # set :jenkins_password, '' # default empty
+  # set :jenkins_node_config_dir, 'config/jenkins/nodes'
+
+  before 'deploy', 'jenkins:config_views'
+
+
+Don't know how to write config.xml for view?
+--------------------------------------------
+
+Create or configure the view you want to manage via usual operation through the Jenkins UI.
+Then, open the `JENKINS_HOME/config.xml` and copy the desired configuration from `<views>` section, and
+ommit `<owner class="hudson" reference="../../.."/>` line.
+
+Plugin Configuration(experimental)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Note
+----
+
+This feature is may change its API without any notice.
+Use at your own risk.
+
+deploy.rb::
+
+  set :application, "your-awesome-app"
+  set :scm, :git
+  set :repository,  "https://github.com/your/repository.git"
+
+  set :jenkins_plugins, %w(cron_column envinject join)
+  # you can specify version as follows:
+  # set :jenkins_plugins, %w(cron_column@1.1.2 envinject join@1.0.0)
+  set :jenkins_install_timeout, 60 * 5      # default: 5min
+  set :jenkins_plugin_enable_update, false  # dafault: false
+  set :jenkins_plugin_enable_restart, false # default: false
+
+  before 'deploy', 'jenkins:install_plugins'
 
 Release Notes
 =============
 
+0.0.6
+  * Support view management (`726ad3ef <https://github.com/cynipe/jenkins-capistrano/commit/726ad3ef817ba15a2d66503ce0dd4bc961ed92e2>`_)
+  * Support plugin management(Experimental) (`4d9964c0 <https://github.com/cynipe/jenkins-capistrano/commit/4d9964c00ff95798915484ceb8b5c837b2aa03e8>`_)
+
 0.0.5.2
   * Fix cgi library loading error
 

data/lib/jenkins-capistrano.rb

@@ -19,6 +19,12 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   _cset(:jenkins_job_config_dir) { 'config/jenkins/jobs' }
   _cset(:jenkins_node_config_dir) { 'config/jenkins/nodes' }
+  _cset(:jenkins_view_config_dir) { 'config/jenkins/views' }
+
+  _cset(:jenkins_plugins) { [] }
+  _cset(:jenkins_install_timeout) { 60 * 5 }
+  _cset(:jenkins_plugin_enable_update) { false }
+  _cset(:jenkins_plugin_enable_restart) { false }
 
   _cset(:disabled_jobs) { [] }
 
@@ -36,6 +42,20 @@ Capistrano::Configuration.instance(:must_exist).load do
     Dir.glob("#{jenkins_node_config_dir}/*.json")
   end
 
+  def view_configs
+    abort "Please create the jenkins_view_config_dir first: #{jenkins_node_config_dir}" unless Dir.exists? jenkins_node_config_dir
+    Dir.glob("#{jenkins_view_config_dir}/*.xml")
+  end
+
+  def missing_plugins
+    installed = client.plugin_names
+    jenkins_plugins.select do |plugin|
+      missing = !installed.include?(plugin.split('@'))
+      logger.info "#{plugin} is already installed." unless missing
+      missing
+    end
+  end
+
   # minimum configurations
   #
   #   role :jenkins, 'localhost:8080'
@@ -93,9 +113,104 @@ Capistrano::Configuration.instance(:must_exist).load do
         client.config_node(name, opts)
         logger.trace "node #{name} created."
       end
+    end
+
+    desc <<-DESC
+      Configure the views to Jenkins server -- meaning create or update --
 
+      Configuration
+      -------------
+      jenkins_view_config_dir
+          the directory path where the view's configuration stored.
+          default: 'config/jenkins/views'
+    DESC
+    task :config_views do
+      logger.info "configuring jenkins views to #{jenkins_host}"
+      logger.important "no view configs found." if view_configs.empty?
+      view_configs.each do |file|
+        name = File.basename(file, '.xml')
+        msg = StringIO.new
+        client.create_or_update_view(name, File.read(file))
+        logger.trace "view #{name} created."
+      end
     end
 
+    desc <<-DESC
+      Install plugins to Jenkins server
+
+      Configuration
+      -------------
+      jenkins_plugins
+          the hash array contains plugin's name and version.
+
+      jenkins_install_timeout
+        a timeout seconds to wait for plugin installation.
+        default: 5 min
+
+      jenkins_plugin_enable_update
+        whether to update or ignore when the plugin already installed.
+        default: false
+
+      jenkins_plugin_enable_restart
+        whether to restart or ignore when the plugin installation requires restarting.
+        default: false
+    DESC
+    task :install_plugins do
+      logger.important "installing plugins to #{jenkins_host}"
+      if jenkins_plugins.empty?
+        logger.info "no plugin config found."
+        next
+      end
+
+      logger.info "calcurating plugins to install..."
+      candidates = client.prevalidate_plugin_config(missing_plugins)
+      plugins_to_install = candidates.reduce([]) do |mem, candidate|
+        plugin = "#{candidate['name']}@#{candidate['version']}"
+        mode = candidate['mode']
+        case
+        when mode == 'missing'
+          logger.debug "#{plugin} marked to be installed."
+          mem << candidate
+        when mode == 'old'
+          if jenkins_plugin_enable_update
+            logger.debug "#{plugin} marked to be updated."
+            mem << candidate
+          end
+        end
+        mem
+      end
+      if plugins_to_install.empty?
+        logger.info "all plugins already installed."
+        next
+      end
+
+      logger.info "installing the plugins, this could be take a while..."
+      client.install_plugin(plugins_to_install)
+
+      names = plugins_to_install.map {|v| v['name'] }
+      client.wait_for_complete(jenkins_install_timeout) do |job|
+        result = job['status'] == true
+        # skip unknown jobs
+        if result and names.include?(job['name'])
+          names.delete job['name']
+          logger.debug "#{job['name']}@#{job['version']} installed."
+        end
+        result
+      end
+      logger.info "all plugins successfully installed."
+
+      if client.restart_required?
+        if jenkins_plugin_enable_restart
+          logger.important "restarting jenkins."
+          client.safe_restart! do
+            logger.debug "waiting for Jenkins to restart..."
+          end
+          logger.info "Jenkins is successfully restarted."
+        else
+          logger.important "restarting is disabled, please restart the jenkins manually for complete the installation."
+        end
+      end
+    end
   end
 
 end

data/lib/jenkins-capistrano/client.rb

@@ -3,6 +3,9 @@ require 'cgi'
 require 'json'
 require 'jenkins-capistrano/client/node'
 require 'jenkins-capistrano/client/job'
+require 'jenkins-capistrano/client/view'
+require 'jenkins-capistrano/client/update_center'
+require 'jenkins-capistrano/client/plugin_manager'
 
 module Jenkins
   class Client
@@ -10,8 +13,10 @@ module Jenkins
 
     headers 'content-type' => 'application/json'
     format :json
+    follow_redirects false
 
     ServerError = Class.new(Exception)
+    TimeoutError = Class.new(Exception)
 
     def initialize(host, opts = {})
       self.class.base_uri host
@@ -25,8 +30,36 @@ module Jenkins
       error_msg.inner_text.empty? ? doc.search("body").text : error_msg
     end
 
+    def session
+      self.class.get('/api/json?tree=nothing').headers['X-JENKINS-SESSION']
+    rescue Errno::ECONNRESET, Errno::ECONNREFUSED => e
+      nil
+    end
+
+    def safe_restart!(timeout = 60 * 5)
+      if block_given?
+        due = Time.now + timeout
+        origin = session
+      end
+
+      res = self.class.post("/safeRestart")
+      raise ServerError, parse_error_message(res) unless res.code.to_i == 302
+      return unless block_given?
+
+      loop do
+        new = session
+        break if new and new != origin
+        yield
+        raise TimeoutError, "Restating timeout: #{timeout}" if Time.now > due
+        sleep 5
+      end
+    end
+
     include Node
     include Job
+    include View
+    include UpdateCenter
+    include PluginManager
 
   end
 end

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

@@ -0,0 +1,51 @@
+
+module Jenkins
+  class Client
+    module PluginManager
+
+      def plugin_names
+        self.class.get("/pluginManager/api/json?tree=plugins[shortName]")['plugins'].map {|plugin| plugin['name'] }
+      end
+
+      def prevalidate_plugin_config(plugins)
+        config = generate_config(plugins)
+        res = self.class.post("/pluginManager/prevalidateConfig", xml_body(config))
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+        # why does HTTParty parses the response as xml?
+        JSON.parse(res.body)
+      end
+
+      def install_plugin(plugins, timeout = 60)
+        config = generate_config(plugins)
+        res = self.class.post("/pluginManager/installNecessaryPlugins", xml_body(config))
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 302
+      end
+
+      private
+      def xml_body(xml_str)
+        {
+          :body => xml_str,
+          :format => :xml,
+          :headers => { 'content-type' => 'application/xml' }
+        }
+      end
+
+      def generate_config(config)
+        plugins = config.map do |v|
+          plugin = case
+            when v.instance_of?(String)
+              v.include?('@') ? v : v + '@*'
+            when v.instance_of?(Hash)
+              "#{v['name']}@#{v['version']}"
+            else
+              raise "Unknown value for plugin config: #{v}"
+          end
+          "<installation plugin='#{plugin}' />"
+        end.join("\n")
+        "<installations>#{plugins}</installations>"
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,43 @@
+
+module Jenkins
+  class Client
+    module UpdateCenter
+
+      def installation_jobs
+        job = self.class.get("/updateCenter/api/json?tree=jobs[id,type,status[success],plugin[name,version]]")['jobs']
+        job.reduce([]) do |mem, job|
+          if job['type'] == 'InstallationJob'
+            mem << {
+              'id'      => job['id'],
+              'type'    => job['type'],
+              'status'  => job['status']['success'],
+              'name'    => job['plugin']['name'],
+              'version' => job['plugin']['version']
+            }
+          end
+          mem
+        end
+      end
+
+      def wait_for_complete(timeout = 60 * 5)
+        due = Time.now + timeout
+        loop do
+          complete = installation_jobs.reduce(true) do |comp, job|
+            comp & (block_given? ? yield(job) : job['status'] == true)
+          end
+          break if complete
+          raise TimeoutError, "Installation timeout: #{timeout}" if Time.now > due
+          sleep 1
+        end
+      end
+
+      def restart_required?
+        res = self.class.get("/pluginManager/api/json?tree=restartRequiredForCompletion")
+        raise ServerError, parse_error_message(res) unless res.code.to_i == 200
+        res['restartRequiredForCompletion'] == true
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,40 @@
+
+module Jenkins
+  class Client
+    module View
+
+      def view_names
+        self.class.get("/api/json")['views'].map {|view| view['name'] }
+      end
+
+      def create_view(name, config)
+        res = self.class.post("/createView/?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 view: #{name}, make sure you have specified auth info properly"
+      end
+
+      def update_view(name, config)
+        res = self.class.post("/view/#{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 view: #{name}, make sure you have specified auth info properly"
+      end
+
+      def create_or_update_view(name, config)
+        view_names.include?(name) ? update_view(name, config) : create_view(name, config)
+      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/version.rb

@@ -1,5 +1,5 @@
 module Jenkins
   module Capistrano
-    VERSION = "0.0.5.2"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,95 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jenkins-capistrano
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  - 2
-  version: 0.0.5.2
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - cynipe
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-12 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capistrano
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 3
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hpricot
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The capistrano tasks for Jenkins CI Server
-email: 
+email:
 - cynipe@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -100,36 +108,33 @@ files:
 - lib/jenkins-capistrano/client.rb
 - lib/jenkins-capistrano/client/job.rb
 - lib/jenkins-capistrano/client/node.rb
+- lib/jenkins-capistrano/client/plugin_manager.rb
+- lib/jenkins-capistrano/client/update_center.rb
+- lib/jenkins-capistrano/client/view.rb
 - lib/jenkins-capistrano/version.rb
-has_rdoc: true
 homepage: https://github.com/cynipe/jenkins-capistrano
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ""
+summary: ''
 test_files: []
-
+has_rdoc: