vagrant-skytap 0.1.8 → 0.1.9

data/lib/vagrant-skytap/action.rb

@@ -9,9 +9,7 @@ module VagrantPlugins
       # This action is called to halt the remote machine.
       def self.action_halt
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env1, b1|
             case result = env1[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -26,9 +24,7 @@ module VagrantPlugins
       # This action is called to suspend the remote machine.
       def self.action_suspend
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env1, b1|
             case result = env1[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -43,9 +39,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 InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case existence_state = env[:result]
             when :missing_environment, :no_vms
@@ -79,9 +73,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 InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case result = env[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -115,9 +107,7 @@ module VagrantPlugins
       # key.
       def self.action_read_ssh_info
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use ReadSSHInfo
         end
       end
@@ -127,9 +117,7 @@ module VagrantPlugins
       # key.
       def self.action_read_state
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           #TODO:NLA Can this whole action be removed?
           b.use ReadState
         end
@@ -138,9 +126,7 @@ module VagrantPlugins
       # This action is called to SSH into the machine.
       def self.action_ssh
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env1, b1|
             case result = env1[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -154,9 +140,7 @@ module VagrantPlugins
 
       def self.action_ssh_run
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env1, b1|
             case result = env1[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -185,15 +169,12 @@ module VagrantPlugins
 
       def self.action_resume
         Vagrant::Action::Builder.new.tap do |b|
-          Vagrant::Action::Builder.new.tap do |b|
-            b.use InitializeAPIClient
-            b.use FetchEnvironment
-            b.use Call, IsSuspended do |env, b1|
-              if env[:result]
-                b1.use MessageResuming
-                b1.use RunVm
-                b1.use WaitForCommunicator
-              end
+          b.use action_fetch_environment
+          b.use Call, IsSuspended do |env, b1|
+            if env[:result]
+              b1.use MessageResuming
+              b1.use RunVm
+              b1.use WaitForCommunicator
             end
           end
         end
@@ -209,9 +190,7 @@ module VagrantPlugins
       def self.action_create
         Vagrant::Action::Builder.new.tap do |b|
           b.use HandleBox
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case result = env[:result]
             when :missing_environment
@@ -277,9 +256,7 @@ module VagrantPlugins
 
       def self.action_reload
         Vagrant::Action::Builder.new.tap do |b|
-          b.use ConfigValidate
-          b.use InitializeAPIClient
-          b.use FetchEnvironment
+          b.use action_fetch_environment
           b.use Call, ExistenceCheck do |env, b1|
             case env[:result]
             when :missing_environment, :missing_vm, :no_vms
@@ -296,6 +273,14 @@ module VagrantPlugins
         end
       end
 
+      def self.action_fetch_environment
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use InitializeAPIClient
+          b.use FetchEnvironment
+        end
+      end
+
       # The autoload farm
       action_root = Pathname.new(File.expand_path("../action", __FILE__))
       autoload :StoreExtraData, action_root.join("store_extra_data")

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

@@ -4,6 +4,8 @@ require 'vagrant-skytap/environment_properties'
 require 'vagrant-skytap/api/resource'
 require 'vagrant-skytap/api/vm'
 require 'vagrant-skytap/api/network'
+require 'vagrant-skytap/api/publish_set'
+
 require_relative 'runstate_operations'
 
 module VagrantPlugins
@@ -54,8 +56,12 @@ module VagrantPlugins
           end
         end
 
+        def get_vms_by_id(ids=[])
+          vms.select{|vm| ids.include?(vm.id)}
+        end
+
         def get_vm_by_id(id)
-          vms.find{|vm|vm.id == id}
+          get_vms_by_id([id]).first
         end
 
         def current_vm
@@ -68,6 +74,12 @@ module VagrantPlugins
           end
         end
 
+        def publish_sets
+          @publish_sets ||= (get_api_attribute('publish_sets') || []).collect do |ps_attrs|
+            PublishSet.new(ps_attrs, self, env)
+          end
+        end
+
         def region
           get_api_attribute('region')
         end
@@ -75,6 +87,7 @@ module VagrantPlugins
         def refresh(attrs)
           @vms = nil
           @networks = nil
+          @publish_sets = nil
           super
         end
 
@@ -104,6 +117,11 @@ module VagrantPlugins
           self.class.check_vm_before_adding(env, vm)
         end
 
+        def create_publish_set(attrs={})
+          resp = api_client.post("#{url}/publish_sets", JSON.dump(attrs))
+          PublishSet.new(JSON.load(resp.body), self, env)
+        end
+
         def properties
           @properties ||= EnvironmentProperties.new(env[:machine].env.local_data_path)
         end

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

@@ -0,0 +1,36 @@
+require 'vagrant-skytap/api/resource'
+
+module VagrantPlugins
+  module Skytap
+    module API
+      class PublishSet < Resource
+
+        attr_reader :environment
+        reads :id, :url, :desktops_url
+
+        def initialize(attrs, environment, env)
+          super
+          @environment = environment
+        end
+
+        def password_protected?
+          # password attribute contains asterisks or null
+          get_api_attribute('password').present?
+        end
+
+        def vm_ids
+          vm_refs = get_api_attribute("vms").collect{|ref| ref['vm_ref']}
+          vm_refs.collect{|ref| ref.match(/\/vms\/(\d+)/)}.compact.map{|match| match[1]}
+        end
+
+        def vms
+          environment.get_vms_by_id(vm_ids)
+        end
+
+        def delete
+          api_client.delete(url)
+        end
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module VagrantPlugins
         attr_reader :provider_config
         attr_reader :environment
 
-        reads :id, :interfaces, :credentials
+        reads :id, :interfaces, :credentials, :name
 
         class << self
           def fetch(env, url)

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

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module Skytap
+    module Cap
+      module PublicAddress
+        def self.public_address(machine)
+          if machine.state.id == :running
+            ssh_info = machine.ssh_info
+            ssh_info[:host] if ssh_info
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/command/helpers.rb

@@ -0,0 +1,30 @@
+module VagrantPlugins
+  module Skytap
+    module Command
+      module Helpers
+        def target_vms
+          @target_vms ||= [].tap do |ret|
+            with_target_vms{|machine| ret << machine}
+          end
+        end
+
+        def fetch_environment
+          if machine = target_vms.first
+            @environment ||= machine.action(:fetch_environment)[:environment]
+          end
+        end
+
+        def target_skytap_vms
+          fetch_environment.get_vms_by_id(target_vms.collect(&:id))
+        end
+
+        def machine_names(vm_ids)
+          target_vms.select{|m| vm_ids.include?(m.id)}.collect{|m| m.name.to_s}
+        end
+      end
+    end
+  end
+end
+
+
+

data/lib/vagrant-skytap/command/publish_url/create.rb

@@ -0,0 +1,65 @@
+require 'optparse'
+require 'vagrant-skytap/command/helpers'
+
+module VagrantPlugins
+  module Skytap
+    module Command
+      module PublishUrl
+        class Create < Vagrant.plugin("2", :command)
+          include Command::Helpers
+
+          def execute
+            options = {}
+
+            opts = OptionParser.new do |o|
+              o.banner = "Usage: vagrant publish-url create [options]"
+              o.separator ""
+              o.separator "Options:"
+              o.separator ""
+
+
+              o.on("-p", "--password PASSWORD", "Set a password for the publish set") do |p|
+                options[:password] = p
+              end
+
+              o.on("-np", "--no-password", "Do not set a password") do |np|
+                options[:no_password] = true
+              end
+
+              o.separator ""
+              o.separator "You will be prompted for a password unless one of the"
+              o.separator "options --password or --no-password have been provided."
+              o.separator "Blank passwords are allowed."
+              o.separator ""
+            end
+
+            return unless argv = parse_options(opts)
+
+            unless options[:no_password] || password = options[:password]
+              password = @env.ui.ask("Password for publish set (will be hidden; blank for no password): ", echo: false)
+            end
+            password ||= ""
+
+            ps = fetch_environment.create_publish_set(
+              name: "Vagrant publish set",
+              publish_set_type: "single_url",
+              vms: target_skytap_vms.collect do |vm|
+                {
+                  vm_ref: vm.url,
+                  access: "run_and_use",
+                }
+              end,
+              password: password
+            )
+            @logger.debug("New publish set: #{ps.url}")
+
+            @env.ui.info(I18n.t("vagrant_skytap.commands.publish_urls.created", url: ps.desktops_url))
+
+            # Success, exit status 0
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/command/publish_url/delete.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+require 'vagrant-skytap/command/helpers'
+
+module VagrantPlugins
+  module Skytap
+    module Command
+      module PublishUrl
+        class Delete < Vagrant.plugin("2", :command)
+          include Command::Helpers
+
+          def execute
+            options = {}
+
+            opts = OptionParser.new do |o|
+              o.separator ""
+              o.separator "Deletes all published URLs for this project, including any"
+              o.separator "created through the Skytap UI."
+
+              o.banner = "Usage: vagrant publish-url delete [options]"
+              o.separator ""
+              o.separator "Options:"
+              o.separator ""
+
+              o.on("-f", "--force", "Delete without prompting") do |f|
+                options[:force] = f
+              end
+            end
+
+            return unless argv = parse_options(opts)
+
+            if publish_sets = fetch_environment.publish_sets.presence
+              unless options[:force]
+                confirm = @env.ui.ask(I18n.t("vagrant_skytap.commands.publish_urls.confirm_delete"))
+                return unless confirm.downcase == 'y'
+              end
+              publish_sets.each(&:delete)
+              @env.ui.info(I18n.t("vagrant_skytap.commands.publish_urls.deleted"))
+            else
+              @env.ui.info(I18n.t("vagrant_skytap.commands.publish_urls.empty_list"))
+            end
+
+            # Success, exit status 0
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/command/publish_url/root.rb

@@ -0,0 +1,76 @@
+require 'optparse'
+
+module VagrantPlugins
+  module Skytap
+    module Command
+      module PublishUrl
+        class Root < Vagrant.plugin("2", :command)
+          def self.synopsis
+            "manages published URLs"
+          end
+
+          def initialize(argv, env)
+            super
+
+            @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+            @subcommands = Vagrant::Registry.new
+            @subcommands.register(:create) do
+              require_relative "create"
+              Create
+            end
+
+            @subcommands.register(:delete) do
+              require_relative "delete"
+              Delete
+            end
+
+            @subcommands.register(:show) do
+              require_relative "show"
+              Show
+            end
+          end
+
+          def execute
+            if @main_args.include?("-h") || @main_args.include?("--help")
+              # Print the help for all the box commands.
+              return help
+            end
+
+            # If we reached this far then we must have a subcommand. If not,
+            # then we also just print the help and exit.
+            command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+            return help if !command_class || !@sub_command
+            @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+            # Initialize and execute the command class
+            command_class.new(@sub_args, @env).execute
+          end
+
+          # Prints the help out for this command
+          def help
+            opts = OptionParser.new do |opts|
+              opts.banner = "Usage: vagrant publish-url <subcommand> [<args>]"
+              opts.separator ""
+              opts.separator "Available subcommands:"
+
+              # Add the available subcommands as separators in order to print them
+              # out as well.
+              keys = []
+              @subcommands.each { |key, value| keys << key.to_s }
+
+              keys.sort.each do |key|
+                opts.separator "     #{key}"
+              end
+
+              opts.separator ""
+              opts.separator "For help on any individual subcommand run `vagrant publish-url <subcommand> -h`"
+            end
+
+            @env.ui.info(opts.help, prefix: false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/command/publish_url/show.rb

@@ -0,0 +1,29 @@
+require 'vagrant-skytap/command/helpers'
+
+module VagrantPlugins
+  module Skytap
+    module Command
+      module PublishUrl
+        class Show < Vagrant.plugin("2", :command)
+          include Command::Helpers
+
+          def execute
+            if publish_sets = fetch_environment.publish_sets.presence
+              results = publish_sets.collect do |ps|
+                "#{ps.desktops_url || 'n/a'}\n" \
+                  "  VMs: #{machine_names(ps.vm_ids).join(', ').presence || '(none)'}" \
+                  "  Password protected? #{ps.password_protected? ? 'yes' : 'no'}"
+              end
+              @env.ui.info(I18n.t("vagrant_skytap.commands.publish_urls.list", publish_urls: results.join("\n")))
+            else
+              @env.ui.info(I18n.t("vagrant_skytap.commands.publish_urls.empty_list"))
+            end
+
+            # Success, exit status 0
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/plugin.rb

@@ -36,7 +36,17 @@ module VagrantPlugins
 
       command("up", primary: true) do
         require_relative "command/up"
-        Command::Up
+        Skytap::Command::Up
+      end
+
+      command("publish-url", primary: true) do
+        require_relative "command/publish_url/root"
+        Skytap::Command::PublishUrl::Root
+      end
+
+      provider_capability(:skytap, :public_address) do
+        require_relative "cap/public_address"
+        Cap::PublicAddress
       end
 
       # This initializes the internationalization strings.

data/lib/vagrant-skytap/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Skytap
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/locales/en.yml

@@ -136,3 +136,32 @@ en:
       long_busy: |-
         The Skytap instance is busy. Wait for the current operation to complete.
 
+    commands:
+      publish_urls:
+        list: |-
+          The VMs in this Skytap environment can be accessed through the
+          following published URL(s):
+          %{publish_urls}
+        empty_list: |-
+          No published URLs were found for this Skytap environment. Run
+          `vagrant publish-url create` to create one.
+        created: |-
+          This Skytap environment (or the specified subset of VMs) can be
+          accessed at the following URL: %{url}
+          Note that anyone with this URL and password will have full control
+          of the VMs until the published URL is deleted. (Finer-grained
+          control is available through the Skytap UI.)
+        already_exists: |-
+          There is already a published URL for this Skytap environment.
+          To modify the published URL, please delete it and create a new
+          one. (Finer-grained control is available through the Skytap UI.)
+        confirm_delete: |-
+          This action will delete ALL published URLs for this Skytap
+          environment, including those created through the Skytap UI.
+          Are you sure you wish to do this? [yN]
+        deleted: |-
+          All published URLs for this Skytap environment (including those
+          created through the Skytap UI) have been deleted. Users cannot
+          manage these VMs, or access them through SmartClient, unless they
+          have a Skytap user account with appropriate permissions.
+

data/spec/unit/base.rb

@@ -23,10 +23,7 @@ require "unit/support/shared/capability_helpers_context"
 require "unit/support/shared/plugin_command_context"
 require "unit/support/shared/skytap_context"
 
-require "vagrant-skytap/core_ext/object/blank"
-require "vagrant-skytap/core_ext/object/tap"
-require "vagrant-skytap/core_ext/try"
-require "vagrant-skytap/plugin"
+require "vagrant-skytap"
 
 # Do not buffer output
 $stdout.sync = true

data/spec/unit/environment_spec.rb

@@ -1,7 +1,6 @@
 require_relative 'base'
 require "vagrant-skytap/api/environment"
 require "vagrant-skytap/api/vm"
-require "vagrant-skytap/errors"
 
 describe VagrantPlugins::Skytap::API::Environment do
   include_context "unit"
@@ -13,6 +12,7 @@ describe VagrantPlugins::Skytap::API::Environment do
   let(:network1_attrs) { JSON.load(File.read(File.join(File.expand_path('..', __FILE__), 'skeletons', 'network1.json'))) }
   let(:vpn_attachment1_attrs) { JSON.load(File.read(File.join(File.expand_path('..', __FILE__), 'skeletons', 'vpn_attachment1.json'))) }
   let(:empty_environment_attrs) { JSON.load(File.read(File.join(File.expand_path('..', __FILE__), 'skeletons', 'empty_environment.json')))}
+  let(:empty_publish_set_attrs) { JSON.load(File.read(File.join(File.expand_path('..', __FILE__), 'skeletons', 'empty_publish_set.json')))}
 
   let(:attrs_one_vm) do
     empty_environment_attrs.dup.tap do |ret|
@@ -26,6 +26,11 @@ describe VagrantPlugins::Skytap::API::Environment do
   let(:attrs) do
     attrs_one_vm.dup.tap do |ret|
       ret['vms'] = [vm1_attrs, vm2_attrs]
+      ret['publish_sets'] = [empty_publish_set_attrs.dup]
+      ret['publish_sets'].first['vms'] = [
+        {"vm_ref" => "http://example.com/vms/#{vm1_attrs['id']}"},
+        {"vm_ref" => "http://example.com/vms/#{vm2_attrs['id']}"}
+      ]
     end
   end
 
@@ -123,6 +128,13 @@ describe VagrantPlugins::Skytap::API::Environment do
     it { should be_a VagrantPlugins::Skytap::API::Network }
   end
 
+  describe "publish_sets" do
+    subject do
+      instance.publish_sets.first
+    end
+    it { should be_a VagrantPlugins::Skytap::API::PublishSet }
+  end
+
   describe "get_vm_by_id" do
     subject do
       instance
@@ -135,9 +147,20 @@ describe VagrantPlugins::Skytap::API::Environment do
     end
   end
 
+  describe "get_vms_by_id" do
+    subject do
+      instance
+    end
+
+    it "should return the appropriate vms from the collection" do
+      expect(subject.vms.count).to eq 2
+      expect(subject.get_vms_by_id(['6981850', '6981851']).collect(&:name)).to eq ['VM1', 'VM2']
+    end
+  end
+
   describe "reload" do
     subject do
-      old_attrs = attrs_one_vm.merge('networks' => [])
+      old_attrs = attrs_one_vm.merge('networks' => [], 'publish_sets' => [])
       new_attrs = attrs.merge('name' => 'Environment with 2 vms')
       client = double('api_client',
         get: double('resp', body: JSON.dump(new_attrs))
@@ -146,14 +169,16 @@ describe VagrantPlugins::Skytap::API::Environment do
       described_class.new(old_attrs, myenv)
     end
 
-    it "reloads the list of vms and networks" do
+    it "reloads the child objects" do
       expect(subject.name).to eq 'Environment 1'
       expect(subject.vms.count).to eq 1
       expect(subject.networks.count).to eq 0
+      expect(subject.publish_sets.count).to eq 0
       subject.reload
       expect(subject.name).to eq 'Environment with 2 vms'
       expect(subject.vms.count).to eq 2
       expect(subject.networks.count).to eq 1
+      expect(subject.publish_sets.count).to eq 1
     end
   end