oxen_deployer 1.0.0 → 1.0.1

data/lib/oxen_deployer.rb

@@ -60,7 +60,7 @@ module OxenDeployer
       recipe = recipes[flavor]
       next if recipe.nil? or flavor == :config
       begin
-        require "Deployer/#{recipe}"
+        require "oxen_deployer/#{recipe}"
       rescue LoadError => e
         re = RuntimeError.new e.message
         re.backtrace = e.backtrace

data/lib/oxen_deployer/apache.rb

@@ -0,0 +1,37 @@
+require 'oxen_deployer'
+
+namespace :oxen do
+  ##
+  # Apache web server
+
+  set :web_command, "apachectl"
+
+  desc "(Re)Start the web servers"
+
+  remote_task :start_web, :roles => :web  do
+    run "#{web_command} restart"
+  end
+
+  desc "Stop the web servers"
+
+  remote_task :stop_web, :roles => :web  do
+    run "#{web_command} stop"
+  end
+
+  ##
+  # Everything HTTP.
+
+  desc "(Re)Start the web and app servers"
+
+  remote_task :start do
+    Rake::Task['oxen:start_app'].invoke
+    Rake::Task['oxen:start_web'].invoke
+  end
+
+  desc "Stop the web and app servers"
+
+  remote_task :stop do
+    Rake::Task['oxen:stop_app'].invoke
+    Rake::Task['oxen:stop_web'].invoke
+  end
+end

data/lib/oxen_deployer/core.rb

@@ -0,0 +1,227 @@
+require 'oxen_deployer'
+
+##
+# used by update, out here so we can ensure all threads have the same value
+def now
+  @now ||= Time.now.utc.strftime("%Y%m%d%H%M.%S")
+end
+
+namespace :oxen do
+  desc "Show the oxen_deployer setup.  This is all the default variables for oxen_deployer
+    tasks.".cleanup
+
+  task :debug do
+    require 'yaml'
+
+    # force them into values
+    Rake::RemoteTask.env.keys.each do |key|
+      next if key =~ /_release|releases|sudo_password/
+      Rake::RemoteTask.fetch key
+    end
+
+    puts "# Environment:"
+    puts
+    puts Rake::RemoteTask.env.to_yaml
+    puts "# Roles:"
+    puts Rake::RemoteTask.roles.to_yaml
+  end
+
+  append :ancillary_dir
+
+  desc "Setup your servers. Before you can use any of the deployment
+    tasks with your project, you will need to make sure all of your
+    servers have been prepared with 'rake oxen:setup'. It is safe to
+    run this task on servers that have already been set up; it will
+    not destroy any deployed revisions or data.".cleanup
+
+  task :setup do
+    Rake::Task['oxen:setup_app'].invoke
+  end
+
+  desc "Prepares application servers for deployment.".cleanup
+
+  remote_task :setup_app, :roles => :app do
+    dirs = [deploy_to, releases_path, shared_path]
+    dirs << scm_path unless skip_scm
+    dirs += shared_paths.keys.map { |d| File.join(shared_path, d) }
+    dirs += ancillary_dir
+    dirs = dirs.join(' ')
+
+    commands = []
+
+    commands << "umask #{umask}" if umask
+    commands << "mkdir -p #{dirs}"
+
+    commands << "chown #{perm_owner} #{dirs}" if perm_owner
+    commands << "chgrp #{perm_group} #{dirs}" if perm_group
+
+    run commands.join(' && ')
+  end
+
+  desc "Updates your application server to the latest revision.  Syncs
+    a copy of the repository, exports it as the latest release, fixes
+    up your symlinks, symlinks the latest revision to current and logs
+    the update.".cleanup
+
+  remote_task :update, :roles => :app do
+    Rake::Task['oxen:update_app'].invoke
+    Rake::Task['oxen:update_symlinks'].invoke
+    Rake::Task['oxen:log_revision'].invoke
+  end
+
+  desc "Updates your application server to the latest revision.  Syncs 
+    a copy of the repository, exports it as the latest release".cleanup
+
+  remote_task :update_app, :roles => :app do
+    begin
+      commands = []
+      commands << "umask #{umask}" if umask
+      unless skip_scm
+        commands << "cd #{scm_path}"
+        commands << "#{source.checkout revision, scm_path}"
+      end
+      commands << "#{source.export revision, release_path}"
+
+      unless shared_paths.empty?
+        commands << "rm -rf #{shared_paths.values.map { |p| File.join(latest_release, p) }.join(' ')}"
+      end
+      unless mkdirs.empty?
+        dirs = mkdirs.map { |d| File.join(latest_release, d) }.join(' ')
+        commands << "mkdir -p #{dirs}"
+        commands << "chown -R #{perm_owner} #{dirs}" if perm_owner
+        commands << "chgrp -R #{perm_group} #{dirs}" if perm_group
+      end
+
+      commands << "chown -R #{perm_owner} #{latest_release}" if perm_owner
+      commands << "chgrp -R #{perm_group} #{latest_release}" if perm_group
+
+      run commands.join(" && ")
+    rescue => e
+      run "rm -rf #{release_path}"
+      raise e
+    end
+  end
+
+  desc "Updates up your symlinks, sets the latest revision to current and updates symlink for shared path".cleanup
+
+  remote_task :update_symlinks, :roles => :app do
+    begin
+      ops = []
+      unless shared_paths.empty?
+        shared_paths.each do |sp, rp|
+          ops << "ln -s #{shared_path}/#{sp} #{latest_release}/#{rp}"
+        end
+      end
+      ops << "rm -f #{current_path}"
+      ops << "ln -s #{latest_release} #{current_path}"
+      run ops.join(' && ') unless ops.empty?
+    rescue => e
+      run "rm -f #{current_path} && ln -s #{previous_release} #{current_path}"
+      run "rm -rf #{release_path}"
+      raise e
+    end
+  end
+
+  desc "Log the update".cleanup
+  
+  remote_task :log_revision, :roles => :app do
+    begin
+      commands = []
+
+      commands << "umask #{umask}" if umask
+
+      commands += [
+        "echo #{now} $USER #{revision} #{File.basename(release_path)} >> #{deploy_to}/revisions.log"
+      ]
+
+      commands << "chown #{perm_owner} #{deploy_to}/revisions.log" if perm_owner
+      commands << "chgrp #{perm_group} #{deploy_to}/revisions.log" if perm_group
+
+      run commands.join(' && ')
+    rescue => e
+      run "rm -f #{current_path} && ln -s #{previous_release} #{current_path}"
+      run "rm -rf #{release_path}"
+      raise e
+    end
+  end
+
+
+  desc "Invoke a single command on every remote server. This is useful for
+    performing one-off commands that may not require a full task to be written
+    for them.  Simply specify the command to execute via the COMMAND
+    environment variable.  To execute the command only on certain roles,
+    specify the ROLES environment variable as a comma-delimited list of role
+    names.
+
+      $ rake oxen:invoke COMMAND='uptime'".cleanup
+
+  remote_task :invoke do
+    command = ENV["COMMAND"]
+    abort "Please specify a command to execute on the remote servers (via the COMMAND environment variable)" unless command
+    run(command)
+  end
+
+  desc "Copy arbitrary files to the currently deployed version using
+    FILES=a,b,c. This is useful for updating files piecemeal when you
+    need to quickly deploy only a single file.
+
+    To use this task, specify the files and directories you want to copy as a
+    comma-delimited list in the FILES environment variable. All directories
+    will be processed recursively, with all files being pushed to the
+    deployment servers. Any file or directory starting with a '.' character
+    will be ignored.
+
+      $ rake oxen:upload FILES=templates,controller.rb".cleanup
+
+  remote_task :upload do
+    file_list = (ENV["FILES"] || "").split(",")
+
+    files = file_list.map do |f|
+      f = f.strip
+      File.directory?(f) ? Dir["#{f}/**/*"] : f
+    end.flatten
+
+    files = files.reject { |f| File.directory?(f) || File.basename(f)[0] == ?. }
+
+    abort "Please specify at least one file to update (via the FILES environment variable)" if files.empty?
+
+    files.each do |file|
+      rsync file, File.join(current_path, file)
+    end
+  end
+
+  desc "Rolls back to a previous version and restarts. This is handy if you
+    ever discover that you've deployed a lemon; 'rake oxen:rollback' and
+    you're right back where you were, on the previously deployed
+    version.".cleanup
+
+  remote_task :rollback, :roles => :app do
+    if releases.length < 2 then
+      abort "could not rollback the code because there is no prior release"
+    else
+      run "rm -f #{current_path}; ln -s #{previous_release} #{current_path} && rm -rf #{current_release}"
+    end
+
+    Rake::Task['oxen:start'].invoke
+  end
+
+  desc "Clean up old releases. By default, the last 5 releases are kept on
+    each server (though you can change this with the keep_releases variable).
+    All other deployed revisions are removed from the servers.".cleanup
+
+  remote_task :cleanup, :roles => :app do
+    max = keep_releases
+    if releases.length <= max then
+      puts "no old releases to clean up #{releases.length} <= #{max}"
+    else
+      puts "keeping #{max} of #{releases.length} deployed releases"
+
+      directories = (releases - releases.last(max)).map { |release|
+        File.join(releases_path, release)
+      }.join(" ")
+
+      run "rm -rf #{directories}"
+    end
+  end
+
+end # namespace vlad

data/lib/oxen_deployer/maintenance.rb

@@ -0,0 +1,25 @@
+require 'oxen_deployer'
+
+##
+# See the following documents for recipes:
+#
+# * http://clarkware.com/blog/2007/1/5/custom-maintenance-pages
+# * http://blog.nodeta.fi/2009/03/11/stopping-your-rails-application-with-phusion-passenger/
+#
+
+namespace :oxen do
+  namespace :maintenance do
+
+    desc "Turn on the maintenance web page"
+
+    remote_task :on, :roles => [:web] do
+      run "cp -f #{shared_path}/config/maintenance.html #{shared_path}/system/"
+    end
+
+    desc "Turn off the maintenance web page"
+
+    remote_task :off, :roles => [:web] do
+      run "rm -f #{shared_path}/system/maintenance.html"
+    end
+  end
+end

data/lib/oxen_deployer/passenger.rb

@@ -0,0 +1,8 @@
+require 'oxen_deployer'
+
+namespace :oxen do
+  desc 'Restart Passenger'
+  remote_task :start_app, :roles => :app do
+    run "touch #{current_release}/tmp/restart.txt"
+  end
+end

data/lib/oxen_deployer/rails.rb

@@ -0,0 +1,35 @@
+namespace :oxen do
+  set :rails_env,      "production"
+  set :rails_env_var,  "RAILS_ENV"
+  set :migrate_args,   ""
+  set :migrate_target, :latest
+  set :mkdirs,         %w(tmp db)
+  set :shared_paths, {
+    'log'    => 'log',
+    'system' => 'public/system',
+    'pids'   => 'tmp/pids',
+  }
+
+  desc "Run the migrate rake task for the the app. By default this is run in
+    the latest app directory.  You can run migrations for the current app
+    directory by setting :migrate_target to :current.  Additional environment
+    variables can be passed to rake via the migrate_args variable.".cleanup
+
+  # No application files are on the DB machine, also migrations should only be
+  # run once.
+  remote_task :migrate, :roles => :app do
+    next unless target_host == Rake::RemoteTask.hosts_for(:app).first
+
+    directory = case migrate_target.to_sym
+                when :current then current_path
+                when :latest  then latest_release
+                else
+                  raise(ArgumentError,
+                        "unknown migration target #{migrate_target.inspect}")
+                end
+
+    run ["cd #{directory}",
+         "#{rake_cmd} #{rails_env_var}=#{rails_env} db:migrate #{migrate_args}"
+        ].join(" && ")
+  end
+end

data/lib/oxen_deployer/subversion.rb

@@ -0,0 +1,27 @@
+class OxenDeployer::Subversion
+
+  set :source, OxenDeployer::Subversion.new
+  set :svn_cmd, "svn"
+  set :revision, "HEAD"
+
+  ##
+  # Returns the command that will check out +revision+ from the repository
+  # into directory +destination+
+
+  def checkout(revision, destination)
+    "#{svn_cmd} co -r #{revision} #{repository} #{destination}"
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the repository into
+  # the directory +destination+.
+
+  def export(revision_or_source, destination)
+    "#{svn_cmd} #{deploy_via} " +
+      if revision_or_source =~ /^(\d+|head)$/i then
+        "-r #{revision_or_source} #{repository} #{destination}"
+      else
+        "#{revision_or_source} #{destination}"
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxen_deployer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -21,6 +21,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/oxen_deployer.rb
+- lib/oxen_deployer/apache.rb
+- lib/oxen_deployer/core.rb
+- lib/oxen_deployer/maintenance.rb
+- lib/oxen_deployer/passenger.rb
+- lib/oxen_deployer/rails.rb
+- lib/oxen_deployer/subversion.rb
 homepage: https://github.com/wdiechmann/oxen_deployer
 licenses: []
 post_install_message: