netvbox 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,5 +1,6 @@
 = netvbox
 
+
 == Description
 netvbox is a {ruby gem}[https://rubygems.org/gems/netvbox] designed for limited
 administration of VirtualBox VMs on networked machines in a Linux environment.
@@ -7,12 +8,50 @@ administration of VirtualBox VMs on networked machines in a Linux environment.
 The original use case was for testing {Chef}[http://www.opscode.com/chef/]
 recipes without needing (or wanting) to provision (and pay for) cloud resources
 (e.g. Amazon EC2). Take a few spare machines, install VirtualBox on each, create
-some snapshots and you're ready to go.
+some snapshots, and you're ready to go.
 
 netvbox maintains a list of snapshots for VirtualBox VMs, and can easily load
 all snapshots, power off all VMs, and display VM status information. VMs can
 be added and removed from the list via the add and remove subcommands.
 
+=== VM sets
+netvbox can manage sets of VirtualBox VMs. You can think of these sets much
+like {rvm}[http://beginrescueend.com/] gemsets. Say, for example, that you have
+5 VirtualBox VMs on various hosts on the network. Sometimes you might want to
+clean and reinstall things on all 5 VMs. Other times you wish to only reload
+snapshots on 3 VMs. You can create VM sets to manage sets of VirtualBox VMs, and
+switch between sets on the fly. See VM set sub-commands in the sub-commands
+section.
+
+
 == Sub-commands
-netvbox uses sub-comamnds. Type netvbox with no arguments to see the commands
+netvbox uses sub-commands. Below is the help listing.
+
+  SUB-COMMANDS
+      add <ssh host> <username> <password> <vm name> <snapshot name>
+          adds a vm snapshot on the specified host
+      list
+          lists vm snapshots
+      load
+          loads vm snapshots
+      poweroff
+          powers off all vms
+      remove <ssh host> <username> <vm name> <snapshot name>
+          removes a vm snapshot from management
+      status
+           shows status of vms
+  
+  VM SET SUB-COMMANDS
+      createset <set name>
+           creates a vm set with the specified name
+      currentset
+           shows the current vm set in use
+      listsets
+           lists all vm sets
+      removeset <set name>
+           removes the vm set with the specified name
+      usedefaultset
+           uses the default vm set
+      useset <set name>
+           uses the vm set with the specified name
 

data/bin/netvbox

@@ -1,64 +1,97 @@
 #!/usr/bin/env ruby
 
-require 'netvbox/vm_manager'
-require 'netvbox/config_manager'
+require 'netvbox/vm_set_config'
+require 'netvbox/vm_set_manager'
+require 'netvbox/printing_delegator'
 require 'netvbox/version'
 
-NETVBOX_CONFIG = "#{ENV['HOME']}/.netvbox"
+NETVBOX_HOME = "#{ENV['HOME']}/.netvbox"
 
 def print_help
-  puts "NetVbox version #{NetVbox::VERSION}"
-  puts "Current config file: #{NETVBOX_CONFIG}"
-  puts 'sub-commands:'
-  puts '    add [ssh host] [username] [password] [vm name] [snapshot name]'
-  puts '        adds a vm to manage'
+  puts "NetVbox #{NetVbox::VERSION}"
+  puts "Config path: #{NETVBOX_HOME}"
+  puts
+  puts 'SUB-COMMANDS'
+  puts '    add <ssh host> <username> <password> <vm name> <snapshot name>'
+  puts '        adds a vm snapshot on the specified host'
   puts '    list'
-  puts '        lists vms under management'
+  puts '        lists vm snapshots'
   puts '    load'
   puts '        loads vm snapshots'
   puts '    poweroff'
   puts '        powers off all vms'
-  puts '    remove [ssh host] [username] [vm name] [snapshot name]'
-  puts '        removes a vm from management'
+  puts '    remove <ssh host> <username> <vm name> <snapshot name>'
+  puts '        removes a vm snapshot from management'
   puts '    status'
   puts '         shows status of vms'
+  puts
+  puts 'VM SET SUB-COMMANDS'
+  puts '    createset <set name>'
+  puts '         creates a vm set with the specified name'
+  puts '    currentset'
+  puts '         shows the current vm set in use'
+  puts '    listsets'
+  puts '         lists all vm sets'
+  puts '    removeset <set name>'
+  puts '         removes the vm set with the specified name'
+  puts '    usedefaultset'
+  puts '         uses the default vm set'
+  puts '    useset <set name>'
+  puts '         uses the vm set with the specified name'
 end
 
-def parse_args
+def expect_args(num_expected_args)
+  if ARGV.length == num_expected_args
+    yield ARGV
+  else
+    puts 'Wrong number of arguments'
+    print_help
+  end
+end
+
+def process_args
   command = ARGV[0]
-  config_manager = NetVbox::ConfigManager.new(NETVBOX_CONFIG)
-  vm_manager = NetVbox::VmManager.new(config_manager)
+  vm_set_manager = NetVbox::VmSetManager.new(NETVBOX_HOME)
+  vm_set = vm_set_manager.current_set
+  delegator = NetVbox::PrintingDelegator.new(vm_set_manager, vm_set)
   case command
   when 'add'
-    if ARGV.length >= 6
+    expect_args(6) do
       hostname, username, password, vm_name, snapshot_name = ARGV[1..5]
-      vm_manager.add_vm(hostname, username, password, vm_name, snapshot_name)
-    else
-      print_help
+      delegator.add_vm(hostname, username, password, vm_name, snapshot_name)
     end
   when 'list'
-    vm_manager.list_vms
+    delegator.list_vms
   when 'load'
-    vm_manager.load_snapshots
+    delegator.load_snapshots
   when 'poweroff'
-    vm_manager.poweroff_all
+    delegator.poweroff_all
   when 'remove'
-    if ARGV.length >= 5
+    expect_args(5) do
       hostname, username, vm_name, snapshot_name = ARGV[1..4]
-      vm_manager.remove_vm(hostname, username, vm_name, snapshot_name)
-    else
-      print_help
+      delegator.remove_vm(hostname, username, vm_name, snapshot_name)
     end
   when 'status'
-    vm_manager.print_status
+    delegator.print_status
+  when 'createset'
+    expect_args(2) {delegator.create_set ARGV[1]}
+  when 'currentset'
+    delegator.print_current_set
+  when 'listsets'
+    delegator.list_sets
+  when 'removeset'
+    expect_args(2) {delegator.remove_set ARGV[1]}
+  when 'usedefaultset'
+    delegator.use_default_set
+  when 'useset'
+    expect_args(2) {delegator.use_set ARGV[1]}
   else
-    puts "Unknown command: #{command}"
-    print_help
+    puts "Unknown command: #{command}. See help."
   end
 end
 
 if ARGV.empty?
   print_help
 else
-  parse_args
+  process_args
 end

data/lib/netvbox/printing_delegator.rb

@@ -0,0 +1,99 @@
+require 'netvbox/vm_set'
+require 'netvbox/vm_set_manager'
+
+module NetVbox
+  class PrintingDelegator
+    def initialize(vm_set_manager, vm_set)
+      @vm_set = vm_set
+      @vm_set_manager = vm_set_manager
+    end
+
+    def add_vm(hostname, username, password, vm_name, snapshot_name)
+      begin
+        @vm_set.add_vm(hostname, username, password, vm_name, snapshot_name)
+        puts "Added (#{vm_name}, #{snapshot_name}) on host, #{hostname}"
+      rescue => e
+        puts "Could not add VM snapshot: #{e.message}"
+      end
+    end
+
+    def list_vms
+      all_vm_info = @vm_set.config.all_vm_info
+      all_vm_info.each do |vm_info|
+        ssh_info = vm_info.ssh_connection_info
+        printf "vm: %-36s host: %s\n", "#{vm_info.vm_name} (#{vm_info.snapshot_name})", "#{ssh_info.username}@#{ssh_info.hostname}"
+      end
+      puts 'No vms' if all_vm_info.empty?
+    end
+
+    def load_snapshots
+      puts 'Loading snapshots...'
+      @vm_set.load_snapshots
+      print_status
+    end
+
+    def poweroff_all
+      puts 'Powering off VMs...'
+      @vm_set.poweroff_all
+      print_status
+    end
+
+    def remove_vm(hostname, username, vm_name, snapshot_name)
+      begin
+        @vm_set.remove_vm(hostname, username, vm_name, snapshot_name)
+        puts "Removed (#{vm_name}, #{snapshot_name}) on host, #{hostname}"
+      rescue => e
+        puts "Could not remove VM snapshot: #{e.message}"
+      end
+    end
+
+    def print_status
+      puts 'Retrieving status info...'
+      all_status = @vm_set.all_status
+      all_status.each do |vm_info, status|
+        printf "%-40s %s\n", "#{vm_info.vm_name} on #{vm_info.ssh_connection_info.hostname}", "[#{status}]"
+      end
+      puts 'There are no vms' if all_status.empty?
+    end
+
+    def create_set(set_name)
+      begin
+        @vm_set_manager.create_set set_name
+        puts "Created set: #{set_name}"
+      rescue => e
+        puts "Could not create set: #{e.message}"
+      end
+    end
+
+    def print_current_set
+      puts @vm_set_manager.current_set_name
+    end
+
+    def list_sets
+      @vm_set_manager.vm_set_names.each {|vm_set_name| puts vm_set_name}
+    end
+
+    def remove_set(set_name)
+      begin
+        @vm_set_manager.remove_set set_name
+        puts "Removed set: #{set_name}"
+      rescue => e
+        puts "Could not remove set: #{e.message}"
+      end
+    end
+
+    def use_default_set
+      @vm_set_manager.use_default_set
+      puts "Now using set: #{@vm_set_manager.current_set_name}"
+    end
+
+    def use_set(set_name)
+      begin
+        @vm_set_manager.use_set set_name
+      rescue => e
+        puts "Could not use set: #{e.message}"
+      end
+      puts "Now using set: #{@vm_set_manager.current_set_name}"
+    end
+  end
+end

data/lib/netvbox/version.rb

@@ -1,3 +1,3 @@
 module NetVbox
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/netvbox/vm.rb

@@ -69,41 +69,35 @@ module NetVbox
 
     def poweroff
       if showvminfo('VMState') == 'running'
-        my_ssh do |ssh|
-          ssh.exec!("VBoxManage controlvm \"#{@vm_info.vm_name}\" poweroff").strip
-        end
-      else
-        "#{@vm_info.vm_name} is not running"
+        my_ssh {|ssh| ssh.exec!("VBoxManage controlvm \"#{@vm_info.vm_name}\" poweroff").strip}
       end
     end
 
     def load_snapshot
-      return "ERROR: you must disable 3d acceleration for #{@vm_info.vm_name}" if showvminfo('accelerate3d') == 'on'
+      # VMs with 3D acceleration cannot be started remotely
+      # TODO: propogate this info to a log or some output to notify user
+      return if showvminfo('accelerate3d') == 'on'
       poweroff
-      my_ssh do |ssh|
-        ssh.exec!("VBoxManage snapshot \"#{@vm_info.vm_name}\" restore \"#{@vm_info.snapshot_name}\" && VBoxManage startvm \"#{@vm_info.vm_name}\" --type headless")
-      end
+      command = "VBoxManage snapshot \"#{@vm_info.vm_name}\" restore \"#{@vm_info.snapshot_name}\" && VBoxManage startvm \"#{@vm_info.vm_name}\" --type headless"
+      my_ssh {|ssh| ssh.exec!(command)}
     end
 
     private
 
     def showvminfo(var_name)
-      my_ssh do |ssh|
-        ssh.exec!("VBoxManage showvminfo \"#{@vm_info.vm_name}\" --machinereadable | grep ^#{var_name}= | cut -d '\"' -f 2").strip
-      end
+      command = "VBoxManage showvminfo \"#{@vm_info.vm_name}\" --machinereadable | grep ^#{var_name}= | cut -d '\"' -f 2"
+      my_ssh {|ssh| ssh.exec!(command).strip}
     end
 
     def my_ssh
       ssh_info = @vm_info.ssh_connection_info
       begin
         # can raise SocketError or Net::SSH::AuthenticationFailed
-        Net::SSH.start(ssh_info.hostname, ssh_info.username, :password => ssh_info.password) do |ssh|
-          return yield ssh
-        end
+        Net::SSH.start(ssh_info.hostname, ssh_info.username, :password => ssh_info.password) {|ssh| return yield ssh}
       rescue SocketError
-        return 'Connection Error'
+        return 'connection error'
       rescue Net::SSH::AuthenticationFailed
-        return 'Authentication Error'
+        return 'authentication error'
       end
     end
   end

data/lib/netvbox/vm_set.rb

@@ -0,0 +1,57 @@
+require 'netvbox/vm'
+require 'netvbox/vm_set_config'
+
+module NetVbox
+  class VmSet
+    def initialize(vm_set_config)
+      @vm_set_config = vm_set_config
+    end
+
+    def config
+      @vm_set_config
+    end
+
+    def load_snapshots
+      threads = []
+      get_vms.each do |vm|
+        threads << Thread.new(vm) {|vm| vm.load_snapshot}
+      end
+      threads.each(&:join)
+    end
+
+    def poweroff_all
+      threads = []
+      get_vms.each do |vm|
+        threads << Thread.new(vm) {|vm| vm.poweroff}
+      end
+      threads.each(&:join)
+    end
+
+    def add_vm(hostname, username, password, vm_name, snapshot_name)
+      vm_info = VmInfo.new(SshConnectionInfo.new(hostname, username, password), vm_name, snapshot_name)
+      @vm_set_config.add_vm(vm_info)
+    end
+
+    def remove_vm(hostname, username, vm_name, snapshot_name)
+      vm_info = VmInfo.new(SshConnectionInfo.new(hostname, username, nil), vm_name, snapshot_name)
+      @vm_set_config.remove_vm(vm_info)
+    end
+
+    # return Hash of VmInfo to status
+    def all_status
+      status_map = {}
+      threads = []
+      get_vms.each do |vm|
+        threads << Thread.new(vm) {|vm| status_map[vm.vm_info] = vm.status}
+      end
+      threads.each(&:join)
+      status_map
+    end
+
+    private
+
+    def get_vms
+      @vm_set_config.all_vm_info.collect {|vm_info| Vm.new(vm_info)}
+    end
+  end
+end

data/lib/netvbox/{config_manager.rb → vm_set_config.rb}

@@ -2,30 +2,38 @@ require 'csv'
 require 'netvbox/vm'
 
 module NetVbox
-  class ConfigManager
+  class VmSetConfig
     def initialize(config_file_path)
       @config_file_path = config_file_path
     end
 
-    def get_all_vm_info
+    def all_vm_info
       all_vm_info = []
       if File.readable?(@config_file_path)
-        CSV.foreach(@config_file_path) do |row|
-          all_vm_info << a_to_vm_info(row)
-        end
+        CSV.foreach(@config_file_path) {|row| all_vm_info << a_to_vm_info(row)}
+      else
+        raise "Could not read file: #{@config_file_path}"
       end
       all_vm_info
     end
 
     def add_vm(vm_info)
-      all_vm_info = get_all_vm_info
-      all_vm_info.index(vm_info).nil? ? write_vm_info(all_vm_info << vm_info) : false
+      all = all_vm_info
+      if all.index(vm_info).nil?
+        write_vm_info(all << vm_info)
+      else
+        raise "(#{vm_info.vm_name}, #{vm_info.snapshot_name}) is already under management"
+      end
     end
 
     def remove_vm(vm_info)
-      all_vm_info = get_all_vm_info
-      updated_vm_info = all_vm_info.select {|i| !(i === vm_info)}
-      all_vm_info != updated_vm_info ? write_vm_info(updated_vm_info) : false
+      all = all_vm_info
+      updated = all.select {|i| !(i === vm_info)}
+      if all != updated      
+        write_vm_info(updated)
+      else
+        raise "(#{vm_info.vm_name}, #{vm_info.snapshot_name}) is not under management"
+      end
     end
 
     private
@@ -49,10 +57,8 @@ module NetVbox
         CSV.open(@config_file_path, "w") do |csv|
           all_vm_info.each {|vm_info| csv << vm_info_to_a(vm_info)}
         end
-        true
       rescue IOError
-        puts "ERROR: Could not write vm info to #{@config_file_path}"
-        return false
+        raise "Could not write vm info to #{@config_file_path}"
       end
     end
   end

data/lib/netvbox/vm_set_manager.rb

@@ -0,0 +1,75 @@
+require 'fileutils'
+require 'netvbox/vm_set_config'
+require 'netvbox/vm_set'
+
+module NetVbox
+  class VmSetManager
+    DEFAULT_VM_SET_NAME = 'default'
+    VM_SETS_FOLDER_NAME = 'vm_sets'
+    CURRENT_VM_SET_FILENAME = 'current_vm_set'
+    VM_SET_EXTENSION = 'vmset'
+
+    def initialize(netvbox_home)
+      @netvbox_home = netvbox_home
+      FileUtils.mkdir_p "#{@netvbox_home}/#{VM_SETS_FOLDER_NAME}"
+      FileUtils.touch vm_set_config_file(DEFAULT_VM_SET_NAME)
+      current_vm_file = "#{@netvbox_home}/#{CURRENT_VM_SET_FILENAME}"
+      IO.write(current_vm_file, DEFAULT_VM_SET_NAME) unless File.exists?(current_vm_file)
+    end
+
+    def exists?(vm_set_name)
+      File.exists? vm_set_config_file(vm_set_name)
+    end
+
+    def vm_set_names
+      Dir.entries("#{@netvbox_home}/#{VM_SETS_FOLDER_NAME}")
+         .select {|e| e.end_with?(VM_SET_EXTENSION)}
+         .collect {|e| e[0...(-VM_SET_EXTENSION.length - 1)]}
+    end
+
+    def current_set_name
+      current_vm_file = "#{@netvbox_home}/#{CURRENT_VM_SET_FILENAME}"
+      File.readable?(current_vm_file) ? IO.read(current_vm_file) : DEFAULT_VM_SET_NAME
+    end
+
+    def current_set
+      VmSet.new(VmSetConfig.new(vm_set_config_file(current_set_name)))
+    end
+
+    def use_default_set
+      FileUtils.touch vm_set_config_file(DEFAULT_VM_SET_NAME)
+      IO.write("#{@netvbox_home}/#{CURRENT_VM_SET_FILENAME}", DEFAULT_VM_SET_NAME)
+    end
+
+    def use_set(vm_set_name)
+      if File.exists? vm_set_config_file(vm_set_name)
+        IO.write("#{@netvbox_home}/#{CURRENT_VM_SET_FILENAME}", vm_set_name)
+      else
+        raise "VM set #{vm_set_name} does not exist"
+      end
+    end
+
+    def create_set(vm_set_name)
+      raise "Set: #{vm_set_name} already exists" if exists? vm_set_name
+      begin
+        FileUtils.touch vm_set_config_file(vm_set_name)
+      rescue
+        raise "Cannot create set with name: #{vm_set_name}"
+      end
+    end
+
+    def remove_set(vm_set_name)
+      raise "Set: #{vm_set_name} does not exist" unless exists? vm_set_name
+      raise "Cannot remove default set" if vm_set_name == DEFAULT_VM_SET_NAME
+      use_default_set if current_set_name == vm_set_name
+      File.delete vm_set_config_file(vm_set_name)
+    end
+
+    private
+
+    def vm_set_config_file(vm_set_name)
+      "#{@netvbox_home}/#{VM_SETS_FOLDER_NAME}/#{vm_set_name}.#{VM_SET_EXTENSION}"
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netvbox
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000 Z
+date: 2011-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &10050840 !ruby/object:Gem::Requirement
+  requirement: &13997300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10050840
+  version_requirements: *13997300
 description: 
 email:
 - hsu.dennis@gmail.com
@@ -36,10 +36,12 @@ files:
 - Rakefile
 - bin/netvbox
 - lib/netvbox.rb
-- lib/netvbox/config_manager.rb
+- lib/netvbox/printing_delegator.rb
 - lib/netvbox/version.rb
 - lib/netvbox/vm.rb
-- lib/netvbox/vm_manager.rb
+- lib/netvbox/vm_set.rb
+- lib/netvbox/vm_set_config.rb
+- lib/netvbox/vm_set_manager.rb
 - netvbox.gemspec
 homepage: https://github.com/dhsu/netvbox
 licenses: []

data/lib/netvbox/vm_manager.rb

@@ -1,73 +0,0 @@
-require 'netvbox/vm'
-require 'netvbox/config_manager'
-
-module NetVbox
-  class VmManager
-    def initialize(config_manager)
-      @config_manager = config_manager
-    end
-
-    def print_status
-      puts 'Getting status info...'
-      threads = []
-      get_vms.each do |vm|
-        threads << Thread.new(vm) {|vm| puts "#{vm.vm_info.vm_name} on #{vm.vm_info.ssh_connection_info.hostname}... #{vm.status}"}
-      end
-      threads.each(&:join)
-      puts 'There are no vms' if threads.empty?
-    end
-
-    def load_snapshots
-      puts 'Loading snapshots...'
-      threads = []
-      get_vms.each do |vm|
-        threads << Thread.new(vm) {|vm| vm.load_snapshot}
-      end
-      threads.each(&:join)
-      print_status
-    end
-
-    def poweroff_all
-      puts 'Powering off vms...'
-      threads = []
-      get_vms.each do |vm|
-        threads << Thread.new(vm) {|vm| vm.poweroff}
-      end
-      threads.each(&:join)
-      print_status
-    end
-
-    def list_vms
-      all_vm_info = @config_manager.get_all_vm_info
-      all_vm_info.each do |vm_info|
-        ssh_info = vm_info.ssh_connection_info
-        puts "#{ssh_info.username}@#{ssh_info.hostname} - vm: #{vm_info.vm_name}, snapshot: #{vm_info.snapshot_name}"
-      end
-      puts 'There are no vms' if all_vm_info.empty?
-    end
-
-    def add_vm(hostname, username, password, vm_name, snapshot_name)
-      vm_info = VmInfo.new(SshConnectionInfo.new(hostname, username, password), vm_name, snapshot_name)
-      if @config_manager.add_vm(vm_info)
-        puts "Successfully added vm (#{vm_name}, #{snapshot_name})"
-      else
-        puts "Failed to add vm (#{vm_name}, #{snapshot_name})"
-      end
-    end
-
-    def remove_vm(hostname, username, vm_name, snapshot_name)
-      vm_info = VmInfo.new(SshConnectionInfo.new(hostname, username, nil), vm_name, snapshot_name)
-      if @config_manager.remove_vm(vm_info)
-        puts "Successfully removed vm (#{vm_name}, #{snapshot_name})"
-      else
-        puts "Failed to remove vm (#{vm_name}, #{snapshot_name})"
-      end
-    end
-
-    private
-
-    def get_vms
-      @config_manager.get_all_vm_info.collect {|vm_info| Vm.new(vm_info)}
-    end
-  end
-end