backup-agoddard 3.0.27

data/spec/archive_spec.rb

@@ -0,0 +1,335 @@
+# encoding: utf-8
+
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+describe Backup::Archive do
+  let(:model) { Backup::Model.new(:test_trigger, 'test model') }
+  let(:archive) { Backup::Archive.new(model, :test_archive) }
+
+  describe '#initialize' do
+
+    it 'should have no paths' do
+      archive.paths.should == []
+    end
+
+    it 'should have no excludes' do
+      archive.excludes.should == []
+    end
+
+    it 'should have no tar_args' do
+      archive.tar_args.should == ''
+    end
+
+    it 'should set a reference to the given model' do
+      archive.instance_variable_get(:@model).should be(model)
+    end
+
+    it 'should convert name to a String' do
+      archive.name.should be_a_kind_of String
+      archive.name.should == 'test_archive'
+    end
+
+    context 'when a configuration block is given' do
+      let(:archive) do
+        Backup::Archive.new(model, :test_archive) do |a|
+          a.add 'added_path'
+          a.add 'another/added_path'
+          a.exclude 'excluded_path'
+          a.exclude 'another/excluded_path'
+          a.tar_options '-h --xattrs'
+        end
+      end
+
+      before do
+        File.stubs(:exist?).returns(true)
+      end
+
+      it 'should add @paths' do
+        archive.paths.should == [
+          File.expand_path('added_path'),
+          File.expand_path('another/added_path')
+        ]
+      end
+
+      it 'should add @excludes' do
+        archive.excludes.should == [
+          File.expand_path('excluded_path'),
+          File.expand_path('another/excluded_path')
+        ]
+      end
+
+      it 'should add @tar_args' do
+        archive.tar_args.should == '-h --xattrs'
+      end
+    end
+
+  end # describe '#initialize'
+
+  describe '#add' do
+
+    context 'when the path exists' do
+      it 'should expand and add the path to @paths' do
+        File.expects(:exist?).with(File.expand_path('foo')).returns(true)
+        Backup::Logger.expects(:warn).never
+
+        archive.add 'foo'
+        archive.paths.should == [File.expand_path('foo')]
+      end
+    end
+
+    context 'when a path does not exist' do
+      it 'should omit the path and log a warning' do
+        File.expects(:exist?).with(
+          File.expand_path('path')
+        ).returns(true)
+        File.expects(:exist?).with(
+          File.expand_path('foo')
+        ).returns(false)
+        File.expects(:exist?).with(
+          File.expand_path('another/path')
+        ).returns(true)
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::Archive::NotFoundError
+          err.message.should ==
+            "Archive::NotFoundError: The following path was not found:\n" +
+            "  #{ File.expand_path('foo') }\n" +
+            "  This path will be omitted from the 'test_archive' Archive."
+        end
+
+        archive.add 'path'
+        archive.add 'foo'
+        archive.add 'another/path'
+        archive.paths.should == [
+          File.expand_path('path'),
+          File.expand_path('another/path')
+        ]
+      end
+    end
+  end
+
+  describe '#exclude' do
+    it 'should expand and add the given path to #excludes' do
+      archive.exclude 'path'
+      archive.exclude 'another/path'
+      archive.excludes.should == [
+        File.expand_path('path'),
+        File.expand_path('another/path')
+      ]
+    end
+  end
+
+  describe '#tar_options' do
+    it 'should set #tar_options to the given string' do
+      archive = Backup::Archive.new(model, :test_archive) do |a|
+        a.tar_options '-h --xattrs'
+      end
+      archive.tar_args.should == '-h --xattrs'
+    end
+  end
+
+  describe '#perform!' do
+    let(:archive_path) do
+      File.join(Backup::Config.tmp_path, 'test_trigger', 'archives')
+    end
+    let(:paths) { ['/path/to/add', '/another/path/to/add'] }
+    let(:excludes) { ['/path/to/exclude', '/another/path/to/exclude'] }
+    let(:pipeline) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      archive.instance_variable_set(:@paths, paths)
+      archive.expects(:utility).with(:tar).returns('tar')
+      FileUtils.expects(:mkdir_p).with(archive_path)
+      Backup::Pipeline.expects(:new).returns(pipeline)
+    end
+
+    context 'when both #paths and #excludes were added' do
+      before do
+        archive.instance_variable_set(:@excludes, excludes)
+      end
+
+      it 'should render the syntax for both' do
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive has started archiving:\n" +
+          "  /path/to/add\n" +
+          "  /another/path/to/add"
+        )
+
+        pipeline.expects(:<<).in_sequence(s).with(
+          "tar  -cPf - " +
+          "--exclude='/path/to/exclude' --exclude='/another/path/to/exclude' " +
+          "'/path/to/add' '/another/path/to/add'"
+        )
+        pipeline.expects(:<<).in_sequence(s).with(
+          "cat > '#{ File.join(archive_path, 'test_archive.tar') }'"
+        )
+        pipeline.expects(:run).in_sequence(s)
+        pipeline.expects(:success?).in_sequence(s).returns(true)
+
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive Complete!"
+        )
+
+        archive.perform!
+      end
+    end # context 'when both #paths and #excludes were added'
+
+    context 'when no excludes were added' do
+      it 'should render only the syntax for adds' do
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive has started archiving:\n" +
+          "  /path/to/add\n" +
+          "  /another/path/to/add"
+        )
+
+        pipeline.expects(:<<).in_sequence(s).with(
+          "tar  -cPf -  '/path/to/add' '/another/path/to/add'"
+        )
+        pipeline.expects(:<<).in_sequence(s).with(
+          "cat > '#{ File.join(archive_path, 'test_archive.tar') }'"
+        )
+        pipeline.expects(:run).in_sequence(s)
+        pipeline.expects(:success?).in_sequence(s).returns(true)
+
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive Complete!"
+        )
+
+        archive.perform!
+      end
+    end # context 'when no excludes were added'
+
+    context 'with #paths, #excludes and #tar_args' do
+      before do
+        archive.instance_variable_set(:@excludes, excludes)
+        archive.instance_variable_set(:@tar_args, '-h --xattrs')
+      end
+
+      it 'should render the syntax for all three' do
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive has started archiving:\n" +
+          "  /path/to/add\n" +
+          "  /another/path/to/add"
+        )
+
+        pipeline.expects(:<<).in_sequence(s).with(
+          "tar -h --xattrs -cPf - " +
+          "--exclude='/path/to/exclude' --exclude='/another/path/to/exclude' " +
+          "'/path/to/add' '/another/path/to/add'"
+        )
+        pipeline.expects(:<<).in_sequence(s).with(
+          "cat > '#{ File.join(archive_path, 'test_archive.tar') }'"
+        )
+        pipeline.expects(:run).in_sequence(s)
+        pipeline.expects(:success?).in_sequence(s).returns(true)
+
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive Complete!"
+        )
+
+        archive.perform!
+      end
+    end # context 'with #paths, #excludes and #tar_args'
+
+    context 'with #paths, #excludes, #tar_args and a Gzip Compressor' do
+      before do
+        archive.instance_variable_set(:@excludes, excludes)
+        archive.instance_variable_set(:@tar_args, '-h --xattrs')
+        compressor = mock
+        model.expects(:compressor).twice.returns(compressor)
+        compressor.expects(:compress_with).yields('gzip', '.gz')
+      end
+
+      it 'should render the syntax with compressor modifications' do
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive has started archiving:\n" +
+          "  /path/to/add\n" +
+          "  /another/path/to/add"
+        )
+
+        pipeline.expects(:<<).in_sequence(s).with(
+          "tar -h --xattrs -cPf - " +
+          "--exclude='/path/to/exclude' --exclude='/another/path/to/exclude' " +
+          "'/path/to/add' '/another/path/to/add'"
+        )
+        pipeline.expects(:<<).in_sequence(s).with('gzip')
+        pipeline.expects(:<<).in_sequence(s).with(
+          "cat > '#{ File.join(archive_path, 'test_archive.tar.gz') }'"
+        )
+        pipeline.expects(:run).in_sequence(s)
+        pipeline.expects(:success?).in_sequence(s).returns(true)
+
+        Backup::Logger.expects(:message).in_sequence(s).with(
+          "Backup::Archive Complete!"
+        )
+
+        archive.perform!
+      end
+    end # context 'with #paths, #excludes, #tar_args and a Gzip Compressor'
+
+    context 'when pipeline command fails' do
+      before do
+        pipeline.stubs(:<<)
+        pipeline.expects(:run)
+        pipeline.expects(:success?).returns(false)
+        pipeline.expects(:error_messages).returns('pipeline_errors')
+      end
+
+      it 'should raise an error' do
+        Backup::Logger.expects(:message).with(
+          "Backup::Archive has started archiving:\n" +
+          "  /path/to/add\n" +
+          "  /another/path/to/add"
+        )
+
+        expect do
+          archive.perform!
+        end.to raise_error(
+          Backup::Errors::Archive::PipelineError,
+          "Archive::PipelineError: Failed to Create Backup Archive\n" +
+          "  pipeline_errors"
+        )
+      end
+    end # context 'when pipeline command fails'
+
+  end # describe '#perform!'
+
+  describe '#paths_to_package' do
+    before do
+      archive.instance_variable_set(
+        :@paths,
+        ['/home/rspecuser/somefile',
+         '/home/rspecuser/logs',
+         '/home/rspecuser/dotfiles']
+      )
+    end
+
+    it 'should return a tar friendly string' do
+      archive.send(:paths_to_package).should ==
+      "'/home/rspecuser/somefile' '/home/rspecuser/logs' '/home/rspecuser/dotfiles'"
+    end
+  end
+
+  describe '#paths_to_exclude' do
+    context 'when no excludes are added' do
+      it 'should return nil' do
+        archive.send(:paths_to_exclude).should be_nil
+      end
+    end
+
+    context 'when excludes are added' do
+      before do
+        archive.instance_variable_set(
+          :@excludes,
+          ['/home/rspecuser/badfile',
+          '/home/rspecuser/wrongdir']
+        )
+      end
+      it 'should return a tar friendly string' do
+        archive.send(:paths_to_exclude).should ==
+        "--exclude='/home/rspecuser/badfile' --exclude='/home/rspecuser/wrongdir'"
+      end
+    end
+  end
+end

data/spec/cleaner_spec.rb

@@ -0,0 +1,312 @@
+# encoding: utf-8
+
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+describe 'Backup::Cleaner' do
+  let(:model)   { Backup::Model.new(:test_trigger, 'test label') }
+  let(:cleaner) { Backup::Cleaner }
+
+  describe '#prepare' do
+    let(:error_tail) do
+      "  Please check the log for messages and/or your notifications\n" +
+      "  concerning this backup: 'test label (test_trigger)'\n" +
+      "  The temporary files which had to be removed should not have existed."
+    end
+
+    context 'when neither the tmp_path is dirty or package files exist' do
+      it 'should do nothing' do
+        cleaner.expects(:packaging_folder_dirty?).returns(false)
+        cleaner.expects(:tmp_path_package_files).returns([])
+        FileUtils.expects(:rm_rf).never
+        FileUtils.expects(:rm_f).never
+        Backup::Logger.expects(:warn).never
+
+        cleaner.prepare(model)
+      end
+    end
+
+    context 'when the tmp_path is dirty' do
+      it 'should remove tmp_path and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(true)
+        cleaner.expects(:tmp_path_package_files).returns([])
+        FileUtils.expects(:rm_f).never
+
+        FileUtils.expects(:rm_rf).with(
+          File.join(Backup::Config.tmp_path, 'test_trigger')
+        )
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder still contains files!\n" +
+            "  '#{ File.join(Backup::Config.tmp_path, 'test_trigger') }'\n" +
+            "  These files will now be removed.\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.prepare(model)
+      end
+    end
+
+    context 'when package files exist' do
+      it 'should remove the files and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(false)
+        cleaner.expects(:tmp_path_package_files).returns(['file1', 'file2'])
+        FileUtils.expects(:rm_rf).never
+
+        FileUtils.expects(:rm_f).with('file1')
+        FileUtils.expects(:rm_f).with('file2')
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder '#{ Backup::Config.tmp_path }'\n" +
+            "  appears to contain the package files from the previous backup!\n" +
+            "  file1\n" +
+            "  file2\n" +
+            "  These files will now be removed.\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.prepare(model)
+      end
+    end
+
+    context 'both the tmp_path is dirty and package files exist' do
+      it 'should clean both and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(true)
+        cleaner.expects(:tmp_path_package_files).returns(['file1', 'file2'])
+
+        FileUtils.expects(:rm_rf).with(
+          File.join(Backup::Config.tmp_path, 'test_trigger')
+        )
+        FileUtils.expects(:rm_f).with('file1')
+        FileUtils.expects(:rm_f).with('file2')
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder still contains files!\n" +
+            "  '#{ File.join(Backup::Config.tmp_path, 'test_trigger') }'\n" +
+            "  These files will now be removed.\n" +
+            "  \n" +
+            "  #{ '-' * 74 }\n" +
+            "  The temporary backup folder '#{ Backup::Config.tmp_path }'\n" +
+            "  appears to contain the package files from the previous backup!\n" +
+            "  file1\n" +
+            "  file2\n" +
+            "  These files will now be removed.\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.prepare(model)
+      end
+    end
+
+  end # describe '#prepare'
+
+  describe '#remove_packaging' do
+    it 'should remove the packaging directory and log a message' do
+      Backup::Logger.expects(:message).with(
+        "Cleaning up the temporary files..."
+      )
+      FileUtils.expects(:rm_rf).with(
+        File.join(Backup::Config.tmp_path, 'test_trigger')
+      )
+
+      cleaner.remove_packaging(model)
+    end
+  end
+
+  describe '#remove_package' do
+    let(:package) { mock }
+    it 'should remove the files for the given package and log a message' do
+      package.expects(:filenames).returns(['file1', 'file2'])
+      Backup::Logger.expects(:message).with(
+        "Cleaning up the package files..."
+      )
+      FileUtils.expects(:rm_f).with(
+        File.join(Backup::Config.tmp_path, 'file1')
+      )
+      FileUtils.expects(:rm_f).with(
+        File.join(Backup::Config.tmp_path, 'file2')
+      )
+
+      cleaner.remove_package(package)
+    end
+  end
+
+  describe '#warnings' do
+    let(:error_tail) do
+      "  Make sure you check these files before the next scheduled backup for\n" +
+      "  'test label (test_trigger)'\n" +
+      "  These files will be removed at that time!"
+    end
+
+    context 'when neither the tmp_path is dirty or package files exist' do
+      it 'should do nothing' do
+        cleaner.expects(:packaging_folder_dirty?).returns(false)
+        cleaner.expects(:tmp_path_package_files).returns([])
+        Backup::Logger.expects(:warn).never
+
+        cleaner.warnings(model)
+      end
+    end
+
+    context 'when the tmp_path is dirty' do
+      it 'should remove tmp_path and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(true)
+        cleaner.expects(:tmp_path_package_files).returns([])
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder still contains files!\n" +
+            "  '#{ File.join(Backup::Config.tmp_path, 'test_trigger') }'\n" +
+            "  This folder may contain completed Archives and/or Database backups.\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.warnings(model)
+      end
+    end
+
+    context 'when package files exist' do
+      it 'should remove the files and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(false)
+        cleaner.expects(:tmp_path_package_files).returns(['file1', 'file2'])
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder '#{ Backup::Config.tmp_path }'\n" +
+            "  appears to contain the backup files which were to be stored:\n" +
+            "  file1\n" +
+            "  file2\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.warnings(model)
+      end
+    end
+
+    context 'both the tmp_path is dirty and package files exist' do
+      it 'should clean both and log a warning' do
+        cleaner.expects(:packaging_folder_dirty?).returns(true)
+        cleaner.expects(:tmp_path_package_files).returns(['file1', 'file2'])
+
+        Backup::Logger.expects(:warn).with do |err|
+          err.should be_an_instance_of Backup::Errors::CleanerError
+          err.message.should == "CleanerError: Cleanup Warning\n" +
+            "  The temporary backup folder still contains files!\n" +
+            "  '#{ File.join(Backup::Config.tmp_path, 'test_trigger') }'\n" +
+            "  This folder may contain completed Archives and/or Database backups.\n" +
+            "  \n" +
+            "  #{ '-' * 74 }\n" +
+            "  The temporary backup folder '#{ Backup::Config.tmp_path }'\n" +
+            "  appears to contain the backup files which were to be stored:\n" +
+            "  file1\n" +
+            "  file2\n" +
+            "  \n" + error_tail
+        end
+
+        cleaner.warnings(model)
+      end
+    end
+
+  end # describe '#warnings'
+
+  describe '#packaging_folder_dirty?' do
+    before do
+      cleaner.instance_variable_set(:@model, model)
+      FileUtils.unstub(:mkdir_p)
+    end
+
+    after do
+      Backup::Config.send(:reset!)
+    end
+
+    context 'when files exist in the packaging folder' do
+      it 'should return true' do
+        Dir.mktmpdir do |path|
+          Backup::Config.update(:root_path => path)
+          FileUtils.mkdir_p(
+            File.join(Backup::Config.tmp_path, 'test_trigger', 'archives')
+          )
+          cleaner.send(:packaging_folder_dirty?).should be_true
+        end
+      end
+    end
+
+    context 'when files do not exist in the packaging folder' do
+      it 'should return false' do
+        Dir.mktmpdir do |path|
+          Backup::Config.update(:root_path => path)
+          FileUtils.mkdir_p(
+            File.join(Backup::Config.tmp_path, 'test_trigger')
+          )
+          cleaner.send(:packaging_folder_dirty?).should be_false
+        end
+      end
+    end
+  end
+
+  describe '#tmp_path_package_files' do
+    before do
+      cleaner.instance_variable_set(:@model, model)
+      FileUtils.unstub(:mkdir_p)
+      FileUtils.unstub(:touch)
+    end
+
+    after do
+      Backup::Config.send(:reset!)
+    end
+
+    context 'when packaging files exist in the tmp_path' do
+      it 'should return the files' do
+        Dir.mktmpdir do |path|
+          Backup::Config.update(:root_path => path)
+          FileUtils.mkdir_p(Backup::Config.tmp_path)
+
+          package_files = [
+            '2012.01.06.12.05.30.test_trigger.tar',
+            '2012.02.06.12.05.30.test_trigger.tar-aa',
+            '2012.03.06.12.05.30.test_trigger.tar.enc',
+            '2012.04.06.12.05.30.test_trigger.tar.enc-aa'
+          ].map! {|f| File.join(Backup::Config.tmp_path, f) }
+
+          other_files = [
+            '2012.01.06.12.05.30.test_trigger.target.tar',
+            '2012.01.06.12.05.30.other_trigger.tar',
+            'foo.tar'
+          ].map! {|f| File.join(Backup::Config.tmp_path, f) }
+
+          FileUtils.touch(package_files + other_files)
+          Dir[File.join(Backup::Config.tmp_path, '*')].count.should be(7)
+
+          cleaner.send(:tmp_path_package_files).sort.should == package_files
+        end
+      end
+    end
+
+    context 'when no packaging files exist in the tmp_path' do
+      it 'should return an empty array' do
+        Dir.mktmpdir do |path|
+          Backup::Config.update(:root_path => path)
+          FileUtils.mkdir_p(Backup::Config.tmp_path)
+
+          other_files = [
+            '2012.01.06.12.05.30.test_trigger.target.tar',
+            '2012.01.06.12.05.30.other_trigger.tar',
+            'foo.tar'
+          ].map! {|f| File.join(Backup::Config.tmp_path, f) }
+
+          FileUtils.touch(other_files)
+          Dir[File.join(Backup::Config.tmp_path, '*')].count.should be(3)
+
+          cleaner.send(:tmp_path_package_files).should == []
+        end
+      end
+    end
+  end
+
+end