netguru-safe 0.2.9

data/lib/astrails/safe/stream.rb

@@ -0,0 +1,20 @@
+module Astrails
+  module Safe
+    class Stream
+
+      attr_accessor :config, :backup
+      def initialize(config, backup)
+        @config, @backup = config, backup
+      end
+
+      # FIXME: move to Backup
+      def expand(path)
+        path .
+        gsub(/:kind\b/, @backup.kind.to_s) .
+        gsub(/:id\b/, @backup.id.to_s) .
+        gsub(/:timestamp\b/, @backup.timestamp)
+      end
+
+    end
+  end
+end

data/lib/astrails/safe/svndump.rb

@@ -0,0 +1,13 @@
+module Astrails
+  module Safe
+    class Svndump < Source
+
+      def command
+        "svnadmin dump #{@config[:options]} #{@config[:repo_path]}"
+      end
+
+      def extension; '.svn'; end
+
+    end
+  end
+end

data/lib/astrails/safe/tmp_file.rb

@@ -0,0 +1,48 @@
+require 'tmpdir'
+module Astrails
+  module Safe
+    module TmpFile
+      @keep_files = []
+
+      def self.tmproot
+        @tmproot ||= Dir.mktmpdir
+      end
+
+      def self.cleanup
+        begin
+          FileUtils.remove_entry_secure tmproot
+        rescue ArgumentError => e
+          if e.message =~ /parent directory is world writable/
+            puts <<-ERR
+
+
+********************************************************************************
+It looks like you have wrong permissions on your TEMP directory.  The usual
+case is when you have world writable TEMP directory withOUT the sticky bit.
+
+Try "chmod +t" on it.
+
+********************************************************************************
+
+ERR
+          else
+            raise
+          end
+        end
+        @tmproot = nil
+      end
+
+      def self.create(name)
+        # create temp directory
+
+        file = Tempfile.new(name, tmproot)
+
+        yield file
+
+        file.close
+        @keep_files << file # so that it will not get gcollected and removed from filesystem until the end
+        file.path
+      end
+    end
+  end
+end

data/lib/astrails/safe/version.rb

@@ -0,0 +1,5 @@
+module Astrails
+  module Safe
+    VERSION = '0.2.9'
+  end
+end

data/lib/extensions/mktmpdir.rb

@@ -0,0 +1,45 @@
+require 'tmpdir'
+
+unless Dir.respond_to?(:mktmpdir)
+  # backward compat for 1.8.6
+  class Dir
+    def Dir.mktmpdir(prefix_suffix=nil, tmpdir=nil)
+      case prefix_suffix
+      when nil
+        prefix = "d"
+        suffix = ""
+      when String
+        prefix = prefix_suffix
+        suffix = ""
+      when Array
+        prefix = prefix_suffix[0]
+        suffix = prefix_suffix[1]
+      else
+        raise ArgumentError, "unexpected prefix_suffix: #{prefix_suffix.inspect}"
+      end
+      tmpdir ||= Dir.tmpdir
+      t = Time.now.strftime("%Y%m%d")
+      n = nil
+      begin
+        path = "#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+        path << "-#{n}" if n
+        path << suffix
+        Dir.mkdir(path, 0700)
+      rescue Errno::EEXIST
+        n ||= 0
+        n += 1
+        retry
+      end
+
+      if block_given?
+        begin
+          yield path
+        ensure
+          FileUtils.remove_entry_secure path
+        end
+      else
+        path
+      end
+    end
+  end
+end

data/spec/integration/airbrake_integration_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'toadhopper'
+
+describe "a failing backup" do
+  before :each do
+    @exception = RuntimeError.new("BOOM")
+    stub.instance_of(Astrails::Safe::Source).backup { raise @exception }
+
+    # 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/airbrake_backup_example"
+
+    # clean state
+    rm_rf @root
+    mkdir_p @root
+
+    # create source tree
+    @src = src = "#{@root}/src"
+    @dst = dst = "#{@root}/backup"
+    mkdir_p @dst
+
+    @now = Time.now
+    @timestamp = @now.strftime("%y%m%d-%H%M")
+
+    stub(Time).now {@now} # Freeze
+  end
+
+  describe "when not configured to send airbrake notifications" do
+    it "should not notify the toadhopper" do
+      dont_allow(Toadhopper).post!
+
+      Astrails::Safe.safe do
+        local :path => "#{@dst}/:kind"
+        tar do
+          archive :test1, :files => @src
+        end
+      end
+    end    
+  end
+  
+  describe "when configured to send airbrake notifications" do
+    def perform_backup
+      Astrails::Safe.safe do
+        airbrake do
+          api_key "test_api_key"
+        end
+
+        local :path => "#{@dst}/:kind"
+        tar do
+          archive :test1, :files => @src
+        end
+      end      
+    end
+    
+    it "should assign the specified api key" do
+      mock(Toadhopper).new('test_api_key')      
+      perform_backup
+    end
+
+    it "should notifiy the toadhopper" do
+      mock.instance_of(Toadhopper).post!(@exception)
+      perform_backup
+    end
+
+    it "should clean up the tmp files" do
+      mock(Astrails::Safe::TmpFile).cleanup
+      perform_backup
+    end
+
+    it "should not raise exceptions from the toadhopper" do
+      mock.instance_of(Toadhopper).post!(@exception) { raise RuntimeError.new("From the toad") }
+      lambda { perform_backup }.should_not raise_exception("From the toad")
+    end
+  end
+end

data/spec/integration/archive_integration_spec.rb

@@ -0,0 +1,88 @@
+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/archive_backup_example"
+
+    # clean state
+    rm_rf @root
+    mkdir_p @root
+
+    # create source tree
+    @src = src = "#{@root}/src"
+    mkdir_p "#{@src}/q/w/e"
+    mkdir_p "#{@src}/a/s/d"
+
+    File.open("#{@src}/qwe1", "w") {|f| f.write("qwe") }
+    File.open("#{@src}/q/qwe2", "w") {|f| f.write("qwe"*2) }
+    File.open("#{@src}/q/w/qwe3", "w") {|f| f.write("qwe"*3) }
+    File.open("#{@src}/q/w/e/qwe4", "w") {|f| f.write("qwe"*4) }
+
+    File.open("#{@src}/asd1", "w") {|f| f.write("asd") }
+    File.open("#{@src}/a/asd2", "w") {|f| f.write("asd" * 2) }
+    File.open("#{@src}/a/s/asd3", "w") {|f| f.write("asd" * 3) }
+
+    @dst = dst = "#{@root}/backup"
+    mkdir_p @dst
+
+    @now = Time.now
+    @timestamp = @now.strftime("%y%m%d-%H%M")
+
+    stub(Time).now {@now} # Freeze
+
+    Astrails::Safe.safe do
+      local :path => "#{dst}/:kind"
+      tar do
+        archive :test1 do
+          files src
+          exclude "#{src}/q/w"
+          exclude "#{src}/q/w/e"
+        end
+      end
+    end
+
+    @backup = "#{dst}/archive/archive-test1.#{@timestamp}.tar.gz"
+  end
+
+  it "should create backup file" do
+    File.exists?(@backup).should be_true
+  end
+
+  describe "after extracting" do
+    before(:all) do
+      # prepare target dir
+      @target = "#{@root}/test"
+      mkdir_p @target
+      system "tar -zxvf #{@backup} -C #{@target}"
+
+      @test = "#{@target}/#{@root}/src"
+      puts @test
+    end
+
+    it "should include asd1/2/3" do
+      File.exists?("#{@test}/asd1").should be_true
+      File.exists?("#{@test}/a/asd2").should be_true
+      File.exists?("#{@test}/a/s/asd3").should be_true
+    end
+
+    it "should only include qwe 1 and 2 (no 3)" do
+      File.exists?("#{@test}/qwe1").should be_true
+      File.exists?("#{@test}/q/qwe2").should be_true
+      File.exists?("#{@test}/q/w/qwe3").should be_false
+      File.exists?("#{@test}/q/w/e/qwe4").should be_false
+    end
+
+    it "should preserve file content" do
+      File.read("#{@test}/qwe1").should == "qwe"
+      File.read("#{@test}/q/qwe2").should == "qweqwe"
+      File.read("#{@test}/a/s/asd3").should == "asdasdasd"
+    end
+  end
+
+end

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,13 @@
+$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 'astrails/safe'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

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