vagrant-cloner 0.9.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-cloner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rob Yurkowski
+
+MIT License
+
+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.md

@@ -0,0 +1,124 @@
+# vagrant-cloner
+
+Copy down production resources to your new Vagrant VM.
+
+## Installation
+
+Use vagrant's built-in gem system:
+
+    vagrant gem install vagrant-cloner
+
+## Usage
+
+You will need to add a `config.vm.provision :cloner` section to your config in
+order for Cloner to work. This should come after your other provisioners; if
+Cloner runs before Chef or Puppet, for example, it's quite conceivable there 
+would be no database to restore to!
+
+Each cloner has its own section inside the configuration, and this is the
+recommended way to set them:
+
+``` ruby
+Vagrant::Config.run do |config|
+
+  config.vm.provision :chef_solo do |chef|
+    # ...
+  end
+
+  config.vm.provision :cloner do |cfg|
+    cfg.cloners.mysql.tap do |c|
+      # Set options here.
+      c.enabled = true
+      c.run_order = 10
+      # ...
+    end
+  end
+end
+```
+
+The following keys are valid:
+
+- **cloners**
+    - **(all cloners)**
+        - **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**
+        - **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.)
+        - **remote_db_user** - Username to remote database server.
+        - **remote_db_password** - Password to remote database server.
+        - **vm_db_user** - Username to database server on VM.
+        - **vm_db_password** - Password to database server on VM.
+        - **databases_to_clone** - Optional: Array of databases to copy down. Defaults to 'all'.
+        - **remote_backup_path** - Optional: Where to dump databases to on remote server. Defaults to '/tmp'.
+        - **local_backup_path** - Optional: Where to store databases on host machine. Defaults to '/tmp'.
+        - **vm_backup_path** - Optional: Where to upload databases on VM. Defaults to '/tmp'.
+        - **backup_file** - Optional: Name for database dump. Defaults to mysql-dump-YYYY-MM-DD.sql.
+        - **disable_cleanup** - Optional: Don't remove database dumps after completion. Defaults to false.
+    - **testcloner**
+        - **foo** - String containing a message to print to console.
+    - **mysqlcleaner**
+        - **scripts** -- Array containing strings of URLs of remote SQL files to be run against the VM's database.
+        - **vm_db_user** - Username to database server on VM.
+        - **vm_db_password** - Password to database server on VM.
+
+If you have some concern about storing passwords in this file (i.e. your Vagrantfile
+is under version control), remember that the Vagrantfile is fully executed, so you can
+simply require a file from elsewhere or read values in.
+
+## Current List of Supplied Cloners
+
+- `mysql` - Import a MySQL database(s)
+- `testcloner` - A simple example of a cloner not meant for use.
+- `mysqlcleaner` - Runs arbitrary SQL scripts against the MySQL server. Useful for sanitizing databases imported by the `mysql` cloner.
+
+## Extra Cloners
+
+You can write your own cloners to use with the tool. Unfortunately, because of how Vagrant loads its configuration settings, it's not possible to store these in a directory that is not in the gem itself.
+
+Our suggestion is as follows:
+
+1. Fork the gem and git-clone it;
+2. Add your own cloner inside lib/vagrant-cloner/cloners/;
+3. Add your configuration settings inside your Vagrantfile;
+4. Run `rake build`;
+5. Run `vagrant gem install vagrant-cloner --local ./pkg/`
+6. Resume using vagrant as usual.
+
+If you make an error in your script, you may have a hard time uninstalling it with `vagrant gem uninstall`. In a trice, you can remove directories in `~/.vagrant.d/gems/gems/` to manually remove troublesome gems. (Note that this was tested on a Linux distribution, so this may vary for Mac and Windows users.)
+
+## How to Write a Cloner
+
+To operate as a cloner, a class must inherit from `Vagrant::Cloners::Cloner`, and implement at a bare minimum these methods:
+
+- `name` - Returns a string representation of the cloner's name; used for namespacing config.
+- `validate!(env, errors)` - Can be used to call `errors.add` if there are validations that need to be performed on configuration values.
+- `call` - Executes the cloner's routine.
+
+A cloner must also be registered in the config to be run. This is best done after the class has been closed, at the bottom of the file:
+
+`Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner <Class>.instance.name, <Class>.instance`
+
+So for the MySQL cloner (which is `Vagrant::Cloners::MysqlCloner`), the line would read 
+
+`Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Vagrant::Cloners::MysqlCloner.instance.name, Vagrant::Cloners::MysqlCloner.instance`
+
+A very minimal example [can be found in the cloners directory](lib/vagrant-cloner/cloners/testcloner.rb). For more detailed examples, look at the other cloners there!
+
+### How is this possibly useful for me?
+
+`Cloner` exposes the `ssh`, `scp`, and `vm` methods to your class, so, in combination with `Kernel#system`, you can do pretty much anything on either host, VM, or remote server that you can do in (z|ba)sh.
+
+The `vm` method, as an aside, is just a reference to the SSH communicator of Vagrant, so you can see what it provides [here](https://github.com/mitchellh/vagrant/blob/master/plugins/communicators/ssh/communicator.rb). If you need to actually access the environment, that is made available through the `env` method.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+6. Explain why you think this belongs in the code here, and not inside your own gem that requires this one.
+
+Pull requests most graciously accepted.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-cloner.rb

@@ -0,0 +1,8 @@
+require 'vagrant'
+require 'vagrant-cloner/provisioner'
+require 'vagrant-cloner/config'
+require 'vagrant-cloner/cloner'
+
+Dir[File.join(File.dirname(__FILE__), 'vagrant-cloner', 'cloners', '*.rb')].each {|f| require f }
+
+Vagrant.provisioners.register(:cloner, Vagrant::Provisioners::Cloner)

data/lib/vagrant-cloner/cloner.rb

@@ -0,0 +1,72 @@
+require 'net/ssh'
+require 'net/scp'
+require 'date'
+require 'singleton'
+
+module Vagrant
+  module Cloners
+    # Cloner defines the base API that a cloner has to modify a VM or remote systems.
+    # TODO: Create a method that downloads to local and then uploads to VM?
+
+    class Cloner
+      include Singleton
+
+      attr_accessor :enabled, :env, :options, :run_order
+
+      def name
+        raise "Cloner must define #name and return a string."
+      end
+
+      def validate!(env, errors)
+        true
+      end
+
+      def enabled?
+        @enabled.nil? ? false : @enabled
+      end
+
+      def run_order
+        @run_order ||= 1000
+      end
+
+      # Shorthand for addressing the SSH communicator to the VM. View available methods
+      # here:
+      # https://github.com/mitchellh/vagrant/blob/master/plugins/communicators/ssh/communicator.rb
+      def vm
+        env[:vm].channel
+      end
+
+      # Opens an SSH connection to an arbitrary server and passes it to a supplied block.
+      #
+      # See netssh documentation for further method options.
+      # http://net-ssh.github.com/net-ssh/
+      def ssh(*args, &block)
+        Net::SSH.start(*args, &block)
+      end
+
+      # Opens an SCP connection to an arbitrary server, downloading or uploading to the
+      # machine currently in scope (whether the host machine or the VM).
+      # Recommended params:
+      #   remote_host, remote_user, {:password => remote_password}
+      #
+      # See netscp documentation for further method options.
+      # https://github.com/net-ssh/net-scp
+      def scp(*args, &block)
+        Net::SCP.start(*args, &block)
+      end
+
+      def datestring
+        Date.today.to_s
+      end
+      protected :datestring
+
+      # Wrap debugging options.
+      %w(info warn error success).each do |meth|
+        define_method(meth) do |message|
+          env[:ui].send(meth.to_sym, message)
+        end
+        protected meth.to_sym
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+module Vagrant
+  module Cloners
+    class MysqlCloner < Cloner
+
+      attr_accessor   :remote_host, :remote_user, :remote_password,
+                      :remote_db_user, :remote_db_password,
+                      :vm_db_user, :vm_db_password,
+                      :databases_to_clone,
+                      :remote_backup_path, :local_backup_path, :vm_backup_path, :backup_file,
+                      :disable_cleanup, :warned_about_password
+
+      def name
+        "mysql"
+      end
+
+      def validate!(env, errors)
+        errors.add "Must specify a remote user and host." unless remote_user && remote_host
+        errors.add "Must specify a remote database user and password." unless remote_db_user && remote_db_password
+        unless warned_about_password or remote_password
+          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
+      end
+
+      def remote_credentials
+        return @remote_credentials unless @remote_credentials.nil?
+
+        creds = [@remote_host, @remote_user]
+        creds.push :password => remote_password if remote_password
+        creds
+      end
+
+      def databases_to_clone
+        @databases_to_clone ||= []
+      end
+
+      def remote_backup_path
+        @remote_backup_path ||= "/tmp"
+      end
+
+      def local_backup_path
+        @local_backup_path ||= "/tmp"
+      end
+
+      def vm_backup_path
+        @vm_backup_path ||= "/tmp"
+      end
+
+      def disable_cleanup
+        @disable_cleanup.nil? ? false : @disable_cleanup
+      end
+      alias_method :disable_cleanup?, :disable_cleanup
+
+
+      def extract_relevant_options
+        @enabled                = options.enabled
+        @remote_host            = options.remote_host
+        @remote_user            = options.remote_user
+        @remote_password        = options.remote_password
+        @remote_db_user         = options.remote_db_user
+        @remote_db_password     = options.remote_db_password
+
+        @databases_to_clone     = options.databases_to_clone
+
+        @vm_db_user             = options.vm_db_user
+        @vm_db_password         = options.vm_db_password
+
+        @remote_credentials     = options.remote_credentials
+
+        @remote_backup_path     = options.remote_backup_path
+        @local_backup_path      = options.local_backup_path
+        @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)
+      end
+
+      def mysql_database_flag
+        if @databases_to_clone.include?("*") || @databases_to_clone.empty?
+          "--all-databases"
+        else
+          "--databases #{Array(@databases_to_clone).join(' ')}"
+        end
+      end
+
+      def call
+        extract_relevant_options
+        dump_remote_database
+        download_remote_database
+        import_database
+        clean_up
+      end
+
+      def dump_remote_database
+        command = "mysqldump -u#{@remote_db_user} -p#{@remote_db_password} #{mysql_database_flag} > #{@remote_backup_location}"
+        ssh(*remote_credentials) {|s| s.exec! command }
+        info "Finished dumping database!"
+      end
+
+      def download_remote_database
+        scp(*remote_credentials) {|s| s.download! @remote_backup_location, @local_backup_path }
+        info "Finished downloading file."
+      end
+
+      def import_database
+        vm.upload @local_backup_location, @vm_backup_location
+        vm.execute "mysql -u#{@vm_db_user} -p#{@vm_db_password} < #{@vm_backup_location}"
+        info "Done loading database."
+      end
+
+      def clean_up
+        unless disable_cleanup?
+          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!"
+        end
+      end
+    end
+  end
+end
+
+Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Vagrant::Cloners::MysqlCloner.instance.name, Vagrant::Cloners::MysqlCloner.instance

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

@@ -0,0 +1,37 @@
+module Etailer
+  class MysqlCleanerCloner < ::Vagrant::Cloners::Cloner
+    attr_accessor :vm_db_user, :vm_db_password
+
+    def name
+      "mysqlcleaner"
+    end
+
+    def scripts
+      @scripts ||= []
+    end
+
+    def scripts=(scripts)
+      @scripts = Array(scripts).flatten
+    end
+
+    def validate!(env, errors)
+      errors.add("You have to specify at least one script to run!") if scripts.nil? || scripts.empty?
+      errors.add("You must specify a VM database user and password!") unless vm_db_user && vm_db_password
+    end
+
+    def mysql_connection_string
+      "-u#{vm_db_user} -p#{vm_db_password}"
+    end
+      
+    def call
+      @scripts.each do |script|
+        info "Fetching script #{script}..."
+        basename = script.split("/").last
+        vm.execute "wget #{script} -P /tmp"
+        vm.execute "mysql #{mysql_connection_string} < /tmp/#{basename}"
+      end
+    end
+  end
+end
+
+Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Etailer::MysqlCleanerCloner.instance.name, Etailer::MysqlCleanerCloner.instance

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

@@ -0,0 +1,31 @@
+module Vagrant
+  module Cloners
+    class TestCloner < Cloner
+      attr_accessor :foo
+
+      def name
+        "testcloner"
+      end
+
+      def validate!(env, errors)
+        errors.add("Must specify a foo") unless foo
+      end
+
+      def call
+        info "Foo is #{foo}"
+      end
+    end
+  end
+end
+
+Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Vagrant::Cloners::TestCloner.instance.name, Vagrant::Cloners::TestCloner.instance
+
+# Inside your vagrant file, make sure you add the section for this cloner!
+#  # ...
+#
+#  config.vm.provision :cloner do |cfg|
+#    cfg.cloners.testcloner.tap do |c|
+#      c.enabled = true
+#      c.foo = "Roses are red, violets are foo."
+#    end
+#  end

data/lib/vagrant-cloner/config.rb

@@ -0,0 +1,70 @@
+# In here:
+# cloners = OpenStruct.new
+#  cloners.mysql = MysqlCloner.config_class.new
+#
+# In readme:
+# config.cloners.mysql.config_option = yes
+#
+# In provisioner
+# config.cloners.any? {|k, v| v.enabled?}
+
+require 'ostruct'
+
+module Vagrant
+  module Provisioners
+    class ClonerContainer < OpenStruct
+      include Enumerable
+      def members
+        methods(false).grep(/=/).map {|m| m[0...-1] }
+      end
+
+      def each
+        members.each {|m| yield send(m) }
+        self
+      end
+
+      def each_pair
+        members.each {|m| yield m, send(m)}
+        self
+      end
+
+      def enabled_by_order
+        members.collect {|m| send(m)} # Get all plugin instances
+          .select {|m| m.enabled? } # Only enabled
+          .sort_by(&:run_order) # Sort by run order
+          .each {|m| yield m} # Yield up
+      end
+
+    end
+
+    class Cloner
+      class ClonerConfig < Vagrant::Config::Base
+        class << self
+          def registered_cloners
+            @@registered_cloners ||= ClonerContainer.new
+          end
+
+          def register_cloner(name, instance)
+            registered_cloners.send("#{name}=".to_sym, instance)
+          end
+        end
+
+        def cloners
+          @@registered_cloners
+        end
+
+        def validate(env, errors)
+          # errors.add('Remote server must be specified.') unless remote_host
+          cloners.select {|c| c.enabled? }.each do |cloner|
+            cloner.validate!(env, errors)
+          end
+        end
+      end
+
+      def self.config_class
+        Vagrant::Provisioners::Cloner::ClonerConfig
+      end
+    end
+  end
+end
+

data/lib/vagrant-cloner/provisioner.rb

@@ -0,0 +1,19 @@
+module Vagrant
+  module Provisioners
+    class Cloner < Vagrant::Provisioners::Base
+
+      def prepare
+      end
+
+      def provision!
+        env[:ui].info "Vagrant-Cloner beginning back-up process."
+        config.cloners.enabled_by_order do |cloner|
+          cloner.tap {|c|
+            c.options = config.cloners.send(cloner.name)
+            c.env = env
+          }.call
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require 'vagrant-cloner'

data/vagrant-cloner.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+version = '0.9.1'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vagrant-cloner"
+  gem.version       = version
+  gem.authors       = ["Robert Coleman", "Rob Yurkowski"]
+  gem.email         = ["github@robert.net.nz", "rob@yurkowski.net"]
+  gem.description   = %q{Copy production resources down to your new VM.}
+  gem.summary       = %q{Copy production resources down to your new VM.}
+  gem.homepage      = "https://github.com/robyurkowski/vagrant-cloner/"
+
+  gem.files         = `git ls-files`.split($/)
+  # 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"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-cloner
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Coleman
+- Rob Yurkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies: []
+description: Copy production resources down to your new VM.
+email:
+- github@robert.net.nz
+- rob@yurkowski.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-cloner.rb
+- lib/vagrant-cloner/cloner.rb
+- lib/vagrant-cloner/cloners/mysql.rb
+- lib/vagrant-cloner/cloners/mysql_cleaner.rb
+- lib/vagrant-cloner/cloners/testcloner.rb
+- lib/vagrant-cloner/config.rb
+- lib/vagrant-cloner/provisioner.rb
+- lib/vagrant_init.rb
+- vagrant-cloner.gemspec
+homepage: https://github.com/robyurkowski/vagrant-cloner/
+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.24
+signing_key: 
+specification_version: 3
+summary: Copy production resources down to your new VM.
+test_files: []