backup 3.0.23 → 3.0.24

data/lib/backup/syncer/cloud/s3.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Backup
+  module Syncer
+    module Cloud
+      class S3 < Base
+
+        ##
+        # Amazon Simple Storage Service (S3) Credentials
+        attr_accessor :access_key_id, :secret_access_key
+
+        ##
+        # The S3 bucket to store files to
+        attr_accessor :bucket
+
+        ##
+        # The AWS region of the specified S3 bucket
+        attr_accessor :region
+
+        ##
+        # Instantiates a new Cloud::S3 Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::Cloud::S3
+        # are set via a super() call to Cloud::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and Cloud specific defaults are set,
+        # the block from the user's configuration file is evaluated.
+        def initialize(&block)
+          super
+
+          instance_eval(&block) if block_given?
+          @path = path.sub(/^\//, '')
+        end
+
+        private
+
+        ##
+        # Established and creates a new Fog storage object for S3.
+        def connection
+          @connection ||= Fog::Storage.new(
+            :provider              => provider,
+            :aws_access_key_id     => access_key_id,
+            :aws_secret_access_key => secret_access_key,
+            :region                => region
+          )
+        end
+
+        ##
+        # Creates a new @repository_object (bucket).
+        # Fetches it from S3 if it already exists,
+        # otherwise it will create it first and fetch use that instead.
+        def repository_object
+          @repository_object ||= connection.directories.get(bucket) ||
+            connection.directories.create(:key => bucket, :location => region)
+        end
+
+        ##
+        # This is the provider that Fog uses for the Cloud Files
+        def provider
+          "AWS"
+        end
+
+      end # Class S3 < Base
+    end # module Cloud
+  end
+end

data/lib/backup/syncer/rsync/base.rb

@@ -12,11 +12,8 @@ module Backup
         # Instantiates a new RSync Syncer object
         # and sets the default configuration
         def initialize
-          load_defaults!
+          super
 
-          @path               ||= 'backups'
-          @directories          = Array.new
-          @mirror             ||= false
           @additional_options ||= Array.new
         end
 

data/lib/backup/syncer/rsync/local.rb

@@ -6,11 +6,15 @@ module Backup
       class Local < Base
 
         ##
-        # Instantiates a new RSync::Local Syncer object.
-        # Default configuration values and any specified in
-        # Backup::Configuration::Syncer::RSync::Local are set from Base.
-        # The user's configuration file is then evaluated to overwrite
-        # these values or provide additional configuration.
+        # Instantiates a new RSync::Local Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::RSync::Local
+        # are set via a super() call to RSync::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and RSync specific defaults are set,
+        # the block from the user's configuration file is evaluated.
         def initialize(&block)
           super
 

data/lib/backup/syncer/rsync/pull.rb

@@ -27,7 +27,7 @@ module Backup
         private
 
         ##
-        # Return expanded @path
+        # Return expanded @path, since this path is local
         def dest_path
           @dest_path ||= File.expand_path(@path)
         end

data/lib/backup/syncer/rsync/push.rb

@@ -22,11 +22,16 @@ module Backup
         attr_accessor :compress
 
         ##
-        # Instantiates a new RSync::Push or RSync::Pull Syncer object.
-        # Default configuration values and any specified in
-        # Backup::Configuration::Syncer::RSync::[Push/Pull] are set from Base.
-        # The user's configuration file is then evaluated to overwrite
-        # these values or provide additional configuration.
+        # Instantiates a new RSync::Push or RSync::Pull Syncer.
+        #
+        # Pre-configured defaults specified in
+        # Configuration::Syncer::RSync::Push or
+        # Configuration::Syncer::RSync::Pull
+        # are set via a super() call to RSync::Base,
+        # which in turn will invoke Syncer::Base.
+        #
+        # Once pre-configured defaults and RSync specific defaults are set,
+        # the block from the user's configuration file is evaluated.
         def initialize(&block)
           super
 

data/lib/backup/version.rb

@@ -13,7 +13,7 @@ module Backup
     #  Defines the minor version
     # PATCH:
     #  Defines the patch version
-    MAJOR, MINOR, PATCH = 3, 0, 23
+    MAJOR, MINOR, PATCH = 3, 0, 24
 
     ##
     # Returns the major version ( big release based off of multiple minor releases )

data/spec-live/.gitignore

@@ -0,0 +1,6 @@
+backups/config.yml
+backups/data
+backups/log
+backups/.cache
+backups/.tmp
+tmp/

data/spec-live/README

@@ -0,0 +1,7 @@
+== spec-live ==
+
+This folder contains "Live" specs which test various features against
+the actual filesystem and/or real storage service accounts.
+
+These are only intended to be used by developers.
+Use at your own risk :)

data/spec-live/backups/config.rb

@@ -0,0 +1,153 @@
+
+##
+# Archive Job
+archive_job = lambda do |archive|
+  archive.add     File.expand_path('../../../lib/backup', __FILE__)
+  archive.exclude File.expand_path('../../../lib/backup/storage', __FILE__)
+end
+
+##
+# Configuration
+
+Backup::Storage::Local.defaults do |storage|
+  storage.path = Backup::SpecLive::TMP_PATH
+  storage.keep = 2
+end
+
+# SSH operations can be tested against 'localhost'
+# To do this, in the config.yml file:
+# - set username/password for your current user
+# - set ip to 'localhost'
+# Although optional, it's recommended you set the 'path'
+# to the same path as Backup::SpecLive::TMP_PATH
+# i.e. '/absolute/path/to/spec-live/tmp'
+# This way, cleaning the "remote path" can be skipped.
+Backup::Storage::SCP.defaults do |storage|
+  opts = SpecLive::CONFIG['storage']['scp']
+
+  storage.username = opts['username']
+  storage.password = opts['password']
+  storage.ip       = opts['ip']
+  storage.port     = opts['port']
+  storage.path     = opts['path']
+  storage.keep     = 2
+end
+
+Backup::Storage::Dropbox.defaults do |storage|
+  opts = SpecLive::CONFIG['storage']['dropbox']
+
+  storage.api_key     = opts['api_key']
+  storage.api_secret  = opts['api_secret']
+  storage.access_type = opts['access_type']
+  storage.path        = opts['path']
+  storage.keep        = 2
+end
+
+Backup::Notifier::Mail.defaults do |notifier|
+  opts = SpecLive::CONFIG['notifier']['mail']
+
+  notifier.on_success           = true
+  notifier.on_warning           = true
+  notifier.on_failure           = true
+
+  notifier.delivery_method      = opts['delivery_method']
+  notifier.from                 = opts['from']
+  notifier.to                   = opts['to']
+  notifier.address              = opts['address']
+  notifier.port                 = opts['port'] || 587
+  notifier.domain               = opts['domain']
+  notifier.user_name            = opts['user_name']
+  notifier.password             = opts['password']
+  notifier.authentication       = opts['authentication'] || 'plain'
+  notifier.enable_starttls_auto = opts['enable_starttls_auto'] || true
+  notifier.sendmail             = opts['sendmail']
+  notifier.sendmail_args        = opts['sendmail_args']
+  notifier.mail_folder          = Backup::SpecLive::TMP_PATH
+end
+
+Backup::Syncer::Cloud::S3.defaults do |s3|
+  opts = SpecLive::CONFIG['syncer']['cloud']['s3']
+
+  s3.access_key_id     = opts['access_key_id']
+  s3.secret_access_key = opts['secret_access_key']
+  s3.bucket            = opts['bucket']
+  s3.region            = opts['region']
+  s3.mirror            = true
+end
+
+##
+# Models
+
+Backup::Model.new(:archive_local, 'test_label') do
+  archive :test_archive, &archive_job
+  store_with Local
+end
+
+Backup::Model.new(:archive_scp, 'test_label') do
+  archive :test_archive, &archive_job
+  store_with SCP
+end
+
+# To initialize the Dropbox session cache, run manually first using:
+# VERBOSE=1 rspec spec-live/storage/dropbox_spec.rb --tag init
+Backup::Model.new(:archive_dropbox, 'test_label') do
+  archive :test_archive, &archive_job
+  store_with Dropbox
+end
+
+Backup::Model.new(:compressor_gzip_archive_local, 'test_label') do
+  archive :test_archive, &archive_job
+  compress_with Gzip
+  store_with Local
+end
+
+Backup::Model.new(:compressor_custom_archive_local, 'test_label') do
+  archive :test_archive, &archive_job
+  compress_with Custom do |c|
+    c.command = 'gzip -1'
+    c.extension = '.foo'
+  end
+  store_with Local
+end
+
+Backup::Model.new(:notifier_mail, 'test_label') do
+  notify_by Mail
+end
+
+Backup::Model.new(:notifier_mail_file, 'test_label') do
+  notify_by Mail do |mail|
+    mail.to = 'test@backup'
+    mail.delivery_method = :file
+  end
+end
+
+Backup::Model.new(:syncer_cloud_s3, 'test_label') do
+  sync_with Cloud::S3 do |s3|
+    s3.directories do
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_a')
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_b')
+    end
+  end
+end
+
+Backup::Model.new(:syncer_cloud_processes_s3, 'test_label') do
+  sync_with Cloud::S3 do |s3|
+    s3.concurrency_type  = :processes
+    s3.concurrency_level = 2
+    s3.directories do
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_a')
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_b')
+    end
+  end
+end
+
+Backup::Model.new(:syncer_cloud_threads_s3, 'test_label') do
+  sync_with Cloud::S3 do |s3|
+    s3.concurrency_type  = :threads
+    s3.concurrency_level = 2
+    s3.directories do
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_a')
+      add File.join(Backup::SpecLive::SYNC_PATH, 'dir_b')
+    end
+  end
+end

data/spec-live/backups/config.yml.template

@@ -0,0 +1,43 @@
+##
+# config.yml template
+# for usage, see:
+#   spec-live/spec_helper.rb
+#   spec-live/backups/config.rb
+##
+---
+storage:
+  scp:
+    specs_enabled: false
+    username: <current user name>
+    password: <password>
+    ip: localhost
+    port: 22
+    path: /absolute/path/to/spec-live/tmp
+  dropbox:
+    specs_enabled: false
+    api_key: <your key>
+    api_secret: <your secret>
+    path:
+    timeout:
+notifier:
+  mail:
+    specs_enabled: false
+    delivery_method: smtp
+    from: <from email>
+    to: <to email>
+    address: smtp.gmail.com
+    port: 587
+    user_name: <user name>
+    password: <password>
+    authentication: plain
+    enable_starttls_auto: true
+    sendmail:
+    sendmail_args:
+syncer:
+  cloud:
+    s3:
+      specs_enabled: false
+      access_key_id:
+      secret_access_key:
+      bucket:
+      region:

data/spec-live/compressor/custom_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Compressor::Custom' do
+
+  def archive_file_for(model)
+    File.join(
+      Backup::SpecLive::TMP_PATH,
+      "#{model.trigger}", model.time, "#{model.trigger}.tar"
+    )
+  end
+
+  def archive_contents_for(model)
+    archive_file = archive_file_for(model)
+    %x{ tar -tvf #{archive_file} }
+  end
+
+  it 'should compress an archive' do
+    model = h_set_trigger('compressor_custom_archive_local')
+    model.perform!
+    archive_file = archive_file_for(model)
+    File.exist?(archive_file).should be_true
+    archive_contents_for(model).should match(
+      /compressor_custom_archive_local\/archives\/test_archive\.tar\.foo/
+    )
+    File.stat(archive_file).size.should be > 0
+  end
+
+end

data/spec-live/compressor/gzip_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Compressor::Gzip' do
+
+  def archive_file_for(model)
+    File.join(
+      Backup::SpecLive::TMP_PATH,
+      "#{model.trigger}", model.time, "#{model.trigger}.tar"
+    )
+  end
+
+  def archive_contents_for(model)
+    archive_file = archive_file_for(model)
+    %x{ tar -tvf #{archive_file} }
+  end
+
+  it 'should compress an archive' do
+    model = h_set_trigger('compressor_gzip_archive_local')
+    model.perform!
+    archive_file = archive_file_for(model)
+    File.exist?(archive_file).should be_true
+    archive_contents_for(model).should match(
+      /compressor_gzip_archive_local\/archives\/test_archive\.tar\.gz/
+    )
+    File.stat(archive_file).size.should be > 0
+  end
+
+end

data/spec-live/notifier/mail_spec.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe 'Notifier::Mail',
+    :if => Backup::SpecLive::CONFIG['notifier']['mail']['specs_enabled'] do
+  describe 'Notifier::Mail :smtp' do
+    let(:trigger) { 'notifier_mail' }
+
+    it 'should send a success email' do
+      model = h_set_trigger(trigger)
+      expect do
+        model.perform!
+      end.not_to raise_error
+    end
+
+    it 'should send a warning email' do
+      model = h_set_trigger(trigger)
+      Backup::Logger.warn 'You have been warned!'
+      expect do
+        model.perform!
+      end.not_to raise_error
+    end
+
+    it 'should send a failure email for non-fatal errors' do
+      model = h_set_trigger(trigger)
+      model.stubs(:databases).raises('A successful failure?')
+      expect do
+        model.perform!
+      end.not_to raise_error
+    end
+
+    it 'should send a failure email fatal errors' do
+      model = h_set_trigger(trigger)
+      model.stubs(:databases).raises(NoMemoryError, 'with increasing frequency...')
+      expect do
+        model.perform!
+      end.to raise_error
+    end
+  end # describe 'Notifier::Mail :smtp'
+
+  describe 'Notifier::Mail :file' do
+    let(:trigger) { 'notifier_mail_file' }
+    let(:test_email) { File.join(Backup::SpecLive::TMP_PATH, 'test@backup') }
+
+    it 'should send a success email' do
+      model = h_set_trigger(trigger)
+      expect do
+        model.perform!
+      end.not_to raise_error
+      File.exist?(test_email).should be_true
+      File.read(test_email).should match(/without any errors/)
+    end
+
+    it 'should send a warning email' do
+      model = h_set_trigger(trigger)
+      Backup::Logger.warn 'You have been warned!'
+      expect do
+        model.perform!
+      end.not_to raise_error
+      File.exist?(test_email).should be_true
+      File.read(test_email).should match(/You have been warned/)
+    end
+
+    it 'should send a failure email for non-fatal errors' do
+      model = h_set_trigger(trigger)
+      model.stubs(:databases).raises('A successful failure?')
+      expect do
+        model.perform!
+      end.not_to raise_error
+      File.exist?(test_email).should be_true
+      File.read(test_email).should match(/successful failure/)
+    end
+
+    it 'should send a failure email fatal errors' do
+      model = h_set_trigger(trigger)
+      model.stubs(:databases).raises(NoMemoryError, 'with increasing frequency...')
+      expect do
+        model.perform!
+      end.to raise_error
+      File.exist?(test_email).should be_true
+      File.read(test_email).should match(/with increasing frequency/)
+    end
+  end # describe 'Notifier::Mail :file'
+end