rvc 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+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.

data/README.rdoc

@@ -0,0 +1,120 @@
+= RVC - Ruby vSphere Console
+
+== Introduction
+
+RVC is a console UI for VMware ESX and VirtualCenter. The vSphere object graph
+is presented as a virtual filesystem, allowing you to navigate and run commands
+against managed entities using familiar shell syntax. RVC doesn't (yet) have
+every feature vSphere Client does, but for common tasks it can be much more
+efficient than clicking through a GUI.
+
+== Installation
+
+    gem install rvc
+
+== Usage
+
+  % rvc 192.168.1.105
+  username: Administrator
+  password:
+  0 dc (datacenter)
+  192.168.1.105:/> cd dc/host/192.168.1.100/
+  192.168.1.105:/dc/host/192.168.1.100/> ls
+  0 host [192.168.1.100] (host): cpu 2*2*2.81 GHz, memory 2.00 GB
+  1 resourcePool [Resources]: cpu 4.35/4.35/normal, mem 0.48/0.48/normal
+  192.168.1.105:/dc/host/192.168.1.100/> ls host/vms/
+  0 foo: poweredOn
+  192.168.1.105:/dc/host/192.168.1.100/> i host/vms/foo
+  name: foo
+  host: dc/host/192.168.1.100/192.168.1.100
+  tools: guestToolsNotRunning
+  VC UUID: 5259d5d2-b767-43c9-db6d-fbf5cc4b6f02
+  power: poweredOn
+  cpus: 1
+  memory: 128 MB
+  nics:
+   Network adapter 1: "VM Network" connected 00:0c:29:c6:5d:2a 
+  192.168.1.105:/dc/host/192.168.1.100/> off host/vms/foo
+  PowerOffVM foo: success
+  192.168.1.105:/dc/host/192.168.1.100/> quit
+
+Enter "help" to see a list of all available commands.
+
+All RVC commands exist in modules, and may optionally have aliases. For
+example, the command to power off a VM is actually "vm.off", since it exists in
+the "vm" module, but since it is a common operation it has been aliased to
+"off".
+
+== Features
+
+=== Tab-completion
+
+Commands and paths can be tab completed in the usual fashion. Whitespace must
+be escaped with a backslash.
+
+=== Marks
+
+  192.168.1.105:/> mark a dc/vm/foo
+  192.168.1.105:/> on ~a
+  PowerOnVM foo: success
+  192.168.1.105:/> off ~a
+  PowerOffVM foo: success
+
+Marks allow you to save a path for later use. Refer to a mark by prefixing its
+name with a tilde. The "ls" command automatically creates numeric marks for
+each object listed; these are the numbers in the first column. As a special
+case, you don't need to use a tilde with numeric marks. The "cd" command
+automatically creates the mark "~~" pointing to the previous directory. If a
+mark reference is input instead of a command then RVC will cd to the marked
+object. Thus, "~~" is a convenient way to toggle between two directories.
+
+When the working directory is a descendant of a Datacenter object, the mark "~"
+refers to the Datacenter. For example "~/datastore" is a convenient way to get
+the datastore folder of the current datacenter.
+
+=== Ruby mode
+
+Beginning an input line with "/" causes RVC to treat it as Ruby code and eval
+it. This gives you direct access to the underlying RbVmomi library. If the line
+"//" is input then RVC will toggle between shell and Ruby mode.
+
+Marks can be easily used in Ruby mode since there are magic variables with the
+same names. Since some marks, like numeric ones, aren't valid variable names,
+they also exist with a "_" prefix.
+
+The methods "this", "conn", and "dc" are provided in Ruby mode, returning the
+current object, connection, and datacenter respectively. The connection object
+is an instance of RbVmomi::VIM.
+
+=== VMODL introspection
+
+The "type" command can be used to display the properties and methods of a VMODL
+class. For example: "type Datacenter".
+
+In Ruby mode, a '#' at the end of the input line will display the output of the
+"type" command for the resulting object's class. This is very useful for
+exploring the vSphere API.
+
+=== Multiple connections
+
+RVC can connect to more than one ESX or VC server at the same time. Simply add
+more hosts to the command line, or use the command "connect". Each connection
+is represented by a top-level node in the virtual filesystem. If more than one
+host is given on the command line, RVC will start in the root of the filesystem
+instead of automatically cd'ing to a connection.
+
+== Extensibility
+
+RVC is designed to let users easily add commands they need. You can create a
+command module, or add to an existing one, by adding a Ruby file to ~/.rvc or
+any directory on the RVC_MODULE_PATH environment variable. The syntax of a user
+command module is the same as those built-in to RVC, so see the
+"lib/rvc/modules" directory for examples.
+
+If you create a generically useful RVC command, please consider sending in a
+patch so everyone can use it.
+
+== Development
+
+Send patches to rlane@vmware.com, or fork the project on GitHub and send me a
+pull request.

data/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rvc"
+    gem.summary = "vSphere console UI"
+    #gem.description = ""
+    gem.email = "rlane@vmware.com"
+    #gem.homepage = ""
+    gem.authors = ["Rich Lane"]
+    gem.add_dependency 'rbvmomi', '>= 1.1.5'
+    gem.add_dependency 'trollop', '>= 1.16.2'
+    gem.add_dependency 'backports', '>= 1.18.2'
+    gem.add_dependency 'ffi', '>= 1.0.7'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+  t.ruby_opts << "-rubygems"
+end
+ 
+begin
+  require 'rcov/rcovtask'
+  desc 'Measures test coverage using rcov'
+  Rcov::RcovTask.new do |rcov|
+    rcov.pattern    = 'test/test_*.rb'
+    rcov.output_dir = 'coverage'
+    rcov.verbose    = true
+    rcov.libs << "test"
+    rcov.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  puts "Rcov not available. Install it with: gem install rcov"
+end

data/TODO

@@ -0,0 +1,4 @@
+add commands for more entities
+add fake subfolders for more entities
+add fastpass authentication
+globbing?

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/rvc

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# 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 'readline'
+require 'pp'
+require 'trollop'
+require 'rbvmomi'
+require 'rbvmomi/trollop'
+require 'shellwords'
+require 'yaml'
+require 'backports'
+require 'rvc'
+
+VIM = RbVmomi::VIM
+include RVC::Util
+
+Thread.abort_on_exception = true
+
+CMD = Module.new
+
+$opts = Trollop.options do
+  banner <<-EOS
+Ruby vSphere Console.
+
+Usage:
+       rvc [options] [username[:password]@]hostname
+
+where [options] are:
+EOS
+
+  opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
+  opt :path, "Initial directory", :short => :none, :default => ENV['RVC_PATH'], :type => :string
+  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
+end
+
+Trollop.die "At least 1 argument expected" unless ARGV.length >= 1
+
+RVC.reload_modules false
+
+$shell = RVC::Shell.new
+
+ARGV.each do |uri|
+  begin
+    puts "Connecting to #{uri}..." if ARGV.size > 1
+    CMD.vim.connect uri, :insecure => $opts[:insecure]
+  rescue UserError
+    puts "Failed to connect to #{uri}: #{$!.message}"
+    exit 1
+  end
+end
+
+RVC::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."
+history = File.open(history_fn, 'a')
+
+if $opts[:path]
+  begin
+    CMD.basic.cd $opts[:path]
+  rescue UserError
+    raise unless $opts[:create_directory]
+    parent_path = File.dirname($opts[:path])
+    lookup(parent_path).CreateFolder(:name => File.basename($opts[:path]))
+    CMD.basic.cd $opts[:path]
+  end
+elsif ARGV.size == 1
+  CMD.basic.cd $shell.connections.keys.first
+end
+
+unless CMD.vmrc.find_vmrc
+  $stderr.puts "VMRC is not installed. You will be unable to view virtual machine consoles. Use the vmrc.install command to install it."
+end
+
+CMD.basic.ls '.'
+
+while true
+  begin
+    input = $opts[:cmd].shift || Readline.readline($shell.prompt, false) or break
+    input = input.strip
+    next if input.empty?
+    (history.puts input; Readline::HISTORY << input) unless input == Readline::HISTORY.to_a[-1]
+    $shell.eval_input input
+  rescue Interrupt
+    puts
+  end
+end

data/lib/rvc.rb

@@ -0,0 +1,31 @@
+# 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 'rbvmomi'
+require 'rvc/inventory'
+require 'rvc/modules'
+require 'rvc/util'
+require 'rvc/path'
+require 'rvc/fs'
+require 'rvc/completion'
+require 'rvc/option_parser'
+require 'rvc/shell'
+
+RbVmomi::VIM.extension_dirs << File.join(File.dirname(__FILE__), "rvc/extensions")

data/lib/rvc/completion.rb

@@ -0,0 +1,110 @@
+# 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 'readline'
+require 'rvc/ttl_cache'
+
+begin
+  require 'rvc/readline-ffi'
+rescue Exception
+end
+
+module RVC
+module Completion
+  Cache = TTLCache.new 10
+
+  Completor = lambda do |word|
+    return unless word
+    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
+  end
+
+  def self.install
+    unless Readline.respond_to? :line_buffer and
+           Readline.respond_to? :char_is_quoted=
+      $stderr.puts "Install the \"ffi\" gem for better tab completion."
+    end
+
+    if Readline.respond_to? :char_is_quoted=
+      Readline.completer_word_break_characters = " \t\n\"'"
+      Readline.completer_quote_characters = "\"\\"
+      is_quoted = lambda { |str,i| i > 0 && str[i-1] == '\\' && !is_quoted[str,i-1] }
+      Readline.char_is_quoted = is_quoted
+    end
+
+    Readline.completion_proc = Completor
+  end
+
+  def self.complete word, line
+    candidates = if line
+      if line[' ']
+        child_candidates(word)
+      else
+        cmd_candidates(word)
+      end
+    else
+      child_candidates(word) + cmd_candidates(word)
+    end
+
+    candidates += mark_candidates(word)
+
+    if candidates.size == 1 and cmd_candidates(word).member?(candidates[0])
+      append_char = ' '
+    else
+      append_char = '/'
+    end
+
+    return append_char, candidates
+  end
+
+  def self.cmd_candidates word
+    ret = []
+    prefix_regex = /^#{Regexp.escape(word)}/
+    MODULES.each do |name,m|
+      m.commands.each { |s| ret << "#{name}.#{s}" }
+    end
+    ret.concat ALIASES.keys
+    ret.sort.select { |e| e.match(prefix_regex) }
+  end
+
+  def self.child_candidates word
+    els, absolute, trailing_slash = Path.parse word
+    last = trailing_slash ? '' : (els.pop || '')
+    els.map! { |x| x.gsub '\\', '' }
+    base_loc = absolute ? Location.new($shell.fs.root) : $shell.fs.loc
+    found_loc = $shell.fs.traverse(base_loc, els) or return []
+    cur = found_loc.obj
+    els.unshift '' if absolute
+    children = Cache[cur, :children] rescue []
+    children.
+      select { |k,v| k.gsub(' ', '\\ ') =~ /^#{Regexp.escape(last)}/ }.
+      map { |k,v| (els+[k])*'/' }.
+      map { |x| x.gsub ' ', '\\ ' }
+  end
+
+  def self.mark_candidates word
+    return [] unless word.empty? || word[0..0] == '~'
+    prefix_regex = /^#{Regexp.escape(word[1..-1] || '')}/
+    $shell.fs.marks.keys.sort.grep(prefix_regex).map { |x| "~#{x}" }
+  end
+end
+end

data/lib/rvc/extensions/ClusterComputeResource.rb

@@ -0,0 +1,42 @@
+# 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.
+
+class RbVmomi::VIM::ClusterComputeResource
+  def self.ls_properties
+    %w(name summary.effectiveCpu summary.effectiveMemory)
+  end
+
+  def ls_text r
+    " (cluster): cpu #{r['summary.effectiveCpu']/1000} GHz, memory #{r['summary.effectiveMemory']/1000} GB"
+  end
+
+  # TODO add datastore, network
+  def children
+    hosts, resourcePool = collect *%w(host resourcePool)
+    {
+      'hosts' => RVC::FakeFolder.new(self, :rvc_host_children),
+      'resourcePool' => resourcePool,
+    }
+  end
+
+  def rvc_host_children
+    RVC::Util.collect_children self, :host
+  end
+end