vagrant-cloner 0.9.3 → 2.0.0

data/README.md

@@ -26,7 +26,7 @@ Vagrant::Config.run do |config|
   end
 
   config.vm.provision :cloner do |cfg|
-    cfg.cloners.mysql.tap do |c|
+    cfg.cloner.mysql.tap do |c|
       # Set options here.
       c.enabled = true
       c.run_order = 10
@@ -38,7 +38,7 @@ end
 
 The following keys are valid:
 
-- **cloners**
+- **cloner**
     - **(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.
@@ -93,16 +93,16 @@ If you make an error in your script, you may have a hard time uninstalling it wi
 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.
+- `validate(machine, 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`
+`Vagrant::ClonerContainer.instance.send("#{<Class>.instance.name}=".to_sym, <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`
+`Vagrant::ClonerContainer.instance.send("#{Vagrant::Cloners::MysqlCloner.instance.name}=".to_sym, 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!
 

data/gem-public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDWDCCAkCgAwIBAgIBADANBgkqhkiG9w0BAQUFADBSMQ8wDQYDVQQDDAZnaXRo
+dWIxFjAUBgoJkiaJk/IsZAEZFgZyb2JlcnQxEzARBgoJkiaJk/IsZAEZFgNuZXQx
+EjAQBgoJkiaJk/IsZAEZFgJuejAeFw0xMzAyMDQwMzAxMTdaFw0xNDAyMDQwMzAx
+MTdaMFIxDzANBgNVBAMMBmdpdGh1YjEWMBQGCgmSJomT8ixkARkWBnJvYmVydDET
+MBEGCgmSJomT8ixkARkWA25ldDESMBAGCgmSJomT8ixkARkWAm56MIIBIjANBgkq
+hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu5iRa6UYCDf6iH+wOnuQtItD+cc6zk9n
+zNROTcz34f9Kc60EBvBQdr1K3dxd3Cg/8KZ8ScldFbDQ5pOQTn83Vp57KW+vXq3W
+Cs5kfYmfPrX+h77NhsyvlPDxXEUfEHYQNXok9GsUmwOMKt4/QmhnPyk0sQ00UFCx
+LIUv23tqTwbkR9cKLGyQL3Wqu35yodLqFA7J3HAV+FLwfaUDbyYwUIOIijtjzzya
+7qsYn6JyFaHULRNVugP8HI5btXbCmOmP87hwXTkRE5PV9QlKsN9gw7RyYJvIAHZm
+Kob9X1khIoqcoEhwU41R55oxIsF6X99oK7Logjh/KQ1ad2U8taidkQIDAQABozkw
+NzAJBgNVHRMEAjAAMB0GA1UdDgQWBBQm8KrxyAkNbIEOkjt3Q0IqHayIcTALBgNV
+HQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQADggEBAJRN7tzK177JE1Qrc/42+Rv0nGMa
+AGDw9Vq5dg0ZOeeDc/R7KwauQm55c9xgiaiZDVPuTcQMrlhVnF7V19upgaSozpOJ
+G3ds/5Dz8YW7417ygOvqU3EJgyk6mRBsuZnqEdZaIqm4W4iTmawBwizNqPucK7tv
++Y2/hwxUAPN018IUJtqyeDktIaEvel5Zxz8otmtoRC++8qZRMN3+AaVNSGRRIgBT
+T9H/4+4jHUDAyjhtWSvSUvcpxODHn5pnz6EdzwDPxHcsGAYKT15qWh1Q30OW9sfO
+1n1MjdAhfkkUVxrbjfGOEjpTeeQ3rAcHkUNAWNLeIeH+2z8ska6zAHl41aU=
+-----END CERTIFICATE-----

data/lib/vagrant-cloner.rb

@@ -1,8 +1,2 @@
 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)
+require 'vagrant-cloner/plugin'

data/lib/vagrant-cloner/base_cloner.rb

@@ -0,0 +1,71 @@
+require 'net/ssh'
+require 'net/scp'
+require 'date'
+require 'singleton'
+
+module VagrantCloner
+  # 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 BaseCloner
+    include Singleton
+
+    attr_accessor :enabled, :machine, :options, :run_order
+    attr_reader :env
+
+    def name
+      raise "Cloner must define #name and return a string."
+    end
+
+    def validate(machine, 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
+      @machine.communicate
+    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|
+        @machine.env.ui.send(meth.to_sym, message)
+      end
+      protected meth.to_sym
+    end
+  end
+end

data/lib/vagrant-cloner/cloner_container.rb

@@ -0,0 +1,31 @@
+require 'ostruct'
+require 'singleton'
+
+module VagrantCloner
+  class ClonerContainer < OpenStruct
+    include Singleton
+    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
+end

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

@@ -1,6 +1,6 @@
-module Vagrant
+module VagrantCloner
   module Cloners
-    class MysqlCloner < Cloner
+    class MysqlCloner < ::VagrantCloner::BaseCloner
 
       attr_accessor   :remote_host, :remote_user, :remote_password,
                       :remote_db_user, :remote_db_password,
@@ -13,13 +13,16 @@ module Vagrant
         "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
+      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
         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."
+          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
 
       def remote_credentials
@@ -105,8 +108,10 @@ module Vagrant
       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}"
+        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}"
+        end
         info "Done loading database."
       end
 
@@ -122,4 +127,4 @@ module Vagrant
   end
 end
 
-Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Vagrant::Cloners::MysqlCloner.instance.name, Vagrant::Cloners::MysqlCloner.instance
+VagrantCloner::ClonerContainer.instance.send("#{VagrantCloner::Cloners::MysqlCloner.instance.name}=".to_sym, VagrantCloner::Cloners::MysqlCloner.instance)

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

@@ -1,5 +1,5 @@
 module Etailer
-  class MysqlCleanerCloner < ::Vagrant::Cloners::Cloner
+  class MysqlCleanerCloner < ::VagrantCloner::BaseCloner
     attr_accessor :vm_db_user, :vm_db_password
 
     def name
@@ -14,9 +14,12 @@ module Etailer
       @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
+    def validate(machine, errors)
+      failures = []
+      failures.push "You have to specify at least one script to run!" if scripts.nil? || scripts.empty?
+      failures.push "You must specify a VM database user and password!" unless vm_db_user && vm_db_password
+
+      errors.merge(name.to_sym => failures) if failures.any?
     end
 
     def mysql_connection_string
@@ -34,4 +37,4 @@ module Etailer
   end
 end
 
-Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Etailer::MysqlCleanerCloner.instance.name, Etailer::MysqlCleanerCloner.instance
+VagrantCloner::ClonerContainer.instance.send("#{Etailer::MysqlCleanerCloner.instance.name}=".to_sym, Etailer::MysqlCleanerCloner.instance)

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

@@ -1,14 +1,17 @@
-module Vagrant
+module VagrantCloner
   module Cloners
-    class TestCloner < Cloner
+    class TestCloner < ::VagrantCloner::BaseCloner
       attr_accessor :foo
 
       def name
         "testcloner"
       end
 
-      def validate!(env, errors)
-        errors.add("Must specify a foo") unless foo
+      def validate(machine, errors)
+        failures = []
+        failures.push "Must specify a foo" unless foo
+
+        failures.merge(name.to_sym => failures) if failures.any?
       end
 
       def call
@@ -18,7 +21,7 @@ module Vagrant
   end
 end
 
-Vagrant::Provisioners::Cloner::ClonerConfig.register_cloner Vagrant::Cloners::TestCloner.instance.name, Vagrant::Cloners::TestCloner.instance
+VagrantCloner::ClonerContainer.instance.send("#{VagrantCloner::Cloners::TestCloner.instance.name}=".to_sym, VagrantCloner::Cloners::TestCloner.instance)
 
 # Inside your vagrant file, make sure you add the section for this cloner!
 #  # ...

data/lib/vagrant-cloner/config.rb

@@ -1,70 +1,19 @@
-# 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
-
+module VagrantCloner
+  class Config < Vagrant.plugin("2", :config)
+    class << self
+      attr_accessor :registered_cloners
     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 cloner
+      self.class.registered_cloners ||= []
+    end
 
-      def self.config_class
-        Vagrant::Provisioners::Cloner::ClonerConfig
+    def validate(machine)
+      errors = {}
+      cloner.select {|c| c.enabled? }.each do |c|
+        c.validate(machine, errors)
       end
+      errors
     end
   end
 end
-

data/lib/vagrant-cloner/plugin.rb

@@ -0,0 +1,22 @@
+require 'vagrant-cloner/cloner_container'
+require 'vagrant-cloner/base_cloner'
+Dir[File.join(File.dirname(__FILE__), 'cloners', '*.rb')].each {|f| require f }
+
+module VagrantCloner
+  class Plugin < ::Vagrant.plugin("2")
+    name "Cloner"
+
+    config(:cloner, :provisioner) do
+      require 'vagrant-cloner/config'
+      ::VagrantCloner::Config.tap do |c| 
+        c.registered_cloners = ::VagrantCloner::ClonerContainer.instance
+      end
+    end
+
+    provisioner(:cloner) do
+      require 'vagrant-cloner/provisioner'
+      ::VagrantCloner::Provisioner
+    end
+
+  end
+end

data/lib/vagrant-cloner/provisioner.rb

@@ -1,18 +1,12 @@
-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
+module VagrantCloner
+  class Provisioner < Vagrant.plugin("2", :provisioner)
+    def provision
+      @machine.env.ui.info "Vagrant-Cloner beginning back-up process."
+      config.cloner.enabled_by_order do |cloner|
+        cloner.tap {|c|
+          c.options = config.cloner.send(cloner.name)
+          c.machine = @machine
+        }.call
       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 = '0.9.3'
+version = '2.0.0'
 
 Gem::Specification.new do |gem|
   gem.name          = "vagrant-cloner"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cloner
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -39,7 +39,7 @@ cert_chain:
   ME9XOXNmTwoxbjFNamRBaGZra1VWeHJiamZHT0VqcFRlZVEzckFjSGtVTkFX
   TkxlSWVIKzJ6OHNrYTZ6QUhsNDFhVT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUt
   LS0tLQo=
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies: []
 description: Copy production resources down to your new VM.
 email:
@@ -54,12 +54,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gem-public_cert.pem
 - lib/vagrant-cloner.rb
-- lib/vagrant-cloner/cloner.rb
+- lib/vagrant-cloner/base_cloner.rb
+- lib/vagrant-cloner/cloner_container.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/plugin.rb
 - lib/vagrant-cloner/provisioner.rb
 - lib/vagrant_init.rb
 - vagrant-cloner.gemspec

data/lib/vagrant-cloner/cloner.rb

@@ -1,72 +0,0 @@
-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