kompanee-recipes 0.0.10 → 0.1.0

data/lib/kompanee-recipes/bundler.rb

@@ -0,0 +1,24 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  set :rake,                  "bundle exec rake"
+
+  namespace :gems do
+    desc "Install Bundled Gems"
+    task :install do
+      run "cd #{current_path} && bundle install --gemfile #{current_path}/Gemfile --path #{shared_path}/bundle --deployment --quiet --without development test"
+    end
+
+    desc "Update Bundled Gems"
+    task :update do
+      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+
+      run "cd #{current_path} && bundle update"
+    end
+  end
+
+  namespace :bundler do
+    desc "Install Bundler"
+    task :install do
+      run "rvm use #{default_ruby_version}@global && gem install bundler --version #{bundler_version} --no-ri --no-rdoc"
+    end
+  end
+end

data/lib/kompanee-recipes/deploy.rb

@@ -1,264 +1,73 @@
-Capistrano::Configuration.instance(:must_exist).load do
-  set :use_sudo,              false
-  set :default_shell,         false
-  set :rake,                  "bundle install; bundle exec rake"
-
-  set(:application_safe)      {application.gsub(/-/, "_")}
-  
-  ######################################################################
-  #                         DATABASE SPECIFIC                          #
-  ######################################################################
-  set(:db_root_password)      {Capistrano::CLI.password_prompt("Root Password For DB: ")}
-  set(:db_app_password)       {Capistrano::CLI.password_prompt("App Password For DB: ")}
-  
-  ######################################################################
-  #                           VERSION CONTROL                          #
-  ######################################################################
-  set :scm,                   :git
-  set :github_account,        "thekompanee"
-  set(:repository)            {"git@github.com:#{github_account}/#{application}.git"}
-  set(:current_branch)        { `git branch`.match(/\* (\S+)\s/m)[1] || raise("Couldn't determine current branch") }
-  set :branch,                defer { current_branch }
-  set :deploy_via,            :remote_cache
-  ssh_options[:forward_agent] = true
-  
-  ######################################################################
-  #                         SYSTEM GEM VERSIONS                        #
-  ######################################################################
-  set :default_ruby_version,  "ruby-1.9.2-head"
-  set :app_ruby_version,      "ruby-1.9.2-head"
-  set :passenger_version,     "3.0.0"
-  set :bundler_version,       "1.0.7"
-  
-  ######################################################################
-  #                          DEPLOYMENT TASKS                          #
-  ######################################################################
-  on :start, "ensure_stage", :except => ["staging", "production"]
-
-  before 'deploy',                  'deploy:web:disable'
-  before 'deploy:migrate',          'deploy:backup'
-  after  'deploy:update_code',      'deploy:migrate'
-  after  'deploy:finalize_update',  'deploy:config:symlink'
-  after  'deploy:restart',          'deploy:tag'
-  after  'deploy',                  'deploy:cleanup', 'deploy:web:enable'
-
-  desc "[internal] Ensure that a rails_env to deploy to has been selected."
-  task :ensure_stage do
-    unless exists?(:rails_env)
-      abort "You need to specify staging or production when you deploy. ie 'cap deploy:staging' or 'cap staging db:backup'"
-    end
-  end
-
-  task :staging do
-    require 'kompanee-recipes/ubuntu_server_setup'
-    require 'kompanee-recipes/app_setup'
-    require 'kompanee-recipes/bash_environment'
+require 'kompanee-recipes/environment'
 
-    set :rails_env,             "staging"
-    set :domain,                "thekompanee.com"
-    
-    set(:user)                  {"deploy"}
-    set(:manager_user)          {ENV['CAP_MANAGER_USER'] || user}
-    set(:user_home)             {"/home/#{user}"}
-    set(:manager_user_home)     {"/home/#{manager_user}"}
-    set(:deploy_dir)            {"/var/www"}
-    set(:deploy_name)           {"#{application_short}.#{domain}"}
-    set(:deploy_to)             {"#{deploy_dir}/#{deploy_name}"}
-    
-    set :server_ip,             "174.143.210.58"
-    set :app_server_ip,         server_ip
-    set :web_server_ip,         server_ip
-    set :db_server_ip,          server_ip
-    
-    set(:server_name)           {"zeus.#{domain}"}
-    set :web_server_name,       server_name
-    set :app_server_name,       server_name
-    set :db_server_name,        server_name
-
-    role :web,                  web_server_name, :primary => true
-    role :app,                  app_server_name, :primary => true
-    role :db,                   db_server_name,  :primary => true
-    
-    role :ubuntu,               web_server_name, app_server_name, db_server_name
-    role :apache,               web_server_name
-    role :mysql,                db_server_name
-  end
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'kompanee-recipes/ariadne'
 
-  task :production do
-    set :rails_env,             "production"
+  before "deploy",          "deploy:web:disable"
+  after  "deploy",          "deploy:web:enable"
 
-    set :user,                  "heroku@thekompanee.com"
-    set(:password)              {Capistrano::CLI.password_prompt("Heroku Password: ")}
-
-    require 'kompanee-recipes/heroku_deploy'
-  end
+  before "deploy:migrate",  "db:backup"
 
   namespace :deploy do
-    task :start do ; end
-    task :stop do ; end
-    task :restart, :roles => :app, :except => { :no_release => true } do
-      run "touch #{File.join(current_path,'tmp','restart.txt')}"
-    end
-
-    task :tag do
-      timestamp_string_without_seconds = Time.now.strftime("%Y%m%d%H%M")
-      tag_name = "deployed_to_#{rails_env}_#{timestamp_string_without_seconds}"
-
-      `git tag -a -m "Tagging deploy to #{rails_env} at #{timestamp_string_without_seconds}" #{tag_name} #{branch}`
-      `git push --tags > /dev/null 2>&1 &`
-
-      puts "Tagged release with #{tag_name}"
-    end
-
-    namespace :gems do
-      desc "Install Bundled Gems"
-      task :install, :roles => :app do
-        Net::SSH.start(app_server_ip, user) do |ssh| 
-          ssh.exec!("cd #{current_path} && bundle install --gemfile #{release_path}/Gemfile --path #{shared_path}/bundle --deployment --quiet --without development test")
-        end
-      end
-
-      desc "Update Bundled Gems"
-      task :update, :roles => :app do
-        raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
-
-        Net::SSH.start(app_server_ip, user) do |ssh| 
-          ssh.exec!("cd #{current_path} && bundle update")
-        end
+    desc <<-DESC
+      [internal] The list of tasks used by `deploy`, `deploy:cold` and `deploy:initial`
+    DESC
+    task :base do
+      transaction do
+        deploy.update
+        deploy.config.symlink
+        gems.install
+        deploy.migrate
+        deploy.tag
+        deploy.cleanup
       end
     end
 
-    namespace :config do
-      task :create do
-        run "if [ ! -d #{shared_path}/config ]; then mkdir #{shared_path}/config; fi"
-        run "if [ ! -f #{shared_path}/config/database.yml ]; then cp #{latest_release}/config/database.#{rails_env}.yml #{shared_path}/config/database.yml; fi"
-      end
-
-      task :symlink do
-        config.create
-        run "ln -nfs #{shared_path}/config/database.yml #{latest_release}/config/database.yml"
+    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, re-enable the site, and restart the web server.
+    DESC
+    task :cold do
+      transaction do
+        website.disable
+        deploy.base
+        website.enable
+        web_server.restart
       end
     end
- 
-    namespace :web do
-      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 :enable, :roles => :web, :except => { :no_release => true } do
-        run "rm #{shared_path}/system/maintenance.html"
-      end
-
-      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 :disable, :roles => :web, :except => { :no_release => true } do
-        on_rollback { rm "#{shared_path}/system/maintenance.html" }
 
-        require 'erb'
-        deadline, reason = ENV['UNTIL'], ENV['REASON']
-
-        template = File.read("./app/views/pages/maintenance.html.erb")
-        maintenance_page = ERB.new(template).result(binding)
-
-        put maintenance_page, "#{shared_path}/system/maintenance.html", :mode => 0644
-      end
-
-      desc "Uses the Web Server to enable the site."
-      task :site_up, :roles => [:web, :apache, :ubuntu] do
-        ubuntu.apache.enable
-      end
-
-      desc "Uses the Web Server to disable the site."
-      task :site_down, :roles => [:web, :apache, :ubuntu] do
-        ubuntu.apache.disable
-      end
-  
-      desc "Takes the entire web server up."
-      task :server_up, :roles => [:web, :apache, :ubuntu] do
-        ubuntu.apache.start
-      end
-  
-      desc "Takes the entire web server down."
-      task :server_down, :roles => [:web, :apache, :ubuntu] do
-        ubuntu.apache.stop
-      end
-
-      desc "Restarts then entire web server."
-      task :server_restart, :roles => [:web, :apache, :ubuntu] do
-        ubuntu.apache.restart
-      end
-
-      desc "Installs the site configuration for the files."
-      task :install, :roles => [:web, :apache, :ubuntu] do
-        app_setup.apache.install_virtual_host
-      end
-
-      desc "Completely removes the site configuration from the server (but leaves the files.)"
-      task :remove, :roles => [:web, :apache] do
-        app_setup.apache.remove_virtual_host
+    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 "Make sure server has all necessary software for deployment."
-    task :server_setup, :roles => [:ubuntu] do
-      ubuntu.setup
-    end
-
-    desc "Prepare the server for deployment."
-    task :prepare do
-      deploy.db.create
-      deploy.web.install
-      deploy.setup
-      deploy.web.site_up
-      deploy.web.server_restart
-      deploy.check
-    end
-  end
-
-  namespace :db do
-    desc "Adds the DBizzle to the Sizzle.  Also adds the appropriate user."
-    task :create, :roles => :db do
-      app_setup.db.create
-    end
-
-    desc "Removes the DB from the Server.  Also removes the user."
-    task :drop, :roles => :db do
-      app_setup.db.drop
-    end
-
-    desc "Backup the database"
-    task :backup, :roles => :db do
-      run "cd #{current_path} && rake BACKUP_DIRECTORY=#{shared_path} RAILS_ENV=#{rails_env} db:backup"
-    end
-
-    desc "Reset database and seed fresh"
-    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 "Seed database"
-    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"
+    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/kompanee-recipes/environment.rb

@@ -0,0 +1,213 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  ######################################################################
+  #                          ENVIRONMENT SETUP                         #
+  ######################################################################
+  on :start, "environment_check", :except => ["staging", "production"]
+
+  after   'production',                       'defaults:production', 'defaults'
+  after   'staging',                          'defaults:staging', 'defaults'
+
+  after   'defaults:rackspace',               'defaults:managed_server'
+  after   'defaults:managed_server',          'load_capabilities'
+  after   'defaults:heroku',                  'load_capabilities'
+
+  before  'environment_check',                'environment_check:common'
+  after   'environment_check:rackspace',      'environment_check:managed_server'
+
+  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 defaults for managed server deployments."
+    task :managed_server do
+      set :default_ruby_version,  "ruby-1.9.2-head"                   unless exists?(:default_ruby_version)
+      set :app_ruby_version,      default_ruby_version                unless exists?(:app_ruby_version)
+      set :passenger_version,     "3.0.0"                             unless exists?(:passenger_version)
+      set :bundler_version,       "1.0.7"                             unless exists?(:bundler_version)
+
+      set :deployment_username,   "deploy"                            unless exists?(:deployment_user)
+      set :manager_username,      "manager"                           unless exists?(:manager_username)
+      set :user,                  deployment_username                 unless exists?(:user)
+
+      set :user_home,             "/home/#{user}"                     unless exists?(:user_home)
+      set :manager_user_home,     "/home/#{manager_username}"         unless exists?(:manager_user_home)
+      set :deployment_user_home,  "/home/#{deployment_username}"      unless exists?(:deployment_user_home)
+      set :deploy_dir,            "/var/www"                          unless exists?(:deploy_dir)
+      set :deploy_name,           "#{application_short}.#{domain}"    unless exists?(:deploy_name)
+      set :deploy_to,             "#{deploy_dir}/#{deploy_name}"
+
+      set :keep_releases,         15
+
+      set :global_shared_files,   ["config/database.yml"]             unless exists?(:global_shared_files)
+
+      set :app_server_ip,         server_ip                           unless exists?(:app_server_ip)
+      set :web_server_ip,         server_ip                           unless exists?(:web_server_ip)
+      set :db_server_ip,          server_ip                           unless exists?(:db_server_ip)
+      
+      set :app_server_name,       server_name                         unless exists?(:app_server_name)
+      set :web_server_name,       server_name                         unless exists?(:web_server_name)
+      set :db_server_name,        server_name                         unless exists?(:db_server_name)
+
+      # Evidently roles can't be assigned in a namespace :-/
+      set_managed_server_roles
+    end
+
+    desc "[internal] Sets intelligent defaults for Kompanee Rackspace deployments."
+    task :rackspace do
+      set :domain,                "thekompanee.com"                                                                       unless exists?(:domain)
+    
+      set :server_ip,             "174.143.212.245"                                                                        unless exists?(:server_ip)
+      set :server_name,           "zeus.#{domain}"                                                                        unless exists?(:server_name)
+
+      set :capabilities,          [:ubuntu, :mysql, :phpmyadmin, :php, :apache, :rvm, :vim, :bash, :bundler, :git, :passenger]  unless exists?(:capabilities)
+    end
+
+    desc "[internal] Sets intelligent defaults for Heroku deployments"
+    task :heroku do
+      set :heroku_credentials_path,   "#{ENV["HOME"]}/.heroku"                                          unless exists?(:heroku_credentials_path)
+      set :heroku_credentials_file,   "#{heroku_credentials_path}/credentials"                          unless exists?(:heroku_credentials_file)
+
+      set(:password)                  {Capistrano::CLI.password_prompt("Encrypted Heroku Password: ")}  unless exists?(:password)
+
+      set :capabilities,              [:heroku]
+    end
+
+    desc "[internal] Sets intelligent version control defaults for deployments"
+    task :vc do
+      set :scm,                   :git
+      set :github_account,        "thekompanee"                                                                           unless exists?(:github_account)
+      set(:repository)            {"git@github.com:#{github_account}/#{application}.git"}
+      set(:branch)                { `git branch`.match(/\* (\S+)\s/m)[1] || raise("Couldn't determine current branch") }
+      set(:remote)                { `git remote`.match(/(\S+)\s/m)[1] || raise("Couldn't determine default remote repository") }
+      set :deploy_via,            :remote_cache
+      ssh_options[:forward_agent] = true
+    end
+
+    desc "[internal] Sets intelligent common defaults for deployments"
+    task :common do
+      set :use_sudo,                    false
+      set :default_shell,               false
+
+      set(:application_underscored)     {application.gsub(/-/, "_")}                                unless exists?(:application_underscored)
+    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.
+      Unfortunately some of them can't be such as :scm but they're our recipies so...
+      LIVE WITH IT! :)
+    DESC
+    task :default do
+      defaults.common
+      defaults.vc
+      defaults.send(deployment_type.to_s)
+    end
+  end
+
+  namespace :environment_check do
+    desc <<-DESC
+      [internal] Checks to see if all necessary Kompanee Rackspace environment variables have been set up.
+    DESC
+    task :rackspace do
+      required_variables = [
+        :domain,
+        :server_ip,
+        :server_name,
+        :app_ruby_version
+      ]
+
+      required_variables.each do |expected_variable|
+        abort( "You have not defined '#{expected_variable}' which is necessary for a Kompanee Rackspace deployment." ) unless exists?(expected_variable)
+      end
+    end
+
+    desc <<-DESC
+      [internal] Checks to see if all necessary managed server environment variables have been set up.
+    DESC
+    task :managed_server do
+      required_variables = [
+        :os_type,
+        :default_ruby_version,
+        :app_ruby_version,
+        :passenger_version,
+        :bundler_version,
+        :user,
+        :deployment_username,
+        :manager_username,
+        :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
+      ]
+
+      required_variables.each do |expected_variable|
+        abort( "You have not defined '#{expected_variable}' which is necessary for a managed server deployment." ) unless exists?(expected_variable)
+      end
+    end
+
+    desc <<-DESC
+      [internal] Checks to see if all necessary Heroku environment variables have been set up.
+    DESC
+    task :heroku do
+      required_variables = [
+        :deploy_name,
+        :user
+      ]
+
+      required_variables.each do |expected_variable|
+        abort( "You have not defined '#{expected_variable}' which is necessary for a Heroku deployment." ) unless exists?(expected_variable)
+      end
+    end
+
+    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
+      ]
+
+      required_variables.each do |expected_variable|
+        abort( "You have not defined '#{expected_variable}' which is necessary for a deployment." ) unless exists?(expected_variable)
+      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.send(deployment_type.to_s)
+    end
+  end
+
+  desc "[internal] This task is only here because `role` cannot be used within a `namespace`"
+  task :set_managed_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
+
+  desc "[internal] This task is only here because `require` cannot be used within a `namespace`"
+  task :load_capabilities do
+    require "kompanee-recipes/#{deployment_type}"
+    capabilities.each do |capability|
+      require "kompanee-recipes/#{capability}"
+    end
+  end
+end