shuttle-deploy 0.2.0.beta1 → 0.2.0.beta2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTM3MDZmNjBlN2EzYTRkZmRlNDc5OTk1ZWM5MGU0MzhmMGVhZTg2Mg==
+    ODM5ZTBlNTBhMjQ3OGVhYzVjMGUyN2M5YzY2OGYxOTdmMTM3OWViOQ==
   data.tar.gz: !binary |-
-    NGRkOTVmY2IzYzU3MDZmMTRmNWQ1YzE3MTYzMjk4NGFlZjc4NzdkNQ==
+    YjYxYzQyYzY2Y2U5OWQ3MzMyNGU1MTM5ZDgxZDQzMzFhZDUwNTUwMw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjBhNjhmOGQyNjNjMTA3MDJjNzM3MjcxOTBhMjIzMmJmYmU2YTk2ZmI0MjMz
-    MDM0MTc5YzMwZjlmMTQxNTdmNGQyZjJhOTdlYjRkMWY5ODUwMDJhYjY2MDY5
-    ZjRmYTczN2VhOGYyNjNiNGY5OTc2ZWQ3YWQ0YTI3MDE2MGI1ZjM=
+    ZDc0MzdhNWMxNmRkZThiYWE2OGU1NmM5YmI5ZjRmMmYwZTQ0NTZlMzJjNmE3
+    MGRhNzNkMzFjODk1MjhhMWMxNzMxMjUwODk2N2MyZTE0YmI4OGUyZDdmNzhh
+    YzQ0NWQ4M2Q3ZDY4YWIzNjdlY2JlOTFlZDJkNWU0NjFhZGJlZjc=
   data.tar.gz: !binary |-
-    M2RkNzViNGNlZmY2ZWRjMTczOTVhNWFkNmYyMmRiZjQ3ZTE4NmNjNzViNWM3
-    YTVjMGI5ZjViYzhiNjQ0MzUwOGRhZDFlMDFlZmM0MDNiNTJjZGFiZGViMWE4
-    NTA4MTQyMTI4MGZmOGQ1YTYyMjI4ODVmNGYyMzJkNzE0MDAwNjg=
+    ODYzNTI5MDJiNzdjODZkZmIxMzgyM2M4M2JlYzAzNmJlYjMwMTkzZjFjMzE1
+    YmRlOTg0NWU1NzIzZjZhMTZlYjIxYzQxODA1YTQ5NTE4M2RlNjAzYWE5MmQ5
+    MWE1MDMzOTczMzNlMjkwMzFkOGZiZDI4MjNlYWI1NWQ0NGIwNjU=

data/README.md

@@ -8,7 +8,13 @@ Operations are performed on SSH connection with target server.
 
 ## Install
 
-Clone repository and run:
+Install from Rubygems:
+
+```
+gem install shuttle-deploy
+```
+
+Or install manually (clone repo first):
 
 ```
 rake install
@@ -42,16 +48,15 @@ Shared directory structure:
 
 ## Process
 
-Deployment flow is split into steps:
+Deployment flow consists of steps:
 
-- Establish connection with target server
-- Prepare application structure. It'll create all required directories or skip if they already exist.
-- Clone repository or check out latest code. Submodules will be automatically updated as well.
-- Switch to specified branch (`master` by default)
-- Create a new release directory and checkout application code
-- Perform strategy-related tasks. 
-- Create a symbolic link to the latest release
-- Clean up old releases (default count: 5)
+- Connect to remote server
+- Prepare application structure (releases, shared dirs, etc)
+- Clone or update git/svn repository code from specified branch
+- Create a new release and checkout application code
+- Perform strategy-defined tasks
+- Make new release current
+- Cleanup old releases
 
 ## Strategies
 
@@ -71,7 +76,6 @@ Example configuration:
 ```yaml
 app:
   name: my-application
-  strategy: static
   git: git@github.com:my-site.git
 
 target:
@@ -81,11 +85,55 @@ target:
   deploy_to: /home/deployer/www
 ```
 
-### Wordpress Strategy
+### WordPress Strategy
 
 This strategy is designed to deploy wordpress sites developed as a separate theme. 
 It requires `subversion` installed on the server (will be automatically installed). 
 
+### Rails Strategy
+
+Rails deployment strategy will deploy your basic application: install dependencies, 
+migrate database, precompile assets and start web server. Most of the steps are automatic.
+
+Define strategy first:
+
+```yml
+app:
+  name: myapp
+  strategy: rails
+```
+
+Then add a separate section:
+
+```yml
+rails:
+  environment: production
+  precompile_assets: true
+  start_server: true
+```
+
+If using `start_server`, shuttle will try to start thin server. 
+You can modify settings for thin:
+
+```yml
+thin:
+  host: 127.0.0.1
+  port: 9000
+  servers: 5
+```
+
+You can also use `foreman` to run application:
+
+```yml
+rails:
+  start_server: false
+
+hooks:
+  before_link_release:
+    - "sudo bundle exec foreman export upstart /etc/init -a $DEPLOY_APP -u $DEPLOY_USER -p 9000 -l $DEPLOY_SHARED_PATH/log"
+    - "sudo start $DEPLOY_APP || sudo restart $DEPLOY_APP"
+```
+
 ## Deployment Config
 
 Deployment config has a few main sections: `app` and `target`. 
@@ -158,6 +206,27 @@ targets:
     deploy_to: /home/staging/myapp
 ```
 
+### Deployment environment
+
+During deployment shuttle sets a few environment variables:
+
+- `DEPLOY_APP`          - Application name
+- `DEPLOY_USER`         - Current deployment user
+- `DEPLOY_PATH`         - Path to application releases
+- `DEPLOY_RELEASE`      - New release number
+- `DEPLOY_RELEASE_PATH` - Path to currently executing release
+- `DEPLOY_CURRENT_PATH` - Path to current release (symlinked)
+- `DEPLOY_SHARED_PATH`  - Path to shared resources
+- `DEPLOY_SCM_PATH`     - Path to code repository
+
+These could be used in hooks. Example:
+
+```
+hooks:
+  before_link_release:
+    - "cp $DEPLOY_SHARED_PATH/myconfig $DEPLOY_RELEASE_PATH/myconfig"
+```
+
 ## Usage
 
 To execute a new deploy, simply type (in your project folder):
@@ -177,7 +246,6 @@ Shuttle v0.2.0
 -----> Using branch 'master'
 -----> Linking release
 -----> Release v35 has been deployed
------> Cleaning up old releases: 1
 
 Execution time: 2s
 ```
@@ -227,4 +295,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/shuttle/deploy.rb

@@ -1,7 +1,7 @@
 module Shuttle
   class Deploy
-    include Shuttle::Tasks
     include Shuttle::Helpers
+    include Shuttle::PathHelpers
 
     attr_reader :ssh
     attr_reader :target
@@ -22,37 +22,5 @@ module Shuttle
         @version = 1
       end
     end
-
-    def deploy_path(path=nil)
-      [target.deploy_to, path].compact.join('/')
-    end
-
-    def shared_path(path=nil)
-      [deploy_path, 'shared', path].compact.join('/')
-    end
-
-    def current_path(path=nil)
-      [deploy_path, 'current', path].compact.join('/')
-    end
-
-    def version_path
-      deploy_path('version')
-    end
-
-    def release_path(path=nil)
-      [deploy_path, 'releases', version, path].compact.join('/')
-    end
-
-    def scm_path
-      deploy_path('scm')
-    end
-
-    def deploy
-      setup
-      update_code
-      checkout_code
-      link_release
-      cleanup_releases
-    end
   end
 end

data/lib/shuttle/deployment/nodejs.rb

@@ -1,5 +1,5 @@
 module Shuttle
-  class Nodejs < Shuttle::Deploy
+  class Nodejs < Shuttle::Strategy
     def setup
       if node_installed?
         log "Using Node.js v#{node_version}, Npm v#{npm_version}"

data/lib/shuttle/deployment/php.rb

@@ -1,5 +1,5 @@
 module Shuttle
-  class Php < Shuttle::Deploy
+  class Php < Shuttle::Strategy
     def setup
       unless php_installed?
         error "Please install PHP first"

data/lib/shuttle/deployment/rails.rb

@@ -1,5 +1,5 @@
 module Shuttle
-  class Rails < Shuttle::Deploy
+  class Rails < Shuttle::Strategy
     include Shuttle::Support::Bundler
     include Shuttle::Support::Thin
 

data/lib/shuttle/deployment/ruby.rb

@@ -1,5 +1,5 @@
 module Shuttle
-  class Ruby < Shuttle::Deploy
+  class Ruby < Shuttle::Strategy
     include Shuttle::Support::Bundler
     include Shuttle::Support::Thin
 

data/lib/shuttle/deployment/static.rb

@@ -1,5 +1,5 @@
 module Shuttle
-  class Static < Shuttle::Deploy
+  class Static < Shuttle::Strategy
     # Does not implement any custom functionality
   end
 end

data/lib/shuttle/errors.rb

@@ -1,5 +1,5 @@
 module Shuttle
   class Error       < StandardError ; end
-  class ConfigError < Error ; end
-  class DeployError < Error ; end
+  class ConfigError < Error         ; end
+  class DeployError < Error         ; end
 end

data/lib/shuttle/path_helpers.rb

@@ -0,0 +1,39 @@
+module Shuttle
+  module PathHelpers
+    # Get deployment root path, everything is based from here
+    # @return [String]
+    def deploy_path(path=nil)
+      [target.deploy_to, path].compact.join('/')
+    end
+
+    # Get shared path between releases
+    # @return [String]
+    def shared_path(path=nil)
+      [deploy_path, 'shared', path].compact.join('/')
+    end
+
+    # Get path to currently used release
+    # @return [String]
+    def release_path(path=nil)
+      [deploy_path, 'releases', version, path].compact.join('/')
+    end
+
+    # Get current release (symlinked) path
+    # @return [String]
+    def current_path(path=nil)
+      [deploy_path, 'current', path].compact.join('/')
+    end
+
+    # Get path to release version file
+    # @return [String]
+    def version_path
+      deploy_path('version')
+    end
+
+    # Get path to where repository code is stored
+    # @return [String]
+    def scm_path
+      deploy_path('scm')
+    end
+  end
+end

data/lib/shuttle/{tasks.rb → strategy.rb}

@@ -1,7 +1,7 @@
 require 'uri'
 
 module Shuttle
-  module Tasks
+  class Strategy < Shuttle::Deploy
     def setup
       log "Preparing application structure"
 
@@ -9,7 +9,6 @@ module Shuttle
 
       ssh.run "mkdir -p #{deploy_path}"
       ssh.run "mkdir -p #{deploy_path('releases')}"
-      ssh.run "mkdir -p #{deploy_path('backups')}"
       ssh.run "mkdir -p #{deploy_path('shared')}"
       ssh.run "mkdir -p #{shared_path('tmp')}"
       ssh.run "mkdir -p #{shared_path('pids')}"
@@ -26,10 +25,6 @@ module Shuttle
       cleanup_releases
     end
 
-    def keep_releases
-      config.app.keep_releases || 10
-    end
-
     def update_code
       if config.app.svn
         return update_code_svn
@@ -153,8 +148,8 @@ module Shuttle
 
       log "Release v#{version} has been deployed"
 
-      # Execute after link_release hook
-      execute_hook(:after_link_release)
+      # Execute after link_release hook, allow failures here
+      execute_hook(:after_link_release, true)
     end
 
     def write_lock
@@ -182,7 +177,7 @@ module Shuttle
         num = Integer(count) - Integer(keep_releases)
 
         if num > 0
-          log "Cleaning up old releases: #{num}"
+          log "Cleaning up old releases: #{num}" if num > 1
 
           ssh.run("remove=$((count > #{keep_releases} ? count - #{keep_releases} : 0))")
           ssh.run("ls -1d [0-9]* | sort -rn | tail -n $remove | xargs rm -rf {}")
@@ -208,9 +203,11 @@ module Shuttle
 
     def export_environment
       ssh.export_hash(
+        'DEPLOY_APP'          => config.app.name,
         'DEPLOY_APPLICATION'  => config.app.name,
         'DEPLOY_USER'         => target.user,
         'DEPLOY_PATH'         => deploy_path,
+        'DEPLOY_RELEASE'      => version,
         'DEPLOY_RELEASE_PATH' => release_path,
         'DEPLOY_CURRENT_PATH' => current_path,
         'DEPLOY_SHARED_PATH'  => shared_path,
@@ -226,9 +223,9 @@ module Shuttle
       end
     end
 
-    def execute_hook(name)
+    def execute_hook(name, allow_failures=false)
       if config.hooks && config.hooks[name]
-        execute_commands(config.hooks[name])
+        execute_commands(config.hooks[name], allow_failures)
       end
     end
 
@@ -240,12 +237,16 @@ module Shuttle
       exec("ssh #{target.user}@#{target.host}")
     end
 
+    def keep_releases
+      config.app.keep_releases || 10
+    end
+
     def changes_at?(path)
       result = ssh.run(%{diff -r #{current_path}/#{path} #{release_path}/#{path} 2>/dev/null})
       result.success? ? false : true
     end
 
-    def execute_commands(commands=[])
+    def execute_commands(commands=[], allow_failures=false)
       commands.flatten.compact.uniq.each do |cmd|
         log %{Executing "#{cmd.strip}"}
         command = cmd
@@ -253,7 +254,7 @@ module Shuttle
 
         result = ssh.run(command)
 
-        if result.failure?
+        if result.failure? && allow_failures == false
           error "Failed: #{result.output}"
         else
           stream_output(result.output)
@@ -261,4 +262,4 @@ module Shuttle
       end
     end
   end
-end
+end

data/lib/shuttle/target.rb

@@ -15,8 +15,8 @@ module Shuttle
     end
 
     def validate!
-      raise Shuttle::ConfigError, "Host required" if host.nil?
-      raise Shuttle::ConfigError, "User required" if user.nil?
+      raise Shuttle::ConfigError, "Host required"        if host.nil?
+      raise Shuttle::ConfigError, "User required"        if user.nil?
       raise Shuttle::ConfigError, "Deploy path required" if deploy_to.nil?
     end
   end

data/lib/shuttle/version.rb

@@ -1,3 +1,3 @@
 module Shuttle
-  VERSION = '0.2.0.beta1'
+  VERSION = '0.2.0.beta2'
 end

data/lib/shuttle.rb

@@ -13,23 +13,24 @@ require 'shuttle/version'
 require 'shuttle/errors'
 
 module Shuttle
-  autoload :Session,   'shuttle/session'
-  autoload :Runner,    'shuttle/runner'
-  autoload :Deploy,    'shuttle/deploy'
-  autoload :Tasks,     'shuttle/tasks'
-  autoload :Target,    'shuttle/target'
-  autoload :Helpers,   'shuttle/helpers'
+  autoload :Session,     'shuttle/session'
+  autoload :Runner,      'shuttle/runner'
+  autoload :Deploy,      'shuttle/deploy'
+  autoload :Target,      'shuttle/target'
+  autoload :Helpers,     'shuttle/helpers'
+  autoload :PathHelpers, 'shuttle/path_helpers'
+  autoload :Strategy,    'shuttle/strategy'
 
-  autoload :Static,    'shuttle/deployment/static'
-  autoload :Php,       'shuttle/deployment/php'
-  autoload :Wordpress, 'shuttle/deployment/wordpress'
-  autoload :Ruby,      'shuttle/deployment/ruby'
-  autoload :Rails,     'shuttle/deployment/rails'
-  autoload :Nodejs,    'shuttle/deployment/nodejs'
+  autoload :Static,      'shuttle/deployment/static'
+  autoload :Php,         'shuttle/deployment/php'
+  autoload :Wordpress,   'shuttle/deployment/wordpress'
+  autoload :Ruby,        'shuttle/deployment/ruby'
+  autoload :Rails,       'shuttle/deployment/rails'
+  autoload :Nodejs,      'shuttle/deployment/nodejs'
 
   module Support
-    autoload :Bundler, 'shuttle/support/bundler'
-    autoload :Foreman, 'shuttle/support/foreman'
-    autoload :Thin,    'shuttle/support/thin'
+    autoload :Bundler,   'shuttle/support/bundler'
+    autoload :Foreman,   'shuttle/support/foreman'
+    autoload :Thin,      'shuttle/support/thin'
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end
 
 $:.unshift File.expand_path("../..", __FILE__)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shuttle-deploy
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta1
+  version: 0.2.0.beta2
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -184,13 +184,14 @@ files:
 - lib/shuttle/deployment/wordpress/vip.rb
 - lib/shuttle/errors.rb
 - lib/shuttle/helpers.rb
+- lib/shuttle/path_helpers.rb
 - lib/shuttle/runner.rb
 - lib/shuttle/session.rb
+- lib/shuttle/strategy.rb
 - lib/shuttle/support/bundler.rb
 - lib/shuttle/support/foreman.rb
 - lib/shuttle/support/thin.rb
 - lib/shuttle/target.rb
-- lib/shuttle/tasks.rb
 - lib/shuttle/version.rb
 - shuttle-deploy.gemspec
 - spec/deploy_spec.rb