virtualman 0.0.0

data/lib/virtualman.rb

@@ -0,0 +1,88 @@
+# Implement a way to interact with the VirtualBox command line tool.
+# Each #Vm is a Class that contains the #name of the VM. With that 
+# name you can then interact with it through VBoxManage for example
+
+class Vm
+
+  # This attribute contains the name of the VM in VirtualBox.
+  attr_reader :name
+
+  # A #Vm is just described by it's name.
+  # *type is for further needs
+  def initialize(vm_name, *type)
+  	@name = vm_name
+  end
+
+  # Returns a boolean whether the VM is running or not
+  def running?
+  	!`VBoxManage showvminfo #{name} | grep State | grep running`.empty?
+  end
+
+  # A general method to interact with the VM.
+  # action is the kind of action to request to VBoxManage
+  # *param is a list of options
+  def manage(action, *param)
+    puts "VBoxManage #{action} #{@name} #{param.join(" ")}"
+    puts `VBoxManage #{action} #{@name} #{param.join(" ")}`
+  end
+
+  # A method to automatically Export a VM as an "importable" appliance
+  # /!\ be careful, this operation requires to poweroff the VM.
+  def backup!(folder)
+    self.manage("controlvm","poweroff")
+
+    filename = Time.now().strftime("#{@name.delete "\""}_%Y%m%dT%H%M")
+
+    self.manage("export","-o #{folder}/#{filename}.ova")
+
+    self.manage("startvm", "--type headless")
+  end
+end
+
+# Create an array tht contains all the #Vm from VirtualBox
+# And implement methods to play with it as a whole.
+class VmLister < Array
+
+  # Return an array with the list returned by the command "VBoxManage list vms"
+  # The argument *type will be used later (to specify a remote host for instance)
+  def perform_list(*type)
+    vm_list = `VBoxManage list vms`.split(/\n/).collect {|e| e[/".*"/]}
+    return vm_list
+  end
+
+  # Populate the array with the method perform_list
+  # The argument *type will be used later (to specify a remote host for instance)
+  def populate!(*type)
+    self.perform_list.each {|vm| self << Vm.new(vm)}
+  end
+
+  # A simple lister
+  def list
+    self.each {|vm| puts "#{vm.name}"}
+  end
+
+  # This methods returns a #VmLister object but just with the running VMs of the list.
+  def running?
+    running_vms = VmLister.new
+    self.collect {|vm| running_vms << vm if vm.running?}
+    return running_vms
+  end
+
+  # A general method to interact with the VBoxManage tool
+  # the block param could be useful for advanced links between your script and this class
+  def manage(action, *param, &block)
+    self.each do |vm|
+      block_param = block.call(vm.name) if block_given?
+      
+      puts "action: #{action} for the VM: #{vm.name} with options :"
+      puts "  #{param} #{block_param}"
+
+      vm.act(action, param, block_param)
+    end
+  end
+
+  # A method to automatically export the list of VMs
+  def backup!(folder)
+    self.each {|vm| vm.backup!(folder)}
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: virtualman
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pierre Ozoux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-16 00:00:00.000000000 Z
+dependencies: []
+description: It is for writing scripts for UNIX-like systems to handle your VirtualBox
+  appliance.
+email: pierre.ozoux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/virtualman.rb
+homepage: http://rubygems.org/gems/virtualman
+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.23
+signing_key: 
+specification_version: 3
+summary: A sinmple way to manage your Virtual Machines under VirtualBox.
+test_files: []