vagrant-skytap 0.1.11 → 0.2.0

data/_patches-20160112/the_version_in_0.1.13.pre1

@@ -0,0 +1,598 @@
+# HG changeset patch
+# Parent 9277259db23ef4e33b90e83fbd16f6624145b338
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/action.rb
+--- a/lib/vagrant-skytap/action.rb	Fri Jan 08 11:52:01 2016 -0800
++++ b/lib/vagrant-skytap/action.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -16,6 +16,7 @@
+               b1.use MessageNotCreated
+             else
+               b1.use StopVm
++              b1.use ClearForwardedPorts
+             end
+           end
+         end
+@@ -31,6 +32,7 @@
+               b1.use MessageNotCreated
+             else
+               b1.use SuspendVm
++              b1.use ClearForwardedPorts
+             end
+           end
+         end
+@@ -65,6 +67,7 @@
+               end
+             end
+           end
++          b.use ClearForwardedPorts
+           b.use PrepareNFSValidIds
+           b.use SyncedFolderCleanup
+         end
+@@ -251,6 +254,7 @@
+             end
+           end
+           b.use WaitForCommunicator
++          b.use action_forward_ports
+         end
+       end
+ 
+@@ -281,15 +285,29 @@
+         end
+       end
+ 
++      def self.action_forward_ports
++        Vagrant::Action::Builder.new.tap do |b|
++          b.use ClearForwardedPorts
++          b.use ReadSSHInfo
++          b.use Message, "forwarding ports"
++          #b.use EnvSet, port_collision_repair: true # does it just work?
++          #b.use PrepareForwardedPortCollisionParams
++          #b.use HandleForwardedPortCollisions
++          b.use ForwardPorts
++        end
++      end
++
+       # The autoload farm
+       action_root = Pathname.new(File.expand_path("../action", __FILE__))
+       autoload :StoreExtraData, action_root.join("store_extra_data")
+       autoload :AddVmToEnvironment, action_root.join("add_vm_to_environment")
++      autoload :ClearForwardedPorts, action_root.join("clear_forwarded_ports")
+       autoload :CreateEnvironment, action_root.join("create_environment")
+       autoload :DeleteEnvironment, action_root.join("delete_environment")
+       autoload :DeleteVm, action_root.join("delete_vm")
+       autoload :ExistenceCheck, action_root.join("existence_check")
+       autoload :FetchEnvironment, action_root.join("fetch_environment")
++      autoload :ForwardPorts, action_root.join("forward_ports")
+       autoload :InitializeAPIClient, action_root.join("initialize_api_client")
+       autoload :InitialState, action_root.join("initial_state")
+       autoload :IsParallelized, action_root.join("is_parallelized")
+@@ -302,6 +320,7 @@
+       autoload :MessageEnvironmentUrl, action_root.join("message_environment_url")
+       autoload :MessageResuming, action_root.join("message_resuming")
+       autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
++      autoload :PrepareForwardedPortCollisionParams, action_root.join("prepare_forwarded_port_collision_params")
+       autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
+       autoload :PrepareNFSValidIds, action_root.join("prepare_nfs_valid_ids")
+       autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/action/clear_forwarded_ports.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/action/clear_forwarded_ports.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,39 @@
++#require 'byebug'
++require "vagrant/util/safe_chdir"
++
++
++module VagrantPlugins
++  module Skytap
++    module Action
++      class ClearForwardedPorts
++        def initialize(app, env)
++          @app = app
++          @env = env
++        end
++
++        def call(env)
++          if pidfiles = read_pidfiles.presence
++            env[:ui].info I18n.t("vagrant.actions.vm.clear_forward_ports.deleting")
++            kill_tunnels(pidfiles)
++          end
++
++          @app.call(env)
++        end
++
++        def read_pidfiles
++          pidfiles = []
++          Vagrant::Util::SafeChdir.safe_chdir(@env[:machine].data_dir) do
++            pidfiles = Dir.glob("*.pid")
++          end
++          pidfiles
++        end
++
++        def kill_tunnels(pidfiles)
++          pidfiles.each do |pidfile|
++            @env[:host].capability(:kill_ssh_tunnel, pidfile, @env)
++          end
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/action/forward_ports.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/action/forward_ports.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,51 @@
++require 'vagrant-skytap/util/compile_forwarded_ports'
++#require 'byebug'
++
++module VagrantPlugins
++  module Skytap
++    module Action
++      class ForwardPorts
++        include Util::CompileForwardedPorts
++
++        def initialize(app, env)
++          @app = app
++        end
++
++        #--------------------------------------------------------------
++        # Execution
++        #--------------------------------------------------------------
++        def call(env)
++          @env = env
++
++          # Get the ports we're forwarding
++          env[:forwarded_ports] ||= compile_forwarded_ports(env[:machine].config)
++
++          # Warn if we're port forwarding to any privileged ports...
++          env[:forwarded_ports].each do |fp|
++            if fp.host_port <= 1024
++              env[:ui].warn I18n.t("vagrant.actions.vm.forward_ports.privileged_ports")
++              break
++            end
++          end
++
++          env[:ui].output(I18n.t("vagrant.actions.vm.forward_ports.forwarding"))
++          forward_ports
++
++          @app.call(env)
++        end
++
++        def forward_ports
++          @env[:forwarded_ports].each do |fp|
++            unless fp.guest_port == 22 && fp.host_port == 2222
++              @env[:ui].detail(I18n.t("vagrant.actions.vm.forward_ports.forwarding_entry",
++                                        adapter: fp.adapter,
++                                        guest_port: fp.guest_port,
++                                        host_port: fp.host_port))
++              @env[:host].capability(:start_ssh_tunnel, fp, @env)
++            end
++          end
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/action/prepare_forwarded_port_collision_params.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/action/prepare_forwarded_port_collision_params.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,45 @@
++module VagrantPlugins
++  module Skytap
++    module Action
++      class PrepareForwardedPortCollisionParams
++        def initialize(app, env)
++          @app = app
++        end
++
++        def call(env)
++          # Get the forwarded ports used by other virtual machines and
++          # consider those in use as well.
++          env[:port_collision_extra_in_use] = read_used_ports
++
++          # Build the remap for any existing collision detections
++          remap = {}
++          env[:port_collision_remap] = remap
++          read_forwarded_ports.each do |_nic, name, hostport, _guestport|
++            env[:machine].config.vm.networks.each do |type, options|
++              next if type != :forwarded_port
++
++              # If the ID matches the name of the forwarded port, then
++              # remap.
++              if options[:id] == name
++                remap[options[:host]] = hostport
++                break
++              end
++            end
++          end
++
++          @app.call(env)
++        end
++
++        def read_used_ports
++          #env[:machine].provider.driver.read_used_ports
++          []
++        end
++
++        def read_forwarded_ports
++          #env[:machine].provider.driver.read_forwarded_ports
++          []
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/hosts/bsd/cap/ssh_tunnel.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/hosts/bsd/cap/ssh_tunnel.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,112 @@
++require "pathname"
++require "tmpdir"
++require 'childprocess'
++require "vagrant/util/subprocess"
++#require 'byebug'
++#require 'ap'
++require 'log4r'
++require "vagrant/util/safe_chdir"
++
++module VagrantPlugins
++  module Skytap
++    module HostBSD
++      module Cap
++        class SSHTunnel
++          def self.start_ssh_tunnel(env, fp, env_hash)
++            logger = Log4r::Logger.new("vagrant::hosts::bsd")
++            port = {
++              adapter:   fp.adapter,
++              guestip:   fp.guest_ip,
++              guestport: fp.guest_port,
++              hostip:    fp.host_ip,
++              hostport:  fp.host_port,
++              name:      fp.id,
++              protocol:  fp.protocol
++            }
++
++            pidfile = pidfile_name(port, env_hash)
++            pid = read_pid(pidfile)
++            if pid && autossh_pid?(pid)
++              logger.info("An autossh process already exists with pid #{pid}.")
++            else
++              args = autossh_args(port, pidfile, env_hash)
++              Vagrant::Util::Subprocess.execute("autossh", *args)
++            end
++          end
++
++          def self.kill_ssh_tunnel(env, pidfile, env_hash)
++            logger = Log4r::Logger.new("vagrant::hosts::bsd")
++            pidfile = File.join(env_hash[:machine].data_dir, pidfile)
++            pid = read_pid(pidfile)
++            if pid && autossh_pid?(pid)
++              Vagrant::Util::Subprocess.execute("kill", pid.to_s)
++            else
++              logger.info("Cleaning up stale autossh pidfile #{pidfile}.")
++              Vagrant::Util::Subprocess.execute("rm", pidfile)
++            end
++          end
++
++          private
++
++          def self.pidfile_name(port, env_hash)
++            tunnel_name = [port[:hostip], port[:name]].compact.join('_')
++            File.join(env_hash[:machine].data_dir, "#{tunnel_name}.pid")
++          end
++
++          def self.read_pid(pidfile)
++            File.read(pidfile).presence.try(:to_i) if File.exist?(pidfile)
++          end
++
++          # Checks that the pid is actually an autossh process (and not
++          # something else using a recycled pid).
++          def self.autossh_pid?(pid)
++            # get_comm_for_pid(pid) == 'autossh'
++            true
++          end
++
++          # Get the command, minus any arguments, for the given
++          # pid. I don't expect this to be compatible cross-platform yet...
++          # This could be complicated cross-platform, and Sys::ProcTable
++          # could likewise be complicated cross-platform ...
++          def self.get_comm_for_pid(pid)
++            result = Vagrant::Util::Subprocess.execute("ps", "-p", pid.to_s, "-o", "comm")
++            result.stdout.split("\n").last
++          end
++
++          def self.autossh_args(port, pidfile, env_hash)
++            ssh_info = env_hash[:machine_ssh_info]
++            ssh_options = {
++              "ServerAliveInterval" => 10,
++              "ServerAliveCountMax" => 3,
++              "StrictHostKeyChecking" => "no",
++            }
++            environment_variables = {
++              env: {
++                "AUTOSSH_PIDFILE" => pidfile,
++                "AUTOSSH_PORT" => 0, # turns off monitoring
++                #"AUTOSSH_LOGFILE" => "./autossh.log",
++              }
++            }
++            forward_string = [
++              port[:hostport],
++              "localhost",
++              port[:guestport]
++            ].join(':')
++
++            autossh_args = []
++            autossh_args << "-q"
++            autossh_args << "-N"
++            autossh_args << "-f"
++            autossh_args << "-i" << env_hash[:machine].data_dir.join("private_key").to_s
++            autossh_args << "-L" << forward_string
++            ssh_options.each do |k, v|
++              autossh_args << "-o" << "#{k}=#{v}"
++            end
++            autossh_args << "#{ssh_info[:username]}@#{ssh_info[:host]}"
++            autossh_args << environment_variables
++          end
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/hosts/linux/cap/ssh_tunnel.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/hosts/linux/cap/ssh_tunnel.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,112 @@
++require "pathname"
++require "tmpdir"
++require 'childprocess'
++require "vagrant/util/subprocess"
++#require 'byebug'
++#require 'ap'
++require 'log4r'
++require "vagrant/util/safe_chdir"
++
++module VagrantPlugins
++  module Skytap
++    module HostLinux
++      module Cap
++        class SSHTunnel
++          def self.start_ssh_tunnel(env, fp, env_hash)
++            logger = Log4r::Logger.new("vagrant::hosts::bsd")
++            port = {
++              adapter:   fp.adapter,
++              guestip:   fp.guest_ip,
++              guestport: fp.guest_port,
++              hostip:    fp.host_ip,
++              hostport:  fp.host_port,
++              name:      fp.id,
++              protocol:  fp.protocol
++            }
++
++            pidfile = pidfile_name(port, env_hash)
++            pid = read_pid(pidfile)
++            if pid && autossh_pid?(pid)
++              logger.info("An autossh process already exists with pid #{pid}.")
++            else
++              args = autossh_args(port, pidfile, env_hash)
++              Vagrant::Util::Subprocess.execute("autossh", *args)
++            end
++          end
++
++          def self.kill_ssh_tunnel(env, pidfile, env_hash)
++            logger = Log4r::Logger.new("vagrant::hosts::bsd")
++            pidfile = File.join(env_hash[:machine].data_dir, pidfile)
++            pid = read_pid(pidfile)
++            if pid && autossh_pid?(pid)
++              Vagrant::Util::Subprocess.execute("kill", pid.to_s)
++            else
++              logger.info("Cleaning up stale autossh pidfile #{pidfile}.")
++              Vagrant::Util::Subprocess.execute("rm", pidfile)
++            end
++          end
++
++          private
++
++          def self.pidfile_name(port, env_hash)
++            tunnel_name = [port[:hostip], port[:name]].compact.join('_')
++            File.join(env_hash[:machine].data_dir, "#{tunnel_name}.pid")
++          end
++
++          def self.read_pid(pidfile)
++            File.read(pidfile).presence.try(:to_i) if File.exist?(pidfile)
++          end
++
++          # Checks that the pid is actually an autossh process (and not
++          # something else using a recycled pid).
++          def self.autossh_pid?(pid)
++            # get_comm_for_pid(pid) == 'autossh'
++            true
++          end
++
++          # Get the command, minus any arguments, for the given
++          # pid. I don't expect this to be compatible cross-platform yet...
++          # This could be complicated cross-platform, and Sys::ProcTable
++          # could likewise be complicated cross-platform ...
++          def self.get_comm_for_pid(pid)
++            result = Vagrant::Util::Subprocess.execute("ps", "-p", pid.to_s, "-o", "comm")
++            result.stdout.split("\n").last
++          end
++
++          def self.autossh_args(port, pidfile, env_hash)
++            ssh_info = env_hash[:machine_ssh_info]
++            ssh_options = {
++              "ServerAliveInterval" => 10,
++              "ServerAliveCountMax" => 3,
++              "StrictHostKeyChecking" => "no",
++            }
++            environment_variables = {
++              env: {
++                "AUTOSSH_PIDFILE" => pidfile,
++                "AUTOSSH_PORT" => 0, # turns off monitoring
++                #"AUTOSSH_LOGFILE" => "./autossh.log",
++              }
++            }
++            forward_string = [
++              port[:hostport],
++              "localhost",
++              port[:guestport]
++            ].join(':')
++
++            autossh_args = []
++            autossh_args << "-q"
++            autossh_args << "-N"
++            autossh_args << "-f"
++            autossh_args << "-i" << env_hash[:machine].data_dir.join("private_key").to_s
++            autossh_args << "-L" << forward_string
++            ssh_options.each do |k, v|
++              autossh_args << "-o" << "#{k}=#{v}"
++            end
++            autossh_args << "#{ssh_info[:username]}@#{ssh_info[:host]}"
++            autossh_args << environment_variables
++          end
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/model/forwarded_port.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/model/forwarded_port.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,70 @@
++module VagrantPlugins
++  module Skytap
++    module Model
++      # Represents a single forwarded port for VirtualBox. This has various
++      # helpers and defaults for a forwarded port.
++      class ForwardedPort
++        # The NAT adapter on which to attach the forwarded port.
++        #
++        # @return [Integer]
++        attr_reader :adapter
++
++        # If true, this port should be auto-corrected.
++        #
++        # @return [Boolean]
++        attr_reader :auto_correct
++
++        # The unique ID for the forwarded port.
++        #
++        # @return [String]
++        attr_reader :id
++
++        # The protocol to forward.
++        #
++        # @return [String]
++        attr_reader :protocol
++
++        # The IP that the forwarded port will connect to on the guest machine.
++        #
++        # @return [String]
++        attr_reader :guest_ip
++
++        # The port on the guest to be exposed on the host.
++        #
++        # @return [Integer]
++        attr_reader :guest_port
++
++        # The IP that the forwarded port will bind to on the host machine.
++        #
++        # @return [String]
++        attr_reader :host_ip
++
++        # The port on the host used to access the port on the guest.
++        #
++        # @return [Integer]
++        attr_reader :host_port
++
++        def initialize(id, host_port, guest_port, options)
++          @id         = id
++          @guest_port = guest_port
++          @host_port  = host_port
++
++          options ||= {}
++          @auto_correct = false
++          @auto_correct = options[:auto_correct] if options.key?(:auto_correct)
++          @adapter  = (options[:adapter] || 1).to_i
++          @guest_ip = options[:guest_ip] || nil
++          @host_ip = options[:host_ip] || nil
++          @protocol = options[:protocol] || "tcp"
++        end
++
++        # This corrects the host port and changes it to the given new port.
++        #
++        # @param [Integer] new_port The new port
++        def correct_host_port(new_port)
++          @host_port = new_port
++        end
++      end
++    end
++  end
++end
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/plugin.rb
+--- a/lib/vagrant-skytap/plugin.rb	Fri Jan 08 11:52:01 2016 -0800
++++ b/lib/vagrant-skytap/plugin.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -49,6 +49,26 @@
+         Cap::PublicAddress
+       end
+ 
++      host_capability("bsd", "start_ssh_tunnel") do
++        require_relative "hosts/bsd/cap/ssh_tunnel"
++        HostBSD::Cap::SSHTunnel
++      end
++
++      host_capability("bsd", "kill_ssh_tunnel") do
++        require_relative "hosts/bsd/cap/ssh_tunnel"
++        HostBSD::Cap::SSHTunnel
++      end
++
++      host_capability("linux", "start_ssh_tunnel") do
++        require_relative "hosts/linux/cap/ssh_tunnel"
++        HostLinux::Cap::SSHTunnel
++      end
++
++      host_capability("linux", "kill_ssh_tunnel") do
++        require_relative "hosts/linux/cap/ssh_tunnel"
++        HostLinux::Cap::SSHTunnel
++      end
++
+       # This initializes the internationalization strings.
+       def self.setup_i18n
+         I18n.load_path << File.expand_path("locales/en.yml", Skytap.source_root)
+diff -r 9277259db23e -r 1c49fba8823c lib/vagrant-skytap/util/compile_forwarded_ports.rb
+--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
++++ b/lib/vagrant-skytap/util/compile_forwarded_ports.rb	Tue Jan 12 18:20:38 2016 -0800
+@@ -0,0 +1,36 @@
++require "vagrant/util/scoped_hash_override"
++require 'vagrant-skytap/model/forwarded_port'
++module VagrantPlugins
++  module Skytap
++    module Util
++      module CompileForwardedPorts
++        include Vagrant::Util::ScopedHashOverride
++
++        # This method compiles the forwarded ports into {ForwardedPort}
++        # models.
++        def compile_forwarded_ports(config)
++          mappings = {}
++
++          config.vm.networks.each do |type, options|
++#            puts type, options
++#            debugger
++            if type == :forwarded_port
++              guest_port = options[:guest]
++              host_port  = options[:host]
++              protocol   = options[:protocol] || "tcp"
++              options    = scoped_hash_override(options, :skytap)
++              id         = options[:id]
++
++              # If the forwarded port was marked as disabled, ignore.
++              next if options[:disabled]
++              mappings[host_port.to_s + protocol.to_s] =
++                Model::ForwardedPort.new(id, host_port, guest_port, options)
++            end
++          end
++
++          mappings.values
++        end
++      end
++    end
++  end
++end