vagrant-parallels 1.7.8 → 2.2.1

data/lib/vagrant-parallels/cap/mount_options.rb

@@ -0,0 +1,49 @@
+require_relative "../util/unix_mount_helpers"
+
+module VagrantPlugins
+  module Parallels
+    module SyncedFolderCap
+      module MountOptions
+        extend VagrantPlugins::Parallels::Util::UnixMountHelpers
+
+        PRL_MOUNT_TYPE = "prl_fs".freeze
+
+        # Returns mount options for a parallels synced folder
+        #
+        # @param [Machine] machine
+        # @param [String] name of mount
+        # @param [String] path of mount on guest
+        # @param [Hash] hash of mount options
+        def self.mount_options(machine, name, guest_path, options)
+          mount_options = options.fetch(:mount_options, [])
+          detected_ids = detect_owner_group_ids(machine, guest_path, mount_options, options)
+          mount_uid = detected_ids[:uid]
+          mount_gid = detected_ids[:gid]
+
+          mount_options << "uid=#{mount_uid}"
+          mount_options << "gid=#{mount_gid}"
+          mount_options = mount_options.join(',')
+          return mount_options, mount_uid, mount_gid
+        end
+
+        def self.mount_type(machine)
+          return PRL_MOUNT_TYPE
+        end
+
+        ## We have to support 2 different expected interfaces of `mount_name` call:
+        ##   Vagrant < 2.2.15:   `def self.mount_name(machine, data)`
+        ##   Vagrant >= 2.2.15:  `def self.mount_name(machine, id, data)`
+        ## https://github.com/Parallels/vagrant-parallels/issues/384
+        def self.mount_name(*args)
+          if args.length >= 3
+            id = args[1]
+          else
+            id = args[-1][:guestpath]
+          end
+
+          id.gsub(/[*":<>?|\/\\]/,'_').sub(/^_/, '')
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-parallels/config.rb

@@ -71,7 +71,7 @@ module VagrantPlugins
           @functional_psf = true
         end
 
-        @linked_clone = false if @linked_clone == UNSET_VALUE
+        @linked_clone = true if @linked_clone == UNSET_VALUE
         @linked_clone_snapshot = nil if @linked_clone_snapshot == UNSET_VALUE
 
         @name = nil if @name == UNSET_VALUE

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

@@ -193,14 +193,13 @@ module VagrantPlugins
           end
         end
 
-        # Deletes any host only networks that aren't being used for anything.
+        # Deletes host-only networks that aren't being used by any virtual machine.
         def delete_unused_host_only_networks
           networks = read_virtual_networks
-          # 'Shared'(vnic0) and 'Host-Only'(vnic1) are default in Parallels Desktop
-          # They should not be deleted anyway.
+
+          # Exclude all host-only network interfaces which were not created by vagrant provider.
           networks.keep_if do |net|
-            net['Type'] == 'host-only' && net['Bound To'] &&
-              net['Bound To'].match(/^(?>vnic|Parallels Host-Only #)(\d+)$/)[1].to_i >= 2
+            net['Type'] == 'host-only' && net['Network ID'] =~ /^vagrant-vnet(\d+)$/
           end
 
           read_vms_info.each do |vm|
@@ -210,8 +209,8 @@ module VagrantPlugins
             end
           end
 
+          # Delete all unused network interfaces.
           networks.each do |net|
-            # Delete the actual host only network interface.
             execute_prlsrvctl('net', 'del', net['Network ID'])
           end
         end
@@ -496,7 +495,6 @@ module VagrantPlugins
         #
         # {
         #   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
@@ -519,11 +517,9 @@ module VagrantPlugins
             }
 
             adapter = net_info['Parallels adapter']
-            if adapter && net_info['Bound To']
-              # In PD >= 10.1.2 there are new field names for an IP/Subnet
-              iface[:ip]       = adapter['IP address'] || adapter['IPv4 address']
-              iface[:netmask]  = adapter['Subnet mask'] || adapter['IPv4 subnet mask']
-              iface[:bound_to] = net_info['Bound To']
+            if adapter
+              iface[:ip]       = adapter['IPv4 address']
+              iface[:netmask]  = adapter['IPv4 subnet mask']
               iface[:status]   = 'Up'
 
               if adapter['IPv6 address'] && adapter['IPv6 subnet mask']
@@ -618,11 +614,9 @@ module VagrantPlugins
           }
           adapter = net_info['Parallels adapter']
 
-          if adapter && net_info['Bound To']
-            # In PD >= 10.1.2 there are new field names for an IP/Subnet
-            iface[:ip]       = adapter['IP address'] || adapter['IPv4 address']
-            iface[:netmask]  = adapter['Subnet mask'] || adapter['IPv4 subnet mask']
-            iface[:bound_to] = net_info['Bound To']
+          if adapter
+            iface[:ip]       = adapter['IPv4 address']
+            iface[:netmask]  = adapter['IPv4 subnet mask']
             iface[:status]   = 'Up'
           end
 
@@ -724,22 +718,6 @@ module VagrantPlugins
           vms_arr | templates_arr
         end
 
-        # Regenerates 'SourceVmUuid' to avoid SMBIOS UUID collision [GH-113]
-        #
-        def regenerate_src_uuid
-          settings = read_settings
-          vm_config = File.join(settings.fetch('Home'), 'config.pvs')
-
-          # Generate and put new SourceVmUuid
-          xml = Nokogiri::XML(File.open(vm_config))
-          p = '//ParallelsVirtualMachine/Identification/SourceVmUuid'
-          xml.xpath(p).first.content = "{#{SecureRandom.uuid}}"
-
-          File.open(vm_config, 'w') do |f|
-            f.write xml.to_xml
-          end
-        end
-
         # Registers the virtual machine
         #
         # @param [String] pvm_file Path to the machine image (*.pvm)

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

@@ -37,26 +37,23 @@ module VagrantPlugins
           @@version_lock.synchronize do
             @@version = read_version
           end
-            
+
           # Instantiate the proper version driver for Parallels Desktop
           @logger.debug("Finding driver for Parallels Desktop version: #{@@version}")
 
           major_ver = @@version.split('.').first.to_i
           driver_klass =
             case major_ver
-            when 1..9 then raise Errors::ParallelsUnsupportedVersion
-            when 10 then PD_10
+            when 1..10 then raise Errors::ParallelsUnsupportedVersion
             when 11 then PD_11
             else PD_12
             end
 
           # Starting since PD 11 only Pro and Business editions have CLI
           # functionality and can be used with Vagrant.
-          if major_ver >= 11
-            edition = read_edition
-            if !edition || !%w(any pro business).include?(edition)
-              raise Errors::ParallelsUnsupportedEdition
-            end
+          edition = read_edition
+          if !edition || !%w(any pro business).include?(edition)
+            raise Errors::ParallelsUnsupportedEdition
           end
 
           @logger.info("Using Parallels driver: #{driver_klass}")
@@ -143,6 +140,7 @@ module VagrantPlugins
           # * prlctl version 8.0.12345.123456
           # * prlctl version 9.0.12345.123456
           # * prlctl version 10.0.0 (12345) rev 123456
+          # * prlctl version 14.0.1 (45154)
           #
           # But we need exactly the first 3 numbers: "x.x.x"
           output = execute(@prlctl_path, '--version')

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

@@ -2,13 +2,13 @@ require 'log4r'
 
 require 'vagrant/util/platform'
 
-require_relative 'pd_10'
+require_relative 'base'
 
 module VagrantPlugins
   module Parallels
     module Driver
       # Driver for Parallels Desktop 11.
-      class PD_11 < PD_10
+      class PD_11 < Base
         def initialize(uuid)
           super(uuid)
 

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

@@ -7,7 +7,7 @@ require_relative 'pd_11'
 module VagrantPlugins
   module Parallels
     module Driver
-      # Driver for Parallels Desktop 12.
+      # Driver for Parallels Desktop 12 and later.
       class PD_12 < PD_11
         def initialize(uuid)
           super(uuid)

data/lib/vagrant-parallels/errors.rb

@@ -27,10 +27,6 @@ module VagrantPlugins
         error_key(:json_parse_error)
       end
 
-      class LinuxMountFailed < VagrantParallelsError
-        error_key(:linux_mount_failed)
-      end
-
       class LinuxPrlFsInvalidOptions < VagrantParallelsError
         error_key(:linux_prl_fs_invalid_options)
       end
@@ -39,6 +35,10 @@ module VagrantPlugins
         error_key(:mac_os_x_required)
       end
 
+      class NetworkCollision < VagrantParallelsError
+        error_key(:network_collision)
+      end
+
       class NetworkInvalidAddress < VagrantParallelsError
         error_key(:network_invalid_address)
       end
@@ -55,6 +55,10 @@ module VagrantPlugins
         error_key(:parallels_invalid_version)
       end
 
+      class ParallelsMountFailed < VagrantParallelsError
+        error_key(:parallels_mount_failed)
+      end
+
       class ParallelsNotDetected < VagrantParallelsError
         error_key(:parallels_not_detected)
       end
@@ -104,4 +108,4 @@ module VagrantPlugins
       end
     end
   end
-end
+end

data/lib/vagrant-parallels/guest_cap/linux/mount_parallels_shared_folder.rb

@@ -1,7 +1,19 @@
+require 'shellwords'
+
+require_relative "../../util/unix_mount_helpers"
+
 module VagrantPlugins
   module Parallels
     module GuestLinuxCap
       class MountParallelsSharedFolder
+        extend VagrantPlugins::Parallels::Util::UnixMountHelpers
+
+        # Mounts Parallels Desktop shared folder on linux guest
+        #
+        # @param [Machine] machine
+        # @param [String] name of mount
+        # @param [String] path of mount on guest
+        # @param [Hash] hash of mount options
         def self.mount_parallels_shared_folder(machine, name, guestpath, options)
           # Sanity check for mount options: we are not supporting
           # VirtualBox-specific 'fmode' and 'dmode' options
@@ -15,83 +27,38 @@ module VagrantPlugins
             end
           end
 
-          expanded_guest_path = machine.guest.capability(
-            :shell_expand_guest_path, guestpath)
+          guest_path = Shellwords.escape(guestpath)
+          mount_type = options[:plugin].capability(:mount_type)
 
-          mount_commands = []
+          @@logger.debug("Mounting #{name} (#{options[:hostpath]} to #{guestpath})")
 
-          if options[:owner].is_a? Integer
-            mount_uid = options[:owner]
-          else
-            mount_uid = "`id -u #{options[:owner]}`"
-          end
-
-          if options[:group].is_a? Integer
-            mount_gid = options[:group]
-            mount_gid_old = options[:group]
-          else
-            mount_gid = "`getent group #{options[:group]} | cut -d: -f3`"
-            mount_gid_old = "`id -g #{options[:group]}`"
-          end
-
-          # First mount command uses getent to get the group
-          mount_options = "-o uid=#{mount_uid},gid=#{mount_gid}"
-          mount_options += ",#{options[:mount_options].join(',')}" if options[:mount_options]
-          mount_commands << "mount -t prl_fs #{mount_options} #{name} #{expanded_guest_path}"
-
-          # Second mount command uses the old style `id -g`
-          mount_options = "-o uid=#{mount_uid},gid=#{mount_gid_old}"
-          mount_options += ",#{options[:mount_options].join(',')}" if options[:mount_options]
-          mount_commands << "mount -t prl_fs #{mount_options} #{name} #{expanded_guest_path}"
-
-          # Clear prior symlink if exists
-          if machine.communicate.test("test -L #{expanded_guest_path}")
-            machine.communicate.sudo("rm #{expanded_guest_path}")
-          end
+          mount_options, mount_uid, mount_gid = options[:plugin].capability(:mount_options, name, guest_path, options)
+          mount_command = "mount -t #{mount_type} -o #{mount_options} #{name} #{guest_path}"
 
           # Create the guest path if it doesn't exist
-          machine.communicate.sudo("mkdir -p #{expanded_guest_path}")
+          machine.communicate.sudo("mkdir -p #{guest_path}")
 
           # Attempt to mount the folder. We retry here a few times because
           # it can fail early on.
-          attempts = 0
-          while true
-            success = true
-
-            mount_commands.each do |command|
-              no_such_device = false
-              status = machine.communicate.sudo(command, error_check: false) do |type, data|
-                no_such_device = true if type == :stderr && data =~ /No such device/i
-              end
-
-              success = status == 0 && !no_such_device
-              break if success
-            end
-
-            break if success
-
-            attempts += 1
-            if attempts > 10
-              raise VagrantPlugins::Parallels::Errors::LinuxMountFailed,
-                command: mount_commands.join("\n")
-            end
-
-            sleep 2
+          stderr = ""
+          retryable(on: Errors::ParallelsMountFailed, tries: 3, sleep: 5) do
+            machine.communicate.sudo(mount_command,
+              error_class: Errors::ParallelsMountFailed,
+              error_key: :parallels_mount_failed,
+              command: mount_command,
+              output: stderr,
+            ) { |type, data| stderr = data if type == :stderr }
           end
 
-          # Emit an upstart event if we can
-          machine.communicate.sudo <<-EOH.gsub(/^ {10}/, "")
-            if command -v /sbin/init && /sbin/init 2>/dev/null --version | grep upstart; then
-              /sbin/initctl emit --no-wait vagrant-mounted MOUNTPOINT=#{expanded_guest_path}
-            fi
-          EOH
+          emit_upstart_notification(machine, guest_path)
         end
 
         def self.unmount_parallels_shared_folder(machine, guestpath, options)
-          result = machine.communicate.sudo(
-            "umount #{guestpath}", error_check: false)
+          guest_path = Shellwords.escape(guestpath)
+
+          result = machine.communicate.sudo("umount #{guest_path}", error_check: false)
           if result == 0
-            machine.communicate.sudo("rmdir #{guestpath}", error_check: false)
+            machine.communicate.sudo("rmdir #{guest_path}", error_check: false)
           end
         end
 

data/lib/vagrant-parallels/plugin.rb

@@ -103,6 +103,21 @@ module VagrantPlugins
         SyncedFolder
       end
 
+      synced_folder_capability(:parallels, "mount_name") do
+        require_relative "cap/mount_options"
+        SyncedFolderCap::MountOptions
+      end
+
+      synced_folder_capability(:parallels, "mount_options") do
+        require_relative "cap/mount_options"
+        SyncedFolderCap::MountOptions
+      end
+
+      synced_folder_capability(:parallels, "mount_type") do
+        require_relative "cap/mount_options"
+        SyncedFolderCap::MountOptions
+      end
+
       # This initializes the internationalization strings.
       def self.setup_i18n
         I18n.load_path << File.expand_path('locales/en.yml', Parallels.source_root)
@@ -143,7 +158,6 @@ module VagrantPlugins
     # our drivers only when they are needed.
     module Driver
       autoload :Meta, File.expand_path('../driver/meta', __FILE__)
-      autoload :PD_10, File.expand_path('../driver/pd_10', __FILE__)
       autoload :PD_11, File.expand_path('../driver/pd_11', __FILE__)
       autoload :PD_12, File.expand_path('../driver/pd_12', __FILE__)
     end

data/lib/vagrant-parallels/synced_folder.rb

@@ -19,14 +19,11 @@ module VagrantPlugins
           end
 
           defs << {
-              name: os_friendly_id(id),
-              hostpath: hostpath.to_s,
+            name: data[:plugin].capability(:mount_name, id, data),
+            hostpath: hostpath.to_s,
           }
         end
 
-        # We should prepare only folders with unique hostpath values.
-        # Anyway, duplicates will be mounted later.
-        defs.uniq! { |d| d[:hostpath] }
         driver(machine).share_folders(defs)
 
         # short guestpaths first, so we don't step on ourselves
@@ -39,8 +36,6 @@ module VagrantPlugins
           end
         end
 
-        shf_config = driver(machine).read_shared_folders
-
         # Parallels Shared Folder services can override Vagrant synced folder
         # configuration. These services should be pre-configured.
         if machine.guest.capability?(:prepare_psf_services)
@@ -49,12 +44,8 @@ module VagrantPlugins
 
         # Go through each folder and mount
         machine.ui.output(I18n.t('vagrant.actions.vm.share_folders.mounting'))
-        folders.each do |_ , data|
-          # Parallels specific: get id from the VM setting
-          # It allows to mount one host folder more then one time [GH-105]
-          id = shf_config.key(data[:hostpath])
-
-          if data[:guestpath] and id
+        folders.each do |id , data|
+          if data[:guestpath]
             # Guest path specified, so mount the folder to specified point
             machine.ui.detail(I18n.t('vagrant.actions.vm.share_folders.mounting_entry',
                                      guestpath: data[:guestpath],
@@ -70,7 +61,11 @@ module VagrantPlugins
 
             # Mount the actual folder
             machine.guest.capability(
-                :mount_parallels_shared_folder, id, data[:guestpath], data)
+              :mount_parallels_shared_folder,
+              data[:plugin].capability(:mount_name, id, data),
+              data[:guestpath],
+              data
+            )
           else
             # If no guest path is specified, then automounting is disabled
             machine.ui.detail(I18n.t('vagrant.actions.vm.share_folders.nomount_entry',
@@ -89,7 +84,7 @@ module VagrantPlugins
         end
 
         # Remove the shared folders from the VM metadata
-        names = folders.map { |id, _data| os_friendly_id(id) }
+        names = folders.map { |id, data| data[:plugin].capability(:mount_name, id, data) }
         driver(machine).unshare_folders(names)
       end
 
@@ -103,11 +98,6 @@ module VagrantPlugins
       def driver(machine)
         machine.provider.driver
       end
-
-      def os_friendly_id(id)
-        # Replace chars *, ", :, <, >, ?, |, /, \
-        id.gsub(/[*":<>?|\/\\]/,'_').sub(/^_/, '')
-      end
     end
   end
 end