vagrant-parallels 0.0.9 → 0.1.0

data/README.md

@@ -12,18 +12,23 @@ Almost all features are available except for exporting/packaging VM's.  This wil
 
 We look forward to hearing from you with any issues or features.  Thank you!
 
+## Installation
+The latest version of this provider is supporting **only Vagrant 1.4 or higher**.
+If you are still using Vagrant 1.3.*, please, specify the plugin version '0.0.9':
+
+- For Vagrant 1.4 or higher execute `vagrant plugin install vagrant-parallels`.
+- For Vagrant 1.3.x execute `vagrant plugin install vagrant-parallels --plugin-version 0.0.9`.
+
 ## Usage
-Install using standard Vagrant 1.1+ plugin installation methods. After installing, then do a `vagrant up` and specify the `parallels` provider. An example is shown below.
+After installing, then do a `vagrant up` and specify the `parallels` provider. An example is shown below.
 
 ```
-$ vagrant plugin install vagrant-parallels
-...
 $ vagrant init
 $ vagrant up --provider=parallels
 ...
 ```
 
-You need to have a parallels compatible box file installed before doing a `vagrant up`, please refer to the coming section for instructions.
+You need to have a parallels compatible box specified in your `Vagrantfile` before doing a `vagrant up`, please refer to the coming section for instructions.
 
 ### Default Provider
 

data/lib/vagrant-parallels/action.rb

@@ -12,17 +12,14 @@ module VagrantPlugins
       def self.action_boot
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckAccessible
-          # b.use CleanMachineFolder
           # b.use ClearForwardedPorts
           b.use Provision
           b.use EnvSet, :port_collision_repair => true
           # b.use PrepareForwardedPortCollisionParams
           # b.use HandleForwardedPortCollisions
-          b.use PruneNFSExports
-          b.use NFS
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
           b.use PrepareNFSSettings
-          b.use ClearSharedFolders
-          b.use ShareFolders
           b.use Network
           b.use ClearNetworkInterfaces
           # b.use ForwardPorts
@@ -295,11 +292,9 @@ module VagrantPlugins
       autoload :Package, File.expand_path("../action/package", __FILE__)
       autoload :PackageConfigFiles, File.expand_path("../action/package_config_files", __FILE__)
       autoload :PrepareNFSSettings, File.expand_path("../action/prepare_nfs_settings", __FILE__)
-      autoload :PruneNFSExports, File.expand_path("../action/prune_nfs_exports", __FILE__)
       autoload :RegisterTemplate, File.expand_path("../action/register_template", __FILE__)
       autoload :Resume, File.expand_path("../action/resume", __FILE__)
       autoload :SetupPackageFiles, File.expand_path("../action/setup_package_files", __FILE__)
-      autoload :ShareFolders, File.expand_path("../action/share_folders", __FILE__)
       autoload :Suspend, File.expand_path("../action/suspend", __FILE__)
       autoload :UnregisterTemplate, File.expand_path("../action/unregister_template", __FILE__)
 

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

@@ -11,12 +11,11 @@ module VagrantPlugins
           if !tools_version
             env[:ui].warn I18n.t("vagrant.actions.vm.check_guest_tools.not_detected")
           else
-            env[:machine].provider.driver.verify! =~ /^[\w\s]+ ([\d.]+)$/
-            os_version = $1
-            unless os_version.start_with? tools_version
+            pd_version = env[:machine].provider.driver.version
+            unless pd_version.start_with? tools_version
               env[:ui].warn(I18n.t("vagrant_parallels.actions.vm.check_guest_tools.version_mismatch",
                                    tools_version: tools_version,
-                                   parallels_version: os_version))
+                                   parallels_version: pd_version))
             end
           end
 

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

@@ -8,35 +8,48 @@ module VagrantPlugins
         end
 
         def call(env)
+          @machine = env[:machine]
           @app.call(env)
 
-          using_nfs = false
-          env[:machine].config.vm.synced_folders.each do |id, opts|
-            if opts[:nfs]
-              using_nfs = true
-              break
-            end
+          if using_nfs?
+            @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
+            add_nfs_settings_to_env!(env)
           end
+        end
 
-          if using_nfs
-            @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
-            env[:nfs_host_ip]    = read_host_ip(env[:machine])
-            env[:nfs_machine_ip] = read_machine_ip(env[:machine])
+        # We're using NFS if we have any synced folder with NFS configured. If
+        # we are not using NFS we don't need to do the extra work to
+        # populate these fields in the environment.
+        def using_nfs?
+          @machine.config.vm.synced_folders.any? { |_, opts| opts[:type] == :nfs }
+        end
 
-            raise Vagrant::Errors::NFSNoHostonlyNetwork if !env[:nfs_machine_ip]
-          end
+        # Extracts the proper host and guest IPs for NFS mounts and stores them
+        # in the environment for the SyncedFolder action to use them in
+        # mounting.
+        #
+        # The ! indicates that this method modifies its argument.
+        def add_nfs_settings_to_env!(env)
+          adapter, host_ip = find_host_only_adapter
+          machine_ip       = nil
+          machine_ip       = read_machine_ip if adapter
+
+          raise Vagrant::Errors::NFSNoHostonlyNetwork if !host_ip || !machine_ip
+
+          env[:nfs_host_ip]    = host_ip
+          env[:nfs_machine_ip] = machine_ip
         end
 
-        # Returns the IP address of the first host only network adapter
+        # Finds first host only network adapter and returns its adapter number
+        # and IP address
         #
-        # @param [Machine] machine
-        # @return [String]
-        def read_host_ip(machine)
-          machine.provider.driver.read_network_interfaces.each do |adapter, opts|
+        # @return [Integer, String] adapter number, ip address of found host-only adapter
+        def find_host_only_adapter
+          @machine.provider.driver.read_network_interfaces.each do |adapter, opts|
             if opts[:type] == :hostonly
-              machine.provider.driver.read_host_only_interfaces.each do |interface|
+              @machine.provider.driver.read_host_only_interfaces.each do |interface|
                 if interface[:bound_to] == opts[:hostonly]
-                  return interface[:ip]
+                  return adapter, interface[:ip]
                 end
               end
             end
@@ -48,17 +61,17 @@ module VagrantPlugins
         # Returns the IP address of the guest by looking at the first
         # enabled host only network.
         #
-        # @return [String]
-        def read_machine_ip(machine)
+        # @return [String] ip address of adapter in guest
+        def read_machine_ip
           ips = []
-          machine.config.vm.networks.each do |type, options|
+          @machine.config.vm.networks.each do |type, options|
             if type == :private_network && options[:ip].is_a?(String)
               ips << options[:ip]
             end
           end
 
           if ips.empty?
-            return nil
+            raise Vagrant::Errors::NFSNoGuestIP
           end
 
           ips

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

@@ -411,13 +411,15 @@ module VagrantPlugins
         #
         # This should raise a VagrantError if things are not ready.
         def verify!
-          # TODO: Use version method?
-          execute('--version')
+          version
         end
 
         def version
-          raw_version = execute('--version', retryable: true)
-          raw_version.gsub('/prlctl version /', '')
+          if execute('--version', retryable: true) =~ /prlctl version ([\d\.]+)/
+            $1.downcase
+          else
+            raise VagrantPlugins::Parallels::Errors::ParallelsInstallIncomplete
+          end
         end
 
         private

data/lib/vagrant-parallels/errors.rb

@@ -19,6 +19,10 @@ module VagrantPlugins
         error_key(:parallels_kernel_module_not_loaded)
       end
 
+      class ParallelsInstallIncomplete < VagrantParallelsError
+        error_key(:parallels_install_incomplete)
+      end
+
       class ParallelsNoRoomForHighLevelNetwork < VagrantParallelsError
         error_key(:parallels_no_room_for_high_level_network)
       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.2.0"
-  raise "The Vagrant Parallels plugin is only compatible with Vagrant 1.2+"
+if Vagrant::VERSION < "1.4.0"
+  raise "The Vagrant Parallels plugin is only compatible with Vagrant 1.4+"
 end
 
 module VagrantPlugins
@@ -40,6 +40,11 @@ module VagrantPlugins
         GuestLinuxCap::MountParallelsSharedFolder
       end
 
+      synced_folder(:parallels) do
+        require File.expand_path("../synced_folder", __FILE__)
+        SyncedFolder
+      end
+
     end
 
     module Driver

data/lib/vagrant-parallels/synced_folder.rb

@@ -0,0 +1,79 @@
+require "vagrant/util/platform"
+
+module VagrantPlugins
+  module Parallels
+    class SyncedFolder < Vagrant.plugin("2", :synced_folder)
+      def usable?(machine)
+        # These synced folders only work if the provider if VirtualBox
+        machine.provider_name == :parallels
+      end
+
+      def prepare(machine, folders, _opts)
+        defs = []
+        folders.each do |id, data|
+          hostpath = Vagrant::Util::Platform.cygwin_windows_path(data[:hostpath])
+
+          defs << {
+              # Escape special symbols (Parallels Shared Folders specific)
+              name: id.split('/').delete_if{|i| i.empty?}.join('_'),
+              hostpath: hostpath.to_s,
+              transient: data[:transient],
+          }
+        end
+
+        driver(machine).share_folders(defs)
+      end
+
+      def enable(machine, folders, _opts)
+        # short guestpaths first, so we don't step on ourselves
+        folders = folders.sort_by do |id, data|
+          if data[:guestpath]
+            data[:guestpath].length
+          else
+            # A long enough path to just do this at the end.
+            10000
+          end
+        end
+
+        # Go through each folder and mount
+        machine.ui.info(I18n.t("vagrant.actions.vm.share_folders.mounting"))
+        folders.each do |id, data|
+          if data[:guestpath]
+            data[:guestpath] = data[:guestpath]
+
+            # Guest path specified, so mount the folder to specified point
+            machine.ui.info(I18n.t("vagrant.actions.vm.share_folders.mounting_entry",
+                                   :guest_path => data[:guestpath]))
+
+            # Dup the data so we can pass it to the guest API
+            data = data.dup
+
+            # Calculate the owner and group
+            ssh_info = machine.ssh_info
+            data[:owner] ||= ssh_info[:username]
+            data[:group] ||= ssh_info[:username]
+
+            # Mount the actual folder
+            machine.guest.capability(
+                :mount_parallels_shared_folder, id, data[:guestpath], data)
+          else
+            # If no guest path is specified, then automounting is disabled
+            machine.ui.info(I18n.t("vagrant.actions.vm.share_folders.nomount_entry",
+                                   :host_path => data[:hostpath]))
+          end
+        end
+      end
+
+      def cleanup(machine, opts)
+        driver(machine).clear_shared_folders if machine.id && machine.id != ""
+      end
+
+      protected
+
+      # 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/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Parallels
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 end

data/locales/en.yml

@@ -538,10 +538,9 @@ en:
         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.
-      virtualbox_install_incomplete: |-
-        Parallels Desktop is complaining that the installation is incomplete. Please
-        run `prlctl --version` 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_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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-parallels
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -127,11 +127,9 @@ files:
 - lib/vagrant-parallels/action/package.rb
 - lib/vagrant-parallels/action/package_config_files.rb
 - lib/vagrant-parallels/action/prepare_nfs_settings.rb
-- lib/vagrant-parallels/action/prune_nfs_exports.rb
 - lib/vagrant-parallels/action/register_template.rb
 - lib/vagrant-parallels/action/resume.rb
 - lib/vagrant-parallels/action/setup_package_files.rb
-- lib/vagrant-parallels/action/share_folders.rb
 - lib/vagrant-parallels/action/suspend.rb
 - lib/vagrant-parallels/action/unregister_template.rb
 - lib/vagrant-parallels/action.rb
@@ -142,6 +140,7 @@ files:
 - lib/vagrant-parallels/guest_cap/linux/mount_parallels_shared_folder.rb
 - lib/vagrant-parallels/plugin.rb
 - lib/vagrant-parallels/provider.rb
+- lib/vagrant-parallels/synced_folder.rb
 - lib/vagrant-parallels/version.rb
 - lib/vagrant-parallels.rb
 - LICENSE.txt
@@ -168,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -608531981673184362
+      hash: 646482643972557885
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

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

@@ -1,20 +0,0 @@
-module VagrantPlugins
-  module Parallels
-    module Action
-      class PruneNFSExports
-        def initialize(app, env)
-          @app = app
-        end
-
-        def call(env)
-          if env[:host]
-            vms = env[:machine].provider.driver.read_all_names
-            env[:host].nfs_prune(vms.values)
-          end
-
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

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

@@ -1,130 +0,0 @@
-require "pathname"
-
-require "log4r"
-
-require "vagrant/util/platform"
-require "vagrant/util/scoped_hash_override"
-
-module VagrantPlugins
-  module Parallels
-    module Action
-      class ShareFolders
-        include Vagrant::Util::ScopedHashOverride
-
-        def initialize(app, env)
-          @logger = Log4r::Logger.new("vagrant::action::vm::share_folders")
-          @app    = app
-        end
-
-        def call(env)
-          @env = env
-
-          prepare_folders
-          create_metadata
-
-          @app.call(env)
-
-          mount_shared_folders
-        end
-
-        # This method returns an actual list of Parallels Desktop
-        # shared folders to create and their proper path.
-        def shared_folders
-          {}.tap do |result|
-            @env[:machine].config.vm.synced_folders.each do |id, data|
-              data = scoped_hash_override(data, :parallels)
-
-              # Ignore NFS shared folders
-              next if data[:nfs]
-
-              # Ignore disabled shared folders
-              next if data[:disabled]
-
-              # This to prevent overwriting the actual shared folders data
-              id = Pathname.new(id).to_s.split('/').drop_while{|i| i.empty?}.join('_')
-              result[id] = data.dup
-            end
-          end
-        end
-
-        # Prepares the shared folders by verifying they exist and creating them
-        # if they don't.
-        def prepare_folders
-          shared_folders.each do |id, options|
-            hostpath = Pathname.new(options[:hostpath]).expand_path(@env[:root_path])
-
-            if !hostpath.directory? && options[:create]
-              # Host path doesn't exist, so let's create it.
-              @logger.debug("Host path doesn't exist, creating: #{hostpath}")
-
-              begin
-                hostpath.mkpath
-              rescue Errno::EACCES
-                raise Vagrant::Errors::SharedFolderCreateFailed,
-                  :path => hostpath.to_s
-              end
-            end
-          end
-        end
-
-        def create_metadata
-          @env[:ui].info I18n.t("vagrant.actions.vm.share_folders.creating")
-
-          folders = []
-          shared_folders.each do |id, data|
-            hostpath = File.expand_path(data[:hostpath], @env[:root_path])
-            hostpath = Vagrant::Util::Platform.cygwin_windows_path(hostpath)
-
-            folders << {
-              :name => id,
-              :hostpath => hostpath,
-              :transient => data[:transient]
-            }
-          end
-
-          @env[:machine].provider.driver.share_folders(folders)
-        end
-
-        # TODO: Fix this, doesn't execute at the correct time
-        def mount_shared_folders
-          @env[:ui].info I18n.t("vagrant.actions.vm.share_folders.mounting")
-
-          # short guestpaths first, so we don't step on ourselves
-          folders = shared_folders.sort_by do |id, data|
-            if data[:guestpath]
-              data[:guestpath].length
-            else
-              # A long enough path to just do this at the end.
-              10000
-            end
-          end
-
-          # Go through each folder and mount
-          folders.each do |id, data|
-            if data[:guestpath]
-              # Guest path specified, so mount the folder to specified point
-              @env[:ui].info(I18n.t("vagrant.actions.vm.share_folders.mounting_entry",
-                                    :guest_path => data[:guestpath]))
-
-              # Dup the data so we can pass it to the guest API
-              data = data.dup
-
-              # Calculate the owner and group
-              ssh_info = @env[:machine].ssh_info
-              data[:owner] ||= ssh_info[:username]
-              data[:group] ||= ssh_info[:username]
-
-              # Mount the actual folder
-              @env[:machine].guest.capability(
-                :mount_parallels_shared_folder, id, data[:guestpath], data)
-            else
-              # If no guest path is specified, then automounting is disabled
-              @env[:ui].info(I18n.t("vagrant.actions.vm.share_folders.nomount_entry",
-                                    :host_path => data[:hostpath]))
-            end
-          end
-        end
-      end
-    end
-  end
-end