webtranslateit-safe 0.4.0

data/spec/webtranslateit/safe/config_spec.rb

@@ -0,0 +1,307 @@
+require 'spec_helper'
+
+describe WebTranslateIt::Safe::Config do
+  it 'parses example config' do
+    config = WebTranslateIt::Safe::Config::Node.new do
+
+      dry_run false
+      local_only true
+      verbose true
+
+      local do
+        path 'path'
+      end
+
+      s3 do
+        key 's3 key'
+        secret 'secret'
+        bucket 'bucket'
+        path 'path1'
+      end
+
+      sftp do
+        user 'sftp user'
+        password 'sftp password'
+        host 'sftp host'
+      end
+
+      gpg do
+        password 'astrails'
+        key 'gpg-key'
+      end
+
+      keep do
+        s3 20
+        local 4
+      end
+
+      mysqldump do
+        options '-ceKq --single-transaction --create-options'
+
+        user 'astrails'
+        password ''
+        host 'localhost'
+        port 3306
+        socket '/var/run/mysqld/mysqld.sock'
+
+        database :blog
+
+        database :production do
+          keep local: 3
+
+          gpg do
+            password 'custom-production-pass'
+          end
+
+          skip_tables [:logger_exceptions, :request_logs]
+        end
+
+      end
+
+      pgdump do
+        options '-i -x -O'
+
+        user 'astrails'
+        password ''
+        host 'localhost'
+        port 5432
+
+        database :blog
+
+        database :production do
+          keep local: 3
+
+          skip_tables [:logger_exceptions, :request_logs]
+        end
+
+      end
+
+      svndump do
+        repo :my_repo do
+          repo_path '/home/svn/my_repo'
+        end
+      end
+
+      tar do
+        archive 'git-repositories' do
+          files '/home/git/repositories'
+        end
+
+        archive 'etc-files' do
+          files '/etc'
+          exclude '/etc/puppet/other'
+        end
+
+        archive 'dot-configs' do
+          files '/home/*/.[^.]*'
+        end
+
+        archive 'blog' do
+          files '/var/www/blog.astrails.com/'
+          exclude ['/var/www/blog.astrails.com/log', '/var/www/blog.astrails.com/tmp']
+        end
+
+        archive :misc do
+          files ['/backup/*.rb']
+        end
+      end
+
+      mongodump do
+        host 'host'
+        database 'database'
+        user 'user'
+        password 'password'
+      end
+    end
+
+    expected = {
+      'dry_run' => false,
+      'local_only' => true,
+      'verbose' => true,
+
+      'local' => {'path' => 'path'},
+
+      's3' => {
+        'key' => 's3 key',
+        'secret' => 'secret',
+        'bucket' => 'bucket',
+        'path' => 'path1'
+      },
+
+      'sftp' => {
+        'user' => 'sftp user',
+        'password' => 'sftp password',
+        'host' => 'sftp host'
+      },
+
+      'gpg' => {'password' => 'astrails', 'key' => 'gpg-key'},
+
+      'keep' => {'s3' => 20, 'local' => 4},
+
+      'mysqldump' => {
+        'options' => '-ceKq --single-transaction --create-options',
+        'user' => 'astrails',
+        'password' => '',
+        'host' => 'localhost',
+        'port' => 3306,
+        'socket' => '/var/run/mysqld/mysqld.sock',
+
+        'databases' => {
+          'blog' => {},
+          'production' => {
+            'keep' => {'local' => 3},
+            'gpg' => {'password' => 'custom-production-pass'},
+            'skip_tables' => ['logger_exceptions', 'request_logs']
+          }
+        }
+      },
+
+      'pgdump' => {
+        'options' => '-i -x -O',
+        'user' => 'astrails',
+        'password' => '',
+        'host' => 'localhost',
+        'port' => 5432,
+
+        'databases' => {
+          'blog' => {},
+          'production' => {
+            'keep' => {'local' => 3},
+            'skip_tables' => ['logger_exceptions', 'request_logs']
+          }
+        }
+      },
+
+      'svndump' => {
+        'repos' => {
+          'my_repo' => {
+            'repo_path' => '/home/svn/my_repo'
+          }
+        }
+      },
+
+      'tar' => {
+        'archives' => {
+          'git-repositories' => {'files' => ['/home/git/repositories']},
+          'etc-files' => {'files' => ['/etc'], 'exclude' => ['/etc/puppet/other']},
+          'dot-configs' => {'files' => ['/home/*/.[^.]*']},
+          'blog' => {
+            'files' => ['/var/www/blog.astrails.com/'],
+            'exclude' => ['/var/www/blog.astrails.com/log', '/var/www/blog.astrails.com/tmp']
+          },
+          'misc' => {'files' => ['/backup/*.rb']}
+        }
+      },
+
+      'mongodump' => {
+        'host' => 'host',
+        'databases' => {
+          'database' => {}
+        },
+        'user' => 'user',
+        'password' => 'password'
+      }
+    }
+
+    config.to_hash.should == expected
+  end
+
+  it 'makes an array from multivalues' do
+    config = WebTranslateIt::Safe::Config::Node.new do
+      skip_tables 'a'
+      skip_tables 'b'
+      files '/foo'
+      files '/bar'
+      exclude '/foo/bar'
+      exclude '/foo/bar/baz'
+    end
+
+    expected = {
+      'skip_tables' => ['a', 'b'],
+      'files' => ['/foo', '/bar'],
+      'exclude' => ['/foo/bar', '/foo/bar/baz']
+    }
+
+    config.to_hash.should == expected
+  end
+
+  it 'raises error on key duplication' do
+    proc do
+      WebTranslateIt::Safe::Config::Node.new do
+        path 'foo'
+        path 'bar'
+      end
+    end.should raise_error(ArgumentError, "duplicate value for 'path'")
+  end
+
+  it 'accepts hash as data' do
+    WebTranslateIt::Safe::Config::Node.new do
+      tar do
+        archive 'blog', files: 'foo', exclude: ['aaa', 'bbb']
+      end
+    end.to_hash.should == {
+      'tar' => {
+        'archives' => {
+          'blog' => {
+            'files' => ['foo'],
+            'exclude' => ['aaa', 'bbb']
+          }
+        }
+      }
+    }
+  end
+
+  it 'accepts hash as data and a block' do
+    WebTranslateIt::Safe::Config::Node.new do
+      tar do
+        archive 'blog', files: 'foo' do
+          exclude ['aaa', 'bbb']
+        end
+      end
+    end.to_hash.should == {
+      'tar' => {
+        'archives' => {
+          'blog' => {
+            'files' => ['foo'],
+            'exclude' => ['aaa', 'bbb']
+          }
+        }
+      }
+    }
+  end
+
+  it 'accepts multiple levels of data hash' do
+    config = WebTranslateIt::Safe::Config::Node.new nil, tar: {
+      s3: {bucket: '_bucket', key: '_key', secret: '_secret'},
+      keep: {s3: 2}
+    }
+
+    config.to_hash.should == {
+      'tar' => {
+        's3' => {'bucket' => '_bucket', 'key' => '_key', 'secret' => '_secret'},
+        'keep' => {'s3' => 2}
+      }
+    }
+  end
+
+  it 'sets multi value as array' do
+    config = WebTranslateIt::Safe::Config::Node.new do
+      tar do
+        archive 'foo' do
+          files 'bar'
+        end
+      end
+    end
+
+    config.to_hash.should == {
+      'tar' => {
+        'archives' => {
+          'foo' => {
+            'files' => ['bar']
+          }
+        }
+      }
+    }
+  end
+
+end

data/spec/webtranslateit/safe/gpg_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe WebTranslateIt::Safe::Gpg do
+  def def_backup
+    {
+      compressed: false,
+      command: 'command',
+      extension: '.foo',
+      filename: 'qweqwe'
+    }
+  end
+
+  def gpg(config = {}, backup = def_backup)
+    WebTranslateIt::Safe::Gpg.new(
+      WebTranslateIt::Safe::Config::Node.new(nil, config),
+      WebTranslateIt::Safe::Backup.new(backup)
+    )
+  end
+
+  after(:each) { WebTranslateIt::Safe::TmpFile.cleanup }
+
+  describe :process do
+
+    before(:each) do
+      @gpg = gpg
+      stub(@gpg).gpg_password_file { 'pwd-file' }
+      stub(@gpg).pipe { '|gpg -BLAH' }
+    end
+
+    describe 'when active' do
+      before(:each) do
+        stub(@gpg).active? { true }
+      end
+
+      it 'adds .gpg extension' do
+        mock(@gpg.backup.extension) << '.gpg'
+        @gpg.process
+      end
+
+      it 'adds command pipe' do
+        mock(@gpg.backup.command) << (/\|gpg -BLAH/)
+        @gpg.process
+      end
+
+      it 'sets compressed' do
+        mock(@gpg.backup).compressed = true
+        @gpg.process
+      end
+    end
+
+    describe 'when inactive' do
+      before(:each) do
+        stub(@gpg).active? { false }
+      end
+
+      it 'does not touch extension' do
+        dont_allow(@gpg.backup.extension) << anything
+        @gpg.process
+      end
+
+      it 'does not touch command' do
+        dont_allow(@gpg.backup.command) << anything
+        @gpg.process
+      end
+
+      it 'does not touch compressed' do
+        dont_allow(@gpg.backup).compressed = anything
+        @gpg.process
+      end
+    end
+  end
+
+  describe :active? do
+
+    describe 'with key' do
+      it 'is true' do
+        expect(gpg(gpg: {key: :foo})).to be_active
+      end
+    end
+
+    describe 'with password' do
+      it 'is true' do
+        expect(gpg(gpg: {password: :foo})).to be_active
+      end
+    end
+
+    describe 'without key & password' do
+      it 'is false' do
+        expect(gpg).not_to be_active
+      end
+    end
+
+    describe 'with key & password' do
+      it 'raises RuntimeError' do
+        lambda {
+          gpg(gpg: {key: 'foo', password: 'bar'}).send :active?
+        }.should raise_error(RuntimeError, "can't use both gpg password and pubkey")
+      end
+    end
+  end
+
+  describe :pipe do
+
+    describe 'with key' do
+      def kgpg(extra = {})
+        gpg({gpg: {key: 'foo', options: 'GPG-OPT'}.merge(extra), options: 'OPT'})
+      end
+
+      it 'does not call gpg_password_file' do
+        g = kgpg
+        dont_allow(g).gpg_password_file(anything)
+        g.send(:pipe)
+      end
+
+      it "uses '-r' and :options" do
+        kgpg.send(:pipe).should == '|gpg GPG-OPT -e -r foo'
+      end
+
+      it "uses the 'command' options" do
+        kgpg(command: 'other-gpg').send(:pipe).should == '|other-gpg GPG-OPT -e -r foo'
+      end
+    end
+
+    describe 'with password' do
+      def pgpg(extra = {})
+        returning(gpg({gpg: {password: 'bar', options: 'GPG-OPT'}.merge(extra), options: 'OPT'})) do |g|
+          stub(g).gpg_password_file(anything) { 'pass-file' }
+        end
+      end
+
+      it "uses '--passphrase-file' and :options" do
+        pgpg.send(:pipe).should == '|gpg GPG-OPT -c --passphrase-file pass-file'
+      end
+
+      it "uses the 'command' options" do
+        pgpg(command: 'other-gpg').send(:pipe).should == '|other-gpg GPG-OPT -c --passphrase-file pass-file'
+      end
+    end
+  end
+
+  describe :gpg_password_file do
+    it 'creates password file' do
+      file = gpg.send(:gpg_password_file, 'foo')
+      expect(File.exist?(file)).to be true
+      File.read(file).should == 'foo'
+    end
+  end
+end

data/spec/webtranslateit/safe/gzip_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe WebTranslateIt::Safe::Gzip do
+
+  def def_backup
+    {
+      compressed: false,
+      command: 'command',
+      extension: '.foo',
+      filename: 'qweqwe'
+    }
+  end
+
+  after(:each) { WebTranslateIt::Safe::TmpFile.cleanup }
+
+  def gzip(config = {}, backup = def_backup)
+    WebTranslateIt::Safe::Gzip.new(
+      @config = WebTranslateIt::Safe::Config::Node.new(nil, config),
+      @backup = WebTranslateIt::Safe::Backup.new(backup)
+    )
+  end
+
+  describe :preocess do
+
+    describe 'when not yet compressed' do
+      before(:each) { @gzip = gzip }
+
+      it 'adds .gz extension' do
+        mock(@backup.extension) << '.gz'
+        @gzip.process
+      end
+
+      it 'adds |gzip pipe' do
+        mock(@backup.command) << '|gzip'
+        @gzip.process
+      end
+
+      it 'sets compressed' do
+        mock(@backup).compressed = true
+        @gzip.process
+      end
+    end
+
+    describe 'when already compressed' do
+
+      before(:each) { @gzip = gzip({}, extension: '.foo', command: 'foobar', compressed: true) }
+
+      it 'does not touch extension' do
+        @gzip.process
+        @backup.extension.should == '.foo'
+      end
+
+      it 'does not touch command' do
+        @gzip.process
+        @backup.command.should == 'foobar'
+      end
+
+      it 'does not touch compressed' do
+        @gzip.process
+        @backup.compressed.should == true
+      end
+    end
+  end
+end

data/spec/webtranslateit/safe/local_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe WebTranslateIt::Safe::Local do
+  def def_config
+    {
+      local: {
+        path: '/:kind~:id~:timestamp'
+      },
+      keep: {
+        local: 2
+      }
+    }
+  end
+
+  def def_backup
+    {
+      kind: 'mysqldump',
+      id: 'blog',
+      timestamp: 'NoW',
+      compressed: true,
+      command: 'command',
+      extension: '.foo.gz',
+      filename: 'qweqwe'
+    }
+  end
+
+  def local(config = def_config, backup = def_backup)
+    WebTranslateIt::Safe::Local.new(
+      @config = WebTranslateIt::Safe::Config::Node.new(nil, config),
+      @backup = WebTranslateIt::Safe::Backup.new(backup)
+    )
+  end
+
+  describe :active? do
+    it 'is true' do
+      expect(local).to be_active
+    end
+  end
+
+  describe :path do
+    it 'raises RuntimeError when no path' do
+      lambda {
+        local({}).send :path
+      }.should raise_error(RuntimeError, 'missing :local/:path')
+    end
+
+    it 'uses local/path' do
+      local.send(:path).should == '/mysqldump~blog~NoW'
+    end
+  end
+
+  describe :save do
+    before(:each) do
+      @local = local
+      stub(@local).system
+      stub(@local).full_path { 'file-path' }
+      stub(FileUtils).mkdir_p
+    end
+
+    it 'calls system to save the file' do
+      mock(@local).system('command>file-path')
+      @local.send(:save)
+    end
+
+    it 'creates directory' do
+      mock(FileUtils).mkdir_p('/mysqldump~blog~NoW')
+      @local.send(:save)
+    end
+
+    it 'sets backup.path' do
+      mock(@backup).path = 'file-path'
+      @local.send(:save)
+    end
+
+    describe 'dry run' do
+      before(:each) { @local.config[:dry_run] = true }
+
+      it 'should not create directory'
+      it 'should not call system'
+      it 'sets backup.path' do
+        mock(@backup).path = 'file-path'
+        @local.send(:save)
+      end
+    end
+  end
+
+  describe :cleanup do
+    before(:each) do
+      @files = [4, 1, 3, 2].map { |i| "/mysqldump~blog~NoW/qweqwe.#{i}" }
+      stub(File).file?(anything) { true }
+      stub(File).size(anything) { 1 }
+      stub(File).unlink
+    end
+
+    it 'checks [:keep, :local]' do
+      @local = local(def_config.merge(keep: {}))
+      dont_allow(Dir).[]
+      @local.send :cleanup
+    end
+
+    it 'deletes extra files' do
+      @local = local
+      mock(Dir).[]('/mysqldump~blog~NoW/qweqwe.*') { @files }
+      mock(File).unlink('/mysqldump~blog~NoW/qweqwe.1')
+      mock(File).unlink('/mysqldump~blog~NoW/qweqwe.2')
+      @local.send :cleanup
+    end
+  end
+end

data/spec/webtranslateit/safe/mongodump_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe WebTranslateIt::Safe::Mongodump do
+  def def_config
+    {
+      host: 'prod.example.com',
+      user: 'testuser',
+      password: 'p4ssw0rd'
+    }
+  end
+
+  def mongodump(id = :foo, config = def_config)
+    WebTranslateIt::Safe::Mongodump.new(id, WebTranslateIt::Safe::Config::Node.new(nil, config))
+  end
+
+  before(:each) do
+    stub(Time).now.stub!.strftime { 'NOW' }
+    @output_folder = File.join(WebTranslateIt::Safe::TmpFile.tmproot, 'mongodump')
+  end
+
+  after(:each) { WebTranslateIt::Safe::TmpFile.cleanup }
+
+  describe :backup do
+    before(:each) do
+      @mongo = mongodump
+    end
+
+    {
+      id: 'foo',
+      kind: 'mongodump',
+      extension: '.tar',
+      filename: 'mongodump-foo.NOW'
+    }.each do |k, v|
+      it "sets #{k} to #{v}" do
+        @mongo.backup.send(k).should == v
+      end
+    end
+
+    it 'sets the command' do
+      @mongo.backup.send(:command).should == "mongodump -q \"{xxxx : { \\$ne : 0 } }\" --db foo --host prod.example.com -u testuser -p p4ssw0rd --out #{@output_folder} && cd #{@output_folder} && tar cf - ."
+    end
+
+    {
+      host: '--host ',
+      user: '-u ',
+      password: '-p '
+    }.each do |key, v|
+      it "does not add #{key} to command if it is not present" do
+        @mongo = mongodump(:foo, def_config.reject! { |k, _v| k == key })
+        @mongo.backup.send(:command).should_not =~ /#{v}/
+      end
+    end
+  end
+end