esx 0.2.4 → 0.3.1

data/README.md

@@ -102,6 +102,8 @@ __esx create-vm --user root --password foo --name esx-rubiojr --disk-file /path/
 
 # Testing 
 
+Run 'bundler install' to install required deps.
+
 Run rspec from the base dir. By default, the tests try to connect to an ESX host named esx-test-host with user root and no password. Edit spec/spec_helper.rb to fit your needs.
 
 # Copyright

data/bin/esx

@@ -71,15 +71,96 @@ class InfoCommand < BaseCommand
   end
 end
 
+class DestroyVMCommand < BaseCommand
+
+  parameter "ADDRESS", "ESX host address"
+  option "--vm-name", "VM_NAME", "Virtual Machine to destroy"
+
+  def execute
+    begin
+      host = ESX::Host.connect address, user, password
+      host.virtual_machines.each do |vm|
+        if vm.name == vm_name 
+          print "Destroying Virtual Machine '#{vm.name}'..."
+          vm.power_off unless vm.power_state == 'poweredOff'
+          vm.destroy
+          puts "Done."
+        end
+      end
+    rescue Exception => e
+      $stderr.puts "Can't connect to the host #{address}."
+      if debug?
+        $stderr.puts e.message
+      end
+      exit 1
+    end
+  end
+
+end
+
+class PowerOffVMCommand < BaseCommand
+
+  parameter "ADDRESS", "ESX host address"
+  option "--vm-name", "VM_NAME", "Virtual Machine to Power Off"
+
+  def execute
+    begin
+      host = ESX::Host.connect address, user, password
+      host.virtual_machines.each do |vm|
+        if vm.name == vm_name and vm.power_state == 'poweredOn'
+          print "Powering Off VM #{vm_name}... "
+          vm.power_off
+          puts "Done."
+        end
+      end
+    rescue Exception => e
+      $stderr.puts "Can't connect to the host #{address}."
+      if debug?
+        $stderr.puts e.message
+      end
+      exit 1
+    end
+  end
+
+end
+
+class PowerOnVMCommand < BaseCommand
+
+  parameter "ADDRESS", "ESX host address"
+  option "--vm-name", "VM_NAME", "Virtual Machine to Power On"
+
+  def execute
+    begin
+      host = ESX::Host.connect address, user, password
+      host.virtual_machines.each do |vm|
+        if vm.name == vm_name and vm.power_state != 'poweredOn'
+          print "Powering On VM #{vm_name}... "
+          vm.power_on
+          puts "Done."
+        end
+      end
+    rescue Exception => e
+      $stderr.puts "Can't connect to the host #{address}."
+      if debug?
+        $stderr.puts e.message
+      end
+      exit 1
+    end
+  end
+
+end
+
+
 class CreateVMCommand < BaseCommand
 
   parameter "ADDRESS", "ESX host address"
   option "--disk-file", "DISK_FILE", "VMDK file to import", :attribute_name => :disk_file
-  option "--disk-size", "DISK_SIZE", "VM Disk size", :attribute_name => :disk_size, :default => 8192
+  option "--disk-size", "DISK_SIZE", "VM Disk size in MB", :attribute_name => :disk_size, :default => 8192
   option "--guest-id", "GUEST_ID", "GuestID value", :attribute_name => :guest_id, :default => 'otherGuest'
   option "--name", "VM NAME", "Virtual Machine name (required)"
   option "--memory", "MEMORY", "VM Memory size in MB", :default => 512
   option "--mac-address", "MAC", "VM Nic1 MAC address", :default => nil
+  option "--vm-network", "VM NETWORK", "Network where nic is attached to", :default => 'VM Network'
   option "--tmpdir", "TMP DIR", "tmp dir used to download files", :default => "/tmp"
   option "--datastore", "DATASTORE", "Datastore used to host the disk", :default => "datastore1"
   option "--poweron", :flag, "Power on the VM after creation"
@@ -103,7 +184,7 @@ class CreateVMCommand < BaseCommand
       vm = host.create_vm :vm_name => name, 
                           :datastore => datastore, :disk_type => :flat, :memory => memory,
                           :disk_size => disk_size,
-                          :guest_id => guest_id, :mac_address => mac_address
+                          :guest_id => guest_id, :nics => [{:mac_address => mac_address, :network => vm_network}]
     else
       df = disk_file.dup
       if df.strip.chomp =~ /^http/
@@ -205,6 +286,9 @@ end
 class DefaultCommand < Clamp::Command
   default_subcommand "info", "Display host info", InfoCommand
   subcommand "create-vm", "Create a VM", CreateVMCommand
+  subcommand "poweron-vm", "Power On a VM", PowerOnVMCommand
+  subcommand "poweroff-vm", "Power Off a VM", PowerOffVMCommand
+  subcommand "destroy-vm", "Destroy VM", DestroyVMCommand
 end
 
 begin

data/lib/esx.rb

@@ -6,7 +6,7 @@ require 'net/ssh'
 
 module ESX
 
-  VERSION = '0.2.4'
+  VERSION = '0.3.1'
 
   class Host
 
@@ -44,26 +44,34 @@ module ESX
 
     # Host memory size in bytes
     #
+    # returns a Fixnum
+    #
     def memory_size
-      @_host.hardware.memorySize
+      @_host.hardware.memorySize.to_i
     end
 
     # Number of CPU cores available in this host
     #
+    # returns a String
+    #
     def cpu_cores
       @_host.hardware.cpuInfo.numCpuCores
     end
 
     # Power state of this host
     #
+    # poweredOn, poweredOff
+    #
     def power_state
       @_host.summary.runtime.powerState
     end
     
     # Host memory usage in bytes 
+    # 
+    # returns a Fixnum
     #
     def memory_usage
-      @_host.summary.quickStats.overallMemoryUsage.megabytes.to.bytes.to_i
+      @_host.summary.quickStats.overallMemoryUsage * 1024 * 1024
     end
 
     
@@ -124,10 +132,6 @@ module ESX
                              :key => 1000,
                              :busNumber => 0,
                              :sharedBus => :noSharing)
-          },
-          {
-            :operation => :add,
-            :device => RbVmomi::VIM.VirtualE1000(create_net_dev(specification))
           }
         ],
         :extraConfig => [
@@ -137,7 +141,21 @@ module ESX
           }
         ]
       }
-
+      
+      #Add multiple nics
+      nics_count = 0
+      if spec[:nics]
+        spec[:nics].each do |nic_spec|
+          vm_cfg[:deviceChange].push(
+            {
+              :operation => :add,
+              :device => RbVmomi::VIM.VirtualE1000(create_net_dev(nics_count, nic_spec))
+              
+            }
+          )
+          nics_count += 1
+        end
+      end
       # VMDK provided, replace the empty vmdk
       vm_cfg[:deviceChange].push(create_disk_spec(:disk_file => spec[:disk_file], 
                                 :disk_type => spec[:disk_type],
@@ -147,17 +165,18 @@ module ESX
       VM.wrap(@_datacenter.vmFolder.CreateVM_Task(:config => vm_cfg, :pool => @_datacenter.hostFolder.children.first.resourcePool).wait_for_completion)
     end
 
-    def create_net_dev(spec)
+    def create_net_dev(nic_id, spec)
       h = {
-        :key => 0,
+        :key => nic_id,
         :deviceInfo => {
-          :label => 'Network Adapter 1',
-          :summary => 'VM Network'
+          :label => "Network Adapter #{nic_id}",
+          :summary => spec[:network] || 'VM Network'
         },
         :backing => RbVmomi::VIM.VirtualEthernetCardNetworkBackingInfo(
-          :deviceName => 'VM Network'
+          :deviceName => spec[:network] || 'VM Network'
         )
       }
+
       if spec[:mac_address]
         h[:macAddress] = spec[:mac_address]
         h[:addressType] = 'manual'
@@ -298,7 +317,7 @@ module ESX
     def self.wrap(vm)
       _vm = VM.new
       _vm.name = vm.name
-      _vm.memory_size = vm.summary.config.memorySizeMB.megabytes.to.bytes
+      _vm.memory_size = vm.summary.config.memorySizeMB*1024*1024
       _vm.cpus = vm.summary.config.numCpu
       _vm.ethernet_cards_number = vm.summary.config.numEthernetCards 
       _vm.virtual_disks_number = vm.summary.config.numVirtualDisks
@@ -324,22 +343,9 @@ module ESX
     end
 
     # Destroy the VirtualMaching removing it from the inventory
-    #
-    # This operation does not destroy VM disks
-    #
+    # and deleting the disk files
     def destroy
-      disks = vm_object.config.hardware.device.grep(RbVmomi::VIM::VirtualDisk)
-      #disks.select { |x| x.backing.parent == nil }.each do |disk|
-      #  spec = {
-      #    :deviceChange => [
-      #      {
-      #        :operation => :remove,
-      #        :device => disk
-      #      }
-      #    ]
-      #  }
-      #  vm_object.ReconfigVM_Task(:spec => spec).wait_for_completion
-      #end
+      #disks = vm_object.config.hardware.device.grep(RbVmomi::VIM::VirtualDisk)
       vm_object.Destroy_Task.wait_for_completion
     end
 

data/spec/spec_helper.rb

@@ -24,4 +24,27 @@ module ESXTestHelpers
     ""
   end
 
+  def test_data_dir
+    File.dirname(__FILE__) + '/data'
+  end
+
+  def test_host_object
+    @test_host = ESX::Host.connect(esx_host, esx_user, esx_password)
+  end
+  
+  def create_simple_vm
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{ :mac_address => nil, :network => nil }]
+
+    vm = test_host_object.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+    vm
+  end
+
 end

data/spec/unit/host_spec.rb

@@ -7,6 +7,12 @@ describe "ESX host" do
     @test_host = ESX::Host.connect(esx_host, esx_user, esx_password)
   end
 
+  after do
+    @test_host.virtual_machines.each do |vm|
+      vm.destroy
+    end
+  end
+
   it "connects to and ESX with a valid user/pass" do
     host = nil
     lambda do
@@ -18,4 +24,125 @@ describe "ESX host" do
   it "retrives the host name" do
     @test_host.name.should_not be_nil
   end
+
+  it "has no virtual machines" do
+    @test_host.virtual_machines.should be_empty
+  end
+
+  it "creates one one virtual machine with a 1GB empty disk, 512MB RAB, 1NIC" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{ :mac_address => nil, :network => nil }]
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+    @test_host.virtual_machines.size.should eql(1)
+
+    vm = @test_host.virtual_machines.find { |vm| vm.name == 'test1GB' }
+    vm.should_not be_nil
+    vm.memory_size.should eql(512 * 1024 * 1024)
+    vm.ethernet_cards_number.should eql(1)
+    vm.virtual_disks_number.should eql(1)
+  end
+
+  it "should be able to create a VM with 2 nics" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{ :mac_address => nil, :network => nil }, { :mac_address => nil, :network => nil }]
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+
+    vm.ethernet_cards_number.should eql(2)
+  end
+
+  it "should create a VM with 0 NICs if no NIC config is specified" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id
+
+    vm.ethernet_cards_number.should eql(0)
+  end
+  
+  it "should create a VM with 1 NICs and an autogenerated MAC address" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{}]
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+
+    vm.ethernet_cards_number.should eql(1)
+    vm.nics.first.mac.should eql("")
+  end
+
+  it "has an array of datastores with one datastore named datastore1" do
+    @test_host.datastores.is_a?(Array).should be_true
+    @test_host.datastores.first.should be_a ESX::Datastore
+    @test_host.datastores.first.name.should eql('datastore1')
+  end
+
+  it "should be able to create and destroy a VM" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{ :mac_address => nil, :network => nil }]
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+    @test_host.virtual_machines.size.should eql(1)
+    vm = @test_host.virtual_machines.find { |vm| vm.name == 'test1GB' }
+    vm.destroy
+    @test_host.virtual_machines.size.should eql(0)
+  end
+
+  it "should be able to create a VM with a custom MAC address" do
+    name = 'test1GB'
+    disk_size = 1024
+    datastore = 'datastore1'
+    guest_id = 'otherGuest'
+    memory = 512
+    nics = [{ :mac_address => '00:01:02:03:04:05', :network => nil }]
+
+    vm = @test_host.create_vm :vm_name => name, 
+                        :datastore => datastore, :disk_type => :flat, :memory => memory,
+                        :disk_size => disk_size,
+                        :guest_id => guest_id, :nics => nics
+    vm = @test_host.virtual_machines.find { |vm| vm.name == name }
+    vm.nics.first.mac.should eql('00:01:02:03:04:05')
+  end 
+  
+  it "should have valid property types" do
+    @test_host.memory_size.should be_a Fixnum 
+    @test_host.memory_size.should be > 0
+    @test_host.memory_usage.should be_a Fixnum 
+    @test_host.memory_usage.should be > 0
+  end
+
 end

data/spec/unit/vm_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "ESX Virtual Machine" do
+  include ESXTestHelpers
+
+  before do
+    @test_host = ESX::Host.connect(esx_host, esx_user, esx_password)
+  end
+  
+  after do
+    @test_host.virtual_machines.each do |vm|
+      vm.destroy
+    end
+  end
+
+  it "should have an Array of NetworkInterfaces" do
+    vm = create_simple_vm
+    vm.nics.size.should eql(1)
+    vm.nics.first.should be_a ESX::NetworkInterface
+  end 
+ 
+  it "should have valid property types" do
+    vm = create_simple_vm
+    vm.memory_size.should be_a Fixnum 
+    vm.memory_size.should be > 0
+    vm.nics.should be_an Array
+    vm.power_state.should be_a String
+  end
+  
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esx
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000 Z
+date: 2012-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11459820 !ruby/object:Gem::Requirement
+  requirement: &17898020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11459820
+  version_requirements: *17898020
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &11457160 !ruby/object:Gem::Requirement
+  requirement: &17894660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *11457160
+  version_requirements: *17894660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11469480 !ruby/object:Gem::Requirement
+  requirement: &17928200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11469480
+  version_requirements: *17928200
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &11467120 !ruby/object:Gem::Requirement
+  requirement: &17926060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11467120
+  version_requirements: *17926060
 - !ruby/object:Gem::Dependency
   name: alchemist
-  requirement: &11497120 !ruby/object:Gem::Requirement
+  requirement: &17922780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11497120
+  version_requirements: *17922780
 - !ruby/object:Gem::Dependency
   name: rbvmomi
-  requirement: &11493140 !ruby/object:Gem::Requirement
+  requirement: &17949440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11493140
+  version_requirements: *17949440
 - !ruby/object:Gem::Dependency
   name: terminal-table
-  requirement: &11584320 !ruby/object:Gem::Requirement
+  requirement: &17947300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11584320
+  version_requirements: *17947300
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &11582280 !ruby/object:Gem::Requirement
+  requirement: &17945200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11582280
+  version_requirements: *17945200
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &11580560 !ruby/object:Gem::Requirement
+  requirement: &17942780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11580560
+  version_requirements: *17942780
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &11578480 !ruby/object:Gem::Requirement
+  requirement: &17969780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11578480
+  version_requirements: *17969780
 description: Manage VMWare ESX hosts with ease
 email: rubiojr@frameos.org
 executables:
@@ -138,8 +138,10 @@ files:
 - bin/esx
 - examples/basics.rb
 - lib/esx.rb
+- spec/data/tc.vmdk
 - spec/spec_helper.rb
 - spec/unit/host_spec.rb
+- spec/unit/vm_spec.rb
 homepage: http://github.com/rubiojr/esx
 licenses:
 - MIT