backup 3.0.3.build.0 → 3.0.3

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Load Backup
+require File.expand_path( '../../lib/backup', __FILE__ )
+
+##
+# Use Mocha to mock with RSpec
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+# FIXTURES_PATH = File.join( File.dirname(__FILE__), 'fixtures' )
+
+Backup.send(:remove_const, :TRIGGER) if defined? Backup::TRIGGER
+Backup.send(:remove_const, :TIME) if defined? Backup::TIME
+
+module Backup
+  TRIGGER = 'myapp'
+  TIME = Time.now.strftime("%Y.%m.%d.%H.%M.%S")
+end

data/spec/storage/base_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::Base do
+  let(:base) { Backup::Storage::Base.new }
+
+  before do
+    Backup::Logger.stubs(:message)
+  end
+
+  it do
+    storage_object = mock
+    Backup::Storage::Object.expects(:new).with('Base').returns(storage_object)
+    storage_object.stubs(:load).returns([])
+    storage_object.expects(:write)
+    base.keep = 1
+    base.cycle!
+  end
+
+  it do
+    base.keep = 3
+    storage_object = mock
+    objects = %w[1 2 3 4].map { Backup::Storage::Base.new }
+
+    Backup::Storage::Object.expects(:new).with('Base').returns(storage_object)
+    storage_object.stubs(:load).returns(objects)
+    storage_object.expects(:write)
+    Backup::Storage::Base.any_instance.expects(:remove!).times(2)
+
+    base.cycle!
+  end
+end

data/spec/storage/cloudfiles_spec.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::CloudFiles do
+
+  let(:cf) do
+    Backup::Storage::CloudFiles.new do |cf|
+      cf.username  = 'my_username'
+      cf.api_key   = 'my_api_key'
+      cf.container = 'my_container'
+      cf.path      = 'backups'
+      cf.keep      = 20
+    end
+  end
+
+  before do
+    Backup::Configuration::Storage::CloudFiles.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    cf.username.should  == 'my_username'
+    cf.api_key.should   == 'my_api_key'
+    cf.container.should == 'my_container'
+    cf.path.should      == 'backups'
+    cf.keep.should      == 20
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Storage::CloudFiles.defaults do |cf|
+      cf.username = 'my_username'
+      cf.api_key  = 'my_api_key'
+    end
+
+    cf = Backup::Storage::CloudFiles.new do |cf|
+      cf.container = 'my_container'
+      cf.path      = 'my/backups'
+    end
+
+    cf.username.should  == 'my_username'
+    cf.api_key.should   == 'my_api_key'
+    cf.container.should == 'my_container'
+    cf.path.should      == 'my/backups'
+  end
+
+  describe '#connection' do
+    it 'should establish a connection to Rackspace Cloud Files. using the provided credentials' do
+      Fog::Storage.expects(:new).with({
+        :provider           => 'Rackspace',
+        :rackspace_username => 'my_username',
+        :rackspace_api_key  => 'my_api_key'
+      })
+
+      cf.send(:connection)
+    end
+  end
+
+  describe '#provider' do
+    it 'should be Rackspace' do
+      cf.provider == 'Rackspace'
+    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 container' do
+      Backup::Model.new('blah', 'blah') {}
+      file = mock("Backup::Storage::CloudFiles::File")
+      File.expects(:open).with("#{File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER}")}.tar").returns(file)
+      cf.expects(:remote_file).returns("#{ Backup::TIME }.#{ Backup::TRIGGER }.tar").twice
+      connection.expects(:put_object).with('my_container', "backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar", file)
+      cf.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 container' do
+      cf.expects(:remote_file).returns("#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      connection.expects(:delete_object).with('my_container', "backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      cf.send(:remove!)
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke transfer! and cycle!' do
+      cf.expects(:transfer!)
+      cf.expects(:cycle!)
+      cf.perform!
+    end
+  end
+
+end

data/spec/storage/dropbox_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::Dropbox do
+
+  let(:db) do
+    Backup::Storage::Dropbox.new do |db|
+      db.email       = 'my@email.com'
+      db.password    = 'my_password'
+      db.api_key     = 'my_api_key'
+      db.api_secret  = 'my_secret'
+      db.keep        = 20
+    end
+  end
+
+  let(:connection) do
+    c = mock("Dropbox::Session")
+    db.stubs(:connection).returns(c); c
+  end
+
+  before do
+    Backup::Configuration::Storage::Dropbox.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    db.email.should       == 'my@email.com'
+    db.password.should    == 'my_password'
+    db.api_key.should     == 'my_api_key'
+    db.api_secret.should  == 'my_secret'
+    db.path.should        == 'backups'
+    db.keep.should        == 20
+  end
+
+  it 'should overwrite the default path' do
+    db = Backup::Storage::Dropbox.new do |db|
+      db.path = 'my/backups'
+    end
+
+    db.path.should == 'my/backups'
+  end
+
+  describe '#connection' do
+    it do
+      session = mock("Dropbox::Session")
+      Dropbox::Session.expects(:new).with('my_api_key', 'my_secret').returns(session)
+      session.expects(:mode=).with(:dropbox)
+      session.expects(:authorizing_user=).with('my@email.com')
+      session.expects(:authorizing_password=).with('my_password')
+      session.expects(:authorize!)
+
+      db.send(:connection)
+    end
+  end
+
+  describe '#transfer!' do
+    before do
+      Backup::Logger.stubs(:message)
+      connection.stubs(:upload)
+      connection.stubs(:delete)
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Storage::Dropbox started transferring \"#{ Backup::TIME }.#{ Backup::TRIGGER }.tar\".")
+      db.send(:transfer!)
+    end
+
+    it do
+      connection.expects(:upload).with(
+        File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar"),
+        File.join('backups', Backup::TRIGGER),
+        :timeout => 300
+      )
+
+      db.send(:transfer!)
+    end
+  end
+
+  describe '#remove!' do
+    it do
+      connection.expects(:delete).with(
+        File.join('backups', Backup::TRIGGER, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      )
+
+      db.send(:remove!)
+    end
+  end
+
+end

data/spec/storage/ftp_spec.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::FTP do
+
+  let(:ftp) do
+    Backup::Storage::FTP.new do |ftp|
+      ftp.username  = 'my_username'
+      ftp.password  = 'my_password'
+      ftp.ip        = '123.45.678.90'
+      ftp.port      = 21
+      ftp.path      = '~/backups/'
+      ftp.keep      = 20
+    end
+  end
+
+  before do
+    Backup::Configuration::Storage::FTP.clear_defaults!
+  end
+
+  it 'should have defined the configuration properly' do
+    ftp.username.should == 'my_username'
+    ftp.password.should == 'my_password'
+    ftp.ip.should       == '123.45.678.90'
+    ftp.port.should     == 21
+    ftp.path.should     == 'backups/'
+    ftp.keep.should     == 20
+  end
+
+  it 'should use the defaults if a particular attribute has not been defined' do
+    Backup::Configuration::Storage::FTP.defaults do |ftp|
+      ftp.username = 'my_default_username'
+      ftp.password = 'my_default_password'
+      ftp.path     = '~/backups'
+    end
+
+    ftp = Backup::Storage::FTP.new do |ftp|
+      ftp.password = 'my_password'
+      ftp.ip       = '123.45.678.90'
+    end
+
+    ftp.username.should == 'my_default_username'
+    ftp.password.should == 'my_password'
+    ftp.ip.should       == '123.45.678.90'
+    ftp.port.should     == 21
+  end
+
+  it 'should have its own defaults' do
+    ftp = Backup::Storage::FTP.new
+    ftp.port.should == 21
+    ftp.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::FTP.expects(:new).with('123.45.678.90', 'my_username', 'my_password')
+      ftp.send(:connection)
+    end
+
+    it 'should re-define the Net::FTP port' do
+      Net::FTP.stubs(:new)
+      ftp.port = 40
+      ftp.send(:connection)
+      Net::FTP::FTP_PORT.should == 40
+    end
+  end
+
+  describe '#transfer!' do
+    let(:connection) { mock('Fog::Storage') }
+
+    before do
+      Net::FTP.stubs(:new).returns(connection)
+      ftp.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::FTP::File")
+
+      ftp.expects(:create_remote_directories!)
+      connection.expects(:put).with(
+        File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar"),
+        File.join('backups/myapp', "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      )
+
+      ftp.send(:transfer!)
+    end
+  end
+
+  describe '#remove!' do
+    let(:connection) { mock('Net::FTP') }
+
+    before do
+      Net::FTP.stubs(:new).returns(connection)
+    end
+
+    it 'should remove the file from the remote server path' do
+      connection.expects(:delete).with("backups/myapp/#{ Backup::TIME }.#{ Backup::TRIGGER }.tar")
+      ftp.send(:remove!)
+    end
+  end
+
+  describe '#create_remote_directories!' do
+    let(:connection) { mock('Net::FTP') }
+
+    before do
+      Net::FTP.stubs(:new).returns(connection)
+    end
+
+    it 'should properly create remote directories one by one' do
+      ftp.path = '~/backups/some_other_folder/another_folder'
+
+      connection.expects(:mkdir).with('~')
+      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')
+
+      ftp.send(:create_remote_directories!)
+    end
+  end
+
+  describe '#perform' do
+    it 'should invoke transfer! and cycle!' do
+      ftp.expects(:transfer!)
+      ftp.expects(:cycle!)
+      ftp.perform!
+    end
+  end
+
+end

data/spec/storage/object_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Storage::Object do
+  let(:object) { Backup::Storage::Object.new(:s3) }
+
+  it do
+    object.storage_file.should == File.join(Backup::DATA_PATH, Backup::TRIGGER, 's3.yml')
+  end
+
+  describe '#load' do
+    it 'should return an array with objects' do
+      File.expects(:exist?).returns(true)
+      YAML.expects(:load_file).with(
+        File.join(Backup::DATA_PATH, Backup::TRIGGER, 's3.yml')
+      ).returns(YAML.load([Backup::Storage::S3.new, Backup::Storage::S3.new].to_yaml))
+
+      objects = object.load
+      objects.should be_an(Array)
+      objects.first.should be_an_instance_of(Backup::Storage::S3)
+    end
+
+    describe 'loading them sorted by time descending (newest backup is first in the array)' do
+      it do
+        obj_1 = Backup::Storage::S3.new; obj_1.time = '2007.00.00.00.00.00'
+        obj_2 = Backup::Storage::S3.new; obj_2.time = '2009.00.00.00.00.00'
+        obj_3 = Backup::Storage::S3.new; obj_3.time = '2011.00.00.00.00.00'
+
+        File.expects(:exist?).returns(true)
+        YAML.expects(:load_file).with(
+          File.join(Backup::DATA_PATH, Backup::TRIGGER, 's3.yml')
+        ).returns(YAML.load([obj_1, obj_2, obj_3].to_yaml))
+
+        objects = object.load
+        objects[0].time.should == '2011.00.00.00.00.00'
+        objects[1].time.should == '2009.00.00.00.00.00'
+        objects[2].time.should == '2007.00.00.00.00.00'
+      end
+
+      it do
+        obj_3 = Backup::Storage::S3.new; obj_3.time = '2007.00.00.00.00.00'
+        obj_2 = Backup::Storage::S3.new; obj_2.time = '2009.00.00.00.00.00'
+        obj_1 = Backup::Storage::S3.new; obj_1.time = '2011.00.00.00.00.00'
+
+        File.expects(:exist?).returns(true)
+        YAML.expects(:load_file).with(
+          File.join(Backup::DATA_PATH, Backup::TRIGGER, 's3.yml')
+        ).returns(YAML.load([obj_1, obj_2, obj_3].to_yaml))
+
+        objects = object.load
+        objects[0].time.should == '2011.00.00.00.00.00'
+        objects[1].time.should == '2009.00.00.00.00.00'
+        objects[2].time.should == '2007.00.00.00.00.00'
+      end
+
+      it do
+        obj_3 = Backup::Storage::S3.new; obj_3.time = '2007.00.00.00.00.00'
+        obj_1 = Backup::Storage::S3.new; obj_1.time = '2009.00.00.00.00.00'
+        obj_2 = Backup::Storage::S3.new; obj_2.time = '2011.00.00.00.00.00'
+
+        File.expects(:exist?).returns(true)
+        YAML.expects(:load_file).with(
+          File.join(Backup::DATA_PATH, Backup::TRIGGER, 's3.yml')
+        ).returns(YAML.load([obj_1, obj_2, obj_3].to_yaml))
+
+        objects = object.load
+        objects[0].time.should == '2011.00.00.00.00.00'
+        objects[1].time.should == '2009.00.00.00.00.00'
+        objects[2].time.should == '2007.00.00.00.00.00'
+      end
+    end
+  end
+end