boxgrinder-build 0.7.1 → 0.8.0

data/lib/boxgrinder-build/helpers/image-helper.rb

@@ -17,38 +17,39 @@
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
 require 'fileutils'
+require 'boxgrinder-core/helpers/log-helper'
 require 'boxgrinder-build/helpers/guestfs-helper'
 
 module BoxGrinder
   class ImageHelper
     def initialize(config, appliance_config, options = {})
-      @config                 = config
-      @appliance_config       = appliance_config
+      @config = config
+      @appliance_config = appliance_config
 
-      @log          = options[:log] || Logger.new(STDOUT)
-      @exec_helper  = options[:exec_helper] || ExecHelper.new(:log => @log)
+      @log = options[:log] || LogHelper.new
+      @exec_helper = options[:exec_helper] || ExecHelper.new(:log => @log)
     end
 
     def mount_image(disk, mount_dir)
-      offsets      = calculate_disk_offsets(disk)
+      offsets = calculate_disk_offsets(disk)
 
       @log.debug "Mounting image #{File.basename(disk)} in #{mount_dir}..."
       FileUtils.mkdir_p(mount_dir)
 
-      mounts       = {}
+      mounts = {}
 
       offsets.each do |offset|
-        loop_device   = get_loop_device
-        @exec_helper.execute("losetup -o #{offset.to_s} #{loop_device} #{disk}")
-        label         = @exec_helper.execute("e2label #{loop_device}").strip.chomp.gsub('_', '')
+        loop_device = get_loop_device
+        @exec_helper.execute("losetup -o #{offset.to_s} #{loop_device} '#{disk}'")
+        label = @exec_helper.execute("e2label #{loop_device}").strip.chomp.gsub('_', '')
         label = '/' if label == ''
         mounts[label] = loop_device
       end
 
-      @exec_helper.execute("mount #{mounts['/']} #{mount_dir}")
+      @exec_helper.execute("mount #{mounts['/']} '#{mount_dir}'")
 
       mounts.reject { |key, value| key == '/' }.each do |mount_point, loop_device|
-        @exec_helper.execute("mount #{loop_device} #{mount_dir}#{mount_point}")
+        @exec_helper.execute("mount #{loop_device} '#{mount_dir}#{mount_point}'")
       end
 
       @log.trace "Mounts:\n#{mounts}"
@@ -66,6 +67,33 @@ module BoxGrinder
       FileUtils.rm_rf(mount_dir)
     end
 
+    def disk_info(disk)
+      YAML.load(@exec_helper.execute("qemu-img info '#{disk}'"))
+    end
+
+    def convert_disk(disk, format, destination)
+      @log.debug "Conveting '#{disk}' disk to #{format} format and moving it to '#{destination}'..."
+
+      unless File.exists?(destination)
+        info = disk_info(disk)
+
+        if info['file format'] == format.to_s
+          @exec_helper.execute "cp '#{disk}' '#{destination}'"
+        else
+
+          format_with_options = format.to_s
+
+          if format == :vmdk
+            format_with_options += (`qemu-img --help | grep '\\-6'`.strip.chomp.empty? ? ' -o compat6' : ' -6')
+          end
+
+          @exec_helper.execute "qemu-img convert -f #{info['file format']} -O #{format_with_options} '#{disk}' '#{destination}'"
+        end
+      else
+        @log.debug "Destination already exists, skipping disk conversion."
+      end
+    end
+
     def get_loop_device
       begin
         loop_device = @exec_helper.execute("losetup -f 2>&1").strip
@@ -80,8 +108,8 @@ module BoxGrinder
       @log.debug "Calculating offsets for '#{File.basename(disk)}' disk..."
       loop_device = get_loop_device
 
-      @exec_helper.execute("losetup #{loop_device} #{disk}")
-      offsets     = @exec_helper.execute("parted #{loop_device} 'unit B print' | grep -e '^ [0-9]' | awk '{ print $2 }'").scan(/\d+/)
+      @exec_helper.execute("losetup #{loop_device} '#{disk}'")
+      offsets = @exec_helper.execute("parted #{loop_device} 'unit B print' | grep -e '^ [0-9]' | awk '{ print $2 }'").scan(/\d+/)
       # wait one secont before freeing loop device
       sleep 1
       @exec_helper.execute("losetup -d #{loop_device}")
@@ -93,21 +121,21 @@ module BoxGrinder
 
     def create_disk(disk, size)
       @log.trace "Preparing disk..."
-      @exec_helper.execute "dd if=/dev/zero of=#{disk} bs=1 count=0 seek=#{size * 1024}M"
+      @exec_helper.execute "dd if=/dev/zero of='#{disk}' bs=1 count=0 seek=#{size * 1024}M"
       @log.trace "Disk prepared"
     end
 
-    def create_filesystem(disk, options = {})
+    def create_filesystem(loop_device, options = {})
       options = {
-          :type   => @appliance_config.hardware.partitions['/']['type'],
-          :label  => '/'
+          :type => @appliance_config.hardware.partitions['/']['type'],
+          :label => '/'
       }.merge(options)
 
       @log.trace "Creating filesystem..."
 
       case options[:type]
         when 'ext3', 'ext4'
-          @exec_helper.execute "mke2fs -T #{options[:type]} -L '#{options[:label]}' -F #{disk}"
+          @exec_helper.execute "mke2fs -T #{options[:type]} -L '#{options[:label]}' -F #{loop_device}"
         else
           raise "Unsupported filesystem specified: #{options[:type]}"
       end
@@ -117,12 +145,12 @@ module BoxGrinder
 
     def sync_files(from_dir, to_dir)
       @log.debug "Syncing files between #{from_dir} and #{to_dir}..."
-      @exec_helper.execute "rsync -Xura #{from_dir}/* #{to_dir}"
+      @exec_helper.execute "rsync -Xura #{from_dir.gsub(' ', '\ ')}/* '#{to_dir}'"
       @log.debug "Sync finished."
     end
 
     def customize(disk_path)
-      GuestFSHelper.new(disk_path, :log => @log).customize do |guestfs, guestfs_helper|
+      GuestFSHelper.new(disk_path, :log => @log).customize(:ide_disk => ((@appliance_config.os.name == 'rhel' or @appliance_config.os.name == 'centos') and @appliance_config.os.version == '5') ? true : false) do |guestfs, guestfs_helper|
         yield guestfs, guestfs_helper
       end
     end

data/lib/boxgrinder-build/helpers/linux-helper.rb

@@ -16,12 +16,12 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
-require 'logger'
+require 'boxgrinder-core/helpers/log-helper'
 
 module BoxGrinder
   class LinuxHelper
     def initialize( options = {} )
-      @log = options[:log] || Logger.new(STDOUT)
+      @log = options[:log] || LogHelper.new
     end
 
     def kernel_version( guestfs )

data/lib/boxgrinder-build/helpers/package-helper.rb

@@ -16,15 +16,16 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'boxgrinder-core/helpers/log-helper'
+
 module BoxGrinder
   class PackageHelper
-    def initialize(config, appliance_config, dir, options = {})
-      @config           = config
+    def initialize(config, appliance_config, options = {})
+      @config = config
       @appliance_config = appliance_config
-      @dir              = dir
 
-      @log              = options[:log] || Logger.new(STDOUT)
-      @exec_helper      = options[:exec_helper] || ExecHelper.new({:log => @log})
+      @log = options[:log] || LogHelper.new
+      @exec_helper = options[:exec_helper] || ExecHelper.new(:log => @log)
     end
 
     def package(dir, package, type = :tar)
@@ -38,17 +39,13 @@ module BoxGrinder
       case type
         when :tar
           package_name = File.basename(package, '.tgz')
-          symlink      = "#{File.dirname(package)}/#{package_name}"
+          symlink = "#{File.dirname(package)}/#{package_name}"
 
           FileUtils.ln_s(File.expand_path(dir), symlink)
-
-          Dir.chdir(File.dirname(package)) do
-            @exec_helper.execute "tar -hcvzf #{package_name}.tgz #{package_name}"
-          end
-
+          @exec_helper.execute "tar -C '#{File.dirname(package)}' -hcvzf '#{package}' '#{package_name}'"
           FileUtils.rm(symlink)
         else
-          raise "Only tar format is currently supported."
+          raise "Specified format: '#{type}' is currently unsupported."
       end
 
       @log.info "Appliance #{@appliance_config.name} packaged."

data/lib/boxgrinder-build/helpers/plugin-helper.rb

@@ -16,14 +16,15 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
-require 'boxgrinder-build/managers/plugin-manager'
 require 'rubygems'
+require 'boxgrinder-build/managers/plugin-manager'
+require 'boxgrinder-core/helpers/log-helper'
 
 module BoxGrinder
   class PluginHelper
-    def initialize( options = {} )
-      @log      = options[:log] || Logger.new(STDOUT)
-      @options  = options[:options]
+    def initialize( config, options = {} )
+      @options  = config
+      @log      = options[:log] || LogHelper.new
     end
 
     def load_plugins
@@ -40,27 +41,18 @@ module BoxGrinder
       self
     end
 
-    def parse_plugin_list
-      plugins = []
-
-      unless @options.plugins.nil?
-        plugins = @options.plugins.gsub('\'', '').gsub('"', '').split(',')
-        plugins.each { |plugin| plugin.chomp!; plugin.strip! }
-      end
-
-      plugins
-    end
-
     def read_and_require
-      plugins = %w(boxgrinder-build-fedora-os-plugin boxgrinder-build-rhel-os-plugin boxgrinder-build-centos-os-plugin boxgrinder-build-ec2-platform-plugin boxgrinder-build-vmware-platform-plugin boxgrinder-build-s3-delivery-plugin boxgrinder-build-sftp-delivery-plugin boxgrinder-build-local-delivery-plugin boxgrinder-build-ebs-delivery-plugin) + parse_plugin_list
+      plugins = %w(boxgrinder-build-fedora-os-plugin boxgrinder-build-rhel-os-plugin boxgrinder-build-centos-os-plugin boxgrinder-build-ec2-platform-plugin boxgrinder-build-vmware-platform-plugin boxgrinder-build-virtualbox-platform-plugin boxgrinder-build-s3-delivery-plugin boxgrinder-build-sftp-delivery-plugin boxgrinder-build-local-delivery-plugin boxgrinder-build-ebs-delivery-plugin) + @options.additional_plugins
 
       plugins.flatten.each do |plugin|
-        @log.trace "Requiring plugin '#{plugin}'..."
+        @log.trace "Loading plugin '#{plugin}'..."
 
         begin
           require plugin
-        rescue LoadError
-          @log.warn "Specified gem: '#{plugin}' wasn't found. Make sure its name is correct, skipping..." unless plugin.match(/^boxgrinder-build-(.*)-plugin/)
+          @log.trace "- OK"
+        rescue LoadError => e
+          @log.trace "- Not found: #{e.message.strip.chomp}"
+          @log.warn "Specified plugin: '#{plugin}' wasn't found. Make sure its name is correct, skipping..." unless plugin.match(/^boxgrinder-build-(.*)-plugin/)
         end
       end
     end

data/lib/boxgrinder-build/helpers/thor-helper.rb

@@ -0,0 +1,82 @@
+# Copyright 2010 Red Hat, Inc.
+#
+# This is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation; either version 3 of
+# the License, or (at your option) any later version.
+#
+# This software is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this software; if not, write to the Free
+# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+# 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+
+require 'thor'
+
+class Thor
+  module CoreExt
+    class HashWithIndifferentAccess < ::Hash
+      def initialize(hash={})
+        super()
+        hash.each do |key, value|
+          self[convert_key(key)] = value
+        end
+
+        to_boolean(self)
+      end
+
+      def to_boolean(h)
+        h.each do |k, v|
+          if v.is_a?(Hash)
+            to_boolean(v)
+            next
+          end
+
+          next unless v.is_a?(String)
+
+          case v
+            when /^true$/i then
+              h[k] = true
+            when /^false$/i then
+              h[k] = false
+          end
+        end
+      end
+    end
+  end
+end
+
+module BoxGrinder
+  class ThorHelper < Thor
+    class << self
+      def help(shell)
+        boxgrinder_header(shell)
+        super(shell)
+      end
+
+      def task_help(shell, task_name)
+        boxgrinder_header(shell)
+
+        help_method = "#{task_name}_help".to_sym
+        send(help_method, shell) if respond_to?(help_method) and method(help_method).arity == 1
+        super(shell, task_name)
+
+        shell.say
+      end
+
+      def boxgrinder_header(shell)
+        shell.say
+        shell.say "BoxGrinder Build:"
+        shell.say "  A tool for building VM images from simple definition files."
+        shell.say
+        shell.say "Documentation:"
+        shell.say "  http://community.jboss.org/docs/DOC-14358"
+        shell.say
+      end
+    end
+  end
+end

data/lib/boxgrinder-build/managers/plugin-manager.rb

@@ -20,8 +20,8 @@ require 'singleton'
 
 module BoxGrinder
   module Plugins
-    def plugin( args )
-      PluginManager.instance.register_plugin( args )
+    def plugin(args)
+      PluginManager.instance.register_plugin(args)
     end
   end
 end
@@ -34,11 +34,11 @@ module BoxGrinder
     include Singleton
 
     def initialize
-      @plugins = { :delivery => {}, :os => {}, :platform => {}}
+      @plugins = {:delivery => {}, :os => {}, :platform => {}}
     end
 
-    def register_plugin( info )
-      validate_plugin_info( info )
+    def register_plugin(info)
+      validate_plugin_info(info)
 
       raise "We already have registered plugin for #{info[:name]}." unless @plugins[info[:name]].nil?
 
@@ -53,13 +53,13 @@ module BoxGrinder
       self
     end
 
-    def validate_plugin_info( info )
+    def validate_plugin_info(info)
       raise "No name specified for your plugin" if info[:name].nil?
       raise "No class specified for your plugin" if info[:class].nil?
       raise "No type specified for your plugin" if info[:type].nil?
     end
 
-    def initialize_plugin( type, name )
+    def initialize_plugin(type, name)
       plugins = @plugins[type]
       # this should never happen
       raise "There are no #{type} plugins." if plugins.nil?
@@ -68,26 +68,11 @@ module BoxGrinder
 
       begin
         plugin = plugin_info[:class].new
-      rescue => e
-        raise "Error while initializing #{plugin_info[:class]} plugin.", e
+      rescue
+        raise "Error while initializing '#{plugin_info[:class].to_s}' plugin."
       end
 
-      [ plugin, plugin_info ]
-    end
-
-    def plugin_types( type )
-      types = []
-
-      available_plugins_for_selected_type = @plugins[type]
-
-      unless available_plugins_for_selected_type.nil?
-        available_plugins_for_selected_type.each_value do |info|
-          types << info[:types] unless info[:types].nil?
-          types << info[:name]
-        end
-      end
-
-      types.flatten
+      [plugin, plugin_info]
     end
 
     attr_reader :plugins

data/lib/boxgrinder-build/plugins/base-plugin.rb

@@ -28,31 +28,31 @@ require 'logger'
 module BoxGrinder
   class BasePlugin
     def initialize
-      @plugin_config       = {}
+      @plugin_config = {}
 
-      @deliverables        = OpenCascade.new
-      @supported_oses      = OpenCascade.new
+      @deliverables = OpenCascade.new
+      @supported_oses = OpenCascade.new
       @target_deliverables = OpenCascade.new
-      @dir                 = OpenCascade.new
+      @dir = OpenCascade.new
     end
 
     def init(config, appliance_config, options = {})
-      @config                = config
-      @appliance_config      = appliance_config
-      @options               = options
-      @log                   = options[:log] || Logger.new(STDOUT)
-      @exec_helper           = options[:exec_helper] || ExecHelper.new(:log => @log)
-      @image_helper          = options[:image_helper] || ImageHelper.new(@config, @appliance_config, :log => @log)
-      @plugin_info           = options[:plugin_info]
-      @previous_plugin_info  = options[:previous_plugin_info]
-      @previous_deliverables = options[:previous_deliverables] || {}
+      @config = config
+      @appliance_config = appliance_config
+      @options = options
+      @log = options[:log] || Logger.new(STDOUT)
+      @exec_helper = options[:exec_helper] || ExecHelper.new(:log => @log)
+      @image_helper = options[:image_helper] || ImageHelper.new(@config, @appliance_config, :log => @log)
+      @previous_plugin_info = options[:previous_plugin_info]
+      @previous_deliverables = options[:previous_deliverables] || OpenCascade.new
 
-      @dir.base              = "#{@appliance_config.path.build}/#{@plugin_info[:name]}-plugin"
-      @dir.tmp               = "#{@dir.base}/tmp"
+      @plugin_info = options[:plugin_info]
 
-      @config_file           = "#{ENV['HOME']}/.boxgrinder/plugins/#{@plugin_info[:name]}"
+      @dir.base = "#{@appliance_config.path.build}/#{@plugin_info[:name]}-plugin"
+      @dir.tmp = "#{@dir.base}/tmp"
 
       read_plugin_config
+      merge_plugin_config
 
       @move_deliverables = true
       @initialized = true
@@ -67,7 +67,7 @@ module BoxGrinder
       raise "Please specify deliverables as Hash, not #{deliverable.class}." unless deliverable.is_a?(Hash)
 
       deliverable.each do |name, path|
-        @deliverables[name]        = "#{@dir.tmp}/#{path}"
+        @deliverables[name] = "#{@dir.tmp}/#{path}"
         @target_deliverables[name] = "#{@dir.base}/#{path}"
       end
     end
@@ -80,6 +80,7 @@ module BoxGrinder
     end
 
     def is_supported_os?
+      return true if @supported_oses.empty?
       return false unless !@supported_oses[@appliance_config.os.name].nil? and @supported_oses[@appliance_config.os.name].include?(@appliance_config.os.version)
       true
     end
@@ -108,10 +109,8 @@ module BoxGrinder
     def validate_plugin_config(fields = [], doc = nil)
       more_info = doc.nil? ? '' : "See #{doc} for more info"
 
-      raise "Not valid configuration file for #{info[:name]} plugin. Please create valid '#{@config_file}' file. #{more_info}" if @plugin_config.nil?
-
       fields.each do |field|
-        raise "Please specify a valid '#{field}' key in plugin configuration file: '#{@config_file}'. #{more_info}" if @plugin_config[field].nil?
+        raise "Please specify a valid '#{field}' key in BoxGrinder configuration file: '#{@config.file}' or use CLI '--#{@plugin_info[:type]}-config #{field}:DATA' argument. #{more_info}" if @plugin_config[field].nil?
       end
     end
 
@@ -120,18 +119,18 @@ module BoxGrinder
     end
 
     def run(*args)
+      unless is_supported_os?
+        @log.error "#{@plugin_info[:full_name]} plugin supports following operating systems: #{supported_oses}. Your appliance contains #{@appliance_config.os.name} #{@appliance_config.os.version} operating system which is not supported by this plugin, sorry."
+        return
+      end
+
       FileUtils.rm_rf @dir.tmp
       FileUtils.mkdir_p @dir.tmp
 
       execute(*args)
 
-      after_execute
-    end
+      # TODO execute post commands for platform plugins here?
 
-    def after_init
-    end
-
-    def after_execute
       @deliverables.each do |name, path|
         @log.trace "Moving '#{path}' deliverable to target destination '#{@target_deliverables[name]}'..."
         FileUtils.mv(path, @target_deliverables[name])
@@ -140,6 +139,12 @@ module BoxGrinder
       FileUtils.rm_rf @dir.tmp
     end
 
+    def after_init
+    end
+
+    def after_execute
+    end
+
     def deliverables_exists?
       raise "You can only check deliverables after the plugin is initialized, please initialize the plugin using init method." if @initialized.nil?
 
@@ -163,16 +168,28 @@ module BoxGrinder
       @plugin_config[key] = @plugin_config[key].nil? ? value : @plugin_config[key]
     end
 
+    # This reads the plugin config from file
     def read_plugin_config
-      return unless File.exists?(@config_file)
+      return if @config[:plugins].nil? or @config[:plugins][@plugin_info[:name].to_s].nil?
 
-      @log.debug "Reading configuration file for #{self.class.name}."
+      @log.debug "Reading configuration for #{@plugin_info[:full_name]} plugin."
 
-      begin
-        @plugin_config = YAML.load_file(@config_file)
-      rescue
-        raise "An error occurred while reading configuration file '#{@config_file}' for #{self.class.name}. Is it a valid YAML file?"
-      end
+      @plugin_config = @config[:plugins][@plugin_info[:name].to_s]
+    end
+
+    # This merges the plugin config with configuration provided in command line
+    def merge_plugin_config
+      config =
+          case @plugin_info[:type]
+            when :os
+              @config.os_config
+            when :platform
+              @config.platform_config
+            when :delivery
+              @config.delivery_config
+          end
+
+      @plugin_config.merge!(config)
     end
   end
 end