stratocumulus 0.0.3 → 0.0.4

data/lib/stratocumulus/database.rb

@@ -1,20 +1,25 @@
 # encoding: UTF-8
+require 'stratocumulus/database/mysql'
+require 'stratocumulus/database/pipe_io'
+require 'English'
 
 module Stratocumulus
   class Database
-    def initialize(options = {})
-      @username = options['username'] || 'root'
-      @password = options['password']
+    def initialize(options = {}, backend_class = nil)
       @name = options['name']
-
-      @host = options['host']
-      @port = options['port']
-
-      check_dependencies(options['type'])
+      fail 'database name not specified' unless @name
+      setup_backend(backend_class, options)
+      check_dependencies
     end
 
     def dump
-      IO.popen("bash -c '#{pipefail} #{mysqldump_command} | gzip'")
+      @dump ||= PipeIO.popen("bash -c '#{pipefail} #{@backend.command} | gzip'")
+    end
+
+    def success?
+      dump.read
+      dump.close
+      $CHILD_STATUS.success?
     end
 
     def filename
@@ -23,37 +28,25 @@ module Stratocumulus
 
     private
 
-    def mysqldump_command
-      command = 'mysqldump '
-      command << '--single-transaction '
-      command << "-u#{@username} "
-      command << "-h#{host} " unless socket?
-      command << "-P#{port} " unless socket?
-      command << "-p#{@password} " if @password
-      command << @name
-    end
-
-    def host
-      @host || 'localhost'
+    def pipefail
+      'set -o pipefail;'
     end
 
-    def port
-      @port || 3306
+    def check_dependencies
+      dependencies.each do |cmd|
+        fail "#{cmd} not available" unless system("which #{cmd} >/dev/null")
+      end
     end
 
-    def socket?
-      !@host && !@port
+    def dependencies
+      ['gzip'] + @backend.dependencies
     end
 
-    def pipefail
-      'set -o pipefail;'
-    end
-
-    def check_dependencies(type)
-      fail 'database name not specified' unless @name
+    def setup_backend(backend_class, options)
+      backend_class ||= MySQL
+      type = options['type']
       fail "#{type} is not a supported database" unless type == 'mysql'
-      fail 'mysqldump not available' unless system('which mysqldump >/dev/null')
-      fail 'gzip not available' unless system('which gzip >/dev/null')
+      @backend = backend_class.new(options)
     end
   end
 end

data/lib/stratocumulus/database/mysql.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+module Stratocumulus
+  class Database
+    class MySQL
+      def initialize(options = {})
+        @username = options['username'] || 'root'
+        @password = options['password']
+        @name = options['name']
+
+        @host = options['host']
+        @port = options['port']
+      end
+
+      def command
+        command = 'mysqldump '
+        command << '--single-transaction '
+        command << "-u#{@username} "
+        command << "-h#{host} " unless socket?
+        command << "-P#{port} " unless socket?
+        command << "-p#{@password} " if @password
+        command << @name
+      end
+
+      def dependencies
+        ['mysqldump']
+      end
+
+      private
+
+      def host
+        @host || 'localhost'
+      end
+
+      def port
+        @port || 3306
+      end
+
+      def socket?
+        !@host && !@port
+      end
+    end
+  end
+end

data/lib/stratocumulus/database/pipe_io.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+# Rewind is undefined so fog won't try to call rewind on a pipe
+
+module Stratocumulus
+  class Database
+    class PipeIO < IO
+      undef rewind
+    end
+  end
+end

data/lib/stratocumulus/storage.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 require 'fog'
-require 'stratocumulus/ext/io'
+require 'logger'
 
 module Stratocumulus
   class Storage
@@ -14,7 +14,18 @@ module Stratocumulus
 
     def upload(database)
       return unless @retention.upload_today?
-      add_expiry_rule(database.filename)
+      file = store_file(database)
+      if database.success?
+        add_expiry_rule(database.filename)
+      else
+        log.error("there was an error generating #{database.filename}")
+        file.destroy
+      end
+    end
+
+    private
+
+    def store_file(database)
       files.create(
         key: database.filename,
         body: database.dump,
@@ -23,8 +34,6 @@ module Stratocumulus
       )
     end
 
-    private
-
     def connection
       Fog::Storage.new(
         provider: 'AWS',
@@ -62,5 +71,9 @@ module Stratocumulus
     rescue Excon::Errors::NotFound
       []
     end
+
+    def log
+      Logger.new(STDERR)
+    end
   end
 end

data/lib/stratocumulus/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module Stratocumulus
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/intergration/database_spec.rb

@@ -21,9 +21,10 @@ describe Stratocumulus::Database do
 
     let(:dump) { Zlib::GzipReader.new(subject.dump).read }
 
-    it 'dumps a gziped copy of the database' do
+    it 'sucessfully dumps a gziped copy of the database' do
       expect(dump).to include('CREATE TABLE `widgets`')
       expect(dump).to include("INSERT INTO `widgets` VALUES (1,'Foo',3,1,2)")
+      expect(subject).to be_success
     end
   end
 end

data/spec/unit/database_spec.rb

@@ -208,4 +208,52 @@ describe Stratocumulus::Database do
       expect(subject.filename).to eq filename
     end
   end
+
+  describe '#success?' do
+    subject  do
+      described_class.new(
+        { 'name' => 'foo', 'type' => 'mysql' },
+        backend
+      )
+    end
+
+    context 'the backend fails' do
+      let(:backend) { FailingBackend }
+
+      it 'returns false' do
+        expect(subject).to_not be_success
+      end
+
+    end
+
+    context 'the backend is sucessfull' do
+      let(:backend) { SucessBackend }
+
+      it 'returns true' do
+        expect(subject).to be_success
+      end
+
+    end
+
+    class FakeBackend
+      def initialize(*)
+      end
+
+      def dependencies
+        []
+      end
+    end
+
+    class FailingBackend < FakeBackend
+      def command
+        'exit 127'
+      end
+    end
+
+    class SucessBackend < FakeBackend
+      def command
+        'exit 0'
+      end
+    end
+  end
 end

data/spec/unit/pipe_io_spec.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Stratocumulus::Database::PipeIO do
+  subject do
+    described_class.popen('echo foo')
+  end
+
+  after do
+    subject.close
+  end
+
+  it 'behaves like IO' do
+    expect(subject.read).to eq "foo\n"
+  end
+
+  describe '#rewind' do
+    it 'is not defined' do
+      expect(subject).to_not respond_to(:rewind)
+    end
+  end
+end
+
+describe IO do
+  subject do
+    described_class.open(
+      described_class.sysopen('spec/support/test_config_file.yml')
+    )
+  end
+
+  it 'is not affected' do
+    subject.read
+    subject.rewind
+    expect(subject.read).to_not be_nil
+  end
+end

data/spec/unit/storage_spec.rb

@@ -18,10 +18,16 @@ describe Stratocumulus::Storage do
   describe '#upload' do
     let(:connection) { double(:fog_conn, directories: directories) }
     let(:directories) { double(:fog_dirs, get: double(files: files)) }
-    let(:files) { double(:fog_files, create: true) }
+    let(:files) { double(:fog_files, create: file) }
+    let(:file) { double }
 
     let(:database) do
-      double(:database, filename: 'foo.sql.gz', dump: :database_dump)
+      double(
+        :database,
+        filename: 'foo.sql.gz',
+        dump: :database_dump,
+        success?: true
+      )
     end
 
     before do
@@ -95,6 +101,29 @@ describe Stratocumulus::Storage do
         end
       end
 
+      context 'when the database is not sucessfull' do
+        let(:database) do
+          double(
+            :database,
+            filename: 'foo.sql.gz',
+            dump: :database_dump,
+            success?: false
+          )
+        end
+
+        before do
+          allow(file).to receive(:destroy)
+        end
+
+        it 'destroys the failing dump' do
+          expect(file).to receive(:destroy)
+        end
+
+        it 'does not create a expiry rule' do
+          expect(service).to_not receive(:put_bucket_lifecycle)
+        end
+      end
+
       context 'rules allready set on the bucket' do
         let(:files) { [existing_file] }
         let(:existing_file) { double(:fog_file, key: 'bar.sql.gz') }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stratocumulus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -160,18 +160,19 @@ files:
 - lib/stratocumulus.rb
 - lib/stratocumulus/cli.rb
 - lib/stratocumulus/database.rb
-- lib/stratocumulus/ext/io.rb
+- lib/stratocumulus/database/mysql.rb
+- lib/stratocumulus/database/pipe_io.rb
 - lib/stratocumulus/retention.rb
 - lib/stratocumulus/runner.rb
 - lib/stratocumulus/storage.rb
 - lib/stratocumulus/version.rb
-- spec/ext/io_spec.rb
 - spec/intergration/database_spec.rb
 - spec/spec_helper.rb
 - spec/support/test.sql
 - spec/support/test_config_file.yml
 - spec/unit/cli_spec.rb
 - spec/unit/database_spec.rb
+- spec/unit/pipe_io_spec.rb
 - spec/unit/retention_spec.rb
 - spec/unit/runner_spec.rb
 - spec/unit/storage_spec.rb
@@ -191,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4542051147236532735
+      hash: 815129825214945472
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -200,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4542051147236532735
+      hash: 815129825214945472
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -208,13 +209,13 @@ signing_key:
 specification_version: 3
 summary: Backup Databases to Cloud Storage
 test_files:
-- spec/ext/io_spec.rb
 - spec/intergration/database_spec.rb
 - spec/spec_helper.rb
 - spec/support/test.sql
 - spec/support/test_config_file.yml
 - spec/unit/cli_spec.rb
 - spec/unit/database_spec.rb
+- spec/unit/pipe_io_spec.rb
 - spec/unit/retention_spec.rb
 - spec/unit/runner_spec.rb
 - spec/unit/storage_spec.rb

data/lib/stratocumulus/ext/io.rb

@@ -1,8 +0,0 @@
-# encoding: UTF-8
-
-# Rewind is undefined so fog won't try to call rewind on a pipe
-# This should be a refinement, but we are supporting 1.9.3 (for now)
-
-class IO
-  undef rewind
-end

data/spec/ext/io_spec.rb

@@ -1,12 +0,0 @@
-# encoding: UTF-8
-require 'spec_helper'
-
-describe IO do
-  subject { IO.new(IO.sysopen('/dev/null', 'w')) }
-
-  describe '#rewind' do
-    it 'is not defined' do
-      expect(subject).to_not respond_to(:rewind)
-    end
-  end
-end