lab 0.1.5 → 0.2.0

data/src/lib/lab/vm_controller.rb

@@ -0,0 +1,275 @@
+#
+# $Id$
+#
+# This is the main lab controller. Require this controller to get all 
+# lab functionality. 
+#
+#
+
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'driver')))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'controller')))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'modifier')))
+
+require 'find'
+require 'yaml'
+require 'enumerator'
+require 'fileutils'
+
+require 'vm'
+require 'controllers'
+require 'drivers'
+require 'modifiers'
+
+require 'net/scp'
+require 'net/ssh'
+
+module Lab
+module Controllers
+  class VmController 
+
+    include Enumerable
+    include Lab::Controllers::WorkstationController
+    include Lab::Controllers::RemoteWorkstationController
+    include Lab::Controllers::VirtualBoxController 
+    include Lab::Controllers::FogController
+    include Lab::Controllers::DynagenController 
+    include Lab::Controllers::RemoteEsxiController
+    include Lab::Controllers::VsphereController
+    #include Lab::Controllers::QemuController 
+    #include Lab::Controllers::QemudoController 
+    def initialize (labdef=nil)
+
+      # Start with an empty array of vm objects
+      @vms = [] 
+
+      # labdef is a just a big array of hashes
+      load_vms(labdef) if labdef
+    end
+    
+    def clear!
+      @vms = []
+    end
+
+    def [](x)
+      # Support indexing by both names and number
+      if x.class == String
+        find_by_vmid(x)
+      else
+        return @vms[x]
+      end
+    end
+
+    def find_by_vmid(search)
+      @vms.each do |vm|
+        return vm if vm.hostname.to_s.downcase == search.to_s.downcase
+      end
+      return nil
+    end
+
+    def find_by_tag(search)
+      @vms.each do |vm|
+        vm.tags.each do |tag| 
+          return vm if tag.downcase == search.to_s.downcase
+        end
+      end
+      return nil
+    end
+
+    def add_vm(vmid, location=nil, os=nil, tools=nil, credentials=nil, user=nil, host=nil)
+      @vms << Vm.new( {
+        'vmid' => vmid, 
+        'driver' => type, 
+        'location' => location, 
+        'credentials' => credentials,
+        'user' => user,
+        'host' => host
+        })
+    end
+
+    def remove_by_vmid(vmid)
+      @vms.delete(self.find_by_vmid(vmid))
+    end  
+
+    def from_file(file)
+      load_vms(YAML::load_file(file))
+    end
+
+    def load_vms(vms)
+      vms.each do |item|
+        vm = Vm.new(item)
+        @vms << vm unless includes_vmid? vm.vmid
+      end
+    end
+
+    def to_file(file)
+      File.open(file, 'w') { |f| @vms.each { |vm| f.puts vm.to_yaml } } 
+    end
+
+    def each &block
+      @vms.each { |vm| yield vm }
+    end
+
+    def includes?(specified_vm)
+      @vms.each { |vm| if (vm == specified_vm) then return true end  }
+    end
+
+    def includes_vmid?(vmid)
+      @vms.each do |vm|
+        return true if (vm.vmid == vmid)
+      end
+    false
+    end
+
+    #
+    # Build a vm lab from a directory of files. Really only useful for file-based
+    # vm hosts. (vmware workstation)
+    #
+    def build_from_dir(driver_type, dir, clear=false)
+
+      if clear
+        @vms = []
+      end
+
+      if driver_type.downcase == "workstation"
+        vm_list = ::Lab::Controllers::WorkstationController::dir_list(dir)
+      elsif driver_type.downcase == "remote_workstation"  
+        vm_list = ::Lab::Controllers::RemoteWorkstationController::dir_list(dir)
+      elsif driver_type.downcase == "virtualbox"  
+        vm_list = ::Lab::Controllers::VirtualBoxController::dir_list(dir)
+      elsif driver_type.downcase == "fog"
+        vm_list = ::Lab::Controllers::FogController::dir_list(dir)
+      elsif driver_type.downcase == "Dynagen"  
+        vm_list = ::Lab::Controllers::DynagenController::dir_list(dir)
+      elsif driver_type.downcase == "remote_esxi"
+        vm_list =::Lab::Controllers::RemoteEsxiController::dir_list(dir)
+      elsif driver_type.downcase == "vsphere"
+        vm_list =::Lab::Controllers::VsphereController::dir_list(dir)
+      else
+        raise TypeError, "Unsupported VM Type"
+      end
+      
+      vm_list.each_index do |index|
+        @vms << Vm.new( {'vmid' => "vm_#{index}", 'driver' => driver_type, 'location' => vm_list[index]} )
+      end
+    end
+
+
+    #
+    # Builds a vm lab from all running vms. Handy for connecting and saving out 
+    # a config or just managing the currently running vms
+    #
+    def build_from_running(driver_type=nil, user=nil, host=nil, clear=false, pass=nil)
+    
+      if clear
+        @vms = []
+      end
+
+      case driver_type.intern
+        when :workstation
+          vm_list = ::Lab::Controllers::WorkstationController::running_list
+          vm_list.each do |item|
+            # Name the VM
+            index = @vms.count + 1
+            # Add it to the vm list
+            @vms << Vm.new({
+              'vmid' => "vm_#{index}",
+              'driver' => driver_type, 
+              'location' => item
+              })
+          end
+        when :remote_workstation
+          vm_list = ::Lab::Controllers::RemoteWorkstationController::running_list(user, host)
+          vm_list.each do |item|
+            # Name the VM
+            index = @vms.count + 1
+            # Add it to the VM list
+            @vms << Vm.new({
+              'vmid' => "vm_#{index}",
+              'driver' => driver_type, 
+              'location' => item, 
+              'user' => user,
+              'host' => host 
+              })
+          end
+        when :virtualbox
+          vm_list = ::Lab::Controllers::VirtualBoxController::running_list
+          vm_list.each do |item|
+            # Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "#{item}",
+              'driver' => driver_type,
+              'location' => nil 
+              })
+          end
+        when :fog
+          raise "Unsupported"
+        when :dynagen
+          raise "Unsupported"
+        when :remote_esxi
+          vm_list = ::Lab::Controllers::RemoteEsxiController::running_list(user,host)
+          vm_list.each do |item|
+            @vms << Vm.new( {  
+              'vmid' => "#{item[:id]}",
+              'name' => "#{item[:name]}",
+              'driver' => driver_type, 
+              'user' => user,
+              'host' => host 
+              })
+          end
+        when :vsphere
+          vm_list = ::Lab::Controllers::VsphereController::running_list(user,host,pass)
+          vm_list.each do |item|
+            @vms << Vm.new( {  
+              'vmid' => "#{item[:id]}",
+              'name' => "#{item[:name]}",
+              'driver' => driver_type, 
+              'user' => user,
+              'host' => host,
+              'pass' => pass
+              })
+          end
+        else
+          raise TypeError, "Unsupported VM Type"
+        end
+
+    end  
+
+    #
+    # Applicable only to virtualbox. Reads the config file & parses / creates
+    # VM objects for each vm.
+    #
+    def build_from_config(driver_type=nil, user=nil, host=nil, clear=false)
+      if clear
+        @vms = []
+      end
+
+      case driver_type.intern
+        when :virtualbox
+          vm_list = ::Lab::Controllers::VirtualBoxController::config_list
+          
+          vm_list.each do |item|
+            # Add it to the vm list
+            @vms << Vm.new( {  
+              'vmid' => "#{item}",
+              'driver' => driver_type, 
+              'location' => nil, 
+              'user' => user,
+              'host' => host } )
+          end
+            
+        else
+          raise TypeError, "Unsupported VM Type"
+        end
+
+    end  
+
+    def running?(vmid)
+      if includes_vmid?(vmid)
+        return self.find_by_vmid(vmid).running?
+      end
+      return false 
+    end
+  end
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &20127300 !ruby/object:Gem::Requirement
+  requirement: &14248700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20127300
+  version_requirements: *14248700
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &20126880 !ruby/object:Gem::Requirement
+  requirement: &14247980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20126880
+  version_requirements: *14247980
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &20126460 !ruby/object:Gem::Requirement
+  requirement: &14229460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20126460
+  version_requirements: *14229460
 - !ruby/object:Gem::Dependency
   name: rbvmomi
-  requirement: &20126040 !ruby/object:Gem::Requirement
+  requirement: &14228480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20126040
+  version_requirements: *14228480
 description: ! 'Start/Stop/Revert and do other cool stuff w/ Vmware, Virtualbox, and
   ESXi vms. This gem wraps common CLI utilities and other gems to create a common
   inteface for vms. '
@@ -64,16 +64,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - TODO
+- config/test_lab.yml
+- config/test_targets.yml
 - lab.gemspec
 - lib/lab.rb
 - lib/lab/controller/dynagen_controller.rb
 - lib/lab/controller/fog_controller.rb
 - lib/lab/controller/remote_esx_controller.rb
+- lib/lab/controller/remote_esxi_controller.rb
 - lib/lab/controller/remote_workstation_controller.rb
 - lib/lab/controller/virtualbox_controller.rb
 - lib/lab/controller/workstation_controller.rb
@@ -81,7 +85,7 @@ files:
 - lib/lab/controllers.rb
 - lib/lab/driver/dynagen_driver.rb
 - lib/lab/driver/fog_driver.rb
-- lib/lab/driver/remote_esx_driver.rb
+- lib/lab/driver/remote_esxi_driver.rb
 - lib/lab/driver/remote_workstation_driver.rb
 - lib/lab/driver/virtualbox_driver.rb
 - lib/lab/driver/vm_driver.rb
@@ -95,6 +99,41 @@ files:
 - lib/lab/version.rb
 - lib/lab/vm.rb
 - lib/lab/vm_controller.rb
+- src/Gemfile
+- src/README.md
+- src/Rakefile
+- src/TODO
+- src/config/test_lab.yml
+- src/config/test_targets.yml
+- src/lab.gemspec
+- src/lib/lab.rb
+- src/lib/lab/controller/dynagen_controller.rb
+- src/lib/lab/controller/fog_controller.rb
+- src/lib/lab/controller/remote_esxi_controller.rb
+- src/lib/lab/controller/remote_workstation_controller.rb
+- src/lib/lab/controller/virtualbox_controller.rb
+- src/lib/lab/controller/vsphere_controller.rb
+- src/lib/lab/controller/workstation_controller.rb
+- src/lib/lab/controller/workstation_vixr_controller.rb
+- src/lib/lab/controllers.rb
+- src/lib/lab/driver/dynagen_driver.rb
+- src/lib/lab/driver/fog_driver.rb
+- src/lib/lab/driver/remote_esxi_driver.rb
+- src/lib/lab/driver/remote_workstation_driver.rb
+- src/lib/lab/driver/virtualbox_driver.rb
+- src/lib/lab/driver/vm_driver.rb
+- src/lib/lab/driver/vsphere_driver.rb
+- src/lib/lab/driver/workstation_driver.rb
+- src/lib/lab/driver/workstation_vixr_driver.rb
+- src/lib/lab/drivers.rb
+- src/lib/lab/modifier/backtrack5_modifier.rb
+- src/lib/lab/modifier/dos_modifier.rb
+- src/lib/lab/modifier/test_modifier.rb
+- src/lib/lab/modifiers.rb
+- src/lib/lab/version.rb
+- src/lib/lab/vm.rb
+- src/lib/lab/vm_controller.rb
+- src/test/.gitkeep
 - test/.gitkeep
 homepage: http://www.github.com/rapid7/lab/wiki
 licenses: []
@@ -116,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: lab
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Manage VMs like a boss

data/lib/lab/driver/remote_esx_driver.rb

@@ -1,177 +0,0 @@
-require 'vm_driver'
-
-##
-## $Id$
-##
-
-# This driver was built against: 
-# VMware ESX Host Agent 4.1.0 build-348481
-
-module Lab
-module Drivers
-
-class RemoteEsxDriver < VmDriver
-
-	def initialize(config)
-		unless config['user'] then raise ArgumentError, "Must provide a username" end
-		unless config['host'] then raise ArgumentError, "Must provide a hostname" end
-
-		super(config)
-		
-		@user = filter_command(config['user'])
-		@host = filter_command(config['host'])
-		@port = config['port']		
-	end
-
-	def start
-		remote_system_command("vim-cmd vmsvc/power.on #{@vmid}")
-	end
-
-	def stop
-		remote_system_command("vim-cmd vmsvc/power.off #{@vmid}")
-	end
-
-	def suspend
-		remote_system_command("vim-cmd vmsvc/power.suspend #{@vmid}")
-	end
-
-	def pause
-		remote_system_command("vim-cmd vmsvc/power.suspend #{@vmid}")
-	end
-
-	def resume
-		remote_system_command("vim-cmd vmsvc/power.suspendResume #{@vmid}")
-	end
-
-	def reset
-		remote_system_command("vim-cmd vmsvc/power.reset #{@vmid}")
-	end
-
-	def create_snapshot(snapshot)
-		snapshot = filter_input(snapshot)
-		
-		remote_system_command("vim-cmd vmsvc/snapshot.create #{@vmid} #{snapshot} \'lab created snapshot\' 1 true")
-	end
-
-	def revert_snapshot(snapshot)
-
-		snapshots = get_snapshots
-		
-		# Look through our snapshot list, choose the right one based on display_name		
-		snapshots.each do |snapshot_obj|
-		
-			#puts "DEBUG: checking #{snapshot_obj}"
-		
-			if snapshot_obj[:display_name].downcase == snapshot.downcase
-				snapshot_identifier = snapshot_obj[:name].join(" ")
-				
-				#puts "DEBUG: I would revert to #{snapshot_obj}"
-				remote_system_command("vim-cmd vmsvc/snapshot.revert #{@vmid} 0 #{snapshot_identifier}")
-				return true
-			end
-		end
-	
-		# If we got here, the snapshot didn't exist
-		raise "Invalid Snapshot Name"
-	end
-
-	def delete_snapshot(snapshot, remove_children=false)
-		snapshots = get_snapshots
-		
-		# Look through our snapshot list, choose the right one based on display_name		
-		snapshots.each do |snapshot_obj|
-		
-			#puts "DEBUG: checking #{snapshot_obj}"
-		
-			if snapshot_obj[:display_name].downcase == snapshot.downcase
-				snapshot_identifier = snapshot_obj[:name].join(" ")
-				remote_system_command("vim-cmd vmsvc/snapshot.remove #{@vmid} #{remove_children} #{snapshot_identifier}")
-				return true
-			end
-		end
-	
-		# If we got here, the snapshot didn't exist
-		raise "Invalid Snapshot Name"
-	end
-	
-	def delete_all_snapshots
-		remote_system_command("vim-cmd vmsvc/snapshot.removeall #{@vmid}")
-	end
-		
-	def run_command(command)
-		raise "Not Implemented"
-	end
-	
-	def copy_from(from, to)
-		if @os == "linux"
-			scp_from(from, to)
-		else
-			raise "Unimplemented"
-		end
-	end
-
-	def copy_to(from, to)
-		if @os == "linux"
-			scp_to(from, to)
-		else
-			raise "Unimplemented"
-		end
-	end
-
-	def check_file_exists(file)
-		raise "Not Implemented"
-	end
-
-	def create_directory(directory)
-		raise "Not Implemented"
-	end
-
-	def cleanup
-
-	end
-
-	def running?
-		power_status_string = `ssh #{@user}@#{@host} \"vim-cmd vmsvc/power.getstate #{@vmid}\"`
-		return true if power_status_string =~ /Powered on/
-	false
-	end 
-
-	def get_snapshots
-		# Command take the format: 
-		# vmware-vim-cmd vmsvc/snapshot.revert [vmid: int] [snapshotlevel: int] [snapshotindex: int]
-		output = `ssh #{@user}@#{@host} \"vim-cmd vmsvc/snapshot.get #{@vmid}\"`
-
-		# this keeps track of the snapshots, takes the form:
-		#[ {:name => [0,0], :display_name => "String containing the snapshotname}, 
-		#  {:name => [0,1], :display_name => "String containing the snapshotname}, ]
-		#  ... 
-		snapshots = []
-		
-		# Use these to keep track of the parsing...		
-		current_tree = -1
-		current_num = 0
-		count = 0
-		
-		# Do the parsing & stick the snapshots in the snapshots array
-		output_lines = output.split("\n")
-		output_lines.each do |line|
-			if line.include?("|") # this is a new snapshot
-				if line.include?("ROOT") # it's a root
-					current_num = 0
-					current_tree = current_tree + 1 # new tree
-					snapshots << { :name => [current_num, current_tree], :display_name => output_lines[count+1].split(":").last.strip }
-				else
-					current_num = current_num + 1 # new snapshot in current tree
-					snapshots << { :name => [current_num, current_tree], :display_name => output_lines[count+1].split(":").last.strip }
-				end
-			end
-			count = count+1
-		end
-
-	snapshots
-	end
-
-end
-
-end 
-end