easy-deployment 0.5.0 → 0.5.1

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Changelog for easy-deployment
 
-## 0.5.0 (unreleased)
+## 0.5.1 (2013-05-27)
+
+Bugfixes:
+
+* Backup gem requirements for rails 3.2.13 fixed: should be the same as the rails 4 ones, not earlier rails 3 releases
+* Fixed `cap deploy:initial` for cases where the deploy stage name didn't match the rails_env name
+* Fixed backup template not pulling the environment specific hash out of database config
+
+New Features:
+
+* Tail the rails log of your remote servers (either streaming live or the last N lines) `cap tail:live_logs` + `cap tail:recent logs`
+* Load the capistrano rails assetpipeline support by default (can be skipped via generator option)
+* Apache/passenger config template now sets `PassengerMinInstances` and provides some disabled example tuning options
+* Specified license in the gemspec
+
+## 0.5.0 - 2013-04-05
 
 Large rewrite of both templates, and generator code.
 

data/easy-deployment.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/easy-deployment/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Jeremy Olliver", "Nigel Ramsay", "Shevaun Coker", "Cameron Fowler"]
-  gem.email         =  ["jeremy.olliver@abletech.co.nz", "nigel.ramsay@abletech.co.nz", "shevaun.coker@abletech.co.nz", "cameron.fowler@abletech.co.nz"]
+  gem.email         = ["jeremy.olliver@abletech.co.nz", "nigel.ramsay@abletech.co.nz", "shevaun.coker@abletech.co.nz", "cameron.fowler@abletech.co.nz"]
   gem.description   = %q{Easy deployment: includes a generator, and capistrano configuration}
   gem.summary       = %q{Gem for encapsulating Abletech's deployment practices}
   gem.homepage      = "https://github.com/AbleTech/easy-deployment"
@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "easy-deployment"
   gem.require_paths = ["lib"]
   gem.version       = Easy::Deployment::VERSION
+  gem.license       = "GPLv3"
 
   gem.add_runtime_dependency 'rails', '>= 3.0.0'
   gem.add_runtime_dependency 'capistrano', '~> 2.13.5'

data/lib/easy-deployment/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Deployment
-    VERSION = "0.5.0"
+    VERSION = "0.5.1"
   end
 end

data/lib/easy/deployment/capistrano.rb

@@ -43,7 +43,7 @@ Capistrano::Configuration.instance(:must_exist).load do
                   when :latest  then latest_release
                   else raise ArgumentError, "unknown migration target #{migrate_target.inspect}"
                   end
-      run "cd #{directory}; RAILS_ENV=#{stage} bundle exec rake db:create"
+      run "cd #{directory}; RAILS_ENV=#{rails_env || stage} bundle exec rake db:create"
     end
 
     # By default, we deploy using passenger as an app server
@@ -63,7 +63,20 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
   end
 
-  desc "Tag the release by creating or moving a remote branch named after the current environment"
+  namespace :tail do
+    desc "Stream live log output. USAGE tail:live_logs"
+    task :live_logs, :roles => :app do
+      stream_output_from_command("tail -f #{shared_path}/log/#{rails_env}.log", true)
+    end
+
+    desc "Show recent log output. USAGE tail:recent_logs [lines=n] (defaults to 100)"
+    task :recent_logs, :roles => :app do
+      lines = ENV['lines'] || 100
+      stream_output_from_command("tail -n#{lines} #{shared_path}/log/#{rails_env}.log")
+    end
+  end
+
+  desc "[internal] Tag the release by creating or moving a remote branch named after the current environment"
   task :tag_release do
     if system("git branch -r | grep 'origin/releases/#{stage}'")
       system "git push origin :releases/#{stage}"
@@ -71,7 +84,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     system "git push origin #{branch}:releases/#{stage}"
   end
 
-  desc "Annotate release into version.txt"
+  desc "[internal] Annotate release into version.txt"
   task :annotate_release do
     git_revision = `git rev-parse #{branch} 2> /dev/null`.strip
     version_info = "Branch/Tag: #{branch}\\nRevision: #{git_revision}\\nDeployed To: #{stage}\\n\\nDeployed At: #{Time.now}\\nBy: #{`whoami`.chomp}\\n"
@@ -81,4 +94,18 @@ Capistrano::Configuration.instance(:must_exist).load do
   after "deploy:update", "tag_release"
   after "deploy:update", "annotate_release"
 
+
+  # Helper function to stream output colorized by host
+  def stream_output_from_command(cmd, continuous = false)
+    trap("INT") { puts 'Output cancelled'; exit 0; }
+    Capistrano::CLI.ui.say("<%= color('Streaming output Ctrl+c to cancel', :blue) %>") if continuous
+
+    run(cmd) do |channel, stream, data|
+      puts  # for an extra line break before the host name
+      Capistrano::CLI.ui.say("<%= color('#{channel[:host]}', :cyan) %>: #{data}")
+      # puts "#{channel[:host]}: #{data}"
+      break if stream == :err
+    end
+  end
+
 end

data/lib/easy/generators/backup_generator.rb

@@ -11,18 +11,20 @@ module Easy
     def create_backup_files
       gem_group(:backup) do
         gem "whenever", :require => false
-        case Rails::VERSION::MAJOR
-        when 3
+        # Rails 3.2.12 and lower of the Rails 3.2 release series requires mail ~> 2.4.X which neccesitates an older version of backup
+        # We'll handle two cases: one for Rails 3.2.(0-12) and one for Rails 3.2.13 + Rails 4
+        if "3.2" == "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}" && Rails::VERSION::STRING < "3.2.13"
           gem "backup", "~> 3.0.27", :require => false
           gem "fog",    "~> 1.4.0",  :require => false
           gem "mail",   "~> 2.4.0",  :require => false
-        when 4
-          gem "backup", "~> 3.1.3",   :require => false
-          gem "fog",     "~> 1.9.0",  :require => false
-          gem "net-ssh", "<= 2.5.2",  :require => false # Greater than >= 2.3.0 as well, though we can't express that
-          gem "net-scp", "<= 1.0.4",  :require => false # Greater than 1.0.0
-          gem "excon",   "~> 0.17.0", :require => false
-          gem "mail",    "~> 2.5.0",  :require => false
+        elsif Rails::VERSION::STRING >= "3.2.13" && [3,4].include?(Rails::VERSION::MAJOR)
+          # Rails 3.2.13+ and Rails 4 only
+          gem "backup",  "~> 3.1.3",               :require => false
+          gem "fog",     "~> 1.9.0",               :require => false
+          gem "net-ssh", ['>= 2.3.0', '<= 2.5.2'], :require => false
+          gem "net-scp", ['>= 1.0.0', '<= 1.0.4'], :require => false
+          gem "excon",   "~> 0.17.0",              :require => false
+          gem "mail",    "~> 2.5.0",               :require => false
         else
           warn "Unsupported rails release detected. You'll need to manage your own dependencies for the backup gem"
           gem "backup", :require => false

data/lib/easy/generators/deployment_generator.rb

@@ -6,23 +6,17 @@ module Easy
 
     include GeneratorHelpers
 
-    INSTALL_MSG = %{
-Easy Deployment Config now setup!
-
-TODO:
-  * Set the correct git repository in config/deploy.rb
-  * Edit Capfile and enable asset pipeline compilation if you are using it (uncomment load 'deploy/assets')
-}
-
     desc %{Generates standard able technology deployment script using capistrano}
 
-    class_option :stages,           :type => :array,   :default => ['staging', 'production'], :aliases => :s
-    class_option :disable_backup,   :type => :boolean, :default => false
-    class_option :disable_bugsnag,  :type => :boolean, :default => false
-    class_option :disable_newrelic, :type => :boolean, :default => false
+    class_option :stages,            :type => :array,   :default => ['staging', 'production'], :aliases => :s
+    class_option :disable_backup,    :type => :boolean, :default => false
+    class_option :disable_bugsnag,   :type => :boolean, :default => false
+    class_option :disable_newrelic,  :type => :boolean, :default => false
+    class_option :no_asset_pipeline, :type => :boolean, :default => false
 
     def create_deployment_files
       template("deploy.rb.tt", "config/deploy.rb") # Generate deploy.rb first to use ours not capistrano's deploy.rb
+      copy_file("Capfile") unless options[:no_asset_pipeline] # Do this first
       capify!
 
       # Generate all stages specified
@@ -30,7 +24,14 @@ TODO:
         generate("easy:stage", stage)
       end
 
-      say(INSTALL_MSG, :green)
+      install_message = %Q(
+Easy Deployment Config now setup!
+
+TODO:
+  * Set the correct git repository in config/deploy.rb
+  #{"* Edit Capfile and enable asset pipeline compilation if you are using it (uncomment load 'deploy/assets')\n" if options[:no_asset_pipeline]})
+
+      say(install_message, :green)
       options[:stages].each do |stage|
         say("  * Set the ip address for staging in config/deploy/#{stage}.rb && the apache config in config/deploy/#{stage}/apache.conf", :green)
       end

data/lib/easy/generators/templates/Capfile

@@ -0,0 +1,3 @@
+load 'deploy'
+load 'deploy/assets' # Load rails asset pipeline support
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/lib/easy/generators/templates/backup.rb.tt

@@ -13,7 +13,8 @@ Backup::Model.new("<%= application_name %>", "Remote Backup") do
       database_config_filename = "mongo.yml"
     end
   %>
-  database_config = YAML.load_file(File.join(rails_root, "config/<%= database_config_filename %>"))
+  app_database_config = YAML.load_file(File.join(rails_root, "config/<%= database_config_filename %>"))
+  database_config = app_database_config[ENV['RAILS_ENV']]
 
   database <%= database_engine %> do |db|
     db.name               = database_config["database"]

data/lib/easy/generators/templates/stage/apache.conf.tt

@@ -1,10 +1,16 @@
 <VirtualHost *:80>
-   ServerName <%= name %>.<%= application_name %>.co.nz
+  ServerName <%= name %>.<%= application_name %>.co.nz
 
-   DocumentRoot /var/apps/<%= application_name %>/current/public
-   RailsEnv <%= name %>
-   <Directory /var/apps/<%= application_name %>/current/public>
-      AllowOverride all
-      Options -MultiViews
-   </Directory>
+  DocumentRoot /var/apps/<%= application_name %>/current/public
+  RackEnv <%= name %>
+
+  # Passenger tuning
+  PassengerMinInstances 1 # Prevent passenger going to sleep after 15min inactivity
+  # PassengerPreStart http://<%= name %>.<%= application_name %>.co.nz # Pre-load app on deploy. This needs to match the ServerName above
+  # PassengerHighPerformance on # If you don't need any apache mods within this VirtualHost, you may turn this on
+
+  <Directory /var/apps/<%= application_name %>/current/public>
+     AllowOverride all
+     Options -MultiViews
+  </Directory>
 </VirtualHost>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-deployment
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,6 +111,7 @@ files:
 - lib/easy/generators/deployment_generator.rb
 - lib/easy/generators/generator_helpers.rb
 - lib/easy/generators/stage_generator.rb
+- lib/easy/generators/templates/Capfile
 - lib/easy/generators/templates/backup.rb.tt
 - lib/easy/generators/templates/deploy.rb.tt
 - lib/easy/generators/templates/s3.yml
@@ -121,7 +122,8 @@ files:
 - spec/easy_deployment_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/AbleTech/easy-deployment
-licenses: []
+licenses:
+- GPLv3
 post_install_message: 
 rdoc_options: []
 require_paths: