mysql_backup 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Christian Hellsten
+
+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 @@
+= 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 Christian Hellsten. See LICENSE for details.

data/README.textile

@@ -0,0 +1,101 @@
+h1. mysql-backup
+
+A command line tool that backups all MySQL database instances it can find a server.
+
+h2. Installation
+
+<pre>
+<code>
+  $ gem sources -a http://gems.github.com (you only have to do this once)
+  $ sudo gem install christianhellsten-mysql-backup
+</code>
+</pre>
+
+You can also grab the source code and install with rake:
+<pre>
+<code>
+  $ cd /usr/local/src
+  $ git clone git://github.com/christianhellsten/mysql-backup.git
+  $ cd mysql-backup
+  $ sudo rake install_gem
+</code>
+</pre>
+
+h2. Configuration
+
+Configuration is easy, just run the built-in mysql_backup_install command:
+
+<pre>
+<code>
+  $ sudo mysql_backup_install
+</code>
+</pre>
+
+The installation script will ask you to enter all necessary information and then writes the configuration to /etc/mysql_backup.
+
+h2. Usage
+
+Taking a backup of all databases is also easy:
+
+<pre>
+<code>
+  $ sudo mysql_backup
+</code>
+</pre>
+
+This will backup all databases, except the ones defined in the configuration file using the *skip* parameter.
+
+h2. Scheduled backups with cron
+
+Open the cron configuration with the following command:
+
+<pre>
+<code>
+$ sudo crontab -e
+</code>
+</pre>
+
+Add the following:
+
+<pre>
+<code>
+PATH=/usr/local/bin:/usr/bin:/bin
+SHELL=/bin/bash
+
+# m h  dom mon dow   command
+
+# Backup all MySQL databases every night at 24:00
+
+00 00 * * * mysql_backup
+</code>
+</pre>
+
+h2. Sample configuration
+
+<pre>
+<code>
+user: root
+password: xxx
+host: localhost
+dir: /var/backup
+format: %d-%m-%y
+keep: 10
+
+mysqldump:
+  options: -Q -c -C --add-drop-table --add-locks --quick --lock-tables
+  path:
+skip: [mysql, test, information_schema]
+</code>
+</pre>
+
+h2. TODO
+
+* Refactor
+* List dependencies
+* Handle command line errors gracefully
+* Nice
+
+h2. Author
+
+"Christian Hellsten":http://christianhellsten.com ("Aktagon Ltd.":http://aktagon.com)
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mysql_backup"
+    gem.summary = %Q{A backup tool for MySQL.}
+    gem.description = %Q{A simple backup tool for MySQL that takes a backup of all MySQL databases.}
+    gem.email = "christian.hellsten@gmail.com"
+    gem.homepage = "http://github.com/christianhellsten/mysql-backup"
+    gem.authors = ["Christian Hellsten"]
+    gem.add_dependency "sequel", ">= 0"
+    gem.files =  FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (#{$!}) 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|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mysql_backup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/mysql_backup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'mysql_backup'
+
+MysqlBackup.run

data/bin/mysql_backup_install

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'mysql_backup'
+
+MysqlBackup.install
+

data/lib/mysql_backup/backup.rb

@@ -0,0 +1,65 @@
+#require 'ruby-debug'
+
+module MysqlBackup
+  class Backup
+    class << self
+
+      # TODO refactor, too long
+      def run
+        options = Options.options # TODO smells
+
+        user      = options['user']
+        password  = options['password']
+        host      = options['host']
+        encoding  = options['encoding']
+        dir       = options['dir']
+        format    = options['format']
+        keep      = options['keep'] || 10
+        skip      = options['skip']
+        mysqldump_options = options['mysqldump']['options']
+        path      = options['mysqldump']['path']
+
+        timestamp = Time.now.strftime(format)
+
+        connection = Sequel.mysql nil, :user => user, :password => password, :host => host, :encoding => encoding
+
+        databases = []
+        connection['show databases'].each do |db|
+          databases << db[:Database]
+        end
+        databases = databases - skip #['mysql', 'test', 'information_schema']
+
+        databases.each do |db|
+          raise "The backup directory '#{dir}' doesn't exist" if !File.exist?(dir)
+
+          file = File.join(dir, "#{db}_#{timestamp}.sql")
+          p "Backing up #{db.ljust(40)} > #{file}"
+
+          cmd = "#{path}mysqldump -u#{user} -p#{password} -h#{host} #{mysqldump_options} #{db} --result-file=#{file}"
+          
+          result = Pty.exec_pty(cmd, password)
+
+          # gzip 
+          `gzip -fq #{file}`
+      
+          # Find all backups and sort
+          # TODO improve this gem
+          all_backups = Dir.entries(dir).select{|f| f =~ /^#{db}/}.select{|f| File.file? File.join(dir, f) }.sort_by { |f| File.mtime(File.join(dir,f)) }.reverse
+
+          #pp all_backups
+
+          keep_backups = all_backups[0..keep] # eg. 10 latest
+
+          remove = all_backups - keep_backups
+
+          remove.each do |file|
+            puts "Removing backup '#{file}' keeping #{keep}"
+            FileUtils.rm_rf(file)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mysql_backup/install.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+
+module MysqlBackup
+  CONF_FILE = '/etc/mysql_backup'
+
+  class Install
+    class << self
+      def ask_for_options
+        require "highline/import"
+
+        puts <<-PROMPT
+
+        Please enter your MySQL username and password.
+
+        PROMPT
+
+        user     = ask("MySQL username   : ")
+        password = ask("MySQL password   : ") { |q| q.echo = false }
+        host     = ask("MySQL host       : ") { |q| q.default = 'localhost' }
+        dir      = ask("Backup directory : ") { |q| q.default = '/tmp' }
+
+        [user, password, host, dir]
+      end
+
+      def install
+        begin
+          if File.exist?(CONF_FILE)
+            puts <<-WARN
+
+            #{CONF_FILE} already exists. Remove it and try again.
+            
+            WARN
+
+            exit
+          end
+
+          user, password, host, dir = ask_for_options
+
+          File.open(CONF_FILE, 'w') do |file|
+            template = File.read(File.join(File.dirname(__FILE__), 'mysql_backup.yml.example'))
+            template.gsub!('USER', user)
+            template.gsub!('PASS', password)
+            template.gsub!('HOST', host)
+            template.gsub!('DIR', dir)
+            
+            file << template
+          end
+
+          FileUtils.chmod(750, CONF_FILE)
+
+          puts <<-ERR
+
+
+            Configuration file #{CONF_FILE} written.
+
+            You can now backup all databases by running the following command:
+
+              $ mysql_backup
+
+          ERR
+
+        rescue Errno::EACCES => e
+          puts <<-ERR
+
+            You need to run this command with sudo or as root.
+
+          ERR
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/mysql_backup/mysql_backup.yml.example

@@ -0,0 +1,11 @@
+user: USER
+password: PASS
+host: HOST
+dir: DIR
+format: %d-%m-%y
+keep: 10
+
+mysqldump:
+  options: -Q -c -C --add-drop-table --add-locks --quick --lock-tables
+  path:
+skip: [mysql, test, information_schema]

data/lib/mysql_backup/options.rb

@@ -0,0 +1,24 @@
+module MysqlBackup
+  class Options
+    class << self
+      def options
+        @@options ||= begin
+          begin
+            options = YAML::load(File.read('/etc/mysql_backup'))
+          rescue Errno::ENOENT
+            print <<-DOC
+
+          You need to create the configuration file.
+
+          To create the file, run the following commands from the command line:
+
+          $ sudo mysql_backup_install
+
+            DOC
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mysql_backup/pty.rb

@@ -0,0 +1,32 @@
+#
+# This errors means the directory doesn't exist or there's a problem with permissions:
+# /usr/local/lib/ruby/1.8/expect.rb:17:in `expect': undefined method `chr' for nil:NilClass (NoMethodError)
+#
+module MysqlBackup
+  class Pty
+    class << self
+      def exec_pty(cmd, password)
+        $expect_verbose = true 
+        password = '' if password.nil?
+
+        PTY.spawn(cmd) do |reader, writer, pid|
+          begin
+            reader.expect(/Enter password/, 1) do |line|
+              writer.puts password
+            end 
+          rescue
+            print reader.gets
+          end
+
+          begin
+            while line = reader.gets
+              # TODO detect errors we should act upon
+  #            raise line if line.strip.length > 1
+            end
+          rescue Errno::EIO # EOF
+          end
+        end 
+      end
+    end
+  end
+end

data/lib/mysql_backup.rb

@@ -0,0 +1,30 @@
+#
+# TODO Cleanup code
+#
+require 'sequel'
+require 'pty'
+
+require 'lib/mysql_backup/backup'
+require 'lib/mysql_backup/options'
+require 'lib/mysql_backup/pty'
+require 'lib/mysql_backup/install'
+
+module MysqlBackup
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
+  
+  def self.run
+    Backup.run
+  end
+
+  def self.options
+    Options.options
+  end
+
+  def self.install
+    Install.install
+  end
+end
+

data/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 'mysql_backup'
+
+class Test::Unit::TestCase
+end

data/test/test_mysql_backup.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMysqlBackup < 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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: mysql_backup
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christian Hellsten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !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: 
+description: A simple backup tool for MySQL that takes a backup of all MySQL databases.
+email: christian.hellsten@gmail.com
+executables: 
+- mysql_backup
+- mysql_backup_install
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- README.textile
+files: 
+- LICENSE
+- README.rdoc
+- README.textile
+- Rakefile
+- VERSION
+- bin/mysql_backup
+- bin/mysql_backup_install
+- lib/mysql_backup.rb
+- lib/mysql_backup/backup.rb
+- lib/mysql_backup/install.rb
+- lib/mysql_backup/mysql_backup.yml.example
+- lib/mysql_backup/options.rb
+- lib/mysql_backup/pty.rb
+- test/helper.rb
+- test/test_mysql_backup.rb
+has_rdoc: true
+homepage: http://github.com/christianhellsten/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 backup tool for MySQL.
+test_files: 
+- test/helper.rb
+- test/test_mysql_backup.rb