vagrant-cloner 2.0.0 → 2.1.0

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vagrant-cloner.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'pry'
+end

data/README.md

@@ -43,6 +43,7 @@ The following keys are valid:
         - **enabled** - Required: Boolean whether to use this cloner or not. Defaults to false.
         - **run_order** - Suggested: Integer value that dictates which order cloners run in. Lower orders run first. Defaults to 1000.
     - **mysql**
+        - **use_ssh** - If false, will attempt to connect to the remote MySQL server at the `remote_host` using the `remote_user` and `remote_password` settings. Elsewise, will SSH into the remote host, export the database, download it locally, upload it to the VM, and install it that way.
         - **remote_host** - String containing the remote server's FQDN.
         - **remote_user** - Username to connect to remote server.
         - **remote_password** - Optional: Password to connect to remote server. (Can be ignored if using publickey auth.)

data/lib/vagrant-cloner/base_cloner.rb

@@ -63,9 +63,14 @@ module VagrantCloner
     # Wrap debugging options.
     %w(info warn error success).each do |meth|
       define_method(meth) do |message|
-        @machine.env.ui.send(meth.to_sym, message)
+        machine.env.ui.send(meth.to_sym, message)
       end
       protected meth.to_sym
     end
+
+    def debug(message)
+      machine.env.ui.info message
+    end
+    protected :debug
   end
 end

data/lib/vagrant-cloner/cloners/mysql.rb

@@ -3,7 +3,7 @@ module VagrantCloner
     class MysqlCloner < ::VagrantCloner::BaseCloner
 
       attr_accessor   :remote_host, :remote_user, :remote_password,
-                      :remote_db_user, :remote_db_password,
+                      :remote_db_user, :remote_db_password, :use_ssh,
                       :vm_db_user, :vm_db_password,
                       :databases_to_clone,
                       :remote_backup_path, :local_backup_path, :vm_backup_path, :backup_file,
@@ -16,12 +16,11 @@ module VagrantCloner
       def validate(machine, errors)
         failures = []
         failures.push "Must specify a remote user and host." unless remote_user && remote_host
-        failures.push "Must specify a remote database user and password." unless remote_db_user && remote_db_password
+        failures.push "Must specify a remote database user and password." unless (remote_db_user && remote_db_password) || use_ssh
         unless warned_about_password or remote_password
           machine.env.ui.warn "You haven't specified a remote password. Pulling down MySQL databases may fail unless you have proper publickey authentication enabled."
           @warned_about_password = true
         end
-
         errors.merge(name.to_sym => failures) if failures.any?
       end
 
@@ -54,6 +53,11 @@ module VagrantCloner
       end
       alias_method :disable_cleanup?, :disable_cleanup
 
+      def use_ssh
+        @use_ssh.nil? ? true : @use_ssh
+      end
+      alias_method :use_ssh?, :use_ssh
+
 
       def extract_relevant_options
         @enabled                = options.enabled
@@ -63,6 +67,8 @@ module VagrantCloner
         @remote_db_user         = options.remote_db_user
         @remote_db_password     = options.remote_db_password
 
+        @use_ssh                = options.use_ssh
+
         @databases_to_clone     = options.databases_to_clone
 
         @vm_db_user             = options.vm_db_user
@@ -75,9 +81,9 @@ module VagrantCloner
         @vm_backup_path         = options.vm_backup_path
         @backup_file            = options.backup_file || "mysql-backup-#{datestring}.sql"
 
-        @remote_backup_location = File.join(@remote_backup_path, @backup_file)
-        @local_backup_location  = File.join(@local_backup_path, @backup_file)
-        @vm_backup_location     = File.join(@vm_backup_path, @backup_file)
+        @remote_backup_location = File.join(remote_backup_path, @backup_file)
+        @local_backup_location  = File.join(local_backup_path, @backup_file)
+        @vm_backup_location     = File.join(vm_backup_path, @backup_file)
       end
 
       def mysql_database_flag
@@ -88,16 +94,39 @@ module VagrantCloner
         end
       end
 
+      # We don't want to output -p if password is nil, because that will prompt
+      # for a password.
+      def mysql_password_flag(password)
+        if password.nil? || password.empty?
+          ""
+        else
+          %Q{ -p"#{password}"}
+        end
+      end
+
       def call
         extract_relevant_options
-        dump_remote_database
-        download_remote_database
-        import_database
-        clean_up
+        if use_ssh?
+          dump_remote_database
+          download_remote_database
+          import_database
+          clean_up
+        else
+          remote_dump_and_pipe
+        end
+      end
+
+      def remote_dump_and_pipe
+        info "Doing remote mysqldump..."
+        command = %Q{mysqldump --verbose -h #{@remote_host} -u"#{@remote_user}"#{mysql_password_flag(@remote_password)} #{mysql_database_flag} | mysql -u"#{@vm_db_user}"#{mysql_password_flag(@vm_db_password)}}
+        vm.tap do |host|
+          vm.execute command
+        end
+        info "All done!"
       end
 
       def dump_remote_database
-        command = "mysqldump -u#{@remote_db_user} -p#{@remote_db_password} #{mysql_database_flag} > #{@remote_backup_location}"
+        command = %Q{mysqldump -u"#{@remote_db_user}"#{mysql_password_flag(@remote_db_password)} #{mysql_database_flag} > #{@remote_backup_location}}
         ssh(*remote_credentials) {|s| s.exec! command }
         info "Finished dumping database!"
       end
@@ -110,7 +139,8 @@ module VagrantCloner
       def import_database
         vm.tap do |host|
           host.upload @local_backup_location, @vm_backup_location
-          host.execute "mysql -u#{@vm_db_user} -p#{@vm_db_password} < #{@vm_backup_location}"
+          command = %Q{mysql -u"#{@vm_db_user}"#{mysql_password_flag(@vm_db_password)} < #{@vm_backup_location}}
+          host.execute command
         end
         info "Done loading database."
       end
@@ -120,11 +150,13 @@ module VagrantCloner
           ssh(*remote_credentials) {|s| s.exec! "rm #{@remote_backup_location}" } and info "Removed remote backup file."
           system "rm #{@local_backup_location}" and info "Removed local backup file."
           vm.execute "rm #{@vm_backup_location}" and info "Removed vm backup file."
-          info "Done!"
+          success "Done!"
         end
       end
     end
   end
 end
 
-VagrantCloner::ClonerContainer.instance.send("#{VagrantCloner::Cloners::MysqlCloner.instance.name}=".to_sym, VagrantCloner::Cloners::MysqlCloner.instance)
+if defined? VagrantCloner::ClonerContainer
+  VagrantCloner::ClonerContainer.instance.send("#{VagrantCloner::Cloners::MysqlCloner.instance.name}=".to_sym, VagrantCloner::Cloners::MysqlCloner.instance)
+end

data/spec/cloners/mysql_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'pry'
+require 'ostruct'
+
+# Mock this
+module VagrantCloner
+  class BaseCloner
+    def datestring; "2013-01-01"; end
+  end
+end
+
+require 'vagrant-cloner/cloners/mysql'
+
+module VagrantCloner
+  module Cloners
+    describe MysqlCloner do
+      describe "#extract_relevant_options" do
+        describe "when missing keys" do
+          before do 
+            subject.stub!(:options).and_return(OpenStruct.new({:remote_db_password => ''}))
+            subject.extract_relevant_options
+          end
+          
+          its(:remote_db_password) { should be_empty }
+        end
+      end
+
+      describe "#mysql_password_flag" do
+        it "produces nothing if password is nil or empty" do
+          result = subject.mysql_password_flag("")
+          result.should be_empty
+        end
+
+        it "outputs the flag if password is present" do
+          result = subject.mysql_password_flag("test")
+          result.should == %Q{ -p"test"}
+        end
+      end
+    end
+  end
+end

data/vagrant-cloner.gemspec

@@ -2,7 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-version = '2.0.0'
+version = '2.1.0'
 
 Gem::Specification.new do |gem|
   gem.name          = "vagrant-cloner"
@@ -14,8 +14,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/rjocoleman/vagrant-cloner/"
 
   gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
   # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  # gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   
   gem.signing_key = '/Users/rjocoleman/.gemcert/gem-private_key.pem'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cloner
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -39,7 +39,7 @@ cert_chain:
   ME9XOXNmTwoxbjFNamRBaGZra1VWeHJiamZHT0VqcFRlZVEzckFjSGtVTkFX
   TkxlSWVIKzJ6OHNrYTZ6QUhsNDFhVT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUt
   LS0tLQo=
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies: []
 description: Copy production resources down to your new VM.
 email:
@@ -65,6 +65,8 @@ files:
 - lib/vagrant-cloner/plugin.rb
 - lib/vagrant-cloner/provisioner.rb
 - lib/vagrant_init.rb
+- spec/cloners/mysql_spec.rb
+- spec/spec_helper.rb
 - vagrant-cloner.gemspec
 homepage: https://github.com/rjocoleman/vagrant-cloner/
 licenses: []
@@ -90,4 +92,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Copy production resources down to your new VM.
-test_files: []
+test_files:
+- spec/cloners/mysql_spec.rb
+- spec/spec_helper.rb