vagrant-skytap 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df35f6df87630a3718560fe3900aa38b7eb7d946
-  data.tar.gz: 98caf819eed011f11be89c6072c5df6e3a8a4664
+  metadata.gz: ba60765d51a7600c51ba087d57506e1f469c03dc
+  data.tar.gz: 1629dbd77eede4f26f948f1ed65e1e24416ac3ba
 SHA512:
-  metadata.gz: d3798da927dafe1c1f69b8b2f5bbe5fb8ef8480c71fce6866f7ce268c476b7be4ce9ed0226e683e493f957d492d799c67ea9798e273f208fdce1ba32ca61c71c
-  data.tar.gz: 0641307fac52c06148d0554eae1455783834fe745a7bf7432086e27d9001a55660d3e3f41392df8561e69d52be4c78248954cf0aa5b981e6078f75666243747a
+  metadata.gz: f8516f76818cee5c9cb7cebcc9a01b91a94f4be9de223bc21d8b48eb1e6385c0f233e8d4b2daf37e649aa0352069eef227e5c6f1f80896cc790c7d86819843b4
+  data.tar.gz: 701d24018b94c72f42c95d7829285ed60004cb2ddf111a063d02d907853c198948ab043fe2a50d0bc0702c29ae28f762af837e88a6eef23cce314fce48d08a6f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.7 (February 19, 2016)
+
+* Add User-Agent string with the plugin version and Vagrant version.
+
+* Fix bug which coud cause machines to be mapped to the wrong VMs.
+
 # 0.2.6 (February 16, 2016)
 
 * Changes to support logging in to base boxes with the default `vagrant` user and

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

@@ -20,7 +20,6 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 # DEALINGS IN THE SOFTWARE.
 
-require 'log4r'
 require 'vagrant-skytap/api/environment'
 require 'vagrant-skytap/api/vm'
 
@@ -70,6 +69,7 @@ module VagrantPlugins
         # @return [API::Environment] The new or existing environment
         def add_vms(environment, machines)
           source_vms_map = fetch_source_vms(machines)
+          names_to_vm_ids = {}
 
           get_groupings(source_vms_map, parallel: @env[:parallel]).each do |names|
             vms_for_pass = names.collect{|name| source_vms_map[name]}
@@ -84,9 +84,11 @@ module VagrantPlugins
               vms = environment.add_vms(vms_for_pass)
             end
 
-            machines.select{|m| names.include?(m.name)}.each_with_index do |machine, i|
-              machine.id = vms[i].id
-            end
+            vms.each_with_index {|vm, i| names_to_vm_ids[names[i]] = vm.id }
+          end
+
+          machines.each do |machine|
+            machine.id = names_to_vm_ids[machine.name]
           end
 
           environment
@@ -129,15 +131,18 @@ module VagrantPlugins
             acc
           end.values
 
-          # If the same source VM appears more than once, the API
-          # requires us to make multiple calls. For simplicity,
-          # if a particular grouping includes such, just create a single
-          # call for each vm in the group. (Could be optimized further)
           groupings2 = []
           groupings.each_with_index do |grouping, i|
             if grouping.values.uniq.count == grouping.values.count
-              groupings2 << grouping.keys
+              # The new VMs in the API response will be sorted
+              # by the source VM ids. Sort the machines within
+              # each group to match.
+              groupings2 << grouping.invert.sort.collect(&:last)
             else
+              # If the same source VM appears more than once in a
+              # group, we have to make multiple API calls. For
+              # simplicity, handle this case by creating a single
+              # group for each machine.
               groupings2.concat(grouping.keys.map{|v| [v]})
             end
           end

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

@@ -129,12 +129,16 @@ module VagrantPlugins
 
         private
 
+        def user_agent_string
+          "Vagrant-Skytap/#{VERSION} Vagrant/#{Vagrant::VERSION}"
+        end
 
         def default_headers
           {
             'Authorization' => auth_header,
             'Content-Type' => 'application/json',
-            'Accept' => 'application/json'
+            'Accept' => 'application/json',
+            'User-Agent' => user_agent_string,
           }
         end
 

data/lib/vagrant-skytap/version.rb

@@ -22,6 +22,6 @@
 
 module VagrantPlugins
   module Skytap
-    VERSION = "0.2.6"
+    VERSION = "0.2.7"
   end
 end

data/spec/unit/actions/compose_environment_spec.rb

@@ -25,29 +25,45 @@ require File.expand_path("../../base", __FILE__)
 describe VagrantPlugins::Skytap::Action::ComposeEnvironment do
   include_context "rest_api"
 
+  let(:json_path)         { File.join(File.expand_path('../..', __FILE__), 'support', 'api_responses') }
+  let(:vm1_attrs)         { read_json(json_path, 'vm1.json').merge("id" => "1") }
+  let(:vm2_attrs)         { vm1_attrs.merge("id" => "2") }
+  let(:environment_attrs) { read_json(json_path, 'empty_environment.json').merge('vms' => [vm1_attrs]) }
+
   let(:app) { lambda { |env| } }
-  let(:env) { { machine: machine, machines: [machine], environment: environment, ui: ui, api_client: api_client } }
+  let(:env) { { machine: machine, machines: machines, ui: ui, api_client: api_client, parallel: true } }
   let(:provider_config) do
     double(:provider_config, vm_url: "/vms/1", username: "jsmith", api_token: "123123", base_url: base_url)
   end
   let(:api_client) { API::Client.new(provider_config) }
 
   let(:machine)          { double(:machine, name: "vm1", id: nil, :id= => nil, provider_config: provider_config) }
-  let(:existing_machine) { double(:existing_machine, name: "vm2", id: 2) }
+  let(:existing_machine) { double(:existing_machine, name: "vm2", id: "2") }
+  let(:machines)         { [machine] }
 
   let(:environment)     { double(:environment, url: "foo") }
   let(:new_environment) { double(:environment, url: "foo", vms: [vm], properties: environment_properties) }
-  let(:vm)              { double(:vm, id: 1, parent_url: "https://example.com/templates/1") }
+  let(:vm)              { double(:vm, id: "1", parent_url: "https://example.com/templates/1", :stopped? => true) }
 
   let(:environment_properties) { double(:environment_properties, read: nil, write: nil) }
 
-  let(:subject) { described_class.new(app, env) }
+  let(:instance)          { described_class.new(app, env) }
 
+  let(:get_vm_attrs)      { vm1_attrs }
+  let(:post_config_attrs) { environment_attrs }
+  let(:put_config_attrs) { environment_attrs }
   before do
-    stub_request(:get, /.*/).to_return(body: '{}', status: 200)
+    allow_any_instance_of(API::Environment).to receive(:properties).and_return(environment_properties)
+    env[:environment] = environment
+
+    stub_get(%r{/vms/\d+}, get_vm_attrs)
+    stub_post(%r{/configurations$}, post_config_attrs)
+    stub_put(%r{/configurations/\d+}, put_config_attrs)
   end
 
   describe "#call" do
+    subject {instance}
+
     it "does nothing if all machines exist" do
       machine.stub(id: 1)
       expect(app).to receive(:call).with(env)
@@ -59,7 +75,7 @@ describe VagrantPlugins::Skytap::Action::ComposeEnvironment do
       subject.call(env)
     end
 
-    it "makes a single create! call when creating an environment with 1 machine", run: true do
+    it "makes a single create! call when creating an environment with 1 machine" do
       myenv = env.merge(environment: nil)
       expect(app).to receive(:call).with(myenv)
 
@@ -82,7 +98,49 @@ describe VagrantPlugins::Skytap::Action::ComposeEnvironment do
     end
   end
 
+  describe "add_vms" do
+    subject {instance}
+
+    before do
+      stub_get(%r{/vms/1}, vm1_attrs)
+      stub_get(%r{/vms/2}, vm2_attrs)
+      # Hack so the region mismatch check always passes
+      stub_get(%r{/templates/\d+}, {"region" => environment_attrs["region"]})
+    end
+
+    context "when creating an environment from 2 vms with the same parent" do
+      let(:post_config_attrs) do
+        environment_attrs.merge('vms' => [vm1_attrs, vm2_attrs])
+      end
+
+      let(:provider_config2) do
+        double(:provider_config2, vm_url: "/vms/2", username: "jsmith", api_token: "123123", base_url: base_url)
+      end
+      let(:machine2) do
+        double(:machine2, name: "vm2", id: nil, :id= => nil, provider_config: provider_config2)
+      end
+
+      context "when machines are ordered by vm_id" do
+        it "maps the machines to the correct vms" do
+          expect(machine).to receive(:id=).with("1")
+          expect(machine2).to receive(:id=).with("2")
+          subject.add_vms(nil, [machine, machine2])
+        end
+      end
+
+      context "when machines are not ordered by vm_id" do
+        it "maps the machines to the correct vms" do
+          expect(machine).to receive(:id=).with("1")
+          expect(machine2).to receive(:id=).with("2")
+          subject.add_vms(nil, [machine2, machine])
+        end
+      end
+    end
+  end
+
   describe "fetch_source_vms" do
+    subject {instance}
+
     it "fetches a vm and returns a mapping" do
       vms = subject.fetch_source_vms([machine])
       expect(a_request(:get, %r{/vms/\d+$})).to have_been_made.once
@@ -93,8 +151,10 @@ describe VagrantPlugins::Skytap::Action::ComposeEnvironment do
   end
 
   describe "get_groupings" do
-    let(:vm_in_same_template)      { double(:vm_in_same_template,      id: 2, parent_url: "https://example.com/templates/1")}
-    let(:vm_in_different_template) { double(:vm_in_different_template, id: 3, parent_url: "https://example.com/templates/2")}
+    let(:vm_in_same_template)      { double(:vm_in_same_template,      id: "2", parent_url: "https://example.com/templates/1")}
+    let(:vm_in_different_template) { double(:vm_in_different_template, id: "3", parent_url: "https://example.com/templates/2")}
+
+    subject {instance}
 
     it "returns a single group for a single vm" do
       expect(subject.get_groupings({"vm1" => vm})).to eq([ ["vm1"] ])
@@ -116,5 +176,9 @@ describe VagrantPlugins::Skytap::Action::ComposeEnvironment do
     it "respects parallel flag" do
       expect(subject.get_groupings({"vm1" => vm, "vm2" => vm_in_same_template}, parallel: false)).to eq([ ["vm1"], ["vm2"] ])
     end
+
+    it "sorts machines in group by vm id" do
+      expect(subject.get_groupings({"vm1" => vm_in_same_template, "vm2" => vm})).to eq([ ["vm2", "vm1"] ])
+    end
   end
 end

data/spec/unit/api_client_spec.rb

@@ -0,0 +1,44 @@
+# 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_relative 'base'
+require "vagrant-skytap/api/client"
+
+describe VagrantPlugins::Skytap::API::Client do
+  include_context "rest_api"
+
+  let(:provider_config) do
+    double(:provider_config, vm_url: "/vms/1", username: "jsmith", api_token: "123123", base_url: base_url)
+  end
+  let(:instance)   { described_class.new(provider_config) }
+
+  before :each do
+    stub_request(:get, /.*/).to_return(body: "{}", status: 200)
+  end
+
+  describe "user_agent_string" do
+    subject do
+      instance.send(:user_agent_string)
+    end
+    it {should match %r{^Vagrant-Skytap/.* Vagrant/.*}}
+  end
+end

data/spec/unit/support/shared/rest_api_context.rb

@@ -36,4 +36,13 @@ shared_context "rest_api" do
 
   let(:base_url) {"http://example.com/"}
 
+  %i[get post put delete].each do |verb|
+    define_method("stub_#{verb}") do |url_matcher, response_attrs = nil|
+      stub_request(verb, url_matcher).to_return(body: JSON.dump(response_attrs), status: 200)
+    end
+  end
+
+  before do
+    stub_request(:any, /.*/).to_return(body: "{}", status: 200)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-skytap
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Eric True
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -214,6 +214,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/actions/compose_environment_spec.rb
 - spec/unit/actions/update_hardware_spec.rb
+- spec/unit/api_client_spec.rb
 - spec/unit/base.rb
 - spec/unit/config_spec.rb
 - spec/unit/credentials_spec.rb