mysql-slaver 0.1.9 → 0.1.10

data/README.md

@@ -14,7 +14,7 @@ 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
+* any ssh config settings, other than a port number, 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
 * mysql is on the local user's path
@@ -30,11 +30,10 @@ CAVEATS
 
 TODO
 
-* add a "no copying" mode that only updates master log file and position
+* output better help (include optional params, format better (shorter lines))
 * add a "dry-run" mode
-* check ssh connection and permissions
+* check ssh connection
 * check replication permissions
 * check slave is setup as a replication slave (i.e. it has a mysql server id)
 * 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

@@ -1,21 +1,24 @@
 module MysqlSlaver
   class CLI < ::Thor
+    desc "enslave", "Start MySQL replication to this host from a master"
+
     option :master_host,           :required => true, :desc => "The server which will be the replication master, for this slave"
     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 :port,                  :desc => "Mysql port (if not 3306)"
+    option :ssh_port,              :desc => "SSH port (if not 22)"
     option :sock,                  :desc => "Mysql socket file (if any)"
-
-    desc "enslave", "start mysql replication to this host from a master"
+    option :no_copy,               :type => :boolean, :desc => "Do not copy data - just change master status"
 
     def enslave
       MysqlSlaver::Slaver.new(
           :master_host          => options[:master_host],
           :port                 => options[:port],
+          :ssh_port             => options[:ssh_port],
           :socket_file          => options[:sock],
+          :no_copy              => options[:no_copy],
           :mysql_root_password  => options[:root_password],
           :database             => options[:database],
           :replication_user     => options[:replication_user],

data/lib/mysql_slaver/db_copier.rb

@@ -10,7 +10,7 @@ module MysqlSlaver
       @database            = params.fetch(:database)
       @port                = params.fetch(:port, nil)
       @socket_file         = params.fetch(:socket_file, nil)
-      @executor            = params.fetch(:executor) { Executor.new }
+      @executor            = params.fetch(:executor) { Executor.new(:ssh_port => params[:ssh_port]) }
     end
 
     def copy!

data/lib/mysql_slaver/executor.rb

@@ -1,9 +1,19 @@
 module MysqlSlaver
   class Executor
+    attr_reader :ssh_port
+
     include Logger
 
+    def initialize(params = {})
+      @ssh_port = params[:ssh_port]
+    end
+
     def ssh_command(cmd, host)
-      "ssh #{host} '#{cmd}'"
+      if ssh_port
+        "ssh -p #{ssh_port} #{host} '#{cmd}'"
+      else
+        "ssh #{host} '#{cmd}'"
+      end
     end
 
     def execute(cmd)

data/lib/mysql_slaver/slaver.rb

@@ -6,18 +6,21 @@
 # connection)
 module MysqlSlaver
   class Slaver
-    attr_reader :status_fetcher, :data_copier, :master_changer
+    attr_reader :status_fetcher, :data_copier, :master_changer, :no_copy
 
     def initialize(params)
       mysql_root_password = params.fetch(:mysql_root_password, '')
       port                = params.fetch(:port, 3306)
+      ssh_port            = params.fetch(:ssh_port, 22)
       socket_file         = params.fetch(:socket_file, nil)
+      @no_copy            = params.fetch(:no_copy, false)
 
       @status_fetcher = params.fetch(:status_fetcher) {
         StatusFetcher.new(
           :master_host         => params.fetch(:master_host),
           :mysql_root_password => mysql_root_password,
-          :socket_file         => socket_file
+          :socket_file         => socket_file,
+          :ssh_port            => ssh_port
         )
       }
 
@@ -27,7 +30,8 @@ module MysqlSlaver
           :mysql_root_password => mysql_root_password,
           :database            => params.fetch(:database),
           :port                => port,
-          :socket_file         => socket_file
+          :socket_file         => socket_file,
+          :ssh_port            => ssh_port
         )
       }
 
@@ -45,7 +49,7 @@ module MysqlSlaver
 
     def enslave!
       master_status = status_fetcher.status
-      data_copier.copy!
+      data_copier.copy! unless no_copy
       master_changer.change!(master_status)
     end
   end

data/lib/mysql_slaver/status_fetcher.rb

@@ -9,7 +9,7 @@ module MysqlSlaver
       @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 }
+      @executor            = params.fetch(:executor) { Executor.new(:ssh_port => params[:ssh_port]) }
     end
 
     def status

data/spec/mysql_slaver/executor_spec.rb

@@ -2,12 +2,23 @@ require 'spec/spec_helper'
 
 module MysqlSlaver
   describe Executor do
-    subject(:executor) { described_class.new }
+    let(:ssh_port) { nil }
+    let(:params)   { {:ssh_port => ssh_port} }
+
+    subject(:executor) { described_class.new(params) }
 
     describe "#ssh_command" do
       it "formats command" do
         expect(executor.ssh_command("foo", "myhost")).to eq("ssh myhost 'foo'")
       end
+
+      context "with non-standard ssh port" do
+        let(:ssh_port) { 64389 }
+
+        it "formats command" do
+          expect(executor.ssh_command("foo", "myhost")).to eq("ssh -p 64389 myhost 'foo'")
+        end
+      end
     end
   end
 end

data/spec/mysql_slaver/slaver_spec.rb

@@ -32,6 +32,24 @@ module MysqlSlaver
         expect(master_changer).to have_received(:change!)
       end
 
+      context "no-copy" do
+        let(:params) { super().merge(:no_copy => true) }
+
+        it "fetches master status" do
+          slaver.enslave!
+          expect(status_fetcher).to have_received(:status)
+        end
+
+        it "doesn't copy data" do
+          slaver.enslave!
+          expect(data_copier).to_not have_received(:copy!)
+        end
+
+        it "changes master status" do
+          slaver.enslave!
+          expect(master_changer).to have_received(:change!)
+        end
+      end
     end
 
     context "instantiating collaborators" do
@@ -76,6 +94,20 @@ module MysqlSlaver
         end
       end
 
+      context "with non-standard ssh port" do
+        let(:params) { super().merge(:ssh_port => 64389) }
+
+        it "instantiates a status fetcher" do
+          fetcher = slaver.status_fetcher
+          expect(fetcher.executor.ssh_port).to eq(64389)
+        end
+
+        it "instantiates a data copier" do
+          copier = slaver.data_copier
+          expect(copier.executor.ssh_port).to eq(64389)
+        end
+      end
+
       context "with mysql socket" do
         let(:params) { super().merge(:socket_file => "/tmp/mysql.sock") }
 
@@ -93,7 +125,6 @@ module MysqlSlaver
           copier = slaver.data_copier
           expect(copier.socket_file).to eq("/tmp/mysql.sock")
         end
-
       end
     end
   end

metadata

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