vagrant-skytap 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 489ea945efd6c1515171a6aa12fc3dff169acc6a
-  data.tar.gz: 9e32a36b3d528047f7f4ab87a2f6a58ec41a75c2
+  metadata.gz: 4a5a789108c848d82077b5a1d094a784603116ef
+  data.tar.gz: abf71c4beeec288a9d6332dce9c788ef0f9cb957
 SHA512:
-  metadata.gz: a14d3e7fd76c84f23128fb04e31650f95cc229aed47b01184b6ab8b548f49b6399c166fe19360854e615378e42d14d1ba2ce2b72a2402490f70f3e3737b46784
-  data.tar.gz: 7f038b87db83b4568a038eac6feb6f0d178ba567c8577c7465a643bb5760d2c594ccd28de994eca50199de027cdc24f669377005e5af2e7b06c358bf8d6353cf
+  metadata.gz: e90ed82be35afc441c0b84a7c270ad30d36ceb5a2010538df3b9fd800bf8cd8fdec755c2f035f34d3ac0a58cf12364c6c8ca1964ba340ef4581c51afcea02319
+  data.tar.gz: f3a501db191b0fca564b7401e936854221f0adc77342cc0d153b851e56026204916d20bbe79dbb4ce4075a57410523007e7921a34184f39136e00b7328e67eda

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0 (April 13, 2016)
+
+* New functionality to support running Vagrant from within a Skytap VM. The connection between host and
+  guest will be made over a network tunnel between the two Skytap environments.
+* `vagrant ssh` now shows the expected error when the machine is not running.
+* Support unattended `vagrant up` by automatically choosing the only available connection option.  
+
 # 0.2.10 (March 17, 2016)
 
 * Fix bug in port forwarding messaging.

data/lib/vagrant-skytap/action/check_created.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2014-2016 Skytap, Inc.
+#
+# The MIT License (MIT)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+module VagrantPlugins
+  module Skytap
+    module Action
+      # This middleware checks that the VM is created, and raises an exception
+      # if it is not, notifying the user that creation is required.
+      class CheckCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].state.id == :not_created
+            raise Vagrant::Errors::VMNotCreatedError
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/action/check_running.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2014-2016 Skytap, Inc.
+#
+# The MIT License (MIT)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+module VagrantPlugins
+  module Skytap
+    module Action
+      # This middleware checks that the VM is running, and raises an exception
+      # if it is not, notifying the user that the VM must be running.
+      class CheckRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].state.id != :running
+            raise Vagrant::Errors::VMNotRunningError
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/action/get_host_vm.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 2014-2016 Skytap, Inc.
+#
+# The MIT License (MIT)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+require "vagrant-skytap/api/vm"
+
+module VagrantPlugins
+  module Skytap
+    module Action
+      # If Vagrant is running in a Skytap VM, retrieve the VM's metadata,
+      # instantiate the VM, and store the result in env[:vagrant_host_vm].
+      # The request does not go through the REST API, so it can be made
+      # without an api token.
+      class GetHostVM
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_skytap::action::get_host_metadata")
+        end
+
+        def call(env)
+          unless env[:vagrant_host_vm]
+            if metadata = env[:machine].provider.capability(:host_metadata)
+              # The environment will be lazy loaded
+              env[:vagrant_host_vm] = vm = API::Vm.new(metadata, nil, env)
+              @logger.info("Running Vagrant in a Skytap VM. ID: #{vm.try(:id)}")
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/action/prepare_nfs_settings.rb

@@ -20,11 +20,15 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 # DEALINGS IN THE SOFTWARE.
 
+require_relative 'action_helpers'
+
 module VagrantPlugins
   module Skytap
     module Action
       class PrepareNFSSettings
-        attr_reader :env, :machine
+        include ActionHelpers
+
+        attr_reader :env, :machine, :host_vm
 
         def initialize(app,env)
           @app = app
@@ -34,6 +38,7 @@ module VagrantPlugins
 
         def call(env)
           @machine = env[:machine]
+          @host_vm = env[:vagrant_host_vm]
 
           if using_nfs?
             env[:nfs_host_ip] = read_host_ip
@@ -59,13 +64,25 @@ module VagrantPlugins
         end
 
         # Returns the IP address of the host, preferring one on an interface
-        # which the client can route to.
+        # which the client can route to. If we're running in a Skytap VM, and
+        # the guest's network is NAT-enabled, the host VM will have been
+        # assigned a NAT address which can be determined from its metadata.
         #
         # @return [String]
         def read_host_ip
-          UDPSocket.open do |s|
-            s.connect(machine.ssh_info[:host], 1)
-            s.addr.last
+          if host_vm
+            host_iface = host_vm.reload.interfaces.first
+            guest_network = current_vm(env).interfaces.first.network
+          end
+
+          if guest_network.try(:nat_enabled?)
+            host_iface.nat_address_for_network(guest_network)
+          else
+            UDPSocket.open do |s|
+              s.connect(machine.ssh_info[:host], 1)
+              @logger.debug("PrepareNFSSettings#read_host_ip found the following addresses #{s.addr}")
+              s.addr.last
+            end
           end.tap do |ret|
             @logger.debug("PrepareNFSSettings#read_host_ip returning #{ret}")
           end

data/lib/vagrant-skytap/action.rb

@@ -171,29 +171,17 @@ module VagrantPlugins
       # This action is called to SSH into the machine.
       def self.action_ssh
         Vagrant::Action::Builder.new.tap do |b|
-          b.use action_fetch_environment
-          b.use Call, ExistenceCheck do |env1, b1|
-            case result = env1[:result]
-            when :missing_environment, :missing_vm, :no_vms
-              b1.use MessageNotCreated
-            else
-              b1.use SSHExec
-            end
-          end
+          b.use CheckCreated
+          b.use CheckRunning
+          b.use SSHExec
         end
       end
 
       def self.action_ssh_run
         Vagrant::Action::Builder.new.tap do |b|
-          b.use action_fetch_environment
-          b.use Call, ExistenceCheck do |env1, b1|
-            case result = env1[:result]
-            when :missing_environment, :missing_vm, :no_vms
-              b1.use MessageNotCreated
-            else
-              b1.use SSHRun
-            end
-          end
+          b.use CheckCreated
+          b.use CheckRunning
+          b.use SSHRun
         end
       end
 
@@ -204,6 +192,7 @@ module VagrantPlugins
       # later in the sequence.
       def self.action_prepare_boot
         Vagrant::Action::Builder.new.tap do |b|
+          b.use GetHostVM
           b.use PrepareNFSSettings
           b.use PrepareNFSValidIds
           b.use Provision
@@ -258,6 +247,7 @@ module VagrantPlugins
       def self.action_update_hardware
         Vagrant::Action::Builder.new.tap do |b|
           b.use StoreExtraData
+          b.use GetHostVM
           b.use SetUpVm
           b.use Call, IsStopped do |env, b1|
             if env[:result]
@@ -342,6 +332,8 @@ module VagrantPlugins
       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 :CheckCreated, action_root.join("check_created")
+      autoload :CheckRunning, action_root.join("check_running")
       autoload :ClearForwardedPorts, action_root.join("clear_forwarded_ports")
       autoload :ComposeEnvironment, action_root.join("compose_environment")
       autoload :CreateEnvironment, action_root.join("create_environment")
@@ -350,6 +342,7 @@ module VagrantPlugins
       autoload :ExistenceCheck, action_root.join("existence_check")
       autoload :FetchEnvironment, action_root.join("fetch_environment")
       autoload :ForwardPorts, action_root.join("forward_ports")
+      autoload :GetHostVM, action_root.join("get_host_vm")
       autoload :InitializeAPIClient, action_root.join("initialize_api_client")
       autoload :InitialState, action_root.join("initial_state")
       autoload :IsParallelized, action_root.join("is_parallelized")

data/lib/vagrant-skytap/api/connectable.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2014-2016 Skytap, Inc.
+#
+# The MIT License (MIT)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+require 'vagrant-skytap/connection'
+
+module VagrantPlugins
+  module Skytap
+    module API
+      module Connectable
+        # Determine the corresponding [Connection::Choice] subclass for this
+        # resource type; e.g. for [API::Vpn] this would return
+        # [Connection::VpnChoice]. This method may be overridden where the
+        # class name varies from this pattern.
+        #
+        # @return [Class]
+        def connection_choice_class
+          require "vagrant-skytap/connection/#{self.class.rest_name}_choice"
+          Class.const_get("VagrantPlugins::Skytap::Connection::#{self.class.name.split('::').last}Choice")
+        end
+
+        # Return a choice object representing the potential to connect
+        # via this resource. Arguments depend on resource type.
+        #
+        # @return [Connection::Choice]
+        def choice_for_setup(*args)
+          connection_choice_class.new(env, self, *args)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/api/environment.rb

@@ -100,7 +100,7 @@ module VagrantPlugins
         attr_reader :provider_config
         attr_reader :vms, :networks
 
-        reads :id, :name, :vms, :networks, :region, :runstate, :url, :region
+        reads :id, :name, :vms, :networks, :region, :runstate, :url, :routable
 
         def initialize(attrs, env)
           super
@@ -133,10 +133,6 @@ module VagrantPlugins
           end
         end
 
-        def region
-          get_api_attribute('region')
-        end
-
         def refresh(attrs)
           @vms = nil
           @networks = nil
@@ -185,6 +181,15 @@ module VagrantPlugins
         def properties
           @properties ||= EnvironmentProperties.new(env[:machine].env.local_data_path)
         end
+
+        # Indicates whether traffic will be routed between networks within this
+        # environment. (This is different from routing traffic to/from a network
+        # within another environment, which requires an ICNR tunnel.)
+        #
+        # @return [Boolean]
+        def routable?
+          !!routable
+        end
       end
     end
   end

data/lib/vagrant-skytap/api/interface.rb

@@ -86,6 +86,11 @@ module VagrantPlugins
           end
         end
 
+        def nat_address_for_network(network)
+          nat_address = network_nat_addresses.find{|addr| addr['network_id'].to_i == network.id.to_i}
+          nat_address['ip_address'] if nat_address
+        end
+
         def vpn_attachments
           if network
             network.vpn_attachments
@@ -98,6 +103,10 @@ module VagrantPlugins
           nat_addresses['vpn_nat_addresses'] || []
         end
 
+        def network_nat_addresses
+          nat_addresses['network_nat_addresses'] || []
+        end
+
         def nat_addresses
           get_api_attribute('nat_addresses') || {}
         end

data/lib/vagrant-skytap/api/network.rb

@@ -22,23 +22,32 @@
 
 require 'vagrant-skytap/api/resource'
 require 'vagrant-skytap/api/vpn_attachment'
+require 'vagrant-skytap/api/tunnel'
 require 'vagrant-skytap/util/subnet'
+require 'vagrant-skytap/api/connectable'
 
 module VagrantPlugins
   module Skytap
     module API
       class Network < Resource
+        include Connectable
+
         attr_reader :environment
 
-        reads :id, :subnet, :vpn_attachments
+        reads :id, :subnet, :nat_subnet, :vpn_attachments, :name
 
         def initialize(attrs, environment, env)
           super
           @environment = environment
         end
 
+        def url
+          "/configurations/#{environment.id}/networks/#{id}"
+        end
+
         def refresh(attrs)
           @vpn_attachments = nil
+          @tunnels = nil
           super
         end
 
@@ -56,6 +65,56 @@ module VagrantPlugins
           vpn = vpn.id unless vpn.is_a?(String)
           vpn_attachments.detect {|att| att.vpn['id'] == vpn}
         end
+
+        # Indicates whether this network is NAT-enabled.
+        #
+        # @return [Boolean]
+        def nat_enabled?
+          nat_subnet.present?
+        end
+
+        # Indicates whether networks in other environments may connect
+        # to this one.
+        #
+        # @return [Boolean]
+        def tunnelable?
+          get_api_attribute('tunnelable')
+        end
+
+        # The set of ICNR tunnels connecting this network to networks in other
+        # environments.
+        #
+        # @returns [Array] of [API::Tunnel]
+        def tunnels
+          @tunnels ||= (get_api_attribute('tunnels') || []).collect do |tunnel_attrs|
+            Tunnel.new(tunnel_attrs, env)
+          end
+        end
+
+        # Connects to a network in another environment via an ICNR tunnel.
+        #
+        # @param [API::Network] other_network The network to connect to.
+        def connect_to_network(other_network)
+          API::Tunnel.create!(env, self, other_network)
+          updated_network = environment.reload.networks.find{|n| n.id == id}
+          refresh(updated_network.attrs)
+        end
+
+        # Indicates whether an ICNR tunnel exists between this network and the
+        # given network in another environment. (For networks within the same
+        # environment, check the environment's #routable? flag instead.)
+        #
+        # @return [Boolean]
+        def connected_to_network?(other_network)
+          tunnels.any? do |tunnel|
+            tunnel.target_network.id == other_network.id || tunnel.source_network.id == other_network.id
+          end
+        end
+
+        def connection_choice_class
+          require "vagrant-skytap/connection/tunnel_choice"
+          Class.const_get("VagrantPlugins::Skytap::Connection::TunnelChoice")
+        end
       end
     end
   end

data/lib/vagrant-skytap/api/public_ip.rb

@@ -21,82 +21,18 @@
 # DEALINGS IN THE SOFTWARE.
 
 require 'vagrant-skytap/api/resource'
-
-class PublicIpChoice
-  attr_reader :env, :ip, :iface, :execution
-
-  def initialize(env, ip, iface)
-    @env = env
-    @ip = ip
-    @iface = iface
-    @execution = AttachmentExecution.make(env, ip, iface)
-  end
-
-  def to_s
-    "#{execution.verb} public IP: #{ip.address}".tap do |ret|
-      if ip.deployed?
-        ret << ' (attached and deployed to another VM)'
-      elsif ip.attached?
-        ret << ' (attached to another VM)'
-      end
-    end
-  end
-
-  def choose
-    execution.execute
-
-    host = ip.address
-    port = 22
-    [host, port]
-  end
-
-  def valid?
-    true
-  end
-
-  class AttachmentExecution
-    def self.make(env, ip, iface)
-      if ip.attached?
-        UseAttachmentExecution.new(env, ip, iface)
-      else
-        AttachAndUseExecution.new(env, ip, iface)
-      end
-    end
-
-    attr_reader :env, :ip, :iface
-
-    def initialize(env, ip, iface)
-      @env = env
-      @ip = ip
-      @iface = iface
-    end
-  end
-
-  class UseAttachmentExecution < AttachmentExecution
-    def verb
-      'Use'
-    end
-
-    def execute
-      # No-op
-    end
-  end
-
-  class AttachAndUseExecution < AttachmentExecution
-    def verb
-      'Attach and use'
-    end
-
-    def execute
-      iface.attach_public_ip(ip)
-    end
-  end
-end
+require 'vagrant-skytap/api/connectable'
 
 module VagrantPlugins
   module Skytap
     module API
       class PublicIp < Resource
+        include Connectable
+
+        def self.rest_name
+          "public_ip"
+        end
+
         attr_reader :interface
 
         reads :id, :address, :nics
@@ -107,10 +43,6 @@ module VagrantPlugins
           @interface = interface
         end
 
-        def choice_for_setup(iface)
-          PublicIpChoice.new(env, self, iface)
-        end
-
         def attached?
           interface || nics.present?
         end

data/lib/vagrant-skytap/api/publish_set.rb

@@ -30,6 +30,10 @@ module VagrantPlugins
         attr_reader :environment
         reads :id, :url, :desktops_url
 
+        def self.rest_name
+          "publish_set"
+        end
+
         def initialize(attrs, environment, env)
           super
           @environment = environment