vagrant-libvirt 0.1.2 → 0.5.0

data/lib/vagrant-libvirt/cap/public_address.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module ProviderLibvirt
+    module Cap
+      class PublicAddress
+        def self.public_address(machine)
+          # This does not need to be a globally routable address, it
+          # only needs to be accessible from the machine running
+          # Vagrant.
+          ssh_info = machine.ssh_info
+          return nil if !ssh_info
+          ssh_info[:host]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/cap/{synced_folder.rb → synced_folder_9p.rb}

@@ -6,10 +6,9 @@ require 'digest/md5'
 require 'vagrant/util/subprocess'
 require 'vagrant/errors'
 require 'vagrant-libvirt/errors'
-# require_relative "helper"
 
 module VagrantPlugins
-  module SyncedFolder9p
+  module SyncedFolder9P
     class SyncedFolder < Vagrant.plugin('2', :synced_folder)
       include Vagrant::Util
       include VagrantPlugins::ProviderLibvirt::Util::ErbTemplate
@@ -69,10 +68,10 @@ module VagrantPlugins
         end
       end
 
-      # TODO: once up, mount folders
+      # once up, mount folders
       def enable(machine, folders, _opts)
         # Go through each folder and mount
-        machine.ui.info('mounting p9 share in guest')
+        machine.ui.info('mounting 9p share in guest')
         # Only mount folders that have a guest path specified.
         mount_folders = {}
         folders.each do |id, opts|
@@ -83,7 +82,7 @@ module VagrantPlugins
         end
         # Mount the actual folder
         machine.guest.capability(
-          :mount_p9_shared_folder, mount_folders
+          :mount_9p_shared_folder, mount_folders
         )
       end
 

data/lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb

@@ -0,0 +1,109 @@
+require 'log4r'
+require 'ostruct'
+require 'nokogiri'
+require 'digest/md5'
+
+require 'vagrant/util/subprocess'
+require 'vagrant/errors'
+require 'vagrant-libvirt/errors'
+
+module VagrantPlugins
+  module SyncedFolderVirtioFS
+    class SyncedFolder < Vagrant.plugin('2', :synced_folder)
+      include Vagrant::Util
+      include VagrantPlugins::ProviderLibvirt::Util::ErbTemplate
+
+      def initialize(*args)
+        super
+        @logger = Log4r::Logger.new('vagrant_libvirt::synced_folders::virtiofs')
+      end
+
+      def usable?(machine, _raise_error = false)
+        # bail now if not using Libvirt since checking version would throw error
+        return false unless machine.provider_name == :libvirt
+
+        # virtiofs support introduced since 6.2.0
+        # version number format is major * 1,000,000 + minor * 1,000 + release
+        libvirt_version = machine.provider.driver.connection.client.libversion
+        libvirt_version >= 6_002_000
+      end
+
+      def prepare(machine, folders, _opts)
+        raise Vagrant::Errors::Error('No Libvirt connection') if machine.provider.driver.connection.nil?
+        @conn = machine.provider.driver.connection.client
+
+        begin
+          # loop through folders
+          folders.each do |id, folder_opts|
+            folder_opts.merge!(target: id,
+                               mount: true,
+                               readonly: nil) { |_k, ov, _nv| ov }
+
+            mount_tag = Digest::MD5.new.update(folder_opts[:hostpath]).to_s[0, 31]
+            folder_opts[:mount_tag] = mount_tag
+
+            machine.ui.info "================\nMachine id: #{machine.id}\nShould be mounting folders\n #{id}, opts: #{folder_opts}"
+
+            #xml = to_xml('filesystem', folder_opts)
+            xml = Nokogiri::XML::Builder.new do |xml|
+              xml.filesystem(type: 'mount', accessmode: 'passthrough') do
+                xml.driver(type: 'virtiofs')
+                xml.source(dir: folder_opts[:hostpath])
+                xml.target(dir: mount_tag)
+                xml.readonly unless folder_opts[:readonly].nil?
+              end
+            end.to_xml(
+              save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION |
+                         Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS |
+                         Nokogiri::XML::Node::SaveOptions::FORMAT
+            )
+            # puts "<<<<< XML:\n #{xml}\n >>>>>"
+            @conn.lookup_domain_by_uuid(machine.id).attach_device(xml, 0)
+          end
+        rescue => e
+          machine.ui.error("could not attach device because: #{e}")
+          raise VagrantPlugins::ProviderLibvirt::Errors::AttachDeviceError,
+                error_message: e.message
+        end
+      end
+
+      # once up, mount folders
+      def enable(machine, folders, _opts)
+        # Go through each folder and mount
+        machine.ui.info('mounting virtiofs share in guest')
+        # Only mount folders that have a guest path specified.
+        mount_folders = {}
+        folders.each do |id, opts|
+          next unless opts[:mount] && opts[:guestpath] && !opts[:guestpath].empty?
+          mount_folders[id] = opts.dup
+        end
+        # Mount the actual folder
+        machine.guest.capability(
+          :mount_virtiofs_shared_folder, mount_folders
+        )
+      end
+
+      def cleanup(machine, _opts)
+        if machine.provider.driver.connection.nil?
+          raise Vagrant::Errors::Error('No Libvirt connection')
+        end
+        @conn = machine.provider.driver.connection.client
+        begin
+          if machine.id && machine.id != ''
+            dom = @conn.lookup_domain_by_uuid(machine.id)
+            Nokogiri::XML(dom.xml_desc).xpath(
+              '/domain/devices/filesystem'
+            ).each do |xml|
+              dom.detach_device(xml.to_s)
+              machine.ui.info 'Cleaned up shared folders'
+            end
+          end
+        rescue => e
+          machine.ui.error("could not detach device because: #{e}")
+          raise VagrantPlugins::ProviderLibvirt::Errors::DetachDeviceError,
+                error_message: e.message
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/config.rb

@@ -37,6 +37,11 @@ module VagrantPlugins
       # ID SSH key file
       attr_accessor :id_ssh_key_file
 
+      attr_accessor :proxy_command
+
+      # Forward port with id 'ssh'
+      attr_accessor :forward_ssh_port
+
       # Libvirt storage pool name, where box image and instance snapshots will
       # be stored.
       attr_accessor :storage_pool_name
@@ -59,6 +64,7 @@ module VagrantPlugins
       attr_accessor :management_network_pci_bus
       attr_accessor :management_network_pci_slot
       attr_accessor :management_network_domain
+      attr_accessor :management_network_mtu
 
       # System connection information
       attr_accessor :system_uri
@@ -67,6 +73,8 @@ module VagrantPlugins
       attr_accessor :default_prefix
 
       # Domain specific settings used while creating new domain.
+      attr_accessor :title
+      attr_accessor :description
       attr_accessor :uuid
       attr_accessor :memory
       attr_accessor :nodeset
@@ -82,6 +90,8 @@ module VagrantPlugins
       attr_accessor :shares
       attr_accessor :features
       attr_accessor :features_hyperv
+      attr_accessor :clock_offset
+      attr_accessor :clock_timers
       attr_accessor :numa_nodes
       attr_accessor :loader
       attr_accessor :nvram
@@ -91,9 +101,10 @@ module VagrantPlugins
       attr_accessor :machine_virtual_size
       attr_accessor :disk_bus
       attr_accessor :disk_device
+      attr_accessor :disk_driver_opts
       attr_accessor :nic_model_type
       attr_accessor :nested
-      attr_accessor :volume_cache
+      attr_accessor :volume_cache # deprecated, kept for backwards compatibility; use disk_driver
       attr_accessor :kernel
       attr_accessor :cmd_line
       attr_accessor :initrd
@@ -115,6 +126,13 @@ module VagrantPlugins
       attr_accessor :tpm_model
       attr_accessor :tpm_type
       attr_accessor :tpm_path
+      attr_accessor :tpm_version
+
+      # Configure the memballoon
+      attr_accessor :memballoon_enabled
+      attr_accessor :memballoon_model
+      attr_accessor :memballoon_pci_bus
+      attr_accessor :memballoon_pci_slot
 
       # Sets the max number of NICs that can be created
       # Default set to 8. Don't change the default unless you know
@@ -179,6 +197,9 @@ module VagrantPlugins
         @username          = UNSET_VALUE
         @password          = UNSET_VALUE
         @id_ssh_key_file   = UNSET_VALUE
+        @socket            = UNSET_VALUE
+        @proxy_command     = UNSET_VALUE
+        @forward_ssh_port  = UNSET_VALUE # forward port with id 'ssh'
         @storage_pool_name = UNSET_VALUE
         @snapshot_pool_name = UNSET_VALUE
         @random_hostname   = UNSET_VALUE
@@ -192,11 +213,14 @@ module VagrantPlugins
         @management_network_pci_slot = UNSET_VALUE
         @management_network_pci_bus = UNSET_VALUE
         @management_network_domain = UNSET_VALUE
+        @management_network_mtu = UNSET_VALUE
 
         # System connection information
         @system_uri      = UNSET_VALUE
 
         # Domain specific settings.
+        @title             = UNSET_VALUE
+        @description       = UNSET_VALUE
         @uuid              = UNSET_VALUE
         @memory            = UNSET_VALUE
         @nodeset           = UNSET_VALUE
@@ -211,6 +235,8 @@ module VagrantPlugins
         @shares            = UNSET_VALUE
         @features          = UNSET_VALUE
         @features_hyperv   = UNSET_VALUE
+        @clock_offset      = UNSET_VALUE
+        @clock_timers      = []
         @numa_nodes        = UNSET_VALUE
         @loader            = UNSET_VALUE
         @nvram             = UNSET_VALUE
@@ -219,6 +245,7 @@ module VagrantPlugins
         @machine_virtual_size = UNSET_VALUE
         @disk_bus          = UNSET_VALUE
         @disk_device       = UNSET_VALUE
+        @disk_driver_opts  = {}
         @nic_model_type    = UNSET_VALUE
         @nested            = UNSET_VALUE
         @volume_cache      = UNSET_VALUE
@@ -241,6 +268,12 @@ module VagrantPlugins
         @tpm_model         = UNSET_VALUE
         @tpm_type          = UNSET_VALUE
         @tpm_path          = UNSET_VALUE
+        @tpm_version       = UNSET_VALUE
+
+        @memballoon_enabled = UNSET_VALUE
+        @memballoon_model   = UNSET_VALUE
+        @memballoon_pci_bus = UNSET_VALUE
+        @memballoon_pci_slot = UNSET_VALUE
 
         @nic_adapter_count = UNSET_VALUE
 
@@ -369,10 +402,39 @@ module VagrantPlugins
           raise 'Feature name AND state must be specified'
         end
 
+        if options[:name] == 'spinlocks' && options[:retries].nil?
+          raise 'Feature spinlocks requires retries parameter'
+        end
+
         @features_hyperv = []  if @features_hyperv == UNSET_VALUE
 
-        @features_hyperv.push(name: options[:name],
-                              state: options[:state])
+        if options[:name] == 'spinlocks'
+          @features_hyperv.push(name:   options[:name],
+                             state: options[:state],
+                             retries: options[:retries])
+        else
+          @features_hyperv.push(name:   options[:name],
+                             state: options[:state])
+        end
+      end
+
+      def clock_timer(options = {})
+        if options[:name].nil?
+          raise 'Clock timer name must be specified'
+        end
+
+        options.each do |key, value|
+          case key
+            when :name, :track, :tickpolicy, :frequency, :mode, :present
+              if value.nil?
+                raise "Value of timer option #{key} is nil"
+              end
+            else
+              raise "Unknown clock timer option: #{key}"
+          end
+        end
+
+        @clock_timers.push(options.dup)
       end
 
       def cputopology(options = {})
@@ -547,6 +609,12 @@ module VagrantPlugins
         @smartcard_dev[:source_service] = options[:source_service] if @smartcard_dev[:type] == 'tcp'
       end
 
+      # Disk driver options for primary disk
+      def disk_driver(options = {})
+        supported_opts = [:cache, :io, :copy_on_read, :discard, :detect_zeroes]
+        @disk_driver_opts = options.select { |k,_| supported_opts.include? k }
+      end
+
       # NOTE: this will run twice for each time it's needed- keep it idempotent
       def storage(storage_type, options = {})
         if storage_type == :file
@@ -570,11 +638,13 @@ module VagrantPlugins
         # as will the address unit number (unit=0, unit=1, etc)
 
         options = {
+          type: 'raw',
           bus: 'ide',
           path: nil
         }.merge(options)
 
         cdrom = {
+          type: options[:type],
           dev: options[:dev],
           bus: options[:bus],
           path: options[:path]
@@ -600,7 +670,13 @@ module VagrantPlugins
           cache: options[:cache] || 'default',
           allow_existing: options[:allow_existing],
           shareable: options[:shareable],
-          serial: options[:serial]
+          serial: options[:serial],
+          io: options[:io],
+          copy_on_read: options[:copy_on_read],
+          discard: options[:discard],
+          detect_zeroes: options[:detect_zeroes],
+          pool: options[:pool], # overrides storage_pool setting for additional disks
+          wwn: options[:wwn],
         }
 
         @disks << disk # append
@@ -618,14 +694,31 @@ module VagrantPlugins
         @qemu_env.merge!(options)
       end
 
-      # code to generate URI from a config moved out of the connect action
-      def _generate_uri
+      def _default_uri
+        # Determine if any settings except driver provided explicitly, if not
+        # and the LIBVIRT_DEFAULT_URI var is set, use that.
+        #
+        # Skipping driver because that may be set on individual boxes rather
+        # than by the user.
+        if [
+            @connect_via_ssh, @host, @username, @password,
+            @id_ssh_key_file, @qemu_use_session, @socket,
+        ].none?{ |v| v != UNSET_VALUE }
+          if ENV.fetch('LIBVIRT_DEFAULT_URI', '') != ""
+            @uri = ENV['LIBVIRT_DEFAULT_URI']
+          end
+        end
+      end
+
+      # code to generate URI from from either the LIBVIRT_URI environment
+      # variable or a config moved out of the connect action
+      def _generate_uri(qemu_use_session)
         # builds the Libvirt connection URI from the given driver config
         # Setup connection uri.
         uri = @driver.dup
         virt_path = case uri
                     when 'qemu', 'kvm'
-                      @qemu_use_session ? '/session' : '/system'
+                      qemu_use_session ? '/session' : '/system'
                     when 'openvz', 'uml', 'phyp', 'parallels'
                       '/system'
                     when '@en', 'esx'
@@ -639,42 +732,65 @@ module VagrantPlugins
           uri = 'qemu' # use QEMU uri for KVM domain type
         end
 
-        if @connect_via_ssh
+        # turn on ssh if an ssh key file is explicitly provided
+        if @connect_via_ssh == UNSET_VALUE && @id_ssh_key_file && @id_ssh_key_file != UNSET_VALUE
+          @connect_via_ssh = true
+        end
+
+        params = {}
+
+        if @connect_via_ssh == true
+          finalize_id_ssh_key_file
+
           uri << '+ssh://'
-          uri << @username + '@' if @username
+          uri << @username + '@' if @username && @username != UNSET_VALUE
 
-          uri << if @host
-                   @host
-                 else
-                   'localhost'
-                 end
+          uri << ( @host && @host != UNSET_VALUE ? @host : 'localhost' )
+
+          params['no_verify'] = '1'
+          params['keyfile'] = @id_ssh_key_file if @id_ssh_key_file
         else
           uri << '://'
-          uri << @host if @host
+          uri << @host if @host && @host != UNSET_VALUE
         end
 
         uri << virt_path
-        uri << '?no_verify=1'
 
-        if @id_ssh_key_file
-          # set ssh key for access to Libvirt host
-          uri << "\&keyfile="
-          # if no slash, prepend $HOME/.ssh/
-          @id_ssh_key_file.prepend("#{`echo ${HOME}`.chomp}/.ssh/") if @id_ssh_key_file !~ /\A\//
-          uri << @id_ssh_key_file
-        end
         # set path to Libvirt socket
-        uri << "\&socket=" + @socket if @socket
+        params['socket'] = @socket if @socket
+
+        uri << "?" + params.map{|pair| pair.join('=')}.join('&') if !params.empty?
         uri
       end
 
+      def _parse_uri(uri)
+        begin
+          URI.parse(uri)
+        rescue
+          raise "@uri set to invalid uri '#{uri}'"
+        end
+      end
+
       def finalize!
+        _default_uri if @uri == UNSET_VALUE
+
+        # settings which _generate_uri
         @driver = 'kvm' if @driver == UNSET_VALUE
-        @host = nil if @host == UNSET_VALUE
-        @connect_via_ssh = false if @connect_via_ssh == UNSET_VALUE
-        @username = nil if @username == UNSET_VALUE
         @password = nil if @password == UNSET_VALUE
-        @id_ssh_key_file = 'id_rsa' if @id_ssh_key_file == UNSET_VALUE
+        @socket = nil if @socket == UNSET_VALUE
+
+        # If uri isn't set then let's build one from various sources.
+        # Default to passing false for qemu_use_session if it's not set.
+        if @uri == UNSET_VALUE
+          @uri = _generate_uri(@qemu_use_session == UNSET_VALUE ? false : @qemu_use_session)
+        end
+
+        finalize_from_uri
+        finalize_proxy_command
+
+        # forward port with id 'ssh'
+        @forward_ssh_port = false if @forward_ssh_port == UNSET_VALUE
+
         @storage_pool_name = 'default' if @storage_pool_name == UNSET_VALUE
         @snapshot_pool_name = @storage_pool_name if @snapshot_pool_name == UNSET_VALUE
         @storage_pool_path = nil if @storage_pool_path == UNSET_VALUE
@@ -689,14 +805,12 @@ module VagrantPlugins
         @management_network_pci_bus = nil if @management_network_pci_bus == UNSET_VALUE
         @management_network_pci_slot = nil if @management_network_pci_slot == UNSET_VALUE
         @management_network_domain = nil if @management_network_domain == UNSET_VALUE
+        @management_network_mtu = nil if @management_network_mtu == UNSET_VALUE
         @system_uri      = 'qemu:///system' if @system_uri == UNSET_VALUE
 
-        @qemu_use_session = false if @qemu_use_session == UNSET_VALUE
-
-        # generate a URI if none is supplied
-        @uri = _generate_uri if @uri == UNSET_VALUE
-
         # Domain specific settings.
+        @title = '' if @title == UNSET_VALUE
+        @description = '' if @description == UNSET_VALUE
         @uuid = '' if @uuid == UNSET_VALUE
         @memory = 512 if @memory == UNSET_VALUE
         @nodeset = nil if @nodeset == UNSET_VALUE
@@ -717,6 +831,8 @@ module VagrantPlugins
         @shares = nil if @shares == UNSET_VALUE
         @features = ['acpi','apic','pae'] if @features == UNSET_VALUE
         @features_hyperv = [] if @features_hyperv == UNSET_VALUE
+        @clock_offset = 'utc' if @clock_offset == UNSET_VALUE
+        @clock_timers = [] if @clock_timers == UNSET_VALUE
         @numa_nodes = @numa_nodes == UNSET_VALUE ? nil : _generate_numa
         @loader = nil if @loader == UNSET_VALUE
         @nvram = nil if @nvram == UNSET_VALUE
@@ -725,9 +841,10 @@ module VagrantPlugins
         @machine_virtual_size = nil if @machine_virtual_size == UNSET_VALUE
         @disk_bus = 'virtio' if @disk_bus == UNSET_VALUE
         @disk_device = 'vda' if @disk_device == UNSET_VALUE
+        @disk_driver_opts = {} if @disk_driver_opts == UNSET_VALUE
         @nic_model_type = nil if @nic_model_type == UNSET_VALUE
         @nested = false if @nested == UNSET_VALUE
-        @volume_cache = 'default' if @volume_cache == UNSET_VALUE
+        @volume_cache = nil if @volume_cache == UNSET_VALUE
         @kernel = nil if @kernel == UNSET_VALUE
         @cmd_line = '' if @cmd_line == UNSET_VALUE
         @initrd = '' if @initrd == UNSET_VALUE
@@ -749,6 +866,11 @@ module VagrantPlugins
         @tpm_model = 'tpm-tis' if @tpm_model == UNSET_VALUE
         @tpm_type = 'passthrough' if @tpm_type == UNSET_VALUE
         @tpm_path = nil if @tpm_path == UNSET_VALUE
+        @tpm_version = nil if @tpm_version == UNSET_VALUE
+        @memballoon_enabled = nil if @memballoon_enabled == UNSET_VALUE
+        @memballoon_model = 'virtio' if @memballoon_model == UNSET_VALUE
+        @memballoon_pci_bus = '0x00' if @memballoon_pci_bus == UNSET_VALUE
+        @memballoon_pci_slot = '0x0f' if @memballoon_pci_slot == UNSET_VALUE
         @nic_adapter_count = 8 if @nic_adapter_count == UNSET_VALUE
         @emulator_path = nil if @emulator_path == UNSET_VALUE
 
@@ -814,6 +936,14 @@ module VagrantPlugins
       def validate(machine)
         errors = _detected_errors
 
+        # The @uri and @qemu_use_session should not conflict
+        uri = _parse_uri(@uri)
+        if (uri.scheme.start_with? "qemu") && (uri.path.include? "session")
+          if @qemu_use_session != true
+            errors << "the URI and qemu_use_session configuration conflict: uri:'#{@uri}' qemu_use_session:'#{@qemu_use_session}'"
+          end
+        end
+
         machine.provider_config.disks.each do |disk|
           if disk[:path] && (disk[:path][0] == '/')
             errors << "absolute volume paths like '#{disk[:path]}' not yet supported"
@@ -832,6 +962,14 @@ module VagrantPlugins
           end
         end
 
+        if !machine.provider_config.volume_cache.nil? and machine.provider_config.volume_cache != UNSET_VALUE
+          machine.ui.warn("Libvirt Provider: volume_cache is deprecated. Use disk_driver :cache => '#{machine.provider_config.volume_cache}' instead.")
+
+          if !machine.provider_config.disk_driver_opts.empty?
+            machine.ui.warn("Libvirt Provider: volume_cache has no effect when disk_driver is defined.")
+          end
+        end
+
         { 'Libvirt Provider' => errors }
       end
 
@@ -845,11 +983,96 @@ module VagrantPlugins
           c += other.cdroms
           result.cdroms = c
 
+          result.disk_driver_opts = disk_driver_opts.merge(other.disk_driver_opts)
+          
+          c = clock_timers.dup
+          c += other.clock_timers
+          result.clock_timers = c
+
           c = qemu_env != UNSET_VALUE ? qemu_env.dup : {}
           c.merge!(other.qemu_env) if other.qemu_env != UNSET_VALUE
           result.qemu_env = c
         end
       end
+
+      private
+
+      def finalize_from_uri
+        # Parse uri to extract individual components
+        uri = _parse_uri(@uri)
+
+        # only set @connect_via_ssh if not explicitly to avoid overriding
+        # and allow an error to occur if the @uri and @connect_via_ssh disagree
+        @connect_via_ssh = uri.scheme.include? "ssh" if @connect_via_ssh == UNSET_VALUE
+
+        # Set qemu_use_session based on the URI if it wasn't set by the user
+        if @qemu_use_session == UNSET_VALUE
+          if (uri.scheme.start_with? "qemu") && (uri.path.include? "session")
+            @qemu_use_session = true
+          else
+            @qemu_use_session = false
+          end
+        end
+
+        # Extract host and username values from uri if provided, otherwise nil
+        @host = uri.host
+        @username = uri.user
+
+        finalize_id_ssh_key_file
+      end
+
+      def resolve_ssh_key_file(key_file)
+        # set ssh key for access to Libvirt host
+        # if no slash, prepend $HOME/.ssh/
+        key_file.prepend("#{ENV['HOME']}/.ssh/") if key_file && key_file !~ /\A\//
+
+        key_file
+      end
+
+      def finalize_id_ssh_key_file
+        # resolve based on the following roles
+        #  1) if @connect_via_ssh is set to true, and id_ssh_key_file not current set,
+        #     set default if the file exists
+        #  2) if supplied the key name, attempt to expand based on user home
+        #  3) otherwise set to nil
+
+        if @connect_via_ssh == true && @id_ssh_key_file == UNSET_VALUE
+          # set default if using ssh while allowing a user using nil to disable this
+          id_ssh_key_file = resolve_ssh_key_file('id_rsa')
+          id_ssh_key_file = nil if !File.file?(id_ssh_key_file)
+        elsif @id_ssh_key_file != UNSET_VALUE
+          id_ssh_key_file = resolve_ssh_key_file(@id_ssh_key_file)
+        else
+          id_ssh_key_file = nil
+        end
+
+        @id_ssh_key_file = id_ssh_key_file
+      end
+
+      def finalize_proxy_command
+        if @connect_via_ssh
+          if @proxy_command == UNSET_VALUE
+            proxy_command = "ssh '#{@host}' "
+            proxy_command << "-l '#{@username}' " if @username
+            proxy_command << "-i '#{@id_ssh_key_file}' " if @id_ssh_key_file
+            proxy_command << '-W %h:%p'
+          else
+            inputs = { host: @host }
+            inputs[:username] = @username if @username
+            inputs[:id_ssh_key_file] = @id_ssh_key_file if @id_ssh_key_file
+
+            proxy_command = @proxy_command
+            # avoid needing to escape '%' symbols
+            inputs.each do |key, value|
+              proxy_command.gsub!("{#{key}}", value)
+            end
+          end
+
+          @proxy_command = proxy_command
+        else
+          @proxy_command = nil
+        end
+      end
     end
   end
 end