alg-backup 3.0.10

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

data/spec/database/redis_spec.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Database::Redis do
+
+  before do
+    Backup::Database::Redis.any_instance.stubs(:load_defaults!)
+    Backup::Logger.stubs(:error)
+  end
+
+  let(:db) do
+    Backup::Database::Redis.new do |db|
+      db.name        = 'mydatabase'
+      db.path        = '/var/lib/redis/db/'
+      db.password    = 'secret'
+      db.host        =  'localhost'
+      db.port        = 123
+      db.socket      = '/redis.sock'
+      db.invoke_save = true
+
+      db.additional_options = ['--query']
+    end
+  end
+
+  describe '#new' do
+    it 'should read the adapter details correctly' do
+      db.name.should        == 'mydatabase'
+      db.password.should    == 'secret'
+      db.host.should        == 'localhost'
+      db.port.should        == 123
+      db.socket.should      == '/redis.sock'
+      db.invoke_save.should == true
+
+      db.additional_options.should == '--query'
+    end
+
+    it 'arrays should default to empty arrays when not specified' do
+      db = Backup::Database::Redis.new do |db|
+        db.name     = 'mydatabase'
+        db.password = 'secret'
+      end
+
+      db.additional_options.should == ""
+    end
+
+    it 'should ensure the directory is available' do
+      Backup::Database::Redis.any_instance.expects(:mkdir).with("#{Backup::TMP_PATH}/myapp/Redis")
+      Backup::Database::Redis.new {}
+    end
+  end
+
+  describe '#credential_options' do
+    it 'should return the mongo syntax for the credential options' do
+      db.credential_options.should == "-a 'secret'"
+    end
+  end
+
+  describe '#connectivity_options' do
+    it 'should return the redis syntax for the connectivity options' do
+      db.connectivity_options.should == "-h 'localhost' -p '123' -s '/redis.sock'"
+    end
+
+    it 'should return only the port' do
+      db = Backup::Database::Redis.new do |db|
+        db.host   = nil
+        db.port   = 123
+      end
+
+      db.connectivity_options.should == "-p '123'"
+    end
+  end
+
+  describe '#invoke_save!' do
+    it 'should return the full mongodump string' do
+      db.expects(:utility).with('redis-cli').returns('redis-cli')
+      db.expects(:run).with("redis-cli -a 'secret' -h 'localhost' -p '123' -s '/redis.sock' --query SAVE")
+      db.invoke_save!
+    end
+  end
+
+  describe '#copy!' do
+    it do
+      File.expects(:exist?).returns(true)
+      db.stubs(:utility).returns('cp')
+      db.expects(:run).with("cp '#{ File.join('/var/lib/redis/db/mydatabase.rdb') }' '#{ File.join(Backup::TMP_PATH, Backup::TRIGGER, 'Redis', 'mydatabase.rdb') }'")
+      db.copy!
+    end
+  end
+
+  describe '#perform!' do
+    before do
+      Backup::Logger.stubs(:message)
+      File.stubs(:exist?).returns(true)
+      db.stubs(:utility).returns('redis-cli')
+      db.stubs(:mkdir)
+      db.stubs(:run)
+    end
+
+    it 'should copy over without persisting (saving) first' do
+      db.invoke_save = nil
+      db.expects(:invoke_save!).never
+      db.expects(:copy!)
+
+      db.perform!
+    end
+
+    it 'should copy over after persisting (saving) the most recent updates' do
+      db.invoke_save = true
+      db.expects(:invoke_save!)
+      db.expects(:copy!)
+
+      db.perform!
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Database::Redis started dumping and archiving \"mydatabase\".")
+
+      db.perform!
+    end
+  end
+end

data/spec/encryptor/gpg_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Encryptor::GPG do
+
+  let(:encryptor) do
+    Backup::Encryptor::GPG.new do |e|
+      e.key = <<-KEY
+        -----BEGIN PGP PUBLIC KEY BLOCK-----
+        Version: GnuPG v1.4.11 (Darwin)
+
+        mQENBE12G/8BCAC4mnlSMYMBwBYTHe5zURcnYYNCORPWOr0iXGiLWuKxYtrDQyLm
+        X2Nws44Iz7Wp7AuJRAjkitf1cRBgXyDu8wuogXO7JqPmtsUdBCABz9w5NH6IQjgR
+        WNa3g2n0nokA7Zr5FA4GXoEaYivfbvGiyNpd6P4okH+//G2p+3FIryu5xz+89D1b
+        =Yvhg
+        -----END PGP PUBLIC KEY BLOCK-----
+      KEY
+    end
+  end
+
+  context "when a block is provided" do
+    it do
+      key = <<-KEY
+        -----BEGIN PGP PUBLIC KEY BLOCK-----
+        Version: GnuPG v1.4.11 (Darwin)
+
+        mQENBE12G/8BCAC4mnlSMYMBwBYTHe5zURcnYYNCORPWOr0iXGiLWuKxYtrDQyLm
+        X2Nws44Iz7Wp7AuJRAjkitf1cRBgXyDu8wuogXO7JqPmtsUdBCABz9w5NH6IQjgR
+        WNa3g2n0nokA7Zr5FA4GXoEaYivfbvGiyNpd6P4okH+//G2p+3FIryu5xz+89D1b
+        =Yvhg
+        -----END PGP PUBLIC KEY BLOCK-----
+      KEY
+
+      encryptor.key.should == key.gsub(/^(\s|\t)+/, '')
+    end
+  end
+
+  describe '#options' do
+    it do
+      encryptor.expects(:encryption_key_id).returns('secret')
+      encryptor.send(:options).should == "-e --trust-model always -r 'secret'"
+    end
+  end
+
+  describe '#write_tmp_file!' do
+    it do
+      tmp_file = mock('TmpFile')
+      Tempfile.expects(:new).returns(tmp_file)
+      tmp_file.expects(:write).with('secret')
+      tmp_file.expects(:close)
+
+      encryptor.key = 'secret'
+      encryptor.send(:write_tmp_file!)
+    end
+  end
+end

data/spec/encryptor/open_ssl_spec.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Backup::Encryptor::OpenSSL do
+
+  context "when no block is provided" do
+    let(:encryptor) { Backup::Encryptor::OpenSSL.new }
+
+    it do
+      encryptor.password.should == nil
+    end
+
+    it do
+      encryptor.send(:base64).should == []
+    end
+
+    it do
+      encryptor.send(:salt).should == []
+    end
+
+    it do
+      encryptor.send(:options).should == "aes-256-cbc"
+    end
+  end
+
+  context "when a block is provided" do
+    let(:encryptor) do
+      Backup::Encryptor::OpenSSL.new do |e|
+        e.password = "my_secret_password"
+        e.salt     = true
+        e.base64   = true
+      end
+    end
+
+    it do
+      encryptor.password.should == "my_secret_password"
+    end
+
+    it do
+      encryptor.send(:salt).should == ['-salt']
+    end
+
+    it do
+      encryptor.send(:base64).should == ['-base64']
+    end
+
+    it do
+      encryptor.send(:options).should == "aes-256-cbc -base64 -salt"
+    end
+  end
+
+  describe '#perform!' do
+    let(:encryptor) { Backup::Encryptor::OpenSSL.new }
+    before do
+      Backup::Model.extension = 'tar'
+      Backup::Logger.stubs(:message)
+      [:utility, :run, :rm].each { |method| encryptor.stubs(method) }
+    end
+
+    it do
+      encryptor = Backup::Encryptor::OpenSSL.new
+      encryptor.expects(:utility).returns(:openssl)
+      encryptor.expects(:run).with("openssl aes-256-cbc -in '#{ File.join(Backup::TMP_PATH, "#{Backup::TIME}.#{Backup::TRIGGER}.tar") }' -out '#{ File.join(Backup::TMP_PATH, "#{Backup::TIME}.#{Backup::TRIGGER}.tar.enc") }' -k ''")
+      encryptor.perform!
+    end
+
+    it do
+      encryptor = Backup::Encryptor::OpenSSL.new do |e|
+        e.password = "my_secret_password"
+        e.salt     = true
+        e.base64   = true
+      end
+      encryptor.stubs(:utility).returns(:openssl)
+      encryptor.expects(:run).with("openssl aes-256-cbc -base64 -salt -in '#{ File.join(Backup::TMP_PATH, "#{Backup::TIME}.#{Backup::TRIGGER}.tar") }' -out '#{ File.join(Backup::TMP_PATH, "#{Backup::TIME}.#{Backup::TRIGGER}.tar.enc") }' -k 'my_secret_password'")
+      encryptor.perform!
+    end
+
+    it 'should append the .enc extension after the encryption' do
+      Backup::Model.extension.should == 'tar'
+      encryptor.perform!
+      Backup::Model.extension.should == 'tar.enc'
+    end
+
+    it do
+      encryptor.expects(:utility).with(:openssl)
+      encryptor.perform!
+    end
+
+    it do
+      Backup::Logger.expects(:message).with("Backup::Encryptor::OpenSSL started encrypting the archive.")
+      encryptor.perform!
+    end
+
+    context "after encrypting the file (which creates a new file)" do
+      it 'should remove the non-encrypted file' do
+        encryptor.expects(:rm).with(Backup::Model.file)
+        encryptor.perform!
+      end
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'timecop'
+
+describe Backup::Logger do
+  before do
+    Timecop.freeze( Time.now )
+  end
+
+  context 'when logging regular messages' do
+    it do
+      Backup::Logger.expects(:puts).with("[#{ Time.now.strftime("%Y/%m/%d %H:%M:%S") }][\e[32mmessage\e[0m] This has been logged.")
+      File.expects(:open).with(File.join(Backup::LOG_PATH, 'backup.log'), 'a')
+
+      Backup::Logger.message "This has been logged."
+    end
+  end
+
+  context 'when logging error messages' do
+    it do
+      Backup::Logger.expects(:puts).with("[#{ Time.now.strftime("%Y/%m/%d %H:%M:%S") }][\e[31merror\e[0m] This has been logged.")
+      File.expects(:open).with(File.join(Backup::LOG_PATH, 'backup.log'), 'a')
+
+      Backup::Logger.error "This has been logged."
+    end
+  end
+
+  context 'when logging warn messages' do
+    it do
+      Backup::Logger.expects(:puts).with("[#{ Time.now.strftime("%Y/%m/%d %H:%M:%S") }][\e[33mwarning\e[0m] This has been logged.")
+      File.expects(:open).with(File.join(Backup::LOG_PATH, 'backup.log'), 'a')
+
+      Backup::Logger.warn "This has been logged."
+    end
+  end
+
+  context 'when logging silent messages' do
+    it do
+      Backup::Logger.expects(:puts).never
+      File.expects(:open).with(File.join(Backup::LOG_PATH, 'backup.log'), 'a')
+
+      Backup::Logger.silent "This has been logged."
+    end
+  end
+end