cap_blue_green_deploy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85697c72f54a66d12e2e722d7570d762e00bcc3c
-  data.tar.gz: d267f962d678ee6d0812f5f8f673c3a0f04c0362
+  metadata.gz: 8d0abc2d30a99d73e2f5dc1dc5af4081f6d01ad5
+  data.tar.gz: 9fc38baddcc1e6e35d5f22ff5b949bcee25badf2
 SHA512:
-  metadata.gz: c36a439c165fff7888bc36a030103016862696a7ad9aa138909cadf4ac6dceef228470f2c8a8f19e6d63ae10bd8ef9c878b146b71bed45a37ff17eef2b782a82
-  data.tar.gz: 1274c75964d809b8c7a462ac084ee1cceba25bcce6a331dd36aa32624389b3ef795c792030dd87ef56360c71b1f36fa0de5aabdf421510723f6699917205320f
+  metadata.gz: 8342b6167486f372e5773105043f1a7e8743922320cfd3050192d967228bc08c09b36512983dee4cb1e28e8e4f6e096b98e3e77a06160ea552e0dda912092c58
+  data.tar.gz: 761b01ad9ea6d12bb1e2f48e3ef718c66e79c6a2d63a1feaa6626d5ac8d400994cfafbaaa7b954d3b6f64242879c794281ddeade969f531a6e662257a90dbc3a

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 .coveralls.yml
+.DS_Store

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+  - Changing custom variables name for live and previous dir
+  - Adding cap deploy:blue_green:pre command to deploy application
+
 ## 1.0.0
 
   - Removing cleanup callback after live deploy. Need to put manually in Capfile.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cap_blue_green_deploy (1.0.0)
+    cap_blue_green_deploy (1.1.0)
       capistrano (>= 2.0.0, < 3.0.0)
 
 GEM

data/README.md

@@ -1,7 +1,24 @@
-# Cap Blue Green Deploy (Under Tests) [![Code Climate](https://codeclimate.com/github/rafaelbiriba/cap_blue_green_deploy/badges/gpa.svg)](https://codeclimate.com/github/rafaelbiriba/cap_blue_green_deploy) [![Travis](https://api.travis-ci.org/rafaelbiriba/cap_blue_green_deploy.svg?branch=master)](https://travis-ci.org/rafaelbiriba/cap_blue_green_deploy) [![Gem Version](https://badge.fury.io/rb/cap_blue_green_deploy.svg)](http://badge.fury.io/rb/cap_blue_green_deploy) [![Coverage Status](https://coveralls.io/repos/rafaelbiriba/cap_blue_green_deploy/badge.png?branch=master)](https://coveralls.io/r/rafaelbiriba/cap_blue_green_deploy?branch=master)
+# Cap Blue Green Deploy [![Gem Version](https://badge.fury.io/rb/cap_blue_green_deploy.svg)](http://badge.fury.io/rb/cap_blue_green_deploy) [![Code Climate](https://codeclimate.com/github/rafaelbiriba/cap_blue_green_deploy/badges/gpa.svg)](https://codeclimate.com/github/rafaelbiriba/cap_blue_green_deploy) [![Travis](https://api.travis-ci.org/rafaelbiriba/cap_blue_green_deploy.svg?branch=master)](https://travis-ci.org/rafaelbiriba/cap_blue_green_deploy) [![Coverage Status](https://coveralls.io/repos/rafaelbiriba/cap_blue_green_deploy/badge.png?branch=master)](https://coveralls.io/r/rafaelbiriba/cap_blue_green_deploy?branch=master)
 
 Blue-Green deployment solution for Capistrano, using symbolic links between releases.
 
+## Blue Green Concept
+
+Learn more about
+[Blue Green Deployment with Martin Fowler](http://martinfowler.com/bliki/BlueGreenDeployment.html)
+
+## Introduction
+
+**Cap Blue Green Deployment** is a non canonical Blue Green solution, based on symlinks. Instead of having **blue** and **green**, we have **pre** and **live**. Pre is always validation environment and live it's  production environment.
+
+![architecture](docs/architecture.png?a)
+
+You can do as many deploys you need to **pre** without affecting the live env. Changing symlinks you can easily put your code from validation to production environment.
+
+## Prerequisite
+
+  - Capistrano 2 (Capistrano 3 coming soon)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +39,88 @@ And then, require the gem script under your capistrano configuration file (Capfi
 
 ## Usage
 
-WIP
+### Understanding the deploy folder:
+
+  - **current**: Pre environment. Used to test and validate your application.
+  - **current_live**: Live environment. You production access goes here. *This dir name can be customized in custom variables, see below*
+  - **previous_live**: Last live release. Used to do the rollback action of current_live. *This dir name can be customized in custom variables, see below*
+
+### Deploy Commands:
+
+* **Going to Pre** `cap deploy:blue_green:pre`
+
+  This command is an alias for `cap deploy` default task. It will run the deploy process and will create the `current` release
+
+* **Going to Live** `cap deploy:blue_green:live`
+
+  This command will change symlinks of `current_live` dir to keep the the same release path of `current` dir. And also create the `previous_live` symlink to track the last current live release used.
+
+  **More explanations**
+
+  If `current_live` already exists, the `previous_live` dir will be created/updated, copying the same symlink of `current live` release, to keep traking the last valid release.
+
+  Finally, the command will create/update the `current_live` symlink, copying the same symlink of `current` release.
+
+* **Rollbacking** `cap deploy:blue_green:rollback`
+
+  This command will change the `current_live` symlink to use the same destination of `previous_live` symlink.
+
+* **Cleanup** `cap deploy:blue_green:cleanup`
+
+  This is the same behavior of the default capistrano cleanup `deploy:cleanup`, but the `current_live` and `previous_live` releases will be preserved and not removed.
+
+  **This lib automatically rewrite the default deploy:cleanup to use this new cleanup function.**
+
+  **Don't forget that you need to add the cleanup callback manually in your capistrano file:** `after "deploy:update", "deploy:cleanup"`
+
+* **Custom Variables**
+
+  You can change the default value setting new variable in your capistrano file. The default values is:
+  - keep_releases: 5
+  - blue_green_live_dir: "current_live"
+  - blue_green_previous_dir: "previous_live"
+
+## How to Play
+**Custom Variables used**
+- `set :keep_releases, 2`
+- `set :blue_green_live_dir, "current_live"`
+- `set :blue_green_previous_dir, "previous_live"`
+
+**1. Starting with clean server**
+![Clean server](docs/1.server_clean.png)
+
+**2. Running `cap deploy:setup` to prepare the server**
+![Deploy setup](docs/2.deploy_setup.png)
+
+**3. Running `cap deploy` three times to populate the release folder (cleanup code removes one old release)**
+![Deploy](docs/3.1.releases.three_deploys.png)
+![Deploy](docs/3.2.three_deploys.png)
+
+**4. Going to live `cap deploy:blue_green:live` (current_live dir will be created. No changes in releases dir)**
+![Blue Green Live](docs/4.1.releases.deploy_blue_green_live.png)
+![Blue Green Live](docs/4.2.deploy_blue_green_live.png)
+
+**5. Running two more deploy with `cap deploy` (current_live will not change. Cleanup remove one old release.)**
+![Deploy](docs/5.1.releases.two_deploy.png)
+![Deploy](docs/5.2.two_deploy.png)
+
+**6. Going to live again with `cap deploy:blue_green:live` (At this time, previous_live will be created, targeting the current_live release before change it. No changes in releases dir)**
+![Blue Green Live](docs/6.1.releases.deploy_blue_green_live.png)
+![Blue Green Live](docs/6.2.deploy_blue_green_live.png)
+
+**7. Something goes wrong... Rollbacking with `cap deploy:blue_green:rollback` (The current_live will change to target the same release of previous_live. No changes in releases dir)**
+![Blue Green Rollback](docs/7.1.releases.deploy_blue_green_rollback.png)
+![Blue Green Rollback](docs/7.2.deploy_blue_green_rollback.png)
+
+**8. Running one more deploy with `cap deploy` (current_live and previous_live will not change. Cleanup remove one old release.)***
+![Deploy](docs/8.1.releases.one_deploy.png)
+![Deploy](docs/8.2.one_deploy.png)
+
+**9. Going to live again with `cap deploy:blue_green:live`**
+![Deploy](docs/9.1.deploy_blue_green_live.png)
+
+**Changing current_live and previous_live variables to use custom names (custom_live_path, custom_rollback_path)**
+![Custom names](docs/custom_variables.png)
 
 ## Contributing
 

data/lib/cap_blue_green_deploy/tasks.rb

@@ -8,6 +8,7 @@ module CapBlueGreenDeploy::Tasks
     Live.task_load config
     Rollback.task_load config
     Cleanup.task_load config
+    Deploy.task_load config
   end
 
   def self.load_libraries config
@@ -16,14 +17,15 @@ module CapBlueGreenDeploy::Tasks
       extend Live
       extend Rollback
       extend Cleanup
+      extend Deploy
     end
   end
 
   def self.load_variables config
     config.load do
       _cset :keep_releases, 5
-      _cset :blue_green_live_path, "#{deploy_to}/current_live"
-      _cset :blue_green_previous_path, "#{deploy_to}/previous_live"
+      _cset :blue_green_live_dir, "#{deploy_to}/current_live"
+      _cset :blue_green_previous_dir, "#{deploy_to}/previous_live"
     end
   end
 end

data/lib/cap_blue_green_deploy/tasks/deploy.rb

@@ -0,0 +1,14 @@
+module CapBlueGreenDeploy::Tasks::Deploy
+  def self.task_load config
+    config.load do
+      namespace :deploy do
+        namespace :blue_green do
+          desc "Deploy your project to pre environment"
+          task :pre, :roles => :app, :except => { :no_release => true } {}
+        end
+      end
+
+      after "deploy:blue_green:pre", "deploy"
+    end
+  end
+end

data/lib/cap_blue_green_deploy/version.rb

@@ -1,3 +1,3 @@
 module CapBlueGreenDeploy
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/lib/cap_blue_green_deploy/tasks/deploy_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe CapBlueGreenDeploy::Tasks::Deploy do
+
+  class TestClass
+    include CapBlueGreenDeploy::Tasks::Deploy
+  end
+
+  subject do
+    TestClass.new
+  end
+
+  before do
+    @config = double("config")
+    allow(@config).to receive(:load) { |&arg| arg.call }
+  end
+
+  describe ".task_load" do
+    let :subject do
+      CapBlueGreenDeploy::Tasks::Deploy
+    end
+
+    before do
+      allow(subject).to receive(:namespace)
+      allow(subject).to receive(:desc)
+      allow(subject).to receive(:task)
+      allow(subject).to receive(:after)
+    end
+
+    context "capistrano blue green pre task" do
+      before do
+        expect(subject).to receive(:namespace).with(:deploy) { |&arg| arg.call }
+        expect(subject).to receive(:namespace).with(:blue_green) { |&arg| arg.call }
+      end
+
+      it "should define pre task description" do
+        expect(subject).to receive(:desc).with("Deploy your project to pre environment")
+        subject.task_load(@config)
+      end
+
+      it "should set pre task action" do
+        expect(subject).to receive(:task).with(:pre, roles: :app, except: { no_release: true })
+        subject.task_load(@config)
+      end
+
+      it "should create callback to run capistrano deploy after pre action" do
+        expect(subject).to receive(:after).with("deploy:blue_green:pre", "deploy")
+        subject.task_load(@config)
+      end
+    end
+  end
+end

data/spec/lib/cap_blue_green_deploy/tasks_spec.rb

@@ -17,6 +17,7 @@ describe CapBlueGreenDeploy::Tasks do
       allow(subject::Live).to receive(:task_load)
       allow(subject::Rollback).to receive(:task_load)
       allow(subject::Cleanup).to receive(:task_load)
+      allow(subject::Deploy).to receive(:task_load)
     end
 
     after do
@@ -42,6 +43,10 @@ describe CapBlueGreenDeploy::Tasks do
     it "should call Cleanup.task_load" do
       expect(subject::Cleanup).to receive(:task_load).with(@config)
     end
+
+    it "should call Cleanup.task_load" do
+      expect(subject::Deploy).to receive(:task_load).with(@config)
+    end
   end
 
   describe ".load_libraries" do
@@ -61,6 +66,10 @@ describe CapBlueGreenDeploy::Tasks do
       def test_common; end
     end
 
+    module CapBlueGreenDeploy::Tasks::Deploy
+      def test_deploy; end
+    end
+
     before do
       subject.load_libraries @config
     end
@@ -80,6 +89,10 @@ describe CapBlueGreenDeploy::Tasks do
     it "should load common tasks" do
       expect(subject).to respond_to :test_common
     end
+
+    it "should load common deploy" do
+      expect(subject).to respond_to :test_deploy
+    end
   end
 
   describe ".load_variables" do
@@ -98,12 +111,12 @@ describe CapBlueGreenDeploy::Tasks do
     end
 
     it "should set blue_green_live_path variable" do
-      expect(subject).to receive(:_cset).with(:blue_green_live_path, "#{deploy_to}/current_live")
+      expect(subject).to receive(:_cset).with(:blue_green_live_dir, "#{deploy_to}/current_live")
       subject.load_variables @config
     end
 
     it "should set blue_green_previous_path variable" do
-      expect(subject).to receive(:_cset).with(:blue_green_previous_path, "#{deploy_to}/previous_live")
+      expect(subject).to receive(:_cset).with(:blue_green_previous_dir, "#{deploy_to}/previous_live")
       subject.load_variables @config
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cap_blue_green_deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rafael Biriba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -119,17 +119,36 @@ files:
 - README.md
 - Rakefile
 - cap_blue_green_deploy.gemspec
+- docs/1.server_clean.png
+- docs/2.deploy_setup.png
+- docs/3.1.releases.three_deploys.png
+- docs/3.2.three_deploys.png
+- docs/4.1.releases.deploy_blue_green_live.png
+- docs/4.2.deploy_blue_green_live.png
+- docs/5.1.releases.two_deploy.png
+- docs/5.2.two_deploy.png
+- docs/6.1.releases.deploy_blue_green_live.png
+- docs/6.2.deploy_blue_green_live.png
+- docs/7.1.releases.deploy_blue_green_rollback.png
+- docs/7.2.deploy_blue_green_rollback.png
+- docs/8.1.releases.one_deploy.png
+- docs/8.2.one_deploy.png
+- docs/9.1.deploy_blue_green_live.png
+- docs/architecture.png
+- docs/custom_variables.png
 - lib/cap_blue_green_deploy.rb
 - lib/cap_blue_green_deploy/init.rb
 - lib/cap_blue_green_deploy/tasks.rb
 - lib/cap_blue_green_deploy/tasks/cleanup.rb
 - lib/cap_blue_green_deploy/tasks/common.rb
+- lib/cap_blue_green_deploy/tasks/deploy.rb
 - lib/cap_blue_green_deploy/tasks/live.rb
 - lib/cap_blue_green_deploy/tasks/rollback.rb
 - lib/cap_blue_green_deploy/version.rb
 - spec/lib/cap_blue_green_deploy/init_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/cleanup_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/common_spec.rb
+- spec/lib/cap_blue_green_deploy/tasks/deploy_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/live_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/rollback_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks_spec.rb
@@ -162,6 +181,7 @@ test_files:
 - spec/lib/cap_blue_green_deploy/init_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/cleanup_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/common_spec.rb
+- spec/lib/cap_blue_green_deploy/tasks/deploy_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/live_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks/rollback_spec.rb
 - spec/lib/cap_blue_green_deploy/tasks_spec.rb