rvc 1.6.0 → 1.7.0

data/Rakefile

@@ -7,7 +7,7 @@ begin
     gem.email = "rlane@vmware.com"
     #gem.homepage = ""
     gem.authors = ["Rich Lane"]
-    gem.add_dependency 'rbvmomi', '>= 1.5.0'
+    gem.add_dependency 'rbvmomi', '>= 1.6.0'
     gem.add_dependency 'trollop', '>= 1.16.2'
     gem.add_dependency 'backports', '>= 1.18.2'
     gem.add_dependency 'highline', '>= 1.6.1'

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/bin/rvc

@@ -18,25 +18,21 @@
 # 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 'rvc'
+require 'rvc/version'
+require 'rvc/uri_parser'
 require 'readline'
 require "highline/import"
 require 'pp'
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
 require 'shellwords'
 require 'yaml'
 require 'backports'
-require 'rvc'
 require 'tempfile'
-
-VIM = RbVmomi::VIM
+require 'trollop'
+require 'rbvmomi/trollop'
 
 Thread.abort_on_exception = true
 
-CMD = Module.new
-RVC::VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
-
 HighLine.use_color = ENV['TERM'] != nil
 
 $opts = Trollop.options do
@@ -55,68 +51,44 @@ EOS
   opt :create_directory, "Create the initial directory if it doesn't exist", :short => :none
   opt :cmd, "command to evaluate", :short => 'c', :multi => true, :type => :string
   opt :script, "file to execute", :short => 's', :type => :string
+  opt :script_args, "arguments to script", :short => :none, :default => "", :type => :string
   opt :cookie, "authentication cookie file", :short => 'k', :type => :string
+  opt :quiet, "silence unnecessary output", :short => 'q', :default => false, :type => :boolean
 end
 
 $interactive = $opts[:script].nil? and $stdin.tty?
 
-RVC.reload_modules false
-
-session = if ENV['RVC_SESSION'] and not ENV['RVC_SESSION'].empty?
-  RVC::FilesystemSession.new ENV['RVC_SESSION']
-else
-  RVC::MemorySession.new
-end
-
-$shell = RVC::Shell.new session
+# TODO remove $shell when all references are gone
+$shell = shell = RVC::Shell.new
+shell.reload_modules false
 
 # Prompt for hostname if none given. Useful on win32.
-if $shell.session.connections.empty? and ARGV.empty? and $interactive
+if ARGV.empty? and $interactive
   ARGV << Readline.readline("Host to connect to (user@host): ")
 end
 
-$shell.session.connections.each do |key|
-  conn = $shell.session.get_connection(key) or fail "no such connection #{key.inspect}"
-  uri = "#{conn['username']}@#{conn['host']}"
+# TODO cookies, cert digests
+ARGV.each do |str|
   begin
-    puts "Connecting to #{conn['host']}..."
-    CMD.vim.connect uri, {}
-  rescue RVC::Util::UserError
-    puts "Failed to connect to #{conn['host']}: #{$!.message}"
+    uri = RVC::URIParser.parse str
+  rescue
+    puts "Failed to parse URI #{str.inspect}: #{$!.message}"
     exit 1
   end
-end
-
-cookies = {}
-certdigests = {}
-if $opts[:cookie]
-  File.readlines($opts[:cookie]).each do |info|
-    host, cookie, certdigest = info.chomp.split('|')
-    cookies[host] = cookie
-    certdigests[host] = certdigest
-  end
-end
 
-ARGV.each do |uri|
-  # get hostname from uri to display in "connecting to..." message
-  hostinfo = uri.split("@")
-  host = if hostinfo.length > 1
-           hostinfo[1].split(":")[0]
-         else
-           hostinfo[0].split(":")[0]
-         end
   begin
-    puts "Connecting to #{host}..." if (ARGV+$shell.session.connections).size > 1
-    CMD.vim.connect uri, {:cookie => cookies[host],
-                          :certdigest => certdigests[host]}
+    puts "Connecting to #{uri.host}..." if ARGV.size > 1
+    scheme = uri.scheme || 'vim'
+    scheme_handler = RVC::SCHEMES[scheme] or RVC::Util.err "invalid scheme #{scheme.inspect}"
+    scheme_handler[uri]
   rescue RVC::Util::UserError
-    puts "Failed to connect to #{host}: #{$!.message}"
+    puts "Failed to connect to #{uri.host}: #{$!.message}"
     exit 1
   end
 end
 
 if $interactive
-  RVC::Completion.install
+  shell.completion.install
   history_fn = "#{ENV['HOME']}/.rvc-history"
   IO.foreach(history_fn) { |l| Readline::HISTORY << l.chomp } rescue puts "Welcome to RVC. Try the 'help' command."
   begin
@@ -128,19 +100,20 @@ end
 
 if $opts[:path]
   begin
-    CMD.basic.cd RVC::Util.lookup_single($opts[:path])
+    shell.cmds.basic.cd shell.fs.lookup_single($opts[:path])
   rescue RVC::Util::UserError
     raise unless $opts[:create_directory]
     parent_path = File.dirname($opts[:path])
-    RVC::Util.lookup_single(parent_path).CreateFolder(:name => File.basename($opts[:path]))
-    CMD.basic.cd RVC::Util.lookup_single($opts[:path])
+    shell.fs.lookup_single(parent_path).CreateFolder(:name => File.basename($opts[:path]))
+    shell.cmds.basic.cd shell.fs.lookup_single($opts[:path])
   end
-elsif $shell.connections.size == 1 and $interactive
-  conn_name, conn = $shell.connections.first
+elsif shell.connections.size == 1 and $interactive and
+      shell.connections.first[1].is_a? RbVmomi::VIM # HACK
+  conn_name, conn = shell.connections.first
   if conn.serviceContent.about.apiType == 'VirtualCenter'
-    CMD.basic.cd RVC::Util.lookup_single(conn_name)
+    shell.cmds.basic.cd shell.fs.lookup_single(conn_name)
   else
-    CMD.basic.cd RVC::Util.lookup_single("#{conn_name}/ha-datacenter/vm")
+    shell.cmds.basic.cd shell.fs.lookup_single("#{conn_name}/ha-datacenter/vm")
   end
 end
 
@@ -151,43 +124,46 @@ if defined? Ocra
 end
 
 if $interactive
-  if ENV['DISPLAY']
-    $stderr.puts "VMRC is not installed. You will be unable to view virtual machine consoles. Use the vmrc.install command to install it." unless CMD.vmrc.find_vmrc
+  if ENV['DISPLAY'] and !$opts[:quiet]
+    $stderr.puts "VMRC is not installed. You will be unable to view virtual machine consoles. Use the vmrc.install command to install it." unless shell.cmds.vmrc.slate.check_installed
   end
-  $stderr.puts "Use the 'connect' command to connect to an ESX or VC server." if $shell.connections.empty?
-  CMD.basic.ls RVC::Util.lookup_single('.')
+  $stderr.puts "Use the 'connect' command to connect to an ESX or VC server." if shell.connections.empty?
+  shell.cmds.basic.ls shell.fs.lookup_single('.') unless $opts[:quiet]
 end
 
-trap "SIGCHLD" do |sig|
-  begin
-    while pid = Process.wait(-1, Process::WNOHANG)
+if Signal.list["CHLD"]
+  trap "SIGCHLD" do |sig|
+    begin
+      while pid = Process.wait(-1, Process::WNOHANG)
+      end
+    rescue Errno::ECHILD
     end
-  rescue Errno::ECHILD
   end
 end
 
 if $opts[:script]
-  $shell.eval_ruby File.read($opts[:script]), $opts[:script]
+  ARGV.replace(Shellwords.shellwords($opts[:script_args]))
+  shell.eval_ruby File.read($opts[:script]), $opts[:script]
 else
   while true
     begin
       begin
-        input = $opts[:cmd].shift || Readline.readline($shell.prompt, false) or break
+        input = $opts[:cmd].shift || Readline.readline(shell.prompt, false) or break
       rescue
         puts "\n#{$!.class} during readline: #{$!.message}"
-        $!.backtrace.each { |x| puts x } if $shell.debug
+        $!.backtrace.each { |x| puts x } if shell.debug
         next
       end
       input = input.strip
       next if input.empty?
       (history && history.puts(input); Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
-      $shell.eval_input input
+      shell.eval_input input
     rescue Interrupt
       puts
     end
   end
 end
 
-$shell.connections.each do |name, conn|
+shell.connections.each do |name, conn|
   conn.close if conn.respond_to? :close rescue puts("failed to close connection #{name.inspect}: #{$!.class}: #{$!.message}")
 end

data/devel/test-dependencies.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+find lib -maxdepth 2 -name '*.rb' -exec ruby -Ilib -e "puts ARGV[0]; load ARGV[0]" {} \;
+find lib/rvc/extensions -name '*.rb' -exec ruby -rrbvmomi -rrvc/vim -rrvc/util -Ilib -e 'x = File.basename(ARGV[0])[0...-3]; puts x; VIM.const_get(x)' {} \;
+find lib/rvc/modules -name '*.rb' -exec ruby -rrbvmomi -rrvc/vim -rrvc/util -Ilib -e 'include RVC::Util; x = ARGV[0]; puts x; def rvc_alias(a,b=nil); end; def opts(s); end; def rvc_completor(a); end; def raw_opts(a,b); end; load(x)' {} \;

data/lib/rvc.rb

@@ -18,16 +18,15 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rbvmomi'
+module RVC
+  SCHEMES = {}
+end
+
 require 'rvc/inventory'
-require 'rvc/modules'
+require 'rvc/namespace'
 require 'rvc/util'
 require 'rvc/path'
 require 'rvc/fs'
 require 'rvc/completion'
 require 'rvc/option_parser'
 require 'rvc/shell'
-require 'rvc/memory_session'
-require 'rvc/filesystem_session'
-
-RbVmomi::VIM.extension_dirs << File.join(File.dirname(__FILE__), "rvc/extensions")

data/lib/rvc/command.rb

@@ -0,0 +1,65 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+# 
+# 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 'rvc/option_parser'
+
+module RVC
+
+class Command
+  attr_reader :ns, :name, :summary, :parser
+  attr_accessor :completor
+
+  def initialize ns, name, summary, parser
+    @ns = ns
+    @name = name
+    @summary = summary
+    @parser = parser
+    @completor = nil
+  end
+
+  def inspect
+    "#<RVC::Command:#{name}>"
+  end
+
+  def invoke *args
+    @ns.slate.send @name, *args
+  end
+
+  def complete word, args
+    if @completor
+      candidates = @completor.call word, args
+      prefix_regex = /^#{Regexp.escape word}/
+      candidates.select { |x,a| x =~ prefix_regex }
+    else
+      return @ns.shell.completion.fs_candidates(word) +
+             long_option_candidates(word)
+    end
+  end
+
+  def long_option_candidates word
+    return [] unless parser.is_a? RVC::OptionParser
+    prefix_regex = /^#{Regexp.escape(word)}/
+    parser.specs.map { |k,v| "--#{v[:long]}" }.
+                 grep(prefix_regex).sort.
+                 map { |x| [x, ' '] }
+  end
+end
+
+end

data/lib/rvc/command_slate.rb

@@ -0,0 +1,112 @@
+# Copyright (c) 2011-2012 VMware, Inc.  All Rights Reserved.
+# 
+# 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 'rvc/command'
+require 'rvc/option_parser'
+require 'rvc/util'
+
+module RVC
+
+# Execution environment for command definitions
+class CommandSlate
+  include RVC::Util
+
+  def initialize ns
+    @ns = ns
+  end
+
+  # Command definition functions
+
+  def opts name, &b
+    fail "command name must be a symbol" unless name.is_a? Symbol
+
+    if name.to_s =~ /[A-Z]/
+      fail "Camel-casing is not allowed (#{name})"
+    end
+
+    parser = OptionParser.new name.to_s, @ns.shell.fs, &b
+    summary = parser.summary?
+
+    parser.specs.each do |opt_name,spec|
+      if opt_name.to_s =~ /[A-Z]/
+        fail "Camel-casing is not allowed (#{name} option #{opt_name})"
+      end
+    end
+
+    @ns.commands[name] = Command.new @ns, name, summary, parser
+  end
+
+  def raw_opts name, summary
+    fail "command name must be a symbol" unless name.is_a? Symbol
+
+    if name.to_s =~ /[A-Z]/
+      fail "Camel-casing is not allowed (#{name})"
+    end
+
+    parser = RawOptionParser.new name.to_s
+
+    @ns.commands[name] = Command.new @ns, name, summary, parser
+  end
+
+  def rvc_completor name, &b
+    fail "command name must be a symbol" unless name.is_a? Symbol
+    cmd = @ns.commands[name] or fail "command #{name} not defined"
+    cmd.completor = b
+  end
+
+  def rvc_alias name, target=nil
+    fail "command name must be a symbol" unless name.is_a? Symbol
+    target ||= name
+
+    cmdpath = [name]
+    cur = @ns
+    while cur.parent
+      cmdpath << cur.name
+      cur = cur.parent
+    end
+    cmdpath.reverse!
+
+    shell.cmds.aliases[target] = cmdpath
+  end
+
+  # Utility functions
+  
+  def shell
+    @ns.shell
+  end
+
+  def lookup path
+    shell.fs.lookup path
+  end
+
+  def lookup_single path
+    shell.fs.lookup_single path
+  end
+
+  def lookup! path, types
+    shell.fs.lookup! path, types
+  end
+
+  def lookup_single! path, types
+    shell.fs.lookup_single! path, types
+  end
+end
+
+end

data/lib/rvc/completion.rb

@@ -35,24 +35,19 @@ if not defined? RbReadline
 end
 
 module RVC
-module Completion
-  Cache = TTLCache.new 10
 
-  Completor = lambda do |word|
-    return unless word
-    begin
-      line = Readline.line_buffer if Readline.respond_to? :line_buffer
-      append_char, candidates = RVC::Completion.complete word, line
-      Readline.completion_append_character = append_char
-      candidates
-    rescue RVC::Util::UserError
-      puts
-      puts $!.message
-      Readline.refresh_line
-    end
+class Completion
+  def initialize shell
+    @shell = shell
+    @cache = TTLCache.new 10
   end
 
-  def self.install
+  # Halt infinite loop when printing exceptions
+  def inspect
+    ""
+  end
+
+  def install
     if Readline.respond_to? :char_is_quoted=
       Readline.completer_word_break_characters = " \t\n\"'"
       Readline.completer_quote_characters = "\"\\"
@@ -60,35 +55,62 @@ module Completion
       Readline.char_is_quoted = is_quoted
     end
 
-    Readline.completion_proc = Completor
+    Readline.completion_proc = lambda { |word| completor(word) }
   end
 
-  def self.complete word, line
-    line ||= ''
-    first_whitespace_index = line.index(' ')
-
-    if Readline.respond_to? :point
-      do_complete_cmd = !first_whitespace_index || first_whitespace_index >= Readline.point
-      do_complete_args = !do_complete_cmd
-    else
-      do_complete_cmd = true
-      do_complete_args = true
+  def completor word
+    return unless word
+    begin
+      line = Readline.line_buffer if Readline.respond_to? :line_buffer
+      point = Readline.point if Readline.respond_to? :point
+      append_char, candidates = complete word, line, point
+      Readline.completion_append_character = append_char
+      candidates
+    rescue RVC::Util::UserError
+      puts
+      puts $!.message
+      Readline.refresh_line
+    rescue
+      puts
+      puts "#{$!.class}: #{$!.message}"
+      $!.backtrace.each do |x|
+        puts x
+      end
+      Readline.refresh_line
     end
+  end
 
+  def complete word, line, point
     candidates = []
 
-    if do_complete_cmd
-      candidates.concat cmd_candidates(word)
-    end
+    if line and point
+      # Full completion capabilities
+      line = line[0...point]
+      first_whitespace_index = line.index(' ')
 
-    if do_complete_args
-      mod, cmd, args = Shell.parse_input line
-      if mod and mod.completor_for cmd
-        candidates.concat RVC::complete_for_cmd(line, word)
+      if !first_whitespace_index
+        # Command
+        candidates.concat cmd_candidates(word)
       else
-        candidates.concat(fs_candidates(word) +
-                          long_option_candidates(mod, cmd, word))
+        # Arguments
+        begin
+          cmdpath, args = Shell.parse_input line
+        rescue ArgumentError
+          # Unmatched double quote
+          cmdpath, args = Shell.parse_input(line+'"')
+        end
+
+        if cmd = @shell.cmds.lookup(cmdpath)
+          args << word if word == ''
+          candidates.concat cmd.complete(word, args)
+        else
+          candidates.concat fs_candidates(word)
+        end
       end
+    else
+      # Limited completion
+      candidates.concat cmd_candidates(word)
+      candidates.concat fs_candidates(word)
     end
 
     if candidates.size == 1
@@ -100,40 +122,49 @@ module Completion
     return append_char, candidates.map(&:first)
   end
 
-  def self.fs_candidates word
+  def fs_candidates word
     child_candidates(word) + mark_candidates(word)
   end
 
-  def self.cmd_candidates word
+  def cmd_candidates word
+    cmdpath = word.split '.'
+    cmdpath << '' if cmdpath.empty? or word[-1..-1] == '.'
+    prefix_regex = /^#{Regexp.escape(cmdpath[-1])}/
+
+    ns = @shell.cmds.lookup(cmdpath[0...-1].map(&:to_sym), RVC::Namespace)
+    return [] unless ns
+
+    cmdpath_prefix = cmdpath[0...-1].join('.')
+    cmdpath_prefix << '.' unless cmdpath_prefix.empty?
+
     ret = []
-    prefix_regex = /^#{Regexp.escape(word)}/
-    MODULES.each do |name,m|
-      m.commands.each { |s| ret << "#{name}.#{s}" }
+
+    ns.commands.each do |cmd_name,cmd|
+      ret << ["#{cmdpath_prefix}#{cmd_name}", ' '] if cmd_name.to_s =~ prefix_regex
+    end
+
+    ns.namespaces.each do |ns_name,ns|
+      ret << ["#{cmdpath_prefix}#{ns_name}.", ''] if ns_name.to_s =~ prefix_regex
+    end
+
+    # Aliases
+    if ns == @shell.cmds then
+      ret.concat @shell.cmds.aliases.keys.map(&:to_s).grep(prefix_regex).map { |x| [x, ' '] }
     end
-    ret.concat ALIASES.keys
-    ret.grep(prefix_regex).sort.
-        map { |x| [x, ' '] }
-  end
 
-  def self.long_option_candidates mod, cmd, word
-    return [] unless mod and cmd
-    parser = mod.opts_for cmd
-    return [] unless parser.is_a? RVC::OptionParser
-    prefix_regex = /^#{Regexp.escape(word)}/
-    parser.specs.map { |k,v| "--#{v[:long]}" }.
-                 grep(prefix_regex).sort.
-                 map { |x| [x, ' '] }
+    ret.sort_by! { |a,b| a }
+    ret
   end
 
   # TODO convert to globbing
-  def self.child_candidates word
+  def child_candidates word
     arcs, absolute, trailing_slash = Path.parse word
     last = trailing_slash ? '' : (arcs.pop || '')
     arcs.map! { |x| x.gsub '\\', '' }
-    base = absolute ? $shell.fs.root : $shell.fs.cur
-    cur = $shell.fs.traverse(base, arcs).first or return []
+    base = absolute ? @shell.fs.root : @shell.fs.cur
+    cur = @shell.fs.traverse(base, arcs).first or return []
     arcs.unshift '' if absolute
-    children = Cache[cur, :children] rescue []
+    children = @cache[cur, :children] rescue []
     children.
       select { |k,v| k.gsub(' ', '\\ ') =~ /^#{Regexp.escape(last)}/ }.
       map { |k,v| (arcs+[k])*'/' }.
@@ -141,10 +172,10 @@ module Completion
       map { |x| [x, '/'] }
   end
 
-  def self.mark_candidates word
+  def mark_candidates word
     return [] unless word.empty? || word[0..0] == '~'
     prefix_regex = /^#{Regexp.escape(word[1..-1] || '')}/
-    $shell.session.marks.grep(prefix_regex).sort.
+    @shell.fs.marks.keys.grep(prefix_regex).sort.
                          map { |x| ["~#{x}", '/'] }
   end
 end