rds-rotate-db-snapshots 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ddfaa42b87e8ad4f9cabafcea086ce82d0f351068d05db7da97b53fa5080a0f
-  data.tar.gz: dac01f0570c16a5a5a205253f0ca3e6cd26d7f7ed22377da3f9f1bad2e99d87b
+  metadata.gz: ca82ea61b9da51d2888c98f21fda30ce73850b265dcb01b75c2e99c0b84d597d
+  data.tar.gz: 778fc695f23d0c713bedad76b2ce4893401c50d270df596c1324b52dcd0546b7
 SHA512:
-  metadata.gz: 4d5d586b5ff033df7c7a4d131259d7f47b1f30e2592b616fc0e6644fcbd4999d0e24815dba96c9d335e8d6e35446293bee2b59f83ab286eda4a32a3f39cbaf38
-  data.tar.gz: 5f9339752c7a963981f1d6be97ed321a0897f8028d52f632b6dae0fb81e2e495327e127f7dec3d4040b35610ad3a7c56d9206b8220a376485c87f4372fe88470
+  metadata.gz: f8bca5be1bb1d4324ae674677f574707782f92cb9717ec66010a8686ceca450d0127017c109289738c487f25131f6cf355ad60d4a33d8c71d0b2c2278ea24b68
+  data.tar.gz: b00fe71aab391fa82e64b52f1de28bfc68632f0ae5a7961b5e1358fb55a28d19f1d9dd44dbcd59e81ce06204b8d26f290c2c253e303386144b0525c75ff1c3ec

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/rds_rotate_db_snapshots/action_wrappers.rb

@@ -9,7 +9,10 @@ class RdsRotateDbSnapshots
             reset_backoff
             begin
               super *args
-            rescue Aws::RDS::Errors => e
+            rescue Aws::RDS::Errors::ServiceError => e
+              raise if e.is_a? Aws::RDS::Errors::ExpiredToken
+              # TODO: re-work
+              puts "Error: #{e}"
               backoff
               retry
             end

data/lib/rds_rotate_db_snapshots/options_parser.rb

@@ -95,15 +95,15 @@ class RdsRotateDbSnapshots
           @options[:dry_run] = true
         end
       end
+    end
 
-      def split_tag(hash,v)
-        v.split(',').each do |pair|
-          tag, value = pair.split('=',2)
-          if value.nil?
-            raise InvalidArgument, "invalid tag=value format"
-          end
-          hash[tag] = value
+    def split_tag(hash,v)
+      v.split(',').each do |pair|
+        tag, value = pair.split('=',2)
+        if value.nil?
+          raise InvalidArgument, "invalid tag=value format"
         end
+        hash[tag] = value
       end
     end
   end

data/rds-rotate-db-snapshots.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rds-rotate-db-snapshots 0.5.0 ruby lib
+# stub: rds-rotate-db-snapshots 0.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rds-rotate-db-snapshots".freeze
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -38,7 +38,11 @@ Gem::Specification.new do |s|
     "lib/rds_rotate_db_snapshots/rds_client.rb",
     "rds-rotate-db-snapshots.gemspec",
     "spec/helper.rb",
-    "spec/rds_rotate_db_snapshots_spec.rb"
+    "spec/lib/rds_rotate_db_snapshots/action_wrappers_spec.rb",
+    "spec/lib/rds_rotate_db_snapshots/actions_spec.rb",
+    "spec/lib/rds_rotate_db_snapshots/options_parser_spec.rb",
+    "spec/lib/rds_rotate_db_snapshots/rds_client_spec.rb",
+    "spec/lib/rds_rotate_db_snapshots_spec.rb"
   ]
   s.homepage = "http://github.com/serg-kovalev/rds-rotate-db-snapshots".freeze
   s.licenses = ["MIT".freeze]

data/spec/helper.rb

@@ -4,7 +4,7 @@ require "simplecov"
 
 SimpleCov.start do
   add_filter "/spec"
-  # minimum_coverage(70)
+  minimum_coverage(75)
 
   if ENV['CI']
     require 'simplecov-lcov'

data/spec/lib/rds_rotate_db_snapshots/action_wrappers_spec.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestClass
+  def initialize
+    @backoff_counter = 0
+    @options = { backoff_limit: 5 }
+  end
+
+  def test_method
+    raise Aws::RDS::Errors::ServiceError.new(nil, 'service error')
+  end
+
+  def reset_backoff
+    @backoff_counter = 0
+  end
+
+  def backoff
+    @backoff_counter = @backoff_counter + 1
+
+    raise StandardError, 'gave up' if @options[:backoff_limit] > 0 && @options[:backoff_limit] < @backoff_counter
+  end
+
+  extend RdsRotateDbSnapshots::ActionWrappers
+
+  with_backoff :test_method
+end
+
+describe RdsRotateDbSnapshots::ActionWrappers do
+  subject { TestClass.new }
+
+  describe "#with_backoff" do
+    it "does not retry if the exception raised is Aws::RDS::Errors::ExpiredToken" do
+      allow(subject).to receive(:test_method).and_raise(Aws::RDS::Errors::ExpiredToken.new(nil, 'token expired'))
+      expect(subject).not_to receive(:reset_backoff)
+      expect(subject).not_to receive(:backoff)
+      expect{subject.test_method}.to raise_error(Aws::RDS::Errors::ExpiredToken)
+    end
+
+    it "retries if the exception raised is Aws::RDS::Errors::ServiceError" do
+      expect(subject).to receive(:backoff).exactly(6).and_call_original
+
+      expect{ subject.test_method }.to raise_error(StandardError, 'gave up')
+    end
+  end
+end

data/spec/lib/rds_rotate_db_snapshots/actions_spec.rb

@@ -0,0 +1,96 @@
+require 'helper'
+
+RSpec.shared_examples 'rds_rotate_db_snapshots actions' do
+  let(:rds_client) { instance_double(RdsRotateDbSnapshots::RdsClient) }
+  let(:client) { rds_client }
+  let(:options) do
+    { 
+      aws_access_key: 'ACCESS_KEY',
+      aws_secret_access_key: 'SECRET_KEY',
+      aws_region: 'REGION',
+      pattern: 'test',
+      dry_run: true,
+      backoff_limit: 15
+    }
+  end
+  let(:rds_snapshots) do
+    [
+      { snapshot_create_time: Time.now, db_instance_identifier: 'test_db', db_snapshot_identifier: 'test_snapshot' }
+    ]
+  end
+
+  before do
+    allow(subject).to receive(:client).and_return(rds_client)
+    allow(rds_client).to receive(:describe_db_snapshots).and_return(rds_snapshots)
+    allow(rds_client).to receive(:create_db_snapshot)
+    allow(rds_client).to receive(:delete_db_snapshot)
+  end
+
+  describe "#rotate_em" do
+    it "deletes the snapshots that are not part of the specified time periods" do
+      expect(rds_client).to receive(:delete_db_snapshot)
+      subject.rotate_em(rds_snapshots)
+    end
+  end
+
+  describe "#create_snapshot" do
+    it "creates a snapshot with the specified name" do
+      expect(rds_client).to receive(:create_db_snapshot)
+      subject.create_snapshot('test', ['test_db'])
+    end
+  end
+
+  describe "#get_db_snapshots" do
+    let(:snapshots) { double('snapshots', db_snapshots: rds_snapshots) }
+
+    it "returns the list of snapshots from the client" do
+      allow(snapshots).to receive(:[]).with(:marker).and_return(nil)
+      expect(rds_client).to receive(:describe_db_snapshots).and_return(snapshots)
+      snapshots = subject.get_db_snapshots(options)
+      expect(snapshots).to eq(rds_snapshots)
+    end
+  end
+
+end
+
+class Test
+  include RdsRotateDbSnapshots::Actions
+
+  attr_reader :options
+
+  def initialize(script_name: nil, cli: false, options: {})
+    @script_name = script_name
+    @options = options
+    @cli = cli
+    parse_options if cli?
+    @backoff_counter = 0
+  end
+
+  def reset_backoff
+    @backoff_counter = 0
+  end
+
+  def time_periods
+    @options[:time_periods] || {}
+  end
+
+  private
+
+  def cli?
+    !!@cli
+  end
+
+  def parse_options
+    @options = RdsRotateDbSnapshots::OptionsParser.new(script_name: @script_name, cli: @cli).parse!
+  end
+
+  def backoff
+    @backoff_counter = @backoff_counter + 1
+  end
+end
+
+describe RdsRotateDbSnapshots::Actions do
+  subject { Test.new }
+
+  it_behaves_like 'rds_rotate_db_snapshots actions'
+end

data/spec/lib/rds_rotate_db_snapshots/options_parser_spec.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+describe RdsRotateDbSnapshots::OptionsParser do
+  let(:script_name) { "rds_rotate_snapshots.rb" }
+  subject { RdsRotateDbSnapshots::OptionsParser.new(script_name: script_name, cli: true).parse! }
+
+  describe "#parse!" do
+    before { ARGV.clear }
+  
+    it "parses options correctly" do
+      ARGV.concat(["--aws-access-key", "ACCESS_KEY",
+                   "--aws-secret-access-key", "SECRET_KEY",
+                   "--aws-region", "REGION",
+                   "--pattern", "PATTERN",
+                   "--backoff-limit", "20",
+                   "--create-snapshot", "snapshot"])
+      options = subject
+
+      expect(options[:aws_access_key]).to eq("ACCESS_KEY")
+      expect(options[:aws_secret_access_key]).to eq("SECRET_KEY")
+      expect(options[:aws_region]).to eq("REGION")
+      expect(options[:pattern]).to eq("PATTERN")
+      expect(options[:backoff_limit]).to eq("20")
+      expect(options[:create_snapshot]).to eq("snapshot")
+    end
+
+    it "raises NotImplementedError when by-tags option is passed and it is not implemented" do
+      ARGV.concat(["--by-tags", "tag=value,tag2=value"])
+
+      expect { subject }.to raise_error(RdsRotateDbSnapshots::OptionsParser::NotImplementedError)
+    end
+  end
+end

data/spec/lib/rds_rotate_db_snapshots/rds_client_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+describe RdsRotateDbSnapshots::RdsClient do
+  let(:options) { {
+    :aws_access_key => "ACCESS_KEY",
+    :aws_secret_access_key => "SECRET_KEY",
+    :aws_session_token => "SESSION_TOKEN",
+    :aws_region => "REGION"
+  } }
+  let(:rds_client) { RdsRotateDbSnapshots::RdsClient.new(options) }
+
+  it 'configures the client with the correct credentials and region' do
+    expect(rds_client.instance_variable_get(:@client).config.credentials).
+      to have_attributes(access_key_id: "ACCESS_KEY", secret_access_key: "SECRET_KEY", session_token: "SESSION_TOKEN")
+    expect(rds_client.instance_variable_get(:@client).config.region).to eq("REGION")
+  end
+
+  it 'delegates describe_db_snapshots method to the @client object' do
+    expect(rds_client.instance_variable_get(:@client)).to receive(:describe_db_snapshots)
+    rds_client.describe_db_snapshots
+  end
+
+  it 'delegates create_db_snapshot method to the @client object' do
+    expect(rds_client.instance_variable_get(:@client)).to receive(:create_db_snapshot)
+    rds_client.create_db_snapshot("test-snapshot")
+  end
+
+  it 'delegates delete_db_snapshot method to the @client object' do
+    expect(rds_client.instance_variable_get(:@client)).to receive(:delete_db_snapshot)
+    rds_client.delete_db_snapshot("test-snapshot")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rds-rotate-db-snapshots
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Siarhei Kavaliou
@@ -108,7 +108,11 @@ files:
 - lib/rds_rotate_db_snapshots/rds_client.rb
 - rds-rotate-db-snapshots.gemspec
 - spec/helper.rb
-- spec/rds_rotate_db_snapshots_spec.rb
+- spec/lib/rds_rotate_db_snapshots/action_wrappers_spec.rb
+- spec/lib/rds_rotate_db_snapshots/actions_spec.rb
+- spec/lib/rds_rotate_db_snapshots/options_parser_spec.rb
+- spec/lib/rds_rotate_db_snapshots/rds_client_spec.rb
+- spec/lib/rds_rotate_db_snapshots_spec.rb
 homepage: http://github.com/serg-kovalev/rds-rotate-db-snapshots
 licenses:
 - MIT