updated lab backend

git-svn-id: file:///home/svn/framework3/trunk@9931 4d416f70-5f16-0410-b530-b9f4589650da
unstable
Jonathan Cran 2010-07-26 15:24:05 +00:00
parent 2448f6b1a8
commit 5fd9b689e7
3 changed files with 522 additions and 470 deletions

373
lib/lab/lab_controller.rb Normal file
View File

@ -0,0 +1,373 @@
require 'find'
require 'yaml'
require 'vmware_controller'
require 'qemu_controller'
require 'ec2_controller'
#
# ~Higher-level lab methods which are generic to the types of things we want to do with a lab of machines
# Note that any generic vm functionality should be pushed down into the controller class.
class LabController
attr_accessor :labdef
attr_accessor :labbase
attr_accessor :controller
def initialize (labdef = nil, labbase = nil, labtype="vmware")
if !labbase
@labbase = "/opt/vm/" ## set the base directory for the lab (default to local)
else
@labbase = labbase
end
if !labdef
## assign the default lab definition if we were not passed one
@labdef = YAML::load_file(File.join(File.dirname(__FILE__), "..", "..", "data", "lab", "test_lab.yml" ))
else
@labdef = labdef
end
## handle yaml nils :/. turn them into blank strings.
@labdef.each do |key,value|
@labdef[key].each do |subkey,subvalue|
if !subvalue
@labdef[key][subkey] = ""
end
end
end
## set up the controller. note that this is likely to change in the future (to provide for additional vm libs)
if labtype == "vmware"
@controller = VmwareController.new
@file_extension = "vmx"
elsif labtype == "qemu"
@controller = QemuController.new
@file_extension = "img"
elsif labtype == "ec2"
@controller = Ec2Controller.new
else
raise "Invalid Lab Controller"
end
end
def contains?(vmid)
if get_full_path(vmid)
true
end
end
##TODO - these methods need some thought
def build_lab_from_running(basepath=nil)
@vmbase = basepath if basepath
vm_array = self.get_running.split("\n") ## this should probably return an array
vm_array.shift
hlp_stuff_array_info_lab(vm_array)
end
def build_lab_from_files(basepath=nil)
@vmbase = basepath if basepath
vm_array = Find.find(@vmbase).select { |f|
f =~ /\.#{file_extension}$/ && File.executable?(f)
}
hlp_stuff_array_into_lab(vm_array)
end
def hlp_stuff_array_into_lab(arr)
return false unless arr.kind_of? Array
arr.each_with_index {|v,i|
@labdef[i] = File.join(v.split(/[\x5c\x2f]+/))
if @labdef[i] =~ /^#{@vmbase}(.*)/
@labdef[i] = $1
end
}
return @labdef
end
## TODO ^^
def run_command_on_lab_vm(vmid,command,arguments=nil)
begin
if @labdef[vmid]["tools"]
@controller.run_command(get_full_path(vmid), command, @labdef[vmid]["user"],@labdef[vmid]["pass"])
else
if @labdef[vmid]["os"] == "linux"
@controller.run_ssh_command(@labdef[vmid]["hostname"], command , @labdef[vmid]["user"])
else
raise Exception "OS Not Supported"
end
end
rescue Exception => e
print_error "error! " + e.to_s
end
end
def run_browser_on_lab_vm(vmid,uri)
if @labdef[vmid]["os"] == "linux"
command = "firefox " + uri
elsif @labdef[vmid]['os'] == "windows"
command = "C:\\Progra~1\\intern~1\\iexplore.exe " + uri
else
print_error "Don't know how to browse to '" + uri + "'."
end
run_command_on_lab_vm(vmid,command)
end
def start_lab_vm(vmid)
if running?(vmid)
self.list_lab_running
else
begin
@controller.start(get_full_path(vmid))
rescue Exception => e
print_error "error! " + e.to_s
end
end
end
def reset_lab_vm(vmid)
begin
@controller.reset(get_full_path(vmid))
rescue Exception => e
return "error! " + e.to_s
end
end
def pause_lab_vm(vmid)
if !running?(vmid)
self.list_lab_running
else
begin
@controller.pause(get_full_path(vmid))
rescue Exception => e
return "error! " + e.to_s
end
end
end
def suspend_lab_vm(vmid)
if !running?(vmid)
self.list_lab_running
else
begin
@controller.suspend(get_full_path(vmid))
rescue Exception => e
return "error! " + e.inspect
end
end
end
def snapshot_lab_vm(vmid, snapshot)
if !running?(vmid)
self.list_lab_running
else
begin
@controller.create_snapshot(get_full_path(vmid),snapshot)
rescue Exception => e
return "error! " + e.to_s
end
end
end
def revert_lab_vm(vmid, snapshot)
if !running?(vmid)
self.list_lab_running
else
begin
@controller.revert_snapshot(get_full_path(vmid),snapshot)
rescue Exception => e
print_error "error! " + e.to_s
end
end
end
def stop_lab_vm(vmid)
if !running?(vmid)
self.list_lab_running
else
begin
@controller.stop(get_full_path(vmid))
rescue Exception => e
print_error "error! " + e.to_s
end
end
end
def start_lab
@labdef.each { | key, value |
if value
self.start_lab_vm(key)
end
}
end
def pause_lab
@labdef.each { | key, value |
if value
self.pause_lab_vm(key)
end
}
end
def stop_lab
@labdef.each { | key, value |
if value
self.stop_lab_vm(key)
end
}
end
def reset_lab
@labdef.each { | key, value |
if value
self.reset_lab_vm(key)
end
}
end
def suspend_lab
@labdef.each { | key, value |
if value
self.suspend_lab_vm(key)
end
}
end
def snapshot_lab(snapshot)
@labdef.each { | key, value |
if value
self.snapshot_lab_vm(key,snapshot)
end
}
end
def revert_lab(snapshot)
@labdef.each { | key, value |
if value
self.revert_lab_vm(key,snapshot)
end
}
end
def run_command_on_lab(command)
@labdef.each { | key, value |
if value
self.run_command_on_lab_vm(key, command)
end
}
end
def copy_to_lab(file)
@labdef.each { | key, value |
if value
self.copy_to_lab_vm(key,file)
end
}
end
def copy_from_lab(file)
@labdef.each { | key, value |
next unless line =~ /^#{@vmbase}(.*)/
if value
self.copy_from_lab_vm(key,file)
end
}
end
def copy_to_lab_vm(vmid,file)
## handle linux
guestpath = ""
if (@labdef[vmid]["os"] == "linux")
guestpath = "/tmp/"
else
guestpath = "C:\\temp_msf\\\\" ## double-escaping because it's being used in a system command.
end
name = File.basename(file)
## if we've installed vm-tools on the box, use that to copy. if not, use scp
if (@labdef[vmid]["tools"] == "true")
puts "DEBUG: creating directory: " + guestpath
@controller.create_directory_in_guest(get_full_path(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"], guestpath)
begin
puts "DEBUG: copying file: " + file + " into " + guestpath + name
@controller.copy_file_to(get_full_path(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"],file, guestpath + name)
rescue Exception => e
print_error "error! " + e.to_s
end
else
puts "DEBUG: scp copying file: " + file + " into " + guestpath + name
@controller.scp_copy_file_to(@labdef[vmid]["hostname"], @labdef[vmid]["user"], file, guestpath + name)
end
end
def copy_from_lab_vm(vmid,file)
hostpath = "/tmp/"
name = File.basename(file.gsub("\\","/"))
begin
@controller.copy_file_from(get_full_path(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"],file,hostpath + name)
rescue Exception => e
print_error "error! " + e.to_s
end
end
def list_lab_running
@controller.get_running
end
def list_lab
str = ""
@labdef.sort.each { |key,val|
if val != nil
str = str + key.to_s + ": " + val["file"].to_s + "\n"
end
}
return str
end
def find_lab_vm(search)
str = ""
@labdef.sort.each { |key,val|
if val != nil
if (val["file"].to_s.downcase.index(search.downcase) != nil)
str = str + key.to_s + ": " + val["file"].to_s + "\n"
end
end
}
return str
end
def exists?(vmid)
if get_full_path(vmid)
return true
end
return false
end
def running?(vmid)
if @controller.running?(get_full_path(vmid))
return true
end
return false
end
def get_full_path(vmid)
if @labdef[vmid]
@labbase.to_s + @labdef[vmid]["file"].to_s ## handle linux
else
nil
end
end
end

View File

@ -0,0 +1,149 @@
#$Id$
#
# Lower level methods which are ~generic to vm software
#
## VmwareController Wraps vmrun and gives us basic vm functionality
class VmwareController
def initialize
end
def start(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws start " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def stop(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws stop " + "\"" + vmx + "\"")
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def suspend(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws suspend " + "\"" + vmx + "\"")
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def pause(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws pause " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def reset(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws reset " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def run_command(vmx, command, user, pass, displayParameter=false)
if File.exist?(vmx)
vmrunstr = "vmrun -T ws -gu \"" + user + "\" -gp \"" + pass + "\" runProgramInGuest \"" + vmx + "\" " + "\"" + command + "\" -noWait -activeWindow"
if displayParameter
vmrunstr = vmrunstr + " -display :0"
end
system_command(vmrunstr)
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def run_ssh_command(hostname, command, user)
ssh_command = "ssh " + user + "@" + hostname + " " + command
system_command(ssh_command)
end
def copy_file_from(vmx, user, pass, guestpath, hostpath)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " copyFileFromGuestToHost \"" + vmx + "\" \"" + guestpath + "\" \"" + hostpath + "\""
system_command(vmrunstr)
end
def scp_copy_file_from(hostname, user, guestpath, hostpath)
vmrunstr = "scp -r \"" + user + "@" + hostname + ":" + guestpath + "\" \"" + hostpath + "\"" ## TODO - setup keys
system_command(vmrunstr)
end
def copy_file_to(vmx, user, pass, hostpath, guestpath)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " copyFileFromHostToGuest \"" + vmx + "\" \"" + hostpath + "\" \"" + guestpath + "\""
system_command(vmrunstr)
end
def scp_copy_file_to(hostname, user, hostpath, guestpath)
vmrunstr = "scp -r \"" + hostpath + "\" \"" + user + "@" + hostname + ":" + guestpath + "\"" ## TODO - setup keys
system_command(vmrunstr)
end
def check_file_exists(vmx, user, pass, file)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " fileExistsInGuest \"" + vmx + "\" \"" + file + "\" "
system_command(vmrunstr)
end
def create_directory_in_guest(vmx, user, pass, directory)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " createDirectoryInGuest \"" + vmx + "\" \"" + directory + "\" "
system_command(vmrunstr)
end
def create_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws snapshot " + "\"" + vmx + "\" " + snapshot)
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def revert_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws revertToSnapshot " + "\"" + vmx + "\" " + snapshot)
else
raise "Couldn't find: " + vmx, caller
end
end
def delete_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws deleteSnapshot " + "\"" + vmx + "\" " + snapshot )
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def get_running
output = `vmrun list` ##hackity hack=begin
return output
end
def running?(vmx)
output = self.get_running
output.each_line do |line|
if line.strip == vmx.strip
return true
end
end
return false
end
private
def system_command(command)
puts "DEBUG: " + command
system(command)
end
end

View File

@ -1,470 +0,0 @@
#$Id$
require 'find'
#
# Lower level methods which are ~generic to the vm software
#
## Crap class which wraps vmrun and gives us basic vm functionality
class VmwareController
def initialize
puts "vmware server / workstations yo"
end
def start(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws start " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def stop(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws stop " + "\"" + vmx + "\"")
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def suspend(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws suspend " + "\"" + vmx + "\"")
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def pause(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws pause " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def reset(vmx)
if File.exist?(vmx)
system_command("vmrun -T ws reset " + "\"" + vmx + "\"")
else
raise ArgumentError, "Couldn't find: " + vmx, caller
end
end
def run_command(vmx, command, user, pass, displayParameter=false)
if File.exist?(vmx)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " runProgramInGuest \"" + vmx + "\" " + "\"" + command + "\" -interactive -noWait -activeWindow"
if displayParameter
vmrunstr = vmrunstr + " -display :0"
end
system_command(vmrunstr)
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def run_ssh_command(hostname, command, user)
ssh_command = "ssh " + user + "@" + hostname + " " + command
system_command(ssh_command)
end
def copy_file_from(vmx, user, pass, guestpath, hostpath)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " copyFileFromGuestToHost \"" + vmx + "\" \"" + guestpath + "\" \"" + hostpath + "\""
system_command(vmrunstr)
end
def scp_copy_file_from(hostname, user, guestpath, hostpath)
vmrunstr = "scp -r \"" + user + "@" + hostname + ":" + guestpath + "\" \"" + hostpath + "\"" ## TODO - setup keys
system_command(vmrunstr)
end
def copy_file_to(vmx, user, pass, hostpath, guestpath)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " copyFileFromHostToGuest \"" + vmx + "\" \"" + hostpath + "\" \"" + guestpath + "\""
system_command(vmrunstr)
end
def scp_copy_file_to(hostname, user, hostpath, guestpath)
vmrunstr = "scp -r \"" + hostpath + "\" \"" + user + "@" + hostname + ":" + guestpath + "\"" ## TODO - setup keys
system_command(vmrunstr)
end
def check_file_exists(vmx, user, pass, file)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " fileExistsInGuest \"" + vmx + "\" \"" + file + "\" "
system_command(vmrunstr)
end
def create_directory_in_guest(vmx, user, pass, directory)
vmrunstr = "vmrun -T ws -gu " + user + " -gp " + pass + " createDirectoryInGuest \"" + vmx + "\" \"" + directory + "\" "
system_command(vmrunstr)
end
def create_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws snapshot " + "\"" + vmx + "\" " + snapshot)
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def revert_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws revertToSnapshot " + "\"" + vmx + "\" " + snapshot)
else
raise "Couldn't find: " + vmx, caller
end
end
def delete_snapshot(vmx, snapshot)
if File.exist?(vmx)
system_command("vmrun -T ws deleteSnapshot " + "\"" + vmx + "\" " + snapshot )
else
raise ArgumentError,"Couldn't find: " + vmx, caller
end
end
def get_running
output = `vmrun list` ##hackity hack=begin
end
def running?(vmx)
output = self.get_running
output.each_line do |line|
next unless line =~ /^#{@vmbase}(.*)/
return true if line.strip == vmx.strip
end
return false
end
private
def system_command(command)
puts "Running command: " + command
system(command)
end
end
#
# Higher level methods which are more specific to the types of things we want to do with a lab of machines
#
class LabController
attr_accessor :labdef
attr_accessor :vmbase
attr_accessor :controller
def initialize (basepath = ".", labdef = Hash.new)
@vmbase = basepath ## set the base directory for the lab (default to local)
@labdef = labdef ## assign the lab definition if we were passed one (default to empty)
## set up the controller. note that this is likely to change in the future (to provide for additional vm tech)
@controller = VmwareController.new
end
def build_lab_from_running(basepath=nil)
@vmbase = basepath if basepath
vm_array = self.get_running.split("\n")
vm_array.shift
stuff_array_info_lab(vm_array)
end
def build_lab_from_files(basepath=nil)
@vmbase = basepath if basepath
vm_array = Find.find(@vmbase).select { |f|
f =~ /\.vmx$/ && File.executable?(f)
}
stuff_array_into_lab(vm_array)
end
def stuff_array_into_lab(arr)
return false unless arr.kind_of? Array
arr.each_with_index {|v,i|
@labdef[i] = File.join(v.split(/[\x5c\x2f]+/))
if @labdef[i] =~ /^#{@vmbase}(.*)/
@labdef[i] = $1
end
}
return @labdef
end
def run_command_on_lab_vm(vmid,command)
begin
## handle linux
display = false
if (@labdef[vmid]["os"] == "linux")
#display=true
@controller.run_ssh_command(@labdef[vmid]["hostname"], command , @labdef[vmid]["user"])
else
@controller.run_command(get_vmx(vmid), command , @labdef[vmid]["user"],@labdef[vmid]["pass"], display)
end
rescue Exception => e
puts "error! " + e.to_s
end
end
def start_lab_vm(vmid)
if self.running?(vmid)
puts vmid + " already started."
self.list_running
else
begin
@controller.start(get_vmx(vmid))
rescue Exception => e
puts "error! " + e.to_s
end
end
end
def reset_lab_vm(vmid)
begin
@controller.reset(get_vmx(vmid))
rescue Exception => e
puts "error! " + e.to_s
end
end
def pause_lab_vm(vmid)
if !self.running?(vmid)
puts vmid + " not started."
self.list_running
else
begin
@controller.pause(get_vmx(vmid))
rescue Exception => e
puts "error! " + e.to_s
end
end
end
def suspend_lab_vm(vmid)
if !self.running?(vmid)
puts vmid + " not started."
self.list_running
else
begin
@controller.suspend(get_vmx(vmid))
rescue Exception => e
puts "error! " + e.inspect
end
end
end
def snapshot_lab_vm(vmid, snapshot)
if !self.running?(vmid)
puts vmid + " not started."
self.list_running
else
begin
@controller.create_snapshot(get_vmx(vmid),snapshot)
rescue Exception => e
puts "error! " + e.to_s
end
end
end
def revert_lab_vm(vmid, snapshot)
if !self.running?(vmid)
puts vmid + " not started."
self.list_running
else
begin
@controller.revert_snapshot(get_vmx(vmid),snapshot)
rescue Exception => e
puts "error! " + e.to_s
end
end
end
def stop_lab_vm(vmid)
if !self.running?(vmid)
puts vmid + " not started."
self.list_running
else
begin
@controller.stop(get_vmx(vmid))
rescue Exception => e
puts "error! " + e.to_s
end
end
end
def start_lab
@labdef.each { | key, value |
if value
self.start_lab_vm(key)
end
}
end
def pause_lab
@labdef.each { | key, value |
if value
self.pause_lab_vm(key)
end
}
end
def stop_lab
@labdef.each { | key, value |
if value
self.stop_lab_vm(key)
end
}
end
def reset_lab
@labdef.each { | key, value |
if value
self.reset_lab_vm(key)
end
}
end
def suspend_lab
@labdef.each { | key, value |
if value
self.suspend_lab_vm(key)
end
}
end
def snapshot_lab(snapshot)
@labdef.each { | key, value |
if value
self.snapshot_lab_vm(key,snapshot)
end
}
end
def revert_lab(snapshot)
@labdef.each { | key, value |
if value
self.revert_lab_vm(key,snapshot)
end
}
end
def run_command_on_lab(command)
@labdef.each { | key, value |
if value
self.run_command_on_lab_vm(key, command)
end
}
end
def copy_to_lab(file)
@labdef.each { | key, value |
if value
self.copy_to_lab_vm(key,file)
end
}
end
def copy_from_lab(file)
@labdef.each { | key, value |
next unless line =~ /^#{@vmbase}(.*)/
if value
self.copy_from_lab_vm(key,file)
end
}
end
def copy_to_lab_vm(vmid,file)
## handle linux
guestpath = ""
if (@labdef[vmid]["os"] == "linux")
guestpath = "/tmp/"
else
guestpath = "C:\\temp_msf\\\\" ## double-escaping because it's being used in a system command.
end
name = File.basename(file)
## if we've installed vm-tools on the box, use that to copy. if not, use scp
if (@labdef[vmid]["tools"] == "true")
puts "creating directory: " + guestpath
@controller.create_directory_in_guest(get_vmx(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"], guestpath)
begin
puts "copying file: " + file + " into " + guestpath + name
@controller.copy_file_to(get_vmx(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"],file, guestpath + name)
rescue Exception => e
puts "error! " + e.to_s
end
else
puts "scp copying file: " + file + " into " + guestpath + name
@controller.scp_copy_file_to(@labdef[vmid]["hostname"], @labdef[vmid]["user"], file, guestpath + name)
end
end
def copy_from_lab_vm(vmid,file)
hostpath = "/tmp/"
name = File.basename(file.gsub("\\","/"))
begin
@controller.copy_file_from(get_vmx(vmid),@labdef[vmid]["user"],@labdef[vmid]["pass"],file,hostpath + name)
rescue Exception => e
puts "error! " + e.to_s
end
end
def list_running
@controller.get_running
end
def list_lab
str = ""
@labdef.sort.each { |key,val|
if val != nil
str = str + key.to_s + ": " + val["vmx"].to_s + "\n"
end
}
return str
end
def find_lab_vm(search)
str = ""
@labdef.sort.each { |key,val|
if val != nil
if (val["vmx"].to_s.downcase.index(search.downcase) != nil)
str = str + key.to_s + ": " + val["vmx"].to_s + "\n"
end
end
}
return str
end
def running?(vmid)
if @controller.running?(get_vmx(vmid))
return true
end
return false
end
private
def get_vmx(vmid)
if @labdef[vmid]
@vmbase.to_s + @labdef[vmid]["vmx"].to_s ## handle linux
else
raise "VM #{vmid} does not exist!"
end
end
end