app-deployer 0.0.3

data/lib/app-deployer/mysql/templates/create_database.sql.erb

@@ -0,0 +1,7 @@
+<% mysql_grant_locations.each do |location| %>
+GRANT <%= mysql_grant_priv_type %> ON <%= db_name %>.* TO '<%= db_login %>'@'<%= location %>' IDENTIFIED BY '<%= db_password %>';
+<% end %>
+
+CREATE DATABASE IF NOT EXISTS <%= db_name %> CHARACTER SET = <%= db_encoding %>;
+
+FLUSH PRIVILEGES;

data/lib/app-deployer/railsless-deploy.rb

@@ -0,0 +1,399 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  require 'benchmark'
+  require 'capistrano/recipes/deploy/scm'
+  require 'capistrano/recipes/deploy/strategy'
+
+  # =========================================================================
+  # These variables MUST be set in the client capfiles. If they are not set,
+  # the deploy will fail with an error.
+  # =========================================================================
+
+  _cset(:application) { abort "Please specify the name of your application, set :application, 'foo'" }
+  _cset(:repository)  { abort "Please specify the repository that houses your application's code, set :repository, 'foo'" }
+
+  # =========================================================================
+  # These variables may be set in the client capfile if their default values
+  # are not sufficient.
+  # =========================================================================
+
+  _cset :scm,                   :git
+  _cset :deploy_via,            :remote_cache
+  _cset :branch,                'master'
+  _cset(:deploy_to)             { "/var/www/#{application}" }
+  _cset :keep_releases,         5
+  _cset :git_enable_submodules, false
+  _cset :use_compass,           false
+  _cset :use_composer,          false
+  _cset :composer_bin,          false
+  _cset :composer_options,      "--no-scripts --verbose"
+  _cset :curl_options,          "-k"
+  _cset :copy_vendors,          false
+  _cset :update_vendors,        false
+  _cset :clear_cache,           false
+  _cset :use_sudo,              false
+  _cset :php_bin,               "php"
+  default_run_options[:pty]   = true
+  ssh_options[:forward_agent] = true
+
+  # =========================================================================
+  # Default user settings
+  # =========================================================================
+
+  _cset :user,   'deploy'
+  _cset(:group)  {'www-data'}
+  _cset :runner, :user
+
+  # =========================================================================
+  # These variables should NOT be changed unless you are very confident in
+  # what you are doing. Make sure you understand all the implications of your
+  # changes if you do decide to muck with these!
+  # =========================================================================
+
+  _cset(:source)            { Capistrano::Deploy::SCM.new(scm, self) }
+  _cset(:revision)          { source.head }
+  _cset(:real_revision)     { source.local.query_revision(revision) { |cmd| with_env("LC_ALL", "C") { run_locally(cmd) } } }
+
+  _cset(:strategy)          { Capistrano::Deploy::Strategy.new(deploy_via, self) }
+
+  _cset(:release_name)      { set :deploy_timestamped, true; Time.now.utc.strftime("%Y%m%d%H%M%S") }
+
+  _cset :version_dir,       "releases"
+  _cset :shared_dir,        "shared"
+  _cset :shared_children,   [] # Empty!
+  _cset :current_dir,       "current"
+
+  _cset(:releases_path)     { File.join(deploy_to, version_dir) }
+  _cset(:shared_path)       { File.join(deploy_to, shared_dir) }
+  _cset(:current_path)      { File.join(deploy_to, current_dir) }
+  _cset(:release_path)      { File.join(releases_path, release_name) }
+
+  _cset(:releases)          { capture("ls -x #{releases_path}", :except => { :no_release => true }).split.sort }
+  _cset(:current_release)   { releases.length > 0 ? File.join(releases_path, releases.last) : nil }
+  _cset(:previous_release)  { releases.length > 1 ? File.join(releases_path, releases[-2]) : nil }
+
+  _cset(:current_revision)  { capture("cat #{current_path}/REVISION",     :except => { :no_release => true }).chomp }
+  _cset(:latest_revision)   { capture("cat #{current_release}/REVISION",  :except => { :no_release => true }).chomp }
+  _cset(:previous_revision) { capture("cat #{previous_release}/REVISION", :except => { :no_release => true }).chomp if previous_release }
+
+  _cset(:run_method)        { fetch(:use_sudo, true) ? :sudo : :run }
+
+  # some tasks, like symlink, need to always point at the latest release, but
+  # they can also (occassionally) be called standalone. In the standalone case,
+  # the timestamped release_path will be inaccurate, since the directory won't
+  # actually exist. This variable lets tasks like symlink work either in the
+  # standalone case, or during deployment.
+  _cset(:latest_release) { exists?(:deploy_timestamped) ? release_path : current_release }
+
+  STDOUT.sync
+  $error = false
+  $pretty_errors_defined = false
+
+  # Be less verbose by default
+  # logger.level = Capistrano::Logger::IMPORTANT
+
+  before "deploy:update_code" do
+    msg = "--> Updating code base with #{deploy_via} strategy"
+
+    if logger.level == Capistrano::Logger::IMPORTANT
+      pretty_errors
+      puts msg
+    else
+      puts msg.green
+    end
+  end
+
+  after "deploy:update_code" do
+    if use_compass
+      compass.compile
+    end
+  end
+
+  after "deploy:create_symlink" do
+    puts "--> Successfully deployed!".green
+  end
+
+
+  # =========================================================================
+  # These are the tasks that are available to help with deploying web apps,
+  # and specifically, Rails applications. You can have cap give you a summary
+  # of them with `cap -T'.
+  # =========================================================================
+
+  namespace :deploy do
+    desc <<-DESC
+      Deploys your project. This calls both `update' and `restart'. Note that \
+      this will generally only work for applications that have already been deployed \
+      once. For a "cold" deploy, you'll want to take a look at the `deploy:cold' \
+      task, which handles the cold start specifically.
+    DESC
+    task :default do
+      update
+    end
+
+    desc <<-DESC
+      Prepares one or more servers for deployment. Before you can use any \
+      of the Capistrano deployment tasks with your project, you will need to \
+      make sure all of your servers have been prepared with `cap deploy:setup'. When \
+      you add a new server to your cluster, you can easily run the setup task \
+      on just that server by specifying the HOSTS environment variable:
+
+        $ cap HOSTS=new.server.com deploy: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.
+    DESC
+    task :setup, :except => { :no_release => true } do
+      dirs = [deploy_to, releases_path, shared_path]
+      dirs += shared_children.map { |d| File.join(shared_path, d.split('/').last) }
+      run "#{try_sudo} mkdir -p #{dirs.join(' ')}"
+      run "#{try_sudo} chmod g+w #{dirs.join(' ')}" if fetch(:group_writable, true)
+    end
+
+    desc <<-DESC
+      Copies your project and updates the symlink. It does this in a \
+      transaction, so that if either `update_code' or `symlink' fail, all \
+      changes made to the remote servers will be rolled back, leaving your \
+      system in the same state it was in before `update' was invoked. Usually, \
+      you will want to call `deploy' instead of `update', but `update' can be \
+      handy if you want to deploy, but not immediately restart your application.
+    DESC
+    task :update do
+      transaction do
+        update_code
+        create_symlink
+        cleanup
+      end
+    end
+
+    desc <<-DESC
+      Copies your project to the remote servers. This is the first stage \
+      of any deployment; moving your updated code and assets to the deployment \
+      servers. You will rarely call this task directly, however; instead, you \
+      should call the `deploy' task (to do a complete deploy) or the `update' \
+      task (if you want to perform the `restart' task separately).
+
+      You will need to make sure you set the :scm variable to the source \
+      control software you are using (it defaults to :subversion), and the \
+      :deploy_via variable to the strategy you want to use to deploy (it \
+      defaults to :checkout).
+    DESC
+    task :update_code, :except => { :no_release => true } do
+      on_rollback { run "rm -rf #{release_path}; true" }
+      strategy.deploy!
+      finalize_update
+    end
+
+    desc <<-DESC
+      [internal] Touches up the released code. This is called by update_code \
+      after the basic deploy finishes. It assumes a Rails project was deployed, \
+      so if you are deploying something else, you may want to override this \
+      task with your own environment's requirements.
+
+      This task will make the release group-writable (if the :group_writable \
+      variable is set to true, which is the default). It will then set up \
+      symlinks to the shared directory for the log, system, and tmp/pids \
+      directories, and will lastly touch all assets in public/images, \
+      public/stylesheets, and public/javascripts so that the times are \
+      consistent (so that asset timestamping works).  This touch process \
+      is only carried out if the :normalize_asset_timestamps variable is \
+      set to true, which is the default The asset directories can be overridden \
+      using the :public_children variable.
+    DESC
+    task :finalize_update, :except => { :no_release => true } do
+      run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+    end
+    desc <<-DESC
+      Deprecated API. This has become deploy:create_symlink, please update your recipes
+    DESC
+    task :symlink, :except => { :no_release => true } do
+      Kernel.warn "[Deprecation Warning] This API has changed, please hook `deploy:create_symlink` instead of `deploy:symlink`."
+      create_symlink
+    end
+
+    desc <<-DESC
+      Updates the symlink to the most recently deployed version. Capistrano works \
+      by putting each new release of your application in its own directory. When \
+      you deploy a new version, this task's job is to update the `current' symlink \
+      to point at the new version. You will rarely need to call this task \
+      directly; instead, use the `deploy' task (which performs a complete \
+      deploy, including `restart') or the 'update' task (which does everything \
+      except `restart').
+    DESC
+    task :create_symlink, :except => { :no_release => true } do
+      on_rollback do
+        if previous_release
+          run "rm -f #{current_path}; ln -s #{previous_release} #{current_path}; true"
+        else
+          logger.important "no previous release to rollback to, rollback of symlink skipped"
+        end
+      end
+
+      run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+    end
+
+    desc <<-DESC
+      Copy files to the currently deployed version. This is useful for updating \
+      files piecemeal, such as when you need to quickly deploy only a single \
+      file. Some files, such as updated templates, images, or stylesheets, \
+      might not require a full deploy, and especially in emergency situations \
+      it can be handy to just push the updates to production, quickly.
+
+      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.
+
+        $ cap deploy:upload FILES=templates,controller.rb
+
+      Dir globs are also supported:
+
+        $ cap deploy:upload FILES='config/apache/*.conf'
+    DESC
+    task :upload, :except => { :no_release => true } do
+      files = (ENV["FILES"] || "").split(",").map { |f| Dir[f.strip] }.flatten
+      abort "Please specify at least one file or directory to update (via the FILES environment variable)" if files.empty?
+
+      files.each { |file| top.upload(file, File.join(current_path, file)) }
+    end
+
+    namespace :rollback do
+      desc <<-DESC
+        [internal] Points the current symlink at the previous revision.
+        This is called by the rollback sequence, and should rarely (if
+        ever) need to be called directly.
+      DESC
+      task :revision, :except => { :no_release => true } do
+        if previous_release
+          run "rm #{current_path}; ln -s #{previous_release} #{current_path}"
+        else
+          abort "could not rollback the code because there is no prior release"
+        end
+      end
+
+      desc <<-DESC
+        [internal] Removes the most recently deployed release.
+        This is called by the rollback sequence, and should rarely
+        (if ever) need to be called directly.
+      DESC
+      task :cleanup, :except => { :no_release => true } do
+        run "if [ `readlink #{current_path}` != #{current_release} ]; then rm -rf #{current_release}; fi"
+      end
+
+      desc <<-DESC
+        Rolls back to the previously deployed version. The `current' symlink will \
+        be updated to point at the previously deployed version, and then the \
+        current release will be removed from the servers. You'll generally want \
+        to call `rollback' instead, as it performs a `restart' as well.
+      DESC
+      task :code, :except => { :no_release => true } do
+        revision
+        cleanup
+      end
+
+      desc <<-DESC
+        Rolls back to a previous version and restarts. This is handy if you ever \
+        discover that you've deployed a lemon; `cap rollback' and you're right \
+        back where you were, on the previously deployed version.
+      DESC
+      task :default do
+        revision
+        cleanup
+      end
+    end
+
+    desc <<-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. By default, this \
+      will use sudo to clean up the old releases, but if sudo is not available \
+      for your environment, set the :use_sudo variable to false instead.
+    DESC
+    task :cleanup, :except => { :no_release => true } do
+      count = fetch(:keep_releases, 5).to_i
+      local_releases = capture("ls -xt #{releases_path}").split.reverse
+      if count >= local_releases.length
+        logger.important "no old releases to clean up"
+      else
+        logger.info "keeping #{count} of #{local_releases.length} deployed releases"
+        directories = (local_releases - local_releases.last(count)).map { |release|
+          File.join(releases_path, release) }.join(" ")
+
+        try_sudo "rm -rf #{directories}"
+      end
+    end
+
+    desc <<-DESC
+      Test deployment dependencies. Checks things like directory permissions, \
+      necessary utilities, and so forth, reporting on the things that appear to \
+      be incorrect or missing. This is good for making sure a deploy has a \
+      chance of working before you actually run `cap deploy'.
+
+      You can define your own dependencies, as well, using the `depend' method:
+
+        depend :remote, :gem, "tzinfo", ">=0.3.3"
+        depend :local, :command, "svn"
+        depend :remote, :directory, "/u/depot/files"
+    DESC
+    task :check, :except => { :no_release => true } do
+      dependencies = strategy.check!
+
+      other = fetch(:dependencies, {})
+      other.each do |location, types|
+        types.each do |type, calls|
+          if type == :gem
+            dependencies.send(location).command(fetch(:gem_command, "gem")).or("`gem' command could not be found. Try setting :gem_command")
+          end
+
+          calls.each do |args|
+            dependencies.send(location).send(type, *args)
+          end
+        end
+      end
+
+      if dependencies.pass?
+        puts "You appear to have all necessary dependencies installed"
+      else
+        puts "The following dependencies failed. Please check them and try again:"
+        dependencies.reject { |d| d.pass? }.each do |d|
+          puts "--> #{d.message}"
+        end
+        abort
+      end
+    end
+
+    desc <<-DESC
+      Deploys and starts a `cold' application. This is useful if you have not \
+      deployed your application before, or if your application is (for some \
+      other reason) not currently running. It will deploy the code, run any \
+      pending migrations, and then instead of invoking `deploy:restart', it will \
+      invoke `deploy:start' to fire up the application servers.
+    DESC
+    task :cold do
+      update
+    end
+
+    namespace :pending do
+      desc <<-DESC
+        Displays the `diff' since your last deploy. This is useful if you want \
+        to examine what changes are about to be deployed. Note that this might \
+        not be supported on all SCM's.
+      DESC
+      task :diff, :except => { :no_release => true } do
+        system(source.local.diff(current_revision))
+      end
+
+      desc <<-DESC
+        Displays the commits since your last deploy. This is good for a summary \
+        of the changes that have occurred since the last deploy. Note that this \
+        might not be supported on all SCM's.
+      DESC
+      task :default, :except => { :no_release => true } do
+        from = source.next_revision(current_revision)
+        system(source.local.log(from))
+      end
+    end
+
+  end
+
+end # Capistrano::Configuration.instance(:must_exist).load do

data/lib/app-deployer/server/apache/apache.rb

@@ -0,0 +1,59 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'erb'
+
+  namespace :apache do
+    namespace :maintenance do
+      desc <<-DESC
+        Present a maintenance page to visitors. Disables your application's web \
+        interface by writing a "maintenance.html" file to each web server. The \
+        servers must be configured to detect the presence of this file, and if \
+        it is present, always display it instead of performing the request.
+
+        By default, the maintenance page will just say the site is down for \
+        "maintenance", and will be back "shortly", but you can customize the \
+        page by specifying the REASON and UNTIL environment variables:
+
+          $ cap deploy:web:disable \\
+            REASON="hardware upgrade" \\
+            UNTIL="12pm Central Time"
+
+        Further customization will require that you write your own task.
+      DESC
+      task :start, :roles => :web, :except => { :no_release => true } do
+        on_rollback { run "rm #{shared_path}/maintenance.html" }
+
+        warn <<-EOHTACCESS
+
+          # Please add something like this to your site's htaccess to redirect users to the maintenance page.
+          # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+          ErrorDocument 503 /maintenance.html
+          RewriteEngine On
+          RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+          RewriteCond %{DOCUMENT_ROOT}/maintenance.html -f
+          RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+          RewriteRule ^.*$  -  [redirect=503,last]
+        EOHTACCESS
+
+        reason = ENV['REASON']
+        deadline = ENV['UNTIL']
+
+        template = File.read(File.join(File.dirname(__FILE__), "templates", "maintenance.rhtml"))
+        result = ERB.new(template).result(binding)
+
+        put(result, "#{shared_path}/maintenance.html", :mode => 0644, :via => :scp)
+      end
+
+      desc <<-DESC
+        Makes the application web-accessible again. Removes the \
+        "maintenance.html" page generated by deploy:web:disable, which (if your \
+        web servers are configured correctly) will make your application \
+        web-accessible again.
+      DESC
+      task :end, :roles => :web, :except => { :no_release => true } do
+        run "rm #{shared_path}/maintenance.html"
+      end
+    end
+
+  end
+end