backup 3.0.23 → 3.0.24

data/spec/syncer/rsync/local_spec.rb

@@ -5,53 +5,82 @@ require File.expand_path('../../../spec_helper.rb', __FILE__)
 describe Backup::Syncer::RSync::Local do
   let(:syncer) do
     Backup::Syncer::RSync::Local.new do |rsync|
-      rsync.path = "~/my_backups"
+      rsync.path    = "~/my_backups"
+      rsync.mirror  = true
+      rsync.additional_options = ['--opt-a', '--opt-b']
 
       rsync.directories do |directory|
         directory.add "/some/directory"
         directory.add "~/home/directory"
       end
-
-      rsync.mirror             = true
-      rsync.additional_options = ['--opt-a', '--opt-b']
     end
   end
 
-  it 'should be a subclass of RSync::Base' do
-    Backup::Syncer::RSync::Local.superclass.should == Backup::Syncer::RSync::Base
+  it 'should be a subclass of Syncer::RSync::Base' do
+    Backup::Syncer::RSync::Local.
+      superclass.should == Backup::Syncer::RSync::Base
   end
 
   describe '#initialize' do
-    it 'should have defined the configuration properly' do
-      syncer.path.should               == '~/my_backups'
-      syncer.directories.should        == ["/some/directory", "~/home/directory"]
-      syncer.mirror.should             == true
-      syncer.additional_options.should == ['--opt-a', '--opt-b']
+    after { Backup::Syncer::RSync::Local.clear_defaults! }
+
+    it 'should load pre-configured defaults through Syncer::Base' do
+      Backup::Syncer::RSync::Local.any_instance.expects(:load_defaults!)
+      syncer
     end
 
-    context 'when setting configuration defaults' do
-      after { Backup::Configuration::Syncer::RSync::Local.clear_defaults! }
+    context 'when no pre-configured defaults have been set' do
+      it 'should use the values given' do
+        syncer.path.should               == '~/my_backups'
+        syncer.mirror.should             == true
+        syncer.directories.should        == ["/some/directory", "~/home/directory"]
+        syncer.additional_options.should == ['--opt-a', '--opt-b']
+      end
+
+      it 'should use default values if none are given' do
+        syncer = Backup::Syncer::RSync::Local.new
+
+        # from Syncer::Base
+        syncer.path.should    == 'backups'
+        syncer.mirror.should  == false
+        syncer.directories.should == []
 
-      it 'should override the configured defaults' do
-        Backup::Configuration::Syncer::RSync::Local.defaults do |rsync|
-          rsync.path               = 'old_path'
-          #rsync.directories        = 'cannot_have_a_default_value'
-          rsync.mirror             = 'old_mirror'
-          rsync.additional_options = 'old_additional_options'
+        # from Syncer::RSync::Base
+        syncer.additional_options.should == []
+      end
+    end # context 'when no pre-configured defaults have been set'
+
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Syncer::RSync::Local.defaults do |rsync|
+          rsync.path    = 'some_path'
+          rsync.mirror  = 'some_mirror'
+          rsync.additional_options = 'some_additional_options'
         end
+      end
+
+      it 'should use pre-configured defaults' do
+        syncer = Backup::Syncer::RSync::Local.new
+
+        syncer.path.should    == 'some_path'
+        syncer.mirror.should  == 'some_mirror'
+        syncer.directories.should == []
+        syncer.additional_options.should == 'some_additional_options'
+      end
+
+      it 'should override pre-configured defaults' do
         syncer = Backup::Syncer::RSync::Local.new do |rsync|
-          rsync.path               = 'new_path'
-          rsync.directories        = 'new_directories'
-          rsync.mirror             = 'new_mirror'
+          rsync.path    = 'new_path'
+          rsync.mirror  = 'new_mirror'
           rsync.additional_options = 'new_additional_options'
         end
 
-        syncer.path.should               == 'new_path'
-        syncer.directories.should        == 'new_directories'
-        syncer.mirror.should             == 'new_mirror'
+        syncer.path.should    == 'new_path'
+        syncer.mirror.should  == 'new_mirror'
+        syncer.directories.should == []
         syncer.additional_options.should == 'new_additional_options'
       end
-    end # context 'when setting configuration defaults'
+    end # context 'when pre-configured defaults have been set'
   end # describe '#initialize'
 
   describe '#perform!' do

data/spec/syncer/rsync/pull_spec.rb

@@ -15,6 +15,7 @@ describe Backup::Syncer::RSync::Pull do
       rsync.directories do |directory|
         directory.add "/some/directory"
         directory.add "~/home/directory"
+        directory.add "another/directory"
       end
 
       rsync.mirror             = true
@@ -30,12 +31,12 @@ describe Backup::Syncer::RSync::Pull do
     let(:s) { sequence '' }
 
     it 'should perform the RSync::Pull operation on two directories' do
-      syncer.expects(:utility).twice.with(:rsync).returns('rsync')
-      syncer.expects(:options).twice.returns('options_output')
+      syncer.expects(:utility).times(3).with(:rsync).returns('rsync')
+      syncer.expects(:options).times(3).returns('options_output')
 
       syncer.expects(:write_password_file!).in_sequence(s)
 
-      # first directory
+      # first directory - uses the given full path
       Backup::Logger.expects(:message).in_sequence(s).with(
         "Syncer::RSync::Pull started syncing '/some/directory'."
       )
@@ -45,7 +46,7 @@ describe Backup::Syncer::RSync::Pull do
       ).returns('messages from stdout')
       Backup::Logger.expects(:silent).in_sequence(s).with('messages from stdout')
 
-      # second directory
+      # second directory - removes leading '~'
       Backup::Logger.expects(:message).in_sequence(s).with(
         "Syncer::RSync::Pull started syncing '~/home/directory'."
       )
@@ -55,6 +56,16 @@ describe Backup::Syncer::RSync::Pull do
       ).returns('messages from stdout')
       Backup::Logger.expects(:silent).in_sequence(s).with('messages from stdout')
 
+      # third directory - does not expand path
+      Backup::Logger.expects(:message).in_sequence(s).with(
+        "Syncer::RSync::Pull started syncing 'another/directory'."
+      )
+      syncer.expects(:run).in_sequence(s).with(
+        "rsync options_output 'my_username@123.45.678.90:another/directory' " +
+        "'#{ File.expand_path('~/my_backups') }'"
+      ).returns('messages from stdout')
+      Backup::Logger.expects(:silent).in_sequence(s).with('messages from stdout')
+
       syncer.expects(:remove_password_file!).in_sequence(s)
 
       syncer.perform!

data/spec/syncer/rsync/push_spec.rb

@@ -22,100 +22,107 @@ describe Backup::Syncer::RSync::Push do
     end
   end
 
-  it 'should be a subclass of RSync::Base' do
-    Backup::Syncer::RSync::Push.superclass.should == Backup::Syncer::RSync::Base
+  it 'should be a subclass of Syncer::RSync::Base' do
+    Backup::Syncer::RSync::Push.
+      superclass.should == Backup::Syncer::RSync::Base
   end
 
   describe '#initialize' do
-    it 'should have defined the configuration properly' do
-      syncer.username.should           == 'my_username'
-      syncer.password.should           == 'my_password'
-      syncer.ip.should                 == '123.45.678.90'
-      syncer.port.should               == 22
-      syncer.compress.should           == true
-      syncer.path.should               == '~/my_backups'
-      syncer.directories.should        == ["/some/directory", "~/home/directory"]
-      syncer.mirror.should             == true
-      syncer.additional_options.should == ['--opt-a', '--opt-b']
+    after { Backup::Syncer::RSync::Push.clear_defaults! }
+
+    it 'should load pre-configured defaults through Syncer::Base' do
+      Backup::Syncer::RSync::Push.any_instance.expects(:load_defaults!)
+      syncer
     end
 
-    context 'when options are not set' do
-      it 'should use default values' do
+    context 'when no pre-configured defaults have been set' do
+      it 'should use the values given' do
+        syncer.path.should               == '~/my_backups'
+        syncer.mirror.should             == true
+        syncer.directories.should        == ["/some/directory", "~/home/directory"]
+        syncer.additional_options.should == ['--opt-a', '--opt-b']
+
+        syncer.username.should           == 'my_username'
+        syncer.password.should           == 'my_password'
+        syncer.ip.should                 == '123.45.678.90'
+        syncer.port.should               == 22
+        syncer.compress.should           == true
+      end
+
+      it 'should use default values if none are given' do
         syncer = Backup::Syncer::RSync::Push.new
+
+        # from Syncer::Base
+        syncer.path.should    == 'backups'
+        syncer.mirror.should  == false
+        syncer.directories.should == []
+
+        # from Syncer::RSync::Base
+        syncer.additional_options.should == []
+
         syncer.username.should           == nil
         syncer.password.should           == nil
         syncer.ip.should                 == nil
         syncer.port.should               == 22
         syncer.compress.should           == false
-        syncer.path.should               == 'backups'
-        syncer.directories.should        == []
-        syncer.mirror.should             == false
-        syncer.additional_options.should == []
       end
-    end
+    end # context 'when no pre-configured defaults have been set'
 
-    context 'when setting configuration defaults' do
-      after { Backup::Configuration::Syncer::RSync::Push.clear_defaults! }
+    context 'when pre-configured defaults have been set' do
+      before do
+        Backup::Syncer::RSync::Push.defaults do |rsync|
+          rsync.path    = 'some_path'
+          rsync.mirror  = 'some_mirror'
+          rsync.additional_options = 'some_additional_options'
 
-      it 'should use the configured defaults' do
-        Backup::Configuration::Syncer::RSync::Push.defaults do |rsync|
           rsync.username           = 'some_username'
           rsync.password           = 'some_password'
           rsync.ip                 = 'some_ip'
           rsync.port               = 'some_port'
           rsync.compress           = 'some_compress'
-          rsync.path               = 'some_path'
-          #rsync.directories        = 'cannot_have_a_default_value'
-          rsync.mirror             = 'some_mirror'
-          rsync.additional_options = 'some_additional_options'
         end
+      end
+
+      it 'should use pre-configured defaults' do
         syncer = Backup::Syncer::RSync::Push.new
+
+        syncer.path.should    == 'some_path'
+        syncer.mirror.should  == 'some_mirror'
+        syncer.directories.should == []
+        syncer.additional_options.should == 'some_additional_options'
+
         syncer.username.should           == 'some_username'
         syncer.password.should           == 'some_password'
         syncer.ip.should                 == 'some_ip'
         syncer.port.should               == 'some_port'
         syncer.compress.should           == 'some_compress'
-        syncer.path.should               == 'some_path'
-        syncer.directories.should        == []
-        syncer.mirror.should             == 'some_mirror'
-        syncer.additional_options.should == 'some_additional_options'
       end
 
-      it 'should override the configured defaults' do
-        Backup::Configuration::Syncer::RSync::Push.defaults do |rsync|
-          rsync.username           = 'old_username'
-          rsync.password           = 'old_password'
-          rsync.ip                 = 'old_ip'
-          rsync.port               = 'old_port'
-          rsync.compress           = 'old_compress'
-          rsync.path               = 'old_path'
-          #rsync.directories        = 'cannot_have_a_default_value'
-          rsync.mirror             = 'old_mirror'
-          rsync.additional_options = 'old_additional_options'
-        end
+      it 'should override pre-configured defaults' do
         syncer = Backup::Syncer::RSync::Push.new do |rsync|
+          rsync.path    = 'new_path'
+          rsync.mirror  = 'new_mirror'
+          rsync.additional_options = 'new_additional_options'
+
           rsync.username           = 'new_username'
           rsync.password           = 'new_password'
           rsync.ip                 = 'new_ip'
           rsync.port               = 'new_port'
           rsync.compress           = 'new_compress'
-          rsync.path               = 'new_path'
-          rsync.directories        = 'new_directories'
-          rsync.mirror             = 'new_mirror'
-          rsync.additional_options = 'new_additional_options'
         end
 
+        syncer.path.should    == 'new_path'
+        syncer.mirror.should  == 'new_mirror'
+        syncer.directories.should == []
+        syncer.additional_options.should == 'new_additional_options'
+
         syncer.username.should           == 'new_username'
         syncer.password.should           == 'new_password'
         syncer.ip.should                 == 'new_ip'
         syncer.port.should               == 'new_port'
         syncer.compress.should           == 'new_compress'
-        syncer.path.should               == 'new_path'
-        syncer.directories.should        == 'new_directories'
-        syncer.mirror.should             == 'new_mirror'
-        syncer.additional_options.should == 'new_additional_options'
       end
-    end # context 'when setting configuration defaults'
+    end # context 'when pre-configured defaults have been set'
   end # describe '#initialize'
 
   describe '#perform!' do

data/templates/cli/utility/compressor/bzip2

@@ -1,7 +1,4 @@
   ##
   # Bzip2 [Compressor]
   #
-  compress_with Bzip2 do |compression|
-    compression.best = true
-    compression.fast = false
-  end
+  compress_with Bzip2

data/templates/cli/utility/compressor/custom

@@ -0,0 +1,11 @@
+  ##
+  # Custom [Compressor]
+  #
+  # For information on using a Custom Compressor,
+  # please see the following Wiki page:
+  # https://github.com/meskyanichi/backup/wiki/Compressors
+  #
+  compress_with Custom do |compressor|
+    compressor.command   = 'gzip'
+    compressor.extension = '.gz'
+  end

data/templates/cli/utility/compressor/gzip

@@ -1,7 +1,4 @@
   ##
   # Gzip [Compressor]
   #
-  compress_with Gzip do |compression|
-    compression.best = true
-    compression.fast = false
-  end
+  compress_with Gzip

data/templates/cli/utility/compressor/lzma

@@ -1,6 +1,9 @@
   ##
   # Lzma [Compressor]
   #
+  # [DEPRECATED]
+  # See the Wiki for more info.
+  # https://github.com/meskyanichi/backup/wiki/Compressors
   compress_with Lzma do |compression|
     compression.best = true
     compression.fast = false

data/templates/cli/utility/compressor/pbzip2

@@ -1,6 +1,9 @@
   ##
   # Pbzip2 [Compressor]
   #
+  # [DEPRECATED]
+  # See the Wiki for more info.
+  # https://github.com/meskyanichi/backup/wiki/Compressors
   compress_with Pbzip2 do |compression|
     compression.best = true
     compression.fast = false

data/templates/cli/utility/database/mysql

@@ -2,13 +2,16 @@
   # MySQL [Database]
   #
   database MySQL do |db|
-    # To dump all databases, set db.name = :all (or leave blank)
+    # To dump all databases, set `db.name = :all` (or leave blank)
     db.name               = "my_database_name"
     db.username           = "my_username"
     db.password           = "my_password"
     db.host               = "localhost"
     db.port               = 3306
     db.socket             = "/tmp/mysql.sock"
+    # Note: when using `skip_tables` with the `db.name = :all` option,
+    # table names should be prefixed with a database name.
+    # e.g. ["db_name.table_to_skip", ...]
     db.skip_tables        = ["skip", "these", "tables"]
     db.only_tables        = ["only", "these" "tables"]
     db.additional_options = ["--quick", "--single-transaction"]

data/templates/cli/utility/syncer/cloud_files

@@ -3,34 +3,32 @@
   #
   # Available Auth URLs:
   #
-  #  - https://auth.api.rackspacecloud.com     (US - Default)
-  #  - https://lon.auth.api.rackspacecloud.com (UK)
+  #   - https://auth.api.rackspacecloud.com     (US - Default)
+  #   - https://lon.auth.api.rackspacecloud.com (UK)
   #
   # Servicenet:
   #
-  #  Set this to 'true' if Backup runs on a Rackspace server. It will avoid
-  #  transfer charges and it's more performant.
+  #   Set this to 'true' if Backup runs on a Rackspace server.
+  #   It will avoid transfer charges and it's more performant.
   #
   # Mirroring:
   #
-  #  When enabled it will keep an exact mirror of your filesystem on Cloud Files. This means
-  #  that when you remove a file from the filesystem, it will also remote it from Cloud Files.
+  #   When enabled it will keep an exact mirror of your filesystem on Cloud Files.
+  #   This means that when you remove a file from the filesystem,
+  #   it will also remote it from Cloud Files.
   #
-  # Concurrency (concurrency_type):
+  # Concurrency:
   #
-  #  - :threads (recommended)
-  #  - :processes
-  #  - false
+  #   `concurrency_type` may be set to:
   #
-  #  Threads are a good choice for such sync operations and doesn't consume any additional memory.
-  #  Using :processes is discouraged as it's likely to consumes a lot of memory.
+  #     - false (default)
+  #     - :threads
+  #     - :processes
   #
-  # Concurrency (concurrency_level):
+  #   Set `concurrency_level` to the number of threads/processes to use.
+  #   Defaults to 2.
   #
-  #  Defaults to 2, the higher the level, the faster it will sync.
-  #  If you want a high concurrency level (>2), use :threads and not :processes.
-  #
-  sync_with CloudFiles do |cf|
+  sync_with Cloud::CloudFiles do |cf|
     cf.username          = "my_username"
     cf.api_key           = "my_api_key"
     cf.container         = "my_container"
@@ -38,8 +36,8 @@
     cf.servicenet        = false
     cf.path              = "/backups"
     cf.mirror            = true
-    cf.concurrency_type  = :threads
-    cf.concurrency_level = 50
+    cf.concurrency_type  = false
+    cf.concurrency_level = 2
 
     cf.directories do |directory|
       directory.add "/path/to/directory/to/sync"