vagrant 1.5.0 → 2.4.4

data/plugins/providers/hyperv/provider.rb

@@ -0,0 +1,116 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "log4r"
+
+require_relative "driver"
+require_relative "plugin"
+
+require "vagrant/util/platform"
+require "vagrant/util/powershell"
+
+module VagrantPlugins
+  module HyperV
+    class Provider < Vagrant.plugin("2", :provider)
+      attr_reader :driver
+
+      def self.usable?(raise_error=false)
+        if !Vagrant::Util::Platform.windows? &&
+            !Vagrant::Util::Platform.wsl?
+          raise Errors::WindowsRequired
+        end
+
+        if !Vagrant::Util::Platform.windows_admin? &&
+           !Vagrant::Util::Platform.windows_hyperv_admin?
+            raise Errors::AdminRequired
+        end
+
+        if !Vagrant::Util::PowerShell.available?
+          raise Errors::PowerShellRequired
+        end
+
+        true
+      rescue Errors::HyperVError
+        raise if raise_error
+        return false
+      end
+
+      def initialize(machine)
+        @machine = machine
+
+        # This method will load in our driver, so we call it now to
+        # initialize it.
+        machine_id_changed
+        @logger = Log4r::Logger.new("vagrant::hyperv::provider")
+      end
+
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def machine_id_changed
+        @driver = Driver.new(@machine.id)
+      end
+
+      def state
+        state_id = nil
+        state_id = :not_created if !@machine.id
+
+        if !state_id
+          # Run a custom action we define called "read_state" which does
+          # what it says. It puts the state in the `:machine_state_id`
+          # key in the environment.
+          env = @machine.action(:read_state)
+          state_id = env[:machine_state_id]
+        end
+
+        # Get the short and long description
+        short = state_id.to_s
+        long  = ""
+
+        # If we're not created, then specify the special ID flag
+        if state_id == :not_created
+          state_id = Vagrant::MachineState::NOT_CREATED_ID
+        end
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? "new" : @machine.id
+        "Hyper-V (#{id})"
+      end
+
+      # @return [Hash]
+      def ssh_info
+        # We can only SSH into a running machine
+        return nil if state.id != :running
+
+        # Read the IP of the machine using Hyper-V APIs
+        guest_ip = nil
+
+        begin
+          network_info = @driver.read_guest_ip
+          guest_ip = network_info["ip"]
+        rescue Errors::PowerShellError
+          @logger.warn("Failed to read guest IP.")
+        end
+
+        return nil if !guest_ip
+
+        @logger.debug("IP: #{guest_ip}")
+
+        {
+          host: guest_ip,
+          port: 22,
+        }
+      end
+    end
+  end
+end

data/plugins/providers/hyperv/scripts/add_dvd.ps1

@@ -0,0 +1,18 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId,
+    [Parameter(Mandatory=$true)]
+    [string]$ISOPath
+)
+
+try {
+    Hyper-V\Get-VM -ID $VmId | Hyper-V\Add-VMDvdDrive -Path $ISOPath
+} catch {
+    Write-ErrorMessage "Failed to add DVD drive for path - ${ISOPath}: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/attach_disk_drive.ps1

@@ -0,0 +1,31 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId,
+    [Parameter(Mandatory=$true)]
+    [string]$Path,
+    [string]$ControllerType,
+    [string]$ControllerNumber,
+    [string]$ControllerLocation
+)
+
+$Params = @{}
+
+foreach ($key in $MyInvocation.BoundParameters.keys) {
+  $value = (Get-Variable -Exclude "ErrorAction" $key).Value
+  if (($key -ne "VmId") -and ($key -ne "ErrorAction")) {
+    $Params.Add($key, $value)
+  }
+}
+
+try {
+    $VM = Hyper-V\Get-VM -Id $VmId
+    Hyper-V\Add-VMHardDiskDrive -VMName $VM.Name @Params
+} catch {
+    Write-ErrorMessage "Failed to attach disk ${DiskFilePath} to VM ${VM}: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/check_hyperv.ps1

@@ -0,0 +1,11 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+$check = $(-Not (-Not (Get-Command "Hyper-V\Get-VMSwitch" -ErrorAction SilentlyContinue)))
+$result = @{
+    result = $check
+}
+
+Write-OutputMessage $(ConvertTo-Json $result)

data/plugins/providers/hyperv/scripts/check_hyperv_access.ps1

@@ -0,0 +1,17 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages, VagrantVM
+
+param(
+    [parameter (Mandatory=$true)]
+    [string] $Path
+)
+
+$check = Check-VagrantHyperVAccess -Path $Path
+$result = @{
+    root_dir = ($Path -split '\\')[0,1] -join '\';
+    result = $check
+}
+
+Write-OutputMessage $(ConvertTo-Json $result)

data/plugins/providers/hyperv/scripts/clone_vhd.ps1

@@ -0,0 +1,21 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$Source,
+
+    [Parameter(Mandatory=$true)]
+    [string]$Destination
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    Hyper-V\New-VHD -Path $Destination -ParentPath $Source
+} catch {
+    Write-ErrorMessage "Failed to clone drive: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/configure_vm.ps1

@@ -0,0 +1,130 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantVM, VagrantMessages
+
+param(
+    [parameter (Mandatory=$true)]
+    [Guid] $VMID,
+    [parameter (Mandatory=$false)]
+    [string] $SwitchID=$null,
+    [parameter (Mandatory=$false)]
+    [string] $Memory=$null,
+    [parameter (Mandatory=$false)]
+    [string] $MaxMemory=$null,
+    [parameter (Mandatory=$false)]
+    [string] $Processors=$null,
+    [parameter (Mandatory=$false)]
+    [string] $AutoStartAction=$null,
+    [parameter (Mandatory=$false)]
+    [string] $AutoStopAction=$null,
+    [parameter (Mandatory=$false)]
+    [switch] $VirtualizationExtensions,
+    [parameter (Mandatory=$false)]
+    [switch] $EnableCheckpoints,
+    [parameter (Mandatory=$false)]
+    [switch] $EnableAutomaticCheckpoints
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $VM = Hyper-V\Get-VM -Id $VMID
+} catch {
+    Write-ErrorMessage "Failed to locate VM: ${PSItem}"
+    exit 1
+}
+
+if($Processors) {
+    try {
+        Set-VagrantVMCPUS -VM $VM -CPUCount ($Processors -as [int])
+    } catch {
+        Write-ErrorMessage "Failed to configure CPUs: ${PSItem}"
+        exit 1
+    }
+}
+
+if($Memory -or $MaxMemory) {
+    try {
+        Set-VagrantVMMemory -VM $VM -Memory $Memory -MaxMemory $MaxMemory
+    } catch {
+        Write-ErrorMessage "Failed to configure memory: ${PSItem}"
+        exit 1
+    }
+}
+
+if($AutoStartAction -or $AutoStopAction) {
+    try {
+        Set-VagrantVMAutoActions -VM $VM -AutoStartAction $AutoStartAction -AutoStopAction $AutoStopAction
+    } catch {
+        Write-ErrorMessage "Failed to configure automatic actions: ${PSItem}"
+        exit 1
+    }
+}
+
+if($VirtualizationExtensions) {
+    $virtex = $true
+} else {
+    $virtex = $false
+}
+
+try {
+    Set-VagrantVMVirtExtensions -VM $VM -Enabled $virtex
+} catch {
+    Write-ErrorMessage "Failed to configure virtualization extensions: ${PSItem}"
+    exit 1
+}
+
+if($SwitchID) {
+    try {
+        $SwitchName = Get-VagrantVMSwitch -NameOrID $SwitchID
+        Set-VagrantVMSwitch -VM $VM -SwitchName $SwitchName
+    } catch {
+        Write-ErrorMessage "Failed to configure network adapter: ${PSItem}"
+        exit 1
+    }
+}
+
+if($EnableCheckpoints) {
+    $checkpoints = "Standard"
+    $CheckpointAction = "enable"
+} else {
+    $checkpoints = "Disabled"
+    $CheckpointAction = "disable"
+}
+
+try {
+    if((Get-Command Hyper-V\Set-VM).Parameters["CheckpointType"] -eq $null) {
+        if($CheckpointAction -eq "enable") {
+            Write-ErrorMessage "CheckpointType is not available. Cannot enable checkpoints."
+            exit 1
+        }
+    } else {
+        Hyper-V\Set-VM -VM $VM -CheckpointType $checkpoints
+    }
+} catch {
+    Write-ErrorMessage "Failed to ${CheckpointAction} checkpoints on VM: ${PSItem}"
+    exit 1
+}
+
+if($EnableAutomaticCheckpoints) {
+    $autochecks = 1
+    $AutoAction = "enabled"
+} else {
+    $autochecks = 0
+    $AutoAction = "disable"
+}
+
+try {
+    if((Get-Command Hyper-V\Set-VM).Parameters["AutomaticCheckpointsEnabled"] -eq $null) {
+        if($autochecks -eq 1) {
+            Write-ErrorMessage "AutomaticCheckpointsEnabled is not available"
+            exit 1
+        }
+    } else {
+        Hyper-V\Set-VM -VM $VM -AutomaticCheckpointsEnabled $autochecks
+    }
+} catch {
+    Write-ErrorMessage "Failed to ${AutoAction} automatic checkpoints on VM: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/create_snapshot.ps1

@@ -0,0 +1,27 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId,
+    [string]$SnapName
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $VM = Hyper-V\Get-VM -Id $VmId
+    $ChkPnt = $VM.CheckpointType
+    if($ChkPnt -eq "Disabled") {
+        Hyper-V\Set-VM -VM $VM -CheckpointType "Standard"
+    }
+    Hyper-V\Checkpoint-VM $VM -SnapshotName $SnapName
+    if($ChkPnt -eq "Disabled") {
+        Hyper-V\Set-VM -VM $VM -CheckpointType "Disabled"
+    }
+} catch {
+    Write-ErrorMessage "Failed to create snapshot: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/delete_snapshot.ps1

@@ -0,0 +1,19 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId,
+    [string]$SnapName
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $VM = Hyper-V\Get-VM -Id $VmId
+    Hyper-V\Remove-VMSnapshot $VM -Name $SnapName
+} catch {
+    Write-ErrorMessage "Failed to delete snapshot: ${PSItem}"
+}

data/plugins/providers/hyperv/scripts/delete_vm.ps1

@@ -0,0 +1,22 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $VM = Hyper-V\Get-VM -Id $VmId
+    if((Get-Command Hyper-V\Set-VM).Parameters["AutomaticCheckpointsEnabled"] -ne $null) {
+        Hyper-V\Set-VM -VM $VM -AutomaticCheckpointsEnabled $false -ErrorAction SilentlyContinue
+    }
+    Hyper-V\Remove-VM $VM -Force
+} catch {
+    Write-ErrorMessage "Failed to delete VM: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/dismount_vhd.ps1

@@ -0,0 +1,16 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$DiskFilePath
+)
+
+try {
+    Hyper-V\Dismount-VHD -path $DiskFilePath
+} catch {
+    Write-ErrorMessage "Failed to dismount disk info from disk file path ${DiskFilePath}: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/export_vm.ps1

@@ -0,0 +1,32 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId,
+    [Parameter(Mandatory=$true)]
+    [string]$Path
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $vm = Hyper-V\Get-VM -Id $VmId
+    $vm | Hyper-V\Export-VM -Path $Path
+} catch {
+    Write-ErrorMessage "Failed to export VM: ${PSItem}"
+    exit 1
+}
+
+# Prepare directory structure for box import
+try {
+    $name = $vm.Name
+    Move-Item $Path/$name/* $Path
+    Remove-Item -Path $Path/Snapshots -Force -Recurse
+    Remove-Item -Path $Path/$name -Force
+} catch {
+    Write-ErrorMessage "Failed to format exported box: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/file_sync.ps1

@@ -0,0 +1,123 @@
+#Requires -Modules VagrantMessages
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Open Technologies, Inc.
+# All Rights Reserved. Licensed under the MIT License.
+#--------------------------------------------------------------------------
+
+param (
+    [parameter (Mandatory=$true)]
+    [string]$vm_id,
+    [parameter (Mandatory=$true)]
+    [string]$guest_ip,
+    [parameter (Mandatory=$true)]
+    [string]$username,
+    [parameter (Mandatory=$true)]
+    [string]$password,
+    [parameter (Mandatory=$true)]
+    [string]$host_path,
+    [parameter (Mandatory=$true)]
+    [string]$guest_path
+)
+
+function Get-file-hash($source_path, $delimiter) {
+    $source_files = @()
+    (Get-ChildItem $source_path -rec | ForEach-Object -Process {
+      Get-FileHash -Path $_.FullName -Algorithm MD5 } ) |
+        ForEach-Object -Process {
+          $source_files += $_.Path.Replace($source_path, "") + $delimiter + $_.Hash
+        }
+    $source_files
+}
+
+function Get-Remote-Session($guest_ip, $username, $password) {
+    $secstr = convertto-securestring -AsPlainText -Force -String $password
+    $cred = new-object -typename System.Management.Automation.PSCredential -argumentlist $username, $secstr
+    New-PSSession -ComputerName $guest_ip -Credential $cred
+}
+
+function Get-remote-file-hash($source_path, $delimiter, $session) {
+    Invoke-Command -Session $session -ScriptBlock ${function:Get-file-hash} -ArgumentList $source_path, $delimiter
+    # TODO:
+    # Check if remote PS Scripting errors
+}
+
+function Sync-Remote-Machine($machine, $remove_files, $copy_files, $host_path, $guest_path) {
+    ForEach ($item in $copy_files) {
+      $from = $host_path + $item
+      $to = $guest_path + $item
+      # Copy VM can also take a VM object
+      Hyper-V\Copy-VMFile  -VM $machine -SourcePath $from -DestinationPath $to -CreateFullPath -FileSource Host -Force
+    }
+}
+
+function Create-Remote-Folders($empty_source_folders, $guest_path) {
+    ForEach ($item in $empty_source_folders) {
+        $new_name =  $guest_path + $item
+        New-Item "$new_name" -type directory -Force
+    }
+}
+
+function Get-Empty-folders-From-Source($host_path) {
+  Get-ChildItem $host_path -recurse |
+        Where-Object {$_.PSIsContainer -eq $True} |
+            Where-Object {$_.GetFiles().Count -eq 0} |
+                Select-Object FullName | ForEach-Object -Process {
+                    $empty_source_folders += ($_.FullName.Replace($host_path, ""))
+                }
+}
+
+$delimiter = " || "
+
+$machine = Hyper-V\Get-VM -Id $vm_id
+
+# FIXME: PowerShell guys please fix this.
+# The below script checks for all VMIntegrationService which are not enabled
+# and will enable this.
+# When when all the services are enabled this throws an error.
+# Enable VMIntegrationService to true
+try {
+  Hyper-V\Get-VM -Id $vm_id | Hyper-V\Get-VMIntegrationService -Name "Guest Service Interface" | Hyper-V\Enable-VMIntegrationService -Passthru
+  }
+  catch { }
+
+$session = Get-Remote-Session $guest_ip $username $password
+
+$source_files = Get-file-hash $host_path $delimiter
+$destination_files = Get-remote-file-hash $guest_path $delimiter $session
+
+if (!$destination_files) {
+  $destination_files = @()
+}
+if (!$source_files) {
+  $source_files = @()
+}
+
+# Compare source and destination files
+$remove_files = @()
+$copy_files = @()
+
+
+Compare-Object -ReferenceObject $source_files -DifferenceObject $destination_files | ForEach-Object {
+  if ($_.SideIndicator -eq '=>') {
+      $remove_files += $_.InputObject.Split($delimiter)[0]
+  } else {
+      $copy_files += $_.InputObject.Split($delimiter)[0]
+  }
+}
+
+# Update the files to remote machine
+Sync-Remote-Machine $machine $remove_files $copy_files $host_path $guest_path
+
+# Create any empty folders which missed to sync to remote machine
+$empty_source_folders = @()
+$directories = Get-Empty-folders-From-Source $host_path
+
+$result = Invoke-Command -Session $session -ScriptBlock ${function:Create-Remote-Folders} -ArgumentList $empty_source_folders, $guest_path
+# Always remove the connection after Use
+Remove-PSSession -Id $session.Id
+
+$resultHash = @{
+  message = "OK"
+}
+$result = ConvertTo-Json $resultHash
+Write-OutputMessage $result

data/plugins/providers/hyperv/scripts/get_network_config.ps1

@@ -0,0 +1,68 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $vm = Hyper-V\Get-VM -Id $VmId
+} catch {
+    Write-ErrorMessage "Failed to locate VM: ${PSItem}"
+    exit 1
+}
+
+try {
+    $netdev = Hyper-V\Get-VMNetworkAdapter -VM $vm | Select-Object -Index 0
+    if ($netdev -ne $null) {
+        if ($netdev.IpAddresses.Length -gt 0) {
+            foreach ($ip_address in $netdev.IpAddresses) {
+                if ($ip_address.Contains(".") -And [string]::IsNullOrEmpty($ip4_address)) {
+                    $ip4_address = $ip_address
+                } elseif ($ip_address.Contains(":") -And [string]::IsNullOrEmpty($ip6_address)) {
+                    $ip6_address = $ip_address
+                }
+            }
+        }
+
+        # If no address was found in the network settings, check for
+        # neighbor with mac address and see if an IP exists
+        if (([string]::IsNullOrEmpty($ip4_address)) -And ([string]::IsNullOrEmpty($ip6_address))) {
+            $macaddress = $netdev.MacAddress -replace '(.{2})(?!$)', '${1}-'
+            $addr = Get-NetNeighbor -LinkLayerAddress $macaddress -ErrorAction SilentlyContinue | select IPAddress
+            if ($addr) {
+                $ip_address = $addr.IPAddress
+                if ($ip_address.Contains(".")) {
+                    $ip4_address = $ip_address
+                } elseif ($ip_address.Contains(":")) {
+                    $ip6_address = $ip_address
+                }
+            }
+        }
+    }
+
+    if (-Not ([string]::IsNullOrEmpty($ip4_address))) {
+        $guest_ipaddress = $ip4_address
+    } elseif (-Not ([string]::IsNullOrEmpty($ip6_address))) {
+        $guest_ipaddress = $ip6_address
+    }
+
+    if (-Not ([string]::IsNullOrEmpty($guest_ipaddress))) {
+        $resultHash = @{
+            ip = $guest_ipaddress
+        }
+        $result = ConvertTo-Json $resultHash
+        Write-OutputMessage $result
+    } else {
+        Write-ErrorMessage "Failed to determine IP address"
+        exit 1
+    }
+} catch {
+    Write-ErrorMessage "Unexpected error while detecting network configuration: ${PSItem}"
+    exit 1
+}

data/plugins/providers/hyperv/scripts/get_network_mac.ps1

@@ -0,0 +1,35 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+#Requires -Modules VagrantMessages
+
+param(
+    [Parameter(Mandatory=$true)]
+    [string]$VmId
+)
+
+$ErrorActionPreference = "Stop"
+
+try {
+    $ip_address = ""
+    $vm = Hyper-V\Get-VM -Id $VmId
+    $networks = Hyper-V\Get-VMNetworkAdapter -VM $vm
+    foreach ($network in $networks) {
+        if ($network.MacAddress -gt 0) {
+            $mac_address = $network.MacAddress
+            if (-Not ([string]::IsNullOrEmpty($mac_address))) {
+                # We found our mac address!
+                break
+            }
+        }
+    }
+
+    $resultHash = @{
+        mac = "$mac_address"
+    }
+    $result = ConvertTo-Json $resultHash
+    Write-OutputMessage $result
+} catch {
+    Write-ErrorMessage "Unexpected error while fetching MAC: ${PSItem}"
+    exit 1
+}