do_snapshot 0.2.2 → 0.3.0

data/spec/do_snapshot/runner_spec.rb

@@ -0,0 +1,334 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+RSpec.describe DoSnapshot::Runner, type: :aruba do
+  include_context 'spec'
+
+  context 'commands' do
+    context '.snap' do
+      RSpec.shared_examples '.snap methods' do
+        it 'with error' do
+          run 'do_snapshot snap --some-param=5'
+
+          expect(all_stderr).to match(/ERROR: ".*" was called with arguments \["--some-param=5"\]/)
+        end
+
+        it 'with exclude' do
+          excluded_droplets = %w( 100824 )
+          stub_all_api(%w(100825 100823))
+          hash_attribute_eq_no_stub(exclude: excluded_droplets, only: %w())
+
+          expect(all_stdout).to be_found_n_times(t_snapshot_created(snapshot_name), 2)
+          expect(all_stdout).not_to include('100824')
+        end
+
+        it 'with only' do
+          selected_droplets = %w( 100823 )
+          stub_all_api(selected_droplets)
+          hash_attribute_eq_no_stub(only: selected_droplets)
+          expect(last_command).to have_exit_status(0)
+
+          expect(all_stdout).to be_found_n_times(t_snapshot_created(snapshot_name), 1)
+          expect(all_stdout).not_to include('100825')
+          expect(all_stdout).not_to include('100824')
+        end
+
+        it 'with 1 delay' do
+          aruba.config.exit_timeout = 1
+
+          hash_attribute_eq delay: 1, timeout: timeout
+          expect(last_command).to have_exit_status(0)
+          expect(last_command).to have_finished_in_time
+
+          aruba.config.exit_timeout = 15
+        end
+
+        it 'with 0 delay' do
+          hash_attribute_eq delay: 0, timeout: timeout
+
+          expect(last_command).to have_exit_status(0)
+        end
+
+        it 'with custom timeout' do
+          aruba.config.exit_timeout = 1
+
+          hash_attribute_eq timeout: 1, delay: 2
+
+          expect(last_command).to have_exit_status(0)
+          expect(last_command).to have_finished_in_time
+
+          aruba.config.exit_timeout = 15
+        end
+
+        it 'with keep' do
+          attribute_eq 'keep', 7
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).not_to include(t_is_reached)
+          expect(all_stdout).not_to include(t_snapshots_cleaning(droplet_id))
+        end
+
+        it 'with no keep' do
+          attribute_eq 'keep', 3
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to be_found_n_times(t_is_reached, 2)
+          expect(all_stdout).to include(t_snapshots_cleaning(droplet_id))
+        end
+
+        it 'with quiet' do
+          attribute_eq 'quiet', true
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to eq('')
+        end
+
+        it 'with no quiet' do
+          attribute_eq 'quiet', false
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).not_to eq('')
+          expect(all_stdout).to include(t_finished)
+        end
+
+        it 'with stop' do
+          attribute_eq 'stop', true
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).not_to include(t_droplet_shutdown)
+          expect(all_stdout).not_to include(t_wait_until_create)
+          expect(all_stdout).not_to include(t_snapshot_created(snapshot_name))
+        end
+
+        it 'with no stop' do
+          attribute_eq 'stop', 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
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to include(t_snapshots_cleaning(droplet_id))
+        end
+
+        it 'with no clean' do
+          attribute_eq 'clean', false
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).not_to include(t_snapshots_cleaning(droplet_id))
+        end
+
+        it 'with mail' do
+          hash_attribute_eq(mail: mail_options)
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to include(t_sending_email)
+        end
+
+        it 'with no mail' do
+          hash_attribute_eq
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout).to include(t_sending_email)
+        end
+
+        it 'with smtp' do
+          hash_attribute_eq(smtp: smtp_options)
+
+          expect(last_command).to have_exit_status(0)
+        end
+
+        it 'with no smtp' do
+          hash_attribute_eq
+
+          expect(last_command).to have_exit_status(0)
+        end
+
+        it 'with log' do
+          FileUtils.remove_file(log_path, true)
+          hash_attribute_eq(log)
+
+          expect(last_command).to have_exit_status(0)
+          expect(File.exist?(log_path)).to be_truthy
+        end
+
+        it 'with no log' do
+          FileUtils.remove_file(log_path, true)
+          hash_attribute_eq
+
+          expect(last_command).to have_exit_status(0)
+          expect(File.exist?(log_path)).to be_falsey
+        end
+      end
+
+      context 'API V2' do
+        let(:default_options_cli) { default_options.reject { |key, _| %w( droplets threads ).include?(key.to_s) }.merge(protocol: 2) }
+        let(:event_id) { '7499' }
+        let(:snapshot_name) { "example.com_#{DateTime.now.strftime('%Y_%m_%d')}" }
+
+        include_context 'api_v2_helpers'
+        it_behaves_like '.snap methods'
+
+        context 'when no credentials' do
+          it 'with warning about digitalocean credentials' do
+            with_environment(cli_env_nil) do
+              run "do_snapshot snap #{options_line}"
+
+              expect(last_command).to have_exit_status(1)
+              expect(all_stdout)
+                .to include(t_wrong_keys('digital_ocean_access_token'))
+            end
+          end
+        end
+
+        context 'when different credentials' do
+          let(:api_access_token) { "Bearer #{cli_keys_other[:digital_ocean_access_token]}" }
+
+          it 'with no warning' do
+            hash_attribute_eq(cli_keys_other)
+
+            expect(last_command).to have_exit_status(0)
+          end
+        end
+      end
+
+      context 'API V1' do
+        include_context 'api_v1_helpers'
+        it_behaves_like '.snap methods'
+
+        context 'when no credentials' do
+          it 'with warning about digitalocean credentials' do
+            with_environment(cli_env_nil) do
+              run "do_snapshot snap #{options_line}"
+
+              expect(last_command).to have_exit_status(1)
+              expect(all_stdout)
+                .to include(t_wrong_keys(%w( digital_ocean_client_id digital_ocean_api_key ).join(', ')))
+            end
+          end
+        end
+
+        context 'when different credentials' do
+          let(:keys_uri) { "api_key=#{cli_keys_other[:digital_ocean_api_key]}&client_id=#{cli_keys_other[:digital_ocean_client_id]}" }
+
+          it 'with no warning' do
+            hash_attribute_eq(cli_keys_other)
+
+            expect(last_command).to have_exit_status(0)
+          end
+        end
+      end
+    end
+
+    context '.help' do
+      it 'shows a help message' do
+        run 'do_snapshot help'
+        expect(all_stdout)
+          .to match('Commands:')
+      end
+
+      it 'shows a help message for specific commands' do
+        run 'do_snapshot help snap'
+        expect(all_stdout).to include('`do_snapshot` able to create and cleanup snapshots on your droplets.')
+      end
+
+      it 'sure no warning about credentials' do
+        with_environment(cli_env_nil) do
+          run 'do_snapshot help snap'
+
+          expect(last_command).to have_exit_status(0)
+          expect(all_stdout)
+            .not_to include(t_wrong_keys(%w( digital_ocean_client_id digital_ocean_api_key ).join(', ')))
+        end
+      end
+    end
+
+    context '.version' do
+      it 'with right version' do
+        run 'do_snapshot version'
+        expect(all_stdout).to include(DoSnapshot::VERSION)
+      end
+    end
+
+    def t_snapshot_created(name = snapshot_name)
+      "Snapshot name: #{name} created successfully."
+    end
+
+    def t_snapshots_cleaning(id = droplet_id)
+      "Cleaning up snapshots for droplet id: #{id}"
+    end
+
+    def t_droplet_shutdown
+      'Shutting down droplet.'
+    end
+
+    def t_wait_until_create
+      'Wait until snapshot will be created.'
+    end
+
+    def t_finished
+      'All operations has been finished.'
+    end
+
+    def t_is_reached
+      'of snapshots is reached'
+    end
+
+    def t_sending_email
+      'Sending e-mail notification'
+    end
+
+    def t_wrong_keys(keys)
+      "You must have #{keys.upcase} in environment or set it via options."
+    end
+
+    def attribute_eq(name, value)
+      stub_all_api
+      options = default_options_cli.merge(Hash[cli_keys].symbolize_keys).merge(:"#{name}" => value)
+      run "do_snapshot snap #{options_line(options)}"
+    end
+
+    def hash_attribute_eq(hash = {})
+      stub_all_api
+      options = default_options_cli.merge(Hash[cli_keys].symbolize_keys).merge(hash)
+      run "do_snapshot snap #{options_line(options)}"
+    end
+
+    def hash_attribute_eq_no_stub(hash)
+      options = default_options_cli.merge(Hash[cli_keys].symbolize_keys).merge(hash)
+      run "do_snapshot snap #{options_line(options)}"
+    end
+  end
+
+  def options_line(options = default_options_cli) # rubocop:disable Metrics/PerceivedComplexity,Metrics/MethodLength,Metrics/AbcSize,Metrics/CyclomaticComplexity
+    options.map do |key, value|
+      if value.is_a?(String)
+        "--#{key}=#{value}"
+      elsif value.is_a?(FalseClass)
+        "--no-#{key}"
+      elsif value.is_a?(Numeric)
+        "--#{key}=#{value}"
+      elsif value.is_a?(Array)
+        if value.size > 0
+          "--#{key}=#{value.join(' ')}"
+        else
+          nil
+        end
+      elsif value.is_a?(Hash)
+        if value.size > 0
+          items = value.map { |param, setting| "#{param}:#{setting}" }.join(' ')
+          "--#{key}=#{items}"
+        else
+          nil
+        end
+      else
+        "--#{key}"
+      end
+    end.compact.join(' ')
+  end
+end

data/spec/{do_snapshots_spec.rb → do_snapshot_spec.rb}

@@ -4,14 +4,12 @@ require 'spec_helper'
 describe DoSnapshot do
   include_context 'spec'
 
-  subject(:log) { DoSnapshot::Log }
-
   describe DoSnapshot::DropletFindError do
     subject(:error) { described_class }
 
     it 'should work' do
       error.new
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Droplet Not Found'
     end
   end
@@ -21,7 +19,7 @@ describe DoSnapshot do
 
     it 'should work' do
       error.new
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Droplet Listing is failed to retrieve'
     end
   end
@@ -40,7 +38,7 @@ describe DoSnapshot do
 
     it 'should work' do
       error.new(droplet_id)
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include "Droplet id: #{droplet_id} is Failed to Power Off."
     end
   end
@@ -50,14 +48,8 @@ describe DoSnapshot do
 
     it 'should work' do
       error.new(droplet_id)
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include "Droplet id: #{droplet_id} is Failed to Snapshot."
     end
   end
-
-  before(:each) do
-    log.buffer = %w()
-    log.verbose = false
-    log.quiet = true
-  end
 end

data/spec/shared/api_v2_helpers.rb

@@ -4,6 +4,7 @@ require 'spec_helper'
 shared_context 'api_v2_helpers' do
   let(:api_base)           { 'https://api.digitalocean.com/v2' }
   let(:droplets_api_base)  { "#{api_base}/droplets" }
+  let(:api_access_token)   { "Bearer #{access_token}" }
   let(:events_api_base)    { "#{api_base}/droplets/[droplet_id]/actions" }
   let(:actions_api_base)   { "#{api_base}/actions" }
   let(:images_api_base)    { "#{api_base}/images" }
@@ -145,7 +146,7 @@ shared_context 'api_v2_helpers' do
   # Body Helpers
   #
   def stub_request_body(type, request, body)
-    stub_response = stub_request(type, request)
+    stub_response = stub_request(type, request).with(headers: { 'Authorization' => api_access_token })
     return stub_response.with(body: body) if body
     stub_response
   end

data/spec/shared/environment.rb

@@ -5,34 +5,38 @@ shared_context 'spec' do
   include_context 'api_helpers'
 
   def do_not_send_email
-    allow(Pony).to receive(:deliver)
+    allow(Pony).to receive(:deliver) { |mail| mail }
   end
 
-  let(:client_key)         { 'foo' }
-  let(:api_key)            { 'bar' }
-  let(:access_token)       { 'sometoken' }
-  let(:event_id)           { '7501' }
-  let(:droplet_id)         { '100823' }
-  let(:image_id)           { '5019770' }
-  let(:image_id2)          { '5019903' }
-  let(:cli_keys)           { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_client_id: 'NOTFOO', digital_ocean_api_key: 'NOTBAR', digital_ocean_access_token: 'NOTTOK') }
-  let(:snapshot_name)      { "foo_#{DateTime.now.strftime('%Y_%m_%d')}" }
-  let(:default_options)    { Hash[protocol: 1, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, timeout: 600, droplets: nil, threads: []] }
-  let(:no_exclude)         { [] }
-  let(:exclude)            { %w( 100824 100825 ) }
-  let(:no_only)            { [] }
-  let(:only)               { %w( 100823 100824 ) }
-  let(:stop)               { true }
-  let(:no_stop)            { false }
-  let(:quiet)              { true }
-  let(:no_quiet)           { false }
-  let(:clean)              { true }
-  let(:no_clean)           { false }
-  let(:timeout)            { 600 }
-  let(:delay)              { 0 }
-  let(:mail_options)       { Thor::CoreExt::HashWithIndifferentAccess.new(to: 'mail@somehost.com', from: 'from@host.com') }
-  let(:smtp_options)       { Thor::CoreExt::HashWithIndifferentAccess.new(address: 'smtp.gmail.com', port: '25', user_name: 'someuser', password: 'somepassword') }
-  let(:log)                { Thor::CoreExt::HashWithIndifferentAccess.new(log: "#{project_path}/log/test.log") }
+  let(:client_key)          { 'foo' }
+  let(:api_key)             { 'bar' }
+  let(:access_token)        { 'sometoken' }
+  let(:event_id)            { '7501' }
+  let(:droplet_id)          { '100823' }
+  let(:image_id)            { '5019770' }
+  let(:image_id2)           { '5019903' }
+  let(:cli_env_nil)         { Hash['DIGITAL_OCEAN_CLIENT_ID' => nil, 'DIGITAL_OCEAN_API_KEY' => nil, 'DIGITAL_OCEAN_ACCESS_TOKEN' => nil] }
+  let(:cli_keys)            { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_client_id: client_key, digital_ocean_api_key: api_key, digital_ocean_access_token: access_token) }
+  let(:cli_keys_other)      { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_client_id: 'NOTFOO', digital_ocean_api_key: 'NOTBAR', digital_ocean_access_token: 'NOTTOK') }
+  let(:snapshot_name)       { "foo_#{DateTime.now.strftime('%Y_%m_%d')}" }
+  let(:default_options)     { Hash[protocol: 1, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, timeout: 600, droplets: nil, threads: []] }
+  let(:default_options_cli) { default_options.reject { |key, _| %w( droplets threads ).include?(key.to_s) } }
+  let(:no_exclude)          { [] }
+  let(:exclude)             { %w( 100824 100825 ) }
+  let(:no_only)             { [] }
+  let(:only)                { %w( 100823 100824 ) }
+  let(:stop)                { true }
+  let(:no_stop)             { false }
+  let(:quiet)               { true }
+  let(:no_quiet)            { false }
+  let(:clean)               { true }
+  let(:no_clean)            { false }
+  let(:timeout)             { 600 }
+  let(:delay)               { 0 }
+  let(:log_path)            { "#{project_path}/log/test.log" }
+  let(:mail_options)        { Thor::CoreExt::HashWithIndifferentAccess.new(to: 'mail@somehost.com', from: 'from@host.com') }
+  let(:smtp_options)        { Thor::CoreExt::HashWithIndifferentAccess.new(address: 'smtp.gmail.com', port: '25', user_name: 'someuser', password: 'somepassword') }
+  let(:log)                 { Thor::CoreExt::HashWithIndifferentAccess.new(log: log_path) }
 
   def stub_all_api(droplets = nil, active = false)
     drops = []
@@ -89,6 +93,16 @@ shared_context 'spec' do
     ENV['DIGITAL_OCEAN_ACCESS_TOKEN'] = access_token
   end
 
+  def reset_singletons
+    DoSnapshot.configure do |config|
+      # config.logger = Logger.new($stdout)
+      config.verbose = false
+      config.quiet = true
+    end
+    DoSnapshot.logger = DoSnapshot::Log.new
+    DoSnapshot.mailer = DoSnapshot.config.mailer
+  end
+
   before(:all) do
     WebMock.reset!
   end
@@ -96,5 +110,6 @@ shared_context 'spec' do
   before(:each) do
     do_not_send_email
     set_api_keys
+    reset_singletons
   end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ end
 
 require 'do_snapshot/cli'
 require 'webmock/rspec'
+require 'fileutils'
 require 'digitalocean_c'
 require_relative 'shared/api_helpers'
 require_relative 'shared/api_v1_helpers'
@@ -17,6 +18,8 @@ require 'do_snapshot/core_ext/hash'
 WebMock.disable_net_connect!(allow_localhost: true)
 WebMock.disable!(except: [:net_http])
 
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+
 RSpec.configure do |config|
   # Pretty tests
   config.color = true
@@ -33,5 +36,3 @@ end
 def fixture(fixture_name)
   Pathname.new(project_path + '/spec/fixtures/digitalocean/').join("#{fixture_name}.json").read
 end
-
-Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }

data/spec/support/aruba.rb

@@ -0,0 +1,7 @@
+require 'aruba/rspec'
+require 'do_snapshot/runner'
+
+Aruba.configure do |config|
+  config.command_launcher = :in_process
+  config.main_class = DoSnapshot::Runner
+end

data/spec/support/matchers.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :be_found_n_times do |str, times|
+  match do |output|
+    matches = output.scan(str)
+    @size = matches.size
+    @size == times
+  end
+
+  failure_message do |actual|
+    "was found #{size} times\nexpected that '#{str}' would be found #{times} times in:\n#{actual}"
+  end
+
+  private
+
+  def size
+    @size || 0
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,10 +98,13 @@ files:
 - lib/do_snapshot/adapter/digitalocean_v2.rb
 - lib/do_snapshot/cli.rb
 - lib/do_snapshot/command.rb
+- lib/do_snapshot/configuration.rb
 - lib/do_snapshot/core_ext/hash.rb
 - lib/do_snapshot/distribution.rb
+- lib/do_snapshot/helpers.rb
 - lib/do_snapshot/log.rb
 - lib/do_snapshot/mail.rb
+- lib/do_snapshot/runner.rb
 - lib/do_snapshot/version.rb
 - spec/.keep
 - spec/do_snapshot/adapter/abstract_spec.rb
@@ -109,8 +112,11 @@ files:
 - spec/do_snapshot/adapter/digitalocean_v2_spec.rb
 - spec/do_snapshot/cli_spec.rb
 - spec/do_snapshot/command_spec.rb
+- spec/do_snapshot/configuration_spec.rb
+- spec/do_snapshot/log_spec.rb
 - spec/do_snapshot/mail_spec.rb
-- spec/do_snapshots_spec.rb
+- spec/do_snapshot/runner_spec.rb
+- spec/do_snapshot_spec.rb
 - spec/fixtures/digitalocean/v1/error_message.json
 - spec/fixtures/digitalocean/v1/response_event.json
 - spec/fixtures/digitalocean/v1/show_droplet.json
@@ -138,6 +144,8 @@ files:
 - spec/shared/environment.rb
 - spec/shared/uri_helpers.rb
 - spec/spec_helper.rb
+- spec/support/aruba.rb
+- spec/support/matchers.rb
 homepage: http://dosnapshot.merqlove.ru/
 licenses:
 - MIT
@@ -170,8 +178,11 @@ test_files:
 - spec/do_snapshot/adapter/digitalocean_v2_spec.rb
 - spec/do_snapshot/cli_spec.rb
 - spec/do_snapshot/command_spec.rb
+- spec/do_snapshot/configuration_spec.rb
+- spec/do_snapshot/log_spec.rb
 - spec/do_snapshot/mail_spec.rb
-- spec/do_snapshots_spec.rb
+- spec/do_snapshot/runner_spec.rb
+- spec/do_snapshot_spec.rb
 - spec/fixtures/digitalocean/v1/error_message.json
 - spec/fixtures/digitalocean/v1/response_event.json
 - spec/fixtures/digitalocean/v1/show_droplet.json
@@ -199,3 +210,5 @@ test_files:
 - spec/shared/environment.rb
 - spec/shared/uri_helpers.rb
 - spec/spec_helper.rb
+- spec/support/aruba.rb
+- spec/support/matchers.rb