ebs_snapper 0.0.8 → 0.0.9

data/config/sample.config.yaml

@@ -4,5 +4,6 @@ aws:
   secret_access_key : 'ACCESS KEY'
   volume_tag : 'Snapper' # tag to use in AWS for the EBS backup flags
   retain : '10.days'
+  max_retries : 3
+  pause_time: 1
 log_to: '/var/log/ebs_snapper.log'
-pause_time: 1

data/lib/ebs_snapper/cli.rb

@@ -21,7 +21,10 @@ class EbsSnapper::CLI
   
   def self.run  
     opts = parse(ARGV)
-    ebs = EbsSnapper::Ebs.new(opts[:aws])
+    if opts[:dry_run]
+       @logger.info "Dry run mode enabled"
+    end
+    ebs = EbsSnapper::Ebs.new(opts[:aws], opts[:dry_run])
     ebs.snapshot_and_purge
   rescue => e
     @logger.error "Exception: #{e}\n" + e.backtrace().join("\n")
@@ -49,12 +52,12 @@ class EbsSnapper::CLI
   def self.parse(args)
     options = {}
     options[:aws] = {}
+    options[:dry_run] = false
     options[:ultradns] = {}
     options[:log_to] = nil
     options[:verbose] = false
     options[:out] = ''
     options[:config] = nil
-    options[:pause_time] = 1
     
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: ebs_snapper [options]"
@@ -73,6 +76,10 @@ class EbsSnapper::CLI
         options[:verbose] = v
       end
 
+      opts.on("-d", "--dry-run", "Dry run, will not create or delete snapshots") do
+        options[:dry_run] = true
+      end
+
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit

data/lib/ebs_snapper/ebs.rb

@@ -19,16 +19,26 @@ class EbsSnapper::Ebs
   DEFAULT_TAG_NAME = 'Snapper'
   DEFAULT_PAUSE_TIME = 0
   
-  def initialize(opts = {})
+  def initialize(opts = {}, dry_run = false)
+    @dry_run = dry_run
+    @logger = opts[:logger] || Logger.new(STDOUT)
+    max_retries = opts[:max_retries] || AWS.config.max_retries
     if !opts[:secret_access_key].nil? && !opts[:access_key_id].nil?
       AWS.config(:access_key_id => opts[:access_key_id],
-                 :secret_access_key => opts[:secret_access_key])
+                 :secret_access_key => opts[:secret_access_key],
+                 :logger => @logger,
+                 :max_retries => max_retries) 
+    else
+      AWS.config(:logger => @logger,
+                 :max_retries => max_retries) 
     end
 
-    @logger = opts[:logger] || Logger.new(STDOUT)
     @retain = opts[:retain]
     @tag_name = opts[:volume_tag] || DEFAULT_TAG_NAME # default
     PausingEnumerable.pause_time = opts[:pause_time] || DEFAULT_PAUSE_TIME
+    @logger.info "Initializing"
+    @logger.info {"Dry run mode: #{@dry_run}"}
+    @logger.info {"AWS SDK max retries: #{AWS.config.max_retries}"}
   end
   
   def snapshot_and_purge
@@ -62,13 +72,18 @@ class EbsSnapper::Ebs
   end
   
   def snapshot_volume(region, vol_id)
-    timestamp = Time.now.utc
-    @logger.info {"Snapshotting #{vol_id} at: #{timestamp}"}
     vol = region.volumes[vol_id]
     if vol != nil
-      snapshot = vol.create_snapshot("Snapper Backup #{timestamp}")
-      # tag the snapshot with the timestamp so we can look it up later for cleanup
-      snapshot.tag(@tag_name, :value => "#{timestamp.to_i}")
+      if dry_run?
+        @logger.info {"Dry run - would have called vol.create_snapshot for volume #{vol_id}"}
+        @logger.info {"Dry run - would have called snapshot.tag for new snapshot of volume #{vol_id}"}
+      else 
+        timestamp = Time.now.utc
+        @logger.info {"Snapshotting #{vol_id} at: #{timestamp}"}
+        snapshot = vol.create_snapshot("Snapper Backup #{timestamp}")
+        # tag the snapshot with the timestamp so we can look it up later for cleanup
+        snapshot.tag(@tag_name, :value => "#{timestamp.to_i}")
+      end
     else
       @logger.error "Error: Volume #{vol_id} in Region: #{region} not found"
     end
@@ -80,9 +95,13 @@ class EbsSnapper::Ebs
       unless snapshot.status == :pending
         ts = snapshot.tags[@tag_name]
         if ttl.purge?(ts)
-          @logger.info {"Purging #{vol_id} snapshot: #{snapshot.id}"}
           begin
-            snapshot.delete
+            if dry_run?
+              @logger.info {"Dry run - would have called snapshot.delete for snapshot #{snapshot.id} of volume #{vol_id}"}
+            else
+              @logger.info {"Purging #{vol_id} snapshot: #{snapshot.id}"}
+              snapshot.delete
+            end
           rescue => e
             @logger.error "Exception: #{e}\n" + e.backtrace().join("\n")
           end
@@ -90,6 +109,10 @@ class EbsSnapper::Ebs
       end
     end
   end
+  
+  def dry_run?
+    @dry_run == true
+  end
 
   module PausingEnumerable
     
@@ -120,6 +143,7 @@ class EbsSnapper::Ebs
       enumerable
     end
   end
+  
 
   def each_region
     ec2.regions.each do |region|

data/lib/ebs_snapper/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module EbsSnapper
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/lib/ebs_spec.rb

@@ -19,6 +19,37 @@ require 'ostruct'
 describe EbsSnapper::Ebs do 
   DEFAULT_TAG_NAME = EbsSnapper::Ebs::DEFAULT_TAG_NAME
   
+  
+  it "should run purge_old_snapshots in dry mode" do
+    ebs = EbsSnapper::Ebs.new({}, true)
+    ttl = EbsSnapper::Ebs::TTL.new("1.day") # 1 day
+    region = OpenStruct.new
+    
+    snapshot_old = OpenStruct.new
+    snapshot_old.status = :complete
+    snapshot_old.tags = {DEFAULT_TAG_NAME => Time.now.utc.to_i - (86400 * 2)}
+    snapshot_old.should_not_receive(:delete)
+    
+    region.snapshots = [snapshot_old]
+    region.snapshots.stub(:filter).and_return(region.snapshots)
+    
+    ebs.purge_old_snapshots(ttl, region, 2)
+  end
+  
+  it "should run snapshot_volume in dry mode" do
+    ebs = EbsSnapper::Ebs.new({}, true)
+    
+    region = OpenStruct.new
+    region.tags = []
+    region.id = '999'
+    
+    volume = OpenStruct.new
+    volume.should_not_receive(:create_snapshot)
+    region.volumes = {3 => volume}
+    
+    ebs.snapshot_volume(region, 3).should == true
+  end
+  
   it "should find tagged volumes in a region" do
     ebs = EbsSnapper::Ebs.new
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebs_snapper
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 529299969700256006
+      hash: 1635891677389619037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 529299969700256006
+      hash: 1635891677389619037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24