chicken_soup 0.0.1 → 0.0.2

data/lib/chicken_soup/capabilities/mysql.rb

@@ -0,0 +1,48 @@
+######################################################################
+#                            MYSQL TASKS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'chicken_soup/capabilities/shared/db'
+
+  namespace :db do
+    desc <<-DESC
+      Creates the MySQL database and user for the application.
+
+      * Creates a script that is uploaded to the user's home directory.
+      * The script is executed as `root` and as such, the user will be prompted
+        for `root`'s password.
+      * The DB and user name are equivalent to the application_underscored
+        variable.
+      * The DB user will be granted all privileges on the DB.
+    DESC
+    task :create do
+      create_script = <<-CREATESCRIPT
+        create database #{application_underscored} character set utf8;
+        create user '#{application_underscored}'@'localhost' identified by '#{db_app_password}';
+        grant all on #{application_underscored}.* to #{application_underscored}@localhost;
+      CREATESCRIPT
+
+      put create_script, "#{user_home}/create_#{application_underscored}_db_script"
+      run %Q{#{sudo} bash -c "mysql --user=root --password=#{db_root_password} < #{user_home}/create_#{application_underscored}_db_script"}
+      run "rm #{user_home}/create_#{application_underscored}_db_script"
+    end
+
+    desc <<-DESC
+      Drops the MySQL database and user for the application.
+
+      * Creates a script that is uploaded to the user's home directory.
+      * The script is executed as `root` and as such, the user will be prompted
+        for `root`'s password.
+    DESC
+    task :drop do
+      drop_script = <<-DROPSCRIPT
+        drop user #{application_underscored}@localhost;
+        drop database #{application_underscored};
+      DROPSCRIPT
+
+      put drop_script, "#{user_home}/drop_#{application_underscored}_db_script"
+      run %Q{#{sudo} bash -c "mysql --user=root --password=#{db_root_password} < #{user_home}/drop_#{application_underscored}_db_script"}
+      run "rm #{user_home}/drop_#{application_underscored}_db_script"
+    end
+  end
+end

data/lib/chicken_soup/capabilities/passenger.rb

@@ -0,0 +1,31 @@
+######################################################################
+#                           PASSENGER TASKS                          #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    desc <<-DESC
+      There is no way to start the application via Passenger.
+
+      This task does nothing.
+    DESC
+    task :start do ; end
+
+    desc <<-DESC
+      There is no way to stop the application via Passenger.
+
+      This task does nothing.
+    DESC
+    task :stop do ; end
+
+    desc <<-DESC
+      Starts/Restarts the application.
+
+      Passenger knows when you'd like to reset by looking at a file in the `tmp`
+      directory called `restart.txt`.  If the Last Access time for `restart.txt`
+      changes, Passenger restarts the app.
+    DESC
+    task :restart, :except => { :no_release => true } do
+      run "touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+  end
+end

data/lib/chicken_soup/capabilities/postgres.rb

@@ -0,0 +1,6 @@
+######################################################################
+#                          POSTGRES TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'chicken_soup/capabilities/shared/db'
+end

data/lib/chicken_soup/capabilities/rvm.rb

@@ -0,0 +1,42 @@
+######################################################################
+#                             RVM TASKS                              #
+######################################################################
+def run_with_rvm(ruby_env_string, command)
+  run("rvm use #{ruby_env_string} && #{command}")
+end
+
+######################################################################
+#                       RVM ENVIRONMENT CHECKS                       #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary RVM variables have been set up.
+      DESC
+      task :rvm do
+        required_variables = [
+          :ruby_version,
+          :ruby_gemset,
+          :rvm_ruby_string,
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end
+
+######################################################################
+#                    DEFAULT RVM ENVIRONMENT SETUP                   #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      _cset :ruby_version,        ENV["rvm_ruby_string"]
+      _cset :ruby_gemset,         ENV["GEM_HOME"].split('@')[1]
+
+      _cset(:rvm_ruby_string)     {ruby_gemset ? "#{ruby_version}@#{ruby_gemset}" : ruby_version}
+    end
+  end
+end

data/lib/chicken_soup/capabilities/shared/db.rb

@@ -0,0 +1,58 @@
+######################################################################
+#                          COMMON DB TASKS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  _cset(:db_root_password)    {Capistrano::CLI.password_prompt("Root Password For DB: ")}
+  _cset(:db_app_password)     {Capistrano::CLI.password_prompt("App Password For DB: ")}
+
+  run_task "db:create",       :as => "manager"
+  run_task "db:drop",         :as => "manager"
+
+  namespace :db do
+    desc <<-DESC
+      Calls the rake task `db:backup` on the server for the given environment.
+
+      * The backup file is placed in a directory called `db_backups` under the `shared`
+        directory by default.
+      * The filenames are formatted with the timestamp of the backup.
+      * After export, each file is zipped up using a bzip2 compression format.
+    DESC
+    task :backup do
+      run "if [ ! -d #{shared_path}/db_backups ]; then mkdir #{shared_path}/db_backups; fi"
+      run "cd #{current_path} && bundle exec rake BACKUP_DIRECTORY=#{shared_path}/db_backups RAILS_ENV=#{rails_env} db:backup"
+    end
+
+    desc <<-DESC
+      Calls the rake task `db:reset_and_seed` on the server for the given environment.
+
+      Typically, this task will drop the DB, recreate the DB, load the development
+      schema and then populate the DB by calling the `db:seed` task.
+
+      Warning: This task cannot be called in production mode.  If you truely wish
+              to run this in production, you'll need to log into the server and
+              run the rake task manually.
+    DESC
+    task :reset_and_seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:reset_and_seed"
+    end
+
+    desc <<-DESC
+      Calls the rake task `db:seed` on the server for the given environment.
+
+      Typically, this task will populate the DB with valid data which is necessary
+      for the initial production deployment.  An example may be that the `STATES`
+      table gets populated with all the information about the States.
+
+      Warning: This task cannot be called in production mode.  If you truely wish
+              to run this in production, you'll need to log into the server and
+              run the rake task manually.
+    DESC
+    task :seed do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      db.backup
+      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:seed"
+    end
+  end
+end

data/lib/chicken_soup/capabilities/unix.rb

@@ -0,0 +1,163 @@
+######################################################################
+#                         COMMON *NIX TASKS                          #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  before "deploy:config:symlink",                 "deploy:config:create"
+
+  namespace :deploy do
+    namespace :config do
+      desc <<-DESC
+        Creates the directory where the `symlink` task will look for its configuration files.
+
+        It will first look in the user's home directory to see if there is
+        a file of the same name as one of the shared files. If there is, it
+        will move that to the shared location.  If not, it will create an
+        empty file.
+      DESC
+      task :create do
+        run "if [ ! -d #{shared_path}/config ]; then mkdir -p #{shared_path}/config; fi"
+
+        global_shared_files.each do |shared_file|
+          local_shared_file = "#{shared_file}.#{rails_env}"
+
+          if File.exists?(local_shared_file)
+            top.upload(local_shared_file, "#{shared_path}/#{shared_file}", :mode => "600")
+          else
+            run "touch #{shared_path}/#{shared_file}"
+          end
+        end
+      end
+
+      desc <<-DESC
+        Symlinks sensitive configuration files which shouldn't be checked into source control.
+
+        By default, these live in the shared directory that Capistrano sets up.
+      DESC
+      task :symlink do
+        global_shared_files.each do |shared_file|
+          run "ln -nfs #{shared_path}/#{shared_file} #{latest_release}/#{shared_file}"
+        end
+      end
+    end
+  end
+
+  namespace :os do
+    namespace :users do
+      namespace :root do
+        desc <<-DESC
+          [internal] Switches Capistrano to use the root user for all subsequent SSH actions.
+
+          It will prompt for the root user's password the first time it's needed.
+          (If the Kompanee Bash environment has been installed, you will no longer
+          be able to log in as root.)
+        DESC
+        task :use do
+          set_user_to("root")
+        end
+      end
+
+      namespace :manager do
+        desc <<-DESC
+          Switches Capistrano to use the manager user for all subsequent SSH actions.
+
+          It will prompt for the manager user's password the first time it's needed.
+          (If public key authentication is already installed, you will not be prompted.)
+        DESC
+        task :use do
+          set_user_to(manager_username)
+        end
+      end
+
+      namespace :deploy do
+        desc <<-DESC
+          Switches Capistrano to use the deployment user for all subsequent SSH actions.
+
+          It will prompt for the deployment user's password the first time it's needed.
+          (If public key authentication is already installed, you will not be prompted.)
+        DESC
+        task :use do
+          set_user_to(deployment_username)
+        end
+      end
+    end
+  end
+end
+
+######################################################################
+#                       UNIX ENVIRONMENT CHECKS                      #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary unix environment variables have been set up.
+      DESC
+      task :unix do
+        required_variables = [
+          :user,
+          :deployment_username,
+          :manager_username,
+          :user_home,
+          :deployment_user_home,
+          :manager_user_home,
+          :deploy_dir,
+          :deploy_name,
+          :deploy_to,
+          :app_server_ip,
+          :web_server_ip,
+          :db_server_ip,
+          :web_server_name,
+          :app_server_name,
+          :db_server_name
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end
+
+######################################################################
+#               DEFAULT UNIX SERVER ENVIRONMENT SETUP                #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for unix server deployments."
+      task :unix do
+        _cset :deployment_username,   "deploy"
+        _cset :manager_username,      "manager"
+        _cset :user,                  deployment_username
+
+        _cset :user_home,             "/home/#{user}"
+        _cset :manager_user_home,     "/home/#{manager_username}"
+        _cset :deployment_user_home,  "/home/#{deployment_username}"
+        _cset :deploy_dir,            "/var/www"
+        _cset :deploy_name,           "#{application_short}.#{domain}"
+        set   :deploy_to,             "#{deploy_dir}/#{deploy_name}"
+
+        _cset :keep_releases,         15
+
+        _cset :global_shared_files,   ["config/database.yml"]
+
+        _cset :app_server_ip,         server_ip
+        _cset :web_server_ip,         server_ip
+        _cset :db_server_ip,          server_ip
+
+        _cset :app_server_name,       server_name
+        _cset :web_server_name,       server_name
+        _cset :db_server_name,        server_name
+
+        # Evidently roles can't be assigned in a namespace :-/
+        set_unix_server_roles
+      end
+    end
+  end
+
+  desc "[internal] This task is only here because `role` cannot be used within a `namespace`"
+  task :set_unix_server_roles do
+    role :web,                  web_server_name, :primary => true
+    role :app,                  app_server_name, :primary => true
+    role :db,                   db_server_name,  :primary => true
+  end
+end

data/lib/chicken_soup/deploy.rb

@@ -0,0 +1,82 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  before "deploy",          "deploy:web:disable"
+  after  "deploy",          "deploy:web:enable"
+
+  before "deploy:migrate",  "db:backup"
+
+  namespace :deploy do
+    desc <<-DESC
+      [internal] The list of tasks used by `deploy`, `deploy:cold`, `deploy:subzero` and `deploy:initial`
+    DESC
+    task :base do
+      transaction do
+        deploy.update
+        deploy.config.symlink
+        gems.install
+        deploy.migrate
+        deploy.cleanup
+      end
+    end
+
+    desc <<-DESC
+      Used when you would like to be more forceful with your deployment.
+
+      It will forceably disable the site (from the web server layer), run a standard
+      deployment and re-enable the site.
+    DESC
+    task :cold do
+      transaction do
+        website.disable
+        deploy.base
+        website.enable
+      end
+    end
+
+    desc <<-DESC
+      When you just want to "FINISH HIM!", hit "Forward, Down, Forward, High Punch" \
+      and your website will be at your mercy.
+
+      It will forceably stop the web server, run a standard deployment, and restart \
+      the web server.
+    DESC
+    task :subzero do
+      transaction do
+        web_server.stop
+        deploy.base
+        web_server.start
+      end
+    end
+
+    desc <<-DESC
+      This task should be used only on the first deployment.
+
+      It will set up the deployment structure that Capistrano uses, create the DB, install
+      the website configuration files into the web server, and then run a standard "cold"
+      deployment.
+    DESC
+    task :initial do
+      transaction do
+        deploy.setup
+        db.create
+        website.install
+        deploy.cold
+        deploy.check
+      end
+    end
+
+    desc <<-DESC
+      The standard deployment task.
+
+      It will check out a new release of the code to the `releases` directory, update the
+      symlinks to the desired shared configuration files, install all necessary gems,
+      run all pending migrations, tag the git commit, perform a cleanup and restart
+      the application layer so that the changes will take effect.
+    DESC
+    task :default do
+      transaction do
+        deploy.base
+        deploy.restart
+      end
+    end
+  end
+end

data/lib/chicken_soup/environment/checks.rb

@@ -0,0 +1,39 @@
+######################################################################
+#                         ENVIRONMENT CHECKS                         #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  on      :start,                                 'environment:check', :except => ['staging', 'production']
+
+  before  'environment:check',                    'environment:check:common'
+
+  namespace :environment do
+    namespace :check do
+      desc "[internal] Checks for environment variables shared among all deployment types."
+      task :common do
+        abort "You need to specify staging or production when you deploy. ie 'cap staging db:backup'" unless exists?(:rails_env)
+        abort "You need to specify a deployment type in your application's 'deploy.rb' file. ie 'set :deployment_type, :heroku'" unless exists?(:deployment_type)
+
+        required_variables = [
+          :application,
+          :application_short
+        ]
+
+        verify_variables(required_variables)
+      end
+
+      desc "[internal] Runs checks for all of the capabilities listed."
+      task :capabilities do
+        if exists?(:capabilities)
+          fetch(:capabilities).each do |capability|
+            environment.check.send(capability.to_s) if environment.check.respond_to?(capability.to_sym)
+          end
+        end
+      end
+
+      desc "[internal] Checks to see if all the necessary environment variables have been set up for a proper deployment."
+      task :default do
+        environment.check.capabilities
+      end
+    end
+  end
+end

data/lib/chicken_soup/environment/defaults.rb

@@ -0,0 +1,53 @@
+######################################################################
+#                      DEFAULT ENVIRONMENT SETUP                     #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  after   'production',                           'environment:defaults:production', 'environment:defaults'
+  after   'staging',                              'environment:defaults:staging', 'environment:defaults'
+
+  before  'environment:defaults',                 'load_capabilities'
+
+  namespace :environment do
+    namespace :defaults do
+      desc "[internal] Used to set up the intelligent staging defaults we like for our projects"
+      task :staging do
+        set :rails_env,             "staging"
+      end
+
+      desc "[internal] Used to set up the intelligent production defaults we like for our projects"
+      task :production do
+        set :rails_env,             "production"
+      end
+
+      desc "[internal] Sets intelligent common defaults for deployments"
+      task :common do
+        _cset :use_sudo,                  false
+        _cset :default_shell,             false
+
+        _cset :copy_compression,          :bz2
+
+        _cset(:application_underscored)   {application.gsub(/-/, "_")}
+      end
+
+      desc "[internal] Sets defaults for all of the capabilities listed."
+      task :capabilities do
+        if exists?(:capabilities)
+          fetch(:capabilities).each do |capability|
+            environment.defaults.send(capability.to_s) if environment.defaults.respond_to?(capability.to_sym)
+          end
+        end
+      end
+
+      desc <<-DESC
+        [internal] Installs the entire environment for the given deployment type.
+
+        Most of these values can be overridden in each application's deploy.rb file.
+      DESC
+      task :default do
+        defaults.common
+        defaults.send(deployment_type.to_s)
+        defaults.capabilities
+      end
+    end
+  end
+end

data/lib/chicken_soup/environment.rb

@@ -0,0 +1,15 @@
+######################################################################
+#                          ENVIRONMENT SETUP                         #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'chicken_soup/environment/checks'
+  require 'chicken_soup/environment/defaults'
+
+  desc "[internal] This task is only here because `require` cannot be used within a `namespace`"
+  task :load_capabilities do
+    require "chicken_soup/capabilities/unix"
+    capabilities.each do |capability|
+      require "chicken_soup/capabilities/#{capability}"
+    end
+  end
+end

data/lib/chicken_soup/global.rb

@@ -0,0 +1,43 @@
+def close_sessions
+  sessions.values.each { |session| session.close }
+  sessions.clear
+end
+
+def set_user_to(username)
+  close_sessions
+  set :user,        username
+  set(:password)    {Capistrano::CLI.password_prompt("#{username.capitalize}'s Password: ")}
+  set(:user_home)   { user == "root" ? "/root" : "/home/#{username}" }
+end
+
+def run_task(task_name, options = {})
+  raise "#run_task must be passed an `:as` option so that it knows who to change the user to." unless options[:as]
+
+  original_username = exists?(:user) ? user : nil
+
+  if options[:now]
+    set_user_to options[:as]
+    find_and_execute_task(task_name)
+    set_user_to original_username
+  else
+    before task_name,     "os:users:#{options[:as]}:use"
+    after  task_name,     "os:users:#{original_username}:use"
+  end
+end
+
+def verify_variables(required_variables)
+  required_variables.each do |expected_variable|
+    abort( "You have not defined '#{expected_variable}' which is necessary for deployment." ) unless exists?(expected_variable)
+  end
+end
+
+# Taken from the capistrano code.
+def _cset(name, *args, &block)
+  unless exists?(name)
+    set(name, *args, &block)
+  end
+end
+
+def remote_file_exists?(file)
+  capture("if [ -f #{file} ]; then echo 'exists'; fi;").chomp == "exists"
+end

data/lib/chicken_soup/version.rb

@@ -1,3 +1,3 @@
 module ChickenSoup
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/chicken_soup.rb

@@ -1,3 +1,7 @@
-module ChickenSoup
-  # Your code goes here...
+if Object.const_defined?("Capistrano")
+  Capistrano::Configuration.instance(:must_exist).load do
+    require 'chicken_soup/global'
+    require 'chicken_soup/environment'
+    require 'chicken_soup/deploy'
+  end
 end