vagrant-parallels 0.2.1 → 0.2.2.rc1

data/lib/vagrant-parallels/plugin.rb

@@ -47,14 +47,14 @@ module VagrantPlugins
 
     end
 
-    module Driver
-      autoload :PrlCtl, File.expand_path("../driver/prl_ctl", __FILE__)
-    end
+    autoload :Action, File.expand_path("../action", __FILE__)
 
-    module Util
-      def generate_name(path, suffix='')
-        "#{path.basename.to_s.gsub(/[^-a-z0-9_]/i, '')}#{suffix}_#{Time.now.to_i}"
-      end
+    # Drop some autoloads in here to optimize the performance of loading
+    # our drivers only when they are needed.
+    module Driver
+      autoload :Meta, File.expand_path("../driver/meta", __FILE__)
+      autoload :PD_8, File.expand_path("../driver/pd_8", __FILE__)
+      autoload :PD_9, File.expand_path("../driver/pd_9", __FILE__)
     end
   end
 end

data/lib/vagrant-parallels/provider.rb

@@ -9,7 +9,14 @@ module VagrantPlugins
       def initialize(machine)
         @logger = Log4r::Logger.new("vagrant::provider::parallels")
         @machine = machine
-        @driver = Parallels::Driver::PrlCtl.new(machine.id)
+
+        if !Vagrant::Util::Platform.darwin?
+          raise Errors::MacOSXRequired
+        end
+
+        # This method will load in our driver, so we call it now to
+        # initialize it.
+        machine_id_changed
       end
 
       # @see Vagrant::Plugin::V2::Provider#action
@@ -22,15 +29,38 @@ module VagrantPlugins
         nil
       end
 
+      # If the machine ID changed, then we need to rebuild our underlying
+      # driver.
+      def machine_id_changed
+        id = @machine.id
+
+        begin
+          @logger.debug("Instantiating the driver for machine ID: #{@machine.id.inspect}")
+          @driver = VagrantPlugins::Parallels::Driver::Meta.new(id)
+        rescue VagrantPlugins::Parallels::Driver::Meta::VMNotFound
+          # The virtual machine doesn't exist, so we probably have a stale
+          # ID. Just clear the id out of the machine and reload it.
+          @logger.debug("VM not found! Clearing saved machine ID and reloading.")
+          id = nil
+          retry
+        end
+      end
+
       # Returns the SSH info for accessing the Parallels VM.
       def ssh_info
         # If the VM is not created then we cannot possibly SSH into it, so
         # we return nil.
         return nil if state.id == :not_created
 
+        detected_ip = @machine.config.ssh.host || @driver.read_ip_dhcp
+
+        # If ip couldn't be detected then we cannot possibly SSH into it,
+        # and should return nil too.
+        return nil if detected_ip.nil?
+
         # Return ip from running machine, use ip from config if available
         return {
-          :host => @machine.config.ssh.host || @driver.ip,
+          :host => detected_ip,
           :port => @driver.ssh_port(@machine.config.ssh.guest_port)
         }
       end
@@ -65,4 +95,4 @@ module VagrantPlugins
       end
     end
   end
-end
+end

data/lib/vagrant-parallels/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Parallels
-    VERSION = "0.2.1"
+    VERSION = "0.2.2.rc1"
   end
 end

data/locales/en.yml

@@ -1,9 +1,16 @@
 en:
   vagrant_parallels:
+    parallels:
+      checking_guest_tools: |-
+        Checking for Parallels Tools installed on the VM...
+      network_adapter: |-
+        Adapter %{adapter}: %{type}%{extra}
 #-------------------------------------------------------------------------------
 # Translations for exception classes
 #-------------------------------------------------------------------------------
     errors:
+      mac_os_x_required: |-
+        Parallels provider only works on OS X (or Mac OS X).
       prlctl_error: |-
         There was an error while executing `prlctl`, a CLI used by Vagrant
         for controlling Parallels Desktop. The command and stderr is shown below.
@@ -11,18 +18,15 @@ en:
         Command: %{command}
 
         Stderr: %{stderr}
-      prlctl_not_found_error: |-
-        The "prlctl" command or one of its dependencies could not
-        be found. Please verify Parallels Desktop is properly installed. You can verify
-        everything is okay by running "prlctl --version" and verifying
-        that the Parallels Desktop version is outputted.
-      parallels_kernel_module_not_loaded: |-
-        Parallels Desktop is complaining that the kernel module is not loaded. Please
-        run `prlctl --version` or open the Parallels Desktop GUI to see the error
-        message which should contain instructions on how to fix this error.
       parallels_install_incomplete: |-
         Parallels Desktop is complaining that the installation is incomplete.
         Try to reinstall Parallels Desktop or contact Parallels support.
+      parallels_invalid_version: |-
+        Vagrant has detected that you have a version of Parallels Desktop installed
+        that is not supported. Please install or upgrade to one of the supported
+        versions listed below to use Vagrant:
+
+        %{supported_versions}
       parallels_no_room_for_high_level_network: |-
         There is no available slots on the Parallels Desktop VM for the configured
         high-level network interfaces. "private_network" and "public_network"
@@ -30,6 +34,21 @@ en:
         Parallels Desktop VM. Parallels Desktop limits the number of slots to 8, and it
         appears that every slot is in use. Please lower the number of used
         network adapters.
+      parallels_not_detected: |-
+        Vagrant could not detect Parallels Desktop! Make sure it is properly installed.
+        Vagrant uses the `prlctl` binary that ships with Parallels Desktop, and requires
+        this to be available on the PATH. If Parallels Desktop is installed, please find
+        the `prlctl` binary and add it to the PATH environmental variable.
+      vm_inaccessible: |-
+        Your VM has become "inaccessible." Unfortunately, this is a critical error
+        with Parallels Desktop that Vagrant can not cleanly recover from.
+        Please open VirtualBox and clear out your inaccessible virtual machines
+        or find a way to fix them.
+      vm_name_exists: |-
+        Parallels Desktop virtual machine with the name '%{name}' already exists.
+        Please use another name or delete the machine with the existing
+        name, and try again.
+
 #-------------------------------------------------------------------------------
 # Translations for config validation errors
 #-------------------------------------------------------------------------------
@@ -69,7 +88,7 @@ en:
           suspend the virtual machine. In either case, to restart it again,
           simply run `vagrant up`.
 #-------------------------------------------------------------------------------
-# Translations for Vagrant middleware acions
+# Translations for Vagrant middleware actions
 #-------------------------------------------------------------------------------
     actions:
       vm:
@@ -92,9 +111,4 @@ en:
             Parallels Tools Version: %{tools_version}
             Parallels Desktop Version: %{parallels_version}
         export:
-          compacting: Compacting exported HDD...
-        match_mac:
-          generate: |-
-            The specified base MAC is already in use. Generating a new unique MAC
-            address for Shared network...
-          matching: Matching MAC address for Shared network...
+          compacting: Compacting exported HDDs...

data/test/unit/base.rb

@@ -10,8 +10,8 @@ require 'vagrant-parallels'
 $:.unshift File.expand_path("../../", __FILE__)
 
 # Load in helpers
-require "support/tempdir"
 require "unit/support/shared/parallels_context"
+require "unit/support/shared/pd_driver_examples"
 
 # Do not buffer output
 $stdout.sync = true
@@ -21,7 +21,3 @@ $stderr.sync = true
 RSpec.configure do |c|
   c.expect_with :rspec, :stdlib
 end
-
-# Configure VAGRANT_CWD so that the tests never find an actual
-# Vagrantfile anywhere, or at least this minimizes those chances.
-ENV["VAGRANT_CWD"] = Tempdir.new.path

data/test/unit/config_test.rb

@@ -1,4 +1,4 @@
-require_relative "../unit/base"
+require_relative "base"
 
 require VagrantPlugins::Parallels.source_root.join('lib/vagrant-parallels/config')
 
@@ -7,9 +7,12 @@ describe VagrantPlugins::Parallels::Config do
   context "defaults" do
     before { subject.finalize! }
 
+    its(:check_guest_tools) { should be_true }
+    its(:name) { should be_nil }
+
     it "should have one Shared adapter" do
       expect(subject.network_adapters).to eql({
-        0 => [:shared, []],
+        0 => [:shared, {}],
       })
     end
   end
@@ -27,4 +30,12 @@ describe VagrantPlugins::Parallels::Config do
       expect(subject.customizations).to include(["pre-boot", ["set", :id, "--cpus", 4]])
     end
   end
+
+  describe "#network_adapter" do
+    it "configures additional adapters" do
+      subject.network_adapter(2, :bridged, auto_config: true)
+      expect(subject.network_adapters[2]).to eql(
+        [:bridged, auto_config: true])
+    end
+  end
 end

data/test/unit/driver/pd_8_test.rb

@@ -0,0 +1,196 @@
+require_relative "../base"
+
+describe VagrantPlugins::Parallels::Driver::PD_8 do
+  include_context "parallels"
+  let(:parallels_version) { "8" }
+
+  let(:vm_name) {'VM_Name'}
+
+  let(:tpl_uuid) {'1234-some-template-uuid-5678'}
+  let(:tpl_name) {'Some_Template_Name'}
+
+  let(:hostonly_iface) {'vnic10'}
+
+  let(:vnic_options) do {
+    :name => 'vagrant_vnic6',
+    :adapter_ip => '11.11.11.11',
+    :netmask    => '255.255.252.0',
+    :dhcp => {
+      :ip => '11.11.11.11',
+      :lower => '11.11.8.1',
+      :upper => '11.11.11.254'
+    }
+  } end
+
+  subject { VagrantPlugins::Parallels::Driver::Meta.new(uuid) }
+
+  it_behaves_like "parallels desktop driver"
+
+  before do
+    # Returns short info about all registered VMs
+    # `prlctl list --all --json`
+    subprocess.stub(:execute).
+      with("prlctl", "list", "--all", "--json", kind_of(Hash)) do
+        out = <<-eos
+INFO[
+  {
+    "uuid": "#{uuid}",
+    "status": "stopped",
+    "name": "#{vm_name}"
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+    # Returns short info about all registered templates
+    # `prlctl list --all --json --template`
+    subprocess.stub(:execute).
+      with("prlctl", "list", "--all", "--json", "--template", kind_of(Hash)) do
+        out = <<-eos
+INFO[
+  {
+    "uuid": "1234-some-template-uuid-5678",
+    "name": "Some_Template_Name"
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+
+    # Returns detailed info about specified VM or all registered VMs
+    # `prlctl list <vm_uuid> --info --json`
+    # `prlctl list --all --info --json`
+    subprocess.stub(:execute).
+      with("prlctl", "list", kind_of(String), "--info", "--json",
+           kind_of(Hash)) do
+        out = <<-eos
+INFO[
+  {
+    "ID": "#{uuid}",
+    "Name": "#{vm_name}",
+    "State": "stopped",
+    "Home": "/path/to/#{vm_name}.pvm/",
+    "GuestTools": {
+      "version": "8.0.18615"
+    },
+    "Hardware": {
+      "cpu": {
+        "cpus": 1
+      },
+      "memory": {
+        "size": "512Mb"
+      },
+      "hdd0": {
+        "enabled": true,
+        "image": "/path/to/disk1.hdd"
+      },
+      "net0": {
+        "enabled": true,
+        "type": "shared",
+        "mac": "001C42B4B074",
+        "card": "e1000",
+        "dhcp": "yes"
+      },
+      "net1": {
+        "enabled": true,
+        "type": "bridged",
+        "iface": "vnic2",
+        "mac": "001C42EC0068",
+        "card": "e1000",
+        "ips": "33.33.33.5/255.255.255.0 "
+      }
+    },
+    "Host Shared Folders": {
+      "enabled": true,
+      "shared_folder_1": {
+        "enabled": true,
+        "path": "/path/to/shared/folder/1"
+      },
+      "shared_folder_2": {
+        "enabled": true,
+        "path": "/path/to/shared/folder/2"
+      }
+    }
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+    # Returns detailed info about specified template or all registered templates
+    # `prlctl list <tpl_uuid> --info --json --template`
+    # `prlctl list --all --info --json --template`
+    subprocess.stub(:execute).
+      with("prlctl", "list", kind_of(String), "--info", "--json", "--template",
+           kind_of(Hash)) do
+      out = <<-eos
+INFO[
+  {
+    "ID": "#{tpl_uuid}",
+    "Name": "#{tpl_name}",
+    "State": "stopped",
+    "Home": "/path/to/#{tpl_name}.pvm/",
+    "GuestTools": {
+      "version": "8.0.18615"
+    },
+    "Hardware": {
+      "cpu": {
+        "cpus": 1
+      },
+      "memory": {
+        "size": "512Mb"
+      },
+      "hdd0": {
+        "enabled": true,
+        "image": "/path/to/harddisk.hdd"
+      },
+      "net0": {
+        "enabled": true,
+        "type": "shared",
+        "mac": "001C42F6E500",
+        "card": "e1000",
+        "dhcp": "yes"
+      },
+      "net1": {
+        "enabled": true,
+        "type": "bridged",
+        "iface": "vnic4",
+        "mac": "001C42AB0071",
+        "card": "e1000",
+        "ips": "33.33.33.10/255.255.255.0 "
+      }
+    }
+  }
+]
+      eos
+      subprocess_result(stdout: out)
+    end
+
+    # Returns detailed info about virtual network interface
+    # `prlsrvctl net info <net_name>, '--json', retryable: true)
+    subprocess.stub(:execute).
+      with("prlsrvctl", "net", "info", kind_of(String), "--json",
+           kind_of(Hash)) do
+      out = <<-eos
+{
+  "Network ID": "#{vnic_options[:name]}",
+  "Type": "host-only",
+  "Bound To": "#{hostonly_iface}",
+  "Parallels adapter": {
+    "IP address": "#{vnic_options[:adapter_ip]}",
+    "Subnet mask": "#{vnic_options[:netmask]}"
+  },
+  "DHCPv4 server": {
+    "Server address": "#{vnic_options[:dhcp][:ip] || "10.37.132.1"}",
+    "IP scope start address": "#{vnic_options[:dhcp][:lower] || "10.37.132.1"}",
+    "IP scope end address": "#{vnic_options[:dhcp][:upper] || "10.37.132.254"}"
+  }
+}
+      eos
+      subprocess_result(stdout: out)
+    end
+
+  end
+end

data/test/unit/driver/pd_9_test.rb

@@ -0,0 +1,196 @@
+require_relative "../base"
+
+describe VagrantPlugins::Parallels::Driver::PD_9 do
+  include_context "parallels"
+  let(:parallels_version) { "9" }
+
+  let(:vm_name) {'VM_Name'}
+
+  let(:tpl_uuid) {'1234-some-template-uuid-5678'}
+  let(:tpl_name) {'Some_Template_Name'}
+
+  let(:hostonly_iface) {'vnic10'}
+
+  let(:vnic_options) do {
+    :name => 'vagrant_vnic6',
+    :adapter_ip => '11.11.11.11',
+    :netmask    => '255.255.252.0',
+    :dhcp => {
+      :ip => '11.11.11.11',
+      :lower => '11.11.8.1',
+      :upper => '11.11.11.254'
+    }
+  } end
+
+  subject { VagrantPlugins::Parallels::Driver::Meta.new(uuid) }
+
+  it_behaves_like "parallels desktop driver"
+
+  before do
+    # Returns short info about all registered VMs
+    # `prlctl list --all --json`
+    subprocess.stub(:execute).
+      with("prlctl", "list", "--all", "--json", kind_of(Hash)) do
+        out = <<-eos
+[
+  {
+    "uuid": "#{uuid}",
+    "status": "stopped",
+    "name": "#{vm_name}"
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+    # Returns short info about all registered templates
+    # `prlctl list --all --json --template`
+    subprocess.stub(:execute).
+      with("prlctl", "list", "--all", "--json", "--template", kind_of(Hash)) do
+        out = <<-eos
+[
+  {
+    "uuid": "1234-some-template-uuid-5678",
+    "name": "Some_Template_Name"
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+
+    # Returns detailed info about specified VM or all registered VMs
+    # `prlctl list <vm_uuid> --info --json`
+    # `prlctl list --all --info --json`
+    subprocess.stub(:execute).
+      with("prlctl", "list", kind_of(String), "--info", "--json",
+           kind_of(Hash)) do
+        out = <<-eos
+[
+  {
+    "ID": "#{uuid}",
+    "Name": "#{vm_name}",
+    "State": "stopped",
+    "Home": "/path/to/#{vm_name}.pvm/",
+    "GuestTools": {
+      "version": "9.0.23062"
+    },
+    "Hardware": {
+      "cpu": {
+        "cpus": 1
+      },
+      "memory": {
+        "size": "512Mb"
+      },
+      "hdd0": {
+        "enabled": true,
+        "image": "/path/to/disk1.hdd"
+      },
+      "net0": {
+        "enabled": true,
+        "type": "shared",
+        "mac": "001C42B4B074",
+        "card": "e1000",
+        "dhcp": "yes"
+      },
+      "net1": {
+        "enabled": true,
+        "type": "bridged",
+        "iface": "vnic2",
+        "mac": "001C42EC0068",
+        "card": "e1000",
+        "ips": "33.33.33.5/255.255.255.0 "
+      }
+    },
+    "Host Shared Folders": {
+      "enabled": true,
+      "shared_folder_1": {
+        "enabled": true,
+        "path": "/path/to/shared/folder/1"
+      },
+      "shared_folder_2": {
+        "enabled": true,
+        "path": "/path/to/shared/folder/2"
+      }
+    }
+  }
+]
+        eos
+        subprocess_result(stdout: out)
+    end
+
+    # Returns detailed info about specified template or all registered templates
+    # `prlctl list <tpl_uuid> --info --json --template`
+    # `prlctl list --all --info --json --template`
+    subprocess.stub(:execute).
+      with("prlctl", "list", kind_of(String), "--info", "--json", "--template",
+           kind_of(Hash)) do
+      out = <<-eos
+[
+  {
+    "ID": "#{tpl_uuid}",
+    "Name": "#{tpl_name}",
+    "State": "stopped",
+    "Home": "/path/to/#{tpl_name}.pvm/",
+    "GuestTools": {
+      "version": "9.0.24172"
+    },
+    "Hardware": {
+      "cpu": {
+        "cpus": 1
+      },
+      "memory": {
+        "size": "512Mb"
+      },
+      "hdd0": {
+        "enabled": true,
+        "image": "/path/to/harddisk.hdd"
+      },
+      "net0": {
+        "enabled": true,
+        "type": "shared",
+        "mac": "001C42F6E500",
+        "card": "e1000",
+        "dhcp": "yes"
+      },
+      "net1": {
+        "enabled": true,
+        "type": "bridged",
+        "iface": "vnic4",
+        "mac": "001C42AB0071",
+        "card": "e1000",
+        "ips": "33.33.33.10/255.255.255.0 "
+      }
+    }
+  }
+]
+      eos
+      subprocess_result(stdout: out)
+    end
+
+    # Returns detailed info about virtual network interface
+    # `prlsrvctl net info <net_name>, '--json', retryable: true)
+    subprocess.stub(:execute).
+      with("prlsrvctl", "net", "info", kind_of(String), "--json",
+           kind_of(Hash)) do
+      out = <<-eos
+{
+  "Network ID": "#{vnic_options[:name]}",
+  "Type": "host-only",
+  "Bound To": "#{hostonly_iface}",
+  "Parallels adapter": {
+    "IP address": "#{vnic_options[:adapter_ip]}",
+    "Subnet mask": "#{vnic_options[:netmask]}"
+  },
+  "DHCPv4 server": {
+    "Server address": "#{vnic_options[:dhcp][:ip] || "10.37.132.1"}",
+    "IP scope start address": "#{vnic_options[:dhcp][:lower] || "10.37.132.1"}",
+    "IP scope end address": "#{vnic_options[:dhcp][:upper] || "10.37.132.254"}"
+  }
+}
+      eos
+      subprocess_result(stdout: out)
+    end
+
+  end
+end