mysql-replication-helper 0.2.1

data/.document

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

data/README.rdoc

@@ -0,0 +1,27 @@
+= mysql-replication-helper
+
+This is a script that mitigates the errors generated by a Master/Slave MySQL
+replication configuration.
+
+A slave database engine needs to be updated in tandem with the master to
+account for changes such as:
+
+  * Adding a new database
+  * Adding a new user
+  * Adding views which reference particular users
+
+The replication helper facilitates this by identifying typical errors and
+fixing them.
+
+== Installing
+
+  % gem sources -a http://gems.github.com
+  % sudo gem install theworkinggroup-mysql-replication-helper
+
+== Starting
+
+  % replication-helper --daemon
+
+== Copyright
+
+Copyright (c) 2009 The Working Group Inc. (http://twg.ca/)

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mysql-replication-helper"
+    gem.summary = %Q{MySQL Replication Helper}
+    gem.email = "github@tadman.ca"
+    gem.homepage = "http://github.com/theworkinggroup/mysql-replication-helper"
+    gem.authors = [ 'Scott Tadman' ]
+    gem.executables = %w[ replication-helper ]
+    gem.add_dependency 'daemons'
+
+    # 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 technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION').chomp
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mysql-replication-helper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/replication-helper

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#
+# replication-helper  MySQL replication helper agent
+#
+# chkconfig: - 65 34
+# description: MySQL replication helper agent
+# processname: replication-helper
+# config: /etc/replication-helper.conf
+# pidfile: /var/run/replication-helper.pid
+#
+
+require 'rubygems'
+require 'daemons'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'mysql_replication_helper'
+
+daemon_script_path = File.expand_path('../lib/mysql_replication_helper/daemon_launcher.rb', File.dirname(__FILE__))
+
+if (!File.exist?(daemon_script_path))
+  daemon_script_path = Gem.required_location('mysql_replication_helper','mysql_replication_helper/daemon_launcher.rb')
+end
+
+Daemons.run(daemon_script_path)

data/lib/mysql_replication_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'mysql'
+
+module MysqlReplicationHelper
+  # == Autoloads ============================================================
+  
+  autoload(:Agent, 'mysql_replication_helper/agent')
+  autoload(:ErrorHandler, 'mysql_replication_helper/error_handler')
+  autoload(:Daemon, 'mysql_replication_helper/daemon')
+end

data/lib/mysql_replication_helper/agent.rb

@@ -0,0 +1,51 @@
+module MysqlReplicationHelper
+  class Agent
+    autoload(:Master, 'mysql_replication_helper/agent/master')
+    autoload(:Slave, 'mysql_replication_helper/agent/slave')
+
+    DEFAULT_OPTIONS = {
+      :host => 'localhost',
+      :user => 'root',
+      :master_socket => '/local/db/mysql.sock',
+      :slave_socket => '/ebs/db/mysql.sock'
+    }
+    
+    def initialize(options)
+      @options = with_default_options(options)
+    end
+    
+    def connection
+      @connection ||=
+        Mysql.real_connect(
+          @options[:host],
+          user_name,
+          @options[:password],
+          @options[:db],
+          @options[:port],
+          socket_name
+        )
+    end
+    
+    def user_name
+      @options[:user]
+    end
+    
+    def socket_name
+      @options[:socket]
+    end
+    
+    def with_default_options(options)
+      DEFAULT_OPTIONS.merge(options)
+    end
+    
+    def execute(statement)
+      STDERR.puts(statement)
+      connection.real_query(statement)
+    end
+    
+    def query(statement)
+      STDERR.puts(statement)
+      connection.query(statement)
+    end
+  end
+end

data/lib/mysql_replication_helper/agent/master.rb

@@ -0,0 +1,28 @@
+module MysqlReplicationHelper
+  class Agent
+    class Master < Agent
+      def poll!
+        # Nothing yet
+      end
+      
+      def master_status
+        row = query("SHOW MASTER STATUS").fetch_row
+        
+        return unless (row)
+        
+        {
+          :master_log_file => row[0],
+          :master_log_position => row[1].to_i
+        }
+      end
+      
+      def user_name
+        @options[:master_user] or super
+      end
+
+      def socket_name
+        @options[:master_socket] or super
+      end
+    end
+  end
+end

data/lib/mysql_replication_helper/agent/slave.rb

@@ -0,0 +1,68 @@
+module MysqlReplicationHelper
+  class Agent
+    class Slave < Agent
+      include MysqlReplicationHelper::ErrorHandler
+
+      def poll!
+        if (configured?)
+          if (error_message = slave_error)
+            if (statements = sql_to_recover_from(error_message))
+              statements.each do |sql|
+                connection.real_query(sql)
+              end
+            else
+              # Unrecoverable error?
+            end
+          end
+        else
+          assign_master(@options[:master])
+          start!
+        end
+      end
+      
+      def configured?
+        !!query("SHOW SLAVE STATUS").fetch_row
+      end
+      
+      def slave_error
+        row = query("SHOW SLAVE STATUS").fetch_row
+        
+        row and row[19]
+      end
+      
+      def assign_master(master)
+        master_status = master.master_status
+        
+        master_options =
+          {
+            'MASTER_HOST' => 'localhost',
+            'MASTER_USER' => master.user_name,
+            'MASTER_PORT' => 3306,
+            'MASTER_LOG_FILE' => master_status[:master_log_file],
+            'MASTER_LOG_POS' => master_status[:master_log_position]
+          }.collect do |k, v|
+            case (v)
+            when String:
+              "#{k}='#{Mysql.quote(v)}'"
+            else
+              "#{k}=#{v}"
+            end
+          end
+        
+        execute("CHANGE MASTER TO #{master_options * ', '}")
+      end
+      
+      def start!
+        execute("START SLAVE")
+      end
+      
+      def user_name
+        @options[:slave_user] or super
+      end
+
+      def socket_name
+        @options[:slave_socket] or super
+      end
+    end
+  end
+end

data/lib/mysql_replication_helper/daemon.rb

@@ -0,0 +1,18 @@
+module MysqlReplicationHelper
+  class Daemon
+    def initialize(options)
+      @options = options
+      
+      @options[:master] = @master = Agent::Master.new(options)
+      @options[:slave] = @slave = Agent::Slave.new(options)
+    end
+    
+    def run!
+      while (true)
+        @master.poll!
+        @slave.poll!
+        sleep(10)
+      end
+    end
+  end
+end

data/lib/mysql_replication_helper/daemon_launcher.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#
+# Daemonize module
+#
+
+require 'rubygems'
+require 'yaml'
+require 'optparse'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'mysql_replication_helper'
+
+# == Constants ==============================================================
+
+CONFIG_FILE_LOCATIONS = [
+  "/etc/replication-helper.conf",
+  "/etc/replication-helper/config",
+  "~/.replication-helper/config"
+].collect { |p| File.expand_path(p) }.freeze
+
+DEFAULT_CONFIG = {
+}
+
+# == Options ================================================================
+
+op = OptionParser.new
+options = { }
+config = { }
+config_file = nil
+
+op.on("--master-socket=s") { |socket| options[:master_socket] = socket }
+op.on("--master-data=s") { |dir| options[:master_data] = dir }
+op.on("--master-user=s") { |name| options[:master_user] = name }
+
+op.on("--slave-socket=s") { |socket| options[:slave_socket] = socket }
+op.on("--slave-data=s") { |dir| options[:slave_data] = dir }
+op.on("--slave-user=s") { |name| options[:slave_user] = name }
+
+op.on("-c", "--config=s") { |path| config_file = nil }
+op.on("-v", "--verbose") { options[:verbose] = true }
+op.on("-h", "--help") { show_help }
+
+args = op.parse(*ARGV)
+
+# == Configuration ==========================================================
+
+[ CONFIG_FILE_LOCATIONS, config_file ].flatten.each do |config_file|
+  if (File.exist?(config_file))
+    config = YAML.load(open(config_file))
+    break
+  end
+end
+
+config = DEFAULT_CONFIG.merge(config.inject({ }) { |h,(k,v)| h[k.to_sym] = v; h }).merge(options)
+
+
+# == Main ===================================================================
+
+MysqlReplicationHelper::Daemon.new(config).run!

data/lib/mysql_replication_helper/error_handler.rb

@@ -0,0 +1,24 @@
+module MysqlReplicationHelper
+  module ErrorHandler
+    def sql_to_recover_from(error)
+      case (error)
+      when /^Error 'Unknown database '([^\']+)'' on query/
+        [
+          "CREATE DATABASE `#{$1}`",
+          "START SLAVE"
+        ]
+      when /^Error 'There is no '([^\']+)'@'([^\']+)' registered' on query. Default database: '([^\']+)'./
+        [
+          "CREATE USER `#{$1}`@`#{$2}`",
+          "GRANT ALL PRIVILEGES ON `#{$3}`.* TO `#{$1}`@`#{$2}`",
+          "START SLAVE"
+        ]
+      when /^Error 'View '[^\']+' references invalid table\(s\) or column\(s\) or function\(s\) or definer\/invoker of view lack rights to use them' on query. Default database: '([^\']+)'. Query: 'CREATE .*? DEFINER=`([^\`]+)`@`([^\`]+)`/
+        [
+          "GRANT ALL PRIVILEGES ON `#{$1}`.* TO `#{$2}`@`#{$3}`",
+          "START SLAVE"
+        ]
+      end
+    end
+  end
+end

data/mysql-replication-helper.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mysql-replication-helper}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Scott Tadman}]
+  s.date = %q{2011-08-18}
+  s.email = %q{github@tadman.ca}
+  s.executables = [%q{replication-helper}]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "README.rdoc",
+    "Rakefile",
+    "bin/replication-helper",
+    "lib/mysql_replication_helper.rb",
+    "lib/mysql_replication_helper/agent.rb",
+    "lib/mysql_replication_helper/agent/master.rb",
+    "lib/mysql_replication_helper/agent/slave.rb",
+    "lib/mysql_replication_helper/daemon.rb",
+    "lib/mysql_replication_helper/daemon_launcher.rb",
+    "lib/mysql_replication_helper/error_handler.rb",
+    "mysql-replication-helper.gemspec",
+    "test/mysql_replication_helper/error_handler_test.rb",
+    "test/mysql_replication_helper_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/theworkinggroup/mysql-replication-helper}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{MySQL Replication Helper}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<daemons>, [">= 0"])
+    else
+      s.add_dependency(%q<daemons>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<daemons>, [">= 0"])
+  end
+end
+

data/test/mysql_replication_helper/error_handler_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class TestHandler
+  include MysqlReplicationHelper::ErrorHandler
+end
+
+class MysqlReplicationHelper::ErrorHandlerTest < Test::Unit::TestCase
+  def test_responses
+    handler = TestHandler.new
+    
+    [
+      [
+        "Error 'Unknown database 'example_db'' on query. Default database: 'example_db'.",
+        [ "CREATE DATABASE `example_db`", "START SLAVE" ]
+      ],
+      [
+        "Error 'There is no 'example_user'@'example_host' registered' on query. Default database: 'example_db'.",
+        [ "CREATE USER `example_user`@`example_host`", "GRANT ALL PRIVILEGES ON `example_db`.* TO `example_user`@`example_host`", "START SLAVE" ]
+      ],
+      [
+        "Error 'View 'example_db.example_table' references invalid table(s) or column(s) or function(s) or definer/invoker of view lack rights to use them' on query. Default database: 'example_db'. Query: 'CREATE ALGORITHM=UNDEFINED DEFINER=`example_user`@`example_host` SQL SECURITY DEFINER VIEW",
+        [ "GRANT ALL PRIVILEGES ON `example_db`.* TO `example_user`@`example_host`", "START SLAVE" ]
+      ]
+    ].each do |test_case|
+      assert_equal test_case[1], handler.sql_to_recover_from(test_case[0])
+    end
+  end
+end

data/test/mysql_replication_helper_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+class MysqlReplicationHelperTest < Test::Unit::TestCase
+  def test_module_init
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: mysql-replication-helper
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: &70228311548780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70228311548780
+description: 
+email: github@tadman.ca
+executables:
+- replication-helper
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .document
+- README.rdoc
+- Rakefile
+- bin/replication-helper
+- lib/mysql_replication_helper.rb
+- lib/mysql_replication_helper/agent.rb
+- lib/mysql_replication_helper/agent/master.rb
+- lib/mysql_replication_helper/agent/slave.rb
+- lib/mysql_replication_helper/daemon.rb
+- lib/mysql_replication_helper/daemon_launcher.rb
+- lib/mysql_replication_helper/error_handler.rb
+- mysql-replication-helper.gemspec
+- test/mysql_replication_helper/error_handler_test.rb
+- test/mysql_replication_helper_test.rb
+- test/test_helper.rb
+homepage: http://github.com/theworkinggroup/mysql-replication-helper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: MySQL Replication Helper
+test_files: []