rvc 1.0.0

data/lib/rvc/ttl_cache.rb

@@ -0,0 +1,44 @@
+# 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 TTLCache
+  Entry = Struct.new(:value, :time)
+
+  def initialize ttl
+    @ttl = ttl
+    @cache = {}
+  end
+
+  def [] obj, sym, *args
+    @cache.delete_if { |k,v| v.time + @ttl < Time.now }
+    key = [obj,sym,*args]
+    if e = @cache[key]
+      e.value
+    else
+      value = obj.send(sym, *args)
+      @cache[key] = Entry.new value, Time.now
+      value
+    end
+  end
+end
+
+end

data/lib/rvc/util.rb

@@ -0,0 +1,168 @@
+# 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 Util
+  extend self
+
+  def lookup path
+    $shell.fs.lookup path
+  end
+
+  def lookup! path, type
+    lookup(path).tap do |obj|
+      err "Not found: #{path.inspect}" unless obj
+      err "Expected #{type} but got #{obj.class} at #{path.inspect}" unless obj.is_a? type
+    end
+  end
+
+  def menu items
+    items.each_with_index { |x, i| puts "#{i} #{x}" }
+    input = Readline.readline("? ", false)
+    return if !input or input.empty?
+    items[input.to_i]
+  end
+
+  def display_inventory tree, folder, indent=0, &b
+    tree[folder].sort_by { |k,(o,h)| o._ref }.each do |k,(o,h)|
+      case o
+      when VIM::Folder
+        puts "#{"  "*indent}--#{k}"
+        display_inventory tree, o, (indent+1), &b
+      else
+        b[o,h,indent]
+      end
+    end
+  end
+
+  def search_path bin
+    ENV['PATH'].split(':').each do |x|
+      path = File.join(x, bin)
+      return path if File.exists? path
+    end
+    nil
+  end
+
+  UserError = Class.new(Exception)
+  def err msg
+    raise UserError.new(msg)
+  end
+
+  def single_connection objs
+    conns = objs.map { |x| x._connection rescue nil }.compact.uniq
+    err "No connections" if conns.size == 0
+    err "Objects span multiple connections" if conns.size > 1
+    conns[0]
+  end
+
+  def tasks objs, sym, args={}
+    progress(objs.map { |obj| obj._call :"#{sym}_Task", args })
+  end
+
+  def progress tasks
+    interested = %w(info.progress info.state info.entityName info.error info.name)
+    connection = single_connection tasks
+    connection.serviceInstance.wait_for_multiple_tasks interested, tasks do |h|
+      if interactive?
+        h.each do |task,props|
+          state, entityName, name = props['info.state'], props['info.entityName'], props['info.name']
+          name = $` if name =~ /_Task$/
+          if state == 'running'
+            text = "#{name} #{entityName}: #{state} "
+            progress = props['info.progress']
+            barlen = terminal_columns - text.size - 2
+            progresslen = ((progress||0)*barlen)/100
+            progress_bar = "[#{'=' * progresslen}#{' ' * (barlen-progresslen)}]"
+            $stdout.write "\e[K#{text}#{progress_bar}\n"
+          elsif state == 'error'
+            error = props['info.error']
+            $stdout.write "\e[K#{name} #{entityName}: #{error.fault.class.wsdl_name}: #{error.localizedMessage}\n"
+          else
+            $stdout.write "\e[K#{name} #{entityName}: #{state}\n"
+          end
+        end
+        $stdout.write "\e[#{h.size}A"
+        $stdout.flush
+      end
+    end
+    $stdout.write "\e[#{tasks.size}B" if interactive?
+    true
+  end
+
+  def terminal_columns
+    begin
+      require 'curses'
+      Curses.cols
+    rescue LoadError
+      80
+    end
+  end
+
+  def interactive?
+    terminal_columns > 0
+  end
+
+  def tcsetpgrp pgrp=Process.getpgrp
+    return unless $stdin.tty?
+    trap('TTOU', 'SIG_IGN')
+    $stdin.ioctl 0x5410, [pgrp].pack('I')
+    trap('TTOU', 'SIG_DFL')
+  end
+
+  def system_fg cmd, env={}
+    pid = fork do
+      env.each { |k,v| ENV[k] = v }
+      Process.setpgrp
+      tcsetpgrp
+      exec cmd
+    end
+    Process.waitpid2 pid
+    tcsetpgrp
+    nil
+  end
+
+  def collect_children obj, path
+    spec = {
+      :objectSet => [
+        {
+          :obj => obj,
+          :skip => true,
+          :selectSet => [
+            RbVmomi::VIM::TraversalSpec(
+              :path => path,
+              :type => obj.class.wsdl_name
+            )
+          ]
+        }
+      ],
+      :propSet => [
+        {
+          :type => 'ManagedEntity',
+          :pathSet => %w(name),
+        }
+      ]
+    }
+
+    results = obj._connection.propertyCollector.RetrieveProperties(:specSet => [spec])
+
+    Hash[results.map { |r| [r['name'], r.obj] }]
+  end
+end
+end

data/test/_test_completion.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'rvc'
+require 'inventory_fixtures'
+
+class CompletionTest < Test::Unit::TestCase
+  NodeBaz = FixtureNode.new
+  NodeBar = FixtureNode.new
+  NodeFoo = FixtureNode.new('bar' => NodeBar, 'baz' => NodeBaz)
+  Root = FixtureNode.new('foo' => NodeFoo)
+
+  def check word, expected
+    got = RVC::Completion::Completor[word]
+    assert_equal expected, got
+  end
+
+  def setup
+    @context = RVC::Context.new Root
+  end
+
+  def teardown
+    @context = nil
+  end
+
+  def test_simple
+    check 
+  end
+end

data/test/_test_option_parser.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'rvc'
+require 'inventory_fixtures'
+
+class OptionParserTest < Test::Unit::TestCase
+end

data/test/inventory_fixtures.rb

@@ -0,0 +1,15 @@
+class FixtureNode
+  include RVC::InventoryObject
+  attr_accessor :parent
+  attr_reader :children
+
+  def initialize name, children={}
+    @name = name
+    @children = children
+    @children.each { |k,v| v.parent = self }
+  end
+
+  def pretty_print pp
+    pp.text "Node<#{@name}>"
+  end
+end

data/test/test_fs.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+require 'rvc'
+require 'inventory_fixtures'
+
+class FSTest < Test::Unit::TestCase
+  NodeB = FixtureNode.new 'B'
+  NodeC = FixtureNode.new 'C'
+  NodeA = FixtureNode.new('A', 'b' => NodeB, 'c' => NodeC)
+  Root = FixtureNode.new('ROOT', 'a' => NodeA)
+
+  def setup
+    @context = RVC::FS.new Root
+  end
+
+  def teardown
+    @context = nil
+  end
+
+  def test_new
+    assert_equal Root, @context.cur
+    assert_equal "", @context.display_path
+    assert_equal 0, @context.marks.size
+    assert_equal [''], @context.loc.path
+    assert_equal [['', Root]], @context.loc.stack
+  end
+
+  def test_lookup_simple
+    assert_equal nil, @context.lookup('nonexistent')
+    assert_equal Root, @context.lookup('.')
+    assert_equal Root, @context.lookup('..')
+    assert_equal Root, @context.lookup('...')
+    assert_equal NodeA, @context.lookup('a')
+    assert_equal NodeB, @context.lookup('a/b')
+    assert_equal NodeC, @context.lookup('a/b/../c')
+    assert_equal NodeC, @context.lookup('a/b/.../c')
+  end
+
+  def test_lookup_loc_nonexistent
+    loc = @context.lookup_loc 'nonexistent'
+    assert_equal nil, loc
+  end
+
+  def test_lookup_loc_simple
+    %w(a /a ./a ./a/.).each do |path|
+      loc = @context.lookup_loc path
+      assert_equal NodeA, loc.obj
+      assert_equal ['', 'a'], loc.path
+      assert_equal [['', Root], ['a', NodeA]], loc.stack
+    end
+
+    %w(a/b /a/b ./a/b /a/b/.).each do |path|
+      loc = @context.lookup_loc path
+      assert_equal NodeB, loc.obj
+      assert_equal ['', 'a', 'b'], loc.path
+      assert_equal [['', Root], ['a', NodeA], ['b', NodeB]], loc.stack
+    end
+  end
+
+  def test_lookup_loc_parent
+    loc = @context.lookup_loc '..'
+    assert_equal [['', Root]], loc.stack
+
+    loc = @context.lookup_loc 'a/..'
+    assert_equal [['', Root]], loc.stack
+
+    loc = @context.lookup_loc 'a/b/..'
+    assert_equal [['', Root], ['a', NodeA]], loc.stack
+  end
+
+  def test_lookup_loc_realparent
+    loc = @context.lookup_loc '...'
+    assert_equal [['', Root]], loc.stack
+
+    loc = @context.lookup_loc 'a/...'
+    assert_equal [['', Root], ['a', NodeA], ['...', Root]], loc.stack
+
+    loc = @context.lookup_loc 'a/b/...'
+    assert_equal [['', Root], ['a', NodeA], ['b', NodeB], ['...', NodeA]], loc.stack
+  end
+
+  def test_lookup_loc_mark
+    b_loc = @context.lookup_loc 'a/b'
+    assert_not_nil b_loc
+
+    loc = @context.lookup_loc '~foo'
+    assert_equal nil, loc
+
+    ['foo', '~', '7', ''].each do |mark|
+      @context.mark mark, b_loc
+      loc = @context.lookup_loc "~#{mark}"
+      assert_equal [['', Root], ['a', NodeA], ['b', NodeB]], loc.stack
+
+      @context.mark mark, nil
+      loc = @context.lookup_loc "~#{mark}"
+      assert_equal nil, loc
+    end
+
+    @context.mark '7', b_loc
+    loc = @context.lookup_loc "7"
+    assert_equal [['', Root], ['a', NodeA], ['b', NodeB]], loc.stack
+
+    @context.mark '7', nil
+    loc = @context.lookup_loc "7"
+    assert_equal nil, loc
+  end
+
+  def test_cd
+    assert_equal false, @context.cd("nonexistent")
+    assert_equal [['', Root]], @context.loc.stack
+    assert_equal true, @context.cd("a")
+    assert_equal [['', Root], ['a', NodeA]], @context.loc.stack
+  end
+end

data/test/test_parse_path.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'rvc/path'
+
+class ParsePathTest < Test::Unit::TestCase
+  def test_empty
+    els, absolute, trailing_slash = RVC::Path.parse('')
+    assert_equal [], els
+    assert_equal false, absolute
+    assert_equal false, trailing_slash
+  end
+
+  def test_root
+    els, absolute, trailing_slash = RVC::Path.parse('/')
+    assert_equal [], els
+    assert_equal true, absolute
+    assert_equal true, trailing_slash
+  end
+
+  def test_normal
+    els, absolute, trailing_slash = RVC::Path.parse('/foo/bar')
+    assert_equal %w(foo bar), els
+    assert_equal true, absolute
+    assert_equal false, trailing_slash
+
+    els, absolute, trailing_slash = RVC::Path.parse('/foo/bar/')
+    assert_equal %w(foo bar), els
+    assert_equal true, absolute
+    assert_equal true, trailing_slash
+
+    els, absolute, trailing_slash = RVC::Path.parse('foo/bar/')
+    assert_equal %w(foo bar), els
+    assert_equal false, absolute
+    assert_equal true, trailing_slash
+
+    els, absolute, trailing_slash = RVC::Path.parse('foo/bar')
+    assert_equal %w(foo bar), els
+    assert_equal false, absolute
+    assert_equal false, trailing_slash
+  end
+end
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: rvc
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rich Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 00:00:00 -07:00
+default_executable: rvc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rbvmomi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: backports
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.18.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7
+  type: :runtime
+  version_requirements: *id004
+description: 
+email: rlane@vmware.com
+executables: 
+- rvc
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- bin/rvc
+- lib/rvc.rb
+- lib/rvc/completion.rb
+- lib/rvc/extensions/ClusterComputeResource.rb
+- lib/rvc/extensions/ComputeResource.rb
+- lib/rvc/extensions/Datacenter.rb
+- lib/rvc/extensions/Datastore.rb
+- lib/rvc/extensions/DistributedVirtualPortgroup.rb
+- lib/rvc/extensions/DistributedVirtualSwitch.rb
+- lib/rvc/extensions/Folder.rb
+- lib/rvc/extensions/HostSystem.rb
+- lib/rvc/extensions/ManagedEntity.rb
+- lib/rvc/extensions/Network.rb
+- lib/rvc/extensions/ResourcePool.rb
+- lib/rvc/extensions/VirtualMachine.rb
+- lib/rvc/fs.rb
+- lib/rvc/inventory.rb
+- lib/rvc/modules.rb
+- lib/rvc/modules/basic.rb
+- lib/rvc/modules/datastore.rb
+- lib/rvc/modules/host.rb
+- lib/rvc/modules/resource_pool.rb
+- lib/rvc/modules/vim.rb
+- lib/rvc/modules/vm.rb
+- lib/rvc/modules/vmrc.rb
+- lib/rvc/modules/vnc.rb
+- lib/rvc/option_parser.rb
+- lib/rvc/path.rb
+- lib/rvc/readline-ffi.rb
+- lib/rvc/shell.rb
+- lib/rvc/ttl_cache.rb
+- lib/rvc/util.rb
+- test/inventory_fixtures.rb
+- test/test_fs.rb
+- test/test_parse_path.rb
+- test/_test_completion.rb
+- test/_test_option_parser.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: vSphere console UI
+test_files: 
+- test/_test_completion.rb
+- test/_test_option_parser.rb
+- test/inventory_fixtures.rb
+- test/test_fs.rb
+- test/test_parse_path.rb