jenkins-capistrano 0.0.7 → 0.1.0

data/jenkins-capistrano.gemspec

@@ -15,10 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Jenkins::Capistrano::VERSION
 
-  gem.add_dependency 'capistrano'
-  gem.add_dependency 'httparty',  '~> 0.8.3'
-  gem.add_dependency 'hpricot'
+  gem.add_dependency 'capistrano', '< 3.0.0'
+  gem.add_dependency 'jenkins_api_client', '>= 1.0.0'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'tapp'
+  gem.add_development_dependency 'aruba'
 end

data/lib/jenkins-capistrano.rb

@@ -1,216 +1,3 @@
 require 'jenkins-capistrano/version'
-require 'jenkins-capistrano/client'
-
-def _cset(name, *args, &block)
-  unless exists?(name)
-    set(name, *args, &block)
-  end
-end
-
-# Capistrano task for Jenkins.
-#
-# 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'" }
-
-  _cset(:jenkins_username) { '' }
-  _cset(:jenkins_password) { '' }
-
-  _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) { [] }
-
-  def client
-    @client ||= Jenkins::Client.new(jenkins_host, { :username => jenkins_username,  :password => jenkins_password})
-  end
-
-  def job_configs
-    abort "Please create the jenkins_job_config_dir first: #{jenkins_job_config_dir}" unless Dir.exists? jenkins_job_config_dir
-    Dir.glob("#{jenkins_job_config_dir}/*.xml")
-  end
-
-  def node_configs
-    abort "Please create the jenkins_node_config_dir first: #{jenkins_node_config_dir}" unless Dir.exists? jenkins_node_config_dir
-    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'
-  namespace :jenkins do
-
-    desc <<-DESC
-      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: []
-
-    DESC
-    task :deploy_jobs do
-      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))
-        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 --
-
-      Configuration
-      -------------
-      jenkins_node_config_dir
-          the directory path where the node's configuration stored.
-          default: 'config/jenkins/nodes'
-    DESC
-    task :config_nodes do
-      logger.info "configuring jenkins nodes to #{jenkins_host}"
-      logger.important "no node configs found." if node_configs.empty?
-      node_configs.each do |file|
-        name = File.basename(file, '.json')
-        opts = JSON.parse(File.read(file)).to_hash.
-          inject({}) { |mem, (key, val)| mem[key.to_sym] = val; mem }
-        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
+require 'jenkins-capistrano/configurator'
+require 'jenkins-capistrano/tasks'

data/lib/jenkins-capistrano/configurator.rb

@@ -0,0 +1,87 @@
+require 'jenkins-capistrano/template'
+require 'jenkins_api_client'
+
+module Jenkins
+  module Capistrano
+    class Configurator
+
+      attr_reader :logger, :client, :job_config_dir, :node_config_dir, :view_config_dir, :template_vars
+
+      def initialize(options = {})
+        opts = {:log_location => '/dev/null'}.merge(options)
+        @logger = opts.delete(:logger)
+        @template_vars = opts.delete(:template_vars)
+        @client = JenkinsApi::Client.new(opts)
+      end
+
+      def configure_jobs(config_files, disabled_jobs)
+        if config_files.empty?
+          logger.important "no node configs found."
+          return
+        end
+
+        config_files.each do |file|
+          name = name_for(file)
+          client.job.create_or_update(name, config_xml_for(file))
+          logger.trace "job #{name} created."
+          if disabled_jobs.include? name
+            client.job.disable(name)
+            logger.trace "  -> disabled"
+          end
+        end
+      end
+
+      def configure_nodes(config_files)
+        if config_files.empty?
+          logger.important "no node configs found."
+          return
+        end
+
+        config_files.each do |file|
+          name = name_for(file)
+          unless client.node.list.include? name
+            params =  { :name => name, :slave_host => 'dummy-by-jenkins-capistrano', :private_key_file => 'dummy' }
+            client.node.create_dumb_slave(params)
+          end
+          client.node.post_config(name, config_xml_for(file))
+          logger.trace "node #{name} created."
+        end
+      end
+
+      def configure_views(config_files)
+        if config_files.empty?
+          logger.important "no view configs found."
+          return
+        end
+
+        config_files.each do |file|
+          name = name_for(file)
+          unless client.view.exists? name
+            client.view.create name
+          end
+          client.view.post_config(name, config_xml_for(file))
+          logger.trace "view #{name} created."
+        end
+      end
+
+      private
+      def name_for(file_path)
+        file_path.basename.to_s.split('.').first
+      end
+
+      def config_xml_for(file)
+        config_xml = if file.extname == '.erb'
+                       Jenkins::Template.new(file, template_vars).evaluate
+                     else
+                       file.read
+                     end
+        Nokogiri::XML(config_xml) do |config|
+          config.options = Nokogiri::XML::ParseOptions::STRICT
+        end.to_xml
+      rescue => e
+        abort "`#{file}` is not well-formed, put `.erb` as extname if it's erb template: #{e.message}"
+      end
+
+    end
+  end
+end

data/lib/jenkins-capistrano/tasks.rb

@@ -0,0 +1,112 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  _cset(:jenkins_host) { abort "Please specify the host of your jenkins server, set :jenkins_host, 'http://localhost:8080'" }
+
+  _cset(:jenkins_username) { '' }
+  _cset(:jenkins_password) { '' }
+
+  _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(:disabled_jobs) { [] }
+
+  _cset(:jenkins_template_vars) { {} }
+
+  def configurator
+    @configurator ||= Jenkins::Capistrano::Configurator.new(
+      :logger        => logger,
+      :server_url    => jenkins_host,
+      :username      => jenkins_username,
+      :password      => jenkins_password,
+      :template_vars => jenkins_template_vars
+    )
+  end
+
+  %w(job node view).each do |name|
+    instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{name}_configs
+        config_dir = fetch('jenkins_#{name}_config_dir'.to_sym)
+        abort "Please create the jenkins_#{name}_config_dir first: \#{config_dir}" unless Dir.exists? config_dir
+        Pathname.glob(File.join(config_dir, '/*.{xml,erb}'))
+      end
+    RUBY
+  end
+
+  # minimum configurations
+  #
+  #   role :jenkins, 'localhost:8080'
+  namespace :jenkins do
+
+    desc <<-DESC
+      Configure the jobs to Jenkins server.
+
+      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: []
+    DESC
+    task :config_jobs do
+      logger.info "deploying jenkins jobs to #{jenkins_host}"
+      configurator.configure_jobs(job_configs, disabled_jobs)
+    end
+
+
+    desc <<-DESC
+      [DEPRECATED] Use jenkins:config_jobs instead.
+    DESC
+    task :deploy_jobs do
+      logger.important '[DEPRECATED] Use jenkins:config_jobs instead.'
+      config_jobs
+    end
+
+    desc <<-DESC
+
+    DESC
+    task :reverse_jobs do
+      logger.important '[DEPRECATED] Use jenkins:config_jobs instead.'
+      config_jobs
+    end
+
+    desc <<-DESC
+      Configure the nodes to Jenkins server.
+
+      Configuration
+      -------------
+      jenkins_node_config_dir
+          the directory path where the node's configuration stored.
+          default: 'config/jenkins/nodes'
+    DESC
+    task :config_nodes do
+      logger.info "configuring jenkins nodes to #{jenkins_host}"
+      configurator.configure_nodes(node_configs)
+    end
+
+    desc <<-DESC
+      Configure the views to Jenkins server.
+
+      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}"
+      configurator.configure_views(view_configs)
+    end
+
+  end
+
+end

data/lib/jenkins-capistrano/template.rb

@@ -0,0 +1,20 @@
+
+module Jenkins
+  class Template
+
+    def initialize(template, variables)
+      raise ArgumentError, "Template #{template} does not exist." unless File.exists? template
+      raise ArgumentError, "variables must be a Hash, but was #{variables.class}" unless variables.is_a? Hash
+      @template = template
+      @variables = variables
+    end
+
+    def evaluate
+      @variables.each do |param, value|
+        var = "@#{param.to_s}"
+        instance_variable_set(var, value)
+      end
+      ERB.new(File.read(@template), 0, '-').result(binding)
+    end
+  end
+end