zfs-mysql-backup 0.0.8

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= zfs-mysql-backup
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 James Golick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "zfs-mysql-backup"
+    gem.summary = %Q{A script for backing up mysql databases using ZFS}
+    gem.description = %Q{A script for backing up mysql databases using ZFS}
+    gem.email = "james@giraffesoft.ca"
+    gem.homepage = "http://github.com/giraffesoft/zfs-mysql-backup"
+    gem.authors = ["James Golick"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "thor"
+    gem.add_dependency "activerecord"
+    gem.add_dependency "aws-s3"
+    gem.add_dependency "mysql"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "zfs-mysql-backup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.8

data/bin/zfs-mysql-backup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/zfs-mysql-backup', __FILE__)
+
+ZfsMysqlBackup.start
+

data/lib/zfs-mysql-backup.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'activerecord'
+require 'aws/s3'
+
+class ZfsMysqlBackup < Thor
+  no_tasks {
+    attr_reader :logger, :connection, :date, :status, :database_yml, :backup_location, :sms_number
+  }
+
+  desc "backup path/to/database.yml path/to/backup/dir phone_number_to_sms_if_theres_a_failure [name_of_s3_bucket_here to push to s3]", "Create a zfs backup."
+  def backup(database_yml, backup_location, sms_number, s3_bucket = false)
+    @database_yml    = database_yml
+    @backup_location = backup_location
+    @s3_bucket       = s3_bucket
+    @sms_number      = sms_number
+
+    init
+    acquire_lock
+    take_snapshot
+    release_lock
+    handle_snapshot_result
+    push_to_s3 if success? && push_to_s3?
+  end
+  
+  protected 
+    def init
+      @logger     = Logger.new(STDOUT)
+      ActiveRecord::Base.establish_connection(YAML.load(File.read(database_yml))[ENV['RAILS_ENV']])
+      @connection = ActiveRecord::Base.connection
+    end
+
+    def acquire_lock
+      logger.info("[MySQL Backup] Acquiring mysql lock.")
+      connection.execute("FLUSH TABLES WITH READ LOCK")
+      logger.info("[MySQL Backup] Lock acquired.")
+    end
+
+    def take_snapshot
+      @date = Time.now.strftime("%d%m%y%H%M")
+      logger.info("[MySQL Backup] Creating snapshot at #{date}.")
+      system("zfs snapshot data@#{date} 2>&1")
+      @status = $?.exitstatus
+    end
+
+    def handle_snapshot_result
+      success? ? success : failure
+    end
+
+    def success
+      logger.info("[MySQL Backup] Succeeded! Compressing and exporting to #{path_to_backup}")
+      system("zfs send data@#{date} | gzip > #{path_to_backup}")
+    end
+
+    def path_to_backup
+      "#{backup_location}/mysql-#{date}.gz"
+    end
+
+    def failure
+      logger.info("[MySQL Backup] FAILED. Notifying the authorities.")
+      system(%{echo "MySQL Backup at #{date} FAILED." | /usr/local/bin/send_sms #{sms_number}})
+    end
+
+    def release_lock
+      logger.info("[MySQL Backup] Unlocking tables")
+      connection.execute("UNLOCK TABLES;")
+    end
+
+    def push_to_s3?
+      @s3_bucket
+    end
+
+    def push_to_s3
+      logger.info("[MySQL Backup] Pushing to S3 at #{path_to_backup} in #{@s3_bucket}.")
+      begin
+        AWS::S3::Base.establish_connection! :access_key_id     => ENV['AWS_ACCESS_KEY_ID'],
+                                            :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+        AWS::S3::S3Object.store(s3_object_name, open(path_to_backup), @s3_bucket)
+      rescue => e
+        logger.info("[MySQL Backup] Something went wrong. Notifying the authorities!")
+        logger.info("\tError Message #{e.message}")
+        system(%{echo "Pushing to S3 at #{date} FAILED." | /usr/local/bin/send_sms #{sms_number}})
+      end
+      logger.info("[MySQL Backup] Done!")
+    end
+
+    def s3_object_name
+      hostname = `hostname`
+      "mysqlbackups/#{hostname}-#{date}.gz"
+    end
+
+    def success?
+      status == 0
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'zfs-mysql-backup'
+
+class Test::Unit::TestCase
+end

data/test/zfs-mysql-backup_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ZfsMysqlBackupTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/zfs-mysql-backup.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zfs-mysql-backup}
+  s.version = "0.0.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick"]
+  s.date = %q{2009-10-28}
+  s.default_executable = %q{zfs-mysql-backup}
+  s.description = %q{A script for backing up mysql databases using ZFS}
+  s.email = %q{james@giraffesoft.ca}
+  s.executables = ["zfs-mysql-backup"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/zfs-mysql-backup",
+     "lib/zfs-mysql-backup.rb",
+     "test/test_helper.rb",
+     "test/zfs-mysql-backup_test.rb",
+     "zfs-mysql-backup.gemspec"
+  ]
+  s.homepage = %q{http://github.com/giraffesoft/zfs-mysql-backup}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A script for backing up mysql databases using ZFS}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/zfs-mysql-backup_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0"])
+      s.add_runtime_dependency(%q<mysql>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<aws-s3>, [">= 0"])
+      s.add_dependency(%q<mysql>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<aws-s3>, [">= 0"])
+    s.add_dependency(%q<mysql>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: zfs-mysql-backup
+version: !ruby/object:Gem::Version 
+  version: 0.0.8
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-28 00:00:00 -07:00
+default_executable: zfs-mysql-backup
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A script for backing up mysql databases using ZFS
+email: james@giraffesoft.ca
+executables: 
+- zfs-mysql-backup
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/zfs-mysql-backup
+- lib/zfs-mysql-backup.rb
+- test/test_helper.rb
+- test/zfs-mysql-backup_test.rb
+- zfs-mysql-backup.gemspec
+has_rdoc: true
+homepage: http://github.com/giraffesoft/zfs-mysql-backup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A script for backing up mysql databases using ZFS
+test_files: 
+- test/test_helper.rb
+- test/zfs-mysql-backup_test.rb