esx 0.4.2 → 0.4.3

data/README.md

@@ -110,4 +110,3 @@ Run rspec from the base dir. By default, the tests try to connect to an ESX host
 
 Copyright (c) 2011 Sergio Rubio. See LICENSE.txt for
 further details.
-

data/esx.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "esx"
+  s.version = "0.4.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Rubio", "Massimo Maino"]
+  s.date = "2013-03-29"
+  s.description = "Manage VMWare ESX hosts with ease"
+  s.email = "rubiojr@frameos.org"
+  s.executables = ["esx"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/esx",
+    "esx.gemspec",
+    "examples/basics.rb",
+    "lib/esx.rb",
+    "spec/spec_helper.rb",
+    "spec/unit/helper_spec.rb",
+    "spec/unit/host_spec.rb",
+    "spec/unit/vm_spec.rb",
+    "templates/vmx_template.erb"
+  ]
+  s.homepage = "http://github.com/rubiojr/esx"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Simple RbVmomi wrapper library to manage VMWare ESX hosts"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<net-ssh>, [">= 0"])
+      s.add_development_dependency(%q<net-scp>, [">= 0"])
+      s.add_development_dependency(%q<rbvmomi>, [">= 0"])
+      s.add_development_dependency(%q<alchemist>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<alchemist>, [">= 0"])
+      s.add_runtime_dependency(%q<rbvmomi>, [">= 0"])
+      s.add_runtime_dependency(%q<terminal-table>, [">= 0"])
+      s.add_runtime_dependency(%q<net-ssh>, [">= 0"])
+      s.add_runtime_dependency(%q<net-scp>, [">= 0"])
+      s.add_runtime_dependency(%q<clamp>, [">= 0"])
+    else
+      s.add_dependency(%q<net-ssh>, [">= 0"])
+      s.add_dependency(%q<net-scp>, [">= 0"])
+      s.add_dependency(%q<rbvmomi>, [">= 0"])
+      s.add_dependency(%q<alchemist>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<alchemist>, [">= 0"])
+      s.add_dependency(%q<rbvmomi>, [">= 0"])
+      s.add_dependency(%q<terminal-table>, [">= 0"])
+      s.add_dependency(%q<net-ssh>, [">= 0"])
+      s.add_dependency(%q<net-scp>, [">= 0"])
+      s.add_dependency(%q<clamp>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<net-ssh>, [">= 0"])
+    s.add_dependency(%q<net-scp>, [">= 0"])
+    s.add_dependency(%q<rbvmomi>, [">= 0"])
+    s.add_dependency(%q<alchemist>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["> 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<alchemist>, [">= 0"])
+    s.add_dependency(%q<rbvmomi>, [">= 0"])
+    s.add_dependency(%q<terminal-table>, [">= 0"])
+    s.add_dependency(%q<net-ssh>, [">= 0"])
+    s.add_dependency(%q<net-scp>, [">= 0"])
+    s.add_dependency(%q<clamp>, [">= 0"])
+  end
+end
+

data/lib/esx.rb

@@ -4,10 +4,11 @@ require 'alchemist'
 require 'net/scp'
 require 'net/ssh'
 require 'erb'
+require 'tempfile'
 
 module ESX
 
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 
   if !defined? Log or Log.nil?
     Log = Logger.new($stdout)
@@ -41,7 +42,7 @@ module ESX
     #
     # Host connection is insecure by default
    def self.connect(host, user, password,  insecure = true, opts = {})
-      vim = RbVmomi::VIM.connect :host => host, :user => user, :password => password, :insecure => insecure
+      vim = RbVmomi::VIM.connect :host => host, :user => user, :password => password, :insecure => insecure, :rev => opts[:rev]||'4.0'
       host = Host.new(host, user,password, opts)
       host.vim = vim
       host
@@ -184,6 +185,7 @@ module ESX
       else
         gem_root = Gem::Specification.find_by_name("esx").gem_dir
         template_path = File.join(gem_root, 'templates', 'vmx_template.erb')
+        spec[:guest_id] = convert_guest_id_for_vmdk(spec[:guest_id])
         erb = ERB.new File.read(template_path)
         vmx = erb.result binding
         tmp_vmx = Tempfile.new 'vmx'
@@ -192,6 +194,7 @@ module ESX
         ds = spec[:datastore]||'datastore1'
         ds = ds.gsub('[','').gsub(']','')
         vmx_path = "/vmfs/volumes/#{ds}/#{spec[:vm_name]}/#{spec[:vm_name]}.vmx"
+        remote_command "mkdir -p #{File.dirname(vmx_path)}"
         upload_file tmp_vmx.path, vmx_path
         remote_command "vim-cmd solo/registervm #{vmx_path}"
         VM.wrap(@_datacenter.find_vm(spec[:vm_name]),self)
@@ -235,16 +238,29 @@ module ESX
       ]
     end
 
-    # Return a list of VM available in the inventory
+    # Return a list of VM available in the inventory * recursive search of folders as well
     #
     def virtual_machines
       vms = []
-      vm = @_datacenter.vmFolder.childEntity.each do |x|
-        vms << VM.wrap(x,self)
-      end
+      vm = @_datacenter.vmFolder
+      vms = recursive_virtual_machine(vm,vms)
+
       vms
     end
 
+    def recursive_virtual_machine(parentObject,array)
+      vm = parentObject.childEntity.each do |x|
+        if x.to_s.match("Folder")
+          array = recursive_virtual_machine(x,array)
+        else
+          array << VM.wrap(x,self)
+        end
+      end
+
+      array
+    end
+    private :recursive_virtual_machine
+
     #
     # Run a command in the ESX host via SSH
     #
@@ -438,6 +454,15 @@ module ESX
       spec[:fileOperation] = :create if disk_file.nil?
       spec
     end
+
+    def convert_guest_id_for_vmdk(guest_id)
+      exceptions = {
+        "winLonghornGuest" => "longhorn",
+        "winLonghorn64Guest" => "longhorn-64",
+      }
+      return exceptions[guest_id] if exceptions[guest_id]
+      guest_id.downcase.gsub(/guest/, '').gsub(/_?64/, '-64')
+    end
   end
 
   class VM

data/spec/unit/helper_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe "ESX host helpers" do
+  subject { ESX::Host.new("address", "user", "password") }
+
+  describe "convert_guest_id_for_vmdk" do
+
+    # key: http://pubs.vmware.com/vsphere-50/index.jsp?topic=/com.vmware.wssdk.apiref.doc_50/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
+    # value: in vmx file
+    guest_id_map =  {
+      "dosGuest" => "dos",
+      "win31Guest" => "win31",
+      "win95Guest" => "win95",
+      "win98Guest" => "win98",
+      "winMeGuest" => "winme",
+      "winNTGuest" => "winnt",
+      "win2000ProGuest" => "win2000pro",
+      "win2000ServGuest" => "win2000serv",
+      "win2000AdvServGuest" => "win2000advserv",
+      "winXPHomeGuest" => "winxphome",
+      "winXPProGuest" => "winxppro",
+      "winXPPro64Guest" => "winxppro-64",
+      "winNetWebGuest" => "winnetweb",
+      "winNetStandardGuest" => "winnetstandard",
+      "winNetEnterpriseGuest" => "winnetenterprise",
+      "winNetDatacenterGuest" => "",
+      "winNetBusinessGuest" => "",
+      "winNetStandard64Guest" => "winnetstandard-64",
+      "winNetEnterprise64Guest" => "winnetenterprise-64",
+      "winLonghornGuest" => "longhorn",
+      "winLonghorn64Guest" => "longhorn-64",
+      "winNetDatacenter64Guest" => "",
+      "winVistaGuest" => "winvista",
+      "winVista64Guest" => "winvista-64",
+      "windows7Guest" => "windows7",
+      "windows7_64Guest" => "windows7-64",
+      "windows7Server64Guest" => "",
+      "windows8Guest" => "windows8",
+      "windows8_64Guest" => "windows8-64",
+      "windows8Server64Guest" => "",
+      "freebsdGuest" => "freebsd",
+      "freebsd64Guest" => "freebsd-64",
+      "redhatGuest" => "redhat",
+      "rhel2Guest" => "rhel2",
+      "rhel3Guest" => "rhel3",
+      "rhel3_64Guest" => "rhel3-64",
+      "rhel4Guest" => "rhel4",
+      "rhel4_64Guest" => "rhel4-64",
+      "rhel5Guest" => "rhel5",
+      "rhel5_64Guest" => "rhel5-64",
+      "rhel6Guest" => "rhel6",
+      "rhel6_64Guest" => "rhel6-64",
+      "centosGuest" => "centos",
+      "centos64Guest" => "centos-64",
+      "oracleLinuxGuest" => "oraclelinux",
+      "oracleLinux64Guest" => "oraclelinux-64",
+      "suseGuest" => "suse",
+      "suse64Guest" => "suse-64",
+      "slesGuest" => "sles",
+      "sles64Guest" => "sles-64",
+      "sles10Guest" => "sles10",
+      "sles10_64Guest" => "sles10-64",
+      "sles11Guest" => "sles11",
+      "sles11_64Guest" => "sles11-64",
+      "nld9Guest" => "nld9",
+      "oesGuest" => "oes",
+      "sjdsGuest" => "sjds",
+      "mandrivaGuest" => "mandriva",
+      "mandriva64Guest" => "mandriva-64",
+      "turboLinuxGuest" => "turbolinux",
+      "turboLinux64Guest" => "turbolinux-64",
+      "ubuntuGuest" => "ubuntu",
+      "ubuntu64Guest" => "ubuntu-64",
+      "debian4Guest" => "debian4",
+      "debian4_64Guest" => "debian4-64",
+      "debian5Guest" => "debian5",
+      "debian5_64Guest" => "debian5-64",
+      "debian6Guest" => "debian6",
+      "debian6_64Guest" => "debian6-64",
+      "asianux3Guest" => "asianux3",
+      "asianux3_64Guest" => "asianux3-64",
+      "asianux4Guest" => "asianux4",
+      "asianux4_64Guest" => "asianux4-64",
+      "other24xLinuxGuest" => "other24xlinux",
+      "other26xLinuxGuest" => "other26xlinux",
+      "otherLinuxGuest" => "otherlinux",
+      "other24xLinux64Guest" => "other24xlinux-64",
+      "other26xLinux64Guest" => "other26xlinux-64",
+      "otherLinux64Guest" => "otherlinux-64",
+      "solaris6Guest" => "",
+      "solaris7Guest" => "",
+      "solaris8Guest" => "solaris8",
+      "solaris9Guest" => "solaris9",
+      "solaris10Guest" => "solaris10",
+      "solaris10_64Guest" => "solaris10-64",
+      "solaris11_64Guest" => "solaris11-64",
+      "os2Guest" => "os2",
+      "eComStationGuest" => "ecomstation",
+      "eComStation2Guest" => "ecomstation2",
+      "netware4Guest" => "",
+      "netware5Guest" => "netware5",
+      "netware6Guest" => "netware6",
+      "openServer5Guest" => "",
+      "openServer6Guest" => "",
+      "unixWare7Guest" => "",
+      "darwinGuest" => "darwin",
+      "darwin64Guest" => "darwin-64",
+      "darwin10Guest" => "darwin10",
+      "darwin10_64Guest" => "darwin10-64",
+      "darwin11Guest" => "darwin11",
+      "darwin11_64Guest" => "darwin11-64",
+      "vmkernelGuest" => "vmkernel",
+      "vmkernel5Guest" => "vmkernel5",
+      "otherGuest" => "other",
+      "otherGuest64" => "other-64",
+    }
+
+    guest_id_map.each do |api_value, vmx_value|
+      if vmx_value.empty?
+        it "should convert #{api_value} to vmx guestOS value"
+      else
+        it "should convert #{api_value} to #{vmx_value}" do
+          subject.send(:convert_guest_id_for_vmdk, api_value).should == vmx_value
+        end
+      end
+    end
+    
+  end
+end

data/templates/vmx_template.erb

@@ -11,7 +11,7 @@ scsi0.virtualDev = "lsilogic"
 scsi0:0.present = "true"
 scsi0:0.fileName = "<%= spec[:disk_file].split("/").last %>"
 scsi0:0.deviceType = "scsi-hardDisk"
-guestOS = <%= spec[:guest_id] %>
+guestOS = "<%= spec[:guest_id] %>"
 floppy0.present = "FALSE"
 <% spec[:nics].each_with_index do |nic,index| %>
 ethernet<%= index %>.present = "true"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esx
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-08 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -253,9 +253,11 @@ files:
 - README.md
 - Rakefile
 - bin/esx
+- esx.gemspec
 - examples/basics.rb
 - lib/esx.rb
 - spec/spec_helper.rb
+- spec/unit/helper_spec.rb
 - spec/unit/host_spec.rb
 - spec/unit/vm_spec.rb
 - templates/vmx_template.erb
@@ -280,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Simple RbVmomi wrapper library to manage VMWare ESX hosts