veewee 0.3.0.alpha4 → 0.3.0.alpha5

data/lib/veewee/error.rb

@@ -5,6 +5,18 @@ module Veewee
         super(msg)
         @original = original; end
     end
+
+    class DefinitionError < Error
+    end
+
+    class DefinitionNotExist < DefinitionError
+    end
+
+    class TemplateError < Error
+    end
+
+    class SshError < Error
+    end
 end
 
 #Usage (from the exceptional ruby book)

data/lib/veewee/provider/core/box.rb

@@ -0,0 +1,52 @@
+require 'veewee/provider/core/helper/tcp'
+require 'veewee/provider/core/helper/ssh'
+require 'veewee/provider/core/helper/web'
+require 'veewee/provider/core/helper/shell'
+require 'veewee/provider/core/helper/iso'
+
+require 'veewee/provider/core/box/build'
+require 'veewee/provider/core/box/scp'
+require 'veewee/provider/core/box/exec'
+require 'veewee/provider/core/box/poweroff'
+require 'veewee/provider/core/box/halt'
+require 'veewee/provider/core/box/sudo'
+require 'veewee/provider/core/box/ssh'
+require 'veewee/provider/core/box/issh'
+require 'veewee/provider/core/box/floppy'
+
+module Veewee
+  module Provider
+    module Core
+      class  Box
+        attr_accessor :definition
+        attr_accessor :env
+        attr_accessor :name
+
+        include ::Veewee::Provider::Core::Helper::Tcp
+        include ::Veewee::Provider::Core::Helper::Web
+        include ::Veewee::Provider::Core::Helper::Shell
+        include ::Veewee::Provider::Core::Helper::Ssh
+        include ::Veewee::Provider::Core::Helper::Iso
+
+        include ::Veewee::Provider::Core::BoxCommand
+
+        def initialize(name,env)
+          @env=env
+          @name=name
+          self.set_definition(name)
+        end
+
+        def set_definition(definition_name)
+          @definition=env.definitions[definition_name]
+          return self
+        end
+
+        def reload
+          @raw=nil
+        end
+
+
+      end #End Class
+    end # End Module
+  end # End Module
+end # End Module

data/lib/veewee/provider/core/box/build.rb

@@ -0,0 +1,229 @@
+module Veewee
+  module Provider
+    module Core
+      module BoxCommand
+
+        def build(options={})
+
+          # Requires valid definition
+
+          env.ui.info "Building Box #{name} with Definition #{definition.name}:"
+          options.each do |name,value|
+            env.ui.info "- #{name} : #{value}"
+          end
+
+          # Checking regexp of postinstall include/excludes
+          validate_postinstall_regex(options)
+
+          # Check the iso file we need to build the box
+          definition.verify_iso(options)
+
+          if self.exists?
+            # check if --force option was given
+            if options['force']==true
+              self.destroy
+              self.reload
+            else
+              env.ui.error "you need to provide --force because the box #{name} already exists"
+              raise Veewee::Error,"you need to provide --force because the box #{name} already exists"
+            end
+          end
+
+          # By now the box should have been gone, just checking again
+          if self.exists?
+            env.ui.error "The box should have been deleted by now. Something went terribly wrong. Sorry"
+            raise Veewee::Error, "The box should have been deleted by now. Something went terribly wrong. Sorry"
+          end
+
+          self.create(options)
+
+          # Check the GUI mode required
+          env.logger.info "Provider asks the box to start: GUI enabled? #{!options[:nogui]}"
+          self.up(options)
+
+          # Waiting for it to boot
+          env.ui.info "Waiting #{definition.boot_wait.to_i} seconds for the machine to boot"
+          sleep definition.boot_wait.to_i
+
+          # Calculate an available kickstart port
+          unless definition.kickstart_port.nil?
+            guessed_port=guess_free_port(definition.kickstart_port.to_i,7199).to_s
+            if guessed_port.to_s!=definition.kickstart_port
+              env.ui.warn "Changing kickstart port from #{definition.kickstart_port} to #{guessed_port}"
+              definition.kickstart_port=guessed_port.to_s
+            end
+          end
+
+          # Let fill's in the variable we need
+          boot_sequence=fill_sequence(definition.boot_cmd_sequence,{
+            :ip =>host_ip_as_seen_by_guest,
+            :port => definition.kickstart_port.to_s,
+            :name => name
+          })
+
+          # Type the boot sequence
+          self.console_type(boot_sequence)
+
+          self.handle_kickstart(options)
+
+          # Wait for an ipaddress
+          # This needs to be done after the kickstart:
+          # As the dhcp request will likely occur just before the kickstart fetch
+          until !self.ip_address.nil?
+            env.logger.info "wait for Ip addres"
+            sleep 2
+          end
+
+          self.transfer_buildinfo(options)
+          self.handle_postinstall(options)
+
+          env.ui.success "The box #{name} was built succesfully!"
+          env.ui.info "You can now login to the box with:"
+          env.ui.info ssh_command_string
+
+          return self
+        end
+
+        def validate_postinstall_regex(options)
+          env.logger.info "Checking the postinstall excludes"
+          unless options["postinstall_exclude"].nil?
+            options["postinstall_exclude"].each do |p|
+              begin
+                r=::Regexp.new(p)
+              rescue ::RegexpError => ex
+                raise Veewee::Error ,"\nError in postinstall exclude (ruby regexp) pattern: #{p}:\n- #{ex}"
+              end
+            end
+          end
+
+          env.logger.info "Checking the postinstall includes"
+          unless options["postinstall_include"].nil?
+            options["postinstall_include"].each do |p|
+              begin
+                r=Regexp.new(p)
+              rescue RegexpError => ex
+                raise Veewee::Error ,"\nError in postinstall include (ruby regexp) pattern: #{p}:\n- #{ex}"
+              end
+            end
+          end
+        end
+
+        def filter_postinstall_files(options)
+          new_definition=definition.clone
+
+          env.logger.info "Applying the postinstall excludes"
+          unless options["postinstall_exclude"].nil?
+            options["postinstall_exclude"].each do |p|
+              env.logger.info "Exclude pattern #{p}"
+              new_definition.postinstall_files.collect! { |f| f.match(p) ? f.gsub(/^/,"_"): f}
+            end
+          end
+
+          env.logger.info "Applying the postinstall includes"
+          unless options["postinstall_include"].nil?
+            options["postinstall_include"].each do |p|
+              env.logger.info "Include pattern #{p}"
+              new_definition.postinstall_files.collect! { |f| f.match(p) ? f.gsub(/^_/,""): f}
+            end
+          end
+
+          env.logger.info "filtered postinstall files:"
+          new_definition.postinstall_files.each do |p|
+            env.logger.info "- "+p
+          end
+
+          return new_definition.postinstall_files
+        end
+
+
+
+        # This will take a sequence and fill in the variables specified in the options
+        # f.i. options={:ip => "name"} will substitute "%IP%" -> "name"
+        def fill_sequence(sequence,options)
+          filled=sequence.dup
+          options.each do |key,value|
+            filled.each do |s|
+              s.gsub!("%#{key.to_s.upcase}%",value)
+            end
+          end
+          return filled
+        end
+
+        def build_info
+          [ {:filename => ".veewee_version",:content => "#{Veewee::VERSION}"}]
+        end
+
+        # This function handles all the post-install scripts
+        # It requires a definition to find all the necessary information
+        def handle_kickstart(options)
+
+          # Filtering post install files based upon --postinstall-include and --postinstall--exclude
+          definition.postinstall_files=filter_postinstall_files(options)
+          # Handling the kickstart by web
+          kickstartfiles=definition.kickstart_file
+
+          if kickstartfiles.nil? || kickstartfiles.length == 0
+            env.ui.info "Skipping webserver as no kickstartfile was specified"
+          end
+
+          env.ui.info "Starting a webserver #{definition.kickstart_ip}:#{definition.kickstart_port}\n"
+
+          # Check if the kickstart is an array or a single string
+          if kickstartfiles.is_a?(String)
+            # Let's turn it into an array
+            kickstartfiles=kickstartfiles.split
+          end
+
+          # For each kickstart file spinup a webserver and wait for the file to be fetched
+          unless kickstartfiles.nil?
+            kickstartfiles.each do |kickfile|
+              wait_for_http_request(kickfile,{
+                :port => definition.kickstart_port,
+                :host => definition.kickstart_ip,
+                :timeout => definition.kickstart_timeout,
+                :web_dir => definition.path
+              })
+            end
+          end
+        end
+
+        # This function handles all the post-install scripts
+        # It requires a box(to login to) and a definition(listing the postinstall files)
+        def handle_postinstall(options)
+          definition.postinstall_files.each do |postinstall_file|
+            # Filenames of postinstall_files are relative to their definition
+            filename=File.join(definition.path,postinstall_file)
+            unless File.basename(postinstall_file)=~/^_/
+              self.scp(filename,File.basename(filename))
+              self.exec("chmod +x \"#{File.basename(filename)}\"")
+              self.exec(sudo("./"+File.basename(filename)))
+            else
+              env.logger.info "Skipping postinstallfile #{postinstall_file}"
+            end
+          end
+        end
+
+        # Transfer information provide by the Provider to the box
+        #
+        #
+        def transfer_buildinfo(options)
+          build_info.each do |info|
+            begin
+              infofile=Tempfile.open("#{info[:filename]}")
+              infofile.puts "#{info[:content]}"
+              infofile.rewind
+              infofile.close
+              self.scp(infofile.path,info[:filename])
+              infofile.delete
+            rescue RuntimeError => ex
+              env.ui.error "Error transfering file #{info[:filename]} failed, possible not enough permissions to write? #{ex}"
+              raise Veewee::Error,"Error transfering file #{info[:filename]} failed, possible not enough permissions to write? #{ex}"
+            end
+          end
+        end
+
+
+      end #Module
+    end #Module
+  end #Module
+end #Module

data/lib/veewee/provider/core/box/exec.rb

@@ -0,0 +1,34 @@
+require 'veewee/provider/core/helper/ssh'
+module Veewee
+  module Provider
+    module  Core
+      module BoxCommand
+
+        def ssh_command_string
+         "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p #{ssh_options[:port]} -l #{definition.ssh_user} #{self.ip_address}"
+        end
+
+        def exec(command,options={})
+          raise Veewee::Error,"Box is not running" unless self.running?
+          begin
+            new_options=ssh_options.merge(options)
+            self.when_ssh_login_works(self.ip_address,new_options) do
+              begin
+                env.logger.info "About to execute remote command #{command} on box #{name} - #{self.ip_address} - #{new_options}"
+                result=self.ssh_execute(self.ip_address,command,new_options)
+                return result
+              rescue RuntimeError => ex
+                env.ui.error "Error executing command #{command} : #{ex}"
+                raise Veewee::SshError, ex
+              end
+            end
+          rescue Net::SSH::AuthenticationFailed => ex
+            env.ui.error "Authentication failure"
+            raise Veewee::SshError, ex
+          end
+
+        end
+      end # Module
+    end # Module
+  end # Module
+end # Module

data/lib/veewee/provider/core/box/floppy.rb

@@ -0,0 +1,31 @@
+module Veewee
+  module Provider
+    module Core
+      module BoxCommand
+        def create_floppy(filename)
+          # Todo Check for java
+          # Todo check output of commands
+
+          # Check for floppy
+          unless definition.floppy_files.nil?
+            require 'tmpdir'
+            temp_dir=Dir.mktmpdir
+            definition.floppy_files.each do |filename|
+              full_filename=full_filename=File.join(definition.path,filename)
+              FileUtils.cp("#{full_filename}","#{temp_dir}")
+            end
+            javacode_dir=File.expand_path(File.join(__FILE__,'..','..','..','..','..','java'))
+            floppy_file=File.join(definition.path,filename)
+            if File.exists?(floppy_file)
+              env.logger.info "Removing previous floppy file"
+              FileUtils.rm(floppy_file)
+            end
+            command="java -jar #{javacode_dir}/dir2floppy.jar '#{temp_dir}' '#{floppy_file}'"
+            shell_exec("#{command}")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/veewee/provider/core/box/halt.rb

@@ -0,0 +1,24 @@
+require 'veewee/provider/core/helper/ssh'
+module Veewee
+  module Provider
+    module  Core
+      module BoxCommand
+
+        def halt(options={})
+          if self.running?
+            if options["force"]==true
+              self.poweroff
+            else
+              self.exec("echo '#{definition.shutdown_cmd}' > /tmp/shutdown.sh")
+              self.exec("chmod +x /tmp/shutdown.sh")
+              self.exec(sudo("/tmp/shutdown.sh"))
+            end
+          else
+            raise Veewee::Error,"Box is not running"
+          end
+        end
+
+      end # Module
+    end # Module
+  end # Module
+end # Module

data/lib/veewee/provider/core/box/issh.rb

@@ -0,0 +1,15 @@
+require 'veewee/provider/core/helper/ssh'
+module Veewee
+  module Provider
+    module  Core
+      module BoxCommand
+
+        def issh(command=nil,options={})
+          self.ssh(command,options.merge({:interactive => true}))
+        end
+
+      end # Module
+    end # Module
+  end # Module
+end # Module
+

data/lib/veewee/provider/core/box/poweroff.rb

@@ -0,0 +1,12 @@
+module Veewee
+  module Provider
+    module  Core
+      module BoxCommand
+
+        def poweroff(options={})
+        end
+
+      end # Module
+    end # Module
+  end # Module
+end # Module

data/lib/veewee/provider/core/box/scp.rb

@@ -0,0 +1,29 @@
+require 'veewee/provider/core/helper/ssh'
+module Veewee
+  module Provider
+    module  Core
+      module BoxCommand
+
+        def scp(localfile,remotefile,options={})
+          raise Veewee::Error,"Box is not running" unless self.running?
+          begin
+            new_options=ssh_options.merge(options)
+            self.when_ssh_login_works(self.ip_address,new_options) do
+              begin
+                env.logger.info "About to transfer #{localfile} to #{remotefile} to the box #{name} - #{self.ip_address} - #{new_options}"
+                self.ssh_transfer_file(self.ip_address,localfile,remotefile,new_options)
+              rescue RuntimeError => ex
+                env.ui.error "Error transfering file #{localfile} failed, possible not enough permissions to write? #{ex}"
+                raise Veewee::SshError,ex
+              end
+            end
+          rescue Net::SSH::AuthenticationFailed => ex
+            env.ui.error "Authentication failure"
+            raise Veewee::SshError,ex
+          end
+
+        end
+      end # Module
+    end # Module
+  end # Module
+end # Module