vagrant-vsphere 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb46c180bc1ef9ebd482ddf8620bd6fa4c324d43
-  data.tar.gz: f5aa75fac5fcf413bdc568af049c78ae5a2e18c0
+  metadata.gz: 3a1a898766988a184569fc058c077650f032569b
+  data.tar.gz: e0947ca1cd5ed3b11fe6d63e2d0520cc7e1667bb
 SHA512:
-  metadata.gz: 6f8f7c729cffbead019ed907daf78fca6c032fbf8126e180b98fdcf894cc2efe18b77f408e33b39f881b3dacb83c52d843de29858d04779cc955947165c642cd
-  data.tar.gz: 4f74a56f9359d1f25913be8f8e6b5c57911fd44967c266f3dcd944e9f46029956357568ef0640ecad9bcf3ad4baedf2fc1aeed9a5f2314d8197f543c68e48ac7
+  metadata.gz: 4fb61ccad6fc0d7bb33442f22795c51da9c9b78df40c3b8e7575f3fb8e5b56bb5ff7ad7323589b2fb6befa9ccad6b27f71772d3b84818c3f47b348210c08d196
+  data.tar.gz: 6c64eb13ce87c80388698978a362f4ef4b525126a5d4803cc780046670ee7fb6c24628c8d052a85be8fa220441b0569519c408daf47cd6b241b51fcd5e018997

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.10.1
+current_version = 1.11.0
 tag = true
 commit = true
 

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0.0
+  - 2.2.3
 
 before_install:
   - rvm @global do gem uninstall bundler --all --executables
   - gem uninstall bundler --all --executables
-  - gem install bundler --version '1.6.9'
+  - gem install bundler --version '1.12.5'
 
 sudo: false

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.11.0 (2016-11-23)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.11.0)
+
+  - Wait for Windows sysprep when cloning a Windows box
+    ([jcaugust:sysprep_wait](https://github.com/nsidc/vagrant-vsphere/pull/199)).
+  - Add a configurable timeout period for obtaining the VM's IP address
+    ([taliesins:wait-for-ip](https://github.com/nsidc/vagrant-vsphere/pull/204)).
+
 ## [1.10.1 (2016-10-17)](https://github.com/nsidc/vagrant-vsphere/releases/tag/v1.10.1)
 
   - Update dependency on [rbvmomi](https://github.com/vmware/rbvmomi) to allow

data/Gemfile

@@ -6,9 +6,7 @@ group :development do
   # We depend on Vagrant for development, but we don't add it as a
   # gem dependency because we expect to be installed within the
   # Vagrant environment itself using `vagrant plugin`.
-
-  ruby '2.0.0'
-  gem 'vagrant', git: 'git://github.com/mitchellh/vagrant.git', tag: 'v1.8.1'
+  gem 'vagrant', github: 'mitchellh/vagrant'
 end
 
 group :plugins do

data/README.md

@@ -19,9 +19,9 @@ This provider is built on top of the
 * libxml2, libxml2-dev, libxslt, libxslt-dev
 
 ## Current Version
-**version: 1.10.1**
+**version: 1.11.0**
 
-vagrant-vsphere (**version: 1.10.1**) is available from
+vagrant-vsphere (**version: 1.11.0**) is available from
 [RubyGems.org](https://rubygems.org/gems/vagrant-vsphere)
 
 ## Installation
@@ -149,6 +149,8 @@ This provider has the following settings, all are required unless noted:
   for a target VM to be retrieved from the list of vm adapters on the host and filtered for a single legitimate
   adapter with a defined interface.   An error will be raised if this filter is enabled and multiple valid
   adapters exist on a host.
+* `ip_address_timeout` _ _Optional_ Maximum number of seconds to wait while an
+  IP address is obtained
 
 ### Cloning from a VM rather than a template
 

data/lib/vSphere/action.rb

@@ -110,7 +110,8 @@ module VagrantPlugins
             b2.use PowerOn unless env[:result]
           end
           b.use CloseVSphere
-          b.use WaitForCommunicator
+          b.use WaitForIPAddress
+          b.use WaitForCommunicator, [:running]
           b.use Provision
           b.use SyncedFolders
           b.use SetHostname
@@ -263,6 +264,7 @@ module VagrantPlugins
       autoload :MessageNotRunning, action_root.join('message_not_running')
       autoload :PowerOff, action_root.join('power_off')
       autoload :PowerOn, action_root.join('power_on')
+      autoload :WaitForIPAddress, action_root.join('wait_for_ip_address')
 
       # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
       # rubocop:disable IndentationWidth

data/lib/vSphere/action/clone.rb

@@ -34,12 +34,26 @@ module VagrantPlugins
             customization_info = get_customization_spec_info_by_name connection, machine
 
             spec[:customization] = get_customization_spec(machine, customization_info) unless customization_info.nil?
+
+            env[:ui].info "Setting custom address: #{config.addressType}" unless config.addressType.nil?
             add_custom_address_type(template, spec, config.addressType) unless config.addressType.nil?
+
+            env[:ui].info "Setting custom mac: #{config.mac}" unless config.mac.nil?
             add_custom_mac(template, spec, config.mac) unless config.mac.nil?
+
+            env[:ui].info "Setting custom vlan: #{config.vlan}" unless config.vlan.nil?
             add_custom_vlan(template, dc, spec, config.vlan) unless config.vlan.nil?
+
+            env[:ui].info "Setting custom memory: #{config.memory_mb}" unless config.memory_mb.nil?
             add_custom_memory(spec, config.memory_mb) unless config.memory_mb.nil?
+
+            env[:ui].info "Setting custom cpu count: #{config.cpu_count}" unless config.cpu_count.nil?
             add_custom_cpu(spec, config.cpu_count) unless config.cpu_count.nil?
+
+            env[:ui].info "Setting custom cpu reservation: #{config.cpu_reservation}" unless config.cpu_reservation.nil?
             add_custom_cpu_reservation(spec, config.cpu_reservation) unless config.cpu_reservation.nil?
+
+            env[:ui].info "Setting custom memmory reservation: #{config.mem_reservation}" unless config.mem_reservation.nil?
             add_custom_mem_reservation(spec, config.mem_reservation) unless config.mem_reservation.nil?
             add_custom_extra_config(spec, config.extra_config) unless config.extra_config.empty?
             add_custom_notes(spec, config.notes) unless config.notes.nil?
@@ -71,7 +85,6 @@ module VagrantPlugins
               new_vm = apply_sr_result.vm
 
             else
-
               env[:ui].info I18n.t('vsphere.creating_cloned_vm')
               env[:ui].info " -- #{config.clone_from_vm ? 'Source' : 'Template'} VM: #{template.pretty_path}"
               env[:ui].info " -- Target VM: #{vm_base_folder.pretty_path}/#{name}"
@@ -79,6 +92,7 @@ module VagrantPlugins
               new_vm = template.CloneVM_Task(folder: vm_base_folder, name: name, spec: spec).wait_for_completion
 
               config.custom_attributes.each do |k, v|
+                env[:ui].info "Setting custom attribute: #{k}=#{v}"
                 new_vm.setCustomValue(key: k, value: v)
               end
             end
@@ -92,6 +106,8 @@ module VagrantPlugins
 
           machine.id = new_vm.config.uuid
 
+          wait_for_sysprep(env, new_vm, connection, 600, 10) if machine.config.vm.guest.eql?(:windows)
+
           env[:ui].info I18n.t('vsphere.vm_clone_success')
 
           @app.call env
@@ -99,6 +115,37 @@ module VagrantPlugins
 
         private
 
+        def wait_for_sysprep(env, vm, vim_connection, timeout, sleep_time)
+          vem = vim_connection.serviceContent.eventManager
+
+          wait = true
+          waited_seconds = 0
+
+          env[:ui].info I18n.t('vsphere.wait_sysprep')
+          while wait
+            events = query_customization_succeeded(vm, vem)
+
+            if events.size > 0
+              events.each do |e|
+                env[:ui].info e.fullFormattedMessage
+              end
+              wait = false
+            elsif waited_seconds >= timeout
+              fail Errors::VSphereError, :'sysprep_timeout'
+            else
+              sleep(sleep_time)
+              waited_seconds += sleep_time
+            end
+          end
+        end
+
+        def query_customization_succeeded(vm, vem)
+          vem.QueryEvents(filter:
+              RbVmomi::VIM::EventFilterSpec(entity:
+              RbVmomi::VIM::EventFilterSpecByEntity(entity: vm, recursion:
+              RbVmomi::VIM::EventFilterSpecRecursionOption(:self)), eventTypeId: ['CustomizationSucceeded']))
+        end
+
         def get_customization_spec(machine, spec_info)
           customization_spec = spec_info.spec.clone
 

data/lib/vSphere/action/close_vsphere.rb

@@ -9,7 +9,7 @@ module VagrantPlugins
         end
 
         def call(env)
-          env[:vSphere_connection].close
+          env[:vSphere_connection].close if env && env[:vSphere_connection]
           @app.call env
         rescue Errors::VSphereError
           raise

data/lib/vSphere/action/wait_for_ip_address.rb

@@ -0,0 +1,58 @@
+require 'ipaddr'
+require 'timeout'
+
+module VagrantPlugins
+  module VSphere
+    module Action
+      class WaitForIPAddress
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant::vsphere::wait_for_ip_addr')
+        end
+
+        def call(env)
+          timeout = env[:machine].provider_config.ip_address_timeout
+
+          env[:ui].output('Waiting for the machine to report its IP address...')
+          env[:ui].detail("Timeout: #{timeout} seconds")
+
+          guest_ip = nil
+          Timeout.timeout(timeout) do
+            loop do
+              # If a ctrl-c came through, break out
+              return if env[:interrupted]
+
+              guest_ip = nil
+
+              if env[:machine].state.id == :running
+                ssh_info = env[:machine].ssh_info
+                guest_ip = ssh_info[:host] unless ssh_info.nil?
+              end
+
+              if guest_ip
+                begin
+                  IPAddr.new(guest_ip)
+                  break
+                rescue IPAddr::InvalidAddressError
+                  # Ignore, continue looking.
+                  @logger.warn("Invalid IP address returned: #{guest_ip}")
+                end
+              end
+
+              sleep 1
+            end
+          end
+
+          # If we were interrupted then return now
+          return if env[:interrupted]
+
+          env[:ui].detail("IP: #{guest_ip}")
+
+          @app.call(env)
+        rescue Timeout::Error
+          raise Errors::VSphereError, :wait_for_ip_address_timeout
+        end
+      end
+    end
+  end
+end

data/lib/vSphere/config.rb

@@ -3,6 +3,7 @@ require 'vagrant'
 module VagrantPlugins
   module VSphere
     class Config < Vagrant.plugin('2', :config)
+      attr_accessor :ip_address_timeout # Time to wait for an IP address when booting, in seconds @return [Integer]
       attr_accessor :host
       attr_accessor :insecure
       attr_accessor :user
@@ -33,10 +34,15 @@ module VagrantPlugins
       attr_reader :custom_attributes
 
       def initialize
+        @ip_address_timeout = UNSET_VALUE
         @custom_attributes = {}
         @extra_config = {}
       end
 
+      def finalize!
+        @ip_address_timeout = 240 if @ip_address_timeout == UNSET_VALUE
+      end
+
       def custom_attribute(key, value)
         @custom_attributes[key.to_sym] = value
       end

data/lib/vSphere/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module VSphere
-    VERSION = '1.10.1'
+    VERSION = '1.11.0'
   end
 end

data/locales/en.yml

@@ -20,6 +20,8 @@ en:
       The VM has not been created
     vm_not_running: |-
       The VM is not running
+    wait_sysprep: |-
+      Waiting for sysprep
 
     errors:
       missing_template: |-
@@ -48,6 +50,10 @@ en:
         Cannot use Linked Clone with Storage DRS
       multiple_interface_with_real_nic_ip_set: |-
         real_nic_ip filtering set with multiple valid VM interfaces available
+      sysprep_timeout: |-
+        Customization of VM not succeeded within timeout.
+      wait_for_ip_address_timeout: |-
+        Timeout while waiting for ip address
 
     config:
       host: |-

data/spec/action_spec.rb

@@ -25,6 +25,8 @@ describe VagrantPlugins::VSphere::Action do
     end
 
     it 'should check if the VM exits' do
+      @machine.state.stub(:id).and_return(:running)
+
       VagrantPlugins::VSphere::Action::IsCreated.any_instance.should_receive(:call)
 
       run_up

data/spec/spec_helper.rb

@@ -65,6 +65,7 @@ RSpec.configure do |config|
         custom_attributes: {},
         notes: nil,
         extra_config: {},
+        ip_address_timeout: 1,
         real_nic_ip: false)
     vm_config = double(
       vm: double('config_vm',
@@ -75,7 +76,8 @@ RSpec.configure do |config|
                  communicator: nil,
                  networks: [[:private_network, { ip: '0.0.0.0' }]],
                  boot_timeout: 1,
-                 graceful_halt_timeout: 0.1),
+                 graceful_halt_timeout: 0.1,
+                 guest: nil),
       validate: []
     )
     @app = double 'app', call: true
@@ -84,7 +86,7 @@ RSpec.configure do |config|
                       :config => vm_config,
                       :state => double('state', id: nil),
                       :communicate => double('communicator', :wait_for_ready => true, :ready? => true),
-                      :ssh_info => {},
+                      :ssh_info => { :host => IP_ADDRESS },
                       :data_dir => Pathname.new(''),
                       :id => nil,
                       :id= => nil,
@@ -92,7 +94,7 @@ RSpec.configure do |config|
 
     @env = {
       machine: @machine,
-      ui: double('ui', info: nil, output: nil)
+      ui: double('ui', info: nil, output: nil, detail: nil)
     }
 
     @vm = double('vm',

metadata

@@ -1,137 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Andrew Grauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rbvmomi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.4
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.4
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.32.1
 description: Enables Vagrant to manage machines with VMWare vSphere.
@@ -141,11 +141,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .bumpversion.cfg
-- .gitignore
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
+- ".bumpversion.cfg"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Gemfile
@@ -171,6 +171,7 @@ files:
 - lib/vSphere/action/snapshot_list.rb
 - lib/vSphere/action/snapshot_restore.rb
 - lib/vSphere/action/snapshot_save.rb
+- lib/vSphere/action/wait_for_ip_address.rb
 - lib/vSphere/cap/public_address.rb
 - lib/vSphere/cap/snapshot_list.rb
 - lib/vSphere/config.rb
@@ -203,12 +204,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []