netvbox 0.0.1

data/bin/netvbox

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'netvbox/vm_manager'
+require 'netvbox/config_manager'
+require 'netvbox/version'
+
+NETVBOX_CONFIG = "#{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 '    list'
+  puts '        lists vms under management'
+  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 '    status'
+  puts '         shows status of vms'
+end
+
+def parse_args
+  command = ARGV[0]
+  config_manager = NetVbox::ConfigManager.new(NETVBOX_CONFIG)
+  vm_manager = NetVbox::VmManager.new(config_manager)
+  case command
+  when 'add'
+    if ARGV.length >= 6
+      hostname, username, password, vm_name, snapshot_name = ARGV[1..5]
+      vm_manager.add_vm(hostname, username, password, vm_name, snapshot_name)
+    else
+      print_help
+    end
+  when 'list'
+    vm_manager.list_vms
+  when 'load'
+    vm_manager.load_snapshots
+  when 'poweroff'
+    vm_manager.poweroff_all
+  when 'remove'
+    if ARGV.length >= 5
+      hostname, username, vm_name, snapshot_name = ARGV[1..4]
+      vm_manager.remove_vm(hostname, username, vm_name, snapshot_name)
+    else
+      print_help
+    end
+  when 'status'
+    vm_manager.print_status
+  else
+    puts "Unknown command: #{command}"
+    print_help
+  end
+end
+
+if ARGV.empty?
+  print_help
+else
+  parse_args
+end

data/lib/netvbox/config_manager.rb

@@ -0,0 +1,59 @@
+require 'csv'
+require 'netvbox/vm'
+
+module NetVbox
+  class ConfigManager
+    def initialize(config_file_path)
+      @config_file_path = config_file_path
+    end
+
+    def get_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
+      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
+    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
+    end
+
+    private
+
+    def vm_info_to_a(vm_info)
+      a = []
+      a << vm_info.ssh_connection_info.hostname
+      a << vm_info.ssh_connection_info.username
+      a << vm_info.ssh_connection_info.password
+      a << vm_info.vm_name
+      a << vm_info.snapshot_name
+      a
+    end
+
+    def a_to_vm_info(a)
+      VmInfo.new(SshConnectionInfo.new(a[0], a[1], a[2]), a[3], a[4])
+    end
+
+    def write_vm_info(all_vm_info)
+      begin
+        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
+      end
+    end
+  end
+end

data/lib/netvbox/version.rb

@@ -0,0 +1,3 @@
+module NetVbox
+  VERSION = "0.0.1"
+end

data/lib/netvbox/vm.rb

@@ -0,0 +1,110 @@
+require 'net/ssh'
+
+module NetVbox
+
+  class SshConnectionInfo
+    attr_reader :hostname, :username, :password
+
+    def initialize(hostname, username, password)
+      @hostname = hostname
+      @username = username
+      @password = password
+    end
+
+    def ==(other)
+      self === other &&
+      self.password == other.password
+    end
+
+    def ===(other)
+      self.hostname == other.hostname &&
+      self.username == other.username      
+    end
+  end
+
+  class VmInfo
+    attr_reader :ssh_connection_info, :vm_name, :snapshot_name
+
+    def initialize(ssh_connection_info, vm_name, snapshot_name)
+      @ssh_connection_info = ssh_connection_info
+      @vm_name = vm_name
+      @snapshot_name = snapshot_name
+    end
+
+    def ==(other)
+      self.ssh_connection_info == other.ssh_connection_info &&
+      self.vm_name == other.vm_name &&
+      self.snapshot_name == other.snapshot_name
+    end
+
+    def ===(other)
+      self.ssh_connection_info === other.ssh_connection_info &&
+      self.vm_name == other.vm_name &&
+      self.snapshot_name == other.snapshot_name      
+    end
+  end
+
+  class Vm
+    attr_reader :vm_info
+
+    def initialize(vm_info)
+      @vm_info = vm_info
+    end
+
+    def status
+      vm_state = showvminfo('VMState')
+      case vm_state
+      when 'running'
+        'running'
+      when 'saved'
+        'not running (saved)'
+      when 'poweroff'
+        'not running (power off)'
+      when 'aborted'
+        'not running (aborted)'
+      else
+        vm_state
+      end
+    end
+
+    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"
+      end
+    end
+
+    def load_snapshot
+      return "ERROR: you must disable 3d acceleration for #{@vm_info.vm_name}" 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
+    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
+    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
+      rescue SocketError
+        return 'Connection Error'
+      rescue Net::SSH::AuthenticationFailed
+        return 'Authentication Error'
+      end
+    end
+  end
+end

data/lib/netvbox/vm_manager.rb

@@ -0,0 +1,70 @@
+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)
+    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
+      @config_manager.get_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
+    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

data/lib/netvbox.rb

@@ -0,0 +1,5 @@
+require "netvbox/version"
+
+module NetVbox
+  # nothing yet...
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: netvbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dennis Hsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: &12295500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12295500
+description: Remote administration of VirtualBox VMs through ssh
+email:
+- hsu.dennis@gmail.com
+executables:
+- netvbox
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/netvbox.rb
+- lib/netvbox/version.rb
+- lib/netvbox/vm_manager.rb
+- lib/netvbox/vm.rb
+- lib/netvbox/config_manager.rb
+- bin/netvbox
+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.8.10
+signing_key: 
+specification_version: 3
+summary: Remote administration of VirtualBox VMs through ssh
+test_files: []