vagrant-skytap 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a5a789108c848d82077b5a1d094a784603116ef
-  data.tar.gz: abf71c4beeec288a9d6332dce9c788ef0f9cb957
+  metadata.gz: dae76ca9f326fc61d315aed14516cb4d62a03276
+  data.tar.gz: c26500f1f04d28b9325f3487369ea89106788437
 SHA512:
-  metadata.gz: e90ed82be35afc441c0b84a7c270ad30d36ceb5a2010538df3b9fd800bf8cd8fdec755c2f035f34d3ac0a58cf12364c6c8ca1964ba340ef4581c51afcea02319
-  data.tar.gz: f3a501db191b0fca564b7401e936854221f0adc77342cc0d153b851e56026204916d20bbe79dbb4ce4075a57410523007e7921a34184f39136e00b7328e67eda
+  metadata.gz: 1fc8c6e878f55c34c81e6475ad67dbd3a3c759c28eeb9ca678b1db2e8599061d79263787837fdc9217c2eff6bf738c2dd5d26d8c03a6b0c0d7ff3555110030ae
+  data.tar.gz: afa804091a15ffda3cf6478ef6def6d5527fb958dc7daf908109265f347f4c707792aa9a2cea147e046d3630cb3cfe7a537d2f7f27d8bd846ddaa7f7beb15459

data/.gitignore

@@ -13,8 +13,7 @@ Gemfile.lock
 
 # Vagrant
 .vagrant
-Vagrantfile
-!example_box/Vagrantfile
+/Vagrantfile
 
 # RVM files for gemset/ruby setting
 .ruby-*

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.1 (April 15, 2016)
+
+* Add support for running in a Skytap VM when the VM's network is using a custom DNS.
+
 # 0.3.0 (April 13, 2016)
 
 * New functionality to support running Vagrant from within a Skytap VM. The connection between host and

data/boxes/Vagrantfile

@@ -0,0 +1,8 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.vm.provider :skytap do |skytap|
+    skytap.vm_url = "https://cloud.skytap.com/vms/3157858"
+  end
+end

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

@@ -22,22 +22,63 @@
 
 require "socket"
 require "net/http"
+require "log4r"
 
 module VagrantPlugins
   module Skytap
     module Cap
       module HostMetadata
+        METADATA_LINK_LOCAL_ADDRESS = '169.254.169.254'
+        OPEN_TIMEOUT = 2
+        READ_TIMEOUT = 5
 
-        # Attempt to retrieve information about the Vagrant host
-        # from the metadata service. If found, we're running in a
-        # Skytap VM.
+        # If Vagrant is running in a Skytap VM, returns metadata from which an
+        # [API::Vm] can be constructed. Otherwise returns nil.
+        #
+        # @param [Vagrant::Machine] machine The guest machine (ignored).
+        # @return [Hash] or [NilClass]
         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
+          logger = Log4r::Logger.new("vagrant_skytap::cap::host_metadata")
+
+          # There are two addresses to try for the metadata service. If using
+          # the default DNS, 'gw' will resolve to the endpoint address. If
+          # using custom DNS, be prepared to fall back to the hard-coded IP
+          # address.
+          ['gw', METADATA_LINK_LOCAL_ADDRESS].each do |host|
+            begin
+              http = Net::HTTP.new(host)
+              http.open_timeout = OPEN_TIMEOUT
+              http.read_timeout = READ_TIMEOUT
+
+              # Test for a working web server before actually hitting the
+              # metadata service. The response is expected to be 404.
+              http.request(Net::HTTP::Get.new("/"))
+
+              begin
+                response = http.request(Net::HTTP::Get.new("/skytap"))
+              rescue Timeout::Error => ex
+                raise Errors::MetadataServiceUnavailable
+              end
+
+              if response.is_a?(Net::HTTPServerError)
+                raise Errors::MetadataServiceUnavailable
+              elsif response.is_a?(Net::HTTPOK)
+                attrs = JSON.parse(response.body)
+                return attrs if attrs.key?('configuration_url')
+                logger.debug("The JSON retrieved was not VM metadata! Ignoring.")
+              end
+            rescue SocketError => ex
+              logger.debug("Could not resolve hostname '#{host}'.")
+            rescue Errno::ENETUNREACH => ex
+              logger.debug("No route exists for '#{host}'.")
+            rescue Timeout::Error => ex
+              logger.debug("Response timed out for '#{host}'.")
+            rescue JSON::ParserError
+              logger.debug("Response from '#{host}' was garbled.")
+            end
           end
+
+          nil
         end
       end
     end

data/lib/vagrant-skytap/errors.rb

@@ -100,6 +100,10 @@ module VagrantPlugins
       class VmParentMismatch < VagrantSkytapError
         error_key(:vm_parent_mismatch)
       end
+
+      class MetadataServiceUnavailable < VagrantSkytapError
+        error_key(:metadata_service_unavailable)
+      end
     end
   end
 end

data/lib/vagrant-skytap/version.rb

@@ -22,6 +22,6 @@
 
 module VagrantPlugins
   module Skytap
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/locales/en.yml

@@ -121,6 +121,10 @@ en:
       feature_not_supported_for_host_os: |-
         The %{feature_name} feature is currently not supported for your host operating system.
 
+      metadata_service_unavailable: |-
+        You appear to be running Vagrant in a Skytap VM. There was an error retrieving
+        information about this VM. Please retry later.
+
     states:
       short_not_created: |-
         not created

data/spec/acceptance/base.rb

@@ -0,0 +1,25 @@
+# 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-spec/acceptance"
+require_relative "shared/context_skytap"
+

data/spec/acceptance/shared/context_skytap.rb

@@ -0,0 +1,25 @@
+# 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.
+
+shared_context "provider-context/skytap" do
+
+end

data/spec/acceptance/skeletons/generic/Vagrantfile

@@ -0,0 +1,3 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "skytap/ubuntu-1204-x64-us-west"
+end

data/spec/unit/cap/host_metadata_spec.rb

@@ -24,20 +24,99 @@ require File.expand_path("../../base", __FILE__)
 require "vagrant-skytap/cap/host_metadata"
 
 describe VagrantPlugins::Skytap::Cap::HostMetadata do
-  let(:machine) { double("machine") }
+  include_context "skytap"
+
+  let(:machine)   { double(:machine) }
+  let(:metadata)  { {"id" => 1, "configuration_url" => "foo"} }
+  let(:metadata1) { metadata }
+  let(:metadata2) { metadata }
+  let(:status)    { 200 }
+  let(:status1)   { status }
+  let(:status2)   { status }
 
   before do
-    stub_request(:get, %r{http://gw/skytap}).to_return(body: '', status: 404)
+    stub_request(:any, /.*/).to_return(body: "", status: 404)
+    stub_request(:get, "http://gw/skytap").to_return(body: JSON.dump(metadata1), status: status1)
+    stub_request(:get, "http://169.254.169.254/skytap").to_return(body: JSON.dump(metadata2), status: status2)
+  end
+
+  def assert_fallback_to_ip
+    expect(a_request(:get, "http://169.254.169.254/")).to have_been_made
+  end
+
+  def assert_no_fallback_to_ip
+    expect(a_request(:get, "http://169.254.169.254/")).not_to have_been_made
   end
 
   describe "host_metadata" do
-    it "returns nil if the metadata is not found" do
-      expect(described_class.host_metadata(machine)).to be nil
+    subject do
+      described_class.host_metadata(machine)
+    end
+
+    context "when default DNS is in use" do
+      it "should get the metadata from gw" do
+        expect(subject).to eq metadata
+        assert_no_fallback_to_ip
+      end
+
+      context "when metadata service is down" do
+        before do
+          stub_request(:get, "http://gw/skytap").to_timeout
+        end
+        it "should raise an exception without retrying" do
+          expect{subject}.to raise_error(Errors::MetadataServiceUnavailable)
+          assert_no_fallback_to_ip
+        end
+      end
+
+      context "when metadata service returns an error" do
+        let(:status1) { 500 }
+        it "should raise an exception without retrying" do
+          expect{subject}.to raise_error(Errors::MetadataServiceUnavailable)
+          assert_no_fallback_to_ip
+        end
+      end
     end
 
-    it "returns the metadata if found" do
-      stub_request(:get, %r{http://gw/skytap}).to_return(body: '{"id": 1}', status: 200)
-      expect(described_class.host_metadata(machine)).to eq({"id" => 1})
+    context "when custom DNS is in use" do
+      context "when gw resolves to some random web server" do
+        let(:metadata1) { 'hello' }
+        it "should fall back to the fixed IP address" do
+          expect(subject).to eq metadata
+          assert_fallback_to_ip
+        end
+      end
+
+      context "when gw times out" do
+        before do
+          stub_request(:get, "http://gw/").to_timeout
+        end
+        it "should fall back to the fixed IP address" do
+          expect(subject).to eq metadata
+          assert_fallback_to_ip
+        end
+      end
+
+      context "when gw cannot be resolved" do
+        before do
+          stub_request(:get, "http://gw/").to_raise(SocketError)
+        end
+        it "should fall back to the fixed IP address" do
+          expect(subject).to eq metadata
+          assert_fallback_to_ip
+        end
+
+        # Or maybe this isn't a Skytap VM.
+        context "when fixed IP address is unreachable" do
+          before do
+            stub_request(:get, "http://169.254.169.254/").to_raise(Errno::ENETUNREACH)
+          end
+          it "should return nil" do
+            expect(subject).to eq nil
+            assert_fallback_to_ip
+          end
+        end
+      end
     end
   end
 end

data/vagrant-spec.config.rb

@@ -0,0 +1,10 @@
+require_relative "spec/acceptance/base"
+
+Vagrant::Spec::Acceptance.configure do |c|
+  c.component_paths << File.expand_path("../spec/acceptance", __FILE__)
+  c.skeleton_paths << File.expand_path("../spec/acceptance/skeletons", __FILE__)
+
+  c.provider "skytap",
+    box: File.expand_path("../skytap-test.box", __FILE__),
+    contexts: ["provider-context/skytap"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-skytap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Eric True
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -120,6 +120,7 @@ files:
 - boxes/empty.box
 - boxes/metadata.json
 - boxes/README.md
+- boxes/Vagrantfile
 - CHANGELOG.md
 - Gemfile
 - lib/vagrant-skytap/action/action_helpers.rb
@@ -222,6 +223,9 @@ files:
 - locales/en.yml
 - Rakefile
 - README.md
+- spec/acceptance/base.rb
+- spec/acceptance/shared/context_skytap.rb
+- spec/acceptance/skeletons/generic/Vagrantfile
 - spec/spec_helper.rb
 - spec/unit/actions/compose_environment_spec.rb
 - spec/unit/actions/prepare_nfs_settings_spec.rb
@@ -268,6 +272,7 @@ files:
 - tasks/bundler.rake
 - tasks/test.rake
 - vagrant-skytap.gemspec
+- vagrant-spec.config.rb
 - .gitignore
 homepage: http://www.skytap.com
 licenses: