vagrant-vmware-desktop 0.0.1 → 3.0.0

data/lib/vagrant-vmware-desktop/action/suspended.rb

@@ -0,0 +1,24 @@
+require "log4r"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is suspended.
+      class Suspended
+        include Common
+
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("hashicorp::provider::vmware::suspended")
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :suspended
+          @logger.debug("result: #{env[:result].inspect}")
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-desktop/action/vmx_modify.rb

@@ -0,0 +1,39 @@
+require "log4r"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      # This class modifies the VMX file according to the advanced
+      # provider configuration.
+      class VMXModify
+        include Common
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("hashicorp::provider::vmware::vmx_modify")
+        end
+
+        def call(env)
+          vmx_changes = env[:machine].provider_config.vmx
+          if vmx_changes.length > 0
+            @logger.info("Modifying VMX file according to user config...")
+            env[:machine].provider.driver.vmx_modify do |vmx|
+              vmx_changes.each do |key, value|
+                if value.nil?
+                  @logger.info("  - Delete: #{key}")
+                  vmx.delete(key)
+                else
+                  @logger.info("  - Set: #{key} = '#{value}'")
+                  vmx[key.to_s.downcase] = value
+                end
+              end
+            end
+          end
+
+          # Carry on
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-desktop/action/wait_for_address.rb

@@ -0,0 +1,31 @@
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      class WaitForAddress
+        include Common
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(
+            I18n.t("hashicorp.vagrant_vmware_desktop.waiting_for_address"))
+          while true
+            # If we're interrupted then just back out
+            return if env[:interrupted]
+
+            # If we have an IP we are don
+            break if env[:machine].provider.driver.read_ip(
+              env[:machine].provider_config.enable_vmrun_ip_lookup
+            )
+
+            sleep 1
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-desktop/action/wait_for_communicator_compat.rb

@@ -0,0 +1,32 @@
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      class WaitForCommunicatorCompat
+        include Common
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(
+            I18n.t("hashicorp.vagrant_vmware_desktop.waiting_for_boot"))
+          while true
+            # If we're interrupted then just back out
+            return if env[:interrupted]
+
+            if env[:machine].communicate.ready?
+              env[:ui].info(I18n.t(
+                "hashicorp.vagrant_vmware_desktop.booted_and_ready"))
+              break
+            end
+
+            sleep 2
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-desktop/action/wait_for_vmx_halt.rb

@@ -0,0 +1,35 @@
+require "log4r"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Action
+      # This waits for the actual "vmx" process to finish running.
+      class WaitForVMXHalt
+        include Common
+
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("hashicorp::provider::vmware::wait_for_vmx_halt")
+        end
+
+        def call(env)
+          @logger.info("Waiting for VMX process to go away...")
+          if env[:machine].provider.driver.vmx_alive?
+            env[:ui].info(I18n.t("hashicorp.vagrant_vmware_desktop.waiting_for_vmx_halt"))
+
+            60.times do |i|
+              if !env[:machine].provider.driver.vmx_alive?
+                @logger.info("VMX process went away!")
+                break
+              end
+
+              sleep 1
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-desktop/cap/disk.rb

@@ -0,0 +1,287 @@
+require "vagrant/util/experimental"
+require "vagrant/util/numeric"
+
+module HashiCorp
+  module VagrantVMwareDesktop
+    module Cap
+      module Disk
+
+        @@logger = Log4r::Logger.new("hashicorp::provider::vmware::cap::disk")
+
+        DEFAULT_DISK_EXT = "vmdk".freeze
+        BUS_TYPES = ["sata", "ide", "scsi"].map(&:freeze).freeze
+        DEFAULT_BUS = "scsi".freeze
+        DEFAULT_DVD_BUS = "ide".freeze
+        DEFAULT_DVD_DEVICE_TYPE = "cdrom-image"
+        # Adapter types (from vmware-vdiskmanager -h)
+        DISK_ADAPTER_TYPES = ["ide", "buslogic", "lsilogic"].map(&:freeze).freeze
+        DEFAULT_ADAPTER_TYPE = "lsilogic".freeze
+        # Disk types (from vmware-vdiskmanager -h)
+        # 0 : single growable virtual disk
+        # 1 : growable virtual disk split into multiple files
+        # 2 : preallocated virtual disk
+        # 3 : preallocated virtual disk split into multiple files
+        # 4 : preallocated ESX-type virtual disk
+        # 5 : compressed disk optimized for streaming
+        # 6 : thin provisioned virtual disk - ESX 3.x and above
+        DEFAULT_DISK_TYPE = 0.freeze
+        PRIMARY_DISK_SLOT = "scsi0:0".freeze
+
+        def self.set_default_disk_ext(machine)
+          DEFAULT_DISK_EXT
+        end
+
+        def self.default_disk_exts(machine)
+          [DEFAULT_DISK_EXT].freeze
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @param [VagrantPlugins::Kernel_V2::VagrantConfigDisk] defined_disks
+        # @return [Hash] configured_disks - A hash of all the current configured disks
+        def self.configure_disks(machine, defined_disks)
+          return {} if defined_disks.empty?
+
+          attached_disks = machine.provider.driver.get_disks(BUS_TYPES)
+          configured_disks = {disk: [], floppy: [], dvd: []}
+
+          defined_disks.each do |disk|
+            case disk.type
+            when :disk
+              disk_data = setup_disk(machine, disk, attached_disks)
+              if !disk_data.empty?
+                configured_disks[:disk] << disk_data
+              end
+            when :floppy
+              # TODO: Write me
+              machine.ui.info(I18n.t("hashicorp.vagrant_vmware_desktop.cap.disks.floppy_not_supported", name: disk.name))
+            when :dvd
+              disk_data = setup_dvd(machine, disk, attached_disks)
+              if !disk_data.empty?
+                configured_disks[:dvd] << disk_data
+              end
+            else
+              @@logger.info("Invalid disk type #{disk.type}, carrying on.")
+            end
+          end
+
+          configured_disks
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @param [VagrantPlugins::Kernel_V2::VagrantConfigDisk] defined_disks
+        # @param [Hash] disk_meta - A hash of all the previously defined disks
+        #                           from the last configure_disk action
+        # @return [nil]
+        def self.cleanup_disks(machine, defined_disks, disk_meta)
+          return if disk_meta.values.flatten.empty?
+
+          ["disk", "dvd"].each do |k|
+            if !disk_meta[k].is_a?(Array)
+              raise TypeError, "Expected `Array` but received `#{disk_meta[k].class}`"
+            end
+          end
+
+          # TODO: floppy
+          disk_meta["disk"].each do |d|
+            # If disk is defined or the primary disk, don't remove
+            if d["primary"]
+              @@logger.warn("Vagrant will not clean up the primary disk! Primary disk no longer tracked in Vagrantfile")
+              next
+            end
+            next if defined_disks.any? { |dsk| dsk.name == d["Name"]}
+            machine.provider.driver.remove_disk(File.basename(d["Path"]))
+          end
+
+          disk_meta["dvd"].each do |d|
+            # If disk is defined, don't remove
+            next if defined_disks.any? { |dsk| dsk.name == d["Name"]}
+            machine.provider.driver.remove_disk_from_vmx(d["Path"], ["deviceType"])
+          end
+          nil
+        end
+
+        protected
+
+        # Retrieves a disk from a Hash of all the disks
+        #
+        # @param [Config::Disk] disk - the current disk to configure
+        # @param [Hash] all_disks - A hash of all currently defined disks
+        # @return [Hash, nil] - A hash of the current disk, nil if not found
+        def self.get_disk(disk, all_disks)
+          if disk.primary
+            return all_disks[PRIMARY_DISK_SLOT]
+          else
+            if disk.type == :dvd
+              all_disks.values.detect { |v| v["filename"] == disk.file }
+            else
+              all_disks.values.detect do |v|
+                m_ext = File.extname(v["filename"])
+                m_fil = v["filename"].sub(/#{Regexp.escape(m_ext)}$/, "")
+                m_ext.sub!(".", "")
+                m_ext == disk.disk_ext &&
+                  (m_fil == disk.name || m_fil =~ /^#{Regexp.escape(disk.name)}-\d+$/)
+              end
+            end
+          end
+        end
+
+        # Sets up all disk configs of type `:disk`
+        #
+        # @param [Vagrant::Machine] machine - the current machine
+        # @param [Config::Disk] disk - the current disk to configure
+        # @param [Array] all_disks - A list of all currently defined disks in VirtualBox
+        # @return [Hash] - disk_metadata
+        def self.setup_disk(machine, disk, attached_disks)
+          current_disk = get_disk(disk, attached_disks)
+
+          if current_disk.nil?
+            disk_path = create_disk(machine, disk, attached_disks)
+          else
+            # If the path matches the disk name + some extra characters then
+            # make sure to remove the extra characters. They may take the form
+            # <name>-f.vmdk, <name>-f<num>.vmdk, <name>-s<num>.vmdk, <name>-s.vmdk, <name>-flat.vmdk, <name>-delta.vmdk
+            # ref: https://github.com/libyal/libvmdk/blob/master/documentation/VMWare%20Virtual%20Disk%20Format%20(VMDK).asciidoc
+            if current_disk["filename"].match(/\w+-(f\d*|s\d*|flat|delta).vmdk/)
+              file_name = current_disk["filename"].gsub(/-(f\d*|s\d*|flat|delta)/, "")
+              disk_path = File.join(File.dirname(machine.provider.driver.vmx_path), file_name)
+            else
+              disk_path = File.join(File.dirname(machine.provider.driver.vmx_path), current_disk["filename"])
+            end
+
+            # disk.size is in bytes
+            if disk.size > machine.provider.driver.get_disk_size(disk_path)
+              grow_disk(machine, disk_path, disk)
+            elsif disk.size < machine.provider.driver.get_disk_size(disk_path)
+              machine.env.ui.warn(I18n.t("hashicorp.vagrant_vmware_desktop.disk_not_shrinking", path: disk.name))
+              @@logger.warn("Not shrinking disk #{disk.name}")
+            else
+              @@logger.info("Not changing #{disk.name}")
+            end
+          end
+          {UUID: disk.id, Name: disk.name, Path: disk_path, primary: !!disk.primary}
+        end
+
+        # Sets up all disk configs of type `:dvd`
+        #
+        # @param [Vagrant::Machine] machine - the current machine
+        # @param [Config::Disk] disk - the current disk to configure
+        # @param [Array] all_disks - A list of all currently defined disks in VirtualBox
+        # @return [Hash] - disk_metadata
+        def self.setup_dvd(machine, disk, attached_disks)
+          disk_provider_config = {}
+          if disk.provider_config && disk.provider_config.key?(:vmware_desktop)
+            disk_provider_config = disk.provider_config[:vmware_desktop]
+            if !BUS_TYPES.include?(disk_provider_config[:bus_type])
+              disk_provider_config[:bus_type] = DEFAULT_DVD_BUS
+              @@logger.warn("#{disk_provider_config[:bus_type]} is not a valid. Should be one of " \
+                "#{BUS_TYPES.join(', ')}! Setting adapter type to #{DEFAULT_DVD_BUS}")
+            end
+          end
+
+          current_disk = get_disk(disk, attached_disks)
+          bus = disk_provider_config.fetch(:bus_type, DEFAULT_DVD_BUS)
+          if current_disk.nil?
+            # Attach dvd if not already attached
+            slot = get_slot(bus, attached_disks)
+            dvd_opts = {"deviceType" => disk_provider_config.fetch(:device_type, DEFAULT_DVD_DEVICE_TYPE)}
+            machine.provider.driver.add_disk_to_vmx(disk.file, slot, dvd_opts)
+            # Add newly attached disk
+            attached_disks[slot] = {"filename" => disk.file}
+          end
+          {UUID: disk.id, Name: disk.name, Path: disk.file, primary: !!disk.primary}
+        end
+
+        # Creates a disk and attaches disk by editing the machine's vmx data
+        #
+        # @param [Vagrant::Machine] machine
+        # @param [Kernel_V2::VagrantConfigDisk] disk_config
+        # @return [String] full path to disk file
+        def self.create_disk(machine, disk_config, attached_disks)
+          if disk_config.file.nil? || !File.exist?(disk_config.file)
+            # Create a new disk if a file is not provided, or that path does not exist
+            disk_filename = "#{disk_config.name}.#{disk_config.disk_ext}"
+            disk_provider_config = {}
+
+            if disk_config.provider_config && disk_config.provider_config.key?(:vmware_desktop)
+              disk_provider_config = disk_config.provider_config[:vmware_desktop]
+              if !DISK_ADAPTER_TYPES.include?(disk_provider_config[:adapter_type])
+                disk_provider_config[:adapter_type] = DEFAULT_ADAPTER_TYPE
+                @@logger.warn("#{disk_provider_config[:adapter_type]} is not a valid. Should be one " \
+                  "of #{DISK_ADAPTER_TYPES.join(', ')}! Setting adapter type to #{DEFAULT_ADAPTER_TYPE}")
+              end
+              if !BUS_TYPES.include?(disk_provider_config[:bus_type])
+                disk_provider_config[:bus_type] = DEFAULT_BUS
+                @@logger.warn("#{disk_provider_config[:bus_type]} is not a valid. Should be one of " \
+                  "#{BUS_TYPES.join(', ')}! Setting adapter type to #{DEFAULT_BUS}")
+              end
+            end
+            disk_type = DEFAULT_DISK_TYPE
+            disk_adapter = disk_provider_config.fetch(:adapter_type, DEFAULT_ADAPTER_TYPE)
+            bus = disk_provider_config.fetch(:bus_type,  DEFAULT_BUS)
+            disk_path = machine.provider.driver.create_disk(disk_filename, disk_config.size, disk_type, disk_adapter)
+          else
+            # Don't create a new disk if one is provided by `file` config argument
+            disk_path = disk_config.file
+          end
+
+          slot = get_slot(bus, attached_disks)
+          machine.provider.driver.add_disk_to_vmx(File.basename(disk_path), slot)
+          # Add newly attached disk
+          attached_disks[slot] = { "filename" => disk_filename }
+          disk_path
+        end
+
+        # Expand an existing disk
+        #
+        # @param [Vagrant::Machine] machine
+        # @param [String] disk_path Path to disk for expansion
+        # @param [VagrantPlugins::Kernel_V2::VagrantConfigDisk] disk_config
+        # @return [nil]
+        def self.grow_disk(machine, disk_path, disk_config)
+          if machine.provider.driver.snapshot_list.empty?
+            machine.provider.driver.grow_disk(disk_path, disk_config.size)
+          else
+            raise Errors::DiskNotResizedSnapshot, path: disk_path
+          end
+          nil
+        end
+
+        # Gets the next slot available
+        #
+        # @param [String] bus name, one of BUS_TYPES
+        # @param [Hash] attached disks
+        def self.get_slot(bus, attached_disks)
+          bus_num = 0
+          slot_num = 0
+          attached_disks.keys.each do |k|
+           s = k.match(/(?<=#{bus})(\d+:\d+)/)
+           if !s.nil?
+            bus_and_slot = s[0].split(":")
+            if bus_and_slot[0].to_i > bus_num
+              bus_num = bus_and_slot[0].to_i
+              # reset slot num
+              slot_num = 0
+            end
+            if bus_and_slot[1].to_i > slot_num
+              slot_num = bus_and_slot[1].to_i
+            end
+           end
+          end
+
+          # For ide bus the slot number must be 0 or 1
+          if bus.to_s == "ide"
+            bus_num = bus_num + (slot_num%2)
+            slot_num = (slot_num+1)%2
+            if bus_num > 1
+              @@logger.warn("attaching disk to #{bus}#{bus_num}:#{slot_num}, this will " \
+                "likely cause the disk to be unavailable, consider attaching the disk to a different bus")
+            end
+          else
+            slot_num = slot_num + 1
+          end
+          "#{bus}#{bus_num}:#{slot_num}"
+        end
+      end
+    end
+  end
+end