backup 3.0.20 → 3.0.21

data/spec/storage/sftp_spec.rb

@@ -3,197 +3,215 @@
 require File.expand_path('../../spec_helper.rb', __FILE__)
 
 describe Backup::Storage::SFTP do
-
-  let(:sftp) do
-    Backup::Storage::SFTP.new do |sftp|
+  let(:model)   { Backup::Model.new(:test_trigger, 'test label') }
+  let(:storage) do
+    Backup::Storage::SFTP.new(model) 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
+      sftp.keep      = 5
     end
   end
 
-  before do
-    Backup::Configuration::Storage::SFTP.clear_defaults!
-  end
+  describe '#initialize' do
+    it 'should set the correct values' do
+      storage.username.should == 'my_username'
+      storage.password.should == 'my_password'
+      storage.ip.should       == '123.45.678.90'
+      storage.port.should     == 22
+      storage.path.should     == 'backups'
 
-  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
+      storage.storage_id.should be_nil
+      storage.keep.should       == 5
+    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'
+    it 'should set a storage_id if given' do
+      sftp = Backup::Storage::SFTP.new(model, 'my storage_id')
+      sftp.storage_id.should == 'my storage_id'
     end
 
-    sftp = Backup::Storage::SFTP.new do |sftp|
-      sftp.password = 'my_password'
-      sftp.ip       = '123.45.678.90'
+    it 'should remove any preceeding tilde and slash from the path' do
+      storage = Backup::Storage::SFTP.new(model) do |sftp|
+        sftp.path = '~/my_backups/path'
+      end
+      storage.path.should == 'my_backups/path'
     end
 
-    sftp.username.should == 'my_default_username'
-    sftp.password.should == 'my_password'
-    sftp.ip.should       == '123.45.678.90'
-    sftp.port.should     == 22
-  end
+    context 'when setting configuration defaults' do
+      after { Backup::Configuration::Storage::SFTP.clear_defaults! }
+
+      it 'should use the configured defaults' do
+        Backup::Configuration::Storage::SFTP.defaults do |sftp|
+          sftp.username  = 'some_username'
+          sftp.password  = 'some_password'
+          sftp.ip        = 'some_ip'
+          sftp.port      = 'some_port'
+          sftp.path      = 'some_path'
+          sftp.keep      = 'some_keep'
+        end
+        storage = Backup::Storage::SFTP.new(model)
+        storage.username.should == 'some_username'
+        storage.password.should == 'some_password'
+        storage.ip.should       == 'some_ip'
+        storage.port.should     == 'some_port'
+        storage.path.should     == 'some_path'
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'some_keep'
+      end
 
-  it 'should have its own defaults' do
-    sftp = Backup::Storage::SFTP.new
-    sftp.port.should == 22
-    sftp.path.should == 'backups'
-  end
+      it 'should override the configured defaults' do
+        Backup::Configuration::Storage::SFTP.defaults do |sftp|
+          sftp.username  = 'old_username'
+          sftp.password  = 'old_password'
+          sftp.ip        = 'old_ip'
+          sftp.port      = 'old_port'
+          sftp.path      = 'old_path'
+          sftp.keep      = 'old_keep'
+        end
+        storage = Backup::Storage::SFTP.new(model) do |sftp|
+          sftp.username  = 'new_username'
+          sftp.password  = 'new_password'
+          sftp.ip        = 'new_ip'
+          sftp.port      = 'new_port'
+          sftp.path      = 'new_path'
+          sftp.keep      = 'new_keep'
+        end
+
+        storage.username.should == 'new_username'
+        storage.password.should == 'new_password'
+        storage.ip.should       == 'new_ip'
+        storage.port.should     == 'new_port'
+        storage.path.should     == 'new_path'
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'new_keep'
+      end
+    end # context 'when setting configuration defaults'
 
-  describe '#perform' do
-    it 'should invoke transfer! and cycle!' do
-      sftp.expects(:transfer!)
-      sftp.expects(:cycle!)
-      sftp.perform!
-    end
-  end
+  end # describe '#initialize'
 
   describe '#connection' do
-    it 'should establish a connection to the remote server' do
-      connection = mock
+    let(:connection) { mock }
+
+    it 'should yield a connection to the remote server' do
       Net::SFTP.expects(:start).with(
-        '123.45.678.90',
-        'my_username',
-        :password  => 'my_password',
-        :port      => 22
+        '123.45.678.90', 'my_username', :password => 'my_password', :port => 22
       ).yields(connection)
 
-      sftp.send(:connection) do |conn|
-        conn.should be connection
+      storage.send(:connection) do |sftp|
+        sftp.should be(connection)
       end
     end
-  end # describe '#connection'
+  end
 
   describe '#transfer!' do
     let(:connection) { mock }
+    let(:package) { mock }
+    let(:s) { sequence '' }
 
     before do
-      sftp.stubs(:storage_name).returns('Storage::SFTP')
+      storage.instance_variable_set(:@package, package)
+      storage.stubs(:storage_name).returns('Storage::SFTP')
+      storage.stubs(:local_path).returns('/local/path')
+      storage.stubs(:connection).yields(connection)
     end
 
-    context 'when file chunking is not used' do
-      it 'should create remote paths and transfer using a single connection' do
-        local_file  = "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar"
-        remote_file = "#{ Backup::TRIGGER }.tar"
-
-        sftp.expects(:connection).yields(connection)
-        sftp.expects(:create_remote_directories).with(connection)
-
-        Backup::Logger.expects(:message).with(
-          "Storage::SFTP started transferring '#{local_file}' to '#{sftp.ip}'."
-        )
-
-        connection.expects(:upload!).with(
-          File.join(Backup::TMP_PATH, local_file),
-          File.join('backups/myapp', Backup::TIME, remote_file)
-        )
+    it 'should transfer the package files' do
+      storage.expects(:remote_path_for).in_sequence(s).with(package).
+          returns('remote/path')
+      storage.expects(:create_remote_path).in_sequence(s).with(
+        'remote/path', connection
+      )
 
-        sftp.send(:transfer!)
-      end
-    end
+      storage.expects(:files_to_transfer_for).in_sequence(s).with(package).
+        multiple_yields(
+        ['2011.12.31.11.00.02.backup.tar.enc-aa', 'backup.tar.enc-aa'],
+        ['2011.12.31.11.00.02.backup.tar.enc-ab', 'backup.tar.enc-ab']
+      )
+      # first yield
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Storage::SFTP started transferring " +
+        "'2011.12.31.11.00.02.backup.tar.enc-aa' to '123.45.678.90'."
+      )
+      connection.expects(:upload!).in_sequence(s).with(
+        File.join('/local/path', '2011.12.31.11.00.02.backup.tar.enc-aa'),
+        File.join('remote/path', 'backup.tar.enc-aa')
+      )
+      # second yield
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Storage::SFTP started transferring " +
+        "'2011.12.31.11.00.02.backup.tar.enc-ab' to '123.45.678.90'."
+      )
+      connection.expects(:upload!).in_sequence(s).with(
+        File.join('/local/path', '2011.12.31.11.00.02.backup.tar.enc-ab'),
+        File.join('remote/path', 'backup.tar.enc-ab')
+      )
 
-    context 'when file chunking is used' do
-      it 'should transfer all the provided files using a single connection' do
-        s = sequence ''
-
-        sftp.expects(:connection).in_sequence(s).yields(connection)
-        sftp.expects(:create_remote_directories).in_sequence(s).with(connection)
-
-        sftp.expects(:files_to_transfer).in_sequence(s).multiple_yields(
-          ['local_file1', 'remote_file1'], ['local_file2', 'remote_file2']
-        )
-
-        Backup::Logger.expects(:message).in_sequence(s).with(
-          "Storage::SFTP started transferring 'local_file1' to '#{sftp.ip}'."
-        )
-        connection.expects(:upload!).in_sequence(s).with(
-          File.join(Backup::TMP_PATH, 'local_file1'),
-          File.join('backups/myapp', Backup::TIME, 'remote_file1')
-        )
-
-        Backup::Logger.expects(:message).in_sequence(s).with(
-          "Storage::SFTP started transferring 'local_file2' to '#{sftp.ip}'."
-        )
-        connection.expects(:upload!).in_sequence(s).with(
-          File.join(Backup::TMP_PATH, 'local_file2'),
-          File.join('backups/myapp', Backup::TIME, 'remote_file2')
-        )
-
-        sftp.send(:transfer!)
-      end
+      storage.send(:transfer!)
     end
-  end # describe '#transfer'
+  end # describe '#transfer!'
 
   describe '#remove!' do
-    it 'should remove all remote files with a single FTP connection' do
-      s = sequence ''
-      connection = mock
-      remote_path = "backups/myapp/#{ Backup::TIME }"
-      sftp.stubs(:storage_name).returns('Storage::SFTP')
+    let(:package) { mock }
+    let(:connection) { mock }
+    let(:s) { sequence '' }
 
-      sftp.expects(:connection).in_sequence(s).yields(connection)
+    before do
+      storage.stubs(:storage_name).returns('Storage::SFTP')
+      storage.stubs(:connection).yields(connection)
+    end
 
-      sftp.expects(:transferred_files).in_sequence(s).multiple_yields(
-        ['local_file1', 'remote_file1'], ['local_file2', 'remote_file2']
-      )
+    it 'should remove the package files' do
+      storage.expects(:remote_path_for).in_sequence(s).with(package).
+          returns('remote/path')
 
+      storage.expects(:transferred_files_for).in_sequence(s).with(package).
+        multiple_yields(
+        ['2011.12.31.11.00.02.backup.tar.enc-aa', 'backup.tar.enc-aa'],
+        ['2011.12.31.11.00.02.backup.tar.enc-ab', 'backup.tar.enc-ab']
+      )
+      # first yield
       Backup::Logger.expects(:message).in_sequence(s).with(
-        "Storage::SFTP started removing 'local_file1' from '#{sftp.ip}'."
+        "Storage::SFTP started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-aa' from '123.45.678.90'."
       )
       connection.expects(:remove!).in_sequence(s).with(
-        File.join(remote_path, 'remote_file1')
+        File.join('remote/path', 'backup.tar.enc-aa')
       )
-
+      # second yield
       Backup::Logger.expects(:message).in_sequence(s).with(
-        "Storage::SFTP started removing 'local_file2' from '#{sftp.ip}'."
+        "Storage::SFTP started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-ab' from '123.45.678.90'."
       )
       connection.expects(:remove!).in_sequence(s).with(
-        File.join(remote_path, 'remote_file2')
+        File.join('remote/path', 'backup.tar.enc-ab')
       )
 
-      connection.expects(:rmdir!).in_sequence(s).with(remote_path)
+      connection.expects(:rmdir!).with('remote/path').in_sequence(s)
 
-      sftp.send(:remove!)
+      storage.send(:remove!, package)
     end
   end # describe '#remove!'
 
-  describe '#create_remote_directories' do
-    let(:connection) { mock }
+  describe '#create_remote_path' do
+    let(:connection)  { mock }
+    let(:remote_path) { 'backups/folder/another_folder' }
+    let(:s) { sequence '' }
+    let(:sftp_response) { stub(:code => 11, :message => nil) }
+    let(:sftp_status_exception) { Net::SFTP::StatusException.new(sftp_response) }
 
     context 'while properly creating remote directories one by one' do
-      it 'should rescue any SFTP::StatusExceptions' do
-        s = sequence ''
-        sftp.path = '~/backups/some_other_folder/another_folder'
-        sftp_response = stub(:code => 11, :message => nil)
-        sftp_status_exception = Net::SFTP::StatusException.new(sftp_response)
-
-        connection.expects(:mkdir!).in_sequence(s).
-            with("~").raises(sftp_status_exception)
-        connection.expects(:mkdir!).in_sequence(s).
-            with("~/backups").raises(sftp_status_exception)
-        connection.expects(:mkdir!).in_sequence(s).
-            with("~/backups/some_other_folder")
+      it 'should rescue any SFTP::StatusException and continue' do
         connection.expects(:mkdir!).in_sequence(s).
-            with("~/backups/some_other_folder/another_folder")
+            with("backups").raises(sftp_status_exception)
         connection.expects(:mkdir!).in_sequence(s).
-            with("~/backups/some_other_folder/another_folder/myapp")
+            with("backups/folder")
         connection.expects(:mkdir!).in_sequence(s).
-            with("~/backups/some_other_folder/another_folder/myapp/#{ Backup::TIME }")
+            with("backups/folder/another_folder")
 
         expect do
-          sftp.send(:create_remote_directories, connection)
+          storage.send(:create_remote_path, remote_path, connection)
         end.not_to raise_error
       end
     end

data/spec/syncer/base_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe Backup::Syncer::Base do
+  let(:base)    { Backup::Syncer::Base }
+  let(:syncer)  { base.new }
+
+  it 'should include CLI::Helpers' do
+    base.included_modules.should include(Backup::CLI::Helpers)
+  end
+
+  it 'should include Configuration::Helpers' do
+    base.included_modules.should include(Backup::Configuration::Helpers)
+  end
+
+  describe '#syncer_name' do
+    it 'should return the class name with the Backup:: namespace removed' do
+      syncer.send(:syncer_name).should == 'Syncer::Base'
+    end
+  end
+end

data/spec/syncer/rsync/base_spec.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+require File.expand_path('../../../spec_helper.rb', __FILE__)
+
+describe Backup::Syncer::RSync::Base do
+  let(:syncer) { Backup::Syncer::RSync::Base.new }
+
+  describe '#initialize' do
+
+    it 'should use default values' do
+      syncer.path.should               == 'backups'
+      syncer.directories.should        == []
+      syncer.mirror.should             == false
+      syncer.additional_options.should == []
+    end
+
+    context 'when setting configuration defaults' do
+      after { Backup::Configuration::Syncer::RSync::Base.clear_defaults! }
+
+      it 'should use the configured defaults' do
+        Backup::Configuration::Syncer::RSync::Base.defaults do |rsync|
+          rsync.path               = 'some_path'
+          #rsync.directories        = 'cannot_have_a_default_value'
+          rsync.mirror             = 'some_mirror'
+          rsync.additional_options = 'some_additional_options'
+        end
+        syncer = Backup::Syncer::RSync::Base.new
+        syncer.path.should               == 'some_path'
+        syncer.directories.should        == []
+        syncer.mirror.should             == 'some_mirror'
+        syncer.additional_options.should == 'some_additional_options'
+      end
+    end
+
+  end # describe '#initialize'
+
+  describe '#directories' do
+    before do
+      syncer.directories = ['/some/directory', '/another/directory']
+    end
+
+    context 'when no block is given' do
+      it 'should return @directories' do
+        syncer.directories.should ==
+            ['/some/directory', '/another/directory']
+      end
+    end
+
+    context 'when a block is given' do
+      it 'should evalute the block, allowing #add to add directories' do
+        syncer.directories do
+          add '/new/path'
+          add '/another/new/path'
+        end
+        syncer.directories.should == [
+          '/some/directory',
+          '/another/directory',
+          '/new/path',
+          '/another/new/path'
+        ]
+      end
+    end
+  end # describe '#directories'
+
+  describe '#add' do
+    before do
+      syncer.directories = ['/some/directory', '/another/directory']
+    end
+
+    it 'should add the given path to @directories' do
+      syncer.add '/my/path'
+      syncer.directories.should ==
+          ['/some/directory', '/another/directory', '/my/path']
+    end
+  end
+
+  describe '#directory_options' do
+    before do
+      syncer.directories = ['/some/directory', '/another/directory']
+    end
+
+    it 'should return the directories for use in the command line' do
+      syncer.send(:directories_option).should ==
+          "'/some/directory' '/another/directory'"
+    end
+
+    it 'should expand relative paths' do
+      syncer.directories += ['relative/path', '~/home/path']
+      syncer.send(:directories_option).should ==
+          "'/some/directory' '/another/directory' " +
+          "'#{ File.expand_path('relative/path') }' " +
+          "'#{ File.expand_path('~/home/path') }'"
+    end
+  end
+
+  describe '#mirror_option' do
+    context 'when @mirror is true' do
+      before { syncer.mirror = true }
+      it 'should return the command line flag for mirroring' do
+        syncer.send(:mirror_option).should == '--delete'
+      end
+    end
+
+    context 'when @mirror is false' do
+      before { syncer.mirror = false }
+      it 'should return nil' do
+        syncer.send(:mirror_option).should be_nil
+      end
+    end
+  end
+
+  describe '#archive_option' do
+    it 'should return the command line flag for archiving' do
+      syncer.send(:archive_option).should == '--archive'
+    end
+  end
+
+end