hudson_deployer 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Collin VanDyck
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,5 @@
+LICENSE
+Manifest
+README.md
+Rakefile
+lib/hudson_deployer.rb

data/README.md

@@ -0,0 +1,100 @@
+## Overview
+
+This gem was written to help simplify Java deployments using fat-jar hudson builds.
+
+## Example Capfile
+
+	require 'hudson_deployer'
+
+	set  :hudson, "build.company.com"
+	set  :application, "project"
+	set  :build, "project-release"
+	set  :version, "2.0.0"
+	set  :deployer, "deploy"
+
+	config[:default] = { 
+	  :jdbc_url => "jdbc:mysql://localhost:3306/project" 
+	}
+
+	config[:staging] = {
+	  :user => "cvandyck",
+	  :roles => {
+	    :app => "192.168.185.132"
+	  }
+	}
+
+	config[:production] = {
+	  :user => "admin",
+	  :roles => {
+	    :app => "production-001"
+	  }
+	}
+
+	before :deploy do
+	  if @env == :production
+	    run "#{sudo} apt-get install sun-java6-jdk dbus hal -y"
+	  else
+	    run "#{sudo} apt-get install openjdk-6-jdk dbus hal -y"
+	  end
+	  create_user deployer, :homedir => "/opt/project", :shell => "/bin/sh"
+	  create_directory "/var/log/project"
+	  touch "/var/log/project/sysout.log"
+	end
+
+	after :deploy do
+	  render_template "/etc/project.conf", :template => "project.conf.erb", :mode => "0600"
+	  render_template "/etc/project.jvm.conf", :template => "#{@env}/project.jvm.conf.erb", :mode => "0644"
+	  upstart "/etc/init/project.conf", :template => "upstart.conf.erb"
+	  run "#{sudo} stop project || true"
+	  sleep 5
+	  run "#{sudo} start project"
+	end
+
+## Templates
+
+Templates are kept in a folder called "templates".  They can be named anything, but to make your life easier suffix them with .erb.  Render templates with 
+
+	render_template(/etc/broccoli, :template => "broccoli.erb")
+
+Note that the :template parameter assumes a path relative to the templates folder.
+
+Templates are rendered using the same scope binding as the gem itself. They therefore can access configuration (described below).
+
+## Upstart
+
+Servers are bounced using upstart. In the above example, we use upstart to render an upstart configuration file for our project.  Actual upstart commands are done using the Capistrano run command
+
+## Staging vs Production
+
+It is assumed that unless otherwise specified, it will be run in staging mode. To use production,
+
+	cap production deploy
+
+## Configuration
+
+Configuration can be set on a per-environment basis or for all environments. Set configuration variables using the config hash:
+
+	config[:default] = { 
+	  :jdbc_url => "jdbc:mysql://localhost:3306/project" 
+	}
+	
+Set per-environment configuration:
+
+	config[:production] = {
+	  :user => "admin",
+	  :roles => {
+	    :app => "production-001"
+	  }
+	}
+
+The :user and :roles keys are special and change the way that Capistrano works, as expected.  You may also set any other key/value pair you wish. The combined configuration is available through the config_h parameter:
+
+	"database": {
+	    "jdbc_url": "<%= config_h[:jdbc_url] %>",
+	    "driver_class": "com.vertica.Driver"
+	}
+
+## Other Stuff
+
+&copy; Collin VanDyck 2011. Distributed under the MIT license.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('hudson_deployer', '0.0.1') do |p|
+  p.description    = "Unmagical Capistrano deployment using Hudson"
+  p.url            = "https://github.com/collinvandyck/hudson_deployer"
+  p.author         = "Collin VanDyck"
+  p.email          = "collinvandyck @nospam@ gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/hudson_deployer.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hudson_deployer}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Collin VanDyck"]
+  s.date = %q{2011-03-16}
+  s.description = %q{Unmagical Capistrano deployment using Hudson}
+  s.email = %q{collinvandyck @nospam@ gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README.md", "lib/hudson_deployer.rb"]
+  s.files = ["LICENSE", "Manifest", "README.md", "Rakefile", "lib/hudson_deployer.rb", "hudson_deployer.gemspec"]
+  s.homepage = %q{https://github.com/collinvandyck/hudson_deployer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hudson_deployer", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{hudson_deployer}
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Unmagical Capistrano deployment using Hudson}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/hudson_deployer.rb

@@ -0,0 +1,289 @@
+require 'capistrano'
+require 'rest_client'
+require 'json'
+require 'erb'
+
+class Deploy
+  attr_accessor :application, 
+                :version, 
+                :user, 
+                :build_num, 
+                :artifact_url
+                
+  def initialize(&block)
+    if block_given?
+      yield self
+    end
+  end
+  
+  def debug
+    puts "Deployment Configuration:"
+    [:application, :version, :user, :build_num].each do |f|
+      puts "  #{f}: #{send(f)}"
+    end
+  end
+  
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  def hud_api(url)
+    JSON.parse(RestClient.get(url + "/api/json"))
+  end
+
+  # environment configuration
+  ######################################################################
+
+  # by default we are in the staging environment
+  @env = :staging
+  
+  task :staging do
+    @env = :staging
+  end
+  
+  task :production do
+    @env = :production
+  end
+  
+  set(:config) do
+    {
+      :default => {},
+      :staging => {},
+      :production => {}
+    }
+  end
+  
+  def config_h
+    config[:default].merge(config[@env])
+  end
+
+  # required variables
+  ######################################################################
+
+  _cset(:hudson) { abort ":hudson must be set (e.g. build.yammer.com)" }
+  _cset(:application) { abort ":application must be set" }
+  _cset(:build) { abort ":build must be set (e.g. app-release)" }
+  _cset(:version) { abort ":version must be set (e.g. 2.0.0)" }
+  _cset(:user) { abort ":user must be set" }
+  _cset(:launch_command) { abort ":launch_command must be set" }
+
+  # derived variables
+  ######################################################################
+
+  set(:directory) { "/opt/#{application}" }
+  
+  set(:current_release) { "#{directory}/releases/#{Time.now.to_i}" }
+
+  set(:job) do
+    record = hud_api(hudson)["jobs"].find { |j| j["name"] == build }
+    abort("No such hudson build could be found") if !record
+    hud_api(record["url"])
+  end
+
+  set(:current_build) do
+    builds = job["builds"]
+    abort("There are no existing builds for this project") if builds.empty?
+    url = builds.first["url"]
+    hud_api(url).tap do |b|
+      if b["result"] != "SUCCESS"
+        abort("The last build was not successful: #{b["result"]}")
+      end
+      if b["building"] == true
+        abort("Project is currently building. You must wait until it finishes.")
+      end
+    end
+  end
+
+  set(:artifact_url) do
+    artifacts = current_build["artifacts"]
+    if artifacts.empty?
+      abort("No artifacts exist for this project!")
+    end
+    artifact = if artifacts.length > 1
+      puts "More than one artifact was found. Please choose:"
+      artifacts.each_with_index do |artifact, index|
+        puts "#{index}: #{artifact["relativePath"]}"
+      end
+      print  "? "
+      artifact_index = Capistrano::CLI.ui.ask("choice: ").to_i
+      artifacts[artifact_index]
+    else
+      artifacts.first
+    end
+    current_build["url"] + "artifact/" + artifact["relativePath"]
+  end
+
+  set(:artifact_filename) do
+    artifact_url.split("/").last
+  end
+  
+  set(:tmpdir) do
+    "/tmp/deployer-#{Time.now.to_i}".tap do |tmp|
+      FileUtils.mkdir_p(tmp)
+    end
+  end
+  
+  set(:local_entries) do
+    Dir.entries(File.expand_path(File.dirname(__FILE__) + "/" + application)).reject do |name|
+      name =~ /^\./ || name == "Capfile"
+    end
+  end
+  
+  set(:template_names) do
+    Dir.entries(File.expand_path(File.dirname(__FILE__) + "/" + application + "/templates")).reject do |name|
+      name =~ /^\./
+    end
+  end
+  
+  def build_deployment
+    Deploy.new do |d|
+      d.application = application
+      d.version = version
+      d.user = user
+      d.build_num = current_build["number"]
+      d.artifact_url = artifact_url
+    end
+  end
+
+  def make_release_directory
+    run "#{sudo} mkdir -p #{current_release}", :roles => "app"
+    run "#{sudo} chown -R #{deployer} #{current_release}", :roles => "app"
+  end
+  
+  def create_local_build
+    from = File.expand_path(File.dirname(__FILE__) + "/" + application)
+    local_entries.each { |f| FileUtils.cp_r f, tmpdir, :verbose => true }
+  end
+  
+  def verify_plan
+    puts "*" * 80
+    puts "Deployment plan:"
+    @deploy.debug
+    puts "Copying assets:"
+    puts `find #{tmpdir}`
+    puts "*" * 80
+    unless Capistrano::CLI.ui.ask("Is this what you want?") =~ /^y.*/i
+      exit
+    end
+  end
+
+  def download_artifact
+    puts "Downloading artifact..."
+    `wget #{@deploy.artifact_url} -O #{tmpdir}/#{artifact_filename}`
+  end
+  
+  def execute_actions
+    @rendered_actions.each do |action|
+      run "cd #{current_release} && sh #{action}"
+    end
+  end
+  
+  def transfer_build
+    puts "Transferring build..."
+    Dir.entries(tmpdir).each do |e|
+      unless e =~ /^\./
+        tmpfile = "/tmp/#{Time.now.to_i}"
+        upload "#{tmpdir}/#{e}", tmpfile
+        run "#{sudo} mv #{tmpfile} #{current_release}/#{e}"
+        run "#{sudo} chown -R #{deployer}:#{deployer} #{current_release}/#{e}"
+      end
+    end
+  end
+  
+  def symlink
+    link = "#{current_release}/../current"
+    run "#{sudo} rm #{link} || true"
+    run "#{sudo} ln -sF #{current_release} #{link}"
+  end
+  
+  def cleanup
+    FileUtils.rm_r tmpdir
+  end
+
+  def create_user(username, opts={})
+    create_directory(directory, :owner => deployer, :group => deployer) do
+      run "if ! id #{username} > /dev/null 2>&1; then #{sudo} useradd --no-create-home --home-dir #{opts[:homedir]} --shell #{opts[:shell]} #{username}; fi", :roles => "app"
+    end
+  end
+  
+  def create_directory(path, opts={})
+    opts = { :owner => deployer, :group => deployer, :mode => "0755" }.merge(opts)
+    run "#{sudo} mkdir -p #{path}", :roles => "app"
+    yield if block_given?
+    run "#{sudo} chmod #{opts[:mode]} #{path}"
+    run "#{sudo} chown -R #{opts[:owner]}:#{opts[:group]} #{path}", :roles => "app"
+  end
+  
+  def touch(path, opts={})
+    opts = { :owner => deployer, :group => deployer, :mode => "0755" }.merge(opts)
+    run "#{sudo} touch #{path}"
+    run "#{sudo} chown #{opts[:owner]}:#{opts[:group]} #{path}", :roles => "app"
+  end
+  
+  def render_template(path, opts={})
+    opts = { :owner => deployer, :group => deployer, :mode => "0644" }.merge(opts)
+    data = erb(File.read("templates/#{opts[:template]}"))
+    filename = "/tmp/file-#{Time.now.to_i}"
+    put data, filename
+    run "#{sudo} mv #{filename} #{path}"
+    run "#{sudo} chmod #{opts[:mode]} #{path}"
+    run "#{sudo} chown -R #{opts[:owner]}:#{opts[:group]} #{path}", :roles => "app"
+  end
+  
+  def upstart(path, opts={})
+    render_template path, :template => opts[:template], :owner => "root", :group => "root"
+  end
+  
+  def erb(text)
+    ERB.new(text).result(binding)
+  end
+
+  def render_scripts
+    template_names.each do |script_name|
+      filename = tmpdir + "/scripts/" + script_name
+      template = ERB.new(File.read(filename))
+      rendered = template.result(binding)
+      File.open(filename, "w") { |f| f.puts(rendered) }
+    end
+  end
+
+  task :init do
+    puts "Setting user and roles from config"
+    if u = config_h[:user]
+      puts "Setting user to #{u}"
+      set :user, u
+    end
+    if roles = config_h[:roles]
+      roles.each do |h,v|
+        puts "Setting role #{h} => #{v}"
+        role h, v
+      end
+    end
+  end
+  
+  before :deploy, [:init]
+  
+  task :deploy do
+    @deploy = build_deployment
+    create_local_build
+    download_artifact
+    verify_plan
+    make_release_directory
+    transfer_build
+    symlink
+  end
+
+end
+
+
+
+
+
+
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: hudson_deployer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Collin VanDyck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Unmagical Capistrano deployment using Hudson
+email: collinvandyck @nospam@ gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- lib/hudson_deployer.rb
+files: 
+- LICENSE
+- Manifest
+- README.md
+- Rakefile
+- lib/hudson_deployer.rb
+- hudson_deployer.gemspec
+has_rdoc: true
+homepage: https://github.com/collinvandyck/hudson_deployer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Hudson_deployer
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: hudson_deployer
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Unmagical Capistrano deployment using Hudson
+test_files: []
+