vagrant-parallels 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0df49aa2a8f022bfe2918179f34f185e991566
-  data.tar.gz: 7e31ce9a5505febbd9d277dd60b50ebbf65cfd46
+  metadata.gz: 96a1ffdfb9901688a2af90776e4c7f86c1ea5d27
+  data.tar.gz: dedfe0e23fbcaf6b429f31f422bb96b32ad2c7da
 SHA512:
-  metadata.gz: 2f1178440b0b9a8f81eefe23a6ba557dcc0f74de988716bb35b659746aa7524c84f8f26e497714b10362f2656bed6aedfea4c553d32e86bed1763d3d907252da
-  data.tar.gz: 5ff89e1b90270540a21cf0baedab86b11eaac25951e39f96b9a11e4e97fb8a4905d0296009f589eb54de7ac14ad792db2333dcb2ed137a8c1f41a00f36599fd1
+  metadata.gz: 20bc34e6060d31b4af5656c360146104f90fad6d967797c2f6d674f50f5ab5da2c9505dd97cb6c9f919f79e9fe6309412e7a1582ffe8f5587b4c52a1c05e574c
+  data.tar.gz: 9ced0b39362f1f48a7bffb36f7b5477ddac77ef37ff475fc1dd836f066aefd5912a146e729962a7658ffe6222dd8dc0723b64993cd24a5bee73ef8e4095a3529

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 1.6.3 (July 11, 2016)
+DEPRECATIONS:
+  - The following provider options was renamed:
+    - `regen_box_uuid` was renamed to `regen_src_uuid`
+    - `use_linked_clone` was renamed to `linked clone`
+
+  Old names are still supported, but will be removed in `vagrant-parallels` v1.7.0.
+  [[GH-260](https://github.com/Parallels/vagrant-parallels/pull/260)]
+
+IMPROVEMENTS:
+  - Allow to package linked clones with `vagrant package`. External disk images 
+  will be automatically copied, so the resulted box become a full-sized 
+  standalone VM. [[GH-262](https://github.com/Parallels/vagrant-parallels/pull/262)]
+  - Handle the situation when host machine is not connected to Shared network.
+  With Parallels Desktop 11.2.1+ Vagrant will connect it automatically. With earlier
+  versions, the human-readable error message will be displayed. 
+  [[GH-266](https://github.com/Parallels/vagrant-parallels/pull/266)]
+  - Disable home folder sharing by default (Parallels Desktop 11+). 
+  [[GH-257](https://github.com/Parallels/vagrant-parallels/pull/257)]
+
+BUG FIXES:
+  - action/box_unregister: Fix `#recover` method  for layered environments.
+  [[GH-261](https://github.com/Parallels/vagrant-parallels/pull/261)]
+  - action/network: Fix an exception when option "Connect Mac to 
+  this network" is disabled. [[GH-268](https://github.com/Parallels/vagrant-parallels/pull/268)]
+  - commands/snapshot: Add retries for snapshot commands to avoid `prlctl` 
+  failures. [[GH-259](https://github.com/Parallels/vagrant-parallels/pull/259)]  
+
+
 ## 1.6.2 (March 23, 2016)
 BUG FIXES:
   - Fix unsupported action error for `vagrant snapshot` commands [[GH-254](https://github.com/Parallels/vagrant-parallels/pull/254)]

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) 2013 Youssef Shahin
-Copyright (c) 2013-2015 Parallels IP Holdings GmbH.
+Copyright (c) 2013-2016 Parallels IP Holdings GmbH.
 
 MIT License
 

data/lib/vagrant-parallels/action.rb

@@ -11,6 +11,7 @@ module VagrantPlugins
       # a bootup (i.e. not saved).
       def self.action_boot
         Vagrant::Action::Builder.new.tap do |b|
+          b.use CheckSharedInterface
           b.use SetName
           b.use ClearForwardedPorts
           b.use Provision
@@ -74,6 +75,7 @@ module VagrantPlugins
       def self.action_halt
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
+          b.use CheckSharedInterface
           b.use Call, IsState, :not_created do |env1, b1|
             if env1[:result]
               b1.use Message, I18n.t('vagrant.commands.common.vm_not_created')
@@ -122,6 +124,7 @@ module VagrantPlugins
       def self.action_provision
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
+          b.use CheckSharedInterface
           b.use Call, IsState, :not_created do |env1, b1|
             if env1[:result]
               b1.use Message, I18n.t('vagrant.commands.common.vm_not_created')
@@ -163,6 +166,7 @@ module VagrantPlugins
       def self.action_resume
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
+          b.use CheckSharedInterface
           b.use Call, IsState, :not_created do |env1, b1|
             if env1[:result]
               b1.use Message, I18n.t('vagrant.commands.common.vm_not_created')
@@ -227,6 +231,7 @@ module VagrantPlugins
       def self.action_ssh
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
+          b.use CheckSharedInterface
           b.use Call, IsState, :not_created do |env1, b1|
             if env1[:result]
               b1.use Message, I18n.t('vagrant.commands.common.vm_not_created')
@@ -248,6 +253,7 @@ module VagrantPlugins
       def self.action_ssh_run
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
+          b.use CheckSharedInterface
           b.use Call, IsState, :not_created do |env1, b1|
             if env1[:result]
               b1.use Message, I18n.t('vagrant.commands.common.vm_not_created')
@@ -389,6 +395,7 @@ module VagrantPlugins
       autoload :BoxUnregister, File.expand_path('../action/box_unregister', __FILE__)
       autoload :HandleGuestTools, File.expand_path('../action/handle_guest_tools', __FILE__)
       autoload :HandleForwardedPortCollisions, File.expand_path('../action/handle_forwarded_port_collisions.rb', __FILE__)
+      autoload :CheckSharedInterface, File.expand_path('../action/check_shared_interface', __FILE__)
       autoload :ClearNetworkInterfaces, File.expand_path('../action/clear_network_interfaces', __FILE__)
       autoload :ClearForwardedPorts, File.expand_path('../action/clear_forwarded_ports', __FILE__)
       autoload :Customize, File.expand_path('../action/customize', __FILE__)

data/lib/vagrant-parallels/action/box_unregister.rb

@@ -33,6 +33,9 @@ module VagrantPlugins
         end
 
         def recover(env)
+          # If we don't have a box, nothing to do
+          return if !env[:machine].box
+
           unregister_box(env)
         end
 

data/lib/vagrant-parallels/action/check_shared_interface.rb

@@ -0,0 +1,29 @@
+module VagrantPlugins
+  module Parallels
+    module Action
+      class CheckSharedInterface
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          shared_iface = env[:machine].provider.driver.read_shared_interface
+
+          # Shared interface is connected. Just exit
+          return @app.call(env) if shared_iface[:status] == 'Up'
+
+          # Since PD 11.2.1 Vagrant can fix this automatically
+          if !env[:machine].provider.pd_version_satisfies?('>= 11.2.1')
+            raise Errors::SharedInterfaceDisconnected
+          end
+
+          env[:ui].info I18n.t('vagrant_parallels.actions.vm.check_shared_interface.connecting')
+          iface_name = env[:machine].provider.driver.read_shared_network_id
+          env[:machine].provider.driver.connect_network_interface(iface_name)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-parallels/action/clear_forwarded_ports.rb

@@ -12,9 +12,10 @@ module VagrantPlugins
             return @app.call(env)
           end
 
-          if !env[:machine].provider.driver.read_forwarded_ports.empty?
+          ports = env[:machine].provider.driver.read_forwarded_ports
+          if !ports.empty?
             env[:ui].info I18n.t('vagrant.actions.vm.clear_forward_ports.deleting')
-            env[:machine].provider.driver.clear_forwarded_ports
+            env[:machine].provider.driver.clear_forwarded_ports(ports)
           end
 
           @app.call(env)

data/lib/vagrant-parallels/action/export.rb

@@ -12,8 +12,18 @@ module VagrantPlugins
             raise Vagrant::Errors::VMPowerOffToPackage
           end
 
+          # Clone source VM to the temporary copy
           clone(env)
+          @home_path = env[:machine].provider.driver.read_settings(env[:package_box_id]).fetch('Home')
+          @hdd_list = Dir.glob(File.join(@home_path, '*.hdd'))
+
+          # Convert to full-sized VM, copy all external and linked disks (if any)
+          convert_to_full(env)
+
+          # Compact all virtual disks
           compact(env)
+
+          # Preparations completed. Unregister before packaging
           unregister_vm(env)
 
           @app.call(env)
@@ -71,16 +81,69 @@ module VagrantPlugins
           env[:ui].clear_line
         end
 
+        def convert_to_full(env)
+          is_linked = false
+
+          @hdd_list.each do |hdd_dir|
+            disk_desc = File.join(hdd_dir, 'DiskDescriptor.xml')
+            xml = Nokogiri::XML(File.open disk_desc)
+
+            linked_images = xml.xpath('//Parallels_disk_image/StorageData/Storage/Image/File').select do |hds|
+              Pathname.new(hds).absolute?
+            end
+
+            # If this is a regular, not linked HDD, then skip it. Otherwise,
+            # remember this VM as a linked clone.
+            next if linked_images.empty?
+            is_linked = true
+
+
+            env[:ui].info I18n.t('vagrant_parallels.actions.vm.export.copying_linked_disks')
+            linked_images.each do |hds|
+              hds_path = hds.text
+
+              if !File.exist?(hds_path)
+                raise VagrantPlugins::Parallels::Errors::ExternalDiskNotFound,
+                      path: hds_path
+              end
+
+              FileUtils.cp(hds_path, hdd_dir, preserve: true)
+
+              # Save relative hds path to the XML file
+              hds.content = File.basename(hds_path)
+            end
+
+            File.open(disk_desc, 'w') do |f|
+              f.write xml.to_xml
+            end
+          end
+
+          # Flush elements LinkedVmUuid, LinkedSnapshotUuid from "config.pvs"
+          if is_linked
+            @logger.debug 'Converting linked clone to the regular VM'
+            config_pvs = File.join(@home_path, 'config.pvs')
+
+            xml = Nokogiri::XML(File.open(config_pvs))
+            xml.xpath('//ParallelsVirtualMachine/Identification/LinkedVmUuid').first.content = ''
+            xml.xpath('//ParallelsVirtualMachine/Identification/LinkedSnapshotUuid').first.content = ''
+
+            File.open(config_pvs, 'w') do |f|
+              f.write xml.to_xml
+            end
+          end
+        end
+
         def compact(env)
           env[:ui].info I18n.t('vagrant_parallels.actions.vm.export.compacting')
-          env[:machine].provider.driver.compact(env[:package_box_id]) do |progress|
+          @hdd_list.each do |hdd|
+            env[:machine].provider.driver.compact_hdd(hdd) do |progress|
+              env[:ui].clear_line
+              env[:ui].report_progress(progress, 100, false)
+            end
+            # Clear the line a final time so the next data can appear
+            # alone on the line.
             env[:ui].clear_line
-            env[:ui].report_progress(progress, 100, false)
           end
-
-          # Clear the line a final time so the next data can appear
-          # alone on the line.
-          env[:ui].clear_line
         end
 
         def unregister_vm(env)

data/lib/vagrant-parallels/action/forward_ports.rb

@@ -45,7 +45,7 @@ module VagrantPlugins
 
         def forward_ports
           all_rules = @env[:machine].provider.driver.read_forwarded_ports(true)
-          names_in_use = all_rules.collect { |r| r[:rule_name] }
+          names_in_use = all_rules.collect { |r| r[:name] }
           ports = []
 
           @env[:forwarded_ports].each do |fp|

data/lib/vagrant-parallels/action/network.rb

@@ -444,20 +444,18 @@ module VagrantPlugins
 
         # This finds a matching host only network for the given configuration.
         def hostonly_find_matching_network(config)
-          existing = @env[:machine].provider.driver.read_host_only_interfaces
+          this_netaddr = network_address(config[:ip], config[:netmask])
 
-          if config[:name]
-            # Search networks strongly by specified name
-            matched_iface = existing.detect { |i| config[:name] == i[:name] }
-          else
-            # Name is not specified - search by network address
-            this_netaddr = network_address(config[:ip], config[:netmask])
-            matched_iface = existing.detect do |i|
-              this_netaddr == network_address(i[:ip], i[:netmask])
+          @env[:machine].provider.driver.read_host_only_interfaces.each do |interface|
+            return interface if config[:name] && config[:name] == interface[:name]
+
+            if interface[:ip]
+              return interface if this_netaddr == \
+                network_address(interface[:ip], interface[:netmask])
             end
           end
 
-          matched_iface || nil
+          nil
         end
       end
     end

data/lib/vagrant-parallels/action/sane_defaults.rb

@@ -61,7 +61,8 @@ module VagrantPlugins
           settings.merge!(
             startup_view: 'headless',
             time_sync: 'on',
-            disable_timezone_sync: 'on'
+            disable_timezone_sync: 'on',
+            shf_host_defined: 'off'
           )
 
           settings

data/lib/vagrant-parallels/cap.rb

@@ -23,7 +23,6 @@ module VagrantPlugins
       #
       # @return [String] Host's IP address
       def self.host_address(machine)
-
         shared_iface = machine.provider.driver.read_shared_interface
         return shared_iface[:ip] if shared_iface
 

data/lib/vagrant-parallels/config.rb

@@ -13,13 +13,13 @@ module VagrantPlugins
       attr_accessor :regen_src_uuid
       attr_accessor :update_guest_tools
 
+      # Deprecated options
+      attr_accessor :regen_box_uuid
+      attr_accessor :use_linked_clone
+
       # Compatibility with virtualbox provider's syntax
       alias :check_guest_additions= :check_guest_tools=
 
-      # Compatibility with old names
-      alias :regen_box_uuid= :regen_src_uuid=
-      alias :use_linked_clone= :linked_clone=
-
       def initialize
         @check_guest_tools = UNSET_VALUE
         @customizations    = []
@@ -34,6 +34,10 @@ module VagrantPlugins
         @update_guest_tools = UNSET_VALUE
 
         network_adapter(0, :shared)
+
+        # Deprecated options
+        @regen_box_uuid = UNSET_VALUE
+        @use_linked_clone = UNSET_VALUE
       end
 
       def customize(*command)
@@ -55,10 +59,6 @@ module VagrantPlugins
         customize('pre-boot', ['set', :id, '--cpus', count.to_i])
       end
 
-      def regen_box_uuid=(value)
-        @regen_src_uuid = value
-      end
-
       def merge(other)
         super.tap do |result|
           c = customizations.dup
@@ -68,6 +68,16 @@ module VagrantPlugins
       end
 
       def finalize!
+        if @regen_box_uuid != UNSET_VALUE
+          puts "Parallels provider: Vagrantfile option 'regen_box_uuid' is deprecated and will be removed. Please, use 'regen_src_uuid' instead"
+          @regen_src_uuid = @regen_box_uuid if @regen_src_uuid == UNSET_VALUE
+        end
+
+        if @use_linked_clone != UNSET_VALUE
+          puts "Parallels provider: Vagrantfile option 'use_linked_clone' is deprecated and will be removed. Please, use 'linked_clone' instead"
+          @linked_clone = @use_linked_clone if @linked_clone == UNSET_VALUE
+        end
+
         if @check_guest_tools == UNSET_VALUE
           @check_guest_tools = true
         end

data/lib/vagrant-parallels/driver/base.rb

@@ -3,6 +3,7 @@ require 'log4r'
 require 'vagrant/util/busy'
 require 'vagrant/util/network_ip'
 require 'vagrant/util/platform'
+require 'vagrant/util/retryable'
 require 'vagrant/util/subprocess'
 require 'vagrant/util/which'
 
@@ -39,8 +40,20 @@ module VagrantPlugins
           @logger.info("prlsrvctl path: #{@prlsrvctl_path}")
         end
 
-        # Removes all port forwarding rules for the virtual machine.
-        def clear_forwarded_ports
+        # Removes the specified port forwarding rules for the virtual machine.
+        #
+        # @param [Array<Symbol => String>] ports - List of ports.
+        # Each port should be described as a hash with the following keys:
+        #
+        #     {
+        #       name:      'example',
+        #       protocol:  'tcp',
+        #       guest:     'target-vm-uuid',
+        #       hostport:  '8080',
+        #       guestport: '80'
+        #     }
+        #
+        def clear_forwarded_ports(ports)
           raise NotImplementedError
         end
 
@@ -81,24 +94,28 @@ module VagrantPlugins
           read_vms[dst_name]
         end
 
-        # Compacts all disk drives of virtual machine
-        def compact(uuid)
-          hw_info = read_settings(uuid).fetch('Hardware', {})
-          used_drives = hw_info.select do |name, _|
-            name.start_with? 'hdd'
-          end
-          used_drives.each_value do |drive_params|
-            execute(@prldisktool_path, 'compact', '--hdd', drive_params['image']) do |_, data|
-              lines = data.split('\r')
-              # The progress of the compact will be in the last line. Do a greedy
-              # regular expression to find what we're looking for.
-              if lines.last =~ /.+?(\d{,3}) ?%/
-                yield $1.to_i if block_given?
-              end
+        # Compacts the specified virtual disk image
+        #
+        # @param [<String>] hdd_path Path to the target '*.hdd'
+        def compact_hdd(hdd_path)
+          execute(@prldisktool_path, 'compact', '--hdd', hdd_path) do |_, data|
+            lines = data.split('\r')
+            # The progress of the compact will be in the last line. Do a greedy
+            # regular expression to find what we're looking for.
+            if lines.last =~ /.+?(\d{,3}) ?%/
+              yield $1.to_i if block_given?
             end
           end
         end
 
+        # Connects the host machine to the  specified virtual network interface
+        # Could be used for Parallels' Shared and Host-Only interfaces only.
+        #
+        # @param [<String>] name Network interface name. Example: 'Shared'
+        def connect_network_interface(name)
+          raise NotImplementedError
+        end
+
         # Creates a host only network with the given options.
         #
         # @param [<Symbol => String>] options Hostonly network options.
@@ -161,7 +178,11 @@ module VagrantPlugins
         # @param [String] uuid Name or UUID of the target VM
         # @param [String] snapshot_id Snapshot ID
         def delete_snapshot(uuid, snapshot_id)
-          execute_prlctl('snapshot-delete', uuid, '--id', snapshot_id)
+          # Sometimes this command fails with 'Data synchronization is currently
+          # in progress'. Just wait and retry.
+          retryable(on: VagrantPlugins::Parallels::Errors::ExecutionError, tries: 2, sleep: 2) do
+            execute_prlctl('snapshot-delete', uuid, '--id', snapshot_id)
+          end
         end
 
         # Deletes any host only networks that aren't being used for anything.
@@ -292,6 +313,20 @@ module VagrantPlugins
           bridged_ifaces
         end
 
+        # Returns the list of port forwarding rules.
+        # Each rule will be represented as a hash with the following keys:
+        #
+        #     {
+        #       name:      'example',
+        #       protocol:  'tcp',
+        #       guest:     'target-vm-uuid',
+        #       hostport:  '8080',
+        #       guestport: '80'
+        #     }
+        #
+        # @param [Boolean] global If true, returns all the rules on the host.
+        # Otherwise only rules related to the context VM will be returned.
+        # @return [Array<Symbol => String>]
         def read_forwarded_ports(global=false)
           raise NotImplementedError
         end
@@ -371,6 +406,15 @@ module VagrantPlugins
         end
 
         # Returns a list of available host only interfaces.
+        # Each interface is represented as a Hash with the following details:
+        #
+        # {
+        #   name:     'Host-Only',     # Parallels Network ID
+        #   bound_to: 'vnic1',         # interface name
+        #   ip:       '10.37.129.2',   # IP address of the interface
+        #   netmask:  '255.255.255.0', # netmask associated with the interface
+        #   status:   'Up'             # status of the interface
+        # }
         #
         # @return [Array<Symbol => String>]
         def read_host_only_interfaces
@@ -387,7 +431,7 @@ module VagrantPlugins
           end
 
           if shared_ifaces.empty?
-            raise Errors::SharedAdapterNotFound
+            raise Errors::SharedInterfaceNotFound
           end
 
           shared_ifaces.values.first.fetch('mac', nil)
@@ -421,11 +465,7 @@ module VagrantPlugins
         #
         # @return [String] Shared network ID
         def read_shared_network_id
-          # There should be only one Shared interface
-          shared_net = read_virtual_networks.detect do |net|
-            net['Type'] == 'shared'
-          end
-          shared_net.fetch('Network ID')
+          'Shared'
         end
 
         # Returns info about shared network interface.
@@ -537,7 +577,11 @@ module VagrantPlugins
         # @param [String] uuid Name or UUID of the target VM
         # @param [String] snapshot_id Snapshot ID
         def restore_snapshot(uuid, snapshot_id)
-          execute_prlctl('snapshot-switch', uuid, '-i', snapshot_id)
+          # Sometimes this command fails with 'Data synchronization is currently
+          # in progress'. Just wait and retry.
+          retryable(on: VagrantPlugins::Parallels::Errors::ExecutionError, tries: 2, sleep: 2) do
+            execute_prlctl('snapshot-switch', uuid, '-i', snapshot_id)
+          end
         end
 
         # Resumes the virtual machine.