darkofabijan-astrails-safe 0.2.8

data/spec/integration/cleanup_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_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
+    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/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format specdoc
+--format profile:log/spec-benchmark.log
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems'
+require 'ruby-debug'
+require 'yaml'
+
+require 'astrails/safe'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+SERVICES_CONFIG = File.open( 'spec/integration_config.yml' ) { |yf| YAML::load( yf ) }

data/spec/unit/archive_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_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/spec/unit/cloudfiles_spec.rb

@@ -0,0 +1,170 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Astrails::Safe::Cloudfiles do
+
+  def def_config
+    {
+      :cloudfiles => {
+        :container => "_container",
+        :user    => "_user",
+        :api_key => "_api_key",
+      },
+      :keep => {
+        :cloudfiles => 2
+      }
+    }
+  end
+
+  def def_backup(extra = {})
+    {
+      :kind      => "_kind",
+      :filename  => "/backup/somewhere/_kind-_id.NOW.bar",
+      :extension => ".bar",
+      :id        => "_id",
+      :timestamp => "NOW"
+    }.merge(extra)
+  end
+
+  def cloudfiles(config = def_config, backup = def_backup)
+    Astrails::Safe::Cloudfiles.new(
+      Astrails::Safe::Config::Node.new(nil, config),
+      Astrails::Safe::Backup.new(backup)
+    )
+  end
+
+  describe :cleanup do
+
+    before(:each) do
+      @cloudfiles = cloudfiles
+
+      @files = [4,1,3,2].to_a.map { |i| "aaaaa#{i}" }
+
+      @container = "container"
+
+      stub(@container).objects(:prefix => "_kind/_id/_kind-_id.") { @files }
+      stub(@container).delete_object(anything)
+
+      stub(CloudFiles::Connection).
+        new('_user', '_api_key', true, false).stub!.
+        container('_container') {@container}
+    end
+
+    it "should check [:keep, :cloudfiles]" do
+      @cloudfiles.config[:keep].data["cloudfiles"] = nil
+      dont_allow(@cloudfiles.backup).filename
+      @cloudfiles.send :cleanup
+    end
+
+    it "should delete extra files" do
+      mock(@container).delete_object('aaaaa1')
+      mock(@container).delete_object('aaaaa2')
+      @cloudfiles.send :cleanup
+    end
+
+  end
+
+  describe :active do
+    before(:each) do
+      @cloudfiles = cloudfiles
+    end
+
+    it "should be true when all params are set" do
+      @cloudfiles.should be_active
+    end
+
+    it "should be false if container is missing" do
+      @cloudfiles.config[:cloudfiles].data["container"] = nil
+      @cloudfiles.should_not be_active
+    end
+
+    it "should be false if user is missing" do
+      @cloudfiles.config[:cloudfiles].data["user"] = nil
+      @cloudfiles.should_not be_active
+    end
+
+    it "should be false if api_key is missing" do
+      @cloudfiles.config[:cloudfiles].data["api_key"] = nil
+      @cloudfiles.should_not be_active
+    end
+  end
+
+  describe :path do
+    before(:each) do
+      @cloudfiles = cloudfiles
+    end
+    it "should use cloudfiles/path 1st" do
+      @cloudfiles.config[:cloudfiles].data["path"] = "cloudfiles_path"
+      @cloudfiles.config[:local] = {:path => "local_path"}
+      @cloudfiles.send(:path).should == "cloudfiles_path"
+    end
+
+    it "should use local/path 2nd" do
+      @cloudfiles.config[:local] = {:path => "local_path"}
+      @cloudfiles.send(:path).should == "local_path"
+    end
+
+    it "should use constant 3rd" do
+      @cloudfiles.send(:path).should == "_kind/_id"
+    end
+
+  end
+
+  describe :save do
+    def add_stubs(*stubs)
+      stubs.each do |s|
+        case s
+        when :connection
+          stub(CloudFiles::Authentication).new
+          stub(CloudFiles::Connection).
+            new('_user', '_api_key', true, false).stub!.
+            create_container('_container') {@container}
+        when :stat
+          stub(File).stat("foo").stub!.size {123}
+        when :create_container
+          @container = "container"
+          stub(@container).create_object("_kind/_id/backup/somewhere/_kind-_id.NOW.bar.bar", true) {@object}
+          stub(CloudFiles::Connection).create_container {@container}
+        when :file_open
+          stub(File).open("foo")
+        when :cloudfiles_store
+          @object = "object"
+          mock(@object).write(nil) {true}
+        end
+      end
+    end
+
+    before(:each) do
+      @cloudfiles = cloudfiles(def_config, def_backup(:path => "foo"))
+      @full_path = "_kind/_id/backup/somewhere/_kind-_id.NOW.bar.bar"
+    end
+
+    it "should fail if no backup.file is set" do
+      @cloudfiles.backup.path = nil
+      proc {@cloudfiles.send(:save)}.should raise_error(RuntimeError)
+    end
+
+    it "should establish Cloud Files connection" do
+      add_stubs(:connection, :stat, :create_container, :file_open, :cloudfiles_store)
+      @cloudfiles.send(:save)
+    end
+
+    it "should open local file" do
+      add_stubs(:connection, :stat, :create_container, :cloudfiles_store)
+      mock(File).open("foo")
+      @cloudfiles.send(:save)
+    end
+
+    it "should upload file" do
+      add_stubs(:connection, :stat, :create_container, :file_open, :cloudfiles_store)
+      @cloudfiles.send(:save)
+    end
+
+    it "should fail on files bigger then 5G" do
+      add_stubs(:connection)
+      mock(File).stat("foo").stub!.size {5*1024*1024*1024+1}
+      mock(STDERR).puts(anything)
+      dont_allow(Benchmark).realtime
+      @cloudfiles.send(:save)
+    end
+  end
+end

data/spec/unit/config_spec.rb

@@ -0,0 +1,213 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_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
+
+  it "should make an array from multivalues" do
+    config = Astrails::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 "should raise error on key duplication" do
+    proc do
+      Astrails::Safe::Config::Node.new do
+        path "foo"
+        path "bar"
+      end
+    end.should raise_error(ArgumentError, "duplicate value for 'path'")
+  end
+
+end