do_snapshot 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da57ad33d5179bc0f986121e76f31e3905da3e0c
-  data.tar.gz: 0f5bcb0f0fcf7f3edffb692121630a04473680b8
+  metadata.gz: d2f557d0bd09889f074fdc153b9223a55f5866a3
+  data.tar.gz: 07e700c5e6e81e1b32a273204f6f25d4cd60a910
 SHA512:
-  metadata.gz: 6b7c4642781f4436e2ea779208b36567b89c1a31cdc46bfedba882aa3e0f9d614d821d841dd8354c865da51d170eb333e87b10a36942f0b0338be0a56b07977d
-  data.tar.gz: 52a00dd59bc60db77acfa037f98ba03cbfa7b7f1d7701a8d5c91ef8ab9725dd7b04e8f6187cbb182f72498a2348378f915f896aa9637fcdc74d2b13269d06ce3
+  metadata.gz: 70b662713abc68a487cabdd8cce90592b746e95e2067d45bd4a148da063456bc3756b1c40ec7d9f4689bc63627ffb3df775ea5a149e2856615f9e8a753ca401a
+  data.tar.gz: b75713e42882ff55dec16ab945dd2246447cde8fd9f9dcdb3abc4e24987b8bf9440a5326ea6bd1f5751f637bcfb4544b751b5307a06fd4fd5b0f3543e1240822

data/README.md

@@ -172,6 +172,7 @@ For working mailer you need to set e-mail settings via run options.
       -l, [--log=/Users/someone/.do_snapshot/main.log]               # Log file path. By default logging is disabled.
       -c, [--clean], [--no-clean]                                    # Cleanup snapshots after create. If you have more images than you want to `keep`, older will be deleted.
       -s, [--stop], [--no-stop]                                      # Stop creating snapshots if maximum is reached.
+          [--stop-by-power], [--no-stop-by-power]                    # Check if droplet stopped by its power status instead of waiting for event completed state.
       -v, [--trace], [--no-trace]                                    # Verbose mode.
       -q, [--quiet], [--no-quiet]                                    # Quiet mode. If don't need any messages in console.
           [--digital-ocean-access-token=YOURLONGAPITOKEN]            # DIGITAL_OCEAN_ACCESS_TOKEN. if you can't use environment.

data/lib/do_snapshot/adapter/abstract.rb

@@ -9,6 +9,7 @@ module DoSnapshot
       include DoSnapshot::Helpers
 
       attr_accessor :delay, :timeout
+      attr_writer   :stop_by
 
       def initialize(options = {})
         check_keys
@@ -18,12 +19,27 @@ module DoSnapshot
         end
       end
 
+      # Power On request for Droplet
+      #
+      def start_droplet(id)
+        # noinspection RubyResolve
+        instance = droplet(id)
+
+        return power_on(id) unless instance.status.include?('active')
+
+        logger.error "Droplet #{id} is still running. Skipping."
+      end
+
       protected
 
       def set_id; end
 
       def check_keys; end
 
+      def stop_by
+        @stop_by ||= :event_status
+      end
+
       # Waiting wrapper
       def wait_wrap(id, message = "Event Id: #{id}", &status_block)
         logger.debug message
@@ -37,8 +53,15 @@ module DoSnapshot
       end
 
       # Waiting for droplet shutdown
-      def wait_shutdown(droplet_id)
-        wait_wrap(droplet_id, "Droplet Id: #{droplet_id} shutting down") { |id, time| get_shutdown_status(id, time) }
+      def wait_shutdown(droplet_id, event_id)
+        case stop_by
+        when :power_status
+          wait_wrap(droplet_id, "Droplet Id: #{droplet_id} shutting down") { |id, time| get_shutdown_status(id, time) }
+        when :event_status
+          wait_event(event_id)
+        else
+          fail 'Please define :stopper method (:droplet_status, :event_status'
+        end
       end
 
       def after_cleanup(droplet_id, droplet_name, snapshot, event)

data/lib/do_snapshot/adapter/digitalocean.rb

@@ -29,17 +29,6 @@ module DoSnapshot
         instance.snapshots
       end
 
-      # Power On request for Droplet
-      #
-      def start_droplet(id)
-        # noinspection RubyResolve
-        instance = droplet(id)
-
-        return power_on(id) unless instance.status.include? 'active'
-
-        logger.error "Droplet #{id} is still running. Skipping."
-      end
-
       # Request Power On for droplet
       #
       def power_on(id)
@@ -62,7 +51,7 @@ module DoSnapshot
         fail event.message unless event.status.include? 'OK'
 
         # noinspection RubyResolve
-        wait_event(event.event_id)
+        wait_shutdown(id, event.event_id)
       rescue => e
         raise DropletShutdownError.new(id), e.message, e.backtrace
       end

data/lib/do_snapshot/adapter/digitalocean_v2.rb

@@ -31,17 +31,6 @@ module DoSnapshot
         instance.snapshot_ids
       end
 
-      # Power On request for Droplet
-      #
-      def start_droplet(id)
-        # noinspection RubyResolve
-        instance = droplet(id)
-
-        return power_on(id) unless instance.status.include?('active')
-
-        logger.error "Droplet #{id} is still running. Skipping."
-      end
-
       # Request Power On for droplet
       #
       def power_on(id)
@@ -66,7 +55,7 @@ module DoSnapshot
         fail DropletShutdownError.new(id), response.message unless response.respond_to?(:action)
 
         # noinspection RubyResolve
-        wait_event(response.action.id)
+        wait_shutdown(id, response.action.id)
       end
 
       # Sending event to create snapshot via DigitalOcean API and wait for success

data/lib/do_snapshot/cli.rb

@@ -14,7 +14,7 @@ module DoSnapshot
 
     default_task :snap
 
-    map %w( c s create )  => :snap
+    map %w( c s create ) => :snap
     map %w( -V ) => :version
 
     # Overriding Thor method for custom initialization
@@ -135,6 +135,9 @@ module DoSnapshot
                   type: :boolean,
                   aliases: %w( -s),
                   desc: 'Stop creating snapshots if maximum is reached.'
+    method_option :stop_by_power,
+                  type: :boolean,
+                  desc: 'Check if droplet stopped by its power status instead of waiting for event completed state.'
     method_option :trace,
                   type: :boolean,
                   aliases: %w( -v ),

data/lib/do_snapshot/command.rb

@@ -92,7 +92,7 @@ module DoSnapshot
     # API launcher
     #
     def api
-      @api ||= DoSnapshot::Adapter.api(protocol, delay: delay, timeout: timeout)
+      @api ||= DoSnapshot::Adapter.api(protocol, delay: delay, timeout: timeout, stop_by: stop_by)
     end
 
     # Processed droplets
@@ -104,7 +104,7 @@ module DoSnapshot
     protected
 
     attr_accessor :droplets, :exclude, :only
-    attr_accessor :keep, :quiet, :stop, :clean, :timeout, :delay, :protocol
+    attr_accessor :keep, :quiet, :stop, :stop_by_power, :clean, :timeout, :delay, :protocol
 
     attr_writer :threads, :api
 
@@ -116,6 +116,10 @@ module DoSnapshot
       @threads ||= []
     end
 
+    def stop_by
+      stop_by_power ? :power_status : :event_status
+    end
+
     # Working with list of droplets.
     #
     def work_with_droplets

data/lib/do_snapshot/configuration.rb

@@ -9,7 +9,7 @@ module DoSnapshot
     attr_accessor :mailer
 
     def initialize
-      @logger  = nil
+      @logger = nil
       @logger_level = Logger::INFO
       @verbose = false
       @quiet   = false

data/lib/do_snapshot/runner.rb

@@ -5,7 +5,11 @@ module DoSnapshot
   #
   class Runner
     def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
-      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+      @argv = argv
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
     end
 
     def execute! # rubocop:disable Metrics/MethodLength

data/lib/do_snapshot/version.rb

@@ -2,5 +2,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/do_snapshot/adapter/abstract_spec.rb

@@ -10,13 +10,13 @@ RSpec.describe DoSnapshot::Adapter::Abstract do
     describe '#delay' do
       let(:delay) { 5 }
       let(:instance) { api.new(delay: delay) }
-      it('with custom delay') { expect(instance.delay).to eq delay  }
+      it('with custom delay') { expect(instance.delay).to eq delay }
     end
 
     describe '#timeout' do
       let(:timeout) { 5 }
       let(:instance) { api.new(timeout: timeout) }
-      it('with custom timeout') { expect(instance.timeout).to eq timeout  }
+      it('with custom timeout') { expect(instance.timeout).to eq timeout }
     end
   end
 end

data/spec/do_snapshot/adapter/digitalocean_spec.rb

@@ -12,13 +12,13 @@ RSpec.describe DoSnapshot::Adapter::Digitalocean do
     describe '#delay' do
       let(:delay) { 5 }
       let(:instance) { api.new(delay: delay) }
-      it('with custom delay') { expect(instance.delay).to eq delay  }
+      it('with custom delay') { expect(instance.delay).to eq delay }
     end
 
     describe '#timeout' do
       let(:timeout) { 5 }
       let(:instance) { api.new(timeout: timeout) }
-      it('with custom timeout') { expect(instance.timeout).to eq timeout  }
+      it('with custom timeout') { expect(instance.timeout).to eq timeout }
     end
   end
 
@@ -108,7 +108,39 @@ RSpec.describe DoSnapshot::Adapter::Digitalocean do
       end
     end
 
-    describe '.stop_droplet' do
+    describe '.stop_droplet by power status' do
+      let(:instance) { api.new(delay: delay, timeout: timeout, stop_by: :power_status) }
+
+      it 'with success' do
+        stub_event_done(event_id)
+        stub_droplet_stop(droplet_id)
+        stub_droplet_inactive(droplet_id)
+
+        instance.stop_droplet(droplet_id)
+
+        expect(a_request(:get, droplet_stop_url))
+          .to have_been_made
+        expect(a_request(:get, droplet_url))
+          .to have_been_made
+      end
+
+      it 'with error' do
+        stub_droplet_stop_fail(droplet_id)
+        stub_droplet(droplet_id)
+
+        instance.timeout = 1
+        expect { instance.stop_droplet(droplet_id) }
+          .to raise_error(DoSnapshot::DropletShutdownError)
+        instance.timeout = timeout
+        expect(DoSnapshot.logger.buffer)
+          .to include 'Droplet id: 100823 is Failed to Power Off.'
+
+        expect(a_request(:get, droplet_stop_url))
+          .to have_been_made
+      end
+    end
+
+    describe '.stop_droplet by event' do
       it 'with success' do
         stub_event_done(event_id)
         stub_droplet_stop(droplet_id)

data/spec/do_snapshot/adapter/digitalocean_v2_spec.rb

@@ -14,13 +14,13 @@ RSpec.describe DoSnapshot::Adapter::DigitaloceanV2 do
     describe '#delay' do
       let(:delay) { 5 }
       let(:instance) { api.new(delay: delay) }
-      it('with custom delay') { expect(instance.delay).to eq delay  }
+      it('with custom delay') { expect(instance.delay).to eq delay }
     end
 
     describe '#timeout' do
       let(:timeout) { 5 }
       let(:instance) { api.new(timeout: timeout) }
-      it('with custom timeout') { expect(instance.timeout).to eq timeout  }
+      it('with custom timeout') { expect(instance.timeout).to eq timeout }
     end
   end
 
@@ -110,7 +110,38 @@ RSpec.describe DoSnapshot::Adapter::DigitaloceanV2 do
       end
     end
 
-    describe '.stop_droplet' do
+    describe '.stop_droplet by power status' do
+      let(:instance) { api.new(delay: delay, timeout: timeout, stop_by: :power_status) }
+
+      it 'with success' do
+        stub_event_done(event_id)
+        stub_droplet_stop(droplet_id)
+        stub_droplet_inactive(droplet_id)
+
+        instance.stop_droplet(droplet_id)
+
+        expect(a_request(:post, droplet_stop_url))
+          .to have_been_made
+        expect(a_request(:get, droplet_url))
+          .to have_been_made
+      end
+
+      it 'with error' do
+        stub_droplet_stop_fail(droplet_id)
+        stub_droplet(droplet_id)
+        instance.timeout = 1
+        expect { instance.stop_droplet(droplet_id) }
+          .to raise_error(DoSnapshot::DropletShutdownError)
+        instance.timeout = timeout
+        expect(DoSnapshot.logger.buffer)
+          .to include 'Droplet id: 100823 is Failed to Power Off.'
+
+        expect(a_request(:post, droplet_stop_url))
+          .to have_been_made
+      end
+    end
+
+    describe '.stop_droplet by event' do
       it 'with success' do
         stub_event_done(event_id)
         stub_droplet_stop(droplet_id)

data/spec/do_snapshot/cli_spec.rb

@@ -75,6 +75,14 @@ RSpec.describe DoSnapshot::CLI do
         attribute_eq 'stop', false
       end
 
+      it 'with stop by power' do
+        attribute_eq 'stop_by_power', true
+      end
+
+      it 'with stop by event' do
+        attribute_eq 'stop_by_power', false
+      end
+
       it 'with clean' do
         attribute_eq 'clean', true
       end

data/spec/do_snapshot/command_spec.rb

@@ -114,7 +114,30 @@ RSpec.describe DoSnapshot::Command do
       end
     end
 
-    describe '.stop_droplet' do
+    describe '.stop_droplet by power status' do
+      it 'when raised with error' do
+        stub_droplet_stop_fail(droplet_id)
+        load_options(stop_by_power: true)
+        droplet = cmd.api.droplet droplet_id
+        expect { cmd.stop_droplet(droplet) }
+          .not_to raise_error
+        expect(cmd.stop_droplet(droplet))
+          .to be_falsey
+      end
+
+      it 'when stopped' do
+        stub_droplet_inactive(droplet_id)
+        stub_droplet_stop(droplet_id)
+        load_options(stop_by_power: true)
+        droplet = cmd.api.droplet droplet_id
+        expect { cmd.stop_droplet(droplet) }
+          .not_to raise_error
+        expect(cmd.stop_droplet(droplet))
+          .to be_truthy
+      end
+    end
+
+    describe '.stop_droplet by event' do
       it 'when raised with error' do
         stub_droplet_stop_fail(droplet_id)
         load_options

data/spec/do_snapshot/runner_spec.rb

@@ -109,6 +109,24 @@ RSpec.describe DoSnapshot::Runner, type: :aruba do
           expect(all_stdout).to include(t_snapshot_created(snapshot_name))
         end
 
+        it 'with stop by power' do
+          attribute_eq 'stop_by_power', true
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to include(t_droplet_shutdown)
+          expect(all_stdout).to include(t_wait_until_create)
+          expect(all_stdout).to include(t_snapshot_created(snapshot_name))
+        end
+
+        it 'with stop by event' do
+          attribute_eq 'stop_by_power', false
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to include(t_droplet_shutdown)
+          expect(all_stdout).to include(t_wait_until_create)
+          expect(all_stdout).to include(t_snapshot_created(snapshot_name))
+        end
+
         it 'with clean' do
           attribute_eq 'clean', true
 
@@ -314,18 +332,12 @@ RSpec.describe DoSnapshot::Runner, type: :aruba do
       elsif value.is_a?(Numeric)
         "--#{key}=#{value}"
       elsif value.is_a?(Array)
-        if value.size > 0
-          "--#{key}=#{value.join(' ')}"
-        else
-          nil
-        end
+        next unless value.size > 0
+        "--#{key}=#{value.join(' ')}"
       elsif value.is_a?(Hash)
-        if value.size > 0
-          items = value.map { |param, setting| "#{param}:#{setting}" }.join(' ')
-          "--#{key}=#{items}"
-        else
-          nil
-        end
+        next unless value.size > 0
+        items = value.map { |param, setting| "#{param}:#{setting}" }.join(' ')
+        "--#{key}=#{items}"
       else
         "--#{key}"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digitalocean_c