alg-backup 3.0.10

data/spec/storage/s3_spec.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+##
+# available S3 regions:
+# eu-west-1, us-east-1, ap-southeast-1, us-west-1
+describe Backup::Storage::S3 do
+
+  let(:s3) do
+    Backup::Storage::S3.new do |s3|
+      s3.access_key_id      = 'my_access_key_id'
+      s3.secret_access_key  = 'my_secret_access_key'
+      s3.region             = 'us-east-1'
+      s3.bucket             = 'my-bucket'
+      s3.path               = 'backups'
+      s3.keep               = 20
+    end
+  end
+
+  before do
+    Backup::Configuration::Storage::S3.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    s3.access_key_id.should      == 'my_access_key_id'
+    s3.secret_access_key.should  == 'my_secret_access_key'
+    s3.region.should             == 'us-east-1'
+    s3.bucket.should             == 'my-bucket'
+    s3.keep.should               == 20
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Storage::S3.defaults do |s3|
+      s3.access_key_id      = 'my_access_key_id'
+      s3.region             = 'us-east-1'
+    end
+
+    s3 = Backup::Storage::S3.new do |s3|
+      s3.region = 'us-west-1'
+      s3.path   = 'my/backups'
+    end
+
+    s3.access_key_id.should     == 'my_access_key_id' # not defined, uses default
+    s3.secret_access_key.should == nil                # not defined, no default
+    s3.region.should            == 'us-west-1'        # defined, overwrites default
+    s3.bucket.should            == nil                # not defined, no default
+    s3.path.should              == 'my/backups'       # overwritten from Backup::Storage::S3
+  end
+
+  describe '#connection' do
+    it 'should establish a connection to Amazon S3 using the provided credentials' do
+      Fog::Storage.expects(:new).with({
+        :provider               => 'AWS',
+        :aws_access_key_id      => 'my_access_key_id',
+        :aws_secret_access_key  => 'my_secret_access_key',
+        :region                 => 'us-east-1'
+      })
+
+      s3.send(:connection)
+    end
+  end
+
+  describe '#provider' do
+    it 'should be AWS' do
+      s3.provider == 'AWS'
+    end
+  end
+
+  describe '#transfer!' do
+    let(:connection) { mock('Fog::Storage') }
+    before do
+      Fog::Storage.stubs(:new).returns(connection)
+      Backup::Logger.stubs(:message)
+    end
+
+    it 'should transfer the provided file to the bucket' do
+      Backup::Model.new('blah', 'blah') {}
+      file = mock("Backup::Storage::S3::File")
+      File.expects(:open).with("#{File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER}")}.tar").returns(file)
+      s3.expects(:remote_file).returns("#{ Backup::TIME }.#{ Backup::TRIGGER }.tar").twice
+      connection.expects(:sync_clock)
+      connection.expects(:put_object).with('my-bucket', "backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar", file)
+      s3.send(:transfer!)
+    end
+  end
+
+  describe '#remove!' do
+    let(:connection) { mock('Fog::Storage') }
+    before do
+      Fog::Storage.stubs(:new).returns(connection)
+    end
+
+    it 'should remove the file from the bucket' do
+      s3.expects(:remote_file).returns("#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      connection.expects(:sync_clock)
+      connection.expects(:delete_object).with('my-bucket', "backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      s3.send(:remove!)
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke transfer! and cycle!' do
+      s3.expects(:transfer!)
+      s3.expects(:cycle!)
+      s3.perform!
+    end
+  end
+
+end

data/spec/storage/scp_spec.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::SCP do
+
+  let(:scp) do
+    Backup::Storage::SCP.new do |scp|
+      scp.username  = 'my_username'
+      scp.password  = 'my_password'
+      scp.ip        = '123.45.678.90'
+      scp.port      = 22
+      scp.path      = '~/backups/'
+      scp.keep      = 20
+    end
+  end
+
+  before do
+    Backup::Configuration::Storage::SCP.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    scp.username.should == 'my_username'
+    scp.password.should == 'my_password'
+    scp.ip.should       == '123.45.678.90'
+    scp.port.should     == 22
+    scp.path.should     == 'backups/'
+    scp.keep.should     == 20
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Storage::SCP.defaults do |scp|
+      scp.username = 'my_default_username'
+      scp.password = 'my_default_password'
+      scp.path     = '~/backups'
+    end
+
+    scp = Backup::Storage::SCP.new do |scp|
+      scp.password = 'my_password'
+      scp.ip       = '123.45.678.90'
+    end
+
+    scp.username.should == 'my_default_username'
+    scp.password.should == 'my_password'
+    scp.ip.should       == '123.45.678.90'
+    scp.port.should     == 22
+  end
+
+  it 'should have its own defaults' do
+    scp = Backup::Storage::SCP.new
+    scp.port.should == 22
+    scp.path.should == 'backups'
+  end
+
+  describe '#connection' do
+    it 'should establish a connection to the remote server using the provided ip address and credentials' do
+      Net::SSH.expects(:start).with('123.45.678.90', 'my_username', :password => 'my_password', :port => 22)
+      scp.send(:connection)
+    end
+  end
+
+  describe '#transfer!' do
+    let(:connection) { mock('Net::SCP') }
+
+    before do
+      Net::SSH.stubs(:start).returns(connection)
+      scp.stubs(:create_remote_directories!)
+      Backup::Logger.stubs(:message)
+    end
+
+    it 'should transfer the provided file to the path' do
+      Backup::Model.new('blah', 'blah') {}
+      file = mock("Backup::Storage::SCP::File")
+
+      scp.expects(:create_remote_directories!)
+
+      ssh_scp = mock('Net::SSH::SCP')
+      connection.expects(:scp).returns(ssh_scp)
+
+      ssh_scp.expects(:upload!).with(
+        File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar"),
+        File.join('backups/myapp', "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      )
+
+      scp.send(:transfer!)
+    end
+  end
+
+  describe '#remove!' do
+    let(:connection) { mock('Net::SCP') }
+
+    before do
+      Net::SSH.stubs(:start).returns(connection)
+    end
+
+    it 'should remove the file from the remote server path' do
+      connection.expects(:exec!).with("rm backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      scp.send(:remove!)
+    end
+  end
+
+  describe '#create_remote_directories!' do
+    let(:connection) { mock('Net::SSH') }
+
+    before do
+      Net::SSH.stubs(:start).returns(connection)
+    end
+
+    it 'should properly create remote directories one by one' do
+      scp.path = 'backups/some_other_folder/another_folder'
+
+      connection.expects(:exec!).with("mkdir 'backups'")
+      connection.expects(:exec!).with("mkdir 'backups/some_other_folder'")
+      connection.expects(:exec!).with("mkdir 'backups/some_other_folder/another_folder'")
+      connection.expects(:exec!).with("mkdir 'backups/some_other_folder/another_folder/myapp'")
+
+      scp.send(:create_remote_directories!)
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke transfer! and cycle!' do
+      scp.expects(:transfer!)
+      scp.expects(:cycle!)
+      scp.perform!
+    end
+  end
+
+end

data/spec/storage/sftp_spec.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::SFTP do
+
+  let(:sftp) do
+    Backup::Storage::SFTP.new do |sftp|
+      sftp.username  = 'my_username'
+      sftp.password  = 'my_password'
+      sftp.ip        = '123.45.678.90'
+      sftp.port      = 22
+      sftp.path      = '~/backups/'
+      sftp.keep      = 20
+    end
+  end
+
+  before do
+    Backup::Configuration::Storage::SFTP.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    sftp.username.should == 'my_username'
+    sftp.password.should == 'my_password'
+    sftp.ip.should       == '123.45.678.90'
+    sftp.port.should     == 22
+    sftp.path.should     == 'backups/'
+    sftp.keep.should     == 20
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Storage::SFTP.defaults do |sftp|
+      sftp.username = 'my_default_username'
+      sftp.password = 'my_default_password'
+      sftp.path     = '~/backups'
+    end
+
+    sftp = Backup::Storage::SFTP.new do |sftp|
+      sftp.password = 'my_password'
+      sftp.ip       = '123.45.678.90'
+    end
+
+    sftp.username.should == 'my_default_username'
+    sftp.password.should == 'my_password'
+    sftp.ip.should       == '123.45.678.90'
+    sftp.port.should     == 22
+  end
+
+  it 'should have its own defaults' do
+    sftp = Backup::Storage::SFTP.new
+    sftp.port.should == 22
+    sftp.path.should == 'backups'
+  end
+
+  describe '#connection' do
+    it 'should establish a connection to the remote server using the provided ip address and credentials' do
+      Net::SFTP.expects(:start).with('123.45.678.90', 'my_username', :password => 'my_password', :port => 22)
+      sftp.send(:connection)
+    end
+  end
+
+  describe '#transfer!' do
+    let(:connection) { mock('Fog::Storage') }
+
+    before do
+      Net::SFTP.stubs(:start).returns(connection)
+      sftp.stubs(:create_remote_directories!)
+      Backup::Logger.stubs(:message)
+    end
+
+    it 'should transfer the provided file to the path' do
+      Backup::Model.new('blah', 'blah') {}
+      file = mock("Backup::Storage::SFTP::File")
+
+      sftp.expects(:create_remote_directories!)
+      connection.expects(:upload!).with(
+        File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar"),
+        File.join('backups/myapp', "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      )
+
+      sftp.send(:transfer!)
+    end
+  end
+
+  describe '#remove!' do
+    let(:connection) { mock('Net::SFTP') }
+
+    before do
+      Net::SFTP.stubs(:start).returns(connection)
+    end
+
+    it 'should remove the file from the remote server path' do
+      connection.expects(:remove!).with("backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      sftp.send(:remove!)
+    end
+  end
+
+  describe '#create_remote_directories!' do
+    let(:connection) { mock('Net::SFTP') }
+
+    before do
+      Net::SFTP.stubs(:start).returns(connection)
+    end
+
+    it 'should properly create remote directories one by one' do
+      sftp.path = 'backups/some_other_folder/another_folder'
+
+      connection.expects(:mkdir!).with('backups')
+      connection.expects(:mkdir!).with('backups/some_other_folder')
+      connection.expects(:mkdir!).with('backups/some_other_folder/another_folder')
+      connection.expects(:mkdir!).with('backups/some_other_folder/another_folder/myapp')
+
+      sftp.send(:create_remote_directories!)
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke transfer! and cycle!' do
+      sftp.expects(:transfer!)
+      sftp.expects(:cycle!)
+      sftp.perform!
+    end
+  end
+
+end

data/spec/syncer/rsync_spec.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Syncer::RSync do
+
+  let(:rsync) do
+    Backup::Syncer::RSync.new do |rsync|
+      rsync.username  = 'my_username'
+      rsync.password  = 'my_password'
+      rsync.ip        = '123.45.678.90'
+      rsync.port      = 22
+      rsync.path      = '~/backups/'
+      rsync.mirror    = true
+      rsync.compress  = true
+      rsync.additional_options = []
+
+      rsync.directories do |directory|
+        directory.add "/some/random/directory"
+        directory.add "/another/random/directory"
+      end
+    end
+  end
+
+  before do
+    Backup::Configuration::Syncer::RSync.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    rsync.username.should == 'my_username'
+    rsync.password.should == 'my_password'
+    rsync.ip.should       == '123.45.678.90'
+    rsync.port.should     == "--port='22'"
+    rsync.path.should     == 'backups/'
+    rsync.mirror.should   == "--delete"
+    rsync.compress.should == "--compress"
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Syncer::RSync.defaults do |rsync|
+      rsync.username = 'my_default_username'
+      rsync.password = 'my_default_password'
+      rsync.path     = '~/backups'
+      rsync.mirror   = false
+    end
+
+    rsync = Backup::Syncer::RSync.new do |rsync|
+      rsync.password = 'my_password'
+      rsync.ip       = '123.45.678.90'
+      rsync.compress = false
+    end
+
+    rsync.username.should == 'my_default_username'
+    rsync.password.should == 'my_password'
+    rsync.ip.should       == '123.45.678.90'
+    rsync.port.should     == "--port='22'"
+    rsync.mirror.should   == nil
+    rsync.compress.should == nil
+  end
+
+  it 'should have its own defaults' do
+    rsync = Backup::Syncer::RSync.new
+    rsync.port.should     == "--port='22'"
+    rsync.path.should     == 'backups'
+    rsync.compress.should == nil
+    rsync.mirror.should   == nil
+    rsync.directories.should  == ''
+    rsync.additional_options.should == []
+  end
+
+  describe '#mirror' do
+    context 'when true' do
+      it do
+        rsync.mirror = true
+        rsync.mirror.should == '--delete'
+      end
+    end
+
+    context 'when nil/false' do
+      it do
+        rsync.mirror = nil
+        rsync.mirror.should == nil
+      end
+
+      it do
+        rsync.mirror = false
+        rsync.mirror.should == nil
+      end
+    end
+  end
+
+  describe '#compress' do
+    context 'when true' do
+      it do
+        rsync.compress = true
+        rsync.compress.should == '--compress'
+      end
+    end
+
+    context 'when nil/false' do
+      it do
+        rsync.compress = nil
+        rsync.compress.should == nil
+      end
+
+      it do
+        rsync.compress = false
+        rsync.compress.should == nil
+      end
+    end
+  end
+
+  describe '#archive' do
+    it do
+      rsync.archive.should == '--archive'
+    end
+  end
+
+  describe '#port' do
+    it do
+      rsync.port.should == "--port='22'"
+    end
+  end
+
+  describe '#directories' do
+    context 'when its empty' do
+      it do
+        rsync.directories = []
+        rsync.directories.should == ''
+      end
+    end
+
+    context 'when it has items' do
+      it do
+        rsync.directories = ['directory1', 'directory1/directory2', 'directory1/directory2/directory3']
+        rsync.directories.should == "'directory1' 'directory1/directory2' 'directory1/directory2/directory3'"
+      end
+    end
+  end
+
+  describe '#options' do
+    it do
+      rsync.options.should == "--archive --delete --compress --port='22'"
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke the rsync command to transfer the files and directories' do
+      Backup::Logger.expects(:message).with("Backup::Syncer::RSync started syncing '/some/random/directory' '/another/random/directory'.")
+      rsync.expects(:utility).with(:rsync).returns(:rsync)
+      rsync.expects(:run).with("rsync -vhP --archive --delete --compress --port='22' '/some/random/directory' '/another/random/directory' 'my_username@123.45.678.90:backups/'")
+      rsync.perform!
+    end
+  end
+
+end