vagrant-skytap 0.2.10 → 0.3.0

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

@@ -21,90 +21,26 @@
 # DEALINGS IN THE SOFTWARE.
 
 require 'vagrant-skytap/api/resource'
-
-class PublishedServiceChoice
-  attr_reader :env, :iface, :service, :execution
-
-  def self.uncreated_choice(env, iface)
-    new(env, iface, nil)
-  end
-
-  def initialize(env, iface, service=nil)
-    @env = env
-    @iface = iface
-    @service = service
-    @execution = ServiceExecution.make(env, iface, service)
-  end
-
-  def to_s
-    execution.message
-  end
-
-  def choose
-    execution.execute
-    @service = execution.service
-    [service.external_ip, service.external_port]
-  end
-
-  def valid?
-    service.nil? || service.internal_port == 22
-  end
-
-  class ServiceExecution
-    def self.make(env, iface, service=nil)
-      if service
-        UseServiceExecution.new(env, iface, service)
-      else
-        CreateAndUseServiceExecution.new(env, iface, service)
-      end
-    end
-
-    attr_reader :env, :iface, :service
-
-    def initialize(env, iface, service)
-      @env = env
-      @iface = iface
-      @service = service
-    end
-  end
-
-  class UseServiceExecution < ServiceExecution
-    def message
-      "Use published service #{service.external_ip}:#{service.external_port}"
-    end
-
-    def execute
-      # No-op
-    end
-  end
-
-  class CreateAndUseServiceExecution < ServiceExecution
-    def message
-      'Create and use published service'
-    end
-
-    def execute
-      @service = iface.create_published_service(22)
-    end
-  end
-end
+require 'vagrant-skytap/api/connectable'
 
 module VagrantPlugins
   module Skytap
     module API
       class PublishedService < Resource
+        include Connectable
+
         attr_reader :interface
 
         reads :id, :internal_port, :external_ip, :external_port
 
+        def self.rest_name
+          "published_service"
+        end
+
         def initialize(attrs, interface, env)
           super
           @interface = interface
         end
-
-        def choice_for_setup
-          PublishedServiceChoice.new(env, self)
-        end
       end
     end
   end

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

@@ -22,6 +22,8 @@
 
 require_relative 'specified_attributes'
 
+# Base class for all resources accessible through the REST API.
+
 module VagrantPlugins
   module Skytap
     module API
@@ -31,8 +33,12 @@ module VagrantPlugins
         attr_reader :attrs, :env
 
         class << self
-          def resource_name
-            name.split("::").last
+          # Resource name suitable for use in URLs. This should be overridden
+          # for classes with camel-cased names (e.g., VpnAttachment).
+          #
+          # @return [String]
+          def rest_name
+            name.split("::").last.downcase
           end
         end
 
@@ -41,15 +47,27 @@ module VagrantPlugins
           @env = args.last
         end
 
+        # The URL for this specific instance. This method should be overridden
+        # for more complex routes such as Rails nested resources.
+        #
+        # @return [String]
         def url
-          "/#{self.class.resource_name.downcase}s/#{id}"
+          "/#{self.class.rest_name}s/#{id}"
         end
 
+        # Re-fetch the object from the API and update attributes.
+        #
+        # @return [API::Resource]
         def reload
           resp = api_client.get(url)
           refresh(JSON.load(resp.body))
         end
 
+        # Replace the object's attributes hash. Subclasses may override this
+        # method to perform additional operations such as discarding cached child
+        # collections.
+        #
+        # @return [API::Resource]
         def refresh(attrs)
           @attrs = attrs
           self
@@ -57,6 +75,10 @@ module VagrantPlugins
 
         private
 
+        # Return a reference to the API client which was passed in when
+        # the object was created.
+        #
+        # @return [API::Client]
         def api_client
           env[:api_client]
         end

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

@@ -0,0 +1,69 @@
+# 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/resource'
+require 'vagrant-skytap/api/network'
+
+# Represents an inter-configuration network routing (ICNR) tunnel,
+# allowing connections between networks in two different environments.
+
+module VagrantPlugins
+  module Skytap
+    module API
+      class Tunnel < Resource
+        reads :status
+        attr_reader :source_network, :target_network
+
+        class << self
+          # Creates a tunnel between two networks in different environments.
+          # The API response includes information about both networks, but
+          # omits their tunnel collections, so no attempt is made to update
+          # the network objects automatically.
+          #
+          # @param [Hash] env The environment hash
+          # @param [API::Network] network The network making the connection
+          # @param [API::Network] other_network The tunnelable network being
+          #   connected to
+          # @return [API::Tunnel]
+          def create!(env, network, other_network)
+            params = {source_network_id: network.id, target_network_id: other_network.id}
+            resp = env[:api_client].post("/tunnels", JSON.dump(params))
+            new(JSON.load(resp.body), env)
+          end
+        end
+
+        def initialize(attrs, env)
+          super
+          @source_network = Network.new(get_api_attribute('source_network'), env[:environment], env)
+          @target_network = Network.new(get_api_attribute('target_network'), env[:environment], env)
+        end
+
+        # Indicates whether the tunnel is busy.
+        #
+        # @return [Boolean]
+        def busy?
+          status == "busy"
+        end
+      end
+    end
+  end
+end

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

@@ -32,7 +32,6 @@ module VagrantPlugins
         include RunstateOperations
 
         attr_reader :provider_config
-        attr_reader :environment
 
         reads :id, :interfaces, :credentials, :name, :configuration_url, :template_url
 
@@ -46,7 +45,7 @@ module VagrantPlugins
 
         def initialize(attrs, environment, env)
           super
-          @environment = environment
+          @parent = environment
           @provider_config = env[:machine].provider_config
         end
 
@@ -62,6 +61,14 @@ module VagrantPlugins
           end
         end
 
+        def get_interfaces_by_id(ids)
+          interfaces.select{|iface| ids.include?(iface.id)}
+        end
+
+        def get_interface_by_id(id)
+          get_interfaces_by_id([id]).first
+        end
+
         def credentials
           @credentials ||= (get_api_attribute('credentials') || []).collect do |cred_attrs|
             Credentials.new(cred_attrs, self, env)
@@ -93,6 +100,7 @@ module VagrantPlugins
         def parent
           @parent ||= Environment.fetch(env, parent_url)
         end
+        alias_method :environment, :parent
 
         def region
           @region ||= parent.region

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

@@ -23,113 +23,13 @@
 require 'vagrant-skytap/util/subnet'
 require 'vagrant-skytap/api/resource'
 require 'vagrant-skytap/api/vpn_attachment'
-
-class VpnChoice
-  attr_reader :env, :vpn, :vm, :iface, :attachment, :execution
-
-  def initialize(env, vpn, vm)
-    @env = env
-    @vpn = vpn
-    @vm = vm
-    @iface = vm.interfaces.select(&:network).tap do |ifaces|
-      unless vpn.nat_enabled?
-        ifaces.select! {|i| vpn.subsumes?(i.network) }
-      end
-    end.first
-    @execution = AttachmentExecution.make(env, vpn, iface)
-  end
-
-  def to_s
-    "#{execution.verb} VPN: #{vpn.name}".tap do |ret|
-      if vpn.nat_enabled?
-        ret << " (NAT-enabled)"
-      else
-        ret << " (local subnet: #{vpn.local_subnet})"
-      end
-    end
-  end
-
-  def choose
-    execution.execute
-
-    @iface = vm.reload.interfaces.detect{|i| i.id == iface.id }
-    host = iface.address_for(vpn)
-    port = 22
-
-    [host, port]
-  end
-
-  def valid?
-    true
-  end
-
-  class AttachmentExecution
-    attr_reader :env, :vpn, :iface, :attachment
-
-    def self.make(env, vpn, iface)
-      attachment = iface.attachment_for(vpn)
-
-      if attachment.try(:connected?)
-        UseAttachmentExecution.new(env, vpn, iface, attachment)
-      elsif attachment
-        ConnectAttachmentExecution.new(env, vpn, iface, attachment)
-      else
-        CreateAttachmentExecution.new(env, vpn, iface)
-      end
-    end
-
-    def initialize(env, vpn, iface, attachment=nil)
-      @env = env
-      @vpn = vpn
-      @iface = iface
-      @attachment = attachment
-    end
-
-    def verb
-      raise NotImplementedError.new('Must override')
-    end
-
-    def execute
-      raise NotImplementedError.new('Must override')
-    end
-  end
-
-  class UseAttachmentExecution < AttachmentExecution
-    def verb
-      'Use'
-    end
-
-    def execute
-      # No-op
-    end
-  end
-
-  class ConnectAttachmentExecution < AttachmentExecution
-    def verb
-      'Connect to and use'
-    end
-
-    def execute
-      attachment.connect!
-    end
-  end
-
-  class CreateAttachmentExecution < AttachmentExecution
-    def verb
-      'Attach to and use'
-    end
-
-    def execute
-      @attachment = VagrantPlugins::Skytap::API::VpnAttachment.create(iface.network, vpn, env)
-      @attachment.connect!
-    end
-  end
-end
+require 'vagrant-skytap/api/connectable'
 
 module VagrantPlugins
   module Skytap
     module API
       class Vpn < Resource
+        include Connectable
 
         class << self
           def all(env, options = {})
@@ -146,10 +46,6 @@ module VagrantPlugins
 
         reads :id, :local_subnet, :name, :nat_local_subnet
 
-        def choice_for_setup(vm)
-          VpnChoice.new(env, self, vm)
-        end
-
         def nat_enabled?
           !!nat_local_subnet
         end

data/lib/vagrant-skytap/cap/host_metadata.rb

@@ -0,0 +1,45 @@
+# 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 "socket"
+require "net/http"
+
+module VagrantPlugins
+  module Skytap
+    module Cap
+      module HostMetadata
+
+        # Attempt to retrieve information about the Vagrant host
+        # from the metadata service. If found, we're running in a
+        # Skytap VM.
+        def self.host_metadata(machine)
+          begin
+            http = Net::HTTP.new("gw", 80)
+            response = http.request(Net::HTTP::Get.new("/skytap"))
+            JSON.parse(response.body) if response.is_a?(Net::HTTPOK)
+          rescue SocketError, Net::HTTPNotFound => ex
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/connection/public_ip_choice.rb

@@ -0,0 +1,94 @@
+# 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 Connection
+      class PublicIpChoice < Choice
+        attr_reader :ip
+
+        def initialize(env, ip, iface)
+          @env = env
+          @ip = ip
+          @iface = iface
+          @execution = PublicIpAttachmentExecution.make(env, iface, ip)
+        end
+
+        def choose
+          execution.execute
+
+          host = ip.address
+          [host, DEFAULT_PORT]
+        end
+
+        class PublicIpAttachmentExecution < Execution
+          attr_reader :ip
+
+          def self.make(env, iface, ip)
+            if ip.attached?
+              UseExecution.new(env, iface, ip)
+            else
+              AttachAndUseExecution.new(env, iface, ip)
+            end
+          end
+
+          def initialize(env, iface, ip)
+            super
+            @ip = ip
+          end
+
+          def message
+            "#{verb}: #{ip.address}".tap do |ret|
+              if ip.deployed?
+                ret << " " << I18n.t("vagrant_skytap.connections.public_ip.deployed")
+              elsif ip.attached?
+                ret << " " << I18n.t("vagrant_skytap.connections.public_ip.attached")
+              end
+            end
+          end
+        end
+
+        class UseExecution < PublicIpAttachmentExecution
+          def verb
+            I18n.t("vagrant_skytap.connections.public_ip.verb_use")
+          end
+
+          def execute
+            # No-op
+          end
+        end
+
+        class AttachAndUseExecution < PublicIpAttachmentExecution
+          def verb
+            I18n.t("vagrant_skytap.connections.public_ip.verb_attach")
+          end
+
+          def execute
+            iface.attach_public_ip(ip)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/connection/published_service_choice.rb

@@ -0,0 +1,100 @@
+# 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 Connection
+      class PublishedServiceChoice < Choice
+        attr_reader :service
+
+        def self.uncreated_choice(env, iface)
+          new(env, iface, nil)
+        end
+
+        def initialize(env, iface, service=nil)
+          @env = env
+          @iface = iface
+          @service = service
+          @execution = PublishedServiceExecution.make(env, iface, service)
+        end
+
+        def choose
+          execution.execute
+          @service = execution.service
+          [service.external_ip, service.external_port]
+        end
+
+        def valid?
+          service.nil? || service.internal_port == DEFAULT_PORT
+        end
+
+        class PublishedServiceExecution < Execution
+          attr_reader :service
+
+          def self.make(env, iface, service=nil)
+            if service
+              UseExecution.new(env, iface, service)
+            else
+              CreateAndUseExecution.new(env, iface, service)
+            end
+          end
+
+          def initialize(env, iface, service)
+            @env = env
+            @iface = iface
+            @service = service
+          end
+
+          def message
+            verb.tap do |ret|
+              if self.is_a?(UseExecution)
+                ret << " #{service.external_ip}:#{service.external_port}"
+              end
+            end
+          end
+        end
+
+        class UseExecution < PublishedServiceExecution
+          def verb
+            I18n.t("vagrant_skytap.connections.published_service.verb_use")
+          end
+
+          def execute
+            # No-op
+          end
+        end
+
+        class CreateAndUseExecution < PublishedServiceExecution
+          def verb
+            I18n.t("vagrant_skytap.connections.published_service.verb_create_and_use")
+          end
+
+          def execute
+            @service = iface.create_published_service(DEFAULT_PORT)
+          end
+        end
+      end
+    end
+  end
+end