vagrant-parallels 1.5.1 → 1.6.0

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

@@ -14,6 +14,11 @@ module VagrantPlugins
         # We use forwardable to do all our driver forwarding
         extend Forwardable
 
+        # We cache the Parallels Desktop version here once we have one,
+        # since during the execution of Vagrant, it likely doesn't change.
+        @@version = nil
+        @@version_lock = Mutex.new
+
         # The UUID of the virtual machine we represent
         attr_reader :uuid
 
@@ -29,23 +34,26 @@ module VagrantPlugins
 
           # Read and assign the version of Parallels Desktop we know which
           # specific driver to instantiate.
-          @version = read_version || ''
-
+          @@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}")
+          @logger.debug("Finding driver for Parallels Desktop version: #{@@version}")
 
+          major_ver = @@version.split('.').first.to_i
           driver_klass =
-            case @version.split('.').first
-              when '8' then PD_8
-              when '9' then PD_9
-              when '10' then PD_10
-              when '11' then PD_11
-              else raise Errors::ParallelsUnsupportedVersion
+            case major_ver
+            when 1..7 then raise Errors::ParallelsUnsupportedVersion
+            when 8 then PD_8
+            when 9 then PD_9
+            when 10 then PD_10
+            else PD_11
             end
 
           # Starting since PD 11 only Pro and Business editions have CLI
           # functionality and can be used with Vagrant.
-          if @version.split('.').first.to_i >= 11
+          if major_ver >= 11
             edition = read_edition
             if !edition || !%w(any pro business).include?(edition)
               raise Errors::ParallelsUnsupportedEdition
@@ -54,6 +62,7 @@ module VagrantPlugins
 
           @logger.info("Using Parallels driver: #{driver_klass}")
           @driver = driver_klass.new(@uuid)
+          @version = @@version
 
           if @uuid
             # Verify the VM exists, and if it doesn't, then don't worry
@@ -77,6 +86,7 @@ module VagrantPlugins
                        :forward_ports,
                        :halt,
                        :clone_vm,
+                       :list_snapshots,
                        :read_bridged_interfaces,
                        :read_current_snapshot,
                        :read_forwarded_ports,

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

@@ -14,27 +14,6 @@ module VagrantPlugins
 
           @logger = Log4r::Logger.new('vagrant_parallels::driver::pd_11')
         end
-
-        def create_snapshot(uuid, options)
-          args = ['snapshot', uuid]
-          args.concat(['--name', options[:name]]) if options[:name]
-          args.concat(['--description', options[:desc]]) if options[:desc]
-
-          stdout = execute_prlctl(*args)
-          if stdout =~ /\{([\w-]+)\}/
-            return $1
-          end
-
-          raise Errors::SnapshotIdNotDetected, stdout: stdout
-        end
-
-        def read_current_snapshot(uuid)
-          if execute_prlctl('snapshot-list', uuid) =~ /\*\{([\w-]+)\}/
-            return $1
-          end
-
-          nil
-        end
       end
     end
   end

data/lib/vagrant-parallels/errors.rb

@@ -7,6 +7,14 @@ module VagrantPlugins
         error_namespace('vagrant_parallels.errors')
       end
 
+      class BoxImageNotFound < VagrantParallelsError
+        error_key(:box_image_not_found)
+      end
+
+      class BoxIDNotFound < VagrantParallelsError
+        error_key(:box_id_not_found)
+      end
+
       class DhcpLeasesNotAccessible < VagrantParallelsError
         error_key(:dhcp_leases_file_not_accessible)
       end
@@ -51,10 +59,6 @@ module VagrantPlugins
         error_key(:parallels_tools_iso_not_found)
       end
 
-      class ParallelsTplNameNotFound < VagrantParallelsError
-        error_key(:parallels_tpl_name_not_found)
-      end
-
       class ParallelsVMOptionNotFound < VagrantParallelsError
         error_key(:parallels_vm_option_not_found)
       end
@@ -75,8 +79,12 @@ module VagrantPlugins
         error_key(:snapshot_id_not_detected)
       end
 
-      class VMImportFailure < VagrantParallelsError
-        error_key(:vm_import_failure)
+      class SnapshotNotFound < VagrantParallelsError
+        error_key(:snapshot_not_found)
+      end
+
+      class VMCloneFailure < VagrantParallelsError
+        error_key(:vm_clone_failure)
       end
 
       class VMNameExists < VagrantParallelsError

data/lib/vagrant-parallels/guest_cap/darwin/install_parallels_tools.rb

@@ -0,0 +1,34 @@
+module VagrantPlugins
+  module Parallels
+    module GuestDarwinCap
+      class InstallParallelsTools
+
+        def self.install_parallels_tools(machine)
+          machine.communicate.tap do |comm|
+            tools_iso_path = File.expand_path(
+              machine.provider.driver.read_guest_tools_iso_path('darwin'),
+              machine.env.root_path
+            )
+            remote_file = '/tmp/prl-tools-mac.iso'
+            mount_point = "/media/prl-tools-lin_#{rand(100000)}/"
+
+            comm.upload(tools_iso_path, remote_file)
+
+            # Create mount point directory if needed
+            if !comm.test("test -d \"#{mount_point}\"", :sudo => true)
+              comm.sudo("mkdir -p \"#{mount_point}\"")
+            end
+
+            # Mount ISO and install Parallels Tools
+            comm.sudo("hdiutil attach #{remote_file} -mountpoint #{mount_point}")
+            comm.sudo("installer -pkg '#{mount_point}/Install.app/Contents/Resources/Install.mpkg' -target /")
+            comm.sudo("hdiutil detach '#{mount_point}'")
+
+            comm.sudo("rm -Rf \"#{mount_point}\"")
+            comm.sudo("rm -f \"#{remote_file}\"")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-parallels/plugin.rb

@@ -6,8 +6,8 @@ end
 
 # This is a sanity check to make sure no one is attempting to install
 # this into an early Vagrant version.
-if Vagrant::VERSION < '1.5.0'
-  raise 'The Vagrant Parallels plugin is only compatible with Vagrant 1.5+'
+if Gem::Version.new(Vagrant::VERSION).release < Gem::Version.new('1.8.0')
+  raise 'The installed version of Vagrant Parallels plugin is only compatible with Vagrant 1.8+'
 end
 
 module VagrantPlugins
@@ -33,6 +33,11 @@ module VagrantPlugins
         Config
       end
 
+      guest_capability(:darwin, :install_parallels_tools) do
+        require_relative 'guest_cap/darwin/install_parallels_tools'
+        GuestDarwinCap::InstallParallelsTools
+      end
+
       guest_capability(:darwin, :mount_parallels_shared_folder) do
         require_relative 'guest_cap/darwin/mount_parallels_shared_folder'
         GuestDarwinCap::MountParallelsSharedFolder
@@ -64,18 +69,28 @@ module VagrantPlugins
       end
 
       provider_capability(:parallels, :public_address) do
-        require_relative 'cap/public_address'
-        Cap::PublicAddress
+        require_relative 'cap'
+        Cap
+      end
+
+      provider_capability(:parallels, :forwarded_ports) do
+        require_relative 'cap'
+        Cap
       end
 
       provider_capability(:parallels, :host_address) do
-        require_relative 'cap/host_address'
-        Cap::HostAddress
+        require_relative 'cap'
+        Cap
       end
 
       provider_capability(:parallels, :nic_mac_addresses) do
-        require_relative 'cap/nic_mac_addresses'
-        Cap::NicMacAddresses
+        require_relative 'cap'
+        Cap
+      end
+
+      provider_capability(:parallels, :snapshot_list) do
+        require_relative 'cap'
+        Cap
       end
 
       synced_folder(:parallels) do

data/lib/vagrant-parallels/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Parallels
-    VERSION = '1.5.1'
+    VERSION = '1.6.0'
   end
 end

data/locales/en.yml

@@ -7,6 +7,18 @@ en:
 # Translations for exception classes
 #-------------------------------------------------------------------------------
     errors:
+      box_id_not_found: |-
+        Parallels provider couldn't fetch the box image ID. This is usually because
+        the "config.pvs" file is corrupted or doesn't exist. Please remove the box,
+        re-add it, and try again.
+
+        Box: "%{name}"
+        Box VM config: "%{config}"
+
+      box_image_not_found: |-
+        Parallels VM image (*.pvm) could not be found in the directory of
+        '%{name}' box. This is usually because the image has been removed manually.
+        Please remove the box, re-add it, and try again.
       dhcp_leases_file_not_accessible: |-
         Parallels DHCP leases file is not accessible. The Parallels provider
         uses it to detect an IP address of virtual machine. This file must be
@@ -67,12 +79,6 @@ en:
         reinstall Parallels Desktop.
 
         Expected ISO path: "%{iso_path}"
-      parallels_tpl_name_not_found: |-
-        The VM import failed! Template name not found. Please verify that
-        the box you're using is not corrupted and try again.
-
-        Template config path: "%{config_path}"
-
       parallels_vm_option_not_found: |-
         Could not find a required option of Parallels Desktop virtual machine:
           %{vm_option}
@@ -95,17 +101,22 @@ en:
         Desktop for Mac. Please, be aware while choosing the edition to upgrade to.
       snapshot_id_not_detected: |-
         ID of the newly created shapshod could not be detected. This is an
-        internal error that users should never see. Please report a bug.
+        internal error that users should never see. Please report a bug to
+        Parallels provider.
 
         stdout: %{stdout}
+      snapshot_not_found: |-
+        The 'linked_clone_snapshot' specified could not be found. Please double
+        check and try again.
+
+         Snapshot ID: %{snapshot}
       shared_adapter_not_found: |-
         Shared network adapter was not found in your virtual machine configuration.
         It is required to communicate with VM and forward ports. Please check
         network configuration in your Vagrantfile.
-      vm_import_failure: |-
-        The VM import failed! Please verify that the box you're using is not
+      vm_clone_failure: |-
+        The VM cloning failed! Please ensure that the box you're using is not
         corrupted and try again.
-
       vm_name_exists: |-
         Parallels Desktop virtual machine with the name '%{name}' already exists.
         Please use another name or delete the machine with the existing
@@ -170,6 +181,12 @@ en:
 #-------------------------------------------------------------------------------
     actions:
       vm:
+        box:
+          register: Registering VM image from the base box '%{name}'...
+          unregister: Unregistering the box VM image...
+        clone:
+          full: Cloning new virtual machine...
+          linked: Creating new virtual machine as a linked clone...
         handle_guest_tools:
           cant_install: |-
             Vagrant doesn't support installing Parallels Tools for the guest OS
@@ -181,24 +198,21 @@ en:
             Installing the proper version of Parallels Tools. This may take a few minutes...
           not_detected: |-
             Parallels Tools were not detected on this VM! They are required
-            for forwarded ports, shared folders, host only networking and more.
-            If SSH fails or shared folders are not working on this machine,
-            please install Parallels Tools within the virtual machine and
-            reload your VM.
+            for shared folders, time sync and more. If shared folders are not
+            working on this machine, please install Parallels Tools within the
+            virtual machine and reload your VM.
           rebooting: |-
             Parallels Tools have been installed. Rebooting the VM...
           outdated: |-
             Parallels Tools installed on this VM are outdated! In most cases
             this is fine but in rare cases it can cause things such as shared
             folders to not work properly. If you see shared folder errors,
-            please update Parallels Tools within the virtual machine and 
+            please update Parallels Tools within the virtual machine and
             reload your VM.
         export:
           compacting: Compacting exported HDDs...
         forward_ports:
           forwarding_entry: |-
             %{guest_port} => %{host_port}
-        import:
-          importing_linked: Importing base box '%{name}' as a linked clone...
         sane_defaults:
           setting: Setting the default configuration for VM...

data/test/acceptance/provider/linked_clone_spec.rb

@@ -10,7 +10,6 @@ shared_examples 'provider/linked_clone' do |provider, options|
   before do
     environment.skeleton('linked_clone')
     assert_execute('vagrant', 'box', 'add', 'basic', options[:box])
-    assert_execute('vagrant', 'up', "--provider=#{provider}")
   end
 
   after do
@@ -18,7 +17,12 @@ shared_examples 'provider/linked_clone' do |provider, options|
   end
 
   it 'creates machine as linked clone' do
-    status('Test: machine is running after up')
+    status('Test: machine is created as a linked clone')
+    result = execute('vagrant', 'up', "--provider=#{provider}")
+    expect(result).to exit_with(0)
+    expect(result.stdout).to match(/linked clone/)
+
+    status('Test: machine is available by ssh')
     result = execute('vagrant', 'ssh', '-c', 'echo foo')
     expect(result).to exit_with(0)
     expect(result.stdout).to match(/foo\n$/)

data/test/acceptance/skeletons/linked_clone/Vagrantfile

@@ -2,6 +2,6 @@ Vagrant.configure('2') do |config|
   config.vm.box = 'basic'
 
   config.vm.provider 'parallels' do |prl|
-    prl.use_linked_clone = true
+    prl.linked_clone = true
   end
 end

data/test/unit/base.rb

@@ -5,6 +5,7 @@ require 'rspec/autorun'
 # classes to test.
 require 'vagrant'
 require 'vagrant-parallels'
+require 'vagrant-spec/unit'
 
 # Add the test directory to the load path
 $:.unshift File.expand_path('../../', __FILE__)

data/test/unit/cap_test.rb

@@ -0,0 +1,96 @@
+require_relative 'base'
+
+require 'vagrant-parallels/cap'
+
+describe VagrantPlugins::Parallels::Cap do
+  include_context 'vagrant-unit'
+
+  let(:iso_env) do
+    # We have to create a Vagrantfile so there is a root path
+    env = isolated_environment
+    env.vagrantfile('')
+    env.create_vagrant_env
+  end
+
+  let(:machine) do
+    iso_env.machine(iso_env.machine_names[0], :dummy).tap do |m|
+      m.provider.stub(driver: driver)
+      m.stub(state: state)
+    end
+  end
+
+  let(:driver) { double('driver') }
+  let(:state)  { double('state', id: :running) }
+
+  describe '#forwarded_ports' do
+    it 'returns all the forwarded ports' do
+      allow(driver).to receive(:read_forwarded_ports).and_return([
+        { hostport:  123, guestport: 456 },
+        { hostport:  245, guestport: 245 }
+      ])
+
+      expect(described_class.forwarded_ports(machine)).to eq({
+        123 => 456,
+        245 => 245,
+      })
+    end
+
+    it 'returns nil when the machine is not running' do
+      allow(state).to receive(:id).and_return(:stopped)
+      expect(described_class.forwarded_ports(machine)).to be(nil)
+    end
+  end
+
+  describe '#host_address' do
+    it "returns host's IP of Shared interface" do
+      allow(driver).to receive(:read_shared_interface).and_return(ip: '1.2.3.4')
+      expect(described_class.host_address(machine)).to eq('1.2.3.4')
+    end
+  end
+
+  describe '#nic_mac_addresses' do
+    it 'returns a hash with MAC addresses' do
+      allow(driver).to receive(:read_mac_addresses).and_return(
+        ['001A2B3C4D5E', '005E4D3C2B1A'])
+      expect(described_class.nic_mac_addresses(machine)).to eq({
+        1 => '001A2B3C4D5E',
+        2 => '005E4D3C2B1A'
+      })
+    end
+
+    it 'returns an empty hash when there are no NICs' do
+      allow(driver).to receive(:read_mac_addresses).and_return([])
+      expect(described_class.nic_mac_addresses(machine)).to eq({})
+    end
+  end
+
+  describe '#public_address' do
+    it "returns VM's IP" do
+      allow(machine).to receive(:ssh_info).and_return(host: '1.2.3.4')
+      expect(described_class.public_address(machine)).to eq('1.2.3.4')
+    end
+
+    it "returns nil when the machine is not running" do
+      allow(state).to receive(:id).and_return(:stopped)
+      expect(described_class.public_address(machine)).to be(nil)
+    end
+
+    it "returns nil when there is no ssh info" do
+      allow(machine).to receive(:ssh_info).and_return(nil)
+      expect(described_class.public_address(machine)).to be(nil)
+    end
+  end
+
+  describe '#snapshot_list' do
+    it 'returns a list of snapshots' do
+      allow(machine).to receive(:id).and_return('foo')
+      allow(driver).to receive(:list_snapshots).with('foo').and_return({
+        'snap_name_1' => 'snap_uuid_1',
+        'snap_name_2' => 'snap_uuid_2'
+      })
+
+      expect(described_class.snapshot_list(machine)).to eq(
+        ['snap_name_1', 'snap_name_2'])
+    end
+  end
+end