rvc 1.5.0 → 1.6.0

data/lib/rvc/field.rb

@@ -0,0 +1,122 @@
+# 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.
+
+module RVC
+
+module ObjectWithFields
+  module ClassMethods
+    def fields inherited=true
+      @fields ||= {}
+      if inherited
+        ancestors.select { |x| x.respond_to? :fields }.
+                  map { |x| x.fields(false) }.
+                  reverse.inject({}) { |b,v| b.merge v }
+      else
+        @fields
+      end
+    end
+
+    def field name, &b
+      name = name.to_s
+      @fields ||= {}
+      @fields[name] = RVC::Field.new(name).tap { |f| f.instance_eval &b }
+    end
+  end
+
+  def field name
+    name = name.to_s
+    field = self.class.fields[name]
+    if field == nil
+      return nil
+    elsif self.class < VIM::ManagedObject
+      *props = collect *field.properties
+      if field.perfmetrics.length > 0
+        perfmgr = self._connection.serviceContent.perfManager
+        perfopts = field.perfmetric_settings.dup
+        perfopts[:max_samples] ||= 5
+        stats = perfmgr.retrieve_stats [self], field.perfmetrics, perfopts
+        props += field.perfmetrics.map do |x| 
+          if stats[self] 
+            stats[self][:metrics][x]
+          else
+            nil
+          end
+        end
+      end
+    else
+      props = []
+      field.properties.each do |propstr|
+        obj = self
+        propstr.split('.').each { |prop| obj = obj.send(prop) }
+        props << obj
+      end
+    end
+    props = [self] if props.empty?
+    field.block.call *props
+  end
+end
+
+class Field
+  ALL_FIELD_NAMES = Set.new
+
+  def initialize name
+    @name = name
+    @summary = nil
+    @properties = []
+    @perfmetrics = []
+    @perfmetric_settings = {}
+    @block = nil
+    @default = false
+    ALL_FIELD_NAMES << name
+  end
+
+  def summary x=nil
+    x ? (@summary = x) : @summary
+  end
+
+  def properties x=nil
+    x ? (@properties.concat x) : @properties
+  end
+
+  def perfmetrics x=nil
+    x ? (@perfmetrics.concat x) : @perfmetrics
+  end
+
+  def perfmetric_settings x=nil
+    x ? (@perfmetric_settings.merge! x) : @perfmetric_settings
+  end
+
+  def block &x
+    x ? (@block = x) : @block
+  end
+
+  def default val=true
+    @default = val
+  end
+
+  def default?; @default; end
+
+  def property prop
+    @properties = [prop]
+    @block = lambda { |x| x }
+  end
+end
+
+end

data/lib/rvc/filesystem_session.rb

@@ -1,3 +1,23 @@
+# 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.
+
 module RVC
 
 class FilesystemSession

data/lib/rvc/inventory.rb

@@ -18,10 +18,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rvc/field'
+
 module RVC
 
 module InventoryObject
+  include ObjectWithFields
+  extend ObjectWithFields::ClassMethods
+
   module ClassMethods
+    include ObjectWithFields::ClassMethods
+
+    def ls_r
+      ""
+    end
+
     def ls_properties
       %w()
     end
@@ -29,12 +40,20 @@ module InventoryObject
     def folder?
       false
     end
+
+    def traverse?
+      false
+    end
   end
 
   def self.included m
     m.extend ClassMethods
   end
 
+  field 'rel_path' do
+    block { |me| me.rvc_relative_path_str($shell.fs.cur) }
+  end
+
   attr_reader :rvc_parent, :rvc_arc
 
   def display_info
@@ -68,6 +87,22 @@ module InventoryObject
     rvc_path.map { |k,v| k } * '/'
   end
 
+  def rvc_relative_path ref
+    my_path = rvc_path
+    ref_path = ref.rvc_path
+    ref_objs = Set.new(ref_path.map { |x| x[1] })
+    common = my_path.take_while { |x| ref_objs.member? x[1] }
+    fail unless common
+    path_to_ref = my_path.reverse.take_while { |x| x[1] != common.last[1] }.reverse
+    num_ups = ref_path.size - common.size
+    ups = (['..']*num_ups).zip(ref_path.reverse[1..-1].map(&:first))
+    ups + path_to_ref
+  end
+
+  def rvc_relative_path_str ref
+    rvc_relative_path(ref).map { |k,v| k } * '/'
+  end
+
   def rvc_link parent, arc
     return if @rvc_parent
     @rvc_parent = parent
@@ -118,15 +153,3 @@ class RootNode
 end
 
 end
-
-class RbVmomi::VIM
-  include RVC::InventoryObject
-
-  def children
-    rootFolder.children
-  end
-
-  def self.folder?
-    true
-  end
-end

data/lib/rvc/known_hosts.rb

@@ -1,3 +1,23 @@
+# 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 'digest/sha2'
 require 'fileutils'
 require 'rbconfig'

data/lib/rvc/memory_session.rb

@@ -1,3 +1,23 @@
+# 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.
+
 module RVC
 
 class MemorySession

data/lib/rvc/modules.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'rvc/util'
+require 'shellwords'
 
 module RVC
 
@@ -31,6 +32,7 @@ class CmdModule
   def initialize module_name
     @module_name = module_name
     @opts = {}
+    @completors = {}
     super()
   end
 
@@ -38,20 +40,73 @@ class CmdModule
     @opts.keys
   end
 
+  def has_command? cmd
+    @opts.member? cmd
+  end
+
   def opts cmd, &b
-    @opts[cmd] = b
+    if cmd.to_s =~ /[A-Z]/
+      fail "Camel-casing is not allowed (#{cmd.to_s})"
+    end
+
+    @opts[cmd] = OptionParser.new cmd.to_s, &b
+
+    @opts[cmd].specs.each do |name,spec|
+      if name.to_s =~ /[A-Z]/
+        fail "Camel-casing is not allowed (#{cmd.to_s} option #{name})"
+      end
+    end
+  end
+
+  def raw_opts cmd, summary
+    @opts[cmd] = RawOptionParser.new cmd.to_s, summary
   end
 
   def opts_for cmd
     @opts[cmd]
   end
 
+  def rvc_completor cmd, &b
+    @completors[cmd] = b
+  end
+
+  def completor_for cmd
+    @completors[cmd]
+  end
+
   def rvc_alias cmd, target=nil
     target ||= cmd
     RVC::ALIASES[target.to_s] = "#{@module_name}.#{cmd}"
   end
 end
 
+def self.complete_for_cmd line, word
+  if line == nil
+    return []
+  end
+  mod, cmd, args = Shell.parse_input line
+  return [] unless mod != nil
+  #XXX assumes you aren't going to have any positional arguments with spaces
+  if(/ $/.match(line))
+    argnum = args.size
+  else
+    argnum = args.size - 1
+  end
+
+  completor = mod.completor_for(cmd.to_sym)
+  if completor == nil
+    return []
+  end
+
+  candidates = completor.call(line, args, word, argnum)
+  if candidates == nil
+    []
+  else
+    prefix_regex = /^#{Regexp.escape word}/
+    candidates.select { |x,a| x =~ prefix_regex }
+  end
+end
+
 BULTIN_MODULE_PATH = [File.expand_path(File.join(File.dirname(__FILE__), 'modules')),
                       File.join(ENV['HOME'], ".rvc")]
 ENV_MODULE_PATH = (ENV['RVC_MODULE_PATH'] || '').split ':'
@@ -65,13 +120,18 @@ def self.reload_modules verbose=true
   Dir.glob(globs) do |f|
     module_name = File.basename(f)[0...-3]
     puts "loading #{module_name} from #{f}" if verbose
-    code = File.read f
-    unless RVC::MODULES.member? module_name
-      m = CmdModule.new module_name
-      CMD.define_singleton_method(module_name.to_sym) { m }
-      RVC::MODULES[module_name] = m
+    begin
+      code = File.read f
+      unless RVC::MODULES.member? module_name
+        m = CmdModule.new module_name
+        CMD.define_singleton_method(module_name.to_sym) { m }
+        RVC::MODULES[module_name] = m
+      end
+      RVC::MODULES[module_name].instance_eval code, f
+    rescue
+      puts "#{$!.class} while loading #{f}: #{$!.message}"
+      $!.backtrace.each { |x| puts x }
     end
-    RVC::MODULES[module_name].instance_eval code, f
   end
 end
 

data/lib/rvc/modules/alarm.rb

@@ -0,0 +1,37 @@
+# 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.
+
+opts :show do
+  summary "Show alarms on the given entities"
+  arg :entity, nil, :lookup => VIM::ManagedEntity, :multi => true
+end
+
+IGNORE_STATUSES = %w(green gray)
+
+def show objs
+  alarm_states = objs.map(&:triggeredAlarmState).flatten.uniq
+  alarm_states.each do |alarm_state|
+    info = alarm_state.alarm.info
+    colored_alarm_status = status_color alarm_state.overallStatus, alarm_state.overallStatus
+    puts "#{alarm_state.entity.name}: #{info.name} (#{colored_alarm_status}): #{info.description}"
+  end
+end
+
+rvc_alias :show, :alarms

data/lib/rvc/modules/basic.rb

@@ -44,20 +44,18 @@ HELP_ORDER = %w(basic vm)
 def help path
   if mod = RVC::MODULES[path]
     opts = mod.instance_variable_get(:@opts)
-    opts.each do |method_name,method_opts|
-      parser = RVC::OptionParser.new method_name, &method_opts
+    opts.each do |method_name,parser|
       help_summary parser, path, method_name
     end
     return
   elsif tgt = RVC::ALIASES[path]
     fail unless tgt =~ /^(.+)\.(.+)$/
-    opts_block = RVC::MODULES[$1].opts_for($2.to_sym)
-    RVC::OptionParser.new(tgt, &opts_block).educate
+    RVC::MODULES[$1].opts_for($2.to_sym).educate
     return
   elsif path =~ /^(.+)\.(.+)$/ and
         mod = RVC::MODULES[$1] and
-        opts_block = mod.opts_for($2.to_sym)
-    RVC::OptionParser.new(path, &opts_block).educate
+        parser = mod.opts_for($2.to_sym)
+    parser.educate
     return
   end
 
@@ -73,8 +71,7 @@ def help path
     HELP_ORDER.index(mod_name) || HELP_ORDER.size
   end.each do |mod_name,mod|
     opts = mod.instance_variable_get(:@opts)
-    opts.each do |method_name,method_opts|
-      parser = RVC::OptionParser.new method_name, &method_opts
+    opts.each do |method_name,parser|
       next unless obj.nil? or parser.applicable.any? { |x| obj.is_a? x }
       help_summary parser, mod_name, method_name
     end
@@ -105,32 +102,9 @@ rvc_alias :debug
 def debug
   debug = $shell.debug = !$shell.debug
   $shell.connections.each do |name,conn|
-    conn.debug = debug
+    conn.debug = debug if conn.respond_to? :debug
   end
-end
-
-
-opts :quit do
-  summary "Exit RVC"
-end
-
-rvc_alias :quit
-rvc_alias :quit, :exit
-rvc_alias :quit, :q
-
-def quit
-  exit
-end
-
-
-opts :reload do
-  summary "Reload RVC command modules"
-end
-
-rvc_alias :reload
-
-def reload
-  RVC.reload_modules
+  puts "debug mode #{debug ? 'en' : 'dis'}abled"
 end
 
 
@@ -162,6 +136,10 @@ rvc_alias :ls
 rvc_alias :ls, :l
 
 def ls obj
+  if obj.respond_to?(:rvc_ls)
+    return obj.rvc_ls
+  end
+
   children = obj.children
   name_map = children.invert
   children, fake_children = children.partition { |k,v| v.is_a? VIM::ManagedEntity }
@@ -187,7 +165,7 @@ def ls obj
   filteredTypes.each do |x|
     filterSpec.propSet << {
       :type => x.wsdl_name,
-      :pathSet => x.ls_properties+%w(name),
+      :pathSet => x.ls_properties+%w(name overallStatus),
     }
   end
 
@@ -198,22 +176,85 @@ def ls obj
     name = name_map[r.obj]
     text = r.obj.ls_text(r) rescue " (error)"
     realname = r['name'] if name != r['name']
-    puts "#{i} #{name}#{realname && " [#{realname}]"}#{text}"
+    colored_name = status_color name, r['overallStatus']
+    puts "#{i} #{colored_name}#{realname && " [#{realname}]"}#{text}"
     r.obj.rvc_link obj, name
     CMD.mark.mark i.to_s, [r.obj]
     i += 1
   end
 end
 
-
 opts :info do
   summary "Display information about an object"
   arg :path, nil, :lookup => Object
-end  
+end
 
 rvc_alias :info
 rvc_alias :info, :i
 
+opts :show do
+  summary "Display information about an object"
+  arg :arg0, nil, :type => :string
+  arg :arg1, nil, :type => :string, :required => false
+end
+
+rvc_alias :show
+
+rvc_completor :show do |line, args, word, index|
+  choices = RVC::Completion.fs_candidates word
+  obj = lookup_single '.'
+  if index == 0
+    if obj.class == VIM::Datacenter || obj.class == VIM
+      choices << ['portgroups', ' ']
+      choices << ['vds', ' ']
+    end
+    if obj.class < VIM::DistributedVirtualSwitch
+      choices << ['running-config', ' ']
+      choices << ['interface', ' ']
+      #choices << ['vlan', ' ']
+      #choices << ['lldp', ' ']
+      #choices << ['cdp', ' ']
+    end
+  #elsif index == 1
+  #  if args[0] == 'vlan'
+  #    choices << ['summary', ' ']
+  #  end
+  end
+  choices
+end
+
+def show arg0, arg1
+  arg1 ||= '.'
+  begin
+    obj = lookup_single arg1
+  rescue
+    obj = nil
+  end
+
+  case arg0
+  when 'running-config'
+    if obj.class < VIM::DistributedVirtualSwitch
+      MODULES['vds'].show_running_config obj
+    else
+      if arg1 != '.'
+        err "'#{arg1}' is not a vDS!"
+      else
+        err "you need to be inside a vDS"
+      end
+    end
+  when 'portgroups'
+    MODULES['vds'].show_all_portgroups [obj]
+  when 'vds'
+    MODULES['vds'].show_all_vds [obj]
+  when 'interface'
+    MODULES['vds'].show_all_ports [obj]
+  #when 'vlan'
+  else
+    path = lookup_single arg0
+    info path
+  end
+end
+
 def info obj
   puts "path: #{obj.rvc_path_str}"
   if obj.respond_to? :display_info
@@ -248,15 +289,15 @@ def reload_entity objs
 end
 
 
-opts :show do
+opts :what do
   summary "Basic information about the given objects"
   arg :obj, nil, :multi => true, :required => false, :lookup => Object
 end
 
-rvc_alias :show
-rvc_alias :show, :w
+rvc_alias :what
+rvc_alias :what, :w
 
-def show objs
+def what objs
   objs.each do |obj|
     puts "#{obj.rvc_path_str}: #{obj.class}"
   end
@@ -344,3 +385,93 @@ def events obj, opts
 ensure
   collector.DestroyCollector if collector
 end
+
+
+opts :fields do
+  summary "Show available fields on an object"
+  arg :obj, nil, :required => false, :default => '.', :lookup => RVC::InventoryObject
+end
+
+def fields obj
+  obj.class.ancestors.select { |x| x.respond_to? :fields }.each do |klass|
+    fields = klass.fields false
+    next if fields.empty?
+    puts "Fields on #{klass}:"
+    fields.each do |name,field|
+      puts " #{name}: #{field.summary}"
+    end
+  end
+end
+
+rvc_alias :fields
+
+
+opts :table do
+  summary "Display a table with the selected fields"
+
+  text <<-EOS
+
+You may specify the fields to display using multiple -f options, or
+separate them with ':'. The available fields for an object are
+shown by the "fields" command.
+  EOS
+  text ""
+
+  arg :obj, nil, :multi => true, :lookup => RVC::InventoryObject
+  opt :field, "Field to display", :multi => true, :type => :string
+  opt :sort, "Field to sort by", :type => :string
+  opt :reverse, "Reverse sort order"
+end
+
+rvc_completor :table do |line, args, word, argnum|
+  if argnum > 0 and args[argnum-1] == '-f'
+    RVC::Field::ALL_FIELD_NAMES.map { |x| [x, ' '] }
+  else
+    RVC::Completion.fs_candidates word
+  end
+end
+
+def table objs, opts
+  if opts[:field_given]
+    fields = opts[:field].map { |x| x.split ':' }.flatten(1)
+  else
+    fields = objs.map(&:class).uniq.
+                  map { |x| x.fields.select { |k,v| v.default? } }.
+                  map(&:keys).flatten(1).uniq
+  end
+
+  data = retrieve_fields(objs, fields).values
+
+  if f = opts[:sort]
+    data.sort! { |a,b| table_sort_compare a[f], b[f] }
+    data.reverse! if opts[:reverse]
+  end
+
+  # Invert field components to get an array of header rows
+  field_components = fields.map { |x| x.split '.' }
+  header_rows = []
+  field_components.each_with_index do |cs,i|
+    cs.each_with_index do |c,j|
+      header_rows[j] ||= [nil]*field_components.length
+      header_rows[j][i] = c
+    end
+  end
+  
+  table = Terminal::Table.new
+  header_rows.each { |row| table.add_row row }
+  table.add_separator
+  data.each do |h|
+    table.add_row(fields.map { |f| h[f] == nil ? 'N/A' : h[f] })
+  end
+  puts table
+end
+
+def table_sort_compare a, b
+  return a <=> b if a != nil and b != nil
+  return 0 if a == nil and b == nil
+  return -1 if a == nil
+  return 1 if b == nil
+  fail
+end
+
+rvc_alias :table