rvc 1.0.0

data/lib/rvc/modules/vmrc.rb

@@ -0,0 +1,72 @@
+# 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 'tmpdir'
+
+VMRC_NAME = "vmware-vmrc-linux-x86-3.0.0"
+VMRC_PKGVER = 1
+VMRC_URL = "https://github.com/downloads/vmware/rvc/#{VMRC_NAME}.#{VMRC_PKGVER}.tar.bz2"
+
+def find_local_vmrc
+  path = File.join(Dir.tmpdir, VMRC_NAME, 'plugins', 'vmware-vmrc')
+  File.exists?(path) && path
+end
+
+def find_vmrc
+  find_local_vmrc || search_path('vmrc')
+end
+
+
+opts :view do
+  summary "Spawn a VMRC"
+  arg :vm, nil, :lookup => VIM::VirtualMachine, :multi => true
+end
+
+rvc_alias :view
+rvc_alias :view, :vmrc
+rvc_alias :view, :v
+
+def view vms
+  err "VMRC not found" unless vmrc = find_vmrc
+  vms.each do |vm|
+    moref = vm._ref
+    ticket = vm._connection.serviceInstance.content.sessionManager.AcquireCloneTicket
+    host = vm._connection._host
+    fork do
+      ENV['https_proxy'] = ENV['HTTPS_PROXY'] = ''
+      $stderr.reopen("#{ENV['HOME']||'.'}/.rvc-vmrc.log", "w")
+      $stderr.puts Time.now
+      Process.setpgrp
+      exec vmrc, '-M', moref,
+                 '-h', host,
+                 '-p', ticket
+    end
+  end
+end
+
+opts :install do
+  summary "Install VMRC"
+end
+
+def install
+  puts "Installing VMRC..."
+  system "curl -L #{VMRC_URL} | tar -xj -C #{Dir.tmpdir}" or err("VMRC installation failed")
+  puts "VMRC was installed successfully."
+end

data/lib/rvc/modules/vnc.rb

@@ -0,0 +1,111 @@
+# 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.
+
+VNC = ENV['VNC'] || search_path('vinagre') || search_path('tightvnc')
+
+opts :view do
+  summary "Spawn a VNC client"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+end
+
+rvc_alias :view, :vnc
+rvc_alias :view, :V
+
+def view vm
+  ip = reachable_ip vm.runtime.host
+  extraConfig = vm.config.extraConfig
+  already_enabled = extraConfig.find { |x| x.key == 'RemoteDisplay.vnc.enabled' && x.value.downcase == 'true' }
+  if already_enabled
+    puts "VNC already enabled"
+    port = extraConfig.find { |x| x.key == 'RemoteDisplay.vnc.port' }.value
+    password = extraConfig.find { |x| x.key == 'RemoteDisplay.vnc.password' }.value
+  else
+    port = unused_vnc_port ip
+    password = vnc_password
+    vm.ReconfigVM_Task(:spec => {
+      :extraConfig => [
+        { :key => 'RemoteDisplay.vnc.enabled', :value => 'true' },
+        { :key => 'RemoteDisplay.vnc.password', :value => password },
+        { :key => 'RemoteDisplay.vnc.port', :value => port.to_s }
+      ]
+    }).wait_for_completion
+  end
+  vnc_client ip, port, password
+end
+
+
+opts :off do
+  summary "Close a VM's VNC port"
+  arg :vm, nil, :lookup => VIM::VirtualMachine
+end
+
+def off vm
+  vm.ReconfigVM_Task(:spec => {
+    :extraConfig => [
+      { :key => 'RemoteDisplay.vnc.enabled', :value => 'false' },
+      { :key => 'RemoteDisplay.vnc.password', :value => '' },
+      { :key => 'RemoteDisplay.vnc.port', :value => '' }
+    ]
+  }).wait_for_completion
+end
+
+
+def reachable_ip host
+  ips = host.config.network.vnic.map { |x| x.spec.ip.ipAddress } # TODO optimize
+  ips.find do |x|
+    begin
+      Timeout.timeout(1) { TCPSocket.new(x, 443).close; true }
+    rescue
+      false
+    end
+  end or err("could not find IP for server #{host.name}")
+end
+
+def unused_vnc_port ip
+  10.times do
+    port = 5901 + rand(64)
+    unused = (TCPSocket.connect(ip, port).close rescue true)
+    return port if unused
+  end
+  err "no unused port found"
+end
+
+# Override this if you don't want a random password
+def vnc_password
+  n = 8
+  chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
+  (0...n).map { chars[rand(chars.length)].chr }.join
+end
+
+# Override this to spawn a VNC client differently
+def vnc_client ip, port, password
+  if VNC
+    fork do
+      $stderr.reopen("#{ENV['HOME']||'.'}/.rvc-vmrc.log", "w")
+      Process.setpgrp
+      exec VNC, "#{ip}:#{port}"
+    end
+    puts "spawning #{VNC}"
+    puts "#{ip}:#{port} password: #{password}"
+  else
+    puts "no VNC client configured"
+    puts "#{ip}:#{port} password: #{password}"
+  end
+end

data/lib/rvc/option_parser.rb

@@ -0,0 +1,114 @@
+# 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 'trollop'
+
+module RVC
+
+class OptionParser < Trollop::Parser
+  attr_reader :applicable
+
+  def initialize cmd, &b
+    @cmd = cmd
+    @summary = nil
+    @args = []
+    @has_options = false
+    @seen_not_required = false
+    @seen_multi = false
+    @applicable = Set.new
+    super &b
+  end
+
+  def summary str
+    @summary = str
+    text str
+  end
+
+  def summary?
+    @summary
+  end
+
+  def opt name, *a
+    super
+    @applicable << @specs[name][:lookup] if @specs[name][:lookup]
+    @has_options = true unless name == :help
+  end
+
+  def has_options?
+    @has_options
+  end
+
+  def arg name, description, opts={}
+    opts = {
+      :required => true,
+      :default => nil,
+      :multi => false,
+    }.merge opts
+    opts[:default] = [] if opts[:multi] and opts[:default].nil?
+    fail "Multi argument must be the last one" if @seen_multi
+    fail "Can't have required argument after optional ones" if opts[:required] and @seen_not_required
+    @applicable << opts[:lookup] if opts[:lookup]
+    @args << [name, description, opts[:required], opts[:default], opts[:multi], opts[:lookup]]
+    text "  #{name}: " + [description, opts[:lookup]].compact.join(' ')
+  end
+
+  def parse argv
+    opts = super argv
+
+    @specs.each do |name,spec|
+      next unless klass = spec[:lookup] and path = opts[name]
+      opts[name] = lookup! path, klass
+    end
+
+    argv = leftovers
+    args = []
+    @args.each do |name,desc,required,default,multi,lookup_klass|
+      if multi
+        err "missing argument '#{name}'" if required and argv.empty?
+        a = (argv.empty? ? default : argv.dup)
+        a.map! { |x| lookup! x, lookup_klass } if lookup_klass
+        args << a
+        argv.clear
+      else
+        x = argv.shift
+        err "missing argument '#{name}'" if required and x.nil?
+        x = default if x.nil?
+        x = lookup! x, lookup_klass if lookup_klass
+        args << x
+      end
+    end
+    err "too many arguments" unless argv.empty?
+    return args, opts
+  end
+
+  def educate
+    arg_texts = @args.map do |name,desc,required,default,multi,lookup_klass|
+      text = name
+      text = "[#{text}]" if not required
+      text = "#{text}..." if multi
+      text
+    end
+    arg_texts.unshift "[opts]" if has_options?
+    puts "usage: #{@cmd} #{arg_texts*' '}"
+    super
+  end
+end
+
+end

data/lib/rvc/path.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.
+
+module RVC
+module Path
+  def self.parse path
+    if path.empty?
+      return [[], false, false]
+    elsif path == '/'
+      return [[], true, true]
+    else
+      els = path.split '/'
+      trailing_slash = path[-1..-1] == '/'
+      absolute = !els[0].nil? && els[0].empty?
+      els.shift if absolute
+      [els, absolute, trailing_slash]
+    end
+  end
+end
+end

data/lib/rvc/readline-ffi.rb

@@ -0,0 +1,41 @@
+# 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 'ffi'
+
+module RVC::ReadlineFFI
+  extend FFI::Library
+  ffi_lib "readline.so"
+  callback :rl_linebuf_func_t, [ :string, :int ], :bool
+  attach_variable :rl_char_is_quoted_p, :rl_char_is_quoted_p, :rl_linebuf_func_t
+  attach_variable :rl_line_buffer, :rl_line_buffer, :string
+end
+
+unless Readline.respond_to? :line_buffer
+  def Readline.line_buffer
+    RVC::ReadlineFFI.rl_line_buffer
+  end
+end
+
+unless Readline.respond_to? :char_is_quoted=
+  def Readline.char_is_quoted= fn
+    RVC::ReadlineFFI.rl_char_is_quoted_p = fn
+  end
+end

data/lib/rvc/shell.rb

@@ -0,0 +1,220 @@
+# 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 Shell
+  attr_reader :fs, :connections
+  attr_accessor :debug
+
+  def initialize
+    @persist_ruby = false
+    @fs = RVC::FS.new RVC::RootNode.new
+    @ruby_evaluator = RubyEvaluator.new @fs
+    @connections = {}
+    @debug = false
+  end
+
+  def eval_input input
+    if input == '//'
+      @persist_ruby = !@persist_ruby
+      return
+    end
+
+    if input[0..0] == '!'
+      system_fg input[1..-1]
+      return
+    end
+
+    ruby = @persist_ruby
+    if input =~ /^\//
+      input = $'
+      ruby = !ruby
+    end
+
+    begin
+      if ruby
+        eval_ruby input
+      else
+        eval_command input
+      end
+    rescue SystemExit, IOError
+      raise
+    rescue UserError, RuntimeError, RbVmomi::Fault
+      if ruby or debug
+        puts "#{$!.class}: #{$!.message}"
+        puts $!.backtrace * "\n"
+      else
+        case $!
+        when RbVmomi::Fault, UserError
+          puts $!.message
+        else
+          puts "#{$!.class}: #{$!.message}"
+        end
+      end
+    rescue Exception
+      puts "#{$!.class}: #{$!.message}"
+      puts $!.backtrace * "\n"
+    end
+  end
+
+  def eval_command input
+    cmd, *args = Shellwords.shellwords(input)
+    return unless cmd
+    err "invalid command" unless cmd.is_a? String
+    case cmd
+    when RVC::FS::MARK_REGEX
+      CMD.basic.cd cmd
+    else
+      if cmd.include? '.'
+        module_name, cmd, = cmd.split '.'
+      elsif ALIASES.member? cmd
+        module_name, cmd, = ALIASES[cmd].split '.'
+      else
+        err "unknown alias #{cmd}"
+      end
+
+      m = MODULES[module_name] or err("unknown module #{module_name}")
+
+      opts_block = m.opts_for(cmd.to_sym)
+      parser = RVC::OptionParser.new cmd, &opts_block
+
+      begin
+        args, opts = parser.parse args
+      rescue Trollop::HelpNeeded
+        parser.educate
+        return
+      end
+
+      if parser.has_options?
+        m.send cmd.to_sym, *(args + [opts])
+      else
+        m.send cmd.to_sym, *args
+      end
+    end
+    nil
+  end
+
+  def eval_ruby input
+    result = @ruby_evaluator.do_eval input
+    if input =~ /\#$/
+      introspect_object result
+    else
+      pp result
+    end
+    nil
+  end
+
+  def prompt
+    "#{@fs.display_path}#{@persist_ruby ? '~' : '>'} "
+  end
+
+  def introspect_object obj
+    case obj
+    when RbVmomi::VIM::DataObject, RbVmomi::VIM::ManagedObject
+      introspect_class obj.class
+    when Array
+      klasses = obj.map(&:class).uniq
+      if klasses.size == 0
+        puts "Array"
+      elsif klasses.size == 1
+        $stdout.write "Array of "
+        introspect_class klasses[0]
+      else
+        counts = Hash.new 0
+        obj.each { |o| counts[o.class] += 1 }
+        puts "Array of:"
+        counts.each { |k,c| puts "  #{k}: #{c}" }
+        puts
+        $stdout.write "Common ancestor: "
+        introspect_class klasses.map(&:ancestors).inject(&:&)[0]
+      end
+    else
+      puts obj.class
+    end
+  end
+
+  def introspect_class klass
+    q = lambda { |x| x =~ /^xsd:/ ? $' : x }
+    if klass < RbVmomi::VIM::DataObject
+      puts "Data Object #{klass}"
+      klass.full_props_desc.each do |desc|
+        puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+      end
+    elsif klass < RbVmomi::VIM::ManagedObject
+      puts "Managed Object #{klass}"
+      puts
+      puts "Properties:"
+      klass.full_props_desc.each do |desc|
+        puts " #{desc['name']}: #{q[desc['wsdl_type']]}#{desc['is-array'] ? '[]' : ''}"
+      end
+      puts
+      puts "Methods:"
+      klass.full_methods_desc.sort_by(&:first).each do |name,desc|
+        params = desc['params']
+        puts " #{name}(#{params.map { |x| "#{x['name']} : #{q[x['wsdl_type'] || 'void']}#{x['is-array'] ? '[]' : ''}" } * ', '}) : #{q[desc['result']['wsdl_type'] || 'void']}"
+      end
+    else
+      puts klass
+    end
+  end
+end
+
+class RubyEvaluator
+  def initialize fs
+    @binding = binding
+    @fs = fs
+  end
+
+  def do_eval input
+    eval input, @binding
+  end
+
+  def this
+    @fs.cur
+  end
+
+  def dc
+    @fs.lookup("~")
+  end
+
+  def conn
+    @fs.lookup("~@")
+  end
+
+  def method_missing sym, *a
+    str = sym.to_s
+    if a.empty?
+      if MODULES.member? str
+        MODULES[str]
+      elsif @fs.marks.member?(str)
+        @fs.marks[str].obj
+      elsif str[0..0] == '_' && @fs.marks.member?(str[1..-1])
+        @fs.marks[str[1..-1]].obj
+      else
+        super
+      end
+    else
+      super
+    end
+  end
+end
+
+end