esx 0.3.2 → 0.4.1

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# 0.4.1 - 2012/03/26
+
+* Minor fixes
+
+# 0.4 - 2012/03/25 
+
+* Do not include test data inside the gem.
+
+* Define a Logger object
+
+    ESX::Log.info "foobar"
+
+* Added some debugging with Log.debug
+
+* ESX::Host now has a *templates_dir* attribute and supports uploading and cloning templates:
+
+    host = ESX::Host.connect 'my-esx-host', 
+                             'root', 
+                             'password'
+
+    host.import_template "/path/to/template.vmdk"
+
+This will copy the "template.vmdk" file to the default templates_dir in ESX. Default templates dir is "/vmfs/volumes/datastore1/esx-gem/templates".
+
+The template is automatically converted to VMDK thin format.
+  
+Using the template:
+
+    host.copy_from_template "template.vmdk", "/vmfs/volumes/datastore1/foo.vmdk"
+
+Sorter version:
+
+    host.import_disk "/path/to/local/template.vmdk",      # local file 
+                     "/vmfs/volumes/datastore1/foo.vmdk", # remote path in ESX
+                     { :use_template => true }
+
+If the template "template.vmdk" is found, use that. Otherwise import the disk, save it as a template and clone the template to "/vmfs/volumes/datastore1/foo.vmdk"
+
+* Added the following methods to ESX::Host
+
+    * ESX::Host.has_template? 
+    * ESX::Host.list_templates 
+    * ESX::Host.delete_template
+
+* Better test coverage

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.add_runtime_dependency 'net-ssh'
   gem.add_runtime_dependency 'net-scp'
   gem.add_runtime_dependency 'clamp'
+  gem.files.exclude 'spec/data/*'
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new

data/lib/esx.rb

@@ -6,16 +6,28 @@ require 'net/ssh'
 
 module ESX
 
-  VERSION = '0.3.2'
+  VERSION = '0.4.1'
+  
+  if !defined? Log or Log.nil?
+    Log = Logger.new($stdout)
+    Log.formatter = proc do |severity, datetime, progname, msg|
+        "[ESX] #{severity}: #{msg}\n"
+    end
+    Log.level = Logger::INFO unless (ENV["DEBUG"].eql? "yes" or \
+                                     ENV["DEBUG"].eql? "true")
+    Log.debug "Initializing logger"
+  end
 
   class Host
 
     attr_reader :address, :user, :password
+    attr_accessor :templates_dir
 
-    def initialize(address, user, password)
+    def initialize(address, user, password, opts = {})
       @address = address
       @password = password
       @user = user
+      @templates_dir = opts[:templates_dir] || "/vmfs/volumes/datastore1/esx-gem/templates"
     end
 
     # Connect to a ESX host
@@ -216,46 +228,144 @@ module ESX
     # Run a command in the ESX host via SSH
     #
     def remote_command(cmd)
+      output = ""
       Net::SSH.start(@address, @user, :password => @password) do |ssh|
-        ssh.exec! cmd
+        output = ssh.exec! cmd
       end
+      output
     end
 
     #
     # Upload file
     #
-    def upload_file(source, dest, print_progress = true)
+    def upload_file(source, dest, print_progress = false)
       Net::SSH.start(@address, @user, :password => @password) do |ssh|
-        puts "Uploading file... (#{File.basename(source)})"
+        Log.info "Uploading file #{File.basename(source)}..." if print_progress
         ssh.scp.upload!(source, dest) do |ch, name, sent, total|
           if print_progress
             print "\rProgress: #{(sent.to_f * 100 / total.to_f).to_i}% completed"
           end
         end
       end
-      puts if print_progress
     end
 
-    def import_disk(source, destination, print_progress = true)
+    def template_exist?(vmdk_file)
+      template_file = File.join(@templates_dir, File.basename(vmdk_file))
+      Log.debug "Checking if template #{template_file} exists"
+      Net::SSH.start(@address, @user, :password => @password) do |ssh|
+        return false if (ssh.exec! "ls -la #{@templates_dir} 2>/dev/null").nil?
+        return false if (ssh.exec! "ls #{template_file} 2>/dev/null").nil?
+      end
+      Log.debug "Template #{template_file} found"
+      true
+    end
+    alias :has_template? :template_exist?
+
+    def list_templates
+      templates = []
+      Net::SSH.start(@address, @user, :password => @password) do |ssh|
+        output = (ssh.exec! "ls -l #{@templates_dir}/*-flat.vmdk 2>/dev/null")
+        output.each_line do |t|
+          templates << t.gsub(/-flat\.vmdk/,".vmdk").split().last.strip.chomp rescue next
+        end unless output.nil?
+      end
+      templates
+    end
+
+    #
+    # Expects fooimg.vmdk
+    # Trims path if /path/to/fooimg.vmdk
+    #
+    def delete_template(template_disk)
+      Log.debug "deleting template #{template_disk}"
+      template = File.join(@templates_dir, File.basename(template_disk))
+      template_flat = File.join(@templates_dir, File.basename(template_disk, ".vmdk") + "-flat.vmdk")
+      Net::SSH.start(@address, @user, :password => @password) do |ssh|
+        if (ssh.exec! "ls #{template} 2>/dev/null").nil?
+          Log.error "Template #{template_disk} does not exist"
+          raise "Template does not exist" 
+        end 
+        ssh.exec!("rm -f #{template} && rm -f #{template_flat} 2>&1")
+      end
+    end
+
+    def import_template(source, params = {})
+      print_progress = params[:print_progress] || false
+      dest_file = File.join(@templates_dir, File.basename(source))
+      Log.debug "Importing template #{source} to #{dest_file}"
+      return dest_file if template_exist?(dest_file)
+      Net::SSH.start(@address, @user, :password => @password) do |ssh|
+        if (ssh.exec! "ls -la #{@templates_dir} 2>/dev/null").nil?
+          # Create template dir 
+          Log.debug "Creating templates dir #{@templates_dir}"
+          ssh.exec "mkdir -p #{@templates_dir}"
+        end
+      end
+      import_disk_convert(source, dest_file, print_progress)
+    end
+
+    #
+    # Expects vmdk source file path and destination path
+    #
+    # copy_from_template "/home/fooser/my.vmdk", "/vmfs/volumes/datastore1/foovm/foovm.vmdk"
+    #
+    # Destination directory must exist otherwise rises exception
+    #
+    def copy_from_template(template_disk, destination)
+      Log.debug "Copying from template #{template_disk} to #{destination}"
+      raise "Template does not exist" if not template_exist?(template_disk)
+      source = File.join(@templates_dir, File.basename(template_disk))
+      Net::SSH.start(@address, @user, :password => @password) do |ssh|
+        Log.debug "Clone disk #{source} to #{destination}"
+        Log.debug ssh.exec!("vmkfstools -i #{source} --diskformat thin #{destination} 2>&1")
+      end
+    end
+
+    #
+    # Imports a VMDK
+    #
+    # if params has :use_template => true, the disk is saved as a template in
+    # @templates_dir and cloned from there.
+    # 
+    # Destination directory must exist otherwise rises exception
+    #
+    def import_disk(source, destination, print_progress = false, params = {})
+      use_template = params[:use_template] || false
+      if use_template
+        Log.debug "import_disk :use_template => true"
+        if !template_exist?(source)
+          Log.debug "import_disk, template does not exist, importing."
+          import_template(source, { :print_progress => print_progress })
+        end
+        copy_from_template(source, destination)
+      else
+        import_disk_convert source, destination, print_progress
+      end
+    end
+
+    #
+    # This method does all the heavy lifting when importing the disk.
+    # It also converts the imported VMDK to thin format
+    #
+    def import_disk_convert(source, destination, print_progress = false)
       tmp_dest = destination + ".tmp"
       Net::SSH.start(@address, @user, :password => @password) do |ssh|
         if not (ssh.exec! "ls #{destination} 2>/dev/null").nil?
           raise Exception.new("Destination file #{destination} already exists")
         end
-        puts "Uploading file... (#{File.basename(source)})"
+        Log.info "Uploading file... (#{File.basename(source)})" if print_progress
         ssh.scp.upload!(source, tmp_dest) do |ch, name, sent, total|
           if print_progress
             print "\rProgress: #{(sent.to_f * 100 / total.to_f).to_i}%"
           end
         end
         if print_progress
-          puts "\nConverting disk..."
+          Log.info "Converting disk..."
           ssh.exec "vmkfstools -i #{tmp_dest} --diskformat thin #{destination}; rm -f #{tmp_dest}"
         else
           ssh.exec "vmkfstools -i #{tmp_dest} --diskformat thin #{destination} >/dev/null 2>&1; rm -f #{tmp_dest}"
         end
       end
-      puts
     end
     
     private
@@ -317,7 +427,9 @@ module ESX
     def self.wrap(vm)
       _vm = VM.new
       _vm.name = vm.name
-      _vm.memory_size = vm.summary.config.memorySizeMB*1024*1024
+      ## HACK: for some reason vm.summary.config.memorySizeMB returns nil
+      # under some conditions
+      _vm.memory_size = vm.summary.config.memorySizeMB*1024*1024 rescue 0
       _vm.cpus = vm.summary.config.numCpu
       _vm.ethernet_cards_number = vm.summary.config.numEthernetCards 
       _vm.virtual_disks_number = vm.summary.config.numVirtualDisks

data/spec/spec_helper.rb

@@ -13,15 +13,15 @@ require 'esx'
 module ESXTestHelpers
   
   def esx_host
-    "esx-test-host"
+    ENV["ESX_HOST"] || "esx-test-host"
   end
 
   def esx_user
-    "root"
+    ENV["ESX_USER"] || "root"
   end
 
   def esx_password
-    ""
+    ENV["ESX_PASSWORD"] || ""
   end
 
   def test_data_dir

data/spec/unit/host_spec.rb

@@ -145,4 +145,58 @@ describe "ESX host" do
     @test_host.memory_usage.should be > 0
   end
 
+  it "should have default templates path" do
+    @test_host.templates_dir.should == "/vmfs/volumes/datastore1/esx-gem/templates"
+  end
+  
+  it "should not have tc.vmdk template" do
+    @test_host.has_template?("tc.vmdk").should == false
+    @test_host.list_templates.size.should == 0
+  end
+
+  it "should not have -flat.vmdk postfix in template names" do
+    @test_host.list_templates.each do |t|
+      t.should_not match /-flat\.vmdk$/
+    end
+  end
+  
+  it "should import tc.vmdk template" do
+    @test_host.import_template File.join(test_data_dir, "tc.vmdk")
+    @test_host.has_template?("tc.vmdk").should == true
+  end
+
+  it "should copy from template" do
+    @test_host.has_template?("tc.vmdk").should == true
+    @test_host.remote_command("mkdir -p /vmfs/volumes/datastore1/foovm/")
+    @test_host.copy_from_template "tc.vmdk", "/vmfs/volumes/datastore1/foovm/foovm.vmdk"
+    @test_host.remote_command("ls /vmfs/volumes/datastore1/foovm/foovm.vmdk").strip.chomp.should == "/vmfs/volumes/datastore1/foovm/foovm.vmdk"
+    @test_host.remote_command("rm -rf /vmfs/volumes/datastore1/foovm")
+  end
+
+  it "should list one template" do
+    @test_host.list_templates.is_a?(Array).should be_true
+    @test_host.list_templates.size.should == 1
+  end
+  
+  it "should import duplicated tc.vmdk template" do
+    @test_host.import_template File.join(test_data_dir, "tc.vmdk")
+    @test_host.has_template?("tc.vmdk").should == true
+    @test_host.list_templates.size.should == 1
+  end
+
+  it "should delete tc.vmdk and tc-flat.vmdk template" do
+    @test_host.delete_template File.join(test_data_dir, "tc.vmdk")
+    @test_host.has_template?("tc.vmdk").should == false 
+    @test_host.list_templates.size.should == 0
+  end
+
+  it "should import disk tc.vmdk into desired dir" do
+    @test_host.remote_command("mkdir /vmfs/volumes/datastore1/foobar/")
+    @test_host.import_disk(File.join(test_data_dir, "tc.vmdk"), 
+                           "/vmfs/volumes/datastore1/foobar/foobar.vmdk")
+
+    @test_host.remote_command("ls /vmfs/volumes/datastore1/foobar/foobar.vmdk").strip.chomp.should == "/vmfs/volumes/datastore1/foobar/foobar.vmdk"
+    @test_host.remote_command "rm -rf /vmfs/volumes/datastore1/foobar/"
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esx
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000 Z
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13584940 !ruby/object:Gem::Requirement
+  requirement: &13782400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13584940
+  version_requirements: *13782400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &13582680 !ruby/object:Gem::Requirement
+  requirement: &13797440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *13582680
+  version_requirements: *13797440
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &13616860 !ruby/object:Gem::Requirement
+  requirement: &13795980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13616860
+  version_requirements: *13795980
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &13614040 !ruby/object:Gem::Requirement
+  requirement: &13793800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13614040
+  version_requirements: *13793800
 - !ruby/object:Gem::Dependency
   name: alchemist
-  requirement: &13611940 !ruby/object:Gem::Requirement
+  requirement: &13791580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13611940
+  version_requirements: *13791580
 - !ruby/object:Gem::Dependency
   name: rbvmomi
-  requirement: &13610820 !ruby/object:Gem::Requirement
+  requirement: &13790180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13610820
+  version_requirements: *13790180
 - !ruby/object:Gem::Dependency
   name: terminal-table
-  requirement: &13710140 !ruby/object:Gem::Requirement
+  requirement: &13805300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13710140
+  version_requirements: *13805300
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &13708680 !ruby/object:Gem::Requirement
+  requirement: &13803800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13708680
+  version_requirements: *13803800
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &13707760 !ruby/object:Gem::Requirement
+  requirement: &13802480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13707760
+  version_requirements: *13802480
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &13707000 !ruby/object:Gem::Requirement
+  requirement: &13800940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13707000
+  version_requirements: *13800940
 description: Manage VMWare ESX hosts with ease
 email: rubiojr@frameos.org
 executables:
@@ -131,6 +131,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .document
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -138,7 +139,6 @@ 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
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Simple RbVmomi wrapper library to manage VMWare ESX hosts