rds-rotate-db-snapshots 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a666ea612ccbf5f055bebe3df9ac6f8c303e8cd6c5e56f2b389828aa2ed08e9a
-  data.tar.gz: a75dbd3e2c5d9652700de2d1ec00d68ab93eda719a8c634f6edcf6843b431b74
+  metadata.gz: 7ddfaa42b87e8ad4f9cabafcea086ce82d0f351068d05db7da97b53fa5080a0f
+  data.tar.gz: dac01f0570c16a5a5a205253f0ca3e6cd26d7f7ed22377da3f9f1bad2e99d87b
 SHA512:
-  metadata.gz: 5c0f1b569236f25233329e26b5de932fd2ff876695db1f413e04cfd8833c9743cb2d3eb38115da783be95388c441252a691a10f2082e50df9f5686d4a770e1ae
-  data.tar.gz: d545f978528f5f176b6ce440fc42aec92d9ff07bb41a510cae1aae4834897e7a1c016f37645d35ae317fbbbaae168def57e18661bfe865b5f65801e790080d41
+  metadata.gz: 4d5d586b5ff033df7c7a4d131259d7f47b1f30e2592b616fc0e6644fcbd4999d0e24815dba96c9d335e8d6e35446293bee2b59f83ab286eda4a32a3f39cbaf38
+  data.tar.gz: 5f9339752c7a963981f1d6be97ed321a0897f8028d52f632b6dae0fb81e2e495327e127f7dec3d4040b35610ad3a7c56d9206b8220a376485c87f4372fe88470

data/.github/workflows/ci.yml

@@ -2,16 +2,16 @@ name: "CI"
 
 on:
   push:
-    branches: ["master"]
+    branches: ["main"]
   pull_request:
-    branches: ["master"]
+    branches: ["main"]
 
 jobs:
   test:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        ruby_version: [2.7, 3.0, 3.1, 'jruby']
+        ruby_version: [2.7, 3.0, 3.1]
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -25,4 +25,19 @@ jobs:
       - name: Bundle Install
         run: bundle install
       - name: Test
-        run: bundle exec rake test
+        run: bundle exec rspec
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ matrix.ruby_version }}
+          parallel: true
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

data/.github/workflows/codeql.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "main" ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "master" ]
+    branches: [ "main" ]
   schedule:
     - cron: '22 4 * * 2'
 

data/.rspec

@@ -0,0 +1 @@
+-w --color

data/Gemfile

@@ -1,20 +1,19 @@
 source "https://rubygems.org"
 
 gem 'aws-sdk-rds', '~> 1'
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development, :test do
-  gem 'bundler'
-  gem 'simplecov'
-end
+gem "rake"
 
 group :development do
   gem 'juwelier'
+  gem "pry"
+  gem "pry-byebug"
 end
 
 group :test do
-  gem 'rake'
-  gem 'shoulda'
-  gem 'minitest'
+  gem "rspec", ">= 3.2"
+  gem "rspec-mocks", ">= 3"
+  gem "rubocop", "~> 0.50.0"
+  gem "simplecov", ">= 0.13"
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem "webmock"
 end

data/README.md

@@ -1,7 +1,7 @@
 # rds-rotate-db-snapshots
 
 [<img src="https://badge.fury.io/rb/rds-rotate-db-snapshots.svg" alt="Gem
-Version" />](https://badge.fury.io/rb/rds-rotate-db-snapshots) [![CI](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/ci.yml/badge.svg?query=branch%3Amaster+event%3Apush)](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/ci.yml?query=branch%3Amaster+event%3Apush) [![CodeQL](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/codeql.yml/badge.svg?query=branch%3Amaster+event%3Apush)](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/codeql.yml?query=branch%3Amaster+event%3Apush)
+Version" />](https://badge.fury.io/rb/rds-rotate-db-snapshots) [![CI](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/ci.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush) [![CodeQL](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/codeql.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/serg-kovalev/rds-rotate-db-snapshots/actions/workflows/codeql.yml?query=branch%3Amain+event%3Apush)
 
 Provides a simple way to rotate db snapshots in Amazon Relational Database
 Service (RDS).
@@ -11,7 +11,6 @@ Service (RDS).
 - 2.7
 - 3.1
 - 3.2
-- jruby
 
 ## Usage
 
@@ -65,7 +64,7 @@ show the messages.
 
 ## Contributing to rds-rotate-db-snapshots
 
-- Check out the latest master to make sure the feature hasn't been
+- Check out the latest main to make sure the feature hasn't been
   implemented or the bug hasn't been fixed yet
 - Check out the issue tracker to make sure someone already hasn't requested
   it and/or contributed it

data/Rakefile

@@ -22,21 +22,6 @@ Juwelier::Tasks.new do |gem|
 end
 Juwelier::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-# require 'simplecov'
-# Rcov::RcovTask.new do |test|
-#   test.libs << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-# end
-
-task :default => :test
-
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/bin/rds-rotate-db-snapshots

@@ -1,200 +1,25 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'aws-sdk-rds'
-require 'optparse'
+require_relative '../lib/rds_rotate_db_snapshots'
 
-$opts = {
-  :aws_access_key => ENV["AWS_ACCESS_KEY_ID"],
-  :aws_secret_access_key => ENV["AWS_SECRET_ACCESS_KEY"],
-  :aws_session_token => ENV["AWS_SESSION_TOKEN"],
-  :aws_region => ENV["AWS_REGION"],
-  :pattern => nil,
-  :by_tags => nil,
-  :dry_run => false,
-  :backoff_limit => 15,
-  :create_snapshot => nil
-}
+rrds = RdsRotateDbSnapshots.new(script_name: File.basename($0), cli: true)
 
-$time_periods = {
-  :hourly  => { :seconds => 60 * 60, :format => '%Y-%m-%d-%H', :keep => 0, :keeping => {} },
-  :daily   => { :seconds => 24 * 60 * 60, :format => '%Y-%m-%d', :keep => 0, :keeping => {} },
-  :weekly  => { :seconds => 7 * 24 * 60 * 60, :format => '%Y-%W', :keep => 0, :keeping => {} },
-  :monthly => { :seconds => 30 * 24 * 60 * 60, :format => '%Y-%m', :keep => 0, :keeping => {} },
-  :yearly  => { :seconds => 12 * 30 * 24 * 60 * 60, :format => '%Y', :keep => 0, :keeping => {} },
-}
-def backoff()
-  $backoffed = $backoffed + 1
-
-  if $opts[:backoff_limit] > 0 && $opts[:backoff_limit] < $backoffed
-    puts "Too many backoff attempts. Sorry it didn't work out."
-    exit 2
-  end
-
-  naptime = rand(60) * $backoffed
-  puts "Backing off for #{naptime} seconds..."
-  sleep naptime
-end
-
-def rotate_em(snapshots)
-  # poor man's way to get a deep copy of our time_periods definition hash
-  periods = Marshal.load(Marshal.dump($time_periods))
-
-  snapshots.each do |snapshot|
-    time = snapshot[:snapshot_create_time]
-    db_id = snapshot[:db_instance_identifier]
-    snapshot_id = snapshot[:db_snapshot_identifier]
-    description = snapshot_id
-    keep_reason = nil
-
-    if $opts[:pattern] && description !~ /#{$opts[:pattern]}/
-      puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Skipping snapshot with description #{description}"
-      next
-    end
-
-    periods.keys.sort { |a, b| periods[a][:seconds] <=> periods[b][:seconds] }.each do |period|
-      period_info = periods[period]
-      keep = period_info[:keep]
-      keeping = period_info[:keeping]
-
-      time_string = time.strftime period_info[:format]
-      if Time.now - time < keep * period_info[:seconds]
-        if !keeping.key?(time_string) && keeping.length < keep
-          keep_reason = period
-          keeping[time_string] = snapshot
-        end
-        break
-      end
-    end
-
-    if keep_reason.nil? && snapshot == snapshots.last && $opts[:keep_last]
-      keep_reason = 'last snapshot'
-    end
-
-    if !keep_reason.nil?
-      puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Keeping for #{keep_reason}"
-    else
-      puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Deleting"
-      begin
-        $rds.delete_db_snapshot(db_snapshot_identifier: snapshot_id) unless $opts[:dry_run]
-      rescue Aws::RDS::Errors => e
-        backoff()
-        retry
-      end
-    end
-  end
-end
-
-def create_snapshot(name, db_indentifier_ids)
-  if !!name
-    name = name.gsub(/[^a-zA-Z0-9\-]/, '')
-    if name.size > 0
-      name = "#{name}-#{Time.now.strftime('%Y%m%d%H%M%S')}"
-      db_indentifier_ids.each do |db_id|
-        begin
-          $rds.create_db_snapshot(db_snapshot_identifier: name, db_instance_identifier: db_id) unless $opts[:dry_run]
-          puts "  #{Time.now.strftime '%Y-%m-%d %H:%M:%S'} Creation snapshot #{name} is pending (db: #{db_id})"
-        rescue Aws::RDS::Errors::InvalidDBInstanceStateFault => e
-          backoff()
-          retry
-        end
-      end
-    else
-      puts "invalid snapshot name format - #{name}"
-      exit 1
-    end
-  end
-end
-
-def split_tag(hash,v)
-    v.split(',').each do |pair|
-        tag, value = pair.split('=',2)
-        if value.nil?
-          puts "invalid tag=value format"
-          exit 1
-        end
-        hash[tag] = value
-    end
-end
-
-def get_db_snapshots(options)
-  snapshots = []
-  response = $rds.describe_db_snapshots(options)
-  while true do
-    snapshots += response.db_snapshots
-    break unless response[:marker]
-
-    response = $rds.describe_db_snapshots(options.merge(marker: response[:marker]))
-  end
-  snapshots
+if rrds.options[:aws_access_key].nil? || rrds.options[:aws_secret_access_key].nil?
+  puts "You must specify your Amazon credentials via --aws-access-key and --aws-secret_access-key and --aws-session-token"
+  exit 1
 end
 
-OptionParser.new do |o|
-  script_name = File.basename($0)
-  o.banner = "Usage: #{script_name} [options] <db_indentifier>\nUsage: #{script_name} --by-tags <tag=value,...> [other options]"
-  o.separator ""
-
-  o.on("--aws-access-key ACCESS_KEY", "AWS Access Key") do |v|
-    $opts[:aws_access_key] = v
-  end
-
-  o.on("--aws-secret-access-key SECRET_KEY", "AWS Secret Access Key") do |v|
-    $opts[:aws_secret_access_key] = v
-  end
-
-  o.on("--aws-region REGION", "AWS Region") do |v|
-    $opts[:aws_region] = v
-  end
-
-  o.on("--aws-session-token SESSION_TOKEN", "AWS session token") do |v|
-    $opts[:aws_session_token] = v
-  end
-
-  o.on("--pattern STRING", "Snapshots without this string in the description will be ignored") do |v|
-    $opts[:pattern] = v
-  end
-
-  o.on("--by-tags TAG=VALUE,TAG=VALUE", "Instead of rotating specific snapshots, rotate over all the snapshots having the intersection of all given TAG=VALUE pairs.") do |v|
-    $opts[:by_tags] = {}
-    puts 'Hey! It\'s not implemented in RDS yet. Who knows, maybe they will add Tagging in RDS later.'
-    exit 0
-    split_tag($opts[:by_tags],v)
-  end
-
-  o.on("--backoff-limit LIMIT", "Backoff and retry when hitting RDS Error exceptions no more than this many times. Default is 15") do |v|
-    $opts[:backoff_limit] = v
-  end
-
-  o.on("--create-snapshot STRING", "Use this option if you want to create a snapshot") do |v|
-    $opts[:create_snapshot] = v
-  end
-
-  $time_periods.keys.sort { |a, b| $time_periods[a][:seconds] <=> $time_periods[b][:seconds] }.each do |period|
-    o.on("--keep-#{period} NUMBER", Integer, "Number of #{period} snapshots to keep") do |v|
-      $time_periods[period][:keep] = v
-    end
-  end
-
-  o.on("--keep-last", "Keep the most recent snapshot, regardless of time-based policy") do |v|
-    $opts[:keep_last] = true
-  end
-
-  o.on("--dry-run", "Shows what would happen without doing anything") do |v|
-    $opts[:dry_run] = true
-  end
-end.parse!
-
-if $opts[:aws_access_key].nil? || $opts[:aws_secret_access_key].nil?
-  puts "You must specify your Amazon credentials via --aws-access-key and --aws-secret_access-key"
+if rrds.options[:aws_region].nil?
+  puts "You must specify your AWS Region via --aws-region"
   exit 1
 end
 
-if ARGV.empty? and $opts[:by_tags].nil?
+if ARGV.empty? and rrds.options[:by_tags].nil?
   puts "You must provide at least one DB Indentifier when not rotating by tags"
   exit 1
 end
 
-if $opts[:by_tags].nil?
+if rrds.options[:by_tags].nil?
   db_indentifier_ids = ARGV
 
   db_indentifier_ids.each do |db_id|
@@ -208,83 +33,29 @@ else
   if !ARGV.empty?
     puts "Ignoring supplied db_indentifier_ids because we're rotating by tags."
   end
-  if $opts[:by_tags].length == 0
+  if rrds.options[:by_tags].length == 0
     puts "Rotating by tags but no tags specified? Refusing to rotate all snapshots!"
     exit 1
   end
 end
 
-if $opts[:backoff_limit] < 0
+if rrds.options[:backoff_limit] < 0
   puts "A negative backoff limit doesn't make much sense."
   exit 1
 end
 
-$backoffed = 0
-begin
-  Aws.config.update(
-    access_key_id: $opts[:aws_access_key],
-    secret_access_key: $opts[:aws_secret_access_key],
-    region: $opts[:aws_region],
-    session_token: $opts[:aws_session_token]
-  )
-  $rds = Aws::RDS::Client.new
-rescue Aws::RDS::Errors => e
-  backoff()
-  retry
-end
-
-if $opts[:create_snapshot]
-  create_snapshot($opts[:create_snapshot], db_indentifier_ids)
+if rrds.options[:create_snapshot]
+  rrds.create_snapshot(rrds.options[:create_snapshot], db_indentifier_ids)
 end
 
 all_snapshots = []
-if $opts[:by_tags]
-  $opts[:by_tags].each do |tag, value|
-    begin
-      these_snapshots = $rds.describe_tags(snapshot_type: 'manual', filters: {'resource-type'=>"snapshot", 'key'=>tag, 'value'=>value}).
-        delete_if{ |e| e.status != 'available' }
-    rescue Aws::RDS::Errors => e
-      backoff()
-      retry
-    end
-    if these_snapshots.length == 0
-      puts "(tag,value)=(#{tag},#{value}) found no snapshots; nothing to rotate!"
-      exit 0
-    end
-    if all_snapshots.length == 0
-      remaining_snapshots = these_snapshots
-    else
-      remaining_snapshots = all_snapshots & these_snapshots
-    end
-    if remaining_snapshots.length == 0
-      puts "No remaining snapshots after applying (tag,value)=(#{tag},#{value}) filter; nothing to rotate!"
-      exit 0
-    end
-    all_snapshots = remaining_snapshots
-  end
-
-  begin
-    rotate_these = get_db_snapshots(db_instance_identifier: all_snapshots.map(&:db_instance_identifier).uniq).
-      delete_if{ |e| !all_snapshots.include?(e.db_snapshot_identifier) }.
-      sort {|a,b| a[:snapshot_create_time] <=> b[:snapshot_create_time] }
-  rescue Aws::RDS::Errors => e
-    backoff()
-    retry
-  end
-
-  rotate_em(rotate_these)
+if rrds.options[:by_tags]
+  rrds.rotate_by_tags
 else
-  begin
-    all_snapshots = get_db_snapshots(snapshot_type: 'manual').
-      delete_if{ |e| e[:status] != 'available' }
-  rescue Aws::RDS::Errors => e
-    backoff()
-    retry
-  end
-
+  snapshots = rrds.get_db_snapshots(snapshot_type: 'manual').delete_if{ |e| e[:status] != 'available' }
   db_indentifier_ids.each do |db_id|
-    rotate_em(
-      all_snapshots.select {|ss| ss[:db_instance_identifier] == db_id }.
+    rrds.rotate_em(
+      snapshots.select {|ss| ss[:db_instance_identifier] == db_id }.
         sort {|a,b| a[:snapshot_create_time] <=> b[:snapshot_create_time] }
     )
   end

data/lib/rds_rotate_db_snapshots/action_wrappers.rb

@@ -0,0 +1,23 @@
+require 'aws-sdk-rds'
+
+class RdsRotateDbSnapshots
+  module ActionWrappers
+    def with_backoff(*method_names)
+      method_names.each do |m|
+        wrapper = Module.new do
+          define_method(m) do |*args|
+            reset_backoff
+            begin
+              super *args
+            rescue Aws::RDS::Errors => e
+              backoff
+              retry
+            end
+            
+          end
+        end
+        self.prepend wrapper
+      end
+    end
+  end
+end

data/lib/rds_rotate_db_snapshots/actions.rb

@@ -0,0 +1,105 @@
+class RdsRotateDbSnapshots
+  module Actions
+    def rotate_em(snapshots)
+      # poor man's way to get a deep copy of our time_periods definition hash
+      periods = Marshal.load(Marshal.dump(time_periods))
+    
+      snapshots.each do |snapshot|
+        time = snapshot[:snapshot_create_time]
+        db_id = snapshot[:db_instance_identifier]
+        snapshot_id = snapshot[:db_snapshot_identifier]
+        description = snapshot_id
+        keep_reason = nil
+    
+        if options[:pattern] && description !~ /#{options[:pattern]}/
+          puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Skipping snapshot with description #{description}"
+          next
+        end
+    
+        periods.keys.sort { |a, b| periods[a][:seconds] <=> periods[b][:seconds] }.each do |period|
+          period_info = periods[period]
+          keep = period_info[:keep]
+          keeping = period_info[:keeping]
+    
+          time_string = time.strftime period_info[:format]
+          if Time.now - time < keep * period_info[:seconds]
+            if !keeping.key?(time_string) && keeping.length < keep
+              keep_reason = period
+              keeping[time_string] = snapshot
+            end
+            break
+          end
+        end
+    
+        if keep_reason.nil? && snapshot == snapshots.last && options[:keep_last]
+          keep_reason = 'last snapshot'
+        end
+    
+        if !keep_reason.nil?
+          puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Keeping for #{keep_reason}"
+        else
+          puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Deleting"
+          begin
+            client.delete_db_snapshot(db_snapshot_identifier: snapshot_id) unless options[:dry_run]
+          rescue Aws::RDS::Errors => e
+            backoff
+            retry
+          end
+        end
+      end
+    end
+    
+    def create_snapshot(name, db_indentifier_ids)
+      if !!name
+        name = name.gsub(/[^a-zA-Z0-9\-]/, '')
+        if name.size > 0
+          name = "#{name}-#{Time.now.strftime('%Y%m%d%H%M%S')}"
+          db_indentifier_ids.each do |db_id|
+            begin
+              client.create_db_snapshot(db_snapshot_identifier: name, db_instance_identifier: db_id) unless options[:dry_run]
+              puts "  #{Time.now.strftime '%Y-%m-%d %H:%M:%S'} Creation snapshot #{name} is pending (db: #{db_id})"
+            rescue Aws::RDS::Errors::InvalidDBInstanceStateFault => e
+              backoff
+              retry
+            end
+          end
+        else
+          puts "invalid snapshot name format - #{name}"
+          exit 1
+        end
+      end
+    end
+    
+    def get_db_snapshots(options)
+      snapshots = []
+      response = client.describe_db_snapshots(options)
+      while true do
+        snapshots += response.db_snapshots
+        break unless response[:marker]
+    
+        response = client.describe_db_snapshots(options.merge(marker: response[:marker]))
+      end
+      snapshots
+    end
+
+    def rotate_by_tags
+      snapshots = []
+      options[:by_tags].each do |tag, value|
+        snapshots = rrds.client.describe_tags(
+            snapshot_type: 'manual', filters: {'resource-type'=>"snapshot", 'key'=>tag, 'value'=>value}
+          ).delete_if{ |e| e.status != 'available' }
+        # TODO: re-work
+        if snapshots.length == 0
+          puts "(tag,value)=(#{tag},#{value}) found no snapshots; nothing to rotate!"
+          exit 0
+        end
+      end
+
+      snapshots = get_db_snapshots(db_instance_identifier: snapshots.map(&:db_instance_identifier).uniq).
+        delete_if{ |e| !snapshots.include?(e.db_snapshot_identifier) }.
+        sort {|a,b| a[:snapshot_create_time] <=> b[:snapshot_create_time] }
+
+      rotate_em snapshots
+    end
+  end
+end

data/lib/rds_rotate_db_snapshots/options_parser.rb

@@ -0,0 +1,110 @@
+require 'optparse'
+
+class RdsRotateDbSnapshots
+  class OptionsParser
+    class NotImplementedError < StandardError; end
+    class InvalidArgument < StandardError; end
+
+    attr_reader :options, :script_name, :time_periods
+
+    def initialize(script_name: nil, cli: false)
+      @script_name = script_name
+      @options = {
+        :aws_access_key => ENV["AWS_ACCESS_KEY_ID"],
+        :aws_secret_access_key => ENV["AWS_SECRET_ACCESS_KEY"],
+        :aws_session_token => ENV["AWS_SESSION_TOKEN"],
+        :aws_region => ENV["AWS_REGION"],
+        :pattern => nil,
+        :by_tags => nil,
+        :dry_run => false,
+        :backoff_limit => 15,
+        :create_snapshot => nil
+      }
+      @time_periods = {
+        :hourly  => { :seconds => 60 * 60, :format => '%Y-%m-%d-%H', :keep => 0, :keeping => {} },
+        :daily   => { :seconds => 24 * 60 * 60, :format => '%Y-%m-%d', :keep => 0, :keeping => {} },
+        :weekly  => { :seconds => 7 * 24 * 60 * 60, :format => '%Y-%W', :keep => 0, :keeping => {} },
+        :monthly => { :seconds => 30 * 24 * 60 * 60, :format => '%Y-%m', :keep => 0, :keeping => {} },
+        :yearly  => { :seconds => 12 * 30 * 24 * 60 * 60, :format => '%Y', :keep => 0, :keeping => {} },
+      }
+      @cli = cli
+      init_cli_parser if cli?
+    end
+
+    def parse!
+      @parser.parse!
+      @options.merge(time_periods: @time_periods)
+    end
+
+    private
+
+    def cli?
+      !!@cli
+    end
+
+    def init_cli_parser
+      @parser ||= OptionParser.new do |o|
+        o.banner = "Usage: #{script_name} [options] <db_indentifier>\nUsage: #{script_name} --by-tags <tag=value,...> [other options]"
+        o.separator ""
+      
+        o.on("--aws-access-key ACCESS_KEY", "AWS Access Key") do |v|
+          @options[:aws_access_key] = v
+        end
+      
+        o.on("--aws-secret-access-key SECRET_KEY", "AWS Secret Access Key") do |v|
+          @options[:aws_secret_access_key] = v
+        end
+      
+        o.on("--aws-region REGION", "AWS Region") do |v|
+          @options[:aws_region] = v
+        end
+      
+        o.on("--aws-session-token SESSION_TOKEN", "AWS session token") do |v|
+          @options[:aws_session_token] = v
+        end
+      
+        o.on("--pattern STRING", "Snapshots without this string in the description will be ignored") do |v|
+          @options[:pattern] = v
+        end
+      
+        o.on("--by-tags TAG=VALUE,TAG=VALUE", "Instead of rotating specific snapshots, rotate over all the snapshots having the intersection of all given TAG=VALUE pairs.") do |v|
+          @options[:by_tags] = {}
+          raise NotImplementedError, 'Hey! It\'s not implemented in RDS yet. Who knows, maybe they will add Tagging in RDS later.'
+          split_tag(@options[:by_tags],v)
+        end
+      
+        o.on("--backoff-limit LIMIT", "Backoff and retry when hitting RDS Error exceptions no more than this many times. Default is 15") do |v|
+          @options[:backoff_limit] = v
+        end
+      
+        o.on("--create-snapshot STRING", "Use this option if you want to create a snapshot") do |v|
+          @options[:create_snapshot] = v
+        end
+      
+        @time_periods.keys.sort { |a, b| @time_periods[a][:seconds] <=> @time_periods[b][:seconds] }.each do |period|
+          o.on("--keep-#{period} NUMBER", Integer, "Number of #{period} snapshots to keep") do |v|
+            @time_periods[period][:keep] = v
+          end
+        end
+      
+        o.on("--keep-last", "Keep the most recent snapshot, regardless of time-based policy") do |v|
+          @options[:keep_last] = true
+        end
+      
+        o.on("--dry-run", "Shows what would happen without doing anything") do |v|
+          @options[:dry_run] = true
+        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
+        end
+      end
+    end
+  end
+end

data/lib/rds_rotate_db_snapshots/rds_client.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+require 'aws-sdk-rds'
+
+class RdsRotateDbSnapshots
+  class RdsClient
+    extend Forwardable
+
+    def_delegators :@client, :describe_db_snapshots, :create_db_snapshot, :delete_db_snapshot
+
+    def initialize(options)
+      Aws.config.update(
+        access_key_id: options[:aws_access_key],
+        secret_access_key: options[:aws_secret_access_key],
+        region: options[:aws_region],
+        session_token: options[:aws_session_token]
+      )
+      @client = Aws::RDS::Client.new
+    end
+  end
+end

data/lib/rds_rotate_db_snapshots.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require_relative 'rds_rotate_db_snapshots/actions'
+require_relative 'rds_rotate_db_snapshots/action_wrappers'
+require_relative 'rds_rotate_db_snapshots/options_parser'
+require_relative 'rds_rotate_db_snapshots/rds_client'
+
+class RdsRotateDbSnapshots
+  extend RdsRotateDbSnapshots::ActionWrappers
+  include RdsRotateDbSnapshots::Actions
+
+  attr_reader :options
+  with_backoff :get_db_snapshots, :create_snapshot, :rotate_em
+
+  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 rds_client
+    @rds_client ||= RdsRotateDbSnapshots::RdsClient.new(@options)
+  end
+  alias_method :client, :rds_client
+
+  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
+  
+    # TODO: re-work
+    if options && options[:backoff_limit] > 0 && options[:backoff_limit] < @backoff_counter
+      puts "Too many backoff attempts. Sorry it didn't work out."
+      exit 2
+    end
+  
+    naptime = rand(60) * @backoff_counter
+    puts "Backing off for #{naptime} seconds..."
+    sleep naptime
+  end
+end

data/rds-rotate-db-snapshots.gemspec

@@ -2,16 +2,16 @@
 # 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.4.3 ruby lib
+# stub: rds-rotate-db-snapshots 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rds-rotate-db-snapshots".freeze
-  s.version = "0.4.3"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Siarhei Kavaliou".freeze]
-  s.date = "2022-12-26"
+  s.date = "2023-01-10"
   s.description = "Provides a simple way to rotate RDS DB snapshots with configurable retention periods.".freeze
   s.email = "kovserg@gmail.com".freeze
   s.executables = ["rds-rotate-db-snapshots".freeze]
@@ -24,16 +24,21 @@ Gem::Specification.new do |s|
     ".github/dependabot.yml",
     ".github/workflows/ci.yml",
     ".github/workflows/codeql.yml",
+    ".rspec",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
     "VERSION",
     "bin/rds-rotate-db-snapshots",
-    "lib/.empty",
+    "lib/rds_rotate_db_snapshots.rb",
+    "lib/rds_rotate_db_snapshots/action_wrappers.rb",
+    "lib/rds_rotate_db_snapshots/actions.rb",
+    "lib/rds_rotate_db_snapshots/options_parser.rb",
+    "lib/rds_rotate_db_snapshots/rds_client.rb",
     "rds-rotate-db-snapshots.gemspec",
-    "test/helper.rb",
-    "test/test_rds-rotate-db-snapshots.rb"
+    "spec/helper.rb",
+    "spec/rds_rotate_db_snapshots_spec.rb"
   ]
   s.homepage = "http://github.com/serg-kovalev/rds-rotate-db-snapshots".freeze
   s.licenses = ["MIT".freeze]
@@ -46,14 +51,16 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<aws-sdk-rds>.freeze, ["~> 1"])
-    s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_runtime_dependency(%q<rake>.freeze, [">= 0"])
     s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_development_dependency(%q<pry>.freeze, [">= 0"])
+    s.add_development_dependency(%q<pry-byebug>.freeze, [">= 0"])
   else
     s.add_dependency(%q<aws-sdk-rds>.freeze, ["~> 1"])
-    s.add_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<pry>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
   end
 end
 

data/spec/helper.rb

@@ -0,0 +1,81 @@
+$TESTING = true
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "/spec"
+  # minimum_coverage(70)
+
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require "rds_rotate_db_snapshots"
+
+require "rdoc"
+require "rspec"
+require "diff/lcs" # You need diff/lcs installed to run specs.
+# require 'stringio'
+require "webmock/rspec"
+
+WebMock.disable_net_connect!(:allow => "coveralls.io")
+
+$0 = "rds_rotate_db_snapshots"
+ARGV.clear
+
+RSpec.configure do |config|
+  config.before do
+    ARGV.replace []
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # def capture(stream)
+  #   begin
+  #     stream = stream.to_s
+  #     eval "$#{stream} = StringIO.new"
+  #     yield
+  #     result = eval("$#{stream}").string
+  #   ensure
+  #     eval("$#{stream} = #{stream.upcase}")
+  #   end
+
+  #   result
+  # end
+
+  def source_root
+    File.join(File.dirname(__FILE__), "fixtures")
+  end
+
+  def destination_root
+    File.join(File.dirname(__FILE__), "sandbox")
+  end
+
+  def silence_warnings
+    old_verbose = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+
+  # true if running on windows, used for conditional spec skips
+  #
+  # @return [TrueClass/FalseClass]
+  def windows?
+    Gem.win_platform?
+  end
+
+  # alias silence capture
+end

data/spec/rds_rotate_db_snapshots_spec.rb

@@ -0,0 +1,62 @@
+require "helper"
+
+describe RdsRotateDbSnapshots do
+  subject { described_class.new(script_name: script_name, cli: cli) }
+
+  let(:script_name) { "test" }
+  let(:cli) { true }
+  before do
+    allow(Aws::RDS::Client).to receive(:new)
+  end
+
+  describe "on include" do
+    it "adds action methods to the base class" do
+      expect(described_class.instance_methods).to include(:rotate_em)
+      expect(described_class.instance_methods).to include(:create_snapshot)
+      expect(described_class.instance_methods).to include(:get_db_snapshots)
+      expect(described_class.instance_methods).to include(:rotate_by_tags)
+      expect(described_class.instance_methods).to include(:client)
+      expect(described_class.instance_methods).to include(:time_periods)
+    end
+  end
+
+  describe "#client" do
+    it "returns an RdsClient" do
+      expect(subject.client).to be_a(RdsRotateDbSnapshots::RdsClient)
+    end
+  end
+
+  describe "#rds_client" do
+    it "returns an RdsClient" do
+      expect(subject.rds_client).to be_a(RdsRotateDbSnapshots::RdsClient)
+    end
+  end
+
+  describe "#reset_backoff" do
+    it "resets backoff counter" do
+      subject.instance_variable_set(:@backoff_counter, 1)
+      subject.reset_backoff
+      expect(subject.instance_variable_get(:@backoff_counter)).to eq(0)
+    end
+  end
+
+  describe "#time_periods" do
+    it "returns time periods" do
+      expect(subject.time_periods).to eq(
+        :daily=>{:format=>"%Y-%m-%d", :keep=>0, :keeping=>{}, :seconds=>86400},
+        :hourly => {:format=>"%Y-%m-%d-%H", :keep=>0, :keeping=>{}, :seconds=>3600},
+        :monthly => {:format=>"%Y-%m", :keep=>0, :keeping=>{}, :seconds=>2592000},
+        :weekly => {:format=>"%Y-%W", :keep=>0, :keeping=>{}, :seconds=>604800},
+        :yearly=>{:format=>"%Y", :keep=>0, :keeping=>{}, :seconds=>31104000}
+      )
+    end
+  end
+
+  describe "#backoff" do
+    it "backs off" do
+      subject.instance_variable_set(:@backoff_counter, 1)
+      expect(subject).to receive(:sleep)
+      subject.send(:backoff)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rds-rotate-db-snapshots
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Siarhei Kavaliou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-rds
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,16 +94,21 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/codeql.yml"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
 - bin/rds-rotate-db-snapshots
-- lib/.empty
+- lib/rds_rotate_db_snapshots.rb
+- lib/rds_rotate_db_snapshots/action_wrappers.rb
+- lib/rds_rotate_db_snapshots/actions.rb
+- lib/rds_rotate_db_snapshots/options_parser.rb
+- lib/rds_rotate_db_snapshots/rds_client.rb
 - rds-rotate-db-snapshots.gemspec
-- test/helper.rb
-- test/test_rds-rotate-db-snapshots.rb
+- spec/helper.rb
+- spec/rds_rotate_db_snapshots_spec.rb
 homepage: http://github.com/serg-kovalev/rds-rotate-db-snapshots
 licenses:
 - MIT

data/lib/.empty

@@ -1 +0,0 @@
-Juwelier doesn't like me not having a lib/ directory.

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-require 'minitest'
-require 'shoulda'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-class Minitest::Test
-end

data/test/test_rds-rotate-db-snapshots.rb

@@ -1,7 +0,0 @@
-require_relative 'helper'
-
-class TestRdsRotateDbSnapshots < Minitest::Test
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end