do_snapshot 0.6.4 → 1.0.0

data/lib/do_snapshot/rspec/api_helpers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module DoSnapshot
+  module RSpec
+    module ApiHelpers # rubocop:disable Style/Documentation
+      extend ::RSpec::Core::SharedContext
+
+      # Stub helpers
+      #
+      def stub_with_id(request, id, fixture, status = 200)
+        return unless request && fixture && id
+        stub_request(:get, url_with_id(request, id))
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      def stub_without_id(request, fixture, status = 200)
+        return unless request && fixture
+        stub_request(:get, request)
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      def stub_with_id_name(request, id, name, fixture, status = 200)
+        return unless request && fixture && id && name
+        stub_request(:get, url_with_id_name(request, id, name))
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      # Url helpers
+      #
+      def url_with_id(request, id)
+        return unless request && id
+        request.sub('[id]', id.to_s)
+      end
+
+      def url_with_event_id(request, droplet_id, id)
+        return unless request && id && droplet_id
+        request.sub('[id]', id.to_s).sub('[droplet_id]', droplet_id.to_s)
+      end
+
+      def url_with_id_name(request, id, name)
+        return unless request && id && name
+        request.sub('[id]', id.to_s).sub('[name]', name)
+      end
+    end
+  end
+end

data/lib/do_snapshot/rspec/api_v2_helpers.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+module DoSnapshot
+  module RSpec
+    module ApiV2Helpers # rubocop:disable Style/Documentation,Metrics/ModuleLength
+      extend ::RSpec::Core::SharedContext
+
+      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" }
+      let(:image_destroy_uri)  { "#{images_api_base}/[id]" }
+      let(:droplets_uri)       { "#{droplets_api_base}?page=1&per_page=1000" }
+      let(:droplet_find_uri)   { "#{droplets_api_base}/[id]" }
+      let(:droplet_stop_uri)   { "#{droplets_api_base}/[id]/actions" }
+      let(:droplet_start_uri)  { "#{droplets_api_base}/[id]/actions" }
+      let(:snapshot_uri)       { "#{droplets_api_base}/[id]/actions" }
+      let(:event_find_uri)     { "#{events_api_base}/[id]" }
+      let(:action_find_uri)    { "#{actions_api_base}/[id]" }
+
+      # List of droplets
+      #
+      def stub_droplets
+        stub_without_id(droplets_uri, 'v2/show_droplets')
+      end
+
+      def stub_droplets_empty
+        stub_without_id(droplets_uri, 'v2/show_droplets_empty')
+      end
+
+      def stub_droplets_fail
+        stub_without_id(droplets_uri, 'v2/error_message')
+      end
+
+      # Droplet data
+      #
+      def stub_droplet(id)
+        stub_with_id(droplet_find_uri, id, 'v2/show_droplet')
+      end
+
+      def stub_droplet_fail(id)
+        stub_with_id(droplet_find_uri, id, 'v2/error_message')
+      end
+
+      def stub_droplet_inactive(id)
+        stub_with_id(droplet_find_uri, id, 'v2/show_droplet_inactive')
+      end
+
+      # Droplet actions
+      #
+      def stub_droplet_stop(id)
+        stub_with_id(droplet_stop_uri, id, 'v2/show_event_power_off_start', :post,
+                     type: 'power_off'
+                    )
+      end
+
+      def stub_droplet_stop_fail(id)
+        stub_with_id(droplet_stop_uri, id, 'v2/error_message', :post,
+                     {
+                       type: 'power_off'
+                     },
+                     404
+                    )
+      end
+
+      def stub_droplet_start(id)
+        stub_with_id(droplet_start_uri, id, 'v2/show_event_power_on_start', :post,
+                     type: 'power_on'
+                    )
+      end
+
+      def stub_droplet_start_done(id)
+        stub_with_id(droplet_start_uri, id, 'v2/show_event_power_on_done', :post,
+                     type: 'power_on'
+                    )
+      end
+
+      def stub_droplet_start_fail(id)
+        stub_with_id(droplet_start_uri, id, 'v2/error_message', :post,
+                     type: 'power_on'
+                    )
+      end
+
+      # Snapshot
+      #
+      def stub_droplet_snapshot(id, name)
+        stub_with_id_name(snapshot_uri, id, name, 'v2/response_event', :post,
+                          type: 'snapshot',
+                          name: name
+                         )
+      end
+
+      def stub_droplet_snapshot_fail(id, name)
+        stub_with_id_name(snapshot_uri, id, name, 'v2/error_message', :post,
+                          {
+                            type: 'snapshot',
+                            name: name
+                          },
+                          404
+                         )
+      end
+
+      # Event status
+      #
+      def stub_event_done(id)
+        stub_with_id(action_find_uri, id, 'v2/show_event_done')
+      end
+
+      def stub_event_fail(id)
+        stub_with_id(action_find_uri, id, 'v2/error_message')
+      end
+
+      def stub_event_running(id)
+        stub_with_id(action_find_uri, id, 'v2/show_event_start')
+      end
+
+      # Image actions
+      #
+      def stub_image_destroy(id)
+        stub_with_id(image_destroy_uri, id, 'v2/empty', :delete, nil, 204)
+      end
+
+      def stub_image_destroy_fail(id)
+        stub_with_id(image_destroy_uri, id, 'v2/error_message', :delete, nil, 404)
+      end
+
+      # Stub helpers
+      #
+      def stub_with_id(request, id, fixture, type = :get, body = nil, status = 200) # rubocop:disable Metrics/ParameterLists
+        return unless request && fixture && id
+        stub_request_body(type, url_with_id(request, id), body)
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      def stub_without_id(request, fixture, type = :get, body = nil, status = 200)
+        return unless request && fixture
+        stub_request_body(type, request, body)
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      def stub_with_id_name(request, id, name, fixture, type = :get, body = nil, status = 200) # rubocop:disable Metrics/ParameterLists
+        return unless request && fixture && id && name
+        stub_request_body(type, url_with_id_name(request, id, name), body)
+          .to_return(status: status, body: fixture(fixture))
+      end
+
+      # Body Helpers
+      #
+      def stub_request_body(type, request, body)
+        stub_response = stub_request(type, request).with(headers: { 'Authorization' => api_access_token })
+        return stub_response.with(body: body) if body
+        stub_response
+      end
+    end
+  end
+end

data/lib/do_snapshot/rspec/environment.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+module DoSnapshot
+  module RSpec
+    module Environment # rubocop:disable Style/Documentation
+      extend ::RSpec::Core::SharedContext
+
+      include ApiHelpers
+
+      def do_not_send_email
+        allow(Pony).to receive(:deliver) { |mail| mail }
+      end
+
+      let(:client_key)          { 'foo' }
+      let(:api_key)             { 'bar' }
+      let(:access_token)        { 'sometoken' }
+      let(:event_id)            { '7499' }
+      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_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, 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 ) }
+      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(:shutdown)            { true }
+      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 = []
+        droplets ||= [droplet_id]
+        droplets.each do |droplet|
+          drops.push Hash[
+                         stub_droplet: (active ? stub_droplet(droplet) : stub_droplet_inactive(droplet))
+                     ].merge(stub_droplet_api(droplet))
+        end
+        stubs = Hash[drops: drops]
+        @stubs = stubs.merge(default_stub_api)
+      end
+
+      def stub_droplet_api(droplet)
+        {
+          stub_droplet_stop: stub_droplet_stop(droplet),
+          stub_droplet_start: stub_droplet_start(droplet),
+          stub_droplet_snapshot: stub_droplet_snapshot(droplet, snapshot_name)
+        }
+      end
+
+      def default_stub_api
+        {
+          stub_event_done: stub_event_done(event_id),
+          stub_droplets: stub_droplets,
+          stub_image_destroy1: stub_image_destroy(image_id),
+          stub_image_destroy2: stub_image_destroy(image_id2)
+        }
+      end
+
+      def stub_cleanup
+        @stubs ||= {}
+        @stubs.each_pair do |_k, v|
+          remove_request_stub(v) if v.class == WebMock::RequestStub
+          next unless v.class == Array
+
+          v.each do |d|
+            d.each_pair do |_dk, dv|
+              remove_request_stub(dv) if v.class == WebMock::RequestStub
+            end
+          end
+        end
+      end
+
+      def reset_api_keys
+        ENV['DIGITAL_OCEAN_API_KEY']   = nil
+        ENV['DIGITAL_OCEAN_CLIENT_ID'] = nil
+        ENV['DIGITAL_OCEAN_ACCESS_TOKEN'] = nil
+      end
+
+      def set_api_keys
+        ENV['DIGITAL_OCEAN_API_KEY']   = api_key
+        ENV['DIGITAL_OCEAN_CLIENT_ID'] = client_key
+        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
+
+      before(:each) do
+        do_not_send_email
+        set_api_keys
+        reset_singletons
+      end
+    end
+  end
+end

data/lib/do_snapshot/rspec/uri_helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module DoSnapshot
+  module RSpec
+    module UriHelpers # rubocop:disable Style/Documentation
+      extend ::RSpec::Core::SharedContext
+
+      let(:droplet_url) { url_with_id(droplet_find_uri, droplet_id) }
+      let(:droplet_stop_url) { url_with_id(droplet_stop_uri, droplet_id) }
+      let(:droplet_start_url) { url_with_id(droplet_start_uri, droplet_id) }
+      let(:event_find_url) { url_with_id(event_find_uri, event_id) }
+      let(:image_destroy_url) { url_with_id(image_destroy_uri, image_id) }
+      let(:image_destroy2_url) { url_with_id(image_destroy_uri, image_id2) }
+      let(:action_find_url) { url_with_id(action_find_uri, event_id) }
+      let(:droplet_snapshot_url) { url_with_id_name(snapshot_uri, droplet_id, snapshot_name) }
+    end
+  end
+end

data/lib/do_snapshot/runner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'do_snapshot/cli'
 
 module DoSnapshot

data/lib/do_snapshot/version.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.6.4'
+  VERSION = '1.0.0'
 end

data/spec/do_snapshot/adapter/abstract_spec.rb

@@ -1,8 +1,9 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe DoSnapshot::Adapter::Abstract do
-  include_context 'environment'
+  include DoSnapshot::RSpec::Environment
 
   subject(:api) { described_class }
 

data/spec/do_snapshot/adapter/droplet_kit_spec.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe DoSnapshot::Adapter::DropletKit do
+  include DoSnapshot::RSpec::Environment
+  include DoSnapshot::RSpec::ApiV2Helpers
+  include DoSnapshot::RSpec::Adapter
+end

data/spec/do_snapshot/adapter_spec.rb

@@ -1,8 +1,9 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe DoSnapshot::Adapter do
-  include_context 'environment'
+  include DoSnapshot::RSpec::Environment
 
   module DoSnapshot
     module Adapter
@@ -17,7 +18,7 @@ RSpec.describe DoSnapshot::Adapter do
   describe '#api' do
     it 'when adapter' do
       api = adapter.api(2)
-      expect(api).to be_a_kind_of(DoSnapshot::Adapter::DigitaloceanV2)
+      expect(api).to be_a_kind_of(DoSnapshot::Adapter::DropletKit)
     end
 
     it 'when custom adapter' do

data/spec/do_snapshot/cli_spec.rb

@@ -1,12 +1,13 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe DoSnapshot::CLI do
-  include_context 'environment'
-  include_context 'api_v2_helpers'
+  include DoSnapshot::RSpec::Environment
+  include DoSnapshot::RSpec::ApiV2Helpers
 
   subject(:cli)     { described_class }
-  subject(:api)     { DoSnapshot::Adapter::DigitaloceanV2 }
+  subject(:api)     { DoSnapshot::Adapter::DropletKit }
 
   describe '.initialize' do
     it 'with args & options' do

data/spec/do_snapshot/command_spec.rb

@@ -1,15 +1,16 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe DoSnapshot::Command do
-  include_context 'environment'
-  include_context 'uri_helpers'
+  include DoSnapshot::RSpec::Environment
+  include DoSnapshot::RSpec::UriHelpers
 
   subject(:cmd)     { DoSnapshot::Command.new }
   subject(:log)     { DoSnapshot::Log }
 
   describe 'V2' do
-    include_context 'api_v2_helpers'
+    include DoSnapshot::RSpec::ApiV2Helpers
 
     describe '.snap' do
       context 'when success' do

data/spec/do_snapshot/configuration_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe DoSnapshot::Configuration do