k3_capistrano 1.0.0

data/lib/k3_capistrano/ensure_db_is_set_up.rb

@@ -0,0 +1,34 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+require 'parseconfig'
+require 'facets/string/cleanlines'
+
+namespace :deploy do
+  task :is_db_set_up do
+    #puts %(list_tables=#{(list_tables).to_a.inspect})
+    db.list_tables.include? 'schema_migrations'
+  end
+
+  task :ensure_db_is_set_up do
+    if !is_db_set_up
+      puts "Database #{application} has not been set up/migrated yet. Setting up via '#{db_setup_method}' now..."
+
+      case db_setup_method
+      when 'db:setup'
+        db.setup
+      when 'db:migrate'
+        deploy.migrate
+      when 'restore_backup'
+        raise "backup_to_restore_for_initial_setup must be set if db_setup_method is 'restore_backup'" unless exists?(:backup_to_restore_for_initial_setup)
+        set :which_backup, "#{db_backups_dir}/#{backup_to_restore_for_initial_setup}"
+        backup.restore
+      else
+        raise ArgumentError, "unknown db_setup_method #{db_setup_method.inspect}"
+      end
+    end
+  end
+end
+
+require 'capistrano_database_yml'
+
+end

data/lib/k3_capistrano/git.rb

@@ -0,0 +1,37 @@
+# Git
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+require 'timeout'
+require 'facets/string/cleanlines'
+
+namespace :git do
+  desc "Checks to see if your branch is ahead of its remote and needs to be pushed. Because it's easy to forget to git push..."
+  task :check_if_needs_push do
+    lines = `git status`.cleanlines.grep(/Your branch is ahead of|Your branch and.*have diverged/)
+    if lines.any?
+      beep
+      puts lines
+      response = nil
+      begin
+        timeout(wait_for = 15) do
+          response = Capistrano::CLI.ui.ask("Do you want to git push now? y/n")
+        end
+      rescue Timeout::Error
+        puts "No response after #{wait_for} seconds. Continuing without push..."
+      end
+
+      if response == 'y'
+        git.push
+      end
+    end
+  end
+
+  desc "Pushes your local commits to the git server so that they will actually get deployed"
+  task :push do
+    system "git push origin"
+    abort "git push failed" unless $?.success?
+  end
+end
+
+end

data/lib/k3_capistrano/logs.rb

@@ -0,0 +1,20 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+namespace :logs do
+  desc "tail all 4 app log files to help you debug problems with your app (n={number of lines to show from each})"
+  task :tail, :roles => :app do
+    set :user, ENV['USER']
+    n = ENV['n'] || 25
+    puts %(user=#{(user).inspect})
+    sudo "tail -v -n#{n} /var/log/nginx/error.log"; puts
+    sudo "tail -v -n#{n} /etc/service/#{application}/log/main/current"; puts
+    sudo "tail -v -n#{n} #{current_path}/log/unicorn.log"; puts
+    sudo "tail -v -n#{n} #{current_path}/log/production.log"; puts
+  end
+  desc "tail -f the production.log file"
+  task :watch, :roles => :app do
+    stream("tail -f #{current_path}/log/production.log")
+  end
+end
+
+end

data/lib/k3_capistrano/ssh.rb

@@ -0,0 +1,14 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+desc <<-End
+ssh to the server specified by the 'domain' variable.
+
+This allows you to quickly ssh to the staging or production server for your app without having to remember the hostname to connect to.
+  $ cap staging ssh
+  $ cap production ssh
+End
+task :ssh do
+  exec_verbose "ssh #{user}@#{domain}"
+end
+
+end

data/lib/k3_capistrano/test_request.rb

@@ -0,0 +1,16 @@
+# Note: This is not automatically included from k3/capistrano in case you want
+# to add another after 'deploy:restart' trigger before this one.
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+namespace :deploy do
+  desc 'Does a test request to the web site so we know everything is working'
+  task :test_request do
+    sleep 5
+    system_verbose "curl #{defined?(test_url) || "http://#{domain}/"} | head -n5"
+  end
+end
+
+after  'deploy:restart',     'deploy:test_request'
+
+end

data/lib/k3_capistrano/test_results.rb

@@ -0,0 +1,85 @@
+require 'test_result_logging'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+#===================================================================================================
+# Additional subdirectories under shared (deploy:setup creates the shared directories, deploy:finalize_update task creates the symlinks)
+
+# In addition to these defaults:
+#_cset :shared_children,   %w(public/system log tmp/pids)
+
+#set :shared_children,   shared_children + %w(
+#  public/features
+#  public/spec
+#)
+
+#===================================================================================================
+
+# Work around the fact that there is an 'upload' namespace defined somewhere (where?) that is hiding the upload method provided by FileTransfer. (The 'put' method, on the other hand, still works.)
+# So we have to do:
+#   upload.call local_file, remote_file
+# instead of:
+#   upload local_file, remote_file
+#upload = Capistrano::Configuration::Actions::FileTransfer.instance_method(:upload).bind(parent)
+
+namespace :test_results do
+  desc 'Create the */results directories in shared/ and create symlinks to them in public/'
+  task 'ensure_directories_exist' do
+    ['spec', 'features'].each do |type|
+      run <<-End
+        mkdir -p #{shared_path}/#{type}/results &&
+        ln -nfsT #{shared_path}/#{type} #{latest_release}/public/#{type}
+      End
+    end
+  end
+
+  desc 'upload_latest'
+  task 'upload_latest' do
+    ensure_directories_exist
+    rspec.upload_latest
+    cucumber.upload_latest
+  end
+
+  def _upload_latest_for_logging(logging)
+    logging.each_format_to_current_files do |format, latest|
+      _upload latest  # upload the symlink
+      latest = (latest.dirname + latest.readlink) rescue (puts $!)
+      _upload latest  # upload the target of the symlink
+    end
+  end
+
+  namespace :rspec do
+    desc 'upload_latest'
+    task :upload_latest do
+      _upload_latest_for_logging(RspecTestResultLogging.new)
+    end
+  end
+
+  namespace :cucumber do
+    desc 'upload_latest'
+    task :upload_latest do
+      _upload_latest_for_logging(CucumberTestResultLogging.new)
+    end
+  end
+
+  def _upload(files)
+    files = Array(files)
+    upload_method = Capistrano::Configuration::Actions::FileTransfer.instance_method(:upload).bind(parent)
+    files.each do |local_file|
+      next unless local_file.exist?
+      remote_file = Pathname(shared_path) + local_file
+      upload_method.call local_file.to_s, remote_file.to_s
+    end
+  end
+
+  desc 'upload a single result file (file=features/results/{file_name}.html)'
+  task 'upload', on_error: :continue do
+    file = Pathname(ENV['file'])
+    _upload file
+  end
+end
+
+#before 'deploy:create_symlink', 'test_results:upload_latest'
+before 'deploy:create_symlink', 'test_results:ensure_directories_exist'
+
+end

data/lib/k3_capistrano/unicorn.rb

@@ -0,0 +1,30 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+_cset 'sv_cmd', 'sv'
+
+namespace :deploy do
+  if http_server == 'unicorn'
+    task :start, :roles => :app, :except => { :no_release => true } do
+      run "#{sv_cmd} start #{application}"
+    end
+    task :stop, :roles => :app, :except => { :no_release => true } do
+      run "#{sv_cmd} stop #{application}"
+    end
+    task :graceful_stop, :roles => :app, :except => { :no_release => true } do
+      run "kill -s QUIT `cat #{unicorn_pid}`"
+    end
+    task :reload, :roles => :app, :except => { :no_release => true } do
+      run "kill -s USR2 `cat #{unicorn_pid}`"
+    end
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "#{sv_cmd} restart #{application}"
+    end
+  elsif http_server == 'passenger'
+    desc "Restarting mod_rails with restart.txt"
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+  end
+end
+
+end

data/lib/k3_capistrano/version.rb

@@ -0,0 +1,5 @@
+module K3Capistrano
+  def self.version
+    "1.0.0"
+  end
+end

data/lib/templates/database.yml.erb

@@ -0,0 +1,8 @@
+production:
+  adapter:   <%= database['adapter'] %>
+  encoding:  <%= database['encoding'] %>
+  database:  <%= database['database'] %>
+  username:  <%= database['username'] %>
+  password:  <%= my_cnf['client']['password'] %>
+  reconnect: <%= database['reconnect'] %>
+  pool: 5

data/lib/test_result_logging.rb

@@ -0,0 +1,79 @@
+require 'active_support/core_ext/class/attribute'
+
+class TestResultLogging
+  class_attribute :formats_to_extensions
+  class_attribute :_results_dir
+
+  # Used for generating filenames for where we should store the results of the current test run (new_file)
+  attr_accessor :current_run_name
+
+  def initialize
+    self.current_run_name   = Time.now.strftime("%Y-%m-%dT%H:%M:%S")
+  end
+
+  def self.user
+    ENV['USER']
+  end
+  def user; self.class.user; end
+
+  def self.results_dir
+    Pathname(_results_dir).tap {|_| _.mkpath unless _.exist? }
+  end
+  def results_dir; self.class.results_dir; end
+
+  def self.latest_default_file_for_format(format)
+    ext = formats_to_extensions[format]
+    results_dir + ("default.#{ext}")
+  end
+
+  def self.latest_symlink_for_format(format)
+    ext = formats_to_extensions[format]
+    results_dir + ("latest.#{user}.#{ext}")
+  end
+
+  def new_file_for_format(format)
+    ext = formats_to_extensions[format]
+    results_dir + ("#{current_run_name}.#{user}.#{ext}")
+  end
+
+  def each_format_to_current_files
+    formats_to_extensions.each do |format, ext|
+      yield [
+        format,
+        self.class.latest_symlink_for_format(format),
+        new_file_for_format(format)
+      ]
+    end
+  end
+
+  def update_latest_symlinks
+    each_format_to_current_files do |format, latest_symlink, new_file|
+      puts "Updating #{latest_symlink} to point to #{new_file.basename}..."
+      latest_symlink.tap {|_| _.unlink rescue nil }.make_symlink new_file.basename
+    end
+  end
+end
+
+class RspecTestResultLogging < TestResultLogging
+  self.formats_to_extensions = { 'html'=>'html', 'doc'=>'doc.txt', 'failures'=>'failures.txt' }
+  self._results_dir = 'spec/results'
+
+  def set_env_to_log_results
+    each_format_to_current_files do |format, latest_symlink, new_file|
+      ENV["rspec_#{format}_file"] = new_file.basename.to_s
+    end
+  end
+
+end
+
+class CucumberTestResultLogging < TestResultLogging
+  self.formats_to_extensions = { 'html'=>'html', 'pretty'=>'txt',  'rerun'=>'rerun.txt' }
+  self._results_dir = 'features/results'
+
+  def set_env_to_log_results
+    each_format_to_current_files do |format, latest_symlink, new_file|
+      ENV["cucumber_#{format}_file"] = new_file.basename.to_s
+    end
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: k3_capistrano
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano_colors
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rvm-capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Common Capistrano tasks and defaults used by K3 Integrations
+email:
+- tyler@k3integrations.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.md
+- k3_capistrano.gemspec
+- lib/capistrano_database_yml.rb
+- lib/k3/capistrano.rb
+- lib/k3_capistrano.rb
+- lib/k3_capistrano/asset_pipeline.rb
+- lib/k3_capistrano/capistrano.rb
+- lib/k3_capistrano/chef.rb
+- lib/k3_capistrano/db.rb
+- lib/k3_capistrano/db_backups.rb
+- lib/k3_capistrano/ensure_db_is_set_up.rb
+- lib/k3_capistrano/git.rb
+- lib/k3_capistrano/logs.rb
+- lib/k3_capistrano/ssh.rb
+- lib/k3_capistrano/test_request.rb
+- lib/k3_capistrano/test_results.rb
+- lib/k3_capistrano/unicorn.rb
+- lib/k3_capistrano/version.rb
+- lib/templates/database.yml.erb
+- lib/test_result_logging.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: k3_capistrano
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Common Capistrano tasks and defaults used by K3 Integrations
+test_files: []