backup 3.0.20 → 3.0.21

data/spec/compressor/gzip_spec.rb

@@ -5,54 +5,79 @@ require File.expand_path('../../spec_helper.rb', __FILE__)
 describe Backup::Compressor::Gzip do
   let(:compressor) { Backup::Compressor::Gzip.new }
 
-  before do
-    Backup::Model.extension = 'tar'
-  end
+  describe 'setting configuration defaults' do
+    after { Backup::Configuration::Compressor::Gzip.clear_defaults! }
 
-  describe 'the options' do
-    it do
-      compressor.send(:best).should == []
-    end
+    it 'uses and overrides configuration defaults' do
+      Backup::Configuration::Compressor::Gzip.best.should be_false
+      Backup::Configuration::Compressor::Gzip.fast.should be_false
+
+      compressor = Backup::Compressor::Gzip.new
+      compressor.best.should be_false
+      compressor.fast.should be_false
+
+      Backup::Configuration::Compressor::Gzip.defaults do |c|
+        c.best = true
+        c.fast = true
+      end
+      Backup::Configuration::Compressor::Gzip.best.should be_true
+      Backup::Configuration::Compressor::Gzip.fast.should be_true
 
-    it do
-      compressor.send(:fast).should == []
+      compressor = Backup::Compressor::Gzip.new
+      compressor.best.should be_true
+      compressor.fast.should be_true
+
+      compressor = Backup::Compressor::Gzip.new do |c|
+        c.best = false
+      end
+      compressor.best.should be_false
+      compressor.fast.should be_true
+
+      compressor = Backup::Compressor::Gzip.new do |c|
+        c.fast = false
+      end
+      compressor.best.should be_true
+      compressor.fast.should be_false
     end
-  end
+  end # describe 'setting configuration defaults'
 
-  describe '#perform!' do
+  describe '#compress_with' do
     before do
-      [:run, :utility].each { |method| compressor.stubs(method) }
+      compressor.expects(:log!)
+      compressor.expects(:utility).with(:gzip).returns('gzip')
     end
 
-    it 'should perform the compression' do
-      compressor.expects(:utility).with(:gzip).returns(:gzip)
-      compressor.expects(:run).with("gzip  '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
+    it 'should yield with the --best option' do
+      compressor.best = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'gzip --best'
+        ext.should == '.gz'
+      end
     end
 
-    it 'should perform the compression with the --best and --fast options' do
-      compressor = Backup::Compressor::Gzip.new do |c|
-        c.best = true
-        c.fast = true
+    it 'should yield with the --fast option' do
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'gzip --fast'
+        ext.should == '.gz'
       end
-
-      compressor.stubs(:utility).returns(:gzip)
-      compressor.expects(:run).with("gzip --best --fast '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
     end
 
-    it 'should set the class variable @extension (Backup::Model.extension) to .gz' do
-      compressor.stubs(:utility).returns(:gzip)
-      compressor.expects(:run)
-
-      Backup::Model.extension.should == 'tar'
-      compressor.perform!
-      Backup::Model.extension.should == 'tar.gz'
+    it 'should yield with the --best and --fast options' do
+      compressor.best = true
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'gzip --best --fast'
+        ext.should == '.gz'
+      end
     end
 
-    it 'should log' do
-      Backup::Logger.expects(:message).with("Backup::Compressor::Gzip started compressing the archive.")
-      compressor.perform!
+    it 'should yield with no options' do
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'gzip'
+        ext.should == '.gz'
+      end
     end
-  end
+  end # describe '#compress_with'
+
 end

data/spec/compressor/lzma_spec.rb

@@ -5,54 +5,79 @@ require File.expand_path('../../spec_helper.rb', __FILE__)
 describe Backup::Compressor::Lzma do
   let(:compressor) { Backup::Compressor::Lzma.new }
 
-  before do
-    Backup::Model.extension = 'tar'
-  end
+  describe 'setting configuration defaults' do
+    after { Backup::Configuration::Compressor::Lzma.clear_defaults! }
 
-  describe 'the options' do
-    it do
-      compressor.send(:best).should == []
-    end
+    it 'uses and overrides configuration defaults' do
+      Backup::Configuration::Compressor::Lzma.best.should be_false
+      Backup::Configuration::Compressor::Lzma.fast.should be_false
+
+      compressor = Backup::Compressor::Lzma.new
+      compressor.best.should be_false
+      compressor.fast.should be_false
+
+      Backup::Configuration::Compressor::Lzma.defaults do |c|
+        c.best = true
+        c.fast = true
+      end
+      Backup::Configuration::Compressor::Lzma.best.should be_true
+      Backup::Configuration::Compressor::Lzma.fast.should be_true
 
-    it do
-      compressor.send(:fast).should == []
+      compressor = Backup::Compressor::Lzma.new
+      compressor.best.should be_true
+      compressor.fast.should be_true
+
+      compressor = Backup::Compressor::Lzma.new do |c|
+        c.best = false
+      end
+      compressor.best.should be_false
+      compressor.fast.should be_true
+
+      compressor = Backup::Compressor::Lzma.new do |c|
+        c.fast = false
+      end
+      compressor.best.should be_true
+      compressor.fast.should be_false
     end
-  end
+  end # describe 'setting configuration defaults'
 
-  describe '#perform!' do
+  describe '#compress_with' do
     before do
-      [:run, :utility].each { |method| compressor.stubs(method) }
+      compressor.expects(:log!)
+      compressor.expects(:utility).with(:lzma).returns('lzma')
     end
 
-    it 'should perform the compression' do
-      compressor.expects(:utility).with(:lzma).returns(:lzma)
-      compressor.expects(:run).with("lzma  '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
+    it 'should yield with the --best option' do
+      compressor.best = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'lzma --best'
+        ext.should == '.lzma'
+      end
     end
 
-    it 'should perform the compression with the --best and --fast options' do
-      compressor = Backup::Compressor::Lzma.new do |c|
-        c.best = true
-        c.fast = true
+    it 'should yield with the --fast option' do
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'lzma --fast'
+        ext.should == '.lzma'
       end
-
-      compressor.stubs(:utility).returns(:lzma)
-      compressor.expects(:run).with("lzma --best --fast '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
     end
 
-    it 'should set the class variable @extension (Backup::Model.extension) to .lzma' do
-      compressor.stubs(:utility).returns(:lzma)
-      compressor.expects(:run)
-
-      Backup::Model.extension.should == 'tar'
-      compressor.perform!
-      Backup::Model.extension.should == 'tar.lzma'
+    it 'should yield with the --best and --fast options' do
+      compressor.best = true
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'lzma --best --fast'
+        ext.should == '.lzma'
+      end
     end
 
-    it 'should log' do
-      Backup::Logger.expects(:message).with("Backup::Compressor::Lzma started compressing the archive.")
-      compressor.perform!
+    it 'should yield with no options' do
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'lzma'
+        ext.should == '.lzma'
+      end
     end
-  end
+  end # describe '#compress_with'
+
 end

data/spec/compressor/pbzip2_spec.rb

@@ -5,59 +5,120 @@ require File.expand_path('../../spec_helper.rb', __FILE__)
 describe Backup::Compressor::Pbzip2 do
   let(:compressor) { Backup::Compressor::Pbzip2.new }
 
-  before do
-    Backup::Model.extension = 'tar'
-  end
+  describe 'setting configuration defaults' do
+    after { Backup::Configuration::Compressor::Pbzip2.clear_defaults! }
 
-  describe 'the options' do
-    it do
-      compressor.send(:best).should == []
-    end
+    it 'uses and overrides configuration defaults' do
+      Backup::Configuration::Compressor::Pbzip2.best.should be_false
+      Backup::Configuration::Compressor::Pbzip2.fast.should be_false
+      Backup::Configuration::Compressor::Pbzip2.processors.should be_false
 
-    it do
-      compressor.send(:fast).should == []
-    end
+      compressor = Backup::Compressor::Pbzip2.new
+      compressor.best.should be_false
+      compressor.fast.should be_false
+      compressor.processors.should be_false
+
+      Backup::Configuration::Compressor::Pbzip2.defaults do |c|
+        c.best = true
+        c.fast = true
+        c.processors = 2
+      end
+      Backup::Configuration::Compressor::Pbzip2.best.should be_true
+      Backup::Configuration::Compressor::Pbzip2.fast.should be_true
+      Backup::Configuration::Compressor::Pbzip2.processors.should == 2
 
-    it do
-      compressor.send(:processors).should == []
+      compressor = Backup::Compressor::Pbzip2.new
+      compressor.best.should be_true
+      compressor.fast.should be_true
+      compressor.processors.should == 2
+
+      compressor = Backup::Compressor::Pbzip2.new do |c|
+        c.best = false
+      end
+      compressor.best.should be_false
+      compressor.fast.should be_true
+      compressor.processors.should == 2
+
+      compressor = Backup::Compressor::Pbzip2.new do |c|
+        c.fast = false
+      end
+      compressor.best.should be_true
+      compressor.fast.should be_false
+      compressor.processors.should == 2
+
+      compressor = Backup::Compressor::Pbzip2.new do |c|
+        c.processors = false
+      end
+      compressor.best.should be_true
+      compressor.fast.should be_true
+      compressor.processors.should be_false
     end
-  end
+  end # describe 'setting configuration defaults'
 
-  describe '#perform!' do
+  describe '#compress_with' do
     before do
-      [:run, :utility].each { |method| compressor.stubs(method) }
+      compressor.expects(:log!)
+      compressor.expects(:utility).with(:pbzip2).returns('pbzip2')
     end
 
-    it 'should perform the compression' do
-      compressor.expects(:utility).with(:pbzip2).returns(:pbzip2)
-      compressor.expects(:run).with("pbzip2  '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
+    it 'should yield with the --best option' do
+      compressor.best = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 --best'
+        ext.should == '.bz2'
+      end
     end
 
-    it 'should perform the compression with the --best, --fast and -p1 options' do
-      compressor = Backup::Compressor::Pbzip2.new do |c|
-        c.best = true
-        c.fast = true
-        c.processors = 1
+    it 'should yield with the --fast option' do
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 --fast'
+        ext.should == '.bz2'
       end
+    end
 
-      compressor.stubs(:utility).returns(:pbzip2)
-      compressor.expects(:run).with("pbzip2 --best --fast -p1 '#{ File.join(Backup::TMP_PATH, "#{ Backup::TIME }.#{ Backup::TRIGGER }.tar") }'")
-      compressor.perform!
+    it 'should yield with the -p option' do
+      compressor.processors = 2
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 -p2'
+        ext.should == '.bz2'
+      end
     end
 
-    it 'should set the class variable @extension (Backup::Model.extension) to .bz2' do
-      compressor.stubs(:utility).returns(:pbzip2)
-      compressor.expects(:run)
+    it 'should yield with the --best and --fast options' do
+      compressor.best = true
+      compressor.fast = true
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 --best --fast'
+        ext.should == '.bz2'
+      end
+    end
 
-      Backup::Model.extension.should == 'tar'
-      compressor.perform!
-      Backup::Model.extension.should == 'tar.bz2'
+    it 'should yield with the --best and -p options' do
+      compressor.best = true
+      compressor.processors = 2
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 --best -p2'
+        ext.should == '.bz2'
+      end
     end
 
-    it 'should log' do
-      Backup::Logger.expects(:message).with("Backup::Compressor::Pbzip2 started compressing the archive.")
-      compressor.perform!
+    it 'should yield with the --fast and -p options' do
+      compressor.fast = true
+      compressor.processors = 2
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2 --fast -p2'
+        ext.should == '.bz2'
+      end
     end
-  end
+
+    it 'should yield with no options' do
+      compressor.compress_with do |cmd, ext|
+        cmd.should == 'pbzip2'
+        ext.should == '.bz2'
+      end
+    end
+
+  end # describe '#compress_with'
+
 end

data/spec/config_spec.rb

@@ -0,0 +1,321 @@
+# encoding: utf-8
+
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+describe 'Backup::Config' do
+  let(:config) { Backup::Config }
+  before(:all) { config.send(:reset!) }
+  after(:each) do
+    config.unstub(:update)
+    config.unstub(:set_root_path)
+    config.unstub(:set_path_variable)
+    config.send(:reset!)
+  end
+
+  describe '#update' do
+    let(:default_root_path) { config.root_path }
+
+    context 'when a root_path is given' do
+      it 'should use #set_root_path to set the new root_path' do
+        config.expects(:set_root_path).with('a/path')
+
+        config.update(:root_path => 'a/path')
+      end
+
+      it 'should set all paths using the new root_path' do
+        config.expects(:set_root_path).with('path').returns('/root/path')
+        Backup::Config::DEFAULTS.each do |key, val|
+          config.expects(:set_path_variable).with(key, nil, val, '/root/path')
+        end
+
+        config.update(:root_path => 'path')
+      end
+    end # context 'when a root_path is given'
+
+    context 'when a root_path is not given' do
+      it 'should set all paths without using a root_path' do
+        Backup::Config::DEFAULTS.each do |key, val|
+          config.expects(:set_path_variable).with(key, nil, val, false)
+        end
+
+        config.update
+      end
+    end # context 'when a root_path is not given'
+
+  end # describe '#update'
+
+  describe '#load_config!' do
+    context 'when @config_file exists' do
+      before do
+        File.expects(:exist?).with(config.config_file).returns(true)
+      end
+
+      it 'should load the config file' do
+        File.expects(:read).with(config.config_file).returns(:file_contents)
+        config.expects(:module_eval).with(:file_contents, config.config_file)
+
+        expect do
+          config.load_config!
+        end.not_to raise_error
+      end
+    end
+
+    context 'when @config_file does not exist' do
+      before do
+        File.expects(:exist?).returns(false)
+      end
+
+      it 'should raise an error' do
+        File.expects(:read).never
+        config.expects(:module_eval).never
+
+        expect do
+          config.load_config!
+        end.to raise_error {|err|
+          err.should be_an_instance_of Backup::Errors::Config::NotFoundError
+          err.message.should match(
+            /Could not find configuration file: '#{config.config_file}'/
+          )
+        }
+      end
+    end
+  end # describe '#load_config!'
+
+  describe '#set_root_path' do
+
+    context 'when the given path == @root_path' do
+      it 'should return @root_path without requiring the path to exist' do
+        File.expects(:directory?).never
+        expect do
+          config.send(:set_root_path, config.root_path).
+              should == config.root_path
+        end.not_to raise_error
+      end
+    end
+
+    context 'when the given path exists' do
+      it 'should set and return the @root_path' do
+        expect do
+          config.send(:set_root_path, Dir.pwd).should == Dir.pwd
+        end.not_to raise_error
+        config.root_path.should == Dir.pwd
+      end
+
+      it 'should expand relative paths' do
+        expect do
+          config.send(:set_root_path, '').should == Dir.pwd
+        end.not_to raise_error
+        config.root_path.should == Dir.pwd
+      end
+    end
+
+    context 'when the given path does not exist' do
+      it 'should raise an error' do
+        path = File.expand_path('foo')
+        expect do
+          config.send(:set_root_path, 'foo')
+        end.to raise_error {|err|
+          err.should be_an_instance_of Backup::Errors::Config::NotFoundError
+          err.message.should match(/Root Path Not Found/)
+          err.message.should match(/Path was: #{ path }/)
+        }
+      end
+    end
+
+  end # describe '#set_root_path'
+
+  describe '#set_path_variable' do
+    after do
+      if config.instance_variable_defined?(:@var)
+        config.send(:remove_instance_variable, :@var)
+      end
+    end
+
+    context 'when a path is given' do
+      context 'when the given path is an absolute path' do
+        it 'should always use the given path' do
+          path = File.expand_path('foo')
+
+          config.send(:set_path_variable, 'var', path, 'none', '/root/path')
+          config.instance_variable_get(:@var).should == path
+
+          config.send(:set_path_variable, 'var', path, 'none', nil)
+          config.instance_variable_get(:@var).should == path
+        end
+      end
+
+      context 'when the given path is a relative path' do
+        context 'when a root_path is given' do
+          it 'should append the path to the root_path' do
+            config.send(:set_path_variable, 'var', 'foo', 'none', '/root/path')
+            config.instance_variable_get(:@var).should == '/root/path/foo'
+          end
+        end
+        context 'when a root_path is not given' do
+          it 'should expand the path' do
+            path = File.expand_path('foo')
+
+            config.send(:set_path_variable, 'var', 'foo', 'none', false)
+            config.instance_variable_get(:@var).should == path
+          end
+        end
+      end
+    end # context 'when a path is given'
+
+    context 'when no path is given' do
+      context 'when a root_path is given' do
+        it 'should use the root_path with the given ending' do
+          config.send(:set_path_variable, 'var', nil, 'ending', '/root/path')
+          config.instance_variable_get(:@var).should == '/root/path/ending'
+        end
+      end
+      context 'when a root_path is not given' do
+        it 'should do nothing' do
+          config.send(:set_path_variable, 'var', nil, 'ending', false)
+          config.instance_variable_defined?(:@var).should be_false
+        end
+      end
+    end # context 'when no path is given'
+
+  end # describe '#set_path_variable'
+
+  describe '#reset!' do
+    before do
+      @env_user = ENV['USER']
+      @env_home = ENV['HOME']
+    end
+
+    after do
+      ENV['USER'] = @env_user
+      ENV['HOME'] = @env_home
+    end
+
+    it 'should be called to set variables when module is loaded' do
+      # just to avoid 'already initialized constant' warnings
+      config.constants.each {|const| config.send(:remove_const, const) }
+
+      expected = config.instance_variables.sort.map(&:to_sym) - [:@mocha]
+      config.instance_variables.each do |var|
+        config.send(:remove_instance_variable, var)
+      end
+      config.instance_variables.should be_empty
+
+      load File.expand_path('../../lib/backup/config.rb', __FILE__)
+      config.instance_variables.sort.map(&:to_sym).should == expected
+    end
+
+    context 'when setting @user' do
+      context 'when ENV["USER"] is set' do
+        before { ENV['USER'] = 'test' }
+
+        it 'should set value for @user to ENV["USER"]' do
+          config.send(:reset!)
+          config.user.should == 'test'
+        end
+      end
+
+      context 'when ENV["USER"] is not set' do
+        before { ENV.delete('USER') }
+
+        it 'should set value using the user login name' do
+          config.send(:reset!)
+          config.user.should == Etc.getpwuid.name
+        end
+      end
+    end # context 'when setting @user'
+
+    context 'when setting @root_path' do
+      context 'when ENV["HOME"] is set' do
+        before { ENV['HOME'] = 'test/home/dir' }
+
+        it 'should set value using ENV["HOME"]' do
+          config.send(:reset!)
+          config.root_path.should ==
+              File.join(File.expand_path('test/home/dir'),'Backup')
+        end
+      end
+
+      context 'when ENV["HOME"] is not set' do
+        before { ENV.delete('HOME') }
+
+        it 'should set value using $PWD' do
+          config.send(:reset!)
+          config.root_path.should == File.expand_path('Backup')
+        end
+      end
+    end # context 'when setting @root_path'
+
+    context 'when setting other path variables' do
+      before { ENV['HOME'] = 'test/home/dir' }
+
+      it 'should use #update' do
+        config.expects(:update).with(
+          :root_path => File.join(File.expand_path('test/home/dir'),'Backup')
+        )
+        config.send(:reset!)
+      end
+    end
+
+  end # describe '#reset!'
+
+  describe '#add_dsl_constants!' do
+    it 'should be called when the module is loaded' do
+      config.constants.each {|const| config.send(:remove_const, const) }
+      config.constants.should be_empty
+
+      load File.expand_path('../../lib/backup/config.rb', __FILE__)
+
+      Backup::Config.const_defined?('MySQL').should be_true
+      Backup::Config.const_defined?('RSync').should be_true
+      Backup::Config::RSync.const_defined?('Local').should be_true
+    end
+  end # describe '#add_dsl_constants!'
+
+  describe '#create_modules' do
+    module TestScope; end
+
+    context 'when given an array of constant names' do
+      it 'should create modules for the given scope' do
+        config.send(:create_modules, TestScope, ['Foo', 'Bar'])
+        TestScope.const_defined?('Foo').should be_true
+        TestScope.const_defined?('Bar').should be_true
+        TestScope::Foo.class.should == Module
+        TestScope::Bar.class.should == Module
+      end
+    end
+
+    context 'when the given array contains Hash values' do
+      it 'should create deeply nested modules' do
+        config.send(
+          :create_modules,
+          TestScope,
+          [ 'FooBar', {
+            :LevelA => [ 'NameA', {
+              :LevelB => ['NameB']
+            } ]
+          } ]
+        )
+        TestScope.const_defined?('FooBar').should be_true
+        TestScope.const_defined?('LevelA').should be_true
+        TestScope::LevelA.const_defined?('NameA').should be_true
+        TestScope::LevelA.const_defined?('LevelB').should be_true
+        TestScope::LevelA::LevelB.const_defined?('NameB').should be_true
+      end
+    end
+  end
+
+  describe 'Backup.const_missing' do
+    it 'should warn if Backup::CONFIG_FILE is referenced from an older config.rb' do
+      Backup::Logger.expects(:warn)
+      expect do
+        Backup.const_get('CONFIG_FILE').should == Backup::Config.config_file
+      end.not_to raise_error
+    end
+
+    it 'should still handle other missing constants' do
+      expect do
+        Backup.const_get('FOO')
+      end.to raise_error(NameError, 'uninitialized constant Backup::FOO')
+    end
+  end
+end