vagrant-parallels 2.3.1 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a092a3894860152f2315793cb2a6ca541bc3488b168e3e08c9ba9637f8c867
-  data.tar.gz: 7e6a76e6734bad9691232004722d0cc04f5bc53992798bd6e5074341dce985af
+  metadata.gz: 5316a81fe9c64de94bb88a2db7b9efcc015325d4b95bd4ec6302f7441334e0c3
+  data.tar.gz: d493a896f4b9776f2755038d333046c6fa920f7e1fdd45de96dee0ae4cf33ef4
 SHA512:
-  metadata.gz: 5ff72d8b55fde7f2d4444048fe9c736e0f312c61f8b5098b0ac5569a1b3415a6c6671b9c54375190cbcd43aebf55b74fbde681ae9ff2c77f0144bd199a525b60
-  data.tar.gz: 5181b7a0c84d03f593e7e4102e8289c95c292a5328566802f017851617259911012745707b78799bf113bd96e78200f95a6762abbb85135181883c273439dd6b
+  metadata.gz: 874be6069e0cf9ec4ee115d75b7979bd68a1c007d04f0552dae2a808d7025c8659926a906ce37814ee19c7c2e04ef7b753d2c5b1d2121f8670092a40b77b5248
+  data.tar.gz: 53435b75213e446b68d679f2600d47e70cc4d5fec8141d9be6e9eba270030cfa9f3d48cf398d5ce07311503de8a053802fb1629408bd49e5f49d25cbf40d0562

data/CHANGELOG.md

@@ -1,10 +1,36 @@
-## 2.3.1 (March 23, 2022)
+## 2.4.0 (May 22, 2023)
+IMPROVEMENTS:
+  - use clonefile copy for macvm boxes
+  [[GH-459](https://github.com/Parallels/vagrant-parallels/pull/459)]
+
+BUG FIXES:
+  - Bump activesupport from 6.1.7.3 to 6.1.7.5
+  [[GH-457](https://github.com/Parallels/vagrant-parallels/pull/457)]
+  - Don't try to call methdods on Nil
+  [[GH-456](https://github.com/Parallels/vagrant-parallels/pull/456)]
+  - Add a doc note for releasing a new provider version
+  [[GH-452](https://github.com/Parallels/vagrant-parallels/pull/452)]
+  - website: Remove unused images
+  [[GH-450](https://github.com/Parallels/vagrant-parallels/pull/450)]
+  - adding macos
+  [[GH-447](https://github.com/Parallels/vagrant-parallels/pull/447)]
+
+## 2.4.0 (May 22, 2023)
+IMPROVEMENTS:
+  - Implement shared folder support for `.macvm` VMs
+  [[GH-448](https://github.com/Parallels/vagrant-parallels/pull/448)]
+
+BUG FIXES:
+  - Fix shared folder mount error on `.macvm` VMs
+  [[GH-445](https://github.com/Parallels/vagrant-parallels/pull/445)]
+
+## 2.3.1 (March 23, 2023)
 BUG FIXES:
   - Fix the detection of VM IP. Wait for the IP to become available to
   avoid connection issues and Vagrant warnings.
   [[GH-440](https://github.com/Parallels/vagrant-parallels/issues/440)]
 
-## 2.3.0 (March 22, 2022)
+## 2.3.0 (March 22, 2023)
 IMPROVEMENTS:
   - Support fetching the VM IP using prlctl
   [[GH-434](https://github.com/Parallels/vagrant-parallels/pull/434)].

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

@@ -4,7 +4,6 @@ module VagrantPlugins
   module Parallels
     module Action
       class Import
-        include VagrantPlugins::Parallels::Util::Common
         @@lock = Mutex.new
 
         def initialize(app, env)
@@ -26,7 +25,7 @@ module VagrantPlugins
 
           # Linked clones are supported only for PD 11 and higher
           # Linked clones are not supported in macvms
-          if env[:machine].provider_config.linked_clone and !is_macvm(env)
+          if env[:machine].provider_config.linked_clone and !Util::Common::is_macvm(env[:machine])
             # Linked clone creation should not be concurrent [GH-206]
             options[:snapshot_id] = env[:clone_snapshot_id]
             options[:linked] = true

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

@@ -6,7 +6,6 @@ module VagrantPlugins
   module Parallels
     module Action
       class PrepareCloneSnapshot
-        include VagrantPlugins::Parallels::Util::Common
         @@lock = Mutex.new
 
         def initialize(app, env)
@@ -20,7 +19,7 @@ module VagrantPlugins
             return @app.call(env)
           end
 
-          if is_macvm(env)
+          if Util::Common::is_macvm(env[:machine])
             #Ignore, since macvms doesn't support snapshot creation
             @logger.info('Snapshot creation is not supported yet for macOS ARM Guests, skip snapshot preparing')
             return @app.call(env)

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

@@ -4,7 +4,6 @@ module VagrantPlugins
   module Parallels
     module Action
       class SaneDefaults
-        include VagrantPlugins::Parallels::Util::Common
 
         def initialize(app, env)
           @logger = Log4r::Logger.new('vagrant_parallels::action::sanedefaults')
@@ -30,7 +29,7 @@ module VagrantPlugins
 
         def default_settings
           # Options defined below are not supported for `*.macvm` VMs
-          return {} if is_macvm(@env)
+          return {} if Util::Common::is_macvm(@env[:machine])
 
           {
             tools_autoupdate: 'no',

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

@@ -78,7 +78,26 @@ module VagrantPlugins
         # @return [String] UUID of the new VM.
         def clone_vm(src_name, options = {})
           dst_name = "vagrant_temp_#{(Time.now.to_f * 1000.0).to_i}_#{rand(100000)}"
+          src_vm = json { execute_prlctl('list', '--json', '-i', src_name) }.first
 
+          if options[:linked] || !Util::Common.is_apfs?(src_vm.fetch('Home'))
+            # If linked clone is an option, or path to src is not on APFS, then do the normal clone.
+            prlctl_clone_vm(src_name, dst_name, options)
+          else
+            # We can use clonefile on APFS to do a fast CoW clone of the VM source and then register
+            copy_clone_vm(src_name, dst_name, options)
+          end
+          read_vms[dst_name]
+        end
+
+        # Uses prlctl to clone an existing registered VM
+        #
+        # @param [String] src_name Name or UUID of the source VM or template.
+        # @param [String] dst_name Name of the destination VM.
+        # @param [<String => String>] options Options to clone virtual machine.
+        def prlctl_clone_vm(src_name, dst_name, options = {})
+          list_args = ['list', '--json', '-i', src_name]
+          src_vm = json { execute_prlctl(*list_args) }.first
           args = ['clone', src_name, '--name', dst_name]
           args.concat(['--dst', options[:dst]]) if options[:dst]
 
@@ -97,7 +116,41 @@ module VagrantPlugins
               yield $1.to_i if block_given?
             end
           end
-          read_vms[dst_name]
+        end
+
+        # Uses cp with clonefile flag to clone an existing registered VM
+        #
+        # @param [String] src_name Name or UUID of the source VM or template.
+        # @param [String] dst_name Name of the destination VM.
+        # @param [<String => String>] options Options to clone virtual machine.
+        def copy_clone_vm(src_name, dst_name, options = {})
+          list_args = ['list', '--json', '-i', src_name]
+          src_vm = json { execute_prlctl(*list_args) }.first
+          basepath = File.dirname(src_vm.fetch('Home')).delete_suffix('/')
+          extension = File.basename(src_vm.fetch('Home')).delete_suffix('/').split('.').last
+          clonepath = File.join(ENV['HOME'], "Parallels", "#{dst_name}.#{extension}")
+          execute('cp', '-c', '-R', '-p', src_vm.fetch('Home'), clonepath)
+
+          # Update config.pvs with dst_name as this is what Parallels uses when registering
+          update_vm_name(File.join(clonepath, 'config.pvs'), dst_name)
+
+          # Register the cloned path as a new VM
+          args = ['register', clonepath]
+          # Regenerate SourceVmUuid of the cloned VM
+          args << '--regenerate-src-uuid' if options[:regenerate_src_uuid]
+
+          # Regenerate SourceVmUuid of the cloned VM
+          execute_prlctl(*args)
+
+          # Don't need the box hanging around in Parallels
+          execute_prlctl('unregister', src_name)
+        end
+
+        def update_vm_name(config_pvs_path, name)
+          xml = Nokogiri::XML(File.read(config_pvs_path))
+          elem = xml.at_xpath('//ParallelsVirtualMachine/Identification/VmName')
+          elem.content = name
+          File.write(config_pvs_path, xml.to_xml)
         end
 
         # Compacts the specified virtual disk image

data/lib/vagrant-parallels/plugin.rb

@@ -103,6 +103,16 @@ module VagrantPlugins
         SyncedFolder
       end
 
+      synced_folder(:parallels_macvm) do
+        require_relative 'synced_folder_macvm'
+        SyncedFolderMacVM
+      end
+
+      synced_folder_capability(:parallels_macvm, "mount_name") do
+        require_relative "cap/mount_options"
+        SyncedFolderCap::MountOptions
+      end
+
       synced_folder_capability(:parallels, "mount_name") do
         require_relative "cap/mount_options"
         SyncedFolderCap::MountOptions

data/lib/vagrant-parallels/synced_folder.rb

@@ -4,9 +4,10 @@ module VagrantPlugins
   module Parallels
     class SyncedFolder < Vagrant.plugin('2', :synced_folder)
       def usable?(machine, raise_errors=false)
-        # These synced folders only work if the provider is Parallels
+        # These synced folders only work if the provider is Parallels and the guest is not *.macvm
         machine.provider_name == :parallels &&
-          machine.provider_config.functional_psf
+          machine.provider_config.functional_psf &&
+          !Util::Common::is_macvm(machine)
       end
 
       def prepare(machine, folders, _opts)

data/lib/vagrant-parallels/synced_folder_macvm.rb

@@ -0,0 +1,50 @@
+require 'vagrant/util/platform'
+
+module VagrantPlugins
+  module Parallels
+    class SyncedFolderMacVM < Vagrant.plugin('2', :synced_folder)
+      def usable?(machine, raise_errors=false)
+        # These synced folders only work if the provider is Parallels and the guest is *.macvm
+        machine.provider_name == :parallels && Util::Common::is_macvm(machine)
+      end
+
+      def prepare(machine, folders, _opts)
+        # Setup shared folder definitions in the VM config.
+        defs = []
+        folders.each do |id, data|
+          hostpath = data[:hostpath]
+          if !data[:hostpath_exact]
+            hostpath = Vagrant::Util::Platform.cygwin_windows_path(hostpath)
+          end
+
+          defs << {
+            name: data[:plugin].capability(:mount_name, id, data),
+            hostpath: hostpath.to_s,
+          }
+        end
+
+        driver(machine).share_folders(defs)
+      end
+
+      def enable(machine, folders, _opts)
+        # TBD: Synced folders for *.macvm are not implemented yet
+        return
+      end
+
+      def disable(machine, folders, _opts)
+        # Remove the shared folders from the VM metadata
+        names = folders.map { |id, data| data[:plugin].capability(:mount_name, id, data) }
+        driver(machine).unshare_folders(names)
+      end
+
+      def cleanup(machine, opts)
+        driver(machine).clear_shared_folders if machine.id && machine.id != ''
+      end
+
+      # This is here so that we can stub it for tests
+      def driver(machine)
+        machine.provider.driver
+      end
+    end
+  end
+end

data/lib/vagrant-parallels/util/common.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 module VagrantPlugins
   module Parallels
     module Util
@@ -5,10 +7,27 @@ module VagrantPlugins
 
         # Determines whether the VM's box contains a macOS guest for an Apple Silicon host.
         # In this case the image file ends with '.macvm' instead of '.pvm'
-        def is_macvm(env)
-          return !!Dir.glob(env[:machine].box.directory.join('*.macvm')).first
+        def self.is_macvm(machine)
+          return !machine.box.nil? && !!Dir.glob(machine.box.directory.join('*.macvm')).first
+        end
+
+        # Determines if the box directory is on an APFS filesystem
+        def self.is_apfs?(path, &block)
+            output = {stdout: '', stderr: ''}
+            df_command = %w[df -T apfs]
+            df_command << Shellwords.escape(path)
+            execute(*df_command, &block).exit_code == 0
         end
 
+        private
+
+        def self.execute(*command, &block)
+          command << { notify: [:stdout, :stderr] }
+
+          Vagrant::Util::Busy.busy(lambda {}) do
+            Vagrant::Util::Subprocess.execute(*command, &block)
+          end
+        end
       end
     end
   end

data/lib/vagrant-parallels/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Parallels
-    VERSION = '2.3.1'
+    VERSION = '2.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-parallels
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.1
 platform: ruby
 authors:
 - Mikhail Zholobov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -142,6 +142,7 @@ files:
 - lib/vagrant-parallels/plugin.rb
 - lib/vagrant-parallels/provider.rb
 - lib/vagrant-parallels/synced_folder.rb
+- lib/vagrant-parallels/synced_folder_macvm.rb
 - lib/vagrant-parallels/util/common.rb
 - lib/vagrant-parallels/util/compile_forwarded_ports.rb
 - lib/vagrant-parallels/util/unix_mount_helpers.rb
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Parallels provider for Vagrant.