deployinator 0.1.5 → 0.1.6

data/lib/deployinator/built-in.rb

@@ -1,13 +1,13 @@
-set :deploy_log_level,            "debug"
 set :webserver_socket_path,       -> { shared_path.join('run') }
 set :deploy_templates_path,       "templates/deploy"
 set :jobs_app_name,               "jobs"
+set :deploy_custom_container_options, -> {} # Set customer Docker options w/o overriding methods below
 
 # Default deploy_to directory is /var/www/my_app
 # set :deploy_to, '/var/www/my_app'
 
 # Default value for :log_level is :debug
-# set :log_level, :debug
+set :log_level, :info
 
 # Default value for :linked_files is []
 # set :linked_files, %w{config/database.yml}
@@ -36,45 +36,50 @@ set :migration_role,                :db                   # Defaults to 'db'
 set :assets_roles,                  [:app]                # Defaults to [:web]
 #set :assets_prefix,                'prepackaged-assets'  # Defaults to 'assets' this should match config.assets.prefix in your rails config/application.rb
 
-# TODO: fix from_local, right now you have to copy-paste the set_scm method to your deploy.rb
-# Use `cap <stage> deploy from_local=true` to deploy your locally changed code
-#   instead of the code in the git repo. You can also add --trace.
-# You can set include_dir and exclude_dir settings (from capistrano-scm-copy gem).
-#   These will only apply when using the from_local=true option
-# set :include_dir, '../.*'
-# set :exclude_dir, ["../.$", "../..", '.././infrastructure']
-def set_scm
-  if ENV['from_local']
-    if "#{fetch(:stage)}" == "production"
-      run_locally do
-        fatal("You are trying to deploy to production using from_local, " +
-          "this should pretty much never be done.")
-      end
-      ask :yes_no, "Are you positive you want to continue?"
-      case fetch(:yes_no).chomp.downcase
-      when "yes"
-      when "no"
-        exit
-      else
-        warn "Please enter 'yes' or 'no'"
-        set_scm
-      end
-    end
-    set :scm, :copy
-  else
-    set :scm, :git
-  end
-end
-set_scm
+# # TODO: fix from_local, right now you have to copy-paste the set_scm method to your deploy.rb
+# # Use `cap <stage> deploy from_local=true` to deploy your locally changed code
+# #   instead of the code in the git repo. You can also add --trace.
+# # You can set include_dir and exclude_dir settings (from capistrano-scm-copy gem).
+# #   These will only apply when using the from_local=true option
+# # set :include_dir, '../.*'
+# # set :exclude_dir, ["../.$", "../..", '.././infrastructure']
+# def set_scm
+#   if ENV['from_local']
+#     if "#{fetch(:stage)}" == "production"
+#       run_locally do
+#         fatal("You are trying to deploy to production using from_local, " +
+#           "this should pretty much never be done.")
+#       end
+#       ask :yes_no, "Are you positive you want to continue?"
+#       case fetch(:yes_no).chomp.downcase
+#       when "yes"
+#       when "no"
+#         exit
+#       else
+#         warn "Please enter 'yes' or 'no'"
+#         set_scm
+#       end
+#     end
+#     set :scm, :copy
+#   else
+#     set :scm, :git
+#   end
+# end
+# set_scm
 
 def deploy_run_bluepill(host)
+  warn "Starting a new container named #{fetch(:ruby_container_name)} on #{host}"
   execute(
     "docker", "run", "--tty", "--detach",
+    # "--user", fetch(:webserver_username), TODO find out of this can run as the deployer user instead of root, if so, set the user, if not, fix rails console to su to www-data first
     "--name", fetch(:ruby_container_name),
+    "-e", "APP_STAGE=#{fetch(:stage)}",
+    "-e", "RAILS_ROOT=#{current_path}",
     "-e", "GEM_HOME=#{shared_path.join('bundle')}",
     "-e", "GEM_PATH=#{shared_path.join('bundle')}",
     "-e", "BUNDLE_GEMFILE=#{current_path.join('Gemfile')}",
     "-e", "PATH=#{shared_path.join('bundle', 'bin')}:$PATH",
+    fetch(:deploy_custom_container_options),
     "--restart", "always", "--memory", "#{fetch(:ruby_container_max_mem_mb)}m",
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
     "--entrypoint", shared_path.join('bundle', 'bin', 'bluepill'),
@@ -83,26 +88,34 @@ def deploy_run_bluepill(host)
   )
 end
 def deploy_bluepill_restart(host)
-  execute("docker", "exec", "--tty",
+  execute(
+    "docker", "exec", "--tty",
     fetch(:ruby_container_name),
     shared_path.join('bundle', 'bin', 'bluepill'),
-    fetch(:application), "restart")
+    fetch(:application), "restart"
+  )
 end
 def deploy_bluepill_stop(host)
-  execute("docker", "exec", "--tty",
+  execute(
+    "docker", "exec", "--tty",
     fetch(:ruby_container_name),
     shared_path.join('bundle', 'bin', 'bluepill'),
-    fetch(:application), "stop")
+    fetch(:application), "stop"
+  )
 end
 def deploy_run_bluepill_jobs(host)
   execute(
     "docker", "run", "--tty", "--detach",
+    "-w", current_path,
     "--user", fetch(:webserver_username),
     "--name", fetch(:ruby_jobs_container_name),
+    "-e", "APP_STAGE=#{fetch(:stage)}",
+    "-e", "RAILS_ROOT=#{current_path}",
     "-e", "GEM_HOME=#{shared_path.join('bundle')}",
     "-e", "GEM_PATH=#{shared_path.join('bundle')}",
     "-e", "BUNDLE_GEMFILE=#{current_path.join('Gemfile')}",
     "-e", "PATH=#{shared_path.join('bundle', 'bin')}:$PATH",
+    fetch(:deploy_custom_container_options),
     "--restart", "always", "--memory", "#{fetch(:ruby_jobs_container_max_mem_mb)}m",
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
     "--entrypoint", shared_path.join('bundle', 'bin', 'rabid_jobs_tasker'),
@@ -123,10 +136,13 @@ def deploy_run_cadvisor(host)
     "google/cadvisor:latest"
   )
 end
+# TODO change these both to run as webserver_username
+#   also offer Rails 2.X versions
 def deploy_rails_console(host)
   [
     "ssh", "-t", "#{host}", "\"docker", "exec", "--interactive", "--tty",
     fetch(:ruby_container_name),
+    # "sudo", "-u", fetch(:webserver_username), TODO, find out if running bluepill as www-data works, otherwise add this line
     "bash", "-c", "'cd", current_path, "&&",
     shared_path.join('bundle', 'bin', 'rails'),
     "console", "#{fetch(:rails_env)}'\""
@@ -149,7 +165,7 @@ def sshkit_bundle_command_map
     "-e", "GEM_PATH=#{shared_path.join('bundle')}",
     "-e", "PATH=#{shared_path.join('bundle', 'bin')}:$PATH",
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
-    "--volume", "$SSH_AUTH_SOCK:/ssh-agent --env SSH_AUTH_SOCK=/ssh-agent",
+    "--volume", "$SSH_AUTH_SOCK:/ssh-agent:rw", "--env SSH_AUTH_SOCK=/ssh-agent",
     "--volume", "/home:/home:rw",
     "--volume", "/etc/passwd:/etc/passwd:ro",
     "--volume", "/etc/group:/etc/group:ro",
@@ -158,35 +174,49 @@ def sshkit_bundle_command_map
   ].join(' ')
 end
 def deploy_assets_precompile(host)
-  execute("docker", "run", "--rm", "--tty", "--user", fetch(:webserver_username),
+  execute(
+    "docker", "run", "--rm", "--tty", "--user", fetch(:webserver_username),
+    "-e", "APP_STAGE=#{fetch(:stage)}",
+    "-e", "RAILS_ROOT=#{current_path}",
     "-w", release_path,
     "--volume", "/home:/home:rw",
     "--volume", "/etc/passwd:/etc/passwd:ro",
     "--volume", "/etc/group:/etc/group:ro",
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
+    fetch(:deploy_custom_container_options),
     "--entrypoint", "/bin/bash",
     fetch(:ruby_image_name), "-c",
     "\"umask", "0007", "&&", "#{shared_path.join('bundle', 'bin', 'rake')}",
-    "assets:precompile\"")
+    "assets:precompile\""
+  )
 end
 def deploy_assets_cleanup(host)
-  execute("docker", "run", "--rm", "--tty",
+  execute(
+    "docker", "run", "--rm", "--tty",
     "-e", "RAILS_ENV=#{fetch(:rails_env)}",
     "-w", release_path,
+    fetch(:deploy_custom_container_options),
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
     "--entrypoint", shared_path.join('bundle', 'bin', 'bundle'),
-    fetch(:ruby_image_name), "exec", "rake", "assets:clean")
+    fetch(:ruby_image_name), "exec", "rake", "assets:clean"
+  )
 end
 def deploy_rake_db_migrate(host)
-  execute("docker", "run", "--rm", "--tty",
+  execute(
+    "docker", "run", "--rm", "--tty",
     "-w", release_path,
+    "-e", "APP_STAGE=#{fetch(:stage)}",
+    "-e", "RAILS_ROOT=#{current_path}",
     "-e", "RAILS_ENV=#{fetch(:rails_env)}",
+    fetch(:deploy_custom_container_options),
     "--volume", "#{fetch(:deploy_to)}:#{fetch(:deploy_to)}:rw",
     "--entrypoint", shared_path.join('bundle', 'bin', 'rake'),
-    fetch(:ruby_image_name), "db:migrate")
+    fetch(:ruby_image_name), "db:migrate"
+  )
 end
 def deploy_install_bundler(host)
-  execute("docker", "run", "--rm", "--tty", "--user", fetch(:deployment_username),
+  execute(
+    "docker", "run", "--rm", "--tty", "--user", fetch(:deployment_username),
     "-e", "GEM_HOME=#{shared_path.join('bundle')}",
     "-e", "GEM_PATH=#{shared_path.join('bundle')}",
     "-e", "PATH=#{shared_path.join('bundle', 'bin')}:$PATH",
@@ -199,5 +229,6 @@ def deploy_install_bundler(host)
     "\"umask", "0007", "&&" "/usr/local/bin/gem", "install",
     "--install-dir", "#{shared_path.join('bundle')}",
     "--bindir", shared_path.join('bundle', 'bin'),
-    "--no-ri", "--no-rdoc", "--quiet", "bundler", "-v'#{fetch(:bundler_version)}'\"")
+    "--no-ri", "--no-rdoc", "--quiet", "bundler", "-v'#{fetch(:bundler_version)}'\""
+  )
 end

data/lib/deployinator/check.rb

@@ -1,33 +1,27 @@
 namespace :deploy do
   namespace :check do
 
-    task :bundle_command_map do
+    task :bundle_command_map => 'deployinator:load_settings' do
       set :bundle_binstubs, -> { shared_path.join('bundle', 'bin') }
       set :bundle_gemfile,  -> { release_path.join('Gemfile') }
       SSHKit.config.command_map[:bundle] = sshkit_bundle_command_map
     end
-    before 'bundler:install', 'deploy:check:bundle_command_map'
+    if Rake::Task.task_defined?("bundler:install")
+      before 'bundler:install', 'deploy:check:bundle_command_map'
+    end
 
     # Ensure Capistrano's inner rm commands always run using sudo
-    before 'deploy:started', :rm_command_map do
+    task :rm_command_map => 'deployinator:load_settings' do
       SSHKit.config.command_map[:rm] = "/usr/bin/env sudo rm"
     end
-
-    before 'deploy:check', :brakeman_reminder do
-      run_locally do
-        warn "Remember to run brakeman before deploying!"
-        ask :return_to_continue, nil
-        set :nothing, fetch(:return_to_continue)
-      end
-    end
-
+    before 'deploy:started', 'deploy:check:rm_command_map'
     if Rake::Task.task_defined?("deploy:cleanup")
       # Append dependancy to existing cleanup task
       task 'deploy:cleanup' => 'deploy:check:rm_command_map'
     end
 
     desc 'Ensure all deployinator specific settings are set, and warn and raise if not.'
-    before 'deploy:check', :settings do
+    task :settings => 'deployinator:load_settings' do
       {
         (File.dirname(__FILE__) + "/examples/config/deploy.rb") => 'config/deploy.rb',
         (File.dirname(__FILE__) + "/examples/config/deploy/staging.rb") => "config/deploy/#{fetch(:stage)}.rb"
@@ -36,9 +30,10 @@ namespace :deploy do
         Rake::Task['deployinator:settings'].reenable
       end
     end
+    before 'deploy:check', 'deploy:check:settings'
 
     # TODO make this better
-    before 'deploy:check', :templates do
+    task :templates => 'deployinator:load_settings' do
       run_locally do
         path = fetch(:deploy_templates_path)
         keys_template          = File.expand_path("./#{path}/deployment_authorized_keys.erb")
@@ -50,11 +45,9 @@ namespace :deploy do
         end
       end
     end
+    before 'deploy:check', 'deploy:check:templates'
 
-    before 'deploy:check', 'deployinator:deployment_user'
-    before 'deploy:check', 'deployinator:webserver_user'
-
-    task :root_dir_permissions => ['deployinator:deployment_user', 'deployinator:webserver_user'] do
+    task :root_dir_permissions => ['deployinator:load_settings', 'deployinator:deployment_user', 'deployinator:webserver_user'] do
       on roles(:app) do
         as :root do
           [fetch(:deploy_to), Pathname.new(fetch(:deploy_to)).join("../"), shared_path].each do |dir|
@@ -68,7 +61,7 @@ namespace :deploy do
     end
     before 'deploy:check:directories', 'deploy:check:root_dir_permissions'
 
-    before 'deploy:check', :postgres_running do
+    task :postgres_running => 'deployinator:load_settings' do
       on roles(:app) do
         unless localhost_port_responding?(fetch(:postgres_port))
           fatal "Port #{fetch(:postgres_port)} is not responding, we won't be able to db:migrate!"
@@ -76,8 +69,9 @@ namespace :deploy do
         end
       end
     end
+    before 'deploy:check', 'deploy:check:postgres_running'
 
-    before 'deploy:check', :ensure_cadvisor do
+    task :ensure_cadvisor => 'deployinator:load_settings' do
       on roles(:app) do |host|
         if fetch(:use_cadvisor, true)
           if container_exists?("cadvisor")
@@ -97,6 +91,7 @@ namespace :deploy do
         end
       end
     end
+    before 'deploy:check', 'deploy:check:ensure_cadvisor'
 
   end
 end

data/lib/deployinator/config.rb

@@ -12,11 +12,14 @@ module Capistrano
 end
 
 namespace :deployinator do
+  task :load_settings do
+    load "./config/deploy.rb"
+    SSHKit.config.output_verbosity = fetch(:log_level)
+  end
 
   set :example, "_example"
-
   desc 'Write example config files'
-  task :write_example_configs do
+  task :write_example_configs => 'deployinator:load_settings' do
     run_locally do
       path = fetch(:deploy_templates_path, 'templates/deploy')
       execute "mkdir", "-p", "config/deploy", path
@@ -28,6 +31,7 @@ namespace :deployinator do
         "examples/deployment_authorized_keys.erb" =>
           "#{path}/deployment_authorized_keys#{fetch(:example)}.erb",
         "examples/unicorn.rb.erb"                 => "#{path}/unicorn#{fetch(:example)}.rb.erb",
+        "examples/database.yml.erb"               => "#{path}/database#{fetch(:example)}.yml.erb",
         "examples/bluepill.rb.erb"                => "#{path}/bluepill#{fetch(:example)}.rb.erb",
       }.each do |source, destination|
         config = File.read(File.dirname(__FILE__) + "/#{source}")
@@ -43,14 +47,14 @@ namespace :deployinator do
 
   desc 'Write example config files (will overwrite any existing config files).'
   namespace :write_example_configs do
-    task :in_place do
+    task :in_place => 'deployinator:load_settings' do
       set :example, ""
       Rake::Task['deployinator:write_example_configs'].invoke
     end
   end
 
   desc 'Write a file showing the built-in overridable settings.'
-  task :write_built_in do
+  task :write_built_in => 'deployinator:load_settings' do
     run_locally do
       {
         'built-in.rb'                         => 'built-in.rb',
@@ -66,7 +70,7 @@ namespace :deployinator do
   # These are the only two tasks using :preexisting_ssh_user
   namespace :deployment_user do
     #desc "Setup or re-setup the deployment user, idempotently"
-    task :setup do
+    task :setup => 'deployinator:load_settings' do
       on roles(:all) do |h|
         on "#{fetch(:preexisting_ssh_user)}@#{h}" do |host|
           as :root do
@@ -77,7 +81,7 @@ namespace :deployinator do
     end
   end
 
-  task :deployment_user do
+  task :deployment_user => 'deployinator:load_settings' do
     on roles(:all) do |h|
       on "#{fetch(:preexisting_ssh_user)}@#{h}" do |host|
         as :root do
@@ -90,22 +94,26 @@ namespace :deployinator do
       end
     end
   end
+  before 'deploy:check', 'deployinator:deployment_user'
 
-  task :webserver_user do
+  task :webserver_user => 'deployinator:load_settings' do
     on roles(:app) do
       as :root do
         unix_user_add(fetch(:webserver_username)) unless unix_user_exists?(fetch(:webserver_username))
       end
     end
   end
+  before 'deploy:check', 'deployinator:webserver_user'
 
-  task :file_permissions => [:deployment_user, :webserver_user] do
+  task :file_permissions => [:load_settings, :deployment_user, :webserver_user] do
     on roles(:app) do
       as :root do
         setup_file_permissions
       end
     end
   end
+  # TODO the file_permissions task after 'deploy:check' may be able to be replaced
+  #   with only chowning the releases dir and another dir or two.
   after   'deploy:check',   'deployinator:file_permissions'
   before  'deploy:restart', 'deployinator:file_permissions'
 

data/lib/deployinator/deploy.rb

@@ -3,14 +3,8 @@ lock '3.2.1'
 
 namespace :deploy do
 
-  before :starting, :log_level do
-    SSHKit.config.output_verbosity = fetch(:deploy_log_level)
-  end
-
-  before :starting, 'deployinator:sshkit_umask'
-
   # Default branch is :master
-  before :starting, :set_branch do
+  task :set_branch => 'deployinator:load_settings' do
     unless ENV['from_local']
       # Always use the master branch in production:
       unless "#{fetch(:stage)}" == "production"
@@ -18,9 +12,10 @@ namespace :deploy do
       end
     end
   end
+  before :starting, :set_branch
 
   #desc 'Copies .git folder to support .gemspecs that run git commands'
-  task :copy_git do
+  task :copy_git => 'deployinator:load_settings' do
     unless ENV['from_local'] == "true"
       on roles(:app) do
         within release_path do
@@ -29,13 +24,15 @@ namespace :deploy do
       end
     end
   end
-  before 'bundler:install', 'deploy:copy_git'
+  if Rake::Task.task_defined?("bundler:install")
+    before 'bundler:install', 'deploy:copy_git'
+  end
 
   if Rake::Task.task_defined?("deploy:assets:precompile")
     # Overwrite :assets:precompile to use docker
     Rake::Task["deploy:assets:precompile"].clear_actions
     namespace :assets do
-      task :precompile do
+      task :precompile => 'deployinator:load_settings' do
         on roles(fetch(:assets_roles)) do |host|
           deploy_assets_precompile(host)
         end
@@ -47,7 +44,7 @@ namespace :deploy do
     # Overwrite :cleanup_assets to use docker
     Rake::Task["deploy:cleanup_assets"].clear_actions
     desc 'Cleanup expired assets'
-    task :cleanup_assets => [:set_rails_env] do
+    task :cleanup_assets => ['deployinator:load_settings', :set_rails_env] do
       on roles(fetch(:assets_roles)) do |host|
         deploy_assets_cleanup(host)
       end
@@ -58,7 +55,7 @@ namespace :deploy do
     # Overwrite :migrate to use docker
     Rake::Task["deploy:migrate"].clear_actions
     desc 'Runs rake db:migrate if migrations are set'
-    task :migrate => [:set_rails_env, 'deploy:check:postgres_running'] do
+    task :migrate => ['deployinator:load_settings', :set_rails_env, 'deploy:check:postgres_running'] do
       on primary fetch(:migration_role) do |host|
         conditionally_migrate = fetch(:conditionally_migrate)
         info '[deploy:migrate] Checking changes in /db/migrate' if conditionally_migrate
@@ -72,17 +69,35 @@ namespace :deploy do
     end
   end
 
-  task :install_bundler do
+  task :install_bundler => 'deployinator:load_settings' do
     on roles(:app) do |host|
       unless file_exists?(shared_path.join('bundle', 'bin', 'bundle'))
         deploy_install_bundler(host)
       end
     end
   end
-  before 'bundler:install', 'deploy:install_bundler'
+  if Rake::Task.task_defined?("bundler:install")
+    before 'bundler:install', 'deploy:install_bundler'
+  end
+
+  task :install_database_yml => 'deployinator:load_settings' do
+    on roles(:app) do |host|
+      config_file = "database.yml"
+      template_path = File.expand_path("./#{fetch(:deploy_templates_path)}/#{config_file}.erb")
+      generated_config_file = ERB.new(File.new(template_path).read).result(binding)
+      set :final_path, -> { release_path.join('config', config_file) }
+      upload! StringIO.new(generated_config_file), "/tmp/#{config_file}"
+      execute("mv", "/tmp/#{config_file}", fetch(:final_path))
+      as :root do
+        execute("chown", "#{fetch(:deployment_username)}:#{fetch(:webserver_username)}", fetch(:final_path))
+      end
+    end
+  end
+  before 'deploy:updated', 'deploy:install_database_yml'
+
 
   desc 'Restart application using bluepill restart inside the docker container.'
-  task :restart => [:install_config_files, 'deploy:check:settings'] do
+  task :restart => ['deployinator:load_settings', :install_config_files, 'deploy:check:settings'] do
     on roles(:app) do |host|
       name = fetch(:ruby_container_name)
       if container_exists?(name)
@@ -98,7 +113,6 @@ namespace :deploy do
         as :root do
           execute("rm", "-f", fetch(:webserver_socket_path).join('unicorn.pid'))
         end
-        warn "Starting a new container named #{name} on #{host}"
         deploy_run_bluepill(host)
         check_stayed_running(name)
       end
@@ -106,9 +120,9 @@ namespace :deploy do
   end
   after :publishing, :restart
 
-  desc 'Restart application by recreating the docker container.'
   namespace :restart do
-    task :force => [:install_config_files, 'deploy:check:settings'] do
+    desc 'Restart application by recreating the Docker container'
+    task :force => ['deployinator:load_settings', :install_config_files, 'deploy:check:settings'] do
       on roles(:app) do |host|
         name = fetch(:ruby_container_name)
         if container_exists?(name)
@@ -125,7 +139,7 @@ namespace :deploy do
             begin
               execute("docker", "rm",   name)
             rescue
-              fatal "We were not able to remove the container for some reason. Try running 'cap <stage> deploy:restart:force' again."
+              fatal "We were not able to remove the container #{name} for some reason. Try running 'cap <stage> deploy:restart:force' again."
             end
           end
         end
@@ -143,7 +157,7 @@ namespace :deploy do
 #    end
 #  end
 
-  task :install_config_files do
+  task :install_config_files => 'deployinator:load_settings' do
     on roles(:app) do |host|
       ["bluepill.rb", "unicorn.rb"].each do |config_file|
         template_path = File.expand_path("./#{fetch(:deploy_templates_path)}/#{config_file}.erb")
@@ -159,7 +173,7 @@ namespace :deploy do
   end
 
   desc "Enter the Rails console."
-  task :rails_console do
+  task :rails_console => 'deployinator:load_settings' do
     on roles(:app) do |host|
       info "Entering Rails Console inside #{fetch(:ruby_container_name)} on #{host}"
       system deploy_rails_console(host)
@@ -167,7 +181,7 @@ namespace :deploy do
   end
 
   namespace :rails_console do
-    task :print do
+    task :print => 'deployinator:load_settings' do
       on roles(:app) do |host|
         info "You can SSH into #{host} and run the following command to enter the Rails Console."
         info deploy_rails_console_print(host)
@@ -176,7 +190,7 @@ namespace :deploy do
   end
 
   desc "Write Version file on server"
-  after 'deploy:finished', :write_version_file do
+  task :write_version_file => 'deployinator:load_settings' do
     on roles(:app) do |host|
       execute "echo", "\"<version>", "<release>#{fetch(:current_revision)}</release>",
         "<deployed_at>#{Time.now.strftime('%m/%d/%Y at %H:%M %Z')}</deployed_at>",
@@ -184,11 +198,46 @@ namespace :deploy do
         "</version>\"", ">", current_path.join('public', 'version.xml')
     end
   end
+  after 'deploy:finished', 'deploy:write_version_file'
 
-  after 'deploy:finished', :success_message do
+  task :success_message => 'deployinator:load_settings' do
     run_locally do
       info "That was a successful deploy!"
     end
   end
+  after 'deploy:finished', 'deploy:success_message'
+
+  # the purpose of this task is to prevent hang during a bundle
+  #   install that needs to reach github for the first time and will otherwise
+  #   block asking "Are you sure you want to continue connecting (yes/no)?"
+  # this is only needed when deploying to a server for the first time using from_local=true.
+  task :add_repo_hostkeys => 'deployinator:load_settings' do
+    on roles(:app) do
+      if fetch(:repo_url).include? "@"
+        host = fetch(:repo_url).split(":").shift
+        socket = capture "echo", "$SSH_AUTH_SOCK"
+        with :ssh_auth_sock => socket do
+          if test(
+              "ssh", "-T", "-o", "StrictHostKeyChecking=no", "#{host};",
+              "EXIT_CODE=$?;",
+              "if", "[", "$EXIT_CODE", "-eq", "1", "];",
+                "then", "exit", "0;",
+              "else",
+                "exit", "$EXIT_CODE;",
+              "fi"
+            )
+            info "Successfully added #{host} to known host keys"
+          else
+            fatal "Not able to add #{host}'s ssh keys to the known hosts"
+          end
+        end
+      else
+        warn "Repo URL does not appear to use SSH, not adding to known hosts"
+      end
+    end
+  end
+  if Rake::Task.task_defined?("bundler:install")
+    before 'bundler:install', 'deploy:add_repo_hostkeys'
+  end
 
 end

data/lib/deployinator/examples/config/deploy.rb

@@ -8,10 +8,16 @@ set :application,                   'my_app_name'
 set :preexisting_ssh_user,          ENV['USER']
 set :deployment_username,           "deployer" # user with SSH access and passwordless sudo rights
 set :webserver_username,            "www-data" # less trusted web server user with limited write permissions
+set :database_name,                 "db_name"
+set :database_username,             "db_username"
+set :database_password,             "db_password"
+# All permissions changes are recursive, and unless overridden below,
+#   all folders will be "deployer www-data drwxr-s---",
+#   all files will be   "deployer www-data -rw-r-----"
 set :webserver_owned_dirs,          [shared_path.join('tmp', 'cache'), shared_path.join('public', 'assets')]
 set :webserver_writeable_dirs,      [shared_path.join('run'), shared_path.join("tmp"), shared_path.join("log")]
 set :webserver_executable_dirs,     [shared_path.join("bundle", "bin")]
-set :ignore_permissions_dirs,       [shared_path.join("postgres"), shared_path.join("nginx")]
+set :ignore_permissions_dirs,       [shared_path.join("postgres"), shared_path.join("nginx"), "#{fetch(:deploy_to)}/releases"]
 
 # Default value for linked_dirs is []
 # set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}

data/lib/deployinator/examples/database.yml.erb

@@ -0,0 +1,10 @@
+---
+production:
+  adapter:  postgresql
+  database: <%= fetch(:database_name) %>
+  username: <%= fetch(:database_username) %>
+  password: <%= fetch(:database_password) %>
+  host:     <%= fetch(:postgres_socket_path) %>
+  pool:     5
+  encoding: UTF8
+  timeout:  500

data/lib/deployinator/helpers.rb

@@ -1,10 +1,11 @@
 namespace :deployinator do
 
-  task :sshkit_umask do
+  task :sshkit_umask => 'deployinator:load_settings' do
     SSHKit.config.umask = "0027"
   end
+  before 'deploy:starting', 'deployinator:sshkit_umask'
 
-  task :settings, [:absolute_path, :relative_path] do |t, args|
+  task :settings, [:absolute_path, :relative_path] => 'deployinator:load_settings' do |t, args|
     run_locally do
       if fetch(:print_all)
         lines = "\nThe following settings are needed in your config (#{args.relative_path}).\n"
@@ -33,7 +34,7 @@ end
 
 
 def deployment_user_setup(templates_path)
-  require 'erb' unless defined?(ERB)
+  require 'erb'
   name = fetch(:deployment_username)
   unix_user_add(name) unless unix_user_exists?(name)
   execute "usermod", "-a", "-G", "sudo,docker,#{fetch(:webserver_username)}", name
@@ -48,46 +49,75 @@ def deployment_user_setup(templates_path)
   execute "chmod", "600", "/home/#{name}/.ssh/authorized_keys"
 end
 
+# TODO when replacing this method with the new one, make sure the releases dir itself gets permissioned, just not it's contents.
 def setup_file_permissions
+
   ignore_options = fetch(:ignore_permissions_dirs).collect do |dir|
     ["-not", "-path", "\"#{dir}\"", "-not", "-path", "\"#{dir}/*\""]
   end
+  ignore_options += ["-not", "-path", "\"#{fetch(:deploy_to)}/releases/*\""]
   chown_ignore_options = fetch(:webserver_owned_dirs).collect do |dir|
     ["-not", "-path", "\"#{dir}\"", "-not", "-path", "\"#{dir}/*\""]
   end
+
   # chown webserver owned
   fetch(:webserver_owned_dirs).each do |dir|
     if directory_exists?(dir)
       execute "find", dir, ignore_options,
-        "-exec", "chown", "#{fetch(:webserver_username)}:#{fetch(:webserver_username)}", "{}", "+"
+        '\(', "-not", "-user", fetch(:webserver_username), "-or",
+        "-not", "-group", fetch(:webserver_username), '\)',
+        "-print0", "|", "xargs", "--no-run-if-empty", "--null",
+        "chown", "#{fetch(:webserver_username)}:#{fetch(:webserver_username)}"
+    else
+      execute "mkdir", "-p", dir
+      execute "chown", "#{fetch(:webserver_username)}:#{fetch(:webserver_username)}", dir
     end
   end
+
   # chown
   execute "find", fetch(:deploy_to), ignore_options, chown_ignore_options,
-    "-exec", "chown", "#{fetch(:deployment_username)}:#{fetch(:webserver_username)}", "{}", "+"
+    '\(', "-not", "-user", fetch(:deployment_username), "-or",
+    "-not", "-group", fetch(:webserver_username), '\)',
+    "-print0", "|", "xargs", "--no-run-if-empty", "--null",
+    "chown", "#{fetch(:deployment_username)}:#{fetch(:webserver_username)}"
+
   # chmod executable
   fetch(:webserver_executable_dirs).each do |dir|
     if directory_exists?(dir)
       execute "find", dir, "-type", "f",
-        "-exec", "chmod", "0750", "{}", "+"
+        "-not", "-perm", "0750",
+        "-print0", "|", "xargs", "--no-run-if-empty", "--null", "chmod", "0750"
+    # else # don't do this mkdir because it gets run as root and doesn't chown parent dirs
+    #   execute "mkdir", "-p", dir
+    #   execute "chown", "#{fetch(:deployment_username)}:#{fetch(:webserver_username)}", dir
     end
     ignore_options += ["-not", "-path", "\"#{dir}\"", "-not", "-path", "\"#{dir}/*\""]
   end
+
   # chmod writable
   fetch(:webserver_writeable_dirs).each do |dir|
     if directory_exists?(dir)
       execute "find", "-L", dir, "-type", "d",
-        "-exec", "chmod", "2770", "{}", "+"
+        "-not", "-perm", "2770",
+        "-print0", "|", "xargs", "--no-run-if-empty", "--null", "chmod", "2770"
       execute "find", "-L", dir, "-type", "f",
-        "-exec", "chmod", "0660", "{}", "+"
+        "-not", "-perm", "0660",
+        "-print0", "|", "xargs", "--no-run-if-empty", "--null", "chmod", "0660"
+    else
+      execute "mkdir", "-p", dir
+      execute "chown", "#{fetch(:deployment_username)}:#{fetch(:webserver_username)}", dir
+      execute "chmod", "2770", dir
     end
     ignore_options += ["-not", "-path", "\"#{dir}\"", "-not", "-path", "\"#{dir}/*\""]
   end
+
   # chmod
   execute "find", fetch(:deploy_to), "-type", "d", ignore_options,
-    "-exec", "chmod", "2750", "{}", "+"
+    "-not", "-perm", "2750",
+    "-print0", "|", "xargs", "--no-run-if-empty", "--null", "chmod", "2750"
   execute "find", fetch(:deploy_to), "-type", "f", ignore_options,
-    "-exec", "chmod", "0640", "{}", "+"
+    "-not", "-perm", "0640",
+    "-print0", "|", "xargs", "--no-run-if-empty", "--null", "chmod", "0640"
 end
 
 def container_exists?(container_name)

data/lib/deployinator/jobs.rb

@@ -2,7 +2,7 @@ namespace :deploy do
   namespace :jobs do
 
     desc 'Restart jobs using bluepill restart inside the docker container.'
-    task :restart => ['deploy:check:settings'] do
+    task :restart => ['deployinator:load_settings', 'deploy:check:settings'] do
       on roles(:app) do |host|
         name = fetch(:ruby_jobs_container_name)
         if container_exists?(name)
@@ -24,11 +24,11 @@ namespace :deploy do
         end
       end
     end
-    after 'deploy:restart', :restart
+    after 'deploy:restart', 'deploy:jobs:restart'
 
     desc 'Restart application by recreating the docker container.'
     namespace :restart do
-      task :force => ['deploy:check:settings'] do
+      task :force => ['deployinator:load_settings', 'deploy:check:settings'] do
         on roles(:app) do |host|
           name = fetch(:ruby_jobs_container_name)
           if container_exists?(name)
@@ -50,6 +50,7 @@ namespace :deploy do
         end
       end
     end
+    before 'deploy:restart:force', 'deploy:jobs:restart:force'
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deployinator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +94,7 @@ files:
 - lib/deployinator/examples/Dockerfile
 - lib/deployinator/examples/deployment_authorized_keys.erb
 - lib/deployinator/examples/unicorn.rb.erb
+- lib/deployinator/examples/database.yml.erb
 - lib/deployinator/examples/bluepill.rb.erb
 homepage: https://github.com/snarlysodboxer/deployinator
 licenses:
@@ -106,3 +123,4 @@ signing_key:
 specification_version: 3
 summary: Deploy Applications
 test_files: []
+has_rdoc: