dolphin 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0368b3d9bab059dd58cfb9461d066c152f455761
-  data.tar.gz: e6caa9a6aad53d4fd2f3f1dc90c17560173a926e
+  metadata.gz: 7ae212bf6ffc646c027922fcf0e2a2a08c09f4bf
+  data.tar.gz: 6e22cdeacbde4a142c437ddf1c70660653d44539
 SHA512:
-  metadata.gz: 7bc4d81defbd5df890af8af3bd73a144966e8c60bbaf6b8383f09c546dea0c38ba165c49c3acc0a87a3272c1037a081645349a571656cf0d8455e9eb9a30e060
-  data.tar.gz: 51db0ccf7a148455433c178b336bb37fd89b56bbc453f6ff02bacb3944c67e0c9aaf01fdbc82bd44f4d5a41443f02c0ec27a607dd9db3a5eb5c360a412779a5b
+  metadata.gz: 05039c7d3921e3425fc4908c145512b20103d566213dad815eddf1cde39db4e2487f22f7a19157baa57ac82f95cb3f4a82e6e2c0eb7ecf734f3ce588d4461e9a
+  data.tar.gz: 620b15003c9b38b1b334fecf1b151787f7d6abf06eb3cbbe9e711f6e6e83ae0aa601ef62691868847c3b66278cc3847be339f79ac55dd33df6bbbee542d78e99

data/README.md

@@ -12,25 +12,23 @@ Dolphin: deploy agilely like dolphins can swim. A multi-threaded multi-stage dep
 * Welcome, git checkout.
 * Bye bye, Rake tasks;
 * Welcome, Thor actions.
+* Bye bye, RVM;
+* Welcome, Chruby.
+* Bye bye, gemset;
+* Welcome, system wide gems.
 * Bye bye, complexity;
 * Welcome, nimbleness.
 
-## Installation
+## Installation / Rails generator
 
 Add this line to your application's Gemfile:
 
     gem 'dolphin'
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install dolphin
 
-## Rails generator
-
 Run generator from your Rails application:
 
     $ bin/rails g dolphin:install
@@ -75,11 +73,13 @@ Edit the bin/dolphin script generated as above to adjust settings. Please refer
 
 ## Usage
 
-Show top level command modules:
+### Help
+
+Show top level modules:
 
     $ bin/dolphin
 
-Show subcommands under one module:
+Show tasks under one module:
 
     $ bin/dolphin deploy
     $ bin/dolphin git
@@ -88,10 +88,96 @@ Show subcommands under one module:
     $ bin/dolphin puma
     $ bin/dolphin setup
 
-Execute a subcommand, for example, normal deployment:
+### Execute a task
+
+Each task may involve running groups of commands on the servers. So the hierarchy is like:
+
+    Module (eg., deploy / setup)
+      Task (eg., go / rollback)
+        Group (eg., check lock / update code / restart app)
+          Commands (eg., git fetch / git rebase)
+
+Generally run a task in this format:
+
+    $ bin/dolphin module task argument1 argument2 -e option1 -o option2
+
+For example, normal deployment to production:
 
     $ bin/dolphin deploy go -e production
 
+Rollback to previous release in qa environment:
+
+    $ bin/dolphin deploy rollback -e qa
+
+Switch to a specific tag / branch / commit in alpha environment:
+
+    $ bin/dolphin deploy rollback 96820cf
+
+Please note that the default environment is alpha for developers. So there is no need to append "-e alpha" in the above example.
+
+### Output
+
+The outputs from servers are captured and shown on your console as in the following sections.
+
+#### Commands section
+In this section, the list of commands from the current group is printed. For example:
+
+    $ bin/dolphin deploy try
+    **********Executing commands**********
+    cd /rails/best_app
+    pwd
+    bundle check
+    ============================================================
+
+#### Capture section
+
+In this section, the outputs from the servers are captured in realtime as they are generated. The outputs are classied in 3 types: output / error / exit. The general format of the captured output is:
+
+    server.name => [type]: result from server
+
+Because Dolphin is running tasks on servers in multi-threaded mode, outputs from all servers are mingled together like in random order. For example:
+
+    dev01.best_app.com => [output]: /rails/best_app
+    dev02.best_app.com => [output]: /rails/best_app
+    dev02.best_app.com => [output]: The Gemfile's dependencies are satisfied
+    dev02.best_app.com => [exit]: 0
+    dev01.best_app.com => [output]: The Gemfile's dependencies are satisfied
+    dev01.best_app.com => [exit]: 0
+
+Caveat! Some server applications may label their output differently than expected. So if you see some output labelled with [error], don't assume there are errors or the commands failed. For example, Git may produce such:
+
+    dev02.best_app.com => [error]: Note: checking out '96820cffcec43499acfc737bade544aa011f5376'.
+
+    You are in 'detached HEAD' state. You can look around, make experimental
+    changes and commit them, and you can discard any commits you make in this
+    state without impacting any branches by performing another checkout.
+
+    If you want to create a new branch to retain commits you create, you may
+    do so (now or later) by using -b with the checkout command again. Example:
+
+      git checkout -b new_branch_name
+
+    dev02.best_app.com => [error]: HEAD is now at 96820cf... Return format from gem changed.
+    dev02.best_app.com => [exit]: 0
+
+#### Review section
+
+In this section, the outputs from current command group are printed out again. However, outputs from the same server are grouped together. So you can review the results server by server.
+
+    **********Results Review**********
+
+    ============================================================
+    Executing on [dev01.best_app.com] =>
+    [output]: /rails/best_app
+    [output]: The Gemfile's dependencies are satisfied
+    [exit]: 0
+
+    ============================================================
+    Executing on [dev02.best_app.com] =>
+    [output]: /rails/best_app
+    [output]: The Gemfile's dependencies are satisfied
+    [exit]: 0
+
 ## Extend with custom modules
 
 To extend dolphin's functionality with your custom modules is easy. It is Ruby anyway. For example, to add Centos related functions:

data/dolphin.gemspec

@@ -13,18 +13,22 @@ Gem::Specification.new do |spec|
 
   spec.description   = %q{Dolphin: deploy agilely like dolphins can swim. A multi-threaded multi-stage deployment tool utilizes the full power of Git and Ruby.}
   spec.summary       = %q{Dolphin: deploy agilely like dolphins can swim. A multi-threaded multi-stage deployment tool utilizes the full power of Git and Ruby.
-    Bye bye, serial iteration over list of servers;
-    Welcome, multi-threaded deployment using Parallel gem.
-    Bye bye, afterthought of the multistage extension;
-    Welcome, multi-stage deployment built in from inception.
-    Bye bye, SVN style checkout directories on servers;
-    Welcome, git repository on servers.
-    Bye bye, Capistrano style symlink tricks for current / rollback;
-    Welcome, git checkout.
-    Bye bye, Rake tasks;
-    Welcome, Thor actions.
-    Bye bye, complexity;
-    Welcome, nimbleness.
+    * Bye bye, serial iteration over list of servers;
+    * Welcome, multi-threaded deployment using Parallel gem.
+    * Bye bye, afterthought of the multistage extension;
+    * Welcome, multi-stage deployment built in from inception.
+    * Bye bye, SVN style checkout directories on servers;
+    * Welcome, git repository on servers.
+    * Bye bye, Capistrano style symlink tricks for current / rollback;
+    * Welcome, git checkout.
+    * Bye bye, Rake tasks;
+    * Welcome, Thor actions.
+    * Bye bye, RVM;
+    * Welcome, Chruby.
+    * Bye bye, gemset;
+    * Welcome, system wide gems.
+    * Bye bye, complexity;
+    * Welcome, nimbleness.
   }
 
   spec.files         = `git ls-files`.split($/)

data/lib/dolphin/deploy.rb

@@ -33,6 +33,23 @@ class Dolphin::Deploy < Dolphin::Base
     invoke "dolphin:lock:release"
   end
 
+  desc "rollback", "rollback to previous release or a specified tag"
+  def rollback(tag=nil)
+    # check lock, must explicitly not passing arguments
+    invoke "dolphin:lock:check", []
+    # put lock
+    invoke "dolphin:lock:create", []
+
+    # checkout tag
+    invoke "dolphin:git:checkout"
+
+    # restart app server
+    invoke "dolphin:puma:restart", []
+
+    # remove lock
+    invoke "dolphin:lock:release", []
+  end
+
   desc "try", "normal deploy procedure"
   def try
     menu = [

data/lib/dolphin/git.rb

@@ -6,6 +6,8 @@ class Dolphin::Git < Dolphin::Base
     menu = [
       "
         cd #{@deploy_dir}
+        # Save git head info
+        git rev-parse HEAD > #{@head_file}
         git fetch
         git stash
         git checkout #{@branch}
@@ -18,5 +20,22 @@ class Dolphin::Git < Dolphin::Base
     execute menu
   end
 
+  desc "checkout", "Checkout a specific tag, assume the code on server is up to date"
+  def checkout(tag=nil)
+    if tag
+      command = "git checkout #{tag}"
+    else
+      command = "git checkout `cat #{@head_file}`"
+    end
+    menu = [
+      "
+        cd #{@deploy_dir}
+        #{command}
+      ",
+    ]
+
+    execute menu
+  end
+
 end
 

data/lib/dolphin/version.rb

@@ -1,3 +1,3 @@
 module Dolphin
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/generators/dolphin/templates/dolphin

@@ -84,6 +84,8 @@ class Dolphin::Base
     @deploy_date = Time.now.strftime("%m%d%H%M")
     # custom content for the lock file
     @lock_message = "Deploy started at #{@deploy_date} in progress\n"
+    # name and location of the head file to store git head info
+    @head_file = "#{@deploy_dir}/tmp/pids/head.txt"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dolphin
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Neng Xu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -138,13 +138,14 @@ rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: 'Dolphin: deploy agilely like dolphins can swim. A multi-threaded multi-stage
-  deployment tool utilizes the full power of Git and Ruby. Bye bye, serial iteration
-  over list of servers; Welcome, multi-threaded deployment using Parallel gem. Bye
-  bye, afterthought of the multistage extension; Welcome, multi-stage deployment built
-  in from inception. Bye bye, SVN style checkout directories on servers; Welcome,
-  git repository on servers. Bye bye, Capistrano style symlink tricks for current
-  / rollback; Welcome, git checkout. Bye bye, Rake tasks; Welcome, Thor actions. Bye
-  bye, complexity; Welcome, nimbleness.'
+  deployment tool utilizes the full power of Git and Ruby. * Bye bye, serial iteration
+  over list of servers; * Welcome, multi-threaded deployment using Parallel gem. *
+  Bye bye, afterthought of the multistage extension; * Welcome, multi-stage deployment
+  built in from inception. * Bye bye, SVN style checkout directories on servers; *
+  Welcome, git repository on servers. * Bye bye, Capistrano style symlink tricks for
+  current / rollback; * Welcome, git checkout. * Bye bye, Rake tasks; * Welcome, Thor
+  actions. * Bye bye, RVM; * Welcome, Chruby. * Bye bye, gemset; * Welcome, system
+  wide gems. * Bye bye, complexity; * Welcome, nimbleness.'
 test_files:
 - spec/dolphin/base_spec.rb
 - spec/dolphin/deploy_spec.rb