vbox-ng 0.0.1 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/vbox-ng.rb

@@ -0,0 +1,10 @@
+require 'vbox/vm'
+require 'vbox/cmdlineapi'
+
+module VBOX
+  UUID_RE  = /\{\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\}/
+
+  def self.api
+    @@api ||= CmdLineAPI.new
+  end
+end

data/lib/vbox.rb

@@ -0,0 +1,10 @@
+require 'vbox/vm'
+require 'vbox/cmdlineapi'
+
+module VBOX
+  UUID_RE  = /\{\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\}/
+
+  def self.api
+    @@api ||= CmdLineAPI.new
+  end
+end

data/lib/vbox/cli.rb

@@ -2,21 +2,10 @@
 require 'awesome_print'
 require 'optparse'
 
-# for natural sort order
-# http://stackoverflow.com/questions/4078906/is-there-a-natural-sort-by-method-for-ruby
-class String
-  def naturalized
-    scan(/[^\d]+|\d+/).collect { |f| f.match(/\d+/) ? f.to_i : f }
-  end
-end
-
 module VBOX
 
-  COMMANDS = %w'start pause resume reset poweroff savestate acpipowerbutton acpisleepbutton clone delete show'
   ALIASES  = {'clonevm'=>'clone', 'destroy'=>'delete', 'rm'=>'delete'}
 
-  UUID_RE  = /\{\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\}/
-
   class CLI
     def initialize argv = ARGV
       @argv = argv
@@ -178,231 +167,6 @@ module VBOX
     end
   end
 
-  VMInfo = Struct.new :name, :uuid, :memory_size, :dir_size, :state
-  Snapshot = Struct.new :name, :uuid
-
-  class CmdLineAPI
-    def initialize options={}
-      @options = options
-      @options[:verbose] ||= 2 if @options[:dry_run]
-      @options[:verbose] ||= 0
-    end
-
-    # run as in backtick operator, and return result
-    def ` cmd
-      puts "[.] #{cmd}".gray if @options[:verbose] >= 2
-      exit if @options[:dry_run]
-      r = super
-      #exit 1 unless $?.success?
-      r
-    end
-
-    # run as in system() call
-    def system *args
-      puts "[.] #{args.inspect}".gray if @options[:verbose] >= 2
-      exit if @options[:dry_run]
-      r = super
-      exit 1 unless $?.success?
-      r
-    end
-
-    def get_vm_details vm
-      data = `VBoxManage showvminfo #{vm.uuid} --machinereadable`
-      data.each_line do |line|
-        a = line.strip.split('=',2)
-        next unless a.size == 2
-        k,v = a
-        case k
-        when 'memory'
-          vm.memory_size = v.to_i
-        when 'VMState'
-          vm.state = v.tr('"','').to_sym
-        when 'CfgFile'
-          dir = File.dirname(v.tr('"',''))
-          s = `du -s -BM "#{dir}"`
-          vm.dir_size = s.split("\t").first.tr("M","")
-        end
-      end
-      vm
-    end
-
-    def list_vms params = {}
-      if params[:running]
-        data = `VBoxManage list runningvms`
-      else
-        data = `VBoxManage list vms`
-      end
-      r = []
-      data.strip.each_line do |line|
-        if line[UUID_RE]
-          vm = VMInfo.new
-          vm.uuid = $&
-          vm.name = line.gsub($&, '').strip.sub(/^"/,'').sub(/"$/,'')
-          r << vm
-        end
-      end
-      r.sort_by{ |vm| vm.name.naturalized }
-    end
-
-    def get_vm_info name
-      data = `VBoxManage showvminfo "#{name}" --machinereadable`
-      h = {}
-      data.each_line do |line|
-        line.strip!
-        k,v = line.split('=',2)
-        h[k] = v
-      end
-      h
-    end
-
-    def show name
-      get_vm_info(name).each do |k,v|
-        next if ['"none"', '"off"', '""'].include?(v)
-        puts "#{k}=#{v}"
-      end
-    end
-
-    COMMANDS.each do |cmd|
-      class_eval <<-EOF unless instance_methods.include?(cmd.to_sym)
-        def #{cmd} name
-          system "VBoxManage", "controlvm", name, "#{cmd}"
-        end
-      EOF
-    end
-
-    def start name
-      if ENV['DISPLAY'] && !@options[:headless]
-        system "VBoxManage", "startvm", name
-      else
-        puts "[.] $DISPLAY is not set, assuming --headless".gray unless @options[:headless]
-        @options[:headless] = true
-        system "VBoxManage", "startvm", name, "--type", "headless"
-      end
-    end
-
-
-    def get_snapshots _name
-      r = []
-      name = uuid = nil
-      `VBoxManage snapshot "#{_name}" list --machinereadable`.strip.each_line do |line|
-        k,v = line.strip.split('=',2)
-        next unless v
-        v = v.strip.sub(/^"/,'').sub(/"$/,'')
-        case k
-        when /SnapshotName/
-          name = v
-        when /SnapshotUUID/
-          uuid = v
-        end
-        if name && uuid
-          r << Snapshot.new(name, uuid)
-          name = uuid = nil
-        end
-      end
-      r
-    end
-
-    # d0   -> d1, d2, d3
-    # d1   -> d1.1, d1.2, d1.3
-    # d1.1 -> d1.1.1, d1.1.2, d1.1.3
-    def _gen_vm_name parent_name
-      # try to guess new name
-      numbers = parent_name.scan /\d+/
-      if numbers.any?
-        lastnum = numbers.last
-        names = list_vms.map(&:name)
-        if lastnum.to_i == 0
-          # d0 -> d1, d2, d3
-          newnum = lastnum.to_i + 1
-          while true
-            newname = parent_name.dup
-            newname[parent_name.rindex(lastnum),lastnum.size] = newnum.to_s
-            return newname unless names.include?(newname)
-            newnum += 1
-          end
-        else
-          # d1   -> d1.1, d1.2, d1.3
-          # d1.1 -> d1.1.1, d1.1.2, d1.1.3
-          newnum = 1
-          while true
-            newname = "#{parent_name}.#{newnum}"
-            return newname unless names.include?(newname)
-            newnum += 1
-          end
-        end
-      end
-      nil
-    end
-
-    def take_snapshot vm_name, params = {}
-      system "VBoxManage", "snapshot", vm_name, "take", params[:name] || "noname"
-      exit 1 unless $?.success?
-      get_snapshots(vm_name).last
-    end
-
-    def _name2macpart name
-      r = name.scan(/\d+/).map{ |x| "%02x" % x }.join
-      r == '' ? nil : r
-    end
-
-    def clone old_vm_name
-      @clone_use_snapshot = nil
-      (@options[:clones] || 1).times{ _clone(old_vm_name) }
-    end
-
-    def _clone old_vm_name
-      args = []
-      if new_vm_name = @options['name'] || _gen_vm_name(old_vm_name)
-        args += ["--name", new_vm_name]
-      end
-
-      snapshot = @clone_use_snapshot ||= case @options[:snapshot]
-        when 'new', 'take', 'make'
-          take_snapshot(old_vm_name, new_vm_name ? {:name => "for #{new_vm_name}"} : {})
-        when 'last'
-          get_snapshots(old_vm_name).last
-        else
-          puts "[!] please gimme --snapshot=LAST OR --snapshot=NEW option"
-          exit 1
-        end
-      unless snapshot
-        puts "[!] failed to get snapshot, cannot continue".red
-        exit 1
-      end
-
-      args += ["--options","link"]
-      args += ["--register"]
-      args += ["--snapshot", snapshot.uuid]
-
-      system "VBoxManage", "clonevm", old_vm_name, *args
-
-      get_vm_info(old_vm_name).each do |k,v|
-        if k =~ /^macaddress/
-          old_mac = v.tr('"','').downcase
-          puts "[.] old #{k}=#{old_mac}"
-          old_automac = _name2macpart(old_vm_name)
-          if old_automac && old_mac[-old_automac.size..-1] == old_automac
-            new_automac = _name2macpart(new_vm_name)
-            new_mac = old_mac[0,old_mac.size-new_automac.size] + new_automac
-            puts "[.] new #{k}=#{new_mac}"
-            modify new_vm_name, k, new_mac, :quiet => true
-          end
-        end
-      end
-    end
-
-    def modify name, k, v, params = {}
-      system "VBoxManage", "modifyvm", name, "--#{k}", v
-      if $?.success? && !params[:quiet]
-        h = get_vm_info(k == 'name' ? v : name)
-        puts "#{k}=#{h[k]}"
-      end
-    end
-
-    def delete name
-      system "VBoxManage", "unregistervm", name, "--delete"
-    end
-  end
 end
 
 

data/lib/vbox/cmdlineapi.rb

@@ -0,0 +1,266 @@
+#!/usr/bin/env ruby
+require 'awesome_print'
+
+module VBOX
+
+  COMMANDS = %w'start pause resume reset poweroff savestate acpipowerbutton acpisleepbutton clone delete show'
+
+  Snapshot = Struct.new :name, :uuid
+
+  class CmdLineAPI
+    attr_accessor :options
+
+    def initialize options={}
+      @options = options
+      @options[:verbose] ||= 2 if @options[:dry_run]
+      @options[:verbose] ||= 0
+    end
+
+    # run as in backtick operator, and return result
+    def ` cmd
+      puts "[.] #{cmd}".gray if @options[:verbose] >= 2
+      exit if @options[:dry_run]
+      r = super
+      #exit 1 unless $?.success?
+      r
+    end
+
+    # run as in system() call
+    def system *args
+      puts "[.] #{args.inspect}".gray if @options[:verbose] >= 2
+      exit if @options[:dry_run]
+      r = super
+      #exit 1 unless $?.success?
+      r
+    end
+
+    def get_vm_details vm_or_name_or_uuid
+      name_or_uuid = case vm_or_name_or_uuid
+        when String
+          vm = VM.new
+          vm_or_name_or_uuid
+        when VM
+          vm = vm_or_name_or_uuid
+          vm.uuid
+        end
+
+      data = `VBoxManage showvminfo "#{name_or_uuid}" --machinereadable`
+      data.each_line do |line|
+        k,v = line.strip.split('=',2)
+        next unless v
+        vm.all_vars[k] = v # not stripping quotes here to save some CPU time
+        case k
+        when 'name'
+          vm.name = v.strip.sub(/^"/,'').sub(/"$/,'')
+        when 'UUID'
+          vm.uuid = v.strip.sub(/^"/,'').sub(/"$/,'')
+        when 'memory'
+          vm.memory_size = v.to_i
+        when 'VMState'
+          vm.state = v.tr('"','').to_sym
+#        when 'CfgFile'
+#          dir = File.dirname(v.tr('"',''))
+#          s = `du -s -BM "#{dir}"`
+#          vm.dir_size = s.split("\t").first.tr("M","")
+        end
+      end
+      vm
+    end
+
+    # for natural string sort order
+    # http://stackoverflow.com/questions/4078906/is-there-a-natural-sort-by-method-for-ruby
+    def _naturalize s
+      s.scan(/[^\d]+|\d+/).collect { |f| f.match(/\d+/) ? f.to_i : f }
+    end
+
+    def list_vms params = {}
+      if params[:running]
+        data = `VBoxManage list runningvms`
+      else
+        data = `VBoxManage list vms`
+      end
+      r = []
+      data.strip.each_line do |line|
+        if line[UUID_RE]
+          vm = VM.new
+          vm.uuid = $&
+          vm.name = line.gsub($&, '').strip.sub(/^"/,'').sub(/"$/,'')
+          r << vm
+        end
+      end
+      r.sort_by{ |vm| _naturalize(vm.name) }
+    end
+
+    def get_vm_info name
+      data = `VBoxManage showvminfo "#{name}" --machinereadable`
+      h = {}
+      data.each_line do |line|
+        line.strip!
+        k,v = line.split('=',2)
+        h[k] = v
+      end
+      h
+    end
+
+    def show name
+      get_vm_info(name).each do |k,v|
+        next if ['"none"', '"off"', '""'].include?(v)
+        puts "#{k}=#{v}"
+      end
+    end
+
+    COMMANDS.each do |cmd|
+      class_eval <<-EOF unless instance_methods.include?(cmd.to_sym)
+        def #{cmd} name
+          system "VBoxManage", "controlvm", name, "#{cmd}"
+        end
+      EOF
+    end
+
+    def start name
+      if ENV['DISPLAY'] && !@options[:headless]
+        system "VBoxManage", "startvm", name
+      else
+        puts "[.] $DISPLAY is not set, assuming --headless".gray unless @options[:headless]
+        @options[:headless] = true
+        system "VBoxManage", "startvm", name, "--type", "headless"
+      end
+    end
+
+
+    def get_snapshots _name
+      r = []
+      name = uuid = nil
+      `VBoxManage snapshot "#{_name}" list --machinereadable`.strip.each_line do |line|
+        k,v = line.strip.split('=',2)
+        next unless v
+        v = v.strip.sub(/^"/,'').sub(/"$/,'')
+        case k
+        when /SnapshotName/
+          name = v
+        when /SnapshotUUID/
+          uuid = v
+        end
+        if name && uuid
+          r << Snapshot.new(name, uuid)
+          name = uuid = nil
+        end
+      end
+      r
+    end
+
+    # d0   -> d1, d2, d3
+    # d1   -> d1.1, d1.2, d1.3
+    # d1.1 -> d1.1.1, d1.1.2, d1.1.3
+    def _gen_vm_name parent_name
+      # try to guess new name
+      numbers = parent_name.scan /\d+/
+      if numbers.any?
+        lastnum = numbers.last
+        names = list_vms.map(&:name)
+        if lastnum.to_i == 0
+          # d0 -> d1, d2, d3
+          newnum = lastnum.to_i + 1
+          while true
+            newname = parent_name.dup
+            newname[parent_name.rindex(lastnum),lastnum.size] = newnum.to_s
+            return newname unless names.include?(newname)
+            newnum += 1
+          end
+        else
+          # d1   -> d1.1, d1.2, d1.3
+          # d1.1 -> d1.1.1, d1.1.2, d1.1.3
+          newnum = 1
+          while true
+            newname = "#{parent_name}.#{newnum}"
+            return newname unless names.include?(newname)
+            newnum += 1
+          end
+        end
+      end
+      nil
+    end
+
+    def take_snapshot vm_name, params = {}
+      system "VBoxManage", "snapshot", vm_name, "take", params[:name] || "noname"
+      exit 1 unless $?.success?
+      get_snapshots(vm_name).last
+    end
+
+    def _name2macpart name
+      r = name.scan(/\d+/).map{ |x| "%02x" % x }.join
+      r == '' ? nil : r
+    end
+
+    def clone old_vm_name, params = {}
+      @clone_use_snapshot = nil
+      params = @options.merge(params)
+      n = params[:clones] || 1
+      if n > 1
+        # return array of clones
+        n.times.map{ _clone(old_vm_name, params) }
+      elsif n == 1
+        # return one clone
+        _clone(old_vm_name, params)
+      else
+        raise "invalid count of clones = #{n.inspect}"
+      end
+    end
+
+    def _clone old_vm_name, params
+      args = []
+      if new_vm_name = params['name'] || _gen_vm_name(old_vm_name)
+        args += ["--name", new_vm_name]
+      end
+
+      snapshot = @clone_use_snapshot ||= case params[:snapshot].to_s
+        when 'new', 'take', 'make'
+          take_snapshot(old_vm_name, new_vm_name ? {:name => "for #{new_vm_name}"} : {})
+        when 'last'
+          get_snapshots(old_vm_name).last
+        else
+          puts "[!] please gimme --snapshot=LAST OR --snapshot=NEW option"
+          exit 1
+        end
+      unless snapshot
+        puts "[!] failed to get snapshot, cannot continue".red
+        exit 1
+      end
+
+      args += ["--options","link"]
+      args += ["--register"]
+      args += ["--snapshot", snapshot.uuid]
+
+      system "VBoxManage", "clonevm", old_vm_name, *args
+      return false unless $?.success?
+
+      get_vm_info(old_vm_name).each do |k,v|
+        if k =~ /^macaddress/
+          old_mac = v.tr('"','').downcase
+          puts "[.] old #{k}=#{old_mac}"
+          old_automac = _name2macpart(old_vm_name)
+          if old_automac && old_mac[-old_automac.size..-1] == old_automac
+            new_automac = _name2macpart(new_vm_name)
+            new_mac = old_mac[0,old_mac.size-new_automac.size] + new_automac
+            puts "[.] new #{k}=#{new_mac}"
+            modify new_vm_name, k, new_mac, :quiet => true
+          end
+        end
+      end
+      new_vm_name
+    end
+
+    def modify name, k, v, params = {}
+      system "VBoxManage", "modifyvm", name, "--#{k}", v
+      if $?.success? && !params[:quiet]
+        h = get_vm_info(k == 'name' ? v : name)
+        puts "#{k}=#{h[k]}"
+      end
+    end
+
+    def delete name
+      system "VBoxManage", "unregistervm", name, "--delete"
+    end
+    alias :destroy :delete
+  end
+end

data/lib/vbox/vm.rb

@@ -0,0 +1,61 @@
+module VBOX
+  class VM
+    attr_accessor :name, :uuid, :memory_size, :dir_size, :state, :all_vars
+
+    def initialize
+      @all_vars = {}
+    end
+
+    %w'start pause resume reset poweroff savestate acpipowerbutton acpisleepbutton destroy'.each do |action|
+      define_method "#{action}!" do
+        VBOX.api.send( action, uuid || name )
+      end
+    end
+
+    def clone! params
+      raise "argument must be a Hash" unless params.is_a?(Hash)
+      raise "no :snapshot key" unless params[:snapshot]
+      r = VBOX.api.clone self.name, params
+      case r
+      when Array
+        if r.first.is_a?(VM)
+          r
+        else
+          r.map{ |name| VM.find(name) }
+        end
+      when String
+        VM.find(r)
+      when nil
+        nil
+      else
+        r
+      end
+    end
+
+    def dir_size
+      @dir_size ||=
+        begin
+          VBOX.api.get_vm_details(self) unless @all_vars['CfgFile']
+          return nil unless v=@all_vars['CfgFile']
+          dir = File.dirname(v.tr('"',''))
+          `du -s -BM "#{dir}"`.split("\t").first.tr("M","").to_i
+        end
+    end
+
+    class << self
+      def all
+        VBOX.api.list_vms
+      end
+
+      def first
+        all.first
+      end
+
+      def find name_or_uuid
+        VBOX.api.get_vm_details name_or_uuid
+      end
+
+      alias :[] :find
+    end
+  end
+end

data/spec/vm_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "VBOX::VM" do
+  describe "all()" do
+    it "returns array" do
+      VBOX::VM.all.should be_instance_of(Array)
+    end
+
+    it "returns array of VBOX::VM" do
+      VBOX::VM.all.map(&:class).uniq.should == [VBOX::VM]
+    end
+  end
+
+  describe :first do
+    it "returns VBOX::VM" do
+      VBOX::VM.first.should be_instance_of(VBOX::VM)
+    end
+  end
+
+  TEST_VM_NAME = "d0"
+  TEST_VM_UUID = 'ae340207-f472-4d63-80e7-855fca6808cb'
+
+  [:find, :[]].each do |method|
+    describe method do
+      it "finds VM by name" do
+        vm = VBOX::VM.send(method, TEST_VM_NAME)
+        vm.should be_instance_of(VBOX::VM)
+      end
+
+      it "finds VM by uuid" do
+        vm = VBOX::VM.send(method, TEST_VM_UUID)
+        vm.should be_instance_of(VBOX::VM)
+      end
+
+      it "finds VM by {uuid}" do
+        vm = VBOX::VM.send(method, "{#{TEST_VM_UUID}}")
+        vm.should be_instance_of(VBOX::VM)
+      end
+    end
+  end
+
+  describe :dir_size do
+    VBOX::VM.first.dir_size.should > 0
+  end
+
+  %w'start pause resume reset poweroff savestate acpipowerbutton acpisleepbutton destroy clone'.each do |action|
+    action << "!"
+    describe action do
+      it "should respond to #{action}" do
+        VBOX::VM.first.should respond_to(action)
+      end
+    end
+  end
+end

data/vbox-ng.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "vbox-ng"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrey \"Zed\" Zaikin"]
@@ -27,11 +27,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/vbox",
+    "lib/vbox-ng.rb",
     "lib/vbox.rb",
     "lib/vbox/api41.rb",
     "lib/vbox/cli.rb",
+    "lib/vbox/cmdlineapi.rb",
+    "lib/vbox/vm.rb",
     "spec/spec_helper.rb",
-    "spec/vbox-ng_spec.rb",
+    "spec/vm_spec.rb",
     "vbox-ng.gemspec"
   ]
   s.homepage = "http://github.com/zed-0xff/vbox-ng"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vbox-ng
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -94,11 +94,14 @@ files:
 - Rakefile
 - VERSION
 - bin/vbox
+- lib/vbox-ng.rb
 - lib/vbox.rb
 - lib/vbox/api41.rb
 - lib/vbox/cli.rb
+- lib/vbox/cmdlineapi.rb
+- lib/vbox/vm.rb
 - spec/spec_helper.rb
-- spec/vbox-ng_spec.rb
+- spec/vm_spec.rb
 - vbox-ng.gemspec
 homepage: http://github.com/zed-0xff/vbox-ng
 licenses:
@@ -115,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1207365192943186499
+      hash: -1266878119588599901
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/spec/vbox-ng_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "VboxNg" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end