backup 3.0.23 → 3.0.24

data/spec/cli/utility_spec.rb

@@ -86,6 +86,10 @@ describe 'Backup::CLI::Utility' do
       FileUtils.unstub(:touch)
     end
 
+    after do
+      Backup::Config.send(:reset!)
+    end
+
     context 'when given a config_path' do
       context 'when no config file exists' do
         it 'should create both a config and a model under the given path' do
@@ -190,8 +194,8 @@ describe 'Backup::CLI::Utility' do
           [--storages=STORAGES]        # (cloud_files, dropbox, ftp, local, ninefold, rsync, s3, scp, sftp)
           [--syncers=SYNCERS]          # (cloud_files, rsync_local, rsync_pull, rsync_push, s3)
           [--encryptors=ENCRYPTORS]    # (gpg, openssl)
-          [--compressors=COMPRESSORS]  # (bzip2, gzip, lzma, pbzip2)
-          [--notifiers=NOTIFIERS]      # (campfire, hipchat, mail, presently, prowl, twitter)
+          [--compressors=COMPRESSORS]  # (bzip2, custom, gzip, lzma, pbzip2)
+          [--notifiers=NOTIFIERS]      # (campfire, hipchat, mail, prowl, twitter)
           [--archives]
           [--splitter]                 # use `--no-splitter` to disable
                                       # Default: true
@@ -213,7 +217,7 @@ describe 'Backup::CLI::Utility' do
 
       output_lines.sort.should == expected_lines.sort
     end
-  end
+  end # describe '#generate:model'
 
   describe '#generate:config' do
     before do
@@ -221,6 +225,10 @@ describe 'Backup::CLI::Utility' do
       FileUtils.unstub(:touch)
     end
 
+    after do
+      Backup::Config.send(:reset!)
+    end
+
     context 'when given a config_path' do
       it 'should create a config file in the given path' do
         Dir.mktmpdir do |path|

data/spec/compressor/base_spec.rb

@@ -3,29 +3,50 @@
 require File.expand_path('../../spec_helper.rb', __FILE__)
 
 describe Backup::Compressor::Base do
-  let(:base) { Backup::Compressor::Base.new }
+  let(:compressor) { Backup::Compressor::Base.new }
 
-  describe '#initialize' do
-    it 'should load defaults' do
-      Backup::Compressor::Base.any_instance.expects(:load_defaults!)
-      base
+  it 'should include CLI::Helpers' do
+    Backup::Compressor::Base.
+      include?(Backup::CLI::Helpers).should be_true
+  end
+
+  it 'should include Configuration::Helpers' do
+    Backup::Compressor::Base.
+      include?(Backup::Configuration::Helpers).should be_true
+  end
+
+  describe '#compress_with' do
+    it 'should yield the compressor command and extension' do
+      compressor.instance_variable_set(:@cmd, 'compressor command')
+      compressor.instance_variable_set(:@ext, 'compressor extension')
+
+      compressor.expects(:log!)
+
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'compressor command'
+        ext.should == 'compressor extension'
+      end
     end
   end
 
   describe '#compressor_name' do
     it 'should return class name with Backup namespace removed' do
-      base.send(:compressor_name).should == 'Compressor::Base'
+      compressor.send(:compressor_name).should == 'Compressor::Base'
     end
   end
 
   describe '#log!' do
     it 'should log a message' do
-      base.expects(:compressor_name).returns('Compressor Name')
+      compressor.instance_variable_set(:@cmd, 'compressor command')
+      compressor.instance_variable_set(:@ext, 'compressor extension')
+      compressor.expects(:compressor_name).returns('Compressor Name')
+
       Backup::Logger.expects(:message).with(
-        'Using Compressor Name for compression.'
+        "Using Compressor Name for compression.\n" +
+        "  Command: 'compressor command'\n" +
+        "  Ext: 'compressor extension'"
       )
-      base.send(:log!)
+      compressor.send(:log!)
     end
   end
-
 end

data/spec/compressor/bzip2_spec.rb

@@ -3,81 +3,236 @@
 require File.expand_path('../../spec_helper.rb', __FILE__)
 
 describe Backup::Compressor::Bzip2 do
-  let(:compressor) { Backup::Compressor::Bzip2.new }
+  before do
+    Backup::Compressor::Bzip2.any_instance.stubs(:utility).returns('bzip2')
+  end
 
-  describe 'setting configuration defaults' do
-    after { Backup::Configuration::Compressor::Bzip2.clear_defaults! }
+  it 'should be a subclass of Compressor::Base' do
+    Backup::Compressor::Bzip2.
+      superclass.should == Backup::Compressor::Base
+  end
 
-    it 'uses and overrides configuration defaults' do
-      Backup::Configuration::Compressor::Bzip2.best.should be_false
-      Backup::Configuration::Compressor::Bzip2.fast.should be_false
+  describe '#initialize' do
+    let(:compressor) { Backup::Compressor::Bzip2.new }
 
-      compressor = Backup::Compressor::Bzip2.new
-      compressor.best.should be_false
-      compressor.fast.should be_false
+    after { Backup::Compressor::Bzip2.clear_defaults! }
 
-      Backup::Configuration::Compressor::Bzip2.defaults do |c|
-        c.best = true
-        c.fast = true
+    it 'should load pre-configured defaults' do
+      Backup::Compressor::Bzip2.any_instance.expects(:load_defaults!)
+      compressor
+    end
+
+    context 'when no pre-configured defaults have been set' do
+      it 'should use default values' do
+        compressor.level.should be_false
+
+        compressor.instance_variable_get(:@cmd).should == 'bzip2'
+        compressor.instance_variable_get(:@ext).should == '.bz2'
       end
-      Backup::Configuration::Compressor::Bzip2.best.should be_true
-      Backup::Configuration::Compressor::Bzip2.fast.should be_true
 
-      compressor = Backup::Compressor::Bzip2.new
-      compressor.best.should be_true
-      compressor.fast.should be_true
+      it 'should use the values given' do
+        compressor = Backup::Compressor::Bzip2.new do |c|
+          c.level = 5
+        end
+        compressor.level.should == 5
 
-      compressor = Backup::Compressor::Bzip2.new do |c|
-        c.best = false
+        compressor.instance_variable_get(:@cmd).should == 'bzip2 -5'
+        compressor.instance_variable_get(:@ext).should == '.bz2'
       end
-      compressor.best.should be_false
-      compressor.fast.should be_true
+    end # context 'when no pre-configured defaults have been set'
 
-      compressor = Backup::Compressor::Bzip2.new do |c|
-        c.fast = false
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Compressor::Bzip2.defaults do |c|
+          c.level = 7
+        end
       end
-      compressor.best.should be_true
-      compressor.fast.should be_false
-    end
-  end # describe 'setting configuration defaults'
 
-  describe '#compress_with' do
-    before do
-      compressor.expects(:log!)
-      compressor.expects(:utility).with(:bzip2).returns('bzip2')
-    end
+      it 'should use pre-configured defaults' do
+        compressor.level.should == 7
 
-    it 'should yield with the --best option' do
-      compressor.best = true
-      compressor.compress_with do |cmd, ext|
-        cmd.should == 'bzip2 --best'
-        ext.should == '.bz2'
+        compressor.instance_variable_get(:@cmd).should == 'bzip2 -7'
+        compressor.instance_variable_get(:@ext).should == '.bz2'
       end
-    end
 
-    it 'should yield with the --fast option' do
-      compressor.fast = true
-      compressor.compress_with do |cmd, ext|
-        cmd.should == 'bzip2 --fast'
-        ext.should == '.bz2'
+      it 'should override pre-configured defaults' do
+        compressor = Backup::Compressor::Bzip2.new do |c|
+          c.level = 6
+        end
+        compressor.level.should == 6
+
+        compressor.instance_variable_get(:@cmd).should == 'bzip2 -6'
+        compressor.instance_variable_get(:@ext).should == '.bz2'
       end
-    end
+    end # context 'when pre-configured defaults have been set'
+  end # describe '#initialize'
+
+  describe 'deprecations' do
+    describe 'fast and best options' do
+      context 'when only the fast option is used' do
+        before do
+          Backup::Logger.expects(:warn).with(
+            instance_of(Backup::Errors::ConfigurationError)
+          )
+        end
 
-    it 'should yield with the --best and --fast options' do
-      compressor.best = true
-      compressor.fast = true
-      compressor.compress_with do |cmd, ext|
-        cmd.should == 'bzip2 --best --fast'
-        ext.should == '.bz2'
+        context 'when set to true' do
+          it 'should log a warning and set `level` to 1' do
+            Backup::Logger.expects(:warn).with(
+              "Backup::Compressor::Bzip2.level is being set to '1'"
+            )
+            compressor = Backup::Compressor::Bzip2.new do |c|
+              c.fast = true
+            end
+            compressor.level.should be(1)
+          end
+        end
+
+        context 'when set to false' do
+          it 'should only log a warning' do
+            compressor = Backup::Compressor::Bzip2.new do |c|
+              c.fast = false
+            end
+            compressor.level.should be_false
+          end
+        end
       end
-    end
 
-    it 'should yield with no options' do
-      compressor.compress_with do |cmd, ext|
-        cmd.should == 'bzip2'
-        ext.should == '.bz2'
+      context 'when only the best option is used' do
+        before do
+          Backup::Logger.expects(:warn).with(
+            instance_of(Backup::Errors::ConfigurationError)
+          )
+        end
+
+        context 'when set to true' do
+          it 'should log a warning and set `level` to 1' do
+            Backup::Logger.expects(:warn).with(
+              "Backup::Compressor::Bzip2.level is being set to '9'"
+            )
+            compressor = Backup::Compressor::Bzip2.new do |c|
+              c.best = true
+            end
+            compressor.level.should be(9)
+          end
+        end
+
+        context 'when set to false' do
+          it 'should only log a warning' do
+            compressor = Backup::Compressor::Bzip2.new do |c|
+              c.best = false
+            end
+            compressor.level.should be_false
+          end
+        end
+
       end
-    end
-  end # describe '#compress_with'
 
+      context 'when both fast and best options are used' do
+        before do
+          Backup::Logger.expects(:warn).twice.with(
+            instance_of(Backup::Errors::ConfigurationError)
+          )
+        end
+
+        context 'when both are set true' do
+          context 'when fast is set first' do
+            it 'should cause the best option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '1'"
+              )
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '9'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.fast = true
+                c.best = true
+              end
+              compressor.level.should == 9
+            end
+          end
+
+          context 'when best is set first' do
+            it 'should cause the fast option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '1'"
+              )
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '9'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.best = true
+                c.fast = true
+              end
+              compressor.level.should == 1
+            end
+          end
+        end
+
+        context 'when only one is set true' do
+          context 'when fast is set true before best' do
+            it 'should cause the fast option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '1'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.fast = true
+                c.best = false
+              end
+              compressor.level.should == 1
+            end
+          end
+
+          context 'when fast is set true after best' do
+            it 'should cause the fast option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '1'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.best = false
+                c.fast = true
+              end
+              compressor.level.should == 1
+            end
+          end
+
+          context 'when best is set true before fast' do
+            it 'should cause the best option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '9'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.best = true
+                c.fast = false
+              end
+              compressor.level.should == 9
+            end
+          end
+
+          context 'when best is set true after fast' do
+            it 'should cause the best option to be set' do
+              Backup::Logger.expects(:warn).with(
+                "Backup::Compressor::Bzip2.level is being set to '9'"
+              )
+              compressor = Backup::Compressor::Bzip2.new do |c|
+                c.fast = false
+                c.best = true
+              end
+              compressor.level.should == 9
+            end
+          end
+        end
+
+        context 'when both are set false' do
+          it 'should only issue the two warnings' do
+            compressor = Backup::Compressor::Bzip2.new do |c|
+              c.fast = false
+              c.best = false
+            end
+            compressor.level.should be_false
+          end
+        end
+      end
+    end # describe 'fast and best options'
+  end # describe 'deprecations'
 end

data/spec/compressor/custom_spec.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+
+describe Backup::Compressor::Custom do
+  let(:compressor) { Backup::Compressor::Custom.new }
+
+  before(:all) do
+    # CLI::Helpers#utility will raise an error
+    # if the command is invalid or not set
+    Backup::Compressor::Custom.send(
+      :define_method, :utility,
+      lambda {|arg| arg.to_s.empty? ? 'error' : "/path/to/#{ arg }" }
+    )
+  end
+
+  it 'should be a subclass of Compressor::Base' do
+    Backup::Compressor::Custom.
+      superclass.should == Backup::Compressor::Base
+  end
+
+  describe '#initialize' do
+    let(:compressor) { Backup::Compressor::Custom.new }
+
+    after { Backup::Compressor::Custom.clear_defaults! }
+
+    it 'should load pre-configured defaults' do
+      Backup::Compressor::Custom.any_instance.expects(:load_defaults!)
+      compressor
+    end
+
+    it 'should call CLI::Helpers#utility to validate command' do
+      Backup::Compressor::Custom.any_instance.expects(:utility)
+      compressor
+    end
+
+    it 'should clean the command and extension for use with compress_with' do
+      compressor = Backup::Compressor::Custom.new do |c|
+        c.command   = ' my_command --option foo '
+        c.extension = ' my_extension '
+      end
+
+      compressor.command.should   == ' my_command --option foo '
+      compressor.extension.should == ' my_extension '
+
+      compressor.expects(:log!)
+      compressor.compress_with do |cmd, ext|
+        cmd.should == '/path/to/my_command --option foo'
+        ext.should == 'my_extension'
+      end
+    end
+
+    context 'when no pre-configured defaults have been set' do
+      it 'should use default values' do
+        compressor.command.should   be_nil
+        compressor.extension.should be_nil
+
+        compressor.instance_variable_get(:@cmd).should == 'error'
+        compressor.instance_variable_get(:@ext).should == ''
+      end
+
+      it 'should use the values given' do
+        compressor = Backup::Compressor::Custom.new do |c|
+          c.command   = 'my_command'
+          c.extension = 'my_extension'
+        end
+
+        compressor.command.should   == 'my_command'
+        compressor.extension.should == 'my_extension'
+
+        compressor.instance_variable_get(:@cmd).should == '/path/to/my_command'
+        compressor.instance_variable_get(:@ext).should == 'my_extension'
+      end
+    end # context 'when no pre-configured defaults have been set'
+
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Compressor::Custom.defaults do |c|
+          c.command   = 'default_command'
+          c.extension = 'default_extension'
+        end
+      end
+
+      it 'should use pre-configured defaults' do
+        compressor.command.should   == 'default_command'
+        compressor.extension.should == 'default_extension'
+
+        compressor.instance_variable_get(:@cmd).should == '/path/to/default_command'
+        compressor.instance_variable_get(:@ext).should == 'default_extension'
+      end
+
+      it 'should override pre-configured defaults' do
+        compressor = Backup::Compressor::Custom.new do |c|
+          c.command   = 'new_command'
+          c.extension = 'new_extension'
+        end
+
+        compressor.command.should   == 'new_command'
+        compressor.extension.should == 'new_extension'
+
+        compressor.instance_variable_get(:@cmd).should == '/path/to/new_command'
+        compressor.instance_variable_get(:@ext).should == 'new_extension'
+      end
+    end # context 'when pre-configured defaults have been set'
+  end # describe '#initialize'
+end