vbox-ng 0.1.3 → 1.0.0

data/Gemfile

@@ -10,7 +10,7 @@ gem "awesome_print", "~> 1.1.0"
 group :development do
   gem "rspec", "~> 2.12.0"
 #  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.8.4"
-#  gem "rcov", ">= 0"
+  gem "simplecov"
 end

data/Gemfile.lock

@@ -10,6 +10,7 @@ GEM
       rake
       rdoc
     json (1.7.5)
+    multi_json (1.0.4)
     rake (10.0.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -21,12 +22,17 @@ GEM
     rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   awesome_print (~> 1.1.0)
-  bundler (~> 1.0.0)
+  bundler (>= 1.0.0)
   jeweler (~> 1.8.4)
   rspec (~> 2.12.0)
+  simplecov

data/README.md

@@ -1,4 +1,4 @@
-vbox-ng
+vbox-ng    [![Build Status](https://secure.travis-ci.org/zed-0xff/vbox-ng.png)](http://secure.travis-ci.org/zed-0xff/vbox-ng)  [![Dependency Status](https://gemnasium.com/zed-0xff/vbox-ng.png)](https://gemnasium.com/zed-0xff/vbox-ng)
 ======
 
 Description
@@ -25,15 +25,14 @@ Commandline usage
     	acpipowerbutton, acpisleepbutton, clone, delete, show, snapshots
     
     OPTIONS:
-    	-g, --[no-]glob                  (default: auto) assume <vm_name> is a wildcard,
-    	                                 and run on multiple VMs.
-    	                                 All glob(7) patterns like *,?,[a-z] are supported
-    	                                 plus additional pattern {1-20} which matches
-    	                                 a sequence of numbers: 1,2,3,...,19,20
+    	-g, --[no-]glob                  assume <vm_name> is a wildcard & run on multiple VMs.
+    	                                 All glob(7) patterns are supported plus additional
+    	                                 pattern "{1-20}" - expands to a sequence: 1,2,3,...,19,20
     	-n, --dry-run                    do not change anything, just print commands to be invoked
     	-v, --verbose                    increase verbosity
-    	-c, --clones N                   clone: make N clones
+    	-N, --clones N                   clone: make N clones
     	-S, --snapshot MODE              clone: use LAST shapshot or make NEW
+    	    --name NAME                  clone: name for the clone VM
     	-H, --headless                   start: start VM in headless mode
     	-h, --help                       show this message
     
@@ -41,7 +40,7 @@ Commandline usage
     	vbox -v                        - list VMs with memory and dir sizes
     	vbox "d{1-10}" list            - list only VMs named 'd1','d2','d3',...,'d10'
     	vbox "test*" start             - start VMs which name starts with 'test'
-    	vbox "v[ace]" cpus=2           - set 'number of cpus'=2 on VMs named 'va','vc','ve'
+    	vbox "v[ace]" cpus=2 acpi=on   - set number of cpus & ACPI on VMs named 'va','vc','ve'
     	vbox d0                        - list all parameters of VM named 'd0'
     	vbox d0 clone -c 10 -S last    - make 10 new linked clones of vm 'd0' using the
     	                                 latest hdd snapshot, if any

data/Rakefile

@@ -32,17 +32,27 @@ Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
 
+namespace :spec do
+  desc "record VBoxManage simulation"
+  task :record do
+    ENV['RECORD_VBOXMANAGE'] = '1'
+    Rake::Task[:spec].invoke
+  end
+
+  desc "replay VBoxManage simulation"
+  task :replay do
+    ENV['SIMULATE_VBOXMANAGE'] = '1'
+    Rake::Task[:spec].execute
+  end
+end
+
 #require 'rdoc/task'
 #Rake::RDocTask.new do |rdoc|
 #  version = File.exist?('VERSION') ? File.read('VERSION') : ""

data/VERSION

@@ -1 +1 @@
-0.1.3
+1.0.0

data/lib/vbox-ng.rb

@@ -5,7 +5,19 @@ module VBOX
   # UUID_RE  = /\{\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\}/ # only in ruby 1.9 :(
   UUID_RE  = /\{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\}/i
 
-  def self.api
-    @@api ||= CmdLineAPI.new
+  @@verbosity = ENV['VBOX_DEBUG'].to_i
+
+  class << self
+    def api
+      @@api ||= CmdLineAPI.new
+    end
+
+    def verbosity
+      @@verbosity
+    end
+
+    def verbosity= v
+      @@verbosity = v
+    end
   end
 end

data/lib/vbox.rb

@@ -5,7 +5,19 @@ module VBOX
   # UUID_RE  = /\{\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\}/ # only in ruby 1.9 :(
   UUID_RE  = /\{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\}/i
 
-  def self.api
-    @@api ||= CmdLineAPI.new
+  @@verbosity = ENV['VBOX_DEBUG'].to_i
+
+  class << self
+    def api
+      @@api ||= CmdLineAPI.new
+    end
+
+    def verbosity
+      @@verbosity
+    end
+
+    def verbosity= v
+      @@verbosity = v
+    end
   end
 end

data/lib/vbox/cli.rb

@@ -11,6 +11,7 @@ module VBOX
       @argv = argv
     end
 
+    private
     def _join_by_width words, params = {}
       params[:max_length] ||= 30
       params[:separator]  ||= ", "
@@ -28,6 +29,7 @@ module VBOX
       lines.join params[:newline]
     end
 
+    public
     def banner
       bname = File.basename($0)
       r = []
@@ -56,7 +58,7 @@ module VBOX
       r << %Q{\t#{bname} -v                        - list VMs with memory and dir sizes}
       r << %Q{\t#{bname} "d{1-10}" list            - list only VMs named 'd1','d2','d3',...,'d10'}
       r << %Q{\t#{bname} "test*" start             - start VMs which name starts with 'test'}
-      r << %Q{\t#{bname} "v[ace]" cpus=2           - set 'number of cpus'=2 on VMs named 'va','vc','ve'}
+      r << %Q{\t#{bname} "v[ace]" cpus=2 acpi=on   - set number of cpus & ACPI on VMs named 'va','vc','ve'}
       r << %Q{\t#{bname} d0                        - list all parameters of VM named 'd0'}
       r << %Q{\t#{bname} d0 clone -c 10 -S last    - make 10 new linked clones of vm 'd0' using the}
       r << %Q{\t#{space}                             latest hdd snapshot, if any}
@@ -70,17 +72,16 @@ module VBOX
       r.join("\n")
     end
 
-    def run
+    def parse_argv
       @options = { :verbose => 0 }
       optparser = OptionParser.new do |opts|
         opts.banner = banner
         opts.summary_indent = "\t"
 
         opts.on "-g", "--[no-]glob",
-        "(default: auto) assume <vm_name> is a wildcard,",
-        "and run on multiple VMs.",
-        "All glob(7) patterns like *,?,[a-z] are supported",
-        "plus additional pattern {1-20} which matches","a sequence of numbers: 1,2,3,...,19,20" do |x|
+        "assume <vm_name> is a wildcard & run on multiple VMs.",
+        "All glob(7) patterns are supported plus additional",
+        "pattern \"{1-20}\" - expands to a sequence: 1,2,3,...,19,20" do |x|
           @options[:multiple] = x
         end
         opts.on "-n", "--dry-run", "do not change anything, just print commands to be invoked" do
@@ -90,13 +91,16 @@ module VBOX
           @options[:verbose] ||= 0
           @options[:verbose] += 1
         end
-        opts.on "-c", "--clones N", Integer, "clone: make N clones" do |x|
+        opts.on "-N", "--clones N", Integer, "clone: make N clones" do |x|
           @options[:clones] = x
         end
         a = 'new last take make'.split.map{ |x| [x, x.upcase] }.flatten
         opts.on "-S", "--snapshot MODE", a, "clone: use LAST shapshot or make NEW" do |x|
           @options[:snapshot] = x.downcase
         end
+        opts.on "--name NAME", "clone: name for the clone VM" do |x|
+          @options[:name] = x
+        end
         opts.on "-H", "--headless", "start: start VM in headless mode" do
           @options[:headless] = true
         end
@@ -113,97 +117,226 @@ module VBOX
         @options[:multiple] = "{#{@argv.first}}" !~ UUID_RE
       end
 
-      @vbox = VBOX::CmdLineAPI.new(@options)
+      VBOX.verbosity = @options[:verbose]
+    end
 
-      if @argv.size == 0 || @argv.last == 'list'
-        vms = @vbox.list_vms
-        @vbox.list_vms(:running => true).each do |vm|
-          vms.find{ |vm1| vm1.uuid == vm.uuid }.state = :running
-        end
+    def list_vms name_or_glob
+      vms = _find_vms name_or_glob
 
-        if @argv.size == 2 && @argv.last == 'list'
-          if @options[:multiple]
-            @globs = _expand_glob(@argv.first).flatten
-            vms = vms.keep_if{ |vm| _fnmatch(vm.name) }
-          else
-            vms = vms.keep_if{ |vm| vm.name == @argv.first }
-          end
+      longest = (vms.map(&:name).map(&:size)+[4]).max
+
+      puts "%-*s %5s %6s  %-12s %s".gray % [longest, *%w'NAME MEM DIRSZ STATE UUID']
+      vms.each do |vm|
+        if @options[:verbose] > 0
+          vm.fetch_metadata
+          state = (vm.state == :poweroff) ? '' : vm.state.to_s.upcase
+          s = sprintf "%-*s %5d %6s  %-12s %s", longest, vm.name, vm.memory_size, vm.dir_size,
+            state, vm.uuid
+        else
+          state = (vm.state == :poweroff) ? '' : vm.state.to_s.upcase
+          s = sprintf "%-*s %5s %6s  %-12s %s", longest, vm.name, '', '',
+            state, vm.uuid
         end
+        s = s.green if vm.state == :running
+        puts s
+      end
+    end
 
-        longest = (vms.map(&:name).map(&:size)+[4]).max
-
-        puts "%-*s %5s %6s  %-12s %s".gray % [longest, *%w'NAME MEM DIRSZ STATE UUID']
-        vms.each do |vm|
-          if @options[:verbose] > 0
-            @vbox.get_vm_details vm
-            state = (vm.state == :poweroff) ? '' : vm.state.to_s.upcase
-            s = sprintf "%-*s %5d %6s  %-12s %s", longest, vm.name, vm.memory_size||0, vm.dir_size||0,
-              state, vm.uuid
-          else
-            state = (vm.state == :poweroff) ? '' : vm.state.to_s.upcase
-            s = sprintf "%-*s %5s %6s  %-12s %s", longest, vm.name, '', '',
-              state, vm.uuid
-          end
-          s = s.green if vm.state == :running
-          puts s
+    def vm_cmd name_or_glob, cmd='show', *args
+      vms = _find_vms(name_or_glob)
+      if vms.empty?
+        if cmd == 'create'
+          return vm_cmd_create(name_or_glob)
+        else
+          STDERR.puts "[?] no VMs matching #{name_or_glob.inspect}".red
+          exit 1
         end
-      else
-        name = @argv.shift
-        cmd  = @argv.shift || 'show' # default command is 'show'
+      end
 
-        cmd = ALIASES[cmd] if ALIASES[cmd]
-        if @options[:multiple]
-          _run_multiple_cmd cmd, name
+      method =
+        if cmd['=']
+          # set some VM variables:
+          # vbox vm_name foo=bar bar=baz xxx=yyy
+          args.unshift(cmd)
+          "vm_cmd_set"
         else
-          _run_cmd cmd, name
+          "vm_cmd_#{cmd}"
         end
+
+      unless self.respond_to?(method)
+        STDERR.puts "[?] unknown command #{cmd.inspect}".red
+        exit 1
+      end
+      vms.each do |vm|
+        send method, vm, *args
       end
     end
 
-    # expand globs like "d{1-30}" to d1,d2,d3,d4,...,d29,d30
-    def _expand_glob glob
-      if glob[/\{(\d+)-(\d+)\}/]
-        r = []
-        $1.to_i.upto($2.to_i) do |i|
-          r << _expand_glob(glob.sub($&,i.to_s))
+    SHOW_CATEGORIES = {
+      'GENERAL'          => %w'name cpus memory vram cpuexecutioncap UUID VMState',
+      'VIRTUALIZATION OPTIONS' =>
+        [
+          /^(groups|ostype|hwvirt|nestedpag|largepag|vtxvpid|ioapic|pagefusion|hpet|synthcpu|pae)/,
+          /accelerate/, /balloon/i
+        ],
+      'NET'              => [ /^(nic|nat|mac|bridge|cable|hostonly)/, /^sock/, /^tcp/ ],
+      'STORAGE'          => [ /storage/, /SATA/, /IDE/ ],
+      'SNAPSHOTS'        => [ /snapshot/i ],
+      'VIRTUAL HARDWARE' => [ /^(lpt|uart|audio|ehci|usb|hardware|chipset|monitor|hid|acpi|firmware|USB)/ ],
+      'TELEPORTING'      => [ /teleport/i, /cpuid/i ],
+      'SHARED FOLDERS'   => [ /SharedFolder/ ]
+    }
+
+    public
+    def vm_cmd_show vm
+      vars = vm.metadata.dup
+      unless @options[:verbose] > 0
+        vars.delete_if{ |k,v| ["none","off","disabled","emptydrive","",0,"0",nil].include?(v) }
+      end
+      maxlen = vars.keys.map(&:size).max
+
+      SHOW_CATEGORIES.each do |name, filters|
+        keys = []; title = nil
+        filters.each do |filter|
+          keys += filter.is_a?(Regexp) ? vars.keys.find_all{ |key| key =~ filter } : [filter]
         end
-        r
-      else
-        [glob]
+        keys.each do |k|
+          if v = vars.delete(k)
+            puts (title = "--- #{name} ".ljust(80,'-')) unless title
+            printf("  %-*s: %s\n", maxlen, k, v)
+          end
+        end
+      end
+      puts "--- MISC ".ljust(80,'-')
+      vars.each do |k,v|
+        printf("  %-*s: %s\n", maxlen, k, v)
       end
     end
 
-    def _fnmatch fname
-      @globs.each do |glob|
-        return true if File.fnmatch(glob, fname)
+    # create VM
+    def vm_cmd_create name
+      VM.new(:name => name).create!
+    end
+
+    # destroy VM
+    def vm_cmd_destroy vm
+      vm.destroy!
+    end
+    alias :vm_cmd_rm     :vm_cmd_destroy
+    alias :vm_cmd_delete :vm_cmd_destroy
+
+    # set VM variables
+    def vm_cmd_set vm, *args
+      raise "all arguments must contain '='" unless args.all?{ |arg| arg['='] }
+      args.each do |arg|
+        k,v = arg.split("=",2)
+        vm.set_var k, v
       end
-      false
+      vm.save
     end
 
-    def _run_multiple_cmd cmd, name
-      vms = @vbox.list_vms
-      @globs = _expand_glob(name).flatten
-      vms.each do |vm|
-        if _fnmatch(vm.name)
-          _run_cmd cmd, vm.name
-        end
+    # start VM
+    def vm_cmd_start vm
+      vm.start! :headless => @options[:headless]
+    end
+
+    # pause VM
+    def vm_cmd_pause vm
+      vm.pause!
+    end
+
+    # resume VM
+    def vm_cmd_resume vm
+      vm.resume!
+    end
+    alias :vm_cmd_unpause :vm_cmd_resume
+
+    # reset VM
+    def vm_cmd_reset vm
+      vm.reset!
+    end
+
+    # save VM state
+    def vm_cmd_savestate vm
+      vm.savestate!
+    end
+    alias :vm_cmd_save_state :vm_cmd_savestate
+
+    # stop VM
+    def vm_cmd_poweroff vm
+      vm.poweroff!
+    end
+    alias :vm_cmd_stop :vm_cmd_poweroff
+
+    # ACPI 'Power' Button
+    def vm_cmd_acpipowerbutton vm
+      vm.acpipowerbutton!
+    end
+
+    # ACPI 'Sleep' Button
+    def vm_cmd_acpisleepbutton vm
+      vm.acpisleepbutton!
+    end
+
+    # clone VM
+    def vm_cmd_clone vm
+      # TODO: page fusion
+      unless @options[:snapshot]
+        puts "[!] please gimme --snapshot=LAST OR --snapshot=NEW option".red
+        exit 1
+      end
+      vm.clone! @options
+    end
+
+    # manage VM snapshots
+    def vm_cmd_snapshots vm, *args
+      vm.snapshots.each do |s|
+        printf "%s  %s\n", s.uuid, s.name
       end
     end
+    alias :vm_cmd_snapshot :vm_cmd_snapshots
+
+    def run
+      parse_argv
+      # now @argv contains only VM name and commands, if any
 
-    def _run_cmd cmd, name
-      if COMMANDS.include?(cmd)
-        @vbox.send cmd, name
-      elsif cmd['=']
-        # set some variable, f.ex. "macaddress1=BADC0FFEE000"
-        @vbox.modify name, *cmd.split('=',2)
-      elsif cmd == 'snapshots'
-        @vbox.get_snapshots(name).each do |x|
-          printf "%s  %s\n", x.uuid, x.name
+      if @argv.empty? || (@argv.size <= 2 && @argv.include?('list'))
+        # vbox
+        # vbox list
+        # vbox list "a*"
+        # vbox "a*" list
+        @argv.delete_at(@argv.index('list') || 999) # delete only 1st 'list' entry
+        list_vms @argv.first
+      elsif @argv.empty? || (@argv.size <= 2 && @argv.include?('ls'))
+        # vbox
+        # vbox ls
+        # vbox ls "a*"
+        # vbox "a*" ls
+        @argv.delete_at(@argv.index('ls') || 999) # delete only 1st 'ls' entry
+        list_vms @argv.first
+      else
+        # vbox VM
+        # vbox VM show
+        # vbox VM ...
+        #  - where 'VM' can be vm name or glob or UUID
+        vm_cmd *@argv
+      end
+    end
+
+    private
+
+    def _find_vms name_or_glob
+      if name_or_glob
+        if @options[:multiple]
+          # glob
+          VM.find_all(name_or_glob)
+        else
+          # exact name
+          [ VM.find(name_or_glob) ]
         end
       else
-        STDERR.puts "[!] unknown command #{cmd.inspect}".red
-        puts @help
-        exit 1
+        # all VMs
+        VM.all
       end
     end
   end