rds-rotate-db-snapshots 0.5.2 → 1.0.0

data/.rubocop.yml

@@ -1,93 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-require:
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.2.0
-  Exclude:
-    - 'bin/{bundle,rails,rake}'
-    - vendor/**/*
-
-Layout/LineLength:
-  Max: 120
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Lint/RescueException:
-  Enabled: true
-
-Style/EmptyElse:
-  EnforcedStyle: empty
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/RescueStandardError:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/NumericLiteralPrefix:
-  Enabled: false
-
-Style/EmptyMethod:
-  Enabled: false
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Layout/EmptyLinesAroundExceptionHandlingKeywords:
-  Enabled: false
-
-Layout/FirstHashElementIndentation:
-  Enabled: false
-
-Layout/ParameterAlignment:
-  Enabled: false
-
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
-  Enabled: true
-Lint/EmptyBlock: # (new in 1.1)
-  Enabled: true
-Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
-  Enabled: true
-Lint/ToEnumArguments: # (new in 1.1)
-  Enabled: true
-Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
-  Enabled: true
-Style/ArgumentsForwarding: # (new in 1.1)
-  Enabled: true
-Style/CollectionCompact: # (new in 1.2)
-  Enabled: true
-Style/DocumentDynamicEvalDefinition: # (new in 1.1)
-  Enabled: true
-Style/NegatedIfElseCondition: # (new in 1.2)
-  Enabled: true
-Style/SwapValues: # (new in 1.1)
-  Enabled: true
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*' # Swagger specs require large blocks
-
-Style/HashSyntax:
-  EnforcedShorthandSyntax: never
-
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,127 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2023-01-10 16:06:29 UTC using RuboCop version 1.43.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'rds-rotate-db-snapshots.gemspec'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 146
-
-# Offense count: 1
-Lint/UnreachableCode:
-  Exclude:
-    - 'lib/rds_rotate_db_snapshots/options_parser.rb'
-
-# Offense count: 4
-Lint/UselessAssignment:
-  Exclude:
-    - 'bin/rds-rotate-db-snapshots'
-    - 'lib/rds_rotate_db_snapshots/actions.rb'
-
-# Offense count: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 56
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, inherit_mode.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 42
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 15
-
-# Offense count: 6
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 44
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 16
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'lib/rds_rotate_db_snapshots/options_parser.rb'
-
-# Offense count: 1
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/rds_rotate_db_snapshots/options_parser.rb'
-
-# Offense count: 3
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 9
-
-# Offense count: 10
-# Configuration parameters: .
-# SupportedStyles: have_received, receive
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Offense count: 6
-RSpec/MultipleExpectations:
-  Max: 6
-
-# Offense count: 17
-# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
-# SupportedStyles: always, named_only
-RSpec/NamedSubject:
-  Exclude:
-    - 'spec/lib/rds_rotate_db_snapshots/action_wrappers_spec.rb'
-    - 'spec/lib/rds_rotate_db_snapshots/options_parser_spec.rb'
-    - 'spec/lib/rds_rotate_db_snapshots_spec.rb'
-
-# Offense count: 1
-RSpec/StubbedMock:
-  Exclude:
-    - 'spec/lib/rds_rotate_db_snapshots/actions_spec.rb'
-
-# Offense count: 6
-RSpec/SubjectStub:
-  Exclude:
-    - '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_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/lib/rds_rotate_db_snapshots/actions_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Exclude:
-    - 'spec/helper.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 146

data/lib/rds_rotate_db_snapshots/action_wrappers.rb

@@ -1,26 +0,0 @@
-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::ServiceError => e
-              raise if e.is_a? Aws::RDS::Errors::ExpiredToken
-
-              # TODO: re-work
-              puts "Error: #{e}"
-              backoff
-              retry
-            end
-          end
-        end
-        prepend wrapper
-      end
-    end
-  end
-end

data/lib/rds_rotate_db_snapshots/actions.rb

@@ -1,112 +0,0 @@
-class RdsRotateDbSnapshots
-  module Actions
-    def rotate_em(snapshots)
-      snapshots.each do |snapshot|
-        time = snapshot[:snapshot_create_time]
-        snapshot_id = snapshot[:db_snapshot_identifier]
-        description = snapshot_id
-
-        if options[:pattern] && description !~ /#{options[:pattern]}/
-          puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Skipping snapshot with description #{description}"
-          next
-        end
-
-        keep_reason = rotate_period_based_decision_with(time, snapshot)
-        keep_reason = 'last snapshot' if keep_reason.nil? && snapshot == snapshots.last && options[:keep_last]
-        rotate_or_keep_snapshot(keep_reason, time, snapshot_id)
-      end
-    end
-
-    def create_snapshot(name, db_indentifier_ids)
-      return if name.nil?
-
-      name = name.gsub(/[^a-zA-Z0-9-]/, '')
-      if name.size.positive?
-        create_db_snapshots(name: name, db_indentifier_ids: db_indentifier_ids)
-      else
-        puts "invalid snapshot name format - #{name}"
-        exit 1
-      end
-    end
-
-    def get_db_snapshots(options)
-      snapshots = []
-      response = client.describe_db_snapshots(options)
-      loop 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.empty?
-          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
-
-    private
-
-    def rotate_period_based_decision_with(time, snapshot)
-      # poor man's way to get a deep copy of our time_periods definition hash
-      periods = Marshal.load(Marshal.dump(time_periods))
-      keep_reason = nil
-
-      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]
-        next unless 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
-
-      keep_reason
-    end
-
-    def rotate_or_keep_snapshot(keep_reason, time, snapshot_id)
-      if keep_reason.nil?
-        puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Deleting"
-        client.delete_db_snapshot(db_snapshot_identifier: snapshot_id) unless options[:dry_run]
-      else
-        puts "  #{time.strftime '%Y-%m-%d %H:%M:%S'} #{snapshot_id} Keeping for #{keep_reason}"
-      end
-    end
-
-    def create_db_snapshots(name:, db_indentifier_ids:)
-      name = "#{name}-#{Time.now.strftime('%Y%m%d%H%M%S')}"
-      db_indentifier_ids.each do |db_id|
-        unless options[:dry_run]
-          client.create_db_snapshot(db_snapshot_identifier: name,
-                                    db_instance_identifier: db_id)
-        end
-        puts "  #{Time.now.strftime '%Y-%m-%d %H:%M:%S'} Creation snapshot #{name} is pending (db: #{db_id})"
-      rescue Aws::RDS::Errors::InvalidDBInstanceStateFault
-        backoff
-        retry
-      end
-    end
-  end
-end

data/lib/rds_rotate_db_snapshots/options_parser/options.rb

@@ -1,80 +0,0 @@
-class RdsRotateDbSnapshots
-  class OptionsParser
-    module Options
-      def split_tag(hash, value)
-        value.split(',').each do |pair|
-          tag, value = pair.split('=', 2)
-          raise InvalidArgument, "invalid tag=value format" if value.nil?
-
-          hash[tag] = value
-        end
-      end
-
-      def banner_opts(opt)
-        opt.banner = "Usage: #{script_name} [options] <db_indentifier>\nUsage: #{script_name} " \
-                     "--by-tags <tag=value,...> [other options]"
-        opt.separator ""
-      end
-
-      def aws_opts(opt)
-        opt.on("--aws-access-key ACCESS_KEY", "AWS Access Key") do |v|
-          @options[:aws_access_key] = v
-        end
-
-        opt.on("--aws-secret-access-key SECRET_KEY", "AWS Secret Access Key") do |v|
-          @options[:aws_secret_access_key] = v
-        end
-
-        opt.on("--aws-region REGION", "AWS Region") do |v|
-          @options[:aws_region] = v
-        end
-
-        opt.on("--aws-session-token SESSION_TOKEN", "AWS session token") do |v|
-          @options[:aws_session_token] = v
-        end
-      end
-
-      def not_supported_opts(opt)
-        opt.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
-      end
-
-      def snapshot_create_opts(opt)
-        opt.on("--create-snapshot STRING", "Use this option if you want to create a snapshot") do |v|
-          @options[:create_snapshot] = v
-        end
-      end
-
-      def time_period_opts(opt)
-        @time_periods.keys.sort { |a, b| @time_periods[a][:seconds] <=> @time_periods[b][:seconds] }.each do |period|
-          opt.on("--keep-#{period} NUMBER", Integer, "Number of #{period} snapshots to keep") do |v|
-            @time_periods[period][:keep] = v
-          end
-        end
-
-        opt.on("--keep-last", "Keep the most recent snapshot, regardless of time-based policy") do |_v|
-          @options[:keep_last] = true
-        end
-      end
-
-      def extra_opts(opt)
-        opt.on("--pattern STRING", "Snapshots without this string in the description will be ignored") do |v|
-          @options[:pattern] = v
-        end
-        opt.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
-        opt.on("--dry-run", "Shows what would happen without doing anything") do |_v|
-          @options[:dry_run] = true
-        end
-      end
-    end
-  end
-end

data/lib/rds_rotate_db_snapshots/options_parser.rb

@@ -1,58 +0,0 @@
-require 'optparse'
-require_relative 'options_parser/options'
-class RdsRotateDbSnapshots
-  class OptionsParser
-    class NotImplementedError < StandardError; end
-    class InvalidArgument < StandardError; end
-
-    include RdsRotateDbSnapshots::OptionsParser::Options
-
-    attr_reader :options, :script_name, :time_periods
-
-    def initialize(script_name: nil, cli: false)
-      @script_name = script_name
-      @options = {
-        aws_access_key: ENV.fetch("AWS_ACCESS_KEY_ID", nil),
-        aws_secret_access_key: ENV.fetch("AWS_SECRET_ACCESS_KEY", nil),
-        aws_session_token: ENV.fetch("AWS_SESSION_TOKEN", nil),
-        aws_region: ENV.fetch("AWS_REGION", nil),
-        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|
-        banner_opts o
-        aws_opts o
-        snapshot_create_opts o
-        time_period_opts o
-        extra_opts o
-        not_supported_opts o
-      end
-    end
-  end
-end

data/lib/rds_rotate_db_snapshots/rds_client.rb

@@ -1,20 +0,0 @@
-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

@@ -1,59 +0,0 @@
-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 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 += 1
-
-    # TODO: re-work
-    if options && options[:backoff_limit].positive? && 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/spec/helper.rb

@@ -1,81 +0,0 @@
-$TESTING = true
-
-require "simplecov"
-
-SimpleCov.start do
-  add_filter "/spec"
-  minimum_coverage(75)
-
-  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/lib/rds_rotate_db_snapshots/action_wrappers_spec.rb

@@ -1,45 +0,0 @@
-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 += 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