vbox-ng 0.1.0 → 0.1.1

data/README.md

@@ -9,7 +9,7 @@ Installation
 ------------
     gem install vbox-ng
 
-Usage
+Commandline usage
 -----
 
     # vbox -h
@@ -21,28 +21,97 @@ Usage
     	vbox [options] <vm_name> <command>       - make some action (start, reset, etc) on VM
     
     COMMANDS:
-    	acpipowerbutton
-    	acpisleepbutton
-    	clone
-    	delete
-    	pause
-    	poweroff
-    	reset
-    	resume
-    	savestate
-    	show
-    	snapshots
-    	start
+    	start, pause, resume, reset, poweroff, savestate,
+    	acpipowerbutton, acpisleepbutton, clone, delete, show, snapshots
     
     OPTIONS:
-        -m, --[no-]multiple              (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
-        -n, --dry-run                    do not change anything, just print commands to be invoked
-        -v, --verbose                    increase verbosity
-        -c, --clones N                   clone: make N clones
-        -s, --snapshot MODE              clone: use LAST shapshot or make NEW
-        -H, --headless                   start: start VM in headless mode
-        -h, --help                       show this message
+    	-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
+    	-n, --dry-run                    do not change anything, just print commands to be invoked
+    	-v, --verbose                    increase verbosity
+    	-c, --clones N                   clone: make N clones
+    	-S, --snapshot MODE              clone: use LAST shapshot or make NEW
+    	-H, --headless                   start: start VM in headless mode
+    	-h, --help                       show this message
+    
+    EXAMPLES:
+    	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 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
+    	vbox d0 clone -c 10 -S new     - make ONE new shapshot of VM 'd0' and then make
+    	                                 10 new clones linked to this snapshot
+    	vbox "tmp?" delete             - try to destroy all VMs which name is 4 letters long
+    	                                 and starts with 'tmp'
+    	vbox ae340207-f472-4d63-80e7-855fca6808cb
+    	                               - list all parameters of VM with this GUID
+    	vbox --no-glob "*wtf?!*" rm    - destroy VM which name is '*wtf?!*'
+
+Ruby examples
+=============
+
+Clone first VM
+-----
+``` ruby
+# irb
+>> require 'vbox'
+=> true
+>> vm = VBOX::VM.first
+=> #<VBOX::VM:0x000000012c5320 @all_vars={}, @uuid="{ae340207-f472-4d63-80e7-855fca6808cb}", @name="d0">
+>> vm2 = vm.clone! :snapshot => :last
+0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+Machine has been successfully cloned as "d1"
+[.] old macaddress1=dec0de000000
+[.] new macaddress1=dec0de000001
+=> #<VBOX::VM:0x00000001315820 @all_vars={}, @uuid="{59d9af2a-4401-4b38-ad74-b5c6c6b45a81}", @name="d1">
+```
+
+Find VM by name and start it
+-----
+``` ruby
+>> vm2 = VBOX::VM.find 'd14'
+>> vm2.start!
+[.] $DISPLAY is not set, assuming --headless
+Waiting for VM "59d9af2a-4401-4b38-ad74-b5c6c6b45a81" to power on...
+VM "59d9af2a-4401-4b38-ad74-b5c6c6b45a81" has been successfully started.
+=> true
+```
+
+Stop VM and destroy it (delete all its files)
+-----
+``` ruby
+>> vm2 = VBOX::VM.find 'd14'
+>> vm2.poweroff!
+0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+=> true
+>> vm2.destroy!
+0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+=> true
+>> vm2 = VBOX::VM.find 'd14'
+=> nil
+```
+
+Calculate total disk space occupied by all VMs
+-----
+``` ruby
+>> VBOX::VM.all.map(&:dir_size).inject(&:+)
+=> 20271
+```
+
+Show all VMs sorted by directory size in reverse order
+-----
+``` ruby
+>> VBOX::VM.all.sort_by(&:dir_size).reverse.each{ |vm| printf "%5d %s\n", vm.dir_size, vm.name }
+ 9175 xp
+ 5336 rwthCTF2012 vulnbox final
+ 2962 ubuntu 12.04.1
+ 2184 d0
+  109 u2
+   87 u1
+```

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/vbox/cli.rb

@@ -11,22 +11,62 @@ module VBOX
       @argv = argv
     end
 
+    def _join_by_width words, params = {}
+      params[:max_length] ||= 30
+      params[:separator]  ||= ", "
+      params[:newline]    ||= "\n"
+      lines = []
+      line = []
+      words.each do |word|
+        if (line+[word]).join(params[:separator]).size > params[:max_length]
+          lines << line.join(params[:separator])
+          line = []
+        end
+        line << word
+      end
+      lines << line.join(params[:separator]) unless line.empty?
+      lines.join params[:newline]
+    end
+
     def banner
-      bname = File.basename(__FILE__)
+      bname = File.basename($0)
       r = []
-      r <<  "USAGE:"
-      r <<  "\t#{bname} [options]                           - list VMs"
-      r <<  "\t#{bname} [options] <vm_name>                 - show VM params"
-      r <<  "\t#{bname} [options] <vm_name> <param>=<value> - change VM params (name, cpus, usb, etc)"
-      r <<  "\t#{bname} [options] <vm_name> <command>       - make some action (start, reset, etc) on VM"
-
-      r <<  ""
-      r <<  "COMMANDS:"
-      (COMMANDS+['snapshots']).sort.each do |c|
-        r <<  "\t#{c}"
-      end
-      r <<  ""
-      r <<  "OPTIONS:"
+      r << "USAGE:"
+      r << "\t#{bname} [options]                           - list VMs"
+      r << "\t#{bname} [options] <vm_name>                 - show VM params"
+      r << "\t#{bname} [options] <vm_name> <param>=<value> - change VM params (name, cpus, usb, etc)"
+      r << "\t#{bname} [options] <vm_name> <command>       - make some action (start, reset, etc) on VM"
+
+      r << ""
+      r << "COMMANDS:"
+#      (COMMANDS+['snapshots']).sort.each do |c|
+#        r << "\t#{c}"
+#      end
+      r << "\t" + _join_by_width(COMMANDS+['snapshots'], newline: ",\n\t", max_length: 64 )
+      r << ""
+      r << "OPTIONS:"
+      r.join("\n")
+    end
+
+    def examples
+      bname = File.basename($0)
+      space = " "*bname.size
+      r = []
+      r << "EXAMPLES:"
+      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} 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}
+      r << %Q{\t#{bname} d0 clone -c 10 -S new     - make ONE new shapshot of VM 'd0' and then make}
+      r << %Q{\t#{space}                             10 new clones linked to this snapshot}
+      r << %Q{\t#{bname} "tmp?" delete             - try to destroy all VMs which name is 4 letters long}
+      r << %Q{\t#{space}                             and starts with 'tmp'}
+      r << %Q{\t#{bname} ae340207-f472-4d63-80e7-855fca6808cb}
+      r << %Q{\t#{space}                           - list all parameters of VM with this GUID}
+      r << %Q{\t#{bname} --no-glob "*wtf?!*" rm    - destroy VM which name is '*wtf?!*'}
       r.join("\n")
     end
 
@@ -34,8 +74,9 @@ module VBOX
       @options = { :verbose => 0 }
       optparser = OptionParser.new do |opts|
         opts.banner = banner
+        opts.summary_indent = "\t"
 
-        opts.on "-m", "--[no-]multiple",
+        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",
@@ -53,7 +94,7 @@ module VBOX
           @options[:clones] = x
         end
         a = 'new last take make'.split.map{ |x| [x, x.upcase] }.flatten
-        opts.on "-snapshot", "--snapshot MODE", a, "clone: use LAST shapshot or make NEW" do |x|
+        opts.on "-S", "--snapshot MODE", a, "clone: use LAST shapshot or make NEW" do |x|
           @options[:snapshot] = x.downcase
         end
         opts.on "-H", "--headless", "start: start VM in headless mode" do
@@ -64,7 +105,7 @@ module VBOX
           exit
         end
       end
-      @help = optparser.help
+      @help = optparser.help + "\n" + examples
       @argv = optparser.parse(@argv)
 
       # disable glob matching if first arg is a UUID

data/lib/vbox/cmdlineapi.rb

@@ -64,7 +64,7 @@ module VBOX
 #          vm.dir_size = s.split("\t").first.tr("M","")
         end
       end
-      vm
+      (vm.name && vm.uuid) ? vm : nil
     end
 
     # for natural string sort order

data/spec/vm_spec.rb

@@ -36,6 +36,11 @@ describe "VBOX::VM" do
         vm = VBOX::VM.send(method, "{#{TEST_VM_UUID}}")
         vm.should be_instance_of(VBOX::VM)
       end
+
+      it "finds nothing" do
+        vm = VBOX::VM.send(method, "blah-blah-blah-unexistant-vm-#{rand}-#{rand}-#{rand}")
+        vm.should be_nil
+      end
     end
   end
 

data/vbox-ng.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "vbox-ng"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrey \"Zed\" Zaikin"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vbox-ng
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1266878119588599901
+      hash: -3650103115613908891
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: