vagrant-skytap 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24c83e15798abd9dd2e7df78bd984c2768dae164
-  data.tar.gz: 0198f2146818c63d8ef7fc0bf9808a20fdea288e
+  metadata.gz: df35f6df87630a3718560fe3900aa38b7eb7d946
+  data.tar.gz: 98caf819eed011f11be89c6072c5df6e3a8a4664
 SHA512:
-  metadata.gz: 533b0663bcd1ceee2c749db4cc4bc95a77bb2a1a940d90422fdb118ae182b72dcf10dfc84ccde3510590193511eec4d24ae9421dbbeb4cd2c601db6a5d402804
-  data.tar.gz: 231290cdc514f59aa84187f951a47b13742447a7a5fcfa78af9c1675c1e1efd02a4a2522c5e1f74817b39090ad10cc408b2c8c8fca031766b7ec6bbf30c8abb1
+  metadata.gz: d3798da927dafe1c1f69b8b2f5bbe5fb8ef8480c71fce6866f7ce268c476b7be4ce9ed0226e683e493f957d492d799c67ea9798e273f208fdce1ba32ca61c71c
+  data.tar.gz: 0641307fac52c06148d0554eae1455783834fe745a7bf7432086e27d9001a55660d3e3f41392df8561e69d52be4c78248954cf0aa5b981e6078f75666243747a

data/.gitignore

@@ -19,11 +19,10 @@ Vagrantfile
 # RVM files for gemset/ruby setting
 .ruby-*
 .rvmrc
-.ruby-version
 
-# other source control
 .hg
 .hgignore
-.byebug_history
+.agignore
+.project
+.ruby-version
 .project
-.rspec

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.2.6 (February 16, 2016)
+
+* Changes to support logging in to base boxes with the default `vagrant` user and
+  insecure keypair. Previously, if the SSH username and password were omitted
+  from the `Vagrantfile`, the user was prompted to enter them. We now default
+  to the `vagrant` login. If the source VM (image) has saved credentials
+  (a Skytap-specific feature; see [Accessing and Saving VM Credentials](http://help.skytap.com/#VM_Settings_Credentials.html))
+  then the user will be shown a menu of the stored credentials,
+  as well as an option for the default `vagrant` login.
+
 # 0.2.5 (February 3, 2016)
 
 * Initial push to GitHub. Random cleanup, including getting rid of some unused test files.

data/README.md

@@ -120,8 +120,6 @@ will install the provider only. It will be necess
 ### Sharing Environments via Published URLs
 The  Skytap Vagrant provider has basic support for [published URLs](http://help.skytap.com/#Published_URLs.html). Publishing an environment gives full anonymous access to the Skytap environment to anyone with the URL (and optional password). This feature differs from [Vagrant Share](https://www.vagrantup.com/docs/share/index.html) in that the user will have browser-based access to a shared view of all VMs in the environment, including details at a glance, thumbnails, and desktop access using SmartClient.
 
-![Shared environment view](//help.skytap.com/Content/Resources/Images/PublishedURLView.png)
-
 
 A password may be specified. Anonymous access may be revoked by deleting the published URL, using the `vagrant publish-url delete` subcommand. (Skytap users with appropriate
 permissions may still access the environment through the UI if desired.)

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

@@ -44,7 +44,9 @@ module VagrantPlugins
         end
 
         def using_nfs?
-          @machine.config.vm.synced_folders.any? { |_, opts| opts[:type] == :nfs }
+          @machine.config.vm.synced_folders.any? { |_, opts| opts[:type] == :nfs }.tap do |ret|
+            @logger.debug("PrepareNFSSettings#using_nfs? returning #{ret}. Synced folders: #{@machine.config.vm.synced_folders.inspect}")
+          end
         end
 
         # Returns the IP address of the host, preferring one on an interface which
@@ -54,7 +56,7 @@ module VagrantPlugins
             s.connect(machine.ssh_info[:host], 1)
             s.addr.last
           end.tap do |ret|
-            @logger.debug "read_host_ip returning #{ret}"
+            @logger.debug("PrepareNFSSettings#read_host_ip returning #{ret}")
           end
         end
 

data/lib/vagrant-skytap/action.rb

@@ -63,6 +63,7 @@ module VagrantPlugins
       # This action is called to terminate the remote machine.
       def self.action_destroy
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
           b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case existence_state = env[:result]
@@ -98,6 +99,7 @@ module VagrantPlugins
       # This action is called when `vagrant provision` is called.
       def self.action_provision
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
           b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case result = env[:result]
@@ -228,6 +230,7 @@ module VagrantPlugins
       def self.action_create
         Vagrant::Action::Builder.new.tap do |b|
           b.use HandleBox
+          b.use ConfigValidate
           b.use action_fetch_environment
           b.use ComposeEnvironment
         end
@@ -281,6 +284,7 @@ module VagrantPlugins
 
       def self.action_reload
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
           b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case env[:result]
@@ -300,7 +304,6 @@ module VagrantPlugins
 
       def self.action_fetch_environment
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
           b.use InitializeAPIClient
           b.use FetchEnvironment
         end

data/lib/vagrant-skytap/setup_helper.rb

@@ -66,74 +66,54 @@ module VagrantPlugins
 
       def ask_credentials
         @logger.debug("ask_credentials")
-        return if username && password
 
-        env[:ui].info("Note that the machine password will be stored in " \
-                      "cleartext on your local filesystem.")
-
-        creds = current_vm.credentials.select(&:recognized?)
-
-        if username
-          env[:ui].info("SSH username found in Vagrantfile: #{username}")
-          match = creds.detect{|c| c.username == username}
-
-          if match
-            @logger.info("Found username in Vagrantfile. Using matching password from credentials.")
-            env[:ui].info("Matched SSH password in Skytap VM credentials.")
-            @password = match.password
-          else
-            @logger.info("Found username in Vagrantfile. Will use manual password entry.")
-          end
-        elsif creds.present?
-          question = "How do you want to choose SSH credentials for machine '#{@machine.name}'?"
-          choices = creds.collect do |c|
-            "Use VM credentials stored in Skytap: #{c}"
-          end
-          choices << 'Type credentials manually'
-
-          ask_from_list(question, choices, 0) do |i|
-            if cred = creds[i]
-              @username = cred.username
-              @password = cred.password
+        if !username
+          creds = current_vm.credentials.select(&:recognized?)
+          if creds.present?
+            question = "How do you want to choose SSH credentials for machine '#{@machine.name}'?\n" \
+              "Note that credentials retrieved from the Skytap VM will be stored in cleartext on your local filesystem."
+            ask_from_list(question, credentials_choices(creds), 0) do |i|
+              if cred = creds[i]
+                @username = cred.username
+                @password = cred.password
+              end
             end
+          else
+            @logger.info("No login credentials found for the VM. Allowing fallback to default vagrant login.")
           end
-        else
-          @logger.info("No login credentials found for the VM. Prompting for manual username/password entry.")
         end
-
-        @username ||= ask_username
-        @password ||= ask_password
+        [@username, @password]
       end
 
-      def ask_username
-        @username = ask('Enter SSH username:').strip
-      end
-
-      def ask_password
-        @password = ask('Enter SSH password (no output will appear):', echo: false).strip
+      def credentials_choices(creds)
+        creds.collect do |c|
+          "Use VM credentials stored in Skytap: #{c}"
+        end.tap do |choices|
+          choices << "Don't specify credentials: Use standard 'vagrant' login with insecure keypair"
+        end
       end
 
       def ask_routing
         @logger.debug("ask_routing")
-        return if host && port
-
-        iface = current_vm.interfaces.first
-        choices = connection_choices(iface).select(&:valid?)
-        raise Errors::NoConnectionOptions unless choices.present?
-
-        if vpn_url = @provider_config.vpn_url
-          choice = choices.detect do |choice|
-            choice.vpn && vpn_url.include?(choice.vpn.id)
+        unless host && port
+          iface = current_vm.interfaces.first
+          choices = connection_choices(iface).select(&:valid?)
+          raise Errors::NoConnectionOptions unless choices.present?
+
+          if vpn_url = @provider_config.vpn_url
+            choice = choices.detect do |choice|
+              choice.vpn && vpn_url.include?(choice.vpn.id)
+            end
+            raise Errors::DoesNotExist, object_name: vpn_url unless choice
+            @host, @port = choice.choose
+          else
+            question = "How do you want to connect to machine '#{@machine.name}'?"
+            ask_from_list(question, choices, 0) do |i, choice|
+              @host, @port = choice.choose
+            end
           end
-          raise Errors::DoesNotExist, object_name: vpn_url unless choice
-          @host, @port = choice.choose
-          return
-        end
-
-        question = "How do you want to connect to machine '#{@machine.name}'?"
-        ask_from_list(question, choices, 0) do |i, choice|
-          @host, @port = choice.choose
         end
+        [@host, @port]
       end
 
       def connection_choices(iface)

data/lib/vagrant-skytap/version.rb

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

data/spec/unit/credentials_spec.rb

@@ -0,0 +1,53 @@
+# 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'
+
+describe VagrantPlugins::Skytap::API::Credentials do
+  include_context "rest_api"
+
+  let(:instance) { described_class.new(credential_attrs, nil, {}) }
+
+  describe "recognized?" do
+    subject { instance.recognized? }
+
+    context "when text is xxx/yyy" do
+      let(:credential_attrs) {{ "text" => "xxx/yyy" }}
+      it { should be true }
+    end
+
+    context "when text is xxx / yyy" do
+      let(:credential_attrs) {{ "text" => "xxx / yyy" }}
+      it { should be true }
+    end
+
+    context "when text is blank" do
+      let(:credential_attrs) {{ "text" => "" }}
+      it { should be false }
+    end
+
+    context "when text is xxx, yyy" do
+      let(:credential_attrs) {{ "text" => "xxx, yyy" }}
+      it { should be false }
+    end
+  end
+end

data/spec/unit/setup_helper_spec.rb

@@ -22,60 +22,56 @@
 
 require_relative 'base'
 require "vagrant-skytap/setup_helper"
-require "vagrant-skytap/api/environment"
-require "vagrant-skytap/api/vpn"
-require "vagrant-skytap/api/vpn_attachment"
-require "vagrant-skytap/config"
 
 describe VagrantPlugins::Skytap::SetupHelper do
   include_context "rest_api"
 
-  let(:instance) { described_class.new }
-  let(:json_path) { File.join(File.expand_path('..', __FILE__), 'support', 'api_responses') }
+  let(:json_path)      { File.join(File.expand_path('..', __FILE__), 'support', 'api_responses') }
+  let(:vpn_attachment_attrs)   { read_json(json_path, 'vpn_attachment1.json') }
 
-  let(:vm1_attrs) { read_json(json_path, 'vm1.json') }
-  let(:network1_attrs) { read_json(json_path, 'network1.json') }
-  let(:vpn1_attrs) { read_json(json_path, 'vpn1.json') }
-  let(:vpn_attachment1_attrs) { read_json(json_path, 'vpn_attachment1.json') }
-  let(:empty_environment_attrs) { read_json(json_path, 'empty_environment.json')}
-
-  let(:network_attrs) do
-    network1_attrs.dup.tap do |ret|
-      ret['vpn_attachments'] = [vpn_attachment1_attrs]
+  let(:vm_attrs) do
+    read_json(json_path, 'vm1.json').tap do |ret|
+      ret['interfaces'].first['nat_addresses']['vpn_nat_addresses'] = {}
     end
   end
 
-  let(:vm_attrs) do
-    vm1_attrs.dup.tap do |ret|
-      ret['interfaces'].first['nat_addresses']['vpn_nat_addresses'] = {}
+  let(:network_attrs) do
+    read_json(json_path, 'network1.json').tap do |ret|
+      ret['vpn_attachments'] = [vpn_attachment_attrs]
     end
   end
 
   let(:environment_attrs) do
-    empty_environment_attrs.dup.tap do |ret|
-      ret['vms'] = [vm_attrs]
-      ret['networks'] = [network1_attrs]
+    read_json(json_path, 'empty_environment.json').tap do |ret|
+      ret['vms']      = [vm_attrs]
+      ret['networks'] = [network_attrs]
     end
   end
 
-  let(:environment) { VagrantPlugins::Skytap::API::Environment.new(environment_attrs, env) }
+  let(:environment) do
+    API::Environment.new(environment_attrs, env)
+  end
 
   let(:vpn_attrs) do
-    vpn1_attrs.dup.tap do |ret|
-      ret['network_attachments'] = [vpn_attachment1_attrs]
+    read_json(json_path, 'vpn1.json').dup.tap do |ret|
+      ret['network_attachments'] = [vpn_attachment_attrs]
     end
   end
 
-  let(:vpn) {VagrantPlugins::Skytap::API::Vpn.new(vpn_attrs, env)}
+  let(:vpn)        {API::Vpn.new(vpn_attrs, env)}
+  let(:vpns)       {[vpn]}
+  let(:vpn_choice) {double(:vpn_choice, vpn: vpn, choose: ["1.2.3.4", 22], :valid? => true)}
+  let(:user_input) { "" }
 
   let(:ssh_config) do
-    double(:ssh, username: "foo", password: "bar", host: nil, port: nil)
+    double(:ssh_config, username: nil, password: nil, host: nil, port: nil)
   end
   let(:machine_config) do
     double(:machine_config, ssh: ssh_config)
   end
+  let(:vpn_url) {"/vpns/vpn-123"}
   let(:provider_config) do
-    double(:provider_config, vm_url: "/vms/1", username: "jsmith", api_token: "123123", base_url: base_url)
+    double(:provider_config, vm_url: "/vms/1", username: "jsmith", api_token: "123123", base_url: base_url, vpn_url: vpn_url)
   end
   let(:api_client) { API::Client.new(provider_config) }
   let(:machine)    { double(:machine, name: "vm1", id: "6981850", config: machine_config, provider_config: provider_config) }
@@ -85,48 +81,115 @@ describe VagrantPlugins::Skytap::SetupHelper do
   before :each do
     # Ensure tests are not affected by Skytap credential environment variables
     ENV.stub(:[] => nil)
-    stub_request(:get, /.*/).to_return(body: '{}', status: 200)
-    stub_request(:get, %r{/configurations/\d+}).to_return(body: JSON.dump(environment_attrs), status: 200)
-    stub_request(:get, %r{/vpns$}).to_return(body: JSON.dump([vpn_attrs]), status: 200)
+    allow(ui).to receive(:ask).and_return(user_input)
+    allow(instance).to receive(:vpns).and_return(vpns)
+    allow(vpn).to receive(:choice_for_setup).and_return(vpn_choice)
+    stub_request(:get, /.*/).to_return(body: "{}", status: 200)
+  end
+
+  describe "connection_choices" do
+    subject do
+      instance.send(:connection_choices, instance.current_vm.interfaces.first)
+    end
+
+    context "when there are choices" do
+      it "should return a matching choice" do
+        expect(subject.count).to be 1
+        expect(subject.first.vpn).to be vpn
+      end
+    end
+
+    context "when there are no choices" do
+      let(:vpns) {[]}
+      it { should eq [] }
+    end
   end
 
   describe "ask_routing" do
     subject do
-      instance
+      instance.send(:ask_routing)
     end
 
-    before :each do
-      allow(subject).to receive(:vpns).and_return([vpn])
+    context "when valid vpn_url specified" do
+      it {should eq ["1.2.3.4", 22]}
     end
 
-    after(:each) do
-      allow_any_instance_of(VpnChoice).to receive(:choose).and_call_original
+    context "when invalid vpn_url specified" do
+      let(:vpn_url) {"bogus"}
+      it "raises error" do
+        expect{subject}.to raise_error Errors::DoesNotExist
+      end
     end
 
-    it "has connection_choices" do
-      interface = subject.current_vm.interfaces.first
-      choices = subject.send(:connection_choices, interface)
-      expect(choices.count).to eq 1
-      expect(choices.first.vpn).to_not be_nil
+    context "when vpn_url unspecified" do
+      let(:vpn_url)    {nil}
+      let(:user_input) {"1"}
+      it {should eq ["1.2.3.4", 22]}
     end
 
-    it "does not show choices if vpn_url specified" do
-      allow(provider_config).to receive(:vpn_url).and_return(vpn.url)
-      vpn_choice = double(:choice, vpn: vpn, choose: ['1.2.3.4', 22], :valid? => true)
-      allow(vpn).to receive(:choice_for_setup).and_return(vpn_choice)
-      expect(subject).not_to receive(:ask_from_list)
-      subject.send(:ask_routing)
+    context "when no valid vpns exist" do
+      before do
+        allow(vpn_choice).to receive(:valid?).and_return(false)
+      end
+      it "raises error" do
+        expect{subject}.to raise_error Errors::NoConnectionOptions
+      end
     end
+  end
 
-    it "raises DoesNotExist if non-existent vpn_url specified" do
-      allow(provider_config).to receive(:vpn_url).and_return("bogus")
-      expect{subject.send(:ask_routing)}.to raise_error(Errors::DoesNotExist)
+  describe "ask_credentials" do
+    subject do
+      instance.send(:ask_credentials)
     end
 
-    it "shows choices if vpn_url unspecified" do
-      allow(provider_config).to receive(:vpn_url).and_return(nil)
-      expect(subject).to receive(:ask_from_list)
-      subject.send(:ask_routing)
+    context "when username and password are set" do
+      let(:ssh_config) {double(:ssh_config, username: "foo", password: "bar", host: nil, port: nil)}
+      it {should eq %w[foo bar]}
+    end
+
+    context "when only username is set and it matches a set of stored credentials" do
+      let(:ssh_config) {double(:ssh_config, username: "skytap", password: nil, host: nil, port: nil)}
+      it {should eq ["skytap", nil]}
+    end
+
+    context "when username and password are not set but stored credentials exist" do
+      let(:user_input) {"1"}
+      it {should eq %w[skytap skypass]}
+    end
+
+    context "when username and password are not set and no stored credentials exist" do
+      before do
+        allow(instance.current_vm).to receive(:credentials).and_return([])
+      end
+      it {should eq [nil, nil]}
+    end
+  end
+
+  describe "ask_from_list" do
+    subject do
+      instance.send(:ask_from_list, "Prompt", ["aaa", "bbb"], 0)
+    end
+
+    context "when user enters nothing" do
+      let(:user_input) {""}
+      it {should eq 0}
+    end
+
+    context "when user enters numeral" do
+      let(:user_input) {" 2 "}
+      it {should eq 1}
+    end
+  end
+
+  describe "credentials_choices" do
+    subject do
+      instance.send(:credentials_choices, instance.current_vm.credentials)
+    end
+    it "returns a list of the vm's credentials plus the default vagrant login" do
+      expect(subject).to eq([
+        "Use VM credentials stored in Skytap: skytap / skypass",
+        "Don't specify credentials: Use standard 'vagrant' login with insecure keypair"
+      ])
     end
   end
 end

data/spec/unit/support/api_responses/vm1.json

@@ -72,7 +72,7 @@
   "credentials": [
     {
       "id": "5695620",
-      "text": "xxx / yyy"
+      "text": "skytap / skypass"
     }
   ],
   "desktop_resizable": true,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-skytap
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Eric True
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -216,6 +216,7 @@ files:
 - spec/unit/actions/update_hardware_spec.rb
 - spec/unit/base.rb
 - spec/unit/config_spec.rb
+- spec/unit/credentials_spec.rb
 - spec/unit/environment_spec.rb
 - spec/unit/forwarded_port_spec.rb
 - spec/unit/hosts/common/cap/ssh_tunnel_spec.rb