do_snapshot 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4b1d0886088780b79e06c589eba381d8152ac73
-  data.tar.gz: d5bd6e4651f3265200457d0ffb107d8093325b71
+  metadata.gz: 5ee1fb26e08febbd07bd95db15ede7e27288c6ac
+  data.tar.gz: e94d18d396f7afe4a2746b7d5f26ab4bf162cc1e
 SHA512:
-  metadata.gz: 36e0890a6ea0f126053fad03b94211b9f8d7453c2318be21a32f241dd18d2dbfede194c279d1f19c20c9c59f566c888356579c8c4d4e9f55798e62da62e90cdd
-  data.tar.gz: 09884729d366d5effb5b2ce263e82bb113a0afb4c1c21aead12502beea9d38728a5f612a55487b0b7efd3657f8fc3c43a607b15ce4ed7277bdcce2117eba8a9e
+  metadata.gz: d9222fbba54f8d23156befea3fbe36aebb173e566f29710d09a84c9ab4915ad177e8800818744c54c02ece99fd167b30a013054ff526fc749ce128358cd66e6c
+  data.tar.gz: bc3c05e81971b6a62e217785035361179e2832c9b52f8cab5371d64655eedf57dded6bbc9f5064aa340fbfa1584adc0028c00307f6ff951ffcfdba732fe991c0

data/README.md

@@ -13,6 +13,10 @@
 Use this tool to backup DigitalOcean droplet's via snapshot method, on the fly!
 
 ## API Changes: 
+- 03.08.16: DO now automagically keeps our droplets running when snapshot is processing, so:
+  Added options `--shutdown`, `--no-shutdown`.  
+  `shutdown` now disabled by default, no downtime anymore, `YES`!
+  If you want `shutdown` back use `--shutdown` option.
 - 08.01.16: now we have to use DO API V2 only, because V1 is not work anymore.
 - 17.10.15: now we use DO API V2 by default, due V1 deprecation at 11.2015.
 
@@ -87,8 +91,9 @@ If you want to set keys without environment, than set it via options when you ru
 ### How-To 
 
 ##### Tutorials: 
-- [Longren Tutorial](https://longren.io/automate-making-snapshots-of-your-digitalocean-droplets/)
-- [Arun Kumar Tutorial](http://www.ashout.com/automate-digital-ocean-droplet-snaphot/)
+- [Automate Taking Snapshots of Your DigitalOcean Droplets with DOSnapshot
+, Tyler Longren](https://longren.io/automate-making-snapshots-of-your-digitalocean-droplets/)
+- [How to Automate Taking Digital Ocean Droplet Snaphot with DoSnapShot Script, Arun Kumar](http://www.ashout.com/automate-digital-ocean-droplet-snaphot/)
 
 Here we `keeping` only 5 **latest** snapshots and cleanup older after new one is created. If creation of snapshots failed no one will be deleted. By default we keeping `10` droplets.
 
@@ -147,6 +152,7 @@ For working mailer you need to set e-mail settings via run options.
     Options:
       -p, [--protocol=1]                                             # Select api version.
                                                                      # Default: 2
+          [--shutdown], [--no-shutdown]                              # Check if you want to stop your droplet before the snapshot.
       -o, [--only=123456 123456 123456]                              # Select some droplets.
       -e, [--exclude=123456 123456 123456]                           # Except some droplets.
       -k, [--keep=5]                                                 # How much snapshots you want to keep?
@@ -160,7 +166,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.
+          [--stop-by-power], [--no-stop-by-power]                    # Droplet stop method, by it's 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.
@@ -189,7 +195,6 @@ Support this project and others by [merqlove](https://gratipay.com/~merqlove/) v
 ## Dependencies:
 
 - [Thor](https://github.com/erikhuda/thor) for CLI.
-- [Digitalocean](https://github.com/scottmotte/digitalocean) for API V1 requests.
 - [Barge](https://github.com/blom/barge) for API V2 requests.
 - [Pony](https://github.com/benprew/pony) for mail notifications.
 

data/lib/do_snapshot/adapter/digitalocean_v2.rb

@@ -95,7 +95,7 @@ module DoSnapshot
       def check_keys
         logger.debug 'Checking DigitalOcean Access Token.'
         %w( DIGITAL_OCEAN_ACCESS_TOKEN ).each do |key|
-          fail DoSnapshot::NoTokenError, "You must have #{key} in environment or set it via options." if ENV[key].blank?
+          fail DoSnapshot::NoTokenError, "You must have #{key} in environment or set it via options." if ENV[key].nil? || ENV[key].empty?
         end
       end
 

data/lib/do_snapshot/cli.rb

@@ -82,6 +82,10 @@ module DoSnapshot
                   aliases: %w( -p ),
                   banner: '1',
                   desc: 'Select api version.'
+    method_option :shutdown,
+                  default: false,
+                  type: :boolean,
+                  desc: 'Check if you want to stop droplet before the snapshot.'
     method_option :only,
                   type: :array,
                   default: [],
@@ -137,7 +141,7 @@ module DoSnapshot
                   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.'
+                  desc: "Droplet stop method, by it's power status (instead of waiting for event completed state)."
     method_option :trace,
                   type: :boolean,
                   aliases: %w( -v ),

data/lib/do_snapshot/command.rb

@@ -7,6 +7,10 @@ module DoSnapshot
   class Command # rubocop:disable ClassLength
     include DoSnapshot::Helpers
 
+    RESET_OPTIONS = [:droplets, :exclude, :only, :keep, :quiet,
+                     :stop, :clean, :timeout, :shutdown, :delay,
+                     :protocol, :threads, :api]
+
     def initialize(*args)
       load_options(*args)
     end
@@ -21,6 +25,7 @@ module DoSnapshot
     end
 
     def fail_power_off(e)
+      return unless shutdown
       return unless e && e.id
       api.start_droplet(e.id)
     rescue
@@ -35,12 +40,13 @@ module DoSnapshot
     end
 
     def reset_options
-      [:droplets, :exclude, :only, :keep, :quiet, :stop, :clean, :timeout, :delay, :protocol, :threads, :api].each do |key|
+      RESET_OPTIONS.each do |key|
         send("#{key}=", nil)
       end
     end
 
     def stop_droplet(droplet)
+      return true unless shutdown
       logger.debug 'Shutting down droplet.'
       api.stop_droplet(droplet.id) unless droplet.status.include? 'off'
       true
@@ -49,10 +55,15 @@ module DoSnapshot
       false
     end
 
+    def fail_if_shutdown(droplet)
+      return unless shutdown
+      fail DropletPowerError.new(droplet.id), droplet.name unless api.inactive?(droplet.id)
+    end
+
     # Trying to create a snapshot.
     #
     def create_snapshot(droplet) # rubocop:disable MethodLength,Metrics/AbcSize
-      fail DropletPowerError.new(droplet.id), droplet.name unless api.inactive?(droplet.id)
+      fail_if_shutdown(droplet)
 
       logger.info "Start creating snapshot for droplet id: #{droplet.id} name: #{droplet.name}."
 
@@ -104,7 +115,7 @@ module DoSnapshot
     protected
 
     attr_accessor :droplets, :exclude, :only
-    attr_accessor :keep, :quiet, :stop, :stop_by_power, :clean, :timeout, :delay, :protocol
+    attr_accessor :keep, :quiet, :shutdown, :stop, :stop_by_power, :clean, :timeout, :delay, :protocol
 
     attr_writer :threads, :api
 

data/lib/do_snapshot/version.rb

@@ -2,5 +2,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

data/spec/do_snapshot/cli_spec.rb

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

data/spec/do_snapshot/command_spec.rb

@@ -113,7 +113,7 @@ RSpec.describe DoSnapshot::Command 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)
+        load_options(stop_by_power: true, shutdown: true)
         droplet = cmd.api.droplet droplet_id
         expect { cmd.stop_droplet(droplet) }
           .not_to raise_error
@@ -124,7 +124,17 @@ RSpec.describe DoSnapshot::Command do
       it 'when stopped' do
         stub_droplet_inactive(droplet_id)
         stub_droplet_stop(droplet_id)
-        load_options(stop_by_power: true)
+        load_options(stop_by_power: true, shutdown: 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
+
+      it 'when nothing' do
+        stub_droplet(droplet_id)
+        load_options(stop_by_power: true, shutdown: false)
         droplet = cmd.api.droplet droplet_id
         expect { cmd.stop_droplet(droplet) }
           .not_to raise_error
@@ -154,6 +164,16 @@ RSpec.describe DoSnapshot::Command do
         expect(cmd.stop_droplet(droplet))
           .to be_truthy
       end
+
+      it 'when nothing' do
+        stub_droplet(droplet_id)
+        load_options(shutdown: false)
+        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 '.create_snapshot' do
@@ -176,6 +196,18 @@ RSpec.describe DoSnapshot::Command do
           .not_to raise_error
       end
 
+      it 'when snapshot is created with no shutdown' do
+        stub_droplet(droplet_id)
+        stub_droplet_snapshot(droplet_id, snapshot_name)
+        load_options(shutdown: false)
+        droplet = cmd.api.droplet droplet_id
+        cmd.create_snapshot(droplet)
+        expect(DoSnapshot.logger.buffer)
+          .not_to include "Droplet id: #{droplet_id} must be Powered Off!"
+        expect { cmd.create_snapshot(droplet) }
+          .not_to raise_error
+      end
+
       it 'when droplet is running' do
         stub_droplet(droplet_id)
         load_options
@@ -191,16 +223,25 @@ RSpec.describe DoSnapshot::Command do
     describe '.fail_power_off' do
       it 'when success' do
         stub_droplet_inactive(droplet_id)
-
+        load_options(shutdown: true)
         expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
           .not_to raise_error
         expect(DoSnapshot.logger.buffer)
           .to include "Droplet id: #{droplet_id} is requested for Power On."
       end
 
-      it 'with request error' do
+      it 'not rescue when shutdown is true' do
         stub_droplet_fail(droplet_id)
+        load_options(shutdown: false)
+        expect { cmd.fail_power_off(DoSnapshot::SnapshotCreateError.new(droplet_id)) }
+          .not_to raise_error
+        expect(DoSnapshot.logger.buffer)
+          .to include "Droplet id: #{droplet_id} is Failed to Snapshot."
+      end
 
+      it 'with request error' do
+        stub_droplet_fail(droplet_id)
+        load_options(shutdown: true)
         expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
           .to raise_error(DoSnapshot::DropletFindError)
         expect(DoSnapshot.logger.buffer)
@@ -212,7 +253,7 @@ RSpec.describe DoSnapshot::Command do
       it 'with start error' do
         stub_droplet_inactive(droplet_id)
         stub_droplet_start_done(droplet_id)
-
+        load_options(shutdown: true)
         expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
           .not_to raise_error
         expect(DoSnapshot.logger.buffer)

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 shutdown' do
+          attribute_eq 'shutdown', 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 no shutdown' do
+          attribute_eq 'shutdown', false
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).not_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 power' do
           attribute_eq 'stop_by_power', true
 

data/spec/shared/environment.rb

@@ -19,7 +19,7 @@ RSpec.shared_context 'environment' do
   let(:cli_keys)            { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_access_token: access_token) }
   let(:cli_keys_other)      { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_access_token: 'NOTTOK') }
   let(:snapshot_name)       { "example.com_#{DateTime.now.strftime('%Y_%m_%d')}" }
-  let(:default_options)     { Hash[protocol: 2, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, timeout: 600] }
+  let(:default_options)     { Hash[protocol: 2, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, shutdown: true, timeout: 600] }
   let(:default_options_cli) { default_options.reject { |key, _| %w( droplets threads ).include?(key.to_s) } }
   let(:no_exclude)          { [] }
   let(:exclude)             { %w( 100824 100825 ) }
@@ -31,6 +31,7 @@ RSpec.shared_context 'environment' do
   let(:no_quiet)            { false }
   let(:clean)               { true }
   let(:no_clean)            { false }
+  let(:shutdown)            { true }
   let(:timeout)             { 600 }
   let(:delay)               { 0 }
   let(:log_path)            { "#{project_path}/log/test.log" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-09 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: barge