vagrant-unbundled 2.2.6.2 → 2.2.14.0

data/plugins/providers/virtualbox/cap/validate_disk_ext.rb

@@ -0,0 +1,34 @@
+require "log4r"
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Cap
+      module ValidateDiskExt
+        LOGGER = Log4r::Logger.new("vagrant::plugins::virtualbox::validate_disk_ext")
+
+        # The default set of disk formats that VirtualBox supports
+        DEFAULT_DISK_EXT_LIST = ["vdi", "vmdk", "vhd"].map(&:freeze).freeze
+        DEFAULT_DISK_EXT = "vdi".freeze
+
+        # @param [Vagrant::Machine] machine
+        # @param [String] disk_ext
+        # @return [Bool]
+        def self.validate_disk_ext(machine, disk_ext)
+          DEFAULT_DISK_EXT_LIST.include?(disk_ext)
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @return [Array]
+        def self.default_disk_exts(machine)
+          DEFAULT_DISK_EXT_LIST
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @return [String]
+        def self.set_default_disk_ext(machine)
+          DEFAULT_DISK_EXT
+        end
+      end
+    end
+  end
+end

data/plugins/providers/virtualbox/driver/base.rb

@@ -368,6 +368,21 @@ module VagrantPlugins
         def vm_exists?(uuid)
         end
 
+        # Returns a hash of information about a given virtual machine
+        #
+        # @param [String] uuid
+        # @return [Hash] info
+        def show_vm_info
+          info = {}
+          execute('showvminfo', @uuid, '--machinereadable', retryable: true).split("\n").each do |line|
+            parts = line.partition('=')
+            key = parts.first.gsub('"', '')
+            value = parts.last.gsub('"', '')
+            info[key] = value
+          end
+          info
+        end
+
         # Execute the given subcommand for VBoxManage and return the output.
         def execute(*command, &block)
           # Get the options hash if it exists

data/plugins/providers/virtualbox/driver/meta.rb

@@ -64,6 +64,7 @@ module VagrantPlugins
             "5.1" => Version_5_1,
             "5.2" => Version_5_2,
             "6.0" => Version_6_0,
+            "6.1" => Version_6_1,
           }
 
           if @@version.start_with?("4.2.14")
@@ -96,10 +97,15 @@ module VagrantPlugins
           end
         end
 
-        def_delegators :@driver, :clear_forwarded_ports,
+        def_delegators :@driver,
+          :attach_disk,
+          :clear_forwarded_ports,
           :clear_shared_folders,
+          :clone_disk,
           :clonevm,
+          :close_medium,
           :create_dhcp_server,
+          :create_disk,
           :create_host_only_network,
           :create_snapshot,
           :delete,
@@ -110,9 +116,12 @@ module VagrantPlugins
           :execute_command,
           :export,
           :forward_ports,
+          :get_port_and_device,
+          :get_storage_controller,
           :halt,
           :import,
           :list_snapshots,
+          :list_hdds,
           :read_forwarded_ports,
           :read_bridged_interfaces,
           :read_dhcp_servers,
@@ -125,21 +134,27 @@ module VagrantPlugins
           :read_machine_folder,
           :read_network_interfaces,
           :read_state,
+          :read_storage_controllers,
           :read_used_ports,
           :read_vms,
           :reconfig_host_only,
           :remove_dhcp_server,
+          :remove_disk,
+          :resize_disk,
           :restore_snapshot,
           :resume,
           :set_mac_address,
           :set_name,
           :share_folders,
+          :show_medium_info,
           :ssh_port,
           :start,
           :suspend,
+          :vdi_to_vmdk,
           :verify!,
           :verify_image,
-          :vm_exists?
+          :vm_exists?,
+          :vmdk_to_vdi
 
         protected
 

data/plugins/providers/virtualbox/driver/version_5_0.rb

@@ -16,6 +16,30 @@ module VagrantPlugins
           @uuid = uuid
         end
 
+        # Controller-Port-Device looks like:
+        # SATA Controller-ImageUUID-0-0 (sub out ImageUUID)
+        # - Controller: SATA Controller
+        # - Port: 0
+        # - Device: 0
+        #
+        # @param [String] controller_name - name of storage controller to attach disk to
+        # @param [String] port - port on device to attach disk to
+        # @param [String] device - device on controller for disk
+        # @param [String] type - type of disk to attach
+        # @param [String] file - disk file path
+        # @param [Hash]   opts -  additional options
+        def attach_disk(controller_name, port, device, type, file, **opts)
+          comment = "This disk is managed externally by Vagrant. Removing or adjusting settings could potentially cause issues with Vagrant."
+
+          execute('storageattach', @uuid,
+                  '--storagectl', controller_name,
+                  '--port', port.to_s,
+                  '--device', device.to_s,
+                  '--type', type,
+                  '--medium', file,
+                  '--comment', comment)
+        end
+
         def clear_forwarded_ports
           retryable(on: Vagrant::Errors::VBoxManageError, tries: 3, sleep: 1) do
             args = []
@@ -38,6 +62,13 @@ module VagrantPlugins
           end
         end
 
+        # @param [String] source
+        # @param [String] destination
+        # @param [String] disk_format
+        def clone_disk(source, destination, disk_format, **opts)
+          execute("clonemedium", source, destination, '--format', disk_format)
+        end
+
         def clonevm(master_id, snapshot_name)
           machine_name = "temp_clone_#{(Time.now.to_f * 1000.0).to_i}_#{rand(100000)}"
           args = ["--register", "--name", machine_name]
@@ -49,6 +80,14 @@ module VagrantPlugins
           return get_machine_id(machine_name)
         end
 
+        # Removes a disk from the given virtual machine
+        #
+        # @param [String] disk_uuid or file path
+        # @param [Hash]   opts -  additional options
+        def close_medium(disk_uuid)
+          execute("closemedium", disk_uuid, '--delete')
+        end
+
         def create_dhcp_server(network, options)
           retryable(on: Vagrant::Errors::VBoxManageError, tries: 3, sleep: 1) do
             begin
@@ -65,6 +104,17 @@ module VagrantPlugins
           end
         end
 
+       # Creates a disk. Default format is VDI unless overridden
+       #
+       # @param [String] disk_file
+       # @param [Integer] disk_size - size in bytes
+       # @param [String] disk_format - format of disk, defaults to "VDI"
+        # @param [Hash]  opts -  additional options
+       def create_disk(disk_file, disk_size, disk_format="VDI", **opts)
+         execute("createmedium", '--filename', disk_file, '--sizebyte', disk_size.to_i.to_s, '--format', disk_format)
+       end
+
+
         def create_host_only_network(options)
           # Create the interface
           execute("hostonlyif", "create", retryable: true) =~ /^Interface '(.+?)' was successfully created$/
@@ -130,6 +180,33 @@ module VagrantPlugins
           end
         end
 
+        # Lists all attached harddisks from a given virtual machine. Additionally,
+        # this method adds a new key "Disk Name" based on the disks file path from "Location"
+        #
+        # @return [Array] hdds An array of hashes of harddrive info for a guest
+        def list_hdds
+          hdds = []
+          tmp_drive = {}
+          execute('list', 'hdds', retryable: true).split("\n").each do |line|
+            if line == "" # separator between disks
+              hdds << tmp_drive
+              tmp_drive = {}
+              next
+            end
+            parts = line.partition(":")
+            key = parts.first.strip
+            value = parts.last.strip
+            tmp_drive[key] = value
+
+            if key == "Location"
+              tmp_drive["Disk Name"] = File.basename(value, ".*")
+            end
+          end
+          hdds << tmp_drive unless tmp_drive.empty?
+
+          hdds
+        end
+
         def list_snapshots(machine_id)
           output = execute(
             "snapshot", machine_id, "list", "--machinereadable",
@@ -149,6 +226,24 @@ module VagrantPlugins
           raise
         end
 
+        # @param [String] controller_name - controller name to remove disk from
+        # @param [String] port - port on device to attach disk to
+        # @param [String] device - device on controller for disk
+        def remove_disk(controller_name, port, device)
+          execute('storageattach', @uuid,
+                  '--storagectl', controller_name,
+                  '--port', port.to_s,
+                  '--device', device.to_s,
+                  '--medium', "none")
+        end
+
+        # @param [String] disk_file
+        # @param [Integer] disk_size in bytes
+        # @param [Hash]   opts -  additional options
+        def resize_disk(disk_file, disk_size, **opts)
+          execute("modifymedium", disk_file, '--resizebyte', disk_size.to_i.to_s)
+        end
+
         def restore_snapshot(machine_id, snapshot_name)
           # Start with 0%
           last = 0
@@ -295,6 +390,28 @@ module VagrantPlugins
           nil
         end
 
+        # Returns port and device for an attached disk given a disk uuid. Returns
+        # empty hash if disk is not attachd to guest
+        #
+        # @param [String] disk_uuid - the UUID for the disk we are searching for
+        # @return [Hash] disk_info - Contains a device and port number
+        def get_port_and_device(disk_uuid)
+          disk = {}
+
+          storage_controllers = read_storage_controllers
+          storage_controllers.each do |controller|
+            controller.attachments.each do |attachment|
+              if disk_uuid == attachment[:uuid]
+                disk[:port] = attachment[:port]
+                disk[:device] = attachment[:device]
+                return disk
+              end
+            end
+          end
+
+          return disk
+        end
+
         def halt
           execute("controlvm", @uuid, "poweroff", retryable: true)
         end
@@ -370,7 +487,7 @@ module VagrantPlugins
             end
           end
 
-          return get_machine_id specified_name
+          return get_machine_id(specified_name)
         end
 
         def max_network_adapters
@@ -476,6 +593,11 @@ module VagrantPlugins
 
         def read_guest_ip(adapter_number)
           ip = read_guest_property("/VirtualBox/GuestInfo/Net/#{adapter_number}/V4/IP")
+          if ip.end_with?(".1")
+            @logger.warn("VBoxManage guest property returned: #{ip}. Result resembles IP of DHCP server and is being ignored.")
+            ip = nil
+          end
+
           if !valid_ip_address?(ip)
             raise Vagrant::Errors::VirtualBoxGuestPropertyNotFound,
               guest_property: "/VirtualBox/GuestInfo/Net/#{adapter_number}/V4/IP"
@@ -686,6 +808,26 @@ module VagrantPlugins
           end
         end
 
+        # Returns information for a given disk
+        #
+        # @param [String] disk_type - can be "disk", "dvd", or "floppy"
+        # @param [String] disk_uuid_or_file
+        # @return [Hash] disk
+        def show_medium_info(disk_type, disk_uuid_or_file)
+          disk = {}
+          execute('showmediuminfo', disk_type, disk_uuid_or_file, retryable: true).split("\n").each do |line|
+            parts = line.partition(":")
+            key = parts.first.strip
+            value = parts.last.strip
+            disk[key] = value
+
+            if key == "Location"
+              disk["Disk Name"] = File.basename(value, ".*")
+            end
+          end
+          disk
+        end
+
         def ssh_port(expected_port)
           @logger.debug("Searching for SSH port: #{expected_port.inspect}")
 
@@ -783,12 +925,85 @@ module VagrantPlugins
           return true
         end
 
+        # @param [VagrantPlugins::VirtualboxProvider::Driver] driver
+        # @param [String] defined_disk_path
+        # @return [String] destination - The cloned disk
+        def vmdk_to_vdi(defined_disk_path)
+          source = defined_disk_path
+          destination = File.join(File.dirname(source), File.basename(source, ".*")) + ".vdi"
+
+          clone_disk(source, destination, 'VDI')
+
+          destination
+        end
+
+        # @param [VagrantPlugins::VirtualboxProvider::Driver] driver
+        # @param [String] defined_disk_path
+        # @return [String] destination - The cloned disk
+        def vdi_to_vmdk(defined_disk_path)
+          source = defined_disk_path
+          destination = File.join(File.dirname(source), File.basename(source, ".*")) + ".vmdk"
+
+          clone_disk(source, destination, 'VMDK')
+
+          destination
+        end
+
+        # Helper method to get a list of storage controllers added to the
+        # current VM
+        #
+        # @return [VagrantPlugins::ProviderVirtualBox::Model::StorageControllerArray]
+        def read_storage_controllers
+          vm_info = show_vm_info
+          count = vm_info.count { |key, value| key.match(/^storagecontrollername\d+$/) }
+          all_disks = list_hdds
+
+          storage_controllers = Model::StorageControllerArray.new
+
+          (0..count - 1).each do |n|
+            # basic controller metadata
+            name = vm_info["storagecontrollername#{n}"]
+            type = vm_info["storagecontrollertype#{n}"]
+            maxportcount = vm_info["storagecontrollermaxportcount#{n}"].to_i
+
+            # build attachments array
+            attachments = []
+            vm_info.each do |k, v|
+              if /^#{name}-ImageUUID-(\d+)-(\d+)$/ =~ k
+                port = $1.to_s
+                device = $2.to_s
+                uuid = v
+                location = vm_info["#{name}-#{port}-#{device}"]
+
+                extra_disk_data = all_disks.detect { |d| d["UUID"] == uuid }
+
+                attachment = { port: port,
+                               device: device,
+                               uuid: uuid,
+                               location: location }
+
+                extra_disk_data&.each do |dk,dv|
+                  # NOTE: We convert the keys from VirtualBox to symbols
+                  # to be consistent with the other keys
+                  attachment[dk.downcase.gsub(' ', '_').to_sym] = dv
+                end
+
+                attachments << attachment
+              end
+            end
+
+            storage_controllers << Model::StorageController.new(name, type, maxportcount, attachments)
+          end
+
+          storage_controllers
+        end
+
         protected
 
         def valid_ip_address?(ip)
           # Filter out invalid IP addresses
           # GH-4658 VirtualBox can report an IP address of 0.0.0.0 for FreeBSD guests.
-          if ip == "0.0.0.0"
+          if ip == "0.0.0.0" || ip.nil?
             return false
           else
             return true

data/plugins/providers/virtualbox/driver/version_6_1.rb

@@ -0,0 +1,39 @@
+require File.expand_path("../version_6_0", __FILE__)
+
+module VagrantPlugins
+  module ProviderVirtualBox
+    module Driver
+      # Driver for VirtualBox 6.1.x
+      class Version_6_1 < Version_6_0
+        def initialize(uuid)
+          super
+
+          @logger = Log4r::Logger.new("vagrant::provider::virtualbox_6_1")
+        end
+
+        def read_dhcp_servers
+          execute("list", "dhcpservers", retryable: true).split("\n\n").collect do |block|
+            info = {}
+
+            block.split("\n").each do |line|
+              if network = line[/^NetworkName:\s+HostInterfaceNetworking-(.+?)$/, 1]
+                info[:network]      = network
+                info[:network_name] = "HostInterfaceNetworking-#{network}"
+              elsif ip = line[/^Dhcpd IP:\s+(.+?)$/, 1]
+                info[:ip] = ip
+              elsif netmask = line[/^NetworkMask:\s+(.+?)$/, 1]
+                info[:netmask] = netmask
+              elsif lower = line[/^LowerIPAddress:\s+(.+?)$/, 1]
+                info[:lower] = lower
+              elsif upper = line[/^UpperIPAddress:\s+(.+?)$/, 1]
+                info[:upper] = upper
+              end
+            end
+
+            info
+          end
+        end
+      end
+    end
+  end
+end