simple_deploy 0.5.6 → 0.6.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: "rake spec"

data/CHANGELOG

@@ -1,3 +1,11 @@
+## v0.6.0
+
+* Updated so it no longer caches simpledb attributes so it works better with stackster changes
+* Upgraded to stackster 0.3.2
+* Added execute subcommand to run arbitray commands against stack
+* Refactored deployment to use ssh library
+* Added specs
+
 ## v0.5.6
 
 * Corrected the instances command so it returns all instances

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/intuit/simple_deploy.png)](http://travis-ci.org/intuit/simple_deploy)
+
 I use the stackster to manage stacks, however I understand how to connect to different regions / accounts as well as kick off a deployment on instances.
 
 Getting Started

data/lib/simple_deploy/cli/execute.rb

@@ -0,0 +1,57 @@
+require 'trollop'
+
+module SimpleDeploy
+  module CLI
+    class Execute
+      def execute
+        opts = Trollop::options do
+          version SimpleDeploy::VERSION
+          banner <<-EOS
+
+Execute command on given stack(s).
+
+simple_deploy execute -n STACK_NAME -n STACK_NAME -e ENVIRONMENT -c "COMMAND"
+
+Using Internal IP for SSH:
+
+Simple deploy defaults to using the public IP when ssh'ng to stacks. This option instructs it
+to use the private IP, which is needed when ssh'ng from one stack to another.
+
+simple_deploy deploy -n STACK_NAME -n STACK_NAME -e ENVIRONMENT -i
+
+EOS
+          opt :help, "Display Help"
+          opt :attributes, "= seperated attribute and it's value", :type  => :string,
+                                                                   :multi => true
+          opt :command, "Command to execute.", :type => :string
+          opt :environment, "Set the target environment", :type => :string
+          opt :internal, "Use internal IP for ssh commands"
+          opt :log_level, "Log level:  debug, info, warn, error", :type    => :string,
+                                                                  :default => 'info'
+          opt :name, "Stack name(s) of stack to deploy", :type => :string,
+                                                         :multi => true
+          opt :sudo, "Execute command with sudo"
+        end
+
+        CLI::Shared.valid_options? :provided => opts,
+                                   :required => [:environment, :name]
+
+        logger = SimpleDeployLogger.new :log_level => opts[:log_level]
+
+        opts[:name].each do |name|
+          notifier = Notifier.new :stack_name  => name,
+                                  :environment => opts[:environment],
+                                  :logger      => logger
+
+          stack = Stack.new :environment => opts[:environment],
+                            :name        => name,
+                            :logger      => logger,
+                            :internal    => opts[:internal]
+
+          stack.execute :command => opts[:command],
+                        :sudo    => opts[:sudo]
+        end
+      end
+    end
+  end
+end

data/lib/simple_deploy/cli.rb

@@ -8,6 +8,7 @@ require 'simple_deploy/cli/create'
 require 'simple_deploy/cli/deploy'
 require 'simple_deploy/cli/destroy'
 require 'simple_deploy/cli/events'
+require 'simple_deploy/cli/execute'
 require 'simple_deploy/cli/instances'
 require 'simple_deploy/cli/list'
 require 'simple_deploy/cli/outputs'
@@ -39,6 +40,8 @@ module SimpleDeploy
         CLI::List.new.environments
       when 'events'
         CLI::Events.new.show
+      when 'execute'
+        CLI::Execute.new.execute
       when 'instances'
         CLI::Instances.new.list
       when 'list'
@@ -60,13 +63,13 @@ module SimpleDeploy
       when 'update'
         CLI::Update.new.update
       when '-h'
-        puts "simple_deploy [attributes|clone|create|destroy|environments|events|instances|list|template|outputs|parameters|protect|resources|ssh|status|update] [options]"
+        puts "simple_deploy [attributes|clone|create|destroy|environments|events|execute|instances|list|template|outputs|parameters|protect|resources|ssh|status|update] [options]"
         puts "Append -h for help on specific subcommand."
       when '-v'
         puts SimpleDeploy::VERSION
       else
         puts "Unknown command: '#{cmd}'."
-        puts "simple_deploy [attributes|clone|create|destroy|environments|events|instances|list|template|outputs|parameters|protect|resources|ssh|status|update] [options]"
+        puts "simple_deploy [attributes|clone|create|destroy|environments|events|execute|instances|list|template|outputs|parameters|protect|resources|ssh|status|update] [options]"
         puts "Append -h for help on specific subcommand."
         exit 1
       end

data/lib/simple_deploy/logger.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module SimpleDeploy
   class SimpleDeployLogger
 
@@ -22,6 +24,11 @@ module SimpleDeploy
       Logger.const_get @log_level.upcase
     end
 
+    # Added to support capistrano version 2.13.5
+    def tty?
+      nil
+    end
+
     private
 
     def new_logger(args)

data/lib/simple_deploy/stack/deployment/status.rb

@@ -4,11 +4,11 @@ module SimpleDeploy
       class Status
 
         def initialize(args)
-          @config = args[:config]
-          @stack = args[:stack]
+          @config   = args[:config]
+          @stack    = args[:stack]
           @ssh_user = args[:ssh_user]
-          @name = args[:name]
-          @logger = @config.logger
+          @name     = args[:name]
+          @logger   = @config.logger
         end
 
         def clear_for_deployment?

data/lib/simple_deploy/stack/deployment.rb

@@ -2,54 +2,36 @@ require 'capistrano'
 require 'capistrano/cli'
 
 require 'simple_deploy/stack/deployment/status'
+require 'simple_deploy/stack/execute'
 
 module SimpleDeploy
   class Stack
+
     class Deployment
+
       def initialize(args)
-        @config = args[:config]
-        @instances = args[:instances]
+        @config      = args[:config]
+        @instances   = args[:instances]
         @environment = args[:environment]
-        @ssh_user = args[:ssh_user]
-        @ssh_key = args[:ssh_key]
-        @stack = args[:stack]
-        @name = args[:name]
-        @attributes = @stack.attributes
-        @logger = @config.logger
-        @region = @config.region @environment
-      end
-
-      def create_deployment 
-        if @instances.nil? || @instances.empty?
-          raise "There are no running instances to deploy to"
-        end
-
-        @deployment = Capistrano::Configuration.new :output => @logger
-        @deployment.logger.level = 3
-        @logger.info "Creating deployment to #{@name}."
-
-        set_ssh_gateway
-        set_ssh_user
-        set_ssh_options
-        set_instances
-        set_deploy_command
+        @ssh_user    = args[:ssh_user]
+        @ssh_key     = args[:ssh_key]
+        @stack       = args[:stack]
+        @name        = args[:name]
+        @logger      = @config.logger
+        @region      = @config.region @environment
       end
 
-      def execute(force = false)
-        if !clear_for_deployment? && force
-          clear_deployment_lock true
-
-          Backoff.exp_periods do |p|
-            sleep p
-            break if clear_for_deployment?
-          end
-        end
+      def execute(force=false)
+        wait_for_clear_to_deploy(force)
 
         if clear_for_deployment?
           status.set_deployment_in_progress
+
           @logger.info 'Starting deployment.'
-          @deployment.simpledeploy
+          executer.execute :sudo    => true,
+                          :command => deploy_command
           @logger.info 'Deployment complete.'
+
           status.unset_deployment_in_progress
           true
         else
@@ -58,50 +40,44 @@ module SimpleDeploy
         end
       end
 
+      def clear_deployment_lock(force = false)
+        status.clear_deployment_lock force
+      end
+
       def clear_for_deployment?
         status.clear_for_deployment?
       end
 
-      def clear_deployment_lock(force = false)
-        status.clear_deployment_lock force
-      end
+      private
+
+      def wait_for_clear_to_deploy(force)
+        if !clear_for_deployment? && force
+          clear_deployment_lock true
 
-      def ssh
-        @stack.instances.map do |instance|
-          info = instance['instancesSet'].first
-          if info['vpcId']
-            gw = @attributes['ssh_gateway']
-            "\nssh -i #{@ssh_key} -l #{@ssh_user} -L 9998:#{info['privateIpAddress']}:22 -N #{gw} &\nssh -p 9998 localhost"
-          else
-            "\nssh -i #{@ssh_key} -l #{@ssh_user} #{info['ipAddress']}"
+          Backoff.exp_periods do |p|
+            sleep p
+            break if clear_for_deployment?
           end
         end
       end
 
-      private
-
-      def set_deploy_command
+      def deploy_command
         cmd = 'env '
         get_artifact_endpoints.each_pair do |key,value|
           cmd += "#{key}=#{value} "
         end
         cmd += "PRIMARY_HOST=#{primary_instance} #{deploy_script}"
-
-        @logger.info "Deploy command: '#{cmd}'."
-        @deployment.load :string => "task :simpledeploy do
-        sudo '#{cmd}'
-        end"
       end
 
       def get_artifact_endpoints
         h = {}
         @config.artifacts.each do |artifact|
-          variable = @config.artifact_deploy_variable artifact
-          bucket_prefix = @attributes["#{artifact}_bucket_prefix"]
-          domain = @attributes["#{artifact}_domain"]
+          variable      = @config.artifact_deploy_variable artifact
+          bucket_prefix = attributes["#{artifact}_bucket_prefix"]
+          domain        = attributes["#{artifact}_domain"]
 
           artifact = Artifact.new :name          => artifact,
-                                  :id            => @attributes[artifact],
+                                  :id            => attributes[artifact],
                                   :region        => @region,
                                   :domain        => domain,
                                   :bucket_prefix => bucket_prefix
@@ -111,34 +87,6 @@ module SimpleDeploy
         h
       end
 
-      def set_instances
-        @instances.each do |instance| 
-          @logger.debug "Deploying to instance #{instance}."
-          @deployment.server instance, :instances
-        end
-      end
-
-      def set_ssh_options
-        @logger.debug "Setting key to #{@ssh_key}."
-        @deployment.variables[:ssh_options] = { :keys     => @ssh_key, 
-                                                :paranoid => false }
-      end
-
-      def set_ssh_gateway
-        ssh_gateway = @attributes['ssh_gateway']
-        if ssh_gateway && !ssh_gateway.empty?
-          @deployment.set :gateway, ssh_gateway
-          @logger.info "Proxying via gateway #{ssh_gateway}."
-        else
-          @logger.debug "Not using an ssh gateway."
-        end
-      end
-
-      def set_ssh_user
-        @logger.debug "Setting user to #{@ssh_user}."
-        @deployment.set :user, @ssh_user
-      end
-
       def primary_instance 
         if @stack.instances.any?
           @stack.instances.first['instancesSet'].first['privateIpAddress']
@@ -149,6 +97,17 @@ module SimpleDeploy
         @config.deploy_script
       end
 
+      def executer
+        options = { :config      => @config,
+                    :instances   => @instances,
+                    :environment => @environment,
+                    :ssh_user    => @ssh_user,
+                    :ssh_key     => @ssh_key,
+                    :stack       => @stack,
+                    :name        => @name }
+        @executer ||= SimpleDeploy::Stack::Execute.new options
+      end
+
       def status
         options = { :name        => @name,
                     :environment => @environment,
@@ -158,7 +117,12 @@ module SimpleDeploy
         @status ||= SimpleDeploy::Stack::Deployment::Status.new options
       end
 
+      def attributes
+        @stack.attributes
+      end
+
     end
+
   end
 end
 

data/lib/simple_deploy/stack/execute.rb

@@ -0,0 +1,36 @@
+require 'simple_deploy/stack/ssh'
+
+module SimpleDeploy
+  class Stack
+    class Execute
+      def initialize(args)
+        @config      = args[:config]
+        @instances   = args[:instances]
+        @environment = args[:environment]
+        @ssh_user    = args[:ssh_user]
+        @ssh_key     = args[:ssh_key]
+        @stack       = args[:stack]
+        @name        = args[:name]
+      end
+
+      def execute(args)
+        ssh.execute args
+      end
+
+      private
+
+      def ssh
+        options = { :config      => @config,
+                    :instances   => @instances,
+                    :environment => @environment,
+                    :ssh_user    => @ssh_user,
+                    :ssh_key     => @ssh_key,
+                    :stack       => @stack,
+                    :name        => @name }
+        @ssh ||= SimpleDeploy::Stack::SSH.new options
+      end
+
+    end
+  end
+end
+

data/lib/simple_deploy/stack/ssh.rb

@@ -0,0 +1,93 @@
+require 'capistrano'
+require 'capistrano/cli'
+
+module SimpleDeploy
+  class Stack
+    class SSH
+
+      def initialize(args)
+        @config      = args[:config]
+        @instances   = args[:instances]
+        @environment = args[:environment]
+        @ssh_user    = args[:ssh_user]
+        @ssh_key     = args[:ssh_key]
+        @stack       = args[:stack]
+        @name        = args[:name]
+        @logger      = @config.logger
+        @region      = @config.region @environment
+      end
+
+      def execute(args)
+        create_execute_task args
+        @task.execute
+      end
+
+      private
+
+      def create_execute_task(args)
+        if @instances.nil? || @instances.empty?
+          raise "There are no running instances to execute this command."
+        end
+
+        @task = Capistrano::Configuration.new :output => @logger
+        @task.logger.level = 3
+
+        set_ssh_gateway
+        set_ssh_user
+        set_ssh_options
+        set_instances
+        set_execute_command args
+      end
+
+      def set_execute_command(args)
+        command = args[:command]
+        sudo    = args[:sudo]
+
+        @logger.info "Setting command: '#{command}'."
+        if sudo
+          @task.load :string => "task :execute do
+          sudo '#{command}'
+          end"
+        else
+          @task.load :string => "task :execute do
+          run '#{command}'
+          end"
+        end
+      end
+
+      def set_instances
+        @instances.each do |instance| 
+          @logger.debug "Executing command on instance #{instance}."
+          @task.server instance, :instances
+        end
+      end
+
+      def set_ssh_options
+        @logger.debug "Setting key to #{@ssh_key}."
+        @task.variables[:ssh_options] = { :keys     => @ssh_key, 
+                                          :paranoid => false }
+      end
+
+      def set_ssh_gateway
+        ssh_gateway = attributes['ssh_gateway']
+        if ssh_gateway && !ssh_gateway.empty?
+          @task.set :gateway, ssh_gateway
+          @logger.info "Proxying via gateway #{ssh_gateway}."
+        else
+          @logger.debug "Not using an ssh gateway."
+        end
+      end
+
+      def set_ssh_user
+        @logger.debug "Setting user to #{@ssh_user}."
+        @task.set :user, @ssh_user
+      end
+
+      def attributes
+        @stack.attributes
+      end
+
+    end
+  end
+end
+

data/lib/simple_deploy/stack.rb

@@ -1,5 +1,6 @@
 require 'stackster'
 require 'simple_deploy/stack/deployment'
+require 'simple_deploy/stack/execute'
 require 'simple_deploy/stack/stack_attribute_formater'
 
 module SimpleDeploy
@@ -43,10 +44,13 @@ module SimpleDeploy
     end
 
     def deploy(force = false)
-      deployment.create_deployment
       deployment.execute force
     end
 
+    def execute(args)
+      executer.execute args
+    end
+
     def ssh
       deployment.ssh
     end
@@ -118,6 +122,16 @@ module SimpleDeploy
                                           :main_attributes => attributes
     end
 
+    def executer
+      @executer ||= Stack::Execute.new :config      => @config,
+                                       :environment => @environment,
+                                       :name        => @name,
+                                       :stack       => stack,
+                                       :instances   => instances,
+                                       :ssh_user    => ssh_user,
+                                       :ssh_key     => ssh_key
+    end
+
     def deployment
       @deployment ||= Stack::Deployment.new :config      => @config,
                                             :environment => @environment,

data/lib/simple_deploy/version.rb

@@ -1,3 +1,3 @@
 module SimpleDeploy
-  VERSION = "0.5.6"
+  VERSION = "0.6.0"
 end

data/simple_deploy.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.11.0"
 
-  s.add_runtime_dependency "capistrano"
-  s.add_runtime_dependency "stackster", '= 0.3.1'
-  s.add_runtime_dependency "tinder"
-  s.add_runtime_dependency "trollop"
+  s.add_runtime_dependency "capistrano", "= 2.13.5"
+  s.add_runtime_dependency "stackster", '= 0.3.2'
+  s.add_runtime_dependency "tinder", "= 1.9.1"
+  s.add_runtime_dependency "trollop", "= 2.0"
 end

data/spec/logger_spec.rb

@@ -2,33 +2,39 @@ require 'spec_helper'
 
 describe SimpleDeploy do
 
-  it "should create a new logger object from the hash passed as :logger" do
-    logger_mock = mock 'logger'
-    logger_mock.should_receive(:info).with 'a message'
-    logger = SimpleDeploy::SimpleDeployLogger.new :logger => logger_mock
-    logger.info 'a message'
+  before do
+    @logger_mock = mock 'logger'
   end
 
-  it "should create a new logger object when one is not passed" do
-    logger_mock = mock 'logger'
-    Logger.should_receive(:new).with(STDOUT).and_return logger_mock
-    logger_mock.should_receive(:info).with 'a message'
-    logger_mock.should_receive(:datetime_format=).with '%Y-%m-%dT%H:%M:%S%z'
-    logger_mock.should_receive(:formatter=)
-    logger_mock.should_receive(:level=).with 1
-    logger = SimpleDeploy::SimpleDeployLogger.new
-    logger.info 'a message'
+  context "with new logger" do
+    before do
+      @logger_mock.should_receive(:datetime_format=).with '%Y-%m-%dT%H:%M:%S%z'
+      @logger_mock.should_receive(:formatter=)
+      @logger_mock.should_receive(:level=).with 1
+      Logger.should_receive(:new).with(STDOUT).and_return @logger_mock
+    end
+
+    it "should create a new logger object when one is not passed" do
+      @logger = SimpleDeploy::SimpleDeployLogger.new
+      @logger_mock.should_receive(:info).with 'a message'
+      @logger.info 'a message'
+    end
+
+    it "accept puts with msg and pass it to debug" do
+      @logger = SimpleDeploy::SimpleDeployLogger.new
+      @logger_mock.should_receive(:debug).with 'a message'
+      @logger.puts 'a message'
+    end
+
+    it "tty? return false" do
+      @logger = SimpleDeploy::SimpleDeployLogger.new
+      @logger.tty?.should be_false
+    end
   end
 
-  it "accept puts with msg and pass it to debug" do
-    logger_mock = mock 'logger'
-    Logger.should_receive(:new).with(STDOUT).and_return logger_mock
-    logger_mock.should_receive(:debug).with 'a message'
-    logger_mock.should_receive(:datetime_format=).with '%Y-%m-%dT%H:%M:%S%z'
-    logger_mock.should_receive(:formatter=)
-    logger_mock.should_receive(:level=).with 1
-    logger = SimpleDeploy::SimpleDeployLogger.new
-    logger.puts 'a message'
+  it "should create a new logger object from the hash passed as :logger" do
+    Logger.should_receive(:new).exactly(0).times
+    @logger = SimpleDeploy::SimpleDeployLogger.new :logger => @logger_mock
   end
 
 end

data/spec/stack/deployment/status_spec.rb

@@ -2,6 +2,68 @@ require 'spec_helper'
 
 describe SimpleDeploy do
 
-  it "should test status"
+  before do
+    @logger_stub = stub 'logger', :debug => true,
+                                  :info  => true
+    @config_mock = mock 'config'
+    @config_mock.stub :logger => @logger_stub
+    @stack_mock = mock 'stack'
+
+    options = { :config   => @config_mock,
+                :stack    => @stack_mock,
+                :ssh_user => 'user',
+                :name     => 'dastack' }
+    @status = SimpleDeploy::Stack::Deployment::Status.new options
+  end
+
+  describe "clear_for_deployment?" do
+    it "should return true if clear for deployment" do
+      @stack_mock.stub :attributes => { 'deployment_in_progress' => 'false' }
+      @status.clear_for_deployment?.should be_true 
+    end
+
+    it "should return false if not clear for deployment" do
+      @stack_mock.stub :attributes => { 'deployment_in_progress' => 'true' }
+      @status.clear_for_deployment?.should be_false 
+    end
+  end
+
+  describe "deployment_in_progress?" do
+    it "should return false if no deployment in progress" do
+      @stack_mock.stub :attributes => { 'deployment_in_progress' => 'false' }
+      @status.deployment_in_progress?.should be_false
+    end
+
+    it "should return true if deployment in progress" do
+      @stack_mock.stub :attributes => { 'deployment_in_progress' => 'true' }
+      @status.deployment_in_progress?.should be_true
+    end
+  end
+
+  describe "clear_deployment_lock" do
+    it "should unset deploy in progress if force & deploy in progress" do
+      @stack_mock.stub :attributes => { 'deployment_in_progress' => 'true' }
+      @stack_mock.should_receive(:update).
+             with( { :attributes => [ { 'deployment_in_progress' => 'false'} ] })
+      @status.clear_deployment_lock(true)
+    end
+  end
+
+  describe "set_deployment_in_prgoress" do
+    it "set deployment as in progress" do
+      Time.stub :now => 'thetime'
+      @stack_mock.should_receive(:update).
+             with( { :attributes => [ { "deployment_in_progress" => "true", "deployment_user" => "user", "deployment_datetime" => "thetime" } ] })
+      @status.set_deployment_in_progress
+    end
+  end
+
+  describe "unset_deployment_in_prgoress" do
+    it "clears deployment in progress" do
+      @stack_mock.should_receive(:update).
+             with( { :attributes => [ { 'deployment_in_progress' => 'false'} ] })
+      @status.unset_deployment_in_progress
+    end
+  end
 
 end