mysql-slaver 0.1.8 → 0.1.9

data/README.md

@@ -14,15 +14,15 @@ ASSUMPTIONS/PRE-REQUISITES
 
 * localhost is configured as a mysql replication slave
 * the current localhost user can ssh to the db master
+* any ssh config settings required to access the master from localhost are set in a ~/.ssh/config file
+* ssh is on the current user's path
 * your mysql administrator user is called 'root', locally and on the db master
-* root user has the same password on this host and the master server
 * mysql is on the local user's path
 * mysql and mysqldump are on the remote ssh user's path
 * replication permissions from the local host to the db master are already setup
-* mysql is running on the default port (3306)
-* ssh is on the current user's path
+* root user has the same password on this host and the master server
+* mysql socket (if any) is the same on localhost and the db master
 * db character set is UTF-8
-* any ssh config settings for the host are set in a ~/.ssh/config file
 
 CAVEATS
 
@@ -35,7 +35,6 @@ TODO
 * check ssh connection and permissions
 * check replication permissions
 * check slave is setup as a replication slave (i.e. it has a mysql server id)
-* allow overriding the mysql port
-* allow overriding the mysql root user
+* allow a mysql admin username other than 'root'
 * allow different root user passwords on slave and master
 * allow ssh options

data/lib/mysql_slaver/cli.rb

@@ -4,13 +4,18 @@ module MysqlSlaver
     option :database,              :required => true, :desc => "The database to copy from the master"
     option :replication_user,      :required => true, :desc => "DB user (on the master host), with replication permissions"
     option :replication_password,  :required => true, :desc => "DB password for the replication user"
-    option :root_password,         :desc     => "Password for the mysql root user (on both master and slave)"
+
+    option :root_password,         :desc => "Password for the mysql root user (on both master and slave)"
+    option :port,                  :desc => "Mysql port (if not 3306)"
+    option :sock,                  :desc => "Mysql socket file (if any)"
+
     desc "enslave", "start mysql replication to this host from a master"
-    long_desc <<-LONGDESC
-    LONGDESC
+
     def enslave
       MysqlSlaver::Slaver.new(
           :master_host          => options[:master_host],
+          :port                 => options[:port],
+          :socket_file          => options[:sock],
           :mysql_root_password  => options[:root_password],
           :database             => options[:database],
           :replication_user     => options[:replication_user],

data/lib/mysql_slaver/db_copier.rb

@@ -2,22 +2,41 @@ module MysqlSlaver
   class DbCopier
     include MysqlCommand
 
-    attr_accessor :master_host, :mysql_root_password, :database, :executor
+    attr_accessor :master_host, :mysql_root_password, :database, :executor, :port, :socket_file
 
     def initialize(params)
       @master_host         = params.fetch(:master_host)
       @mysql_root_password = params.fetch(:mysql_root_password, '')
       @database            = params.fetch(:database)
+      @port                = params.fetch(:port, nil)
+      @socket_file         = params.fetch(:socket_file, nil)
       @executor            = params.fetch(:executor) { Executor.new }
     end
 
     def copy!
-      executor.execute mysql_command("stop slave", mysql_root_password)
-      cmd = mysqldump(master_host, database, mysql_root_password)
+      executor.execute mysql_command("stop slave", mysql_params)
+      cmd = mysqldump
       dump_cmd = executor.ssh_command(cmd, master_host)
-      load_cmd = ['mysql', mysql_credentials('root', mysql_root_password), database].join(' ')
+      load_cmd = ['mysql', mysql_credentials('root', mysql_params), database].join(' ')
       command = [dump_cmd, load_cmd].join(' | ')
       executor.execute command
     end
+
+    private
+
+    def mysql_params
+      {
+        :root_password => mysql_root_password,
+        :socket_file   => socket_file
+      }
+    end
+
+    def mysqldump
+      creds = mysql_credentials('root', mysql_params)
+      rtn =  %[mysqldump]
+      rtn << %[ -P #{port}] if port
+      rtn << %[ #{creds} -h #{master_host} --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress #{database}]
+      rtn
+    end
   end
 end

data/lib/mysql_slaver/master_changer.rb

@@ -2,10 +2,12 @@ module MysqlSlaver
   class MasterChanger
     include MysqlCommand
 
-    attr_accessor :master_host, :mysql_root_password, :replication_user, :replication_password, :executor
+    attr_accessor :master_host, :mysql_root_password, :replication_user, :replication_password, :executor, :port, :socket_file
 
     def initialize(params)
       @master_host          = params.fetch(:master_host)
+      @port                 = params.fetch(:port)
+      @socket_file          = params.fetch(:socket_file, nil)
       @mysql_root_password  = params.fetch(:mysql_root_password, '')
       @replication_user     = params.fetch(:replication_user)
       @replication_password = params.fetch(:replication_password)
@@ -18,14 +20,32 @@ module MysqlSlaver
         change_master(status),
         'start slave'
       ]
-      cmd = mysql_command(cmds.join('; '), mysql_root_password)
+      cmd = mysql_command(cmds.join('; '), mysql_params)
       executor.execute cmd
     end
 
     private
 
+    def mysql_params
+      {
+        :root_password => mysql_root_password,
+        :socket_file   => socket_file
+      }
+    end
+
     def change_master(status)
-      %[CHANGE MASTER TO MASTER_LOG_FILE='#{status[:file]}', MASTER_LOG_POS=#{status[:position]}, MASTER_HOST='#{master_host}', MASTER_USER='#{replication_user}', MASTER_PASSWORD='#{replication_password}']
+      %[CHANGE MASTER TO #{cmd_values(status)}]
+    end
+
+    def cmd_values(status)
+      [
+        "MASTER_LOG_FILE='#{status[:file]}'",
+        "MASTER_LOG_POS=#{status[:position]}",
+        "MASTER_HOST='#{master_host}'",
+        "MASTER_PORT=#{port}",
+        "MASTER_USER='#{replication_user}'",
+        "MASTER_PASSWORD='#{replication_password}'"
+      ].join(', ')
     end
   end
 end

data/lib/mysql_slaver/mysql_command.rb

@@ -1,19 +1,19 @@
 module MysqlSlaver
   module MysqlCommand
-    def mysql_credentials(user, password)
-      rtn = "-u #{user} "
-      rtn << "-p #{password} " unless password.to_s == ""
+    def mysql_credentials(user, params)
+      password    = params.fetch(:root_password, "")
+      socket_file = params.fetch(:socket_file, nil)
+
+      rtn = ""
+      rtn << "-S #{socket_file}" if socket_file
+      rtn << " -u #{user}"
+      rtn << " -p #{password}" unless password.to_s == ""
       rtn
     end
 
-    def mysql_command(cmd, password)
-      creds = mysql_credentials('root', password)
+    def mysql_command(cmd, params)
+      creds = mysql_credentials('root', params)
       %[mysql #{creds} -e "#{cmd}"]
     end
-
-    def mysqldump(host, database, password)
-      creds = mysql_credentials('root', password)
-      %[mysqldump -h #{host} #{creds} --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress #{database}]
-    end
   end
 end

data/lib/mysql_slaver/slaver.rb

@@ -9,12 +9,15 @@ module MysqlSlaver
     attr_reader :status_fetcher, :data_copier, :master_changer
 
     def initialize(params)
-      mysql_root_password  = params.fetch(:mysql_root_password, '')
+      mysql_root_password = params.fetch(:mysql_root_password, '')
+      port                = params.fetch(:port, 3306)
+      socket_file         = params.fetch(:socket_file, nil)
 
       @status_fetcher = params.fetch(:status_fetcher) {
         StatusFetcher.new(
           :master_host         => params.fetch(:master_host),
-          :mysql_root_password => mysql_root_password
+          :mysql_root_password => mysql_root_password,
+          :socket_file         => socket_file
         )
       }
 
@@ -22,7 +25,9 @@ module MysqlSlaver
         DbCopier.new(
           :master_host         => params.fetch(:master_host),
           :mysql_root_password => mysql_root_password,
-          :database            => params.fetch(:database)
+          :database            => params.fetch(:database),
+          :port                => port,
+          :socket_file         => socket_file
         )
       }
 
@@ -31,7 +36,9 @@ module MysqlSlaver
           :master_host          => params.fetch(:master_host),
           :mysql_root_password  => mysql_root_password,
           :replication_user     => params.fetch(:replication_user),
-          :replication_password => params.fetch(:replication_password)
+          :replication_password => params.fetch(:replication_password),
+          :port                 => port,
+          :socket_file          => socket_file
         )
       }
     end

data/lib/mysql_slaver/status_fetcher.rb

@@ -3,16 +3,18 @@ module MysqlSlaver
     include Logger
     include MysqlCommand
 
-    attr_accessor :master_host, :mysql_root_password, :executor
+    attr_accessor :master_host, :mysql_root_password, :executor, :socket_file
 
     def initialize(params)
-      @master_host          = params.fetch(:master_host)
-      @mysql_root_password  = params.fetch(:mysql_root_password, '')
-      @executor             = params.fetch(:executor) { Executor.new }
+      @master_host         = params.fetch(:master_host)
+      @socket_file         = params.fetch(:socket_file, nil)
+      @mysql_root_password = params.fetch(:mysql_root_password, '')
+      @executor            = params.fetch(:executor) { Executor.new }
     end
 
     def status
-      cmd = mysql_command("show master status\\G", mysql_root_password)
+      params = {:root_password => mysql_root_password, :socket_file => socket_file}
+      cmd = mysql_command("show master status\\G", params)
       data = executor.execute executor.ssh_command(cmd, master_host)
       rtn = parse data
       log "MASTER STATUS - file: #{rtn[:file]}, position: #{rtn[:position]}"

data/spec/mysql_slaver/db_copier_spec.rb

@@ -17,23 +17,50 @@ module MysqlSlaver
     describe "#copy!" do
       it "stops slave" do
         copier.copy!
-        stop = %[mysql -u root -p supersekrit  -e "stop slave"]
+        stop = %[mysql  -u root -p supersekrit -e "stop slave"]
         expect(executor).to have_received(:execute).with(stop)
       end
 
       it "loads data" do
-        dump_and_load = "dummy-ssh-command | mysql -u root -p supersekrit  myappdb"
+        dump_and_load = "dummy-ssh-command | mysql  -u root -p supersekrit myappdb"
         expect(executor).to receive(:execute).once.ordered.with(dump_and_load)
         copier.copy!
       end
 
       context "dumping" do
         it "issues mysqldump over ssh" do
-          dump = "mysqldump -h my.db.host -u root -p supersekrit  --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress myappdb"
+          dump = "mysqldump  -u root -p supersekrit -h my.db.host --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress myappdb"
           expect(executor).to receive(:ssh_command).with(dump, 'my.db.host')
           copier.copy!
         end
       end
     end
+
+    context "with a non-standard mysql port" do
+      let(:params) { super().merge(:port => 3307) }
+
+      it "issues mysqldump over ssh" do
+        dump = "mysqldump -P 3307  -u root -p supersekrit -h my.db.host --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress myappdb"
+        expect(executor).to receive(:ssh_command).with(dump, 'my.db.host')
+        copier.copy!
+      end
+    end
+
+    context "with a socket file" do
+      let(:params) { super().merge(:socket_file => "/tmp/mysql.sock") }
+
+      it "issues mysqldump over ssh" do
+        dump = "mysqldump -S /tmp/mysql.sock -u root -p supersekrit -h my.db.host --master-data --single-transaction --quick --skip-add-locks --skip-lock-tables --default-character-set=utf8 --compress myappdb"
+        expect(executor).to receive(:ssh_command).with(dump, 'my.db.host')
+        copier.copy!
+      end
+
+      it "loads data" do
+        dump_and_load = "dummy-ssh-command | mysql -S /tmp/mysql.sock -u root -p supersekrit myappdb"
+        expect(executor).to receive(:execute).once.ordered.with(dump_and_load)
+        copier.copy!
+      end
+
+    end
   end
 end

data/spec/mysql_slaver/master_changer_spec.rb

@@ -8,6 +8,7 @@ module MysqlSlaver
     let(:params) {
       {
         :master_host          => 'my.db.host',
+        :port                 => 3306,
         :mysql_root_password  => 'supersekrit',
         :replication_user     => 'repluser',
         :replication_password => 'replpassword',
@@ -18,7 +19,27 @@ module MysqlSlaver
 
     describe "#change!" do
       it "executes multi-part mysql command" do
-        change_cmd = %[mysql -u root -p supersekrit  -e "stop slave; CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin.001555', MASTER_LOG_POS=18426246, MASTER_HOST='my.db.host', MASTER_USER='repluser', MASTER_PASSWORD='replpassword'; start slave"]
+        change_cmd = %[mysql  -u root -p supersekrit -e "stop slave; CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin.001555', MASTER_LOG_POS=18426246, MASTER_HOST='my.db.host', MASTER_PORT=3306, MASTER_USER='repluser', MASTER_PASSWORD='replpassword'; start slave"]
+        changer.change!(status)
+        expect(executor).to have_received(:execute).with(change_cmd)
+      end
+    end
+
+    context "with a non-standard mysql port" do
+      let(:params) { super().merge(:port => 3307) }
+
+      it "executes multi-part mysql command" do
+        change_cmd = %[mysql  -u root -p supersekrit -e "stop slave; CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin.001555', MASTER_LOG_POS=18426246, MASTER_HOST='my.db.host', MASTER_PORT=3307, MASTER_USER='repluser', MASTER_PASSWORD='replpassword'; start slave"]
+        changer.change!(status)
+        expect(executor).to have_received(:execute).with(change_cmd)
+      end
+    end
+
+    context "with a mysql socket file" do
+      let(:params) { super().merge(:socket_file => "/tmp/mysql.sock") }
+
+      it "executes multi-part mysql command" do
+        change_cmd = %[mysql -S /tmp/mysql.sock -u root -p supersekrit -e "stop slave; CHANGE MASTER TO MASTER_LOG_FILE='mysql-bin.001555', MASTER_LOG_POS=18426246, MASTER_HOST='my.db.host', MASTER_PORT=3306, MASTER_USER='repluser', MASTER_PASSWORD='replpassword'; start slave"]
         changer.change!(status)
         expect(executor).to have_received(:execute).with(change_cmd)
       end

data/spec/mysql_slaver/slaver_spec.rb

@@ -64,6 +64,36 @@ module MysqlSlaver
         expect(changer.mysql_root_password).to eq('supersekrit')
         expect(changer.replication_user).to eq('repluser')
         expect(changer.replication_password).to eq('replpassword')
+        expect(changer.port).to eq(3306)
+      end
+
+      context "with non-standard mysql port" do
+        let(:params) { super().merge(:port => 3307) }
+
+        it "instantiates a master changer" do
+          changer = slaver.master_changer
+          expect(changer.port).to eq(3307)
+        end
+      end
+
+      context "with mysql socket" do
+        let(:params) { super().merge(:socket_file => "/tmp/mysql.sock") }
+
+        it "instantiates a status fetcher" do
+          fetcher = slaver.status_fetcher
+          expect(fetcher.socket_file).to eq("/tmp/mysql.sock")
+        end
+
+        it "instantiates a master changer" do
+          changer = slaver.master_changer
+          expect(changer.socket_file).to eq("/tmp/mysql.sock")
+        end
+
+        it "instantiates a data copier" do
+          copier = slaver.data_copier
+          expect(copier.socket_file).to eq("/tmp/mysql.sock")
+        end
+
       end
     end
   end

data/spec/mysql_slaver/status_fetcher_spec.rb

@@ -32,7 +32,7 @@ EOF
       end
         
       it "executes show master command over ssh" do
-        show_master = %[mysql -u root -p supersekrit  -e "show master status\\G"]
+        show_master = %[mysql  -u root -p supersekrit -e "show master status\\G"]
         fetcher.status
         expect(executor).to have_received(:ssh_command).with(show_master, 'my.db.host')
       end
@@ -41,5 +41,15 @@ EOF
         expect(fetcher.status).to eq({:file => 'mysql-bin.003219', :position => '37065270'})
       end
     end
+
+    context "using a socket filename" do
+      let(:params) { super().merge(:socket_file => "/var/run/mysqld/mysqld.master.sock") }
+
+      it "executes show master command over ssh" do
+        show_master = %[mysql -S /var/run/mysqld/mysqld.master.sock -u root -p supersekrit -e "show master status\\G"]
+        fetcher.status
+        expect(executor).to have_received(:ssh_command).with(show_master, 'my.db.host')
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mysql-slaver
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - David Salgado
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-04-17 00:00:00 Z
+date: 2014-04-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec