veewee 0.3.6 → 0.3.7

data/README.md

@@ -1,7 +1,7 @@
 **VeeWee:** the tool to easily build vagrant base boxes or kvm,virtualbox and fusion images
 
 Vagrant is a great tool to test new things or changes in a virtual machine(Virtualbox) using either chef or puppet.
-The first step is to download an existing 'base box'. I believe this scares a lot of people as they don't know who or how this box was build. Therefore lots of people end up first building their own base box to use with vagrant.
+The first step is to download an existing 'base box'. I believe this scares a lot of people as they don't know who or how this box was built. Therefore lots of people end up first building their own base box to use with vagrant.
 
 Besides building Vagrant boxes, veewee can also be used for:
 

data/Rakefile

@@ -25,33 +25,33 @@ Rake::TestTask.new do |t|
 end
 
 desc 'Verify ISO'
-task :iso, [:template_name] do |t,args|
+task :iso, [:template_name] do |t, args|
   require 'net/http'
   #if args.to_hash.size!=1
   #puts "needs one arguments: rake iso [\"yourname\"]"
   #exit
   #end
   Dir.glob("templates/*").each do |name|
-    definition_name=File.basename(name)
+    definition_name = File.basename(name)
     puts name
-    definition=Veewee::Environment.new(:cwd => ".",:definition_dir => "templates").definitions[definition_name]
-    next if definition.nil? || definition.iso_src.nil? || definition.iso_src==""
+    definition = Veewee::Environment.new(:cwd => ".", :definition_dir => "templates").definitions[definition_name]
+    next if definition.nil? || definition.iso_src.nil? || definition.iso_src == ""
     begin
-      url=definition.iso_src
-      found=false
+      url = definition.iso_src
+      found = false
       response = nil
-      while found==false
-        uri=URI.parse(url)
+      while found == false
+        uri = URI.parse(url)
         if uri.is_a?(URI::HTTP)
-          Net::HTTP.start(uri.host,uri.port) {|http|
+          Net::HTTP.start(uri.host, uri.port) { |http|
             response = http.head(uri.path)
           }
           unless response['location'].nil?
             #puts "Redirecting to "+response['location']
-            url=response['location']
+            url = response['location']
           else
-            length=response['content-length']
-            found=true
+            length = response['content-length']
+            found = true
           end
         elsif uri.is_a?(URI::FTP)
           require 'net/ftp'
@@ -62,7 +62,7 @@ task :iso, [:template_name] do |t,args|
             found = true
           rescue Net::FTPReplyError => e
             reply = e.message
-            err_code = reply[0,3].to_i
+            err_code = reply[0, 3].to_i
             unless err_code == 500 || err_code == 502
               # other problem, raise
               raise "Got ftp site but doesn't support size subcommand"
@@ -75,22 +75,22 @@ task :iso, [:template_name] do |t,args|
       if length.to_i < 10000
         puts definition.iso_src
         puts "Incorrect length #{length.to_i}"
-        puts uri.host,uri.port, uri.path,response.code
+        puts uri.host, uri.port, uri.path, response.code
       end
     rescue Exception => ex
-      puts "Error"+ex.to_s+definition.iso_src
+      puts "Error" + ex.to_s + definition.iso_src
     end
   end
 end
 
 desc 'Autobuilds all templates and runs validation.'
-task :autotest, [:pattern] do |t,args|
+task :autotest, [:pattern] do |t, args|
 
   # We overrule all timeouts for tcp and ssh
   #ENV['VEEWEE_TIMEOUT']='600'
 
-  ve=Veewee::Environment.new()
-  ve.templates.each do |name,template|
+  ve = Veewee::Environment.new
+  ve.templates.each do |name, template|
 
     # If pattern was given, only take the ones that match the pattern
     unless args[:pattern].nil?
@@ -98,11 +98,11 @@ task :autotest, [:pattern] do |t,args|
     end
 
     begin
-      ve.definitions.define("auto",name, { 'force' => true})
-      vd=ve.definitions["auto"]
-      box=ve.providers["virtualbox"].get_box("auto")
+      ve.definitions.define("auto", name, { 'force' => true })
+      vd = ve.definitions["auto"]
+      box = ve.providers["virtualbox"].get_box("auto")
       puts "AUTO: Building #{name}"
-      box.build({"auto" => true,"force" => true, 'nogui' => true })
+      box.build({ "auto" => true, "force" => true, 'nogui' => true })
       puts "AUTO: Validating #{name}"
       box.validate_vagrant
       puts "AUTO: Success #{name}"
@@ -111,7 +111,7 @@ task :autotest, [:pattern] do |t,args|
       puts "AUTO: Template #{name} failed - #{ex}"
       if box.running?
         begin
-          screenshot="screenshot-auto-#{name}.png"
+          screenshot = "screenshot-auto-#{name}.png"
           puts "AUTO: Taking snapshot #{screenshot}"
           box.screenshot(screenshot)
         rescue Veewee::Error => ex

data/bin/veewee

@@ -20,7 +20,7 @@ begin
   env.load!
 
   # Start the CLI
-  ::Veewee::CLI.start(ARGV,:env => env)
+  ::Veewee::CLI.start(ARGV, :env => env)
 
 rescue Veewee::Error => e
   env.ui.error "#{e}"

data/doc/kvm.md

@@ -1,8 +1,10 @@
-NOTE:Virtualbox doesn't like KVM to be enabled
+# KVM Provider
 
-## Prerequires
+NOTE: Virtualbox doesn't like KVM to be enabled
 
-To check if you're kernel can run kvm :
+## Prerequisites
+
+To check if your kernel can run kvm :
 
     # kvm_ok or kvm-ok command (on Ubuntu at least)
     kvm_ok
@@ -11,10 +13,59 @@ To check if you're kernel can run kvm :
 
 The modules needed are the following : kvm, kvm_intel or kvm-amd.
 
-## Define a new box
+You need to have at least one storage pool defined in libvirt. You can check all
+available storage pools with
+
+    virsh pool-list
+
+If no storage pool is listed, you can create a new storage pool which saves all
+VM images in the directory /var/lib/libvirt/images with
+
+    mkdir -p /var/lib/libvirt/images
+    cat > /tmp/pool.xml << EOF
+    <pool type="dir">
+      <name>virtimages</name>
+      <target>
+        <path>/var/lib/libvirt/images</path>
+        <format type='qcow2'/>
+      </target>
+    </pool>
+    EOF
+    virsh pool-create /tmp/pool.xml
+
+You need to have at least one network defined. You can check all available
+networks with
+
+    virsh net-list
+
+If there is no default network, consult the documentation of your operating
+system to find out how to creat it.
+
+If you are using libvirt with a URI different than the default `qemu:///system`,
+you need to create a config file for fog.io. If your libvirt endpoint is
+accessible at `qemu+ssh://cloud@myhost.com/system` you can create the .fog config
+file with
+
+    cat > ~/.fog << EOF
+    :default:
+      :libvirt_uri: qemu+ssh://cloud@myhost.com/system
+
+## Using VeeWee
+
+List available templates
+
+    veewee kvm templates
+
+Use one of the listed templates to define a new box e.g. with
+
+    veewee kvm define 'My Ubuntu 12.10 box' 'ubuntu-12.10-server-amd64'
+
+Build the box using KVM / Quemu (this will take a while)
+
+    veewee kvm build 'My Ubuntu 12.10 box'
 
-The workflow to create a box is almost the same as with the Virtualbox
-provider (and others).
+You may want to use the VNC console (e.g. through virt-manager) to monitor /
+check the build process.
 
 ## Options
 
@@ -25,9 +76,7 @@ There is currently few options supported :
 2. **network_bridge_name**: the name of the bridge. It is used just in case
    **network_type** is set to _bridge_.
 3. **pool_name**: the _storage_ pool name to be used when creating the box. If
-   not specified, the default one is used. _Note: it is currently not working
-   with the current fog version (1.7.0) but should be fixed as soon as the fog
-   gem is released_.
+   not specified, the default one is used.
 
 ## Notes
 

data/doc/providers.md

@@ -18,6 +18,6 @@ To interact with the screen , veewee enables VNC on the created vmware fusion ma
 
 ## KVM
 
-To interact  with KVM veewee, uses [libvirt support](http://libvirt.org/ruby/) provided through [Fog gem](http://fog.io) libvirt support
+To interact  with KVM veewee, uses [libvirt support](http://libvirt.org/ruby/) provided through [Fog gem](http://fog.io).
 
-To interact with the screen , veewee enables VNC on the created vmware fusion machines and use the [Ruby-VNC gem](http://code.google.com/p/ruby-vnc/) to send the keystrokes. Here too , sending keystrokes too fast is a problem.
+To interact with the screen , veewee enables VNC on the created kvm machines and use the [Ruby-VNC gem](http://code.google.com/p/ruby-vnc/) to send the keystrokes. Here too , sending keystrokes too fast is a problem.

data/doc/vagrant.md

@@ -3,7 +3,7 @@ Let's define a  Ubuntu 10.10 server i386 basebox called myunbuntubox
 this is essentially making a copy based on the  templates provided above.
 
     $ veewee vbox define 'myubuntubox' 'ubuntu-10.10-server-i386'
-    The basebox 'myubuntubox' has been succesfully created from the template ''ubuntu-10.10-server-i386'
+    The basebox 'myubuntubox' has been successfully created from the template ''ubuntu-10.10-server-i386'
     You can now edit the definition files stored in definitions/myubuntubox
     or build the box with:
     veewee vbox build 'myubuntubox'

data/lib/vagrant_init.rb

@@ -5,5 +5,4 @@ rescue LoadError
   require 'rubygems'
   require 'veewee/command/vagrant'
   require 'veewee/command/kvm'
-
 end

data/lib/veewee/cli.rb

@@ -30,7 +30,7 @@ module Veewee
     #   command listing.
     # @param [Hash] opts Other options (not gone into detail here, look at
     #   the source instead).
-    def self.register(klass, name, usage, description, opts=nil)
+    def self.register(klass, name, usage, description, opts = nil)
       opts ||= {}
 
       if klass <= Command::GroupBase

data/lib/veewee/command.rb

@@ -1,8 +1,8 @@
 module Veewee
   module Command
-    autoload :Base,      'veewee/command/base'
+    autoload :Base, 'veewee/command/base'
     autoload :GroupBase, 'veewee/command/group_base'
-    autoload :Helpers,   'veewee/command/helpers'
+    autoload :Helpers, 'veewee/command/helpers'
     autoload :NamedBase, 'veewee/command/named_base'
   end
 end

data/lib/veewee/command/fusion.rb

@@ -93,7 +93,7 @@ module Veewee
         venv=Veewee::Environment.new(options)
         venv.ui=env.ui
         venv.definitions.define(definition_name,template_name,options)
-        env.ui.info "The basebox '#{definition_name}' has been succesfully created from the template '#{template_name}'"
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
         env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
         env.ui.info "veewee fusion build '#{definition_name}'"
       end
@@ -106,7 +106,7 @@ module Veewee
           venv=Veewee::Environment.new(options)
           venv.ui=env.ui
           venv.definitions.undefine(definition_name,options)
-          env.ui.info "Definition #{definition_name} succesfully removed",:prefix => false
+          env.ui.info "Definition #{definition_name} successfully removed",:prefix => false
         rescue Error => ex
           env.ui.error "#{ex}" , :prefix => false
           exit -1

data/lib/veewee/command/kvm.rb

@@ -60,7 +60,7 @@ module Veewee
         venv=Veewee::Environment.new(options)
         venv.ui=env.ui
         venv.definitions.define(definition_name,template_name,options)
-        env.ui.info "The basebox '#{definition_name}' has been succesfully created from the template '#{template_name}'"
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
         env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
         env.ui.info "veewee kvm build '#{definition_name}'"
       end

data/lib/veewee/command/parallels.rb

@@ -57,7 +57,7 @@ module Veewee
         venv=Veewee::Environment.new(options)
         venv.ui=env.ui
         venv.definitions.define(definition_name,template_name,options)
-        env.ui.info "The basebox '#{definition_name}' has been succesfully created from the template '#{template_name}'"
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
         env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
         env.ui.info "veewee parallels build '#{definition_name}'"
       end
@@ -70,7 +70,7 @@ module Veewee
           venv=Veewee::Environment.new(options)
           venv.ui=env.ui
           venv.definitions.undefine(definition_name,options)
-          env.ui.info "Definition #{definition_name} succesfully removed",:prefix => false
+          env.ui.info "Definition #{definition_name} successfully removed",:prefix => false
         rescue Error => ex
           env.ui.error "#{ex}" , :prefix => false
           exit -1

data/lib/veewee/command/vagrant/define.rb

@@ -33,7 +33,7 @@ module Veewee
             definition_name=argv[0]
             template_name=argv[1]
             venv.definitions.define(definition_name,template_name,options)
-            venv.ui.info "The basebox '#{definition_name}' has been succesfully created from the template '#{template_name}'"
+            venv.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
             venv.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
             venv.ui.info "vagrant basebox build '#{definition_name}'"
           rescue Veewee::Error => ex

data/lib/veewee/command/vagrant/undefine.rb

@@ -28,7 +28,7 @@ module Veewee
             venv.ui=@env.ui
             definition_name=argv[0]
             venv.definitions.undefine(definition_name,options)
-            venv.ui.info("Definition '#{definition_name}' succesfully removed",:prefix => false)
+            venv.ui.info("Definition '#{definition_name}' successfully removed",:prefix => false)
           rescue Veewee::Error => ex
             venv.ui.error(ex,:prefix => false)
             exit -1

data/lib/veewee/command/vbox.rb

@@ -79,7 +79,7 @@ module Veewee
         venv=Veewee::Environment.new(options)
         venv.ui=env.ui
         venv.definitions.define(definition_name,template_name,options)
-        env.ui.info "The basebox '#{definition_name}' has been succesfully created from the template '#{template_name}'"
+        env.ui.info "The basebox '#{definition_name}' has been successfully created from the template '#{template_name}'"
         env.ui.info "You can now edit the definition files stored in definitions/#{definition_name} or build the box with:"
         env.ui.info "veewee vbox build '#{definition_name}'"
         rescue Error => ex
@@ -96,7 +96,7 @@ module Veewee
           venv=Veewee::Environment.new(options)
           venv.ui=env.ui
           venv.definitions.undefine(definition_name,options)
-          env.ui.info "Definition #{definition_name} succesfully removed" , :prefix => false
+          env.ui.info "Definition #{definition_name} successfully removed" , :prefix => false
         rescue Error => ex
           env.ui.error("#{ex}",:prefix => false)
           exit -1

data/lib/veewee/config.rb

@@ -10,18 +10,18 @@ module Veewee
     attr_reader :env
 
     def initialize(options)
-      @env=options[:env]
+      @env = options[:env]
 
       # Initialize with defaults
-      @veewee=::Veewee::Config::Veewee.new(self)
+      @veewee = ::Veewee::Config::Veewee.new(self)
 
     end
 
     def define()
-      config=OpenStruct.new
+      config = OpenStruct.new
 
       # Expose the veewee config
-      config.veewee=@veewee
+      config.veewee = @veewee
 
       # Process config file
       yield config
@@ -30,12 +30,12 @@ module Veewee
 
     # We put a long name to not clash with any function in the Veewee file itself
     def load_veewee_config()
-      veewee_configurator=self
+      veewee_configurator = self
       begin
-        filename=File.join(Dir.pwd,"Veeweefile")
+        filename = File.join(Dir.pwd, "Veeweefile")
         if File.exists?(filename)
-          veeweefile=File.read(filename)
-          veeweefile["Veewee::Config.run"]="veewee_configurator.define"
+          veeweefile = File.read(filename)
+          veeweefile["Veewee::Config.run"] = "veewee_configurator.define"
           #        http://www.dan-manges.com/blog/ruby-dsls-instance-eval-with-delegation
           instance_eval(veeweefile)
         else
@@ -57,7 +57,5 @@ module Veewee
       return self
     end
 
-
-
   end #End Class
 end #End Module

data/lib/veewee/definition.rb

@@ -10,18 +10,18 @@ module Veewee
     attr_accessor :env
     attr_accessor :path
 
-    attr_accessor :cpu_count,:memory_size,:iso_file
+    attr_accessor :cpu_count, :memory_size, :video_memory_size, :iso_file
     attr_accessor :disk_size, :disk_format, :disk_variant
 
     attr_accessor :os_type_id
 
-    attr_accessor :boot_wait,:boot_cmd_sequence
+    attr_accessor :boot_wait, :boot_cmd_sequence
 
-    attr_accessor :kickstart_port,:kickstart_ip,:kickstart_timeout, :kickstart_file
+    attr_accessor :kickstart_port, :kickstart_ip, :kickstart_timeout, :kickstart_file
 
-    attr_accessor :ssh_login_timeout, :ssh_user , :ssh_password, :ssh_key, :ssh_host_port, :ssh_guest_port
+    attr_accessor :ssh_login_timeout, :ssh_user, :ssh_password, :ssh_key, :ssh_host_port, :ssh_guest_port
 
-    attr_accessor :winrm_login_timeout, :winrm_user , :winrm_password, :winrm_host_port, :winrm_guest_port
+    attr_accessor :winrm_login_timeout, :winrm_user, :winrm_password, :winrm_host_port, :winrm_guest_port
 
     attr_accessor :sudo_cmd
     attr_accessor :shutdown_cmd
@@ -32,10 +32,9 @@ module Veewee
 
     attr_accessor :floppy_files
 
+    attr_accessor :use_hw_virt_ext, :use_pae, :hostiocache, :use_sata
 
-    attr_accessor :use_hw_virt_ext,:use_pae,:hostiocache, :use_sata
-
-    attr_accessor :iso_dowload_timeout, :iso_src,:iso_md5 ,:iso_download_instructions
+    attr_accessor :iso_dowload_timeout, :iso_src, :iso_md5, :iso_download_instructions
 
     attr_accessor :virtualbox
     attr_accessor :vmfusion
@@ -50,22 +49,22 @@ module Veewee
       @_ui
     end
 
-    def initialize(name,path,env)
+    def initialize(name, path, env)
 
-      @name=name
-      @env=env
+      @name = name
+      @env = env
 
-      if path.nil? 
-        @path=File.join(env.definition_dir,name)
+      if path.nil?
+        @path = File.join(env.definition_dir, name)
       else
-        @path=path
+        @path = path
       end
 
-      # Default is 1 CPU + 256 Mem of memory
-      @cpu_count='1' ; @memory_size='256';
+      # Default is 1 CPU + 256 Mem of memory + 8 Mem of video memory
+      @cpu_count = '1' ; @memory_size = '256'; @video_memory_size = '8'
 
       # Default there is no ISO file mounted
-      @iso_file = nil, @iso_src = nil ; @iso_md5 = nil ; @iso_download_timeout=1000 ; @iso_download_instructions = nil
+      @iso_file = nil, @iso_src = nil ; @iso_md5 = nil ; @iso_download_timeout = 1000 ; @iso_download_instructions = nil
 
       # Shares to add
       @add_shares = []
@@ -75,10 +74,10 @@ module Veewee
 
       # Default there are no post install files
       @pre_postinstall_file = nil
-      @postinstall_files=[]; @postinstall_timeout = 10000;
+      @postinstall_files = [] ; @postinstall_timeout = 10000 ;
 
-      @iso_file=""
-      @disk_size = '10240'; @disk_format = 'VDI'; @disk_variant = 'Standard'
+      @iso_file = ""
+      @disk_size = '10240' ; @disk_format = 'VDI' ; @disk_variant = 'Standard'
       @use_sata = true
 
       #        :hostiocache => 'off' ,
@@ -86,17 +85,17 @@ module Veewee
       #        :boot_wait => "10", :boot_cmd_sequence => [ "boot"],
       #        :kickstart_port => "7122", :kickstart_ip => "127.0.0.1", :kickstart_timeout => 10000,#
       #        :ssh_login_timeout => "10000", :ssh_user => "vagrant", :ssh_password => "vagrant",:ssh_key => "",
-      @ssh_host_port = "2222"; @ssh_guest_port = "22"
+      @ssh_host_port = "2222" ; @ssh_guest_port = "22"
       #        :ssh_host_port => "2222", :ssh_guest_port => "22", :sudo_cmd => "echo '%p'|sudo -S sh '%f'",
       #       :shutdown_cmd => "shutdown -h now",
       #        :kickstart_file => nil,
-      @winrm_host_port = "5985"; @winrm_guest_port = "5985"
+      @winrm_host_port = "5985" ; @winrm_guest_port = "5985"
       @winrm_login_timeout = "10000"
       @boot_cmd_sequence = [] # Empty list by default
 
-      @virtualbox={:vm_options => {}}
-      @vmfusion={:vm_options => {}}
-      @kvm={:vm_options => {}}
+      @virtualbox = { :vm_options => {} }
+      @vmfusion = { :vm_options => {} }
+      @kvm = { :vm_options => {} }
 
     end
 
@@ -111,56 +110,56 @@ module Veewee
     end
 
     # Class method to loading a definition
-    def self.load(name,env)
+    def self.load(name, env)
 
       # Construct the path to the definition
 
-      path=File.join(env.definition_dir,name)
-      definition=Veewee::Definition.new(name,path,env)
+      path = File.join(env.definition_dir, name)
+      definition = Veewee::Definition.new(name, path, env)
       env.logger.info "Loading definition directory #{definition.path}"
       unless definition.exists?
-        raise Veewee::DefinitionNotExist,"Error: Definition #{name} does not seem to exist"
+        raise Veewee::DefinitionNotExist, "Error: Definition #{name} does not seem to exist"
       end
 
       # We create this longer name to avoid clashes
-      veewee_definition=definition
+      veewee_definition = definition
 
       if definition.exists?
-        definition_file=File.join(definition.path,"definition.rb")
-        content=File.read(definition_file)
+        definition_file = File.join(definition.path, "definition.rb")
+        content = File.read(definition_file)
 
-        content.gsub!("Veewee::Session.declare","veewee_definition.declare")
-        content.gsub!("Veewee::Definition.declare","veewee_definition.declare")
+        content.gsub!("Veewee::Session.declare", "veewee_definition.declare")
+        content.gsub!("Veewee::Definition.declare", "veewee_definition.declare")
 
         env.logger.info(content)
 
         begin
-          cwd=FileUtils.pwd
+          cwd = FileUtils.pwd
           env.logger.info("Entering path #{definition.path}")
           FileUtils.cd(definition.path)
           self.instance_eval(content)
-          env.logger.info("Returning to  path #{cwd}")
+          env.logger.info("Returning to path #{cwd}")
           FileUtils.cd(cwd)
         rescue NameError => ex
-          raise Veewee::DefinitionError,"NameError reading definition from file #{definition_file} #{ex}"
+          raise Veewee::DefinitionError, "NameError reading definition from file #{definition_file} #{ex}"
         rescue Exception => ex
-          raise Veewee::DefinitionError,"Error in the definition from file #{definition_file}\n#{ex}"
+          raise Veewee::DefinitionError, "Error in the definition from file #{definition_file}\n#{ex}"
         end
       else
         env.logger.fatal("#{definition_file} not found")
-        raise Veewee::DefinitionNotExist,"#{definition_file} not found"
+        raise Veewee::DefinitionNotExist, "#{definition_file} not found"
       end
 
       if definition.valid?
         return definition
       else
         env.logger.fatal("Invalid Definition")
-        raise Veewee::DefinitionError,"Invalid Definition"
+        raise Veewee::DefinitionError, "Invalid Definition"
       end
     end
 
     def exists?
-      filename=File.join(path,"definition.rb")
+      filename = File.join(path, "definition.rb")
       unless File.exists?(filename)
         return false
       end
@@ -190,6 +189,7 @@ module Veewee
     end
 
     private
+
     def ostype_valid?
       unless env.ostypes.has_key?(@os_type_id)
         env.ui.info("The ostype: #{@os_type_id} is not available")