backup-agoddard 3.0.27

data/spec/storage/ftp_spec.rb

@@ -0,0 +1,271 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe Backup::Storage::FTP do
+  let(:model)   { Backup::Model.new(:test_trigger, 'test label') }
+  let(:storage) do
+    Backup::Storage::FTP.new(model) do |ftp|
+      ftp.username     = 'my_username'
+      ftp.password     = 'my_password'
+      ftp.ip           = '123.45.678.90'
+      ftp.keep         = 5
+    end
+  end
+
+  it 'should be a subclass of Storage::Base' do
+    Backup::Storage::FTP.
+      superclass.should == Backup::Storage::Base
+  end
+
+  describe '#initialize' do
+    after { Backup::Storage::FTP.clear_defaults! }
+
+    it 'should load pre-configured defaults through Base' do
+      Backup::Storage::FTP.any_instance.expects(:load_defaults!)
+      storage
+    end
+
+    it 'should pass the model reference to Base' do
+      storage.instance_variable_get(:@model).should == model
+    end
+
+    it 'should pass the storage_id to Base' do
+      storage = Backup::Storage::FTP.new(model, 'my_storage_id')
+      storage.storage_id.should == 'my_storage_id'
+    end
+
+    it 'should remove any preceeding tilde and slash from the path' do
+      storage = Backup::Storage::FTP.new(model) do |ftp|
+        ftp.path = '~/my_backups/path'
+      end
+      storage.path.should == 'my_backups/path'
+    end
+
+    context 'when no pre-configured defaults have been set' do
+      it 'should use the values given' do
+        storage.username.should     == 'my_username'
+        storage.password.should     == 'my_password'
+        storage.ip.should           == '123.45.678.90'
+        storage.port.should         == 21
+        storage.path.should         == 'backups'
+        storage.passive_mode.should == false
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 5
+      end
+
+      it 'should use default values if none are given' do
+        storage = Backup::Storage::FTP.new(model)
+
+        storage.username.should     be_nil
+        storage.password.should     be_nil
+        storage.ip.should           be_nil
+        storage.port.should         == 21
+        storage.path.should         == 'backups'
+        storage.passive_mode.should == false
+
+        storage.storage_id.should be_nil
+        storage.keep.should       be_nil
+      end
+    end # context 'when no pre-configured defaults have been set'
+
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Storage::FTP.defaults do |s|
+          s.username     = 'some_username'
+          s.password     = 'some_password'
+          s.ip           = 'some_ip'
+          s.port         = 'some_port'
+          s.path         = 'some_path'
+          s.passive_mode = 'some_passive_mode'
+          s.keep         = 'some_keep'
+        end
+      end
+
+      it 'should use pre-configured defaults' do
+        storage = Backup::Storage::FTP.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.passive_mode.should == 'some_passive_mode'
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'some_keep'
+      end
+
+      it 'should override pre-configured defaults' do
+        storage = Backup::Storage::FTP.new(model) do |s|
+          s.username     = 'new_username'
+          s.password     = 'new_password'
+          s.ip           = 'new_ip'
+          s.port         = 'new_port'
+          s.path         = 'new_path'
+          s.passive_mode = 'new_passive_mode'
+          s.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.passive_mode.should == 'new_passive_mode'
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'new_keep'
+      end
+    end # context 'when pre-configured defaults have been set'
+  end # describe '#initialize'
+
+  describe '#connection' do
+    let(:connection) { mock }
+
+    it 'should yield a connection to the remote server' do
+      Net::FTP.expects(:open).with(
+        '123.45.678.90', 'my_username', 'my_password'
+      ).yields(connection)
+
+      storage.send(:connection) do |ftp|
+        ftp.should be(connection)
+      end
+    end
+
+    it 'should set passive mode if @passive_mode is true' do
+      storage.passive_mode = true
+      Net::FTP.expects(:open).with(
+        '123.45.678.90', 'my_username', 'my_password'
+      ).yields(connection)
+      connection.expects(:passive=).with(true)
+
+      storage.send(:connection) do |ftp|
+        ftp.should be(connection)
+      end
+    end
+
+    it 'should set the Net::FTP_PORT constant' do
+      storage.port = 40
+      Net::FTP.expects(:const_defined?).with(:FTP_PORT).returns(true)
+      Net::FTP.expects(:send).with(:remove_const, :FTP_PORT)
+      Net::FTP.expects(:send).with(:const_set, :FTP_PORT, 40)
+
+      Net::FTP.expects(:open)
+      storage.send(:connection)
+    end
+
+  end # describe '#connection'
+
+  describe '#transfer!' do
+    let(:connection) { mock }
+    let(:package) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.instance_variable_set(:@package, package)
+      storage.stubs(:storage_name).returns('Storage::FTP')
+      storage.stubs(:local_path).returns('/local/path')
+      storage.stubs(:connection).yields(connection)
+    end
+
+    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
+      )
+
+      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::FTP started transferring " +
+        "'2011.12.31.11.00.02.backup.tar.enc-aa' to '123.45.678.90'."
+      )
+      connection.expects(:put).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::FTP started transferring " +
+        "'2011.12.31.11.00.02.backup.tar.enc-ab' to '123.45.678.90'."
+      )
+      connection.expects(:put).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')
+      )
+
+      storage.send(:transfer!)
+    end
+  end # describe '#transfer!'
+
+  describe '#remove!' do
+    let(:package) { mock }
+    let(:connection) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.stubs(:storage_name).returns('Storage::FTP')
+      storage.stubs(:connection).yields(connection)
+    end
+
+    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::FTP started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-aa' from '123.45.678.90'."
+      )
+      connection.expects(:delete).in_sequence(s).with(
+        File.join('remote/path', 'backup.tar.enc-aa')
+      )
+      # second yield
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Storage::FTP started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-ab' from '123.45.678.90'."
+      )
+      connection.expects(:delete).in_sequence(s).with(
+        File.join('remote/path', 'backup.tar.enc-ab')
+      )
+
+      connection.expects(:rmdir).with('remote/path').in_sequence(s)
+
+      storage.send(:remove!, package)
+    end
+  end # describe '#remove!'
+
+  describe '#create_remote_path' do
+    let(:connection)  { mock }
+    let(:remote_path) { 'backups/folder/another_folder' }
+    let(:s) { sequence '' }
+
+    context 'while properly creating remote directories one by one' do
+      it 'should rescue any FTPPermErrors and continue' do
+        connection.expects(:mkdir).in_sequence(s).
+            with("backups").raises(Net::FTPPermError)
+        connection.expects(:mkdir).in_sequence(s).
+            with("backups/folder")
+        connection.expects(:mkdir).in_sequence(s).
+            with("backups/folder/another_folder")
+
+        expect do
+          storage.send(:create_remote_path, remote_path, connection)
+        end.not_to raise_error
+      end
+    end
+  end
+
+end

data/spec/storage/local_spec.rb

@@ -0,0 +1,259 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe Backup::Storage::Local do
+  let(:model)   { Backup::Model.new(:test_trigger, 'test label') }
+  let(:storage_path) do
+    File.join(File.expand_path(ENV['HOME'] || ''), 'backups')
+  end
+  let(:storage) do
+    Backup::Storage::Local.new(model) do |local|
+      local.keep = 5
+    end
+  end
+
+  it 'should be a subclass of Storage::Base' do
+    Backup::Storage::Local.
+      superclass.should == Backup::Storage::Base
+  end
+
+  describe '#initialize' do
+    after { Backup::Storage::Local.clear_defaults! }
+
+    it 'should load pre-configured defaults through Base' do
+      Backup::Storage::Local.any_instance.expects(:load_defaults!)
+      storage
+    end
+
+    it 'should pass the model reference to Base' do
+      storage.instance_variable_get(:@model).should == model
+    end
+
+    it 'should pass the storage_id to Base' do
+      storage = Backup::Storage::Local.new(model, 'my_storage_id')
+      storage.storage_id.should == 'my_storage_id'
+    end
+
+    it 'should expand any path given' do
+      storage = Backup::Storage::Local.new(model) do |local|
+        local.path = 'my_backups/path'
+      end
+      storage.path.should == File.expand_path('my_backups/path')
+    end
+
+    context 'when no pre-configured defaults have been set' do
+      it 'should use the values given' do
+        storage.path.should == storage_path
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 5
+      end
+
+      it 'should use default values if none are given' do
+        storage = Backup::Storage::Local.new(model)
+
+        storage.path.should == storage_path
+
+        storage.storage_id.should be_nil
+        storage.keep.should       be_nil
+      end
+    end # context 'when no pre-configured defaults have been set'
+
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Storage::Local.defaults do |s|
+          s.path = 'some_path'
+          s.keep = 'some_keep'
+        end
+      end
+
+      it 'should use pre-configured defaults' do
+        storage = Backup::Storage::Local.new(model)
+
+        storage.path.should == File.expand_path('some_path')
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'some_keep'
+      end
+
+      it 'should override pre-configured defaults' do
+        storage = Backup::Storage::Local.new(model) do |s|
+          s.path = 'new_path'
+          s.keep = 'new_keep'
+        end
+
+        storage.path.should == File.expand_path('new_path')
+
+        storage.storage_id.should be_nil
+        storage.keep.should       == 'new_keep'
+      end
+    end # context 'when pre-configured defaults have been set'
+  end # describe '#initialize'
+
+  describe '#transfer!' do
+    let(:package) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.instance_variable_set(:@package, package)
+      storage.stubs(:storage_name).returns('Storage::Local')
+      storage.stubs(:local_path).returns('/local/path')
+    end
+
+    context 'when transfer_method is :mv' do
+      before { storage.stubs(:transfer_method).returns(:mv) }
+      it 'should move the package files to their destination' do
+        storage.expects(:remote_path_for).in_sequence(s).with(package).
+            returns('remote/path')
+        FileUtils.expects(:mkdir_p).in_sequence(s).with('remote/path')
+
+        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::Local started transferring " +
+          "'2011.12.31.11.00.02.backup.tar.enc-aa'."
+        )
+        FileUtils.expects(:mv).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::Local started transferring " +
+          "'2011.12.31.11.00.02.backup.tar.enc-ab'."
+        )
+        FileUtils.expects(:mv).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')
+        )
+
+        storage.send(:transfer!)
+      end
+    end # context 'when transfer_method is :mv'
+
+    context 'when transfer_method is :cp' do
+      before { storage.stubs(:transfer_method).returns(:cp) }
+      it 'should copy the package files to their destination' do
+        storage.expects(:remote_path_for).in_sequence(s).with(package).
+            returns('remote/path')
+        FileUtils.expects(:mkdir_p).in_sequence(s).with('remote/path')
+
+        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::Local started transferring " +
+          "'2011.12.31.11.00.02.backup.tar.enc-aa'."
+        )
+        FileUtils.expects(:cp).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::Local started transferring " +
+          "'2011.12.31.11.00.02.backup.tar.enc-ab'."
+        )
+        FileUtils.expects(:cp).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')
+        )
+
+        storage.send(:transfer!)
+      end
+    end # context 'when transfer_method is :cp'
+
+  end # describe '#transfer!'
+
+  describe '#remove!' do
+    let(:package) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.stubs(:storage_name).returns('Storage::Local')
+    end
+
+    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']
+      )
+      # after both yields
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Storage::Local started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-aa'.\n" +
+        "Storage::Local started removing " +
+        "'2011.12.31.11.00.02.backup.tar.enc-ab'."
+      )
+      FileUtils.expects(:rm_r).in_sequence(s).with('remote/path')
+
+      storage.send(:remove!, package)
+    end
+  end # describe '#remove!'
+
+  describe '#transfer_method' do
+    context 'when the storage is the last for the model' do
+      before do
+        model.storages << storage
+      end
+
+      it 'should return :mv' do
+        storage.send(:transfer_method).should == :mv
+        storage.instance_variable_get(:@transfer_method).should == :mv
+      end
+
+      it 'should only check once' do
+        storage.instance_variable_set(:@transfer_method, :mv)
+        model.expects(:storages).never
+        storage.send(:transfer_method).should == :mv
+      end
+    end # context 'when the storage is the last for the model'
+
+    context 'when the storage is not the last for the model' do
+      let(:package) { mock }
+
+      before do
+        model.storages << storage
+        model.storages << Backup::Storage::Local.new(model)
+
+        storage.instance_variable_set(:@package, package)
+      end
+
+      it 'should log a warning and return :cp' do
+        storage.expects(:remote_path_for).with(package).returns('remote_path')
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::Storage::Local::TransferError
+          err.message.should ==
+            "Storage::Local::TransferError: Local File Copy Warning!\n" +
+            "  The final backup file(s) for 'test label' (test_trigger)\n" +
+            "  will be *copied* to 'remote_path'\n" +
+            "  To avoid this, when using more than one Storage, the 'Local' Storage\n" +
+            "  should be added *last* so the files may be *moved* to their destination."
+        end
+
+        storage.send(:transfer_method).should == :cp
+        storage.instance_variable_get(:@transfer_method).should == :cp
+      end
+
+      it 'should only check once' do
+        storage.instance_variable_set(:@transfer_method, :cp)
+        model.expects(:storages).never
+        storage.send(:transfer_method).should == :cp
+      end
+    end # context 'when the storage is not the last for the model'
+
+  end # describe '#transfer_method'
+
+end