backup 2.4.5.1 → 3.0.0.build.0

data/spec/configuration/storage/s3_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Backup::Configuration::Storage::S3 do
+  before do
+    Backup::Configuration::Storage::S3.defaults do |s3|
+      s3.access_key_id      = 'my_access_key_id'
+      s3.secret_access_key  = 'my_secret_access_key'
+      s3.region             = 'us-east-1'
+      s3.bucket             = 'my-bucket'
+      s3.path               = 'my_backups'
+    end
+  end
+
+  it 'should set the default S3 configuration' do
+    s3 = Backup::Configuration::Storage::S3
+    s3.access_key_id.should     == 'my_access_key_id'
+    s3.secret_access_key.should == 'my_secret_access_key'
+    s3.region.should            == 'us-east-1'
+    s3.bucket.should            == 'my-bucket'
+    s3.path.should              == 'my_backups'
+  end
+
+  describe '#clear_defaults!' do
+    it 'should clear all the defaults, resetting them to nil' do
+      Backup::Configuration::Storage::S3.clear_defaults!
+
+      s3 = Backup::Configuration::Storage::S3
+      s3.access_key_id.should     == nil
+      s3.secret_access_key.should == nil
+      s3.region.should            == nil
+      s3.bucket.should            == nil
+      s3.path.should              == nil
+    end
+  end
+end

data/spec/configuration/storage/scp_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Backup::Configuration::Storage::SCP do
+  before do
+    Backup::Configuration::Storage::SCP.defaults do |scp|
+      scp.username  = 'my_username'
+      scp.password  = 'my_password'
+      scp.ip        = '123.45.678.90'
+      scp.port      = 21
+      scp.path      = 'my_backups'
+      scp.keep      = 20
+    end
+  end
+
+  it 'should set the default scp configuration' do
+    scp = Backup::Configuration::Storage::SCP
+    scp.username.should == 'my_username'
+    scp.password.should == 'my_password'
+    scp.ip.should       == '123.45.678.90'
+    scp.port.should     == 21
+    scp.path.should     == 'my_backups'
+    scp.keep.should     == 20
+  end
+
+  describe '#clear_defaults!' do
+    it 'should clear all the defaults, resetting them to nil' do
+      Backup::Configuration::Storage::SCP.clear_defaults!
+
+      scp = Backup::Configuration::Storage::SCP
+      scp.username.should == nil
+      scp.password.should == nil
+      scp.ip.should       == nil
+      scp.port.should     == nil
+      scp.path.should     == nil
+      scp.keep.should     == nil
+    end
+  end
+end

data/spec/configuration/storage/sftp_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Backup::Configuration::Storage::SFTP do
+  before do
+    Backup::Configuration::Storage::SFTP.defaults do |sftp|
+      sftp.username  = 'my_username'
+      sftp.password  = 'my_password'
+      sftp.ip        = '123.45.678.90'
+      sftp.port      = 22
+      sftp.path      = 'my_backups'
+      sftp.keep      = 20
+    end
+  end
+
+  it 'should set the default sftp configuration' do
+    sftp = Backup::Configuration::Storage::SFTP
+    sftp.username.should == 'my_username'
+    sftp.password.should == 'my_password'
+    sftp.ip.should       == '123.45.678.90'
+    sftp.port.should     == 22
+    sftp.path.should     == 'my_backups'
+    sftp.keep.should     == 20
+  end
+
+  describe '#clear_defaults!' do
+    it 'should clear all the defaults, resetting them to nil' do
+      Backup::Configuration::Storage::SFTP.clear_defaults!
+
+      sftp = Backup::Configuration::Storage::SFTP
+      sftp.username.should == nil
+      sftp.password.should == nil
+      sftp.ip.should       == nil
+      sftp.port.should     == nil
+      sftp.path.should     == nil
+      sftp.keep.should     == nil
+    end
+  end
+end

data/spec/database/base_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Database::Base do
+
+  before do
+    class Backup::Database::Base
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
+    end
+  end
+
+  let(:db) do
+    Backup::Database::Base.new do |db|
+      db.utility_path = '/var/usr/my_util'
+    end
+  end
+
+  it 'should return the utility path instead of auto-detecting it' do
+    db.utility(:my_database_util).should == '/var/usr/my_util'
+  end
+
+  it 'should ignore the utility_path when not defined' do
+    db = Backup::Database::Base.new
+    db.utility(:my_database_util).should == :my_database_util
+  end
+
+end

data/spec/database/mongodb_spec.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Database::MongoDB do
+
+  before do
+    Backup::Database::MongoDB.any_instance.stubs(:load_defaults!)
+  end
+
+  let(:db) do
+    Backup::Database::MongoDB.new do |db|
+      db.name      = 'mydatabase'
+      db.username  = 'someuser'
+      db.password  = 'secret'
+      db.host      = 'localhost'
+      db.port      = 123
+
+      db.ipv6               = true
+      db.only_collections   = ['users', 'pirates']
+      db.additional_options = ['--query']
+    end
+  end
+
+  describe '#new' do
+    it 'should read the adapter details correctly' do
+      db.name.should      == 'mydatabase'
+      db.username.should  == 'someuser'
+      db.password.should  == 'secret'
+      db.host.should      == 'localhost'
+      db.port.should      == 123
+
+      db.only_collections.should == ['users', 'pirates']
+      db.additional_options.should == '--query'
+    end
+
+    it 'arrays should default to empty arrays when not specified' do
+      db = Backup::Database::MongoDB.new do |db|
+        db.name     = 'mydatabase'
+        db.username = 'someuser'
+        db.password = 'secret'
+      end
+
+      db.only_collections.should   == []
+      db.additional_options.should == ""
+    end
+
+    it 'should ensure the directory is available' do
+      Backup::Database::MongoDB.any_instance.expects(:mkdir).with("#{Backup::TMP_PATH}/myapp/MongoDB")
+      Backup::Database::MongoDB.new {}
+    end
+  end
+
+  describe '#only_collections' do
+    it 'should return a string for the mongodump selected table to dump option' do
+      db.collections_to_dump.should == %w[users pirates]
+    end
+  end
+
+  describe '#credential_options' do
+    it 'should return the mongo syntax for the credential options' do
+      db.credential_options.should == "--username='someuser' --password='secret'"
+    end
+
+    it 'should only return the mongo syntax for the user' do
+      db = Backup::Database::MongoDB.new do |db|
+        db.username = 'someuser'
+      end
+
+      db.credential_options.should == "--username='someuser'"
+    end
+  end
+
+  describe '#connectivity_options' do
+    it 'should return the mongo syntax for the connectivity options' do
+      db.connectivity_options.should == "--host='localhost' --port='123'"
+    end
+
+    it 'should return only the socket' do
+      db = Backup::Database::MongoDB.new do |db|
+        db.host   = ''
+        db.port   = 123
+      end
+
+      db.connectivity_options.should == "--port='123'"
+    end
+  end
+
+  describe '#ipv6' do
+    it 'should return a mongodb syntax compatible ipv6 flag' do
+      db.ipv6 = true
+      db.ipv6.should == '--ipv6'
+    end
+
+    it 'should return an empty string' do
+      db.ipv6 = nil
+      db.ipv6.should == ''
+    end
+  end
+
+  describe '#mongodump_string' do
+    it 'should return the full mongodump string' do
+      db.expects(:utility).with(:mongodump).returns('mongodump')
+      db.mongodump.should ==
+      "mongodump --db='mydatabase' --username='someuser' --password='secret' " +
+      "--host='localhost' --port='123' --ipv6 --query --out='#{ File.join(Backup::TMP_PATH, Backup::TRIGGER, 'MongoDB') }'"
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      Backup::Logger.stubs(:message)
+      db.stubs(:utility).returns('mongodump')
+      db.stubs(:mkdir)
+      db.stubs(:run)
+    end
+
+    it 'should run the mongodump command and dump all collections' do
+      db.only_collections = []
+      db.expects(:dump!)
+
+      db.perform!
+    end
+
+    it 'should run the mongodump command and dump all collections' do
+      db.only_collections = nil
+      db.expects(:dump!)
+
+      db.perform!
+    end
+
+    it 'should dump only the provided collections' do
+      db.only_collections = %w[users admins profiles]
+      db.expects(:specific_collection_dump!)
+
+      db.perform!
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Database::MongoDB started dumping and archiving \"mydatabase\".")
+      db.perform!
+    end
+  end
+end

data/spec/database/mysql_spec.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Database::MySQL do
+
+  before do
+    Backup::Database::MySQL.any_instance.stubs(:load_defaults!)
+  end
+
+  let(:db) do
+    Backup::Database::MySQL.new do |db|
+      db.name      = 'mydatabase'
+      db.username  = 'someuser'
+      db.password  = 'secret'
+      db.host      = 'localhost'
+      db.port      = '123'
+      db.socket    = '/mysql.sock'
+
+      db.skip_tables = ['logs', 'profiles']
+      db.only_tables = ['users', 'pirates']
+      db.additional_options = ['--single-transaction', '--quick']
+    end
+  end
+
+  describe '#new' do
+    it 'should read the adapter details correctly' do
+      db.name.should      == 'mydatabase'
+      db.username.should  == 'someuser'
+      db.password.should  == 'secret'
+      db.host.should      == 'localhost'
+      db.port.should      == '123'
+      db.socket.should    == '/mysql.sock'
+
+      db.skip_tables.should == ['logs', 'profiles']
+      db.only_tables.should == ['users', 'pirates']
+      db.additional_options.should == ['--single-transaction', '--quick']
+    end
+
+    it 'arrays should default to empty arrays when not specified' do
+      db = Backup::Database::MySQL.new do |db|
+        db.name     = 'mydatabase'
+        db.username = 'someuser'
+        db.password = 'secret'
+      end
+
+      db.skip_tables.should == []
+      db.only_tables.should == []
+      db.additional_options.should == []
+    end
+
+    it 'should ensure the directory is available' do
+      Backup::Database::MySQL.any_instance.expects(:mkdir).with("#{Backup::TMP_PATH}/myapp/MySQL")
+      Backup::Database::MySQL.new {}
+    end
+  end
+
+  describe '#skip_tables' do
+    it 'should return a string for the mysqldump --ignore-tables option' do
+      db.tables_to_skip.should == "--ignore-table='mydatabase.logs'\s--ignore-table='mydatabase.profiles'"
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::MySQL.new {}
+      db.tables_to_skip.should == ""
+    end
+  end
+
+  describe '#only_tables' do
+    it 'should return a string for the mysqldump selected table to dump option' do
+      db.tables_to_dump.should == "users\spirates"
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::MySQL.new {}
+      db.tables_to_dump.should == ""
+    end
+  end
+
+  describe '#credential_options' do
+    it 'should return the mysql syntax for the credential options' do
+      db.credential_options.should == "--user='someuser' --password='secret'"
+    end
+
+    it 'should only return the mysql syntax for the user' do
+      db = Backup::Database::MySQL.new do |db|
+        db.username = 'someuser'
+      end
+
+      db.credential_options.should == "--user='someuser'"
+    end
+  end
+
+  describe '#connectivity_options' do
+    it 'should return the mysql syntax for the connectivity options' do
+      db.connectivity_options.should == "--host='localhost' --port='123' --socket='/mysql.sock'"
+    end
+
+    it 'should return only the socket' do
+      db = Backup::Database::MySQL.new do |db|
+        db.host   = ''
+        db.port   = nil
+        db.socket = '/mysql.sock'
+      end
+
+      db.connectivity_options.should == "--socket='/mysql.sock'"
+    end
+  end
+
+  describe '#additional_options' do
+    it 'should return a string of additional options specified by the user' do
+      db.options.should == '--single-transaction --quick'
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::MySQL.new {}
+      db.options.should == ""
+    end
+  end
+
+  describe '#mysqldump_string' do
+    it 'should return the full mysqldump string' do
+      db.expects(:utility).with(:mysqldump).returns('mysqldump')
+      db.mysqldump.should ==
+      "mysqldump --user='someuser' --password='secret' " +
+      "--host='localhost' --port='123' --socket='/mysql.sock' " +
+      "--single-transaction --quick mydatabase users pirates " +
+      "--ignore-table='mydatabase.logs' --ignore-table='mydatabase.profiles'"
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      Backup::Logger.stubs(:message)
+      db.stubs(:utility).returns('mysqldump')
+      db.stubs(:mkdir)
+      db.stubs(:run)
+    end
+
+    it 'should run the mysqldump command and dump it to the specified path' do
+      db.expects(:run).with("#{db.mysqldump} > '#{Backup::TMP_PATH}/myapp/MySQL/mydatabase.sql'")
+      db.perform!
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Database::MySQL started dumping and archiving \"mydatabase\".")
+      db.perform!
+    end
+  end
+end

data/spec/database/postgresql_spec.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Database::PostgreSQL do
+
+  before do
+    Backup::Database::PostgreSQL.any_instance.stubs(:load_defaults!)
+  end
+
+  let(:db) do
+    Backup::Database::PostgreSQL.new do |db|
+      db.name      = 'mydatabase'
+      db.username  = 'someuser'
+      db.password  = 'secret'
+      db.host      = 'localhost'
+      db.port      = '123'
+      db.socket    = '/pg.sock'
+
+      db.skip_tables = ['logs', 'profiles']
+      db.only_tables = ['users', 'pirates']
+      db.additional_options = ['--single-transaction', '--quick']
+    end
+  end
+
+  describe '#new' do
+    it 'should read the adapter details correctly' do
+      db.name.should      == 'mydatabase'
+      db.username.should  == 'someuser'
+      db.password.should  == 'secret'
+      db.host.should      == 'localhost'
+      db.port.should      == '123'
+      db.socket.should    == '/pg.sock'
+
+      db.skip_tables.should == ['logs', 'profiles']
+      db.only_tables.should == ['users', 'pirates']
+      db.additional_options.should == ['--single-transaction', '--quick']
+    end
+
+    it 'arrays should default to empty arrays when not specified' do
+      db = Backup::Database::PostgreSQL.new do |db|
+        db.name     = 'mydatabase'
+        db.username = 'someuser'
+        db.password = 'secret'
+      end
+
+      db.skip_tables.should == []
+      db.only_tables.should == []
+      db.additional_options.should == []
+    end
+
+    it do
+      db = Backup::Database::PostgreSQL.new {}
+      db.username = ''
+
+      db.credential_options.should == ''
+    end
+
+    it do
+      db = Backup::Database::PostgreSQL.new {}
+      db.username = nil
+
+      db.credential_options.should == ''
+    end
+
+    it 'should ensure the directory is available' do
+      Backup::Database::PostgreSQL.any_instance.expects(:mkdir).with("#{Backup::TMP_PATH}/myapp/PostgreSQL")
+      Backup::Database::PostgreSQL.new {}
+    end
+  end
+
+  describe '#skip_tables' do
+    it 'should return a string for the pg_dump --ignore-tables option' do
+      db.tables_to_skip.should == "--exclude-table='logs' --exclude-table='profiles'"
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::PostgreSQL.new {}
+      db.tables_to_skip.should == ""
+    end
+  end
+
+  describe '#only_tables' do
+    it 'should return a string for the pg_dump selected table to dump option' do
+      db.tables_to_dump.should == "--table='users' --table='pirates'"
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::PostgreSQL.new {}
+      db.tables_to_dump.should == ""
+    end
+  end
+
+  describe '#credential_options' do
+    it 'should return the postgresql syntax for the credential options' do
+      db.credential_options.should == "--username='someuser'"
+    end
+
+    it 'should only return the postgresql syntax for the user' do
+      db = Backup::Database::PostgreSQL.new do |db|
+        db.username = 'someuser'
+      end
+
+      db.credential_options.should == "--username='someuser'"
+    end
+  end
+
+  describe '#connectivity_options' do
+    it 'should return the postgresql syntax for the connectivity options' do
+      db.connectivity_options.should == "--host='localhost' --port='123' --host='/pg.sock'"
+    end
+
+    it 'should return only the socket' do
+      db = Backup::Database::PostgreSQL.new do |db|
+        db.host   = ''
+        db.port   = nil
+        db.socket = '/pg.sock'
+      end
+
+      db.connectivity_options.should == "--host='/pg.sock'"
+    end
+  end
+
+  describe '#additional_options' do
+    it 'should return a string of additional options specified by the user' do
+      db.options.should == '--single-transaction --quick'
+    end
+
+    it 'should return an empty string' do
+      db = Backup::Database::PostgreSQL.new {}
+      db.options.should == ""
+    end
+  end
+
+  describe '#pg_dump_string' do
+    it 'should return the full pg_dump string' do
+      db.expects(:utility).with(:pg_dump).returns('pg_dump')
+      db.pgdump.should ==
+      "pg_dump --username='someuser' " +
+      "--host='localhost' --port='123' --host='/pg.sock' " +
+      "--single-transaction --quick --table='users' --table='pirates' " +
+      "--exclude-table='logs' --exclude-table='profiles' mydatabase"
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      Backup::Logger.stubs(:message)
+      db.stubs(:utility).returns('pg_dump')
+      db.stubs(:mkdir)
+      db.stubs(:run)
+    end
+
+    it 'should run the pg_dump command and dump it to the specified path' do
+      db.expects(:run).with("#{db.pgdump} > '#{Backup::TMP_PATH}/myapp/PostgreSQL/mydatabase.sql'")
+      db.perform!
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Database::PostgreSQL started dumping and archiving \"mydatabase\".")
+      db.perform!
+    end
+  end
+end