bostonlogic-safe 0.3.0

data/examples/integration/cleanup_example.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/../example_helper')
+
+require "fileutils"
+include FileUtils
+
+describe "tar backup" do
+  before(:all) do
+    # need both local and instance vars
+    # instance variables are used in tests
+    # local variables are used in the backup definition (instance vars can't be seen)
+    @root = root = "tmp/cleanup_example"
+
+    # clean state
+    rm_rf @root
+    mkdir_p @root
+
+    # create source tree
+    @src = src = "#{@root}/src"
+    mkdir_p src
+
+    File.open(qwe = "#{@src}/qwe", "w") {|f| f.write("qwe") }
+
+    @dst = dst = "#{@root}/backup"
+    mkdir_p "#{@dst}/archive"
+
+    @now = Time.now
+    @timestamp = @now.strftime("%y%m%d-%H%M")
+
+    stub(Time).now {@now} # Freeze
+
+    cp qwe, "#{dst}/archive/archive-foo.000001.tar.gz"
+    cp qwe, "#{dst}/archive/archive-foo.000002.tar.gz"
+    cp qwe, "#{dst}/archive/archive-foobar.000001.tar.gz"
+    cp qwe, "#{dst}/archive/archive-foobar.000002.tar.gz"
+
+    Astrails::Safe.safe do
+      local :path => "#{dst}/:kind"
+      tar do
+        keep :local => 1 # only leave the latest
+        archive :foo do
+          files src
+        end
+      end
+    end
+
+    @backup = "#{dst}/archive/archive-foo.#{@timestamp}.tar.gz"
+  end
+
+  it "should create backup file" do
+    puts "Expecting: #{@backup}"
+    File.exists?(@backup).should be_true
+  end
+
+  it "should remove old backups" do
+    Dir["#{@dst}/archive/archive-foo.*"].should == [@backup]
+  end
+
+  it "should NOT remove backups with base having same prefix" do
+    Dir["#{@dst}/archive/archive-foobar.*"].should == ["#{@dst}/archive/archive-foobar.000001.tar.gz", "#{@dst}/archive/archive-foobar.000002.tar.gz"]
+  end
+
+end

data/examples/unit/archive_example.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../example_helper')
+
+describe Astrails::Safe::Archive do
+
+  def def_config
+    {
+      :options => "OPTS",
+      :files   => "apples",
+      :exclude => "oranges"
+    }
+  end
+
+  def archive(id = :foo, config = def_config)
+    Astrails::Safe::Archive.new(id, Astrails::Safe::Config::Node.new(nil, config))
+  end
+
+  after(:each) { Astrails::Safe::TmpFile.cleanup }
+
+  describe :backup do
+    before(:each) do
+      @archive = archive
+      stub(@archive).timestamp {"NOW"}
+    end
+
+    {
+      :id => "foo",
+      :kind => "archive",
+      :extension => ".tar",
+      :filename => "archive-foo.NOW",
+      :command => "tar -cf - OPTS --exclude=oranges apples",
+    }.each do |k, v|
+      it "should set #{k} to #{v}" do
+        @archive.backup.send(k).should == v
+      end
+    end
+  end
+
+  describe :tar_exclude_files do
+    it "should return '' when no excludes" do
+      archive(:foo, {}).send(:tar_exclude_files).should == ''
+    end
+
+    it "should accept single exclude as string" do
+      archive(:foo, {:exclude => "bar"}).send(:tar_exclude_files).should == '--exclude=bar'
+    end
+
+    it "should accept multiple exclude as array" do
+      archive(:foo, {:exclude => ["foo", "bar"]}).send(:tar_exclude_files).should == '--exclude=foo --exclude=bar'
+    end
+  end
+
+  describe :tar_files do
+    it "should raise RuntimeError when no files" do
+      lambda {
+        archive(:foo, {}).send(:tar_files)
+      }.should raise_error(RuntimeError, "missing files for tar")
+    end
+
+    it "should accept single file as string" do
+      archive(:foo, {:files => "foo"}).send(:tar_files).should == "foo"
+    end
+
+    it "should accept multiple files as array" do
+      archive(:foo, {:files => ["foo", "bar"]}).send(:tar_files).should == "foo bar"
+    end
+  end
+end

data/examples/unit/config_example.rb

@@ -0,0 +1,184 @@
+require File.expand_path(File.dirname(__FILE__) + '/../example_helper')
+
+describe Astrails::Safe::Config do
+  it "should parse example config" do
+    config = Astrails::Safe::Config::Node.new do
+      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
+        key "gpg-key"
+        password "astrails"
+      end
+
+      keep do
+        local 4
+        s3 20
+      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
+
+    end
+
+    expected = {
+      "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"] },
+        },
+      },
+    }
+
+    config.to_hash.should == expected
+  end
+end

data/examples/unit/gpg_example.rb

@@ -0,0 +1,138 @@
+require File.expand_path(File.dirname(__FILE__) + '/../example_helper')
+
+describe Astrails::Safe::Gpg do
+  def def_backup
+    {
+      :compressed => false,
+      :command => "command",
+      :extension => ".foo",
+      :filename => "qweqwe"
+    }
+  end
+
+  def gpg(config = {}, backup = def_backup)
+    Astrails::Safe::Gpg.new(
+      Astrails::Safe::Config::Node.new(nil, config),
+      Astrails::Safe::Backup.new(backup)
+    )
+  end
+
+  after(:each) { Astrails::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 "should add .gpg extension" do
+        mock(@gpg.backup.extension) << '.gpg'
+        @gpg.process
+      end
+
+      it "should add command pipe" do
+        mock(@gpg.backup.command) << (/\|gpg -BLAH/)
+        @gpg.process
+      end
+
+      it "should set compressed" do
+        mock(@gpg.backup).compressed = true
+        @gpg.process
+      end
+    end
+
+    describe "when inactive" do
+      before(:each) do
+        stub(@gpg).active? {false}
+      end
+
+      it "should not touch extension" do
+        dont_allow(@gpg.backup.extension) << anything
+        @gpg.process
+      end
+
+      it "should not touch command" do
+        dont_allow(@gpg.backup.command) << anything
+        @gpg.process
+      end
+
+      it "should not touch compressed" do
+        dont_allow(@gpg.backup).compressed = anything
+        @gpg.process
+      end
+    end
+  end
+
+  describe :active? do
+
+    describe "with key" do
+      it "should be true" do
+        gpg(:gpg => {:key => :foo}).should be_active
+      end
+    end
+
+    describe "with password" do
+      it "should be true" do
+        gpg(:gpg => {:password => :foo}).should be_active
+      end
+    end
+
+    describe "without key & password" do
+      it "should be false" do
+        gpg.should_not be_active
+      end
+    end
+
+    describe "with key & password" do
+      it "should raise 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
+      before(:each) do
+        @gpg = gpg(:gpg => {:key => "foo", :options => "GPG-OPT"}, :options => "OPT")
+      end
+
+      it "should not call gpg_password_file" do
+        dont_allow(@gpg).gpg_password_file(anything)
+        @gpg.send(:pipe)
+      end
+
+      it "should use '-r' and :options" do
+        @gpg.send(:pipe).should == "|gpg GPG-OPT -e -r foo"
+      end
+    end
+
+    describe "with password" do
+      before(:each) do
+        @gpg = gpg(:gpg => {:password => "bar", :options => "GPG-OPT"}, :options => "OPT")
+        stub(@gpg).gpg_password_file(anything) {"pass-file"}
+      end
+
+      it "should use '--passphrase-file' and :options" do
+        @gpg.send(:pipe).should == "|gpg GPG-OPT -c --passphrase-file pass-file"
+      end
+    end
+  end
+
+  describe :gpg_password_file do
+    it "should create password file" do
+      file = gpg.send(:gpg_password_file, "foo")
+      File.exists?(file).should be_true
+      File.read(file).should == "foo"
+    end
+  end
+end