boxgrinder-build 0.2.0 → 0.3.2

data/bin/boxgrinder-build

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+# JBoss, Home of Professional Open Source
+# Copyright 2009, Red Hat Middleware LLC, and individual contributors
+# by the @authors tag. See the copyright.txt in the distribution for a
+# full listing of individual contributors.
+#
+# 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 2.1 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 'rubygems'
+require 'commander/import'
+require 'boxgrinder-core/helpers/log-helper'
+require 'boxgrinder-build/helpers/plugin-helper'
+require 'boxgrinder-build/appliance'
+
+gem 'boxgrinder-core', '>= 0.0.6'
+gem 'aws-s3', '>= 0.6.2'
+gem 'amazon-ec2', '>= 0.9.6'
+gem 'net-sftp', '>= 2.0.4'
+gem 'net-ssh', '>= 2.0.20'
+gem 'rake', '>= 0.8.7'
+gem 'progressbar', '>= 0.9.0'
+gem 'commander', '>= 4.0.3'
+
+# :name is optional, otherwise uses the basename of this executable
+
+#$stderr.reopen('/dev/null')
+
+program :name, 'BoxGrinder'
+program :version, '0.3.0'
+program :description, 'A tool for building VM images from simple definition files.'
+default_command :build
+
+global_option('-V', '--verbose', TrueClass, "Prints verbose information while building. Default: false.") { ENV['BG_LOG_THRESHOLD'] = 'debug'}
+
+module BoxGrinder
+  log = LogHelper.new
+
+  PluginHelper.new( :log => log ).load_plugins
+
+  command :build do |c|
+    c.syntax      = 'build appliance_definition.appl [options]'
+    c.description = 'Creates a base image for selected appliance definition.'
+
+    c.option '-p STRING', '--platform STRING', String, "The type of platform. Valid types are: #{PlatformPluginManager.instance.plugins.keys.join(', ')}. Default: none."
+    c.option '-d STRING', '--delivery STRING', String, "The delivery type for selected image. Valid types are: #{DeliveryPluginManager.instance.types.keys.join(', ')}. Default: none."
+    c.option '-f', '--force', TrueClass, "Force image creation - removes all previous builds for selected appliance. Default: false."
+    #c.option '-V', '--verbose', TrueClass, "Prints verbose information while building. Default: false."
+
+    c.action do |args, options|
+      options.default :platform => :none
+      options.default :delivery => :none
+      options.default :force    => false
+      options.default :verbose  => false
+
+      options.platform  = options.platform.to_s.downcase.to_sym
+      options.delivery  = options.delivery.to_s.downcase.to_sym
+
+      appliance_definition_file = args.shift or raise('Appliance definition file is required. Run boxgrinder-build -h for more info')
+
+      raise("Appliance definition file '#{appliance_definition_file}' could not be found") unless File.exists?( appliance_definition_file )
+      raise "Not known platform: #{options.platform}. Available platforms: #{PlatformPluginManager.instance.plugins.keys.join(', ')}." if PlatformPluginManager.instance.plugins[options.platform].nil? and options.platform != :none
+      raise "Not known delivery type: #{options.delivery}. Available types: #{DeliveryPluginManager.instance.types.keys.join(', ')}." if DeliveryPluginManager.instance.types.keys.include?(options.delivery).nil?  and options.delivery != :none
+
+      Appliance.new( appliance_definition_file, :options => options, :log => log ).create
+    end
+  end
+end

data/docs/examples/appliances/appliances.appl

@@ -0,0 +1,5 @@
+name: appliances
+summary: This is an appliance with multiple appliances
+appliances:
+  - minimal
+  - packages

data/docs/examples/appliances/minimal.appl

@@ -0,0 +1,9 @@
+name: minimal
+summary: This is an appliance with minimal package set
+os:
+  name: fedora
+  version: 12
+hardware:
+  partitions:
+    /:
+      size: 2

data/docs/examples/appliances/mix.appl

@@ -0,0 +1,8 @@
+name: mix
+summary: This is an appliance with additional packages and appliances
+appliances:
+  - packages
+packages:
+  includes:
+    - texlive-latex
+    - subversion

data/docs/examples/appliances/packages.appl

@@ -0,0 +1,13 @@
+name: packages
+summary: This is an appliance with additional packages
+os:
+  name: fedora
+  version: 12
+hardware:
+  partitions:
+    /:
+      size: 1
+packages:
+  includes:
+    - mc
+    - subversion

data/lib/boxgrinder-build/appliance.rb

@@ -19,34 +19,101 @@
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
 require 'rake/tasklib'
-
-require 'boxgrinder-build/appliance-kickstart.rb'
-require 'boxgrinder-build/images/raw-image.rb'
-require 'boxgrinder-build/images/vmware-image'
-require 'boxgrinder-build/images/ec2-image'
-require 'boxgrinder-build/helpers/release-helper'
-require 'boxgrinder-build/validators/appliance-dependency-validator'
+require 'boxgrinder-core/models/appliance-config'
+require 'boxgrinder-core/models/config'
+require 'boxgrinder-core/helpers/appliance-helper'
+require 'boxgrinder-core/helpers/appliance-config-helper'
+require 'boxgrinder-core/validators/appliance-config-validator'
 
 module BoxGrinder
   class Appliance < Rake::TaskLib
 
-    def initialize( config, appliance_config, options = {} )
-      @config            = config
-      @appliance_config  = appliance_config
+    def initialize(  appliance_definition_file, options = {} )
+      @config            = Config.new
+      @appliance_definition_file  = appliance_definition_file
       @log               = options[:log] || Logger.new(STDOUT)
+      @options           = options[:options]
+    end
+
+    def create
+      appliance_configs, appliance_config = ApplianceHelper.new( :log => @log ).read_definitions( @appliance_definition_file )
+      appliance_config_helper             = ApplianceConfigHelper.new( appliance_configs )
+
+      @appliance_config = appliance_config_helper.merge(appliance_config.clone.init_arch).initialize_paths
+
+      ApplianceConfigValidator.new( @appliance_config, :os_plugins => OperatingSystemPluginManager.instance.plugins ).validate
+
+      if @options.force
+        @log.info "Removing previous builds for #{@appliance_config.name} appliance..."
+        FileUtils.rm_rf( @appliance_config.path.dir.build )
+        @log.debug "Previous builds removed."
+      end
+
+      base_deliverables       = execute_os_plugin
+      platform_deliverables   = execute_platform_plugin( base_deliverables )
+
+      execute_delivery_plugin( platform_deliverables )
+    end
+
+    def execute_os_plugin
+      os_plugin = OperatingSystemPluginManager.instance.plugins[@appliance_config.os.name.to_sym]
+      os_plugin.init( @config, @appliance_config, :log => @log )
+
+      if deliverables_exists( os_plugin.deliverables )
+        @log.info "Deliverables for #{os_plugin.info[:name]} operating system plugin exists, skipping."
+        return os_plugin.deliverables
+      end
+
+      @log.debug "Executing operating system plugin for #{@appliance_config.os.name}..."
+      os_plugin.execute
+      @log.debug "Operating system plugin executed."
+
+      os_plugin.deliverables
+    end
+
+    def execute_platform_plugin( deliverables )
+      if @options.platform == :none
+        @log.debug "No platform selected, skipping platform conversion."
+        return deliverables
+      end
+
+      platform_plugin = PlatformPluginManager.instance.plugins[@options.platform]
+      platform_plugin.init( @config, @appliance_config, :log => @log )
+
+      if deliverables_exists( platform_plugin.deliverables )
+        @log.info "Deliverables for #{platform_plugin.info[:name]} platform plugin exists, skipping."
+        return platform_plugin.deliverables
+      end
+
+      @log.debug "Executing platform plugin for #{@options.platform}..."
+      platform_plugin.execute( deliverables[:disk] )
+      @log.debug "Platform plugin executed."
+
+      platform_plugin.deliverables
+    end
+
+    def execute_delivery_plugin( deliverables )
+      if @options.delivery == :none
+        @log.debug "No delivery method selected, skipping delivering."
+        return deliverables
+      end
 
-      define
+      delivery_plugin = DeliveryPluginManager.instance.types[@options.delivery]
+      delivery_plugin.init( @config, @appliance_config, :log => @log )
+      delivery_plugin.execute( deliverables, @options.delivery )
     end
 
-    def define
-      ApplianceKickstart.new( @config, @appliance_config, :log => @log )
-      ApplianceDependencyValidator.new( @config, @appliance_config, :log => @log )
+    # TODO: move this to plugin (os,platform,delivery)
+    def deliverables_exists( deliverables )
+      return false unless File.exists?(deliverables[:disk])
 
-      RAWImage.new( @config, @appliance_config, :log => @log  )
-      VMwareImage.new( @config, @appliance_config, :log => @log  )
-      EC2Image.new( @config, @appliance_config, :log => @log )
+      [:metadata, :other].each do |deliverable_type|
+        deliverables[deliverable_type].each_value do |file|
+          return false unless File.exists?(file)
+        end
+      end
 
-      ReleaseHelper.new( @config, @appliance_config, :log => @log )
+      true
     end
   end
 end

data/lib/boxgrinder-build/helpers/appliance-customize-helper.rb

@@ -39,9 +39,9 @@ module BoxGrinder
       @guestfs_helper = GuestFSHelper.new( @disk, :log => @log )
       @guestfs = @guestfs_helper.guestfs
 
-      yield self, @guestfs
+      yield @guestfs, @guestfs_helper
 
-      @guestfs.close
+      @guestfs_helper.clean_close
     end
 
     def validate_options( options )

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

@@ -26,6 +26,8 @@ module BoxGrinder
       @raw_disk = raw_disk
       @log      = options[:log] || Logger.new(STDOUT)
 
+      @partitions = {}
+
       launch
     end
 
@@ -53,26 +55,27 @@ module BoxGrinder
 
       @log.debug "Launching guestfs..."
       @guestfs.launch
-      @log.debug "Waiting for guestfs..."
-      @guestfs.wait_ready
+
+      mount_partition( @guestfs.list_partitions.first, '/' ) if @guestfs.list_partitions.size == 1
+      mount_partition( @guestfs.list_devices.first, '/' ) if @guestfs.list_partitions.size == 0
+
       @log.debug "Guestfs launched."
+    end
 
-      if @guestfs.list_partitions.size > 0
-        partition_to_mount = "/dev/sda1"
-      else
-        partition_to_mount = "/dev/sda"
-      end
+    def clean_close
+      @log.debug "Closing guestfs..."
 
-      @log.debug "Mounting root partition..."
-      @guestfs.mount( partition_to_mount, "/" )
-      @log.debug "Root partition mounted."
+      @guestfs.sync
+      @guestfs.umount_all
+      @guestfs.close
 
-      # TODO is this really needed?
-      @log.debug "Uploading '/etc/resolv.conf'..."
-      @guestfs.upload( "/etc/resolv.conf", "/etc/resolv.conf" )
-      @log.debug "'/etc/resolv.conf' uploaded."
+      @log.debug "Guestfs closed."
+    end
 
-      @log.debug "Guestfs launched."
+    def mount_partition( part, mount_point )
+      @log.debug "Mounting #{part} partition to #{mount_point}..."
+      @guestfs.mount_options( "", part, mount_point )
+      @log.debug "Partition mounted."
     end
 
     # TODO this is shitty, I know... https://bugzilla.redhat.com/show_bug.cgi?id=507188

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

@@ -0,0 +1,65 @@
+# JBoss, Home of Professional Open Source
+# Copyright 2009, Red Hat Middleware LLC, and individual contributors
+# by the @authors tag. See the copyright.txt in the distribution for a
+# full listing of individual contributors.
+#
+# 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 2.1 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.
+
+module BoxGrinder
+  class PackageHelper
+    def initialize(config, appliance_config, options = {})
+      @config           = config
+      @appliance_config = appliance_config
+
+      @log              = options[:log] || Logger.new(STDOUT)
+      @exec_helper      = options[:exec_helper] || ExecHelper.new({:log => @log})
+    end
+
+    def package(deliverables, type = :tar)
+      files = []
+      files << File.basename(deliverables[:disk])
+
+      [:metadata, :other].each do |deliverable_type|
+        deliverables[deliverable_type].each_value do |file|
+          files << File.basename(file)
+        end
+      end
+
+      deliverable_platform  = deliverables[:platform].nil? ? "" : deliverables[:platform]
+      package_path          = "#{@appliance_config.path.dir.packages}/#{@appliance_config.name}-#{@appliance_config.version}.#{@appliance_config.release}-#{@appliance_config.hardware.arch}-#{deliverable_platform}.tgz"
+
+      if File.exists?(package_path)
+        @log.info "Package of #{type} type for #{@appliance_config.name} appliance and #{deliverable_platform} platform already exists, skipping."
+        return package_path
+      end
+
+      FileUtils.mkdir_p(File.dirname(package_path))
+
+      @log.info "Packaging #{@appliance_config.name} appliance for #{deliverable_platform} platform to #{type}..."
+
+      case type
+        when :tar
+          @exec_helper.execute "tar -C #{File.dirname(deliverables[:disk])} -cvzf '#{package_path}' #{files.join(' ')}"
+        else
+          raise "Only tar format is currently supported."
+      end
+
+      @log.info "Appliance #{@appliance_config.name} packaged."
+
+      package_path
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# JBoss, Home of Professional Open Source
+# Copyright 2009, Red Hat Middleware LLC, and individual contributors
+# by the @authors tag. See the copyright.txt in the distribution for a
+# full listing of individual contributors.
+#
+# 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 2.1 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 'boxgrinder-build/managers/operating-system-plugin-manager'
+require 'boxgrinder-build/managers/platform-plugin-manager'
+require 'boxgrinder-build/managers/delivery-plugin-manager'
+
+module BoxGrinder
+  class PluginHelper
+    def initialize( options = {} )
+      @log = options[:log] || Logger.new(STDOUT)
+    end
+
+    def load_plugins
+      Dir["#{File.dirname( __FILE__ )}/../plugins/**/*-plugin.rb"].each { |file| require "boxgrinder-build/plugins/#{file.scan(/\/plugins\/(.*)\.rb$/).to_s}" }
+
+      @os_plugins       = OperatingSystemPluginManager.instance.initialize_plugins( :log => @log ).plugins
+      @platform_plugins = PlatformPluginManager.instance.initialize_plugins( :log => @log ).plugins
+      @delivery_plugins = DeliveryPluginManager.instance.initialize_plugins( :log => @log ).plugins
+
+      print_plugins( 'os' ) { @os_plugins }
+      print_plugins( 'platform' ) { @platform_plugins }
+      print_plugins( 'delivery' ) { @delivery_plugins }
+
+      self
+    end
+
+    def print_plugins( type )
+      @log.debug "Loading #{type} plugins..."
+
+      plugins = yield
+
+      @log.debug "We have #{plugins.size} #{type} plugin(s) registered"
+
+      plugins.each_value do |plugin|
+        @log.debug "- plugin for #{plugin.info[:full_name]}."
+      end
+
+      @log.debug "Plugins loaded."
+    end
+
+    def deliverables_exists?( deliverables )
+      return false unless File.exists?(deliverables[:disk])
+
+      [:metadata, :other].each do |deliverable_type|
+        deliverables[deliverable_type].each_value do |file|
+          return false unless File.exists?(file)
+        end
+      end
+
+      true
+    end
+
+    def deliverables_array( deliverables )
+      files = []
+
+      files << deliverables[:disk]
+
+      [:metadata, :other].each do |deliverable_type|
+        deliverables[deliverable_type].each_value do |file|
+          file << file
+        end
+      end
+
+      files
+    end
+
+    attr_reader :os_plugins
+    attr_reader :platform_plugins
+    attr_reader :delivery_plugins
+  end
+end

data/lib/boxgrinder-build/{defaults.rb → managers/base-plugin-manager.rb}

@@ -18,12 +18,45 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'singleton'
+
 module BoxGrinder
-  AWS_DEFAULTS = {
-          :bucket_prefix => "#{DEFAULT_PROJECT_CONFIG[:name].downcase}/#{DEFAULT_PROJECT_CONFIG[:version]}-#{DEFAULT_PROJECT_CONFIG[:release]}",
-          :kernel_id => { "i386" => "aki-a71cf9ce", "x86_64" => "aki-b51cf9dc" }, # EU: :kernel_id => { "i386" => "aki-61022915", "x86_64" => "aki-6d022919" },
-          :ramdisk_id => { "i386" => "ari-a51cf9cc", "x86_64" => "ari-b31cf9da" }, # EU: :ramdisk_id => { "i386" => "ari-63022917", "x86_64" => "ari-37022943" },
-          :kernel_rpm => { "i386" => "http://repo.oddthesis.org/packages/other/kernel-xen-2.6.21.7-2.fc8.i686.rpm", "x86_64" => "http://repo.oddthesis.org/packages/other/kernel-xen-2.6.21.7-2.fc8.x86_64.rpm" },
-          :modules => { "i386" => "http://s3.amazonaws.com/ec2-downloads/ec2-modules-2.6.21.7-2.ec2.v1.2.fc8xen-i686.tgz", "x86_64" => "http://s3.amazonaws.com/ec2-downloads/ec2-modules-2.6.21.7-2.ec2.v1.2.fc8xen-x86_64.tgz" }
-  }
-end
+  class BasePluginManager
+    include Singleton
+
+    def initialize
+      @plugin_classes = []
+      @plugins        = {}
+    end
+
+    def <<(plugin_class)
+      @plugin_classes << plugin_class
+    end
+
+    def initialize_plugins( options = {} )
+      log = options[:log] || Logger.new(STDOUT)
+
+      @plugin_classes.each do |plugin_class|
+        begin
+          plugin = plugin_class.new
+        rescue => e
+          raise "Error while initializing #{plugin_class} plugin.", e
+        end
+
+        next unless plugin.respond_to?(:info)
+
+        plugin.instance_variable_set( :@log, log )
+
+        if @plugins[plugin.info[:name]].nil?
+          @plugins[plugin.info[:name]] = plugin
+        else
+          raise "We already have registered plugin for #{plugin.info[:name]}."
+        end
+      end
+      self
+    end
+
+    attr_reader :plugins
+
+  end
+end

data/lib/{boxgrinder-build.rb → boxgrinder-build/managers/delivery-plugin-manager.rb}

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 # JBoss, Home of Professional Open Source
 # Copyright 2009, Red Hat Middleware LLC, and individual contributors
 # by the @authors tag. See the copyright.txt in the distribution for a
@@ -20,23 +18,22 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
-require 'rubygems'
-
-gem 'boxgrinder-core', '>= 0.0.4'
-gem 'aws-s3', '>= 0.6.2'
-gem 'amazon-ec2', '>= 0.9.6'
-gem 'net-sftp', '>= 2.0.4'
-gem 'net-ssh', '>= 2.0.20'
-gem 'rake', '>= 0.8.7'
+require 'boxgrinder-build/managers/base-plugin-manager'
 
-require 'boxgrinder-build/helpers/rake-helper'
-require 'rake'
+module BoxGrinder
+  class DeliveryPluginManager < BasePluginManager
+    def types
+      t = {}
 
-task :default do
-  puts "Run '#{Rake.application.name} -T' to get list of all available commands."
-end
+      @plugins.each_value do |plugin|
+        plugin.info[:type].each do |type|
+          t[type] = plugin
+        end
 
-BoxGrinder::RakeHelper.new( :version => "1.0.0.Beta2", :release => "SNAPSHOT" )
+      end
+      
+      t
+    end
 
-Rake.application.init('boxgrinder')
-Rake.application.top_level
+  end
+end

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

@@ -0,0 +1,6 @@
+require 'boxgrinder-build/managers/base-plugin-manager'
+
+module BoxGrinder
+  class OperatingSystemPluginManager < BasePluginManager
+  end
+end

data/{bin/boxgrinder → lib/boxgrinder-build/managers/platform-plugin-manager.rb}

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 # JBoss, Home of Professional Open Source
 # Copyright 2009, Red Hat Middleware LLC, and individual contributors
 # by the @authors tag. See the copyright.txt in the distribution for a
@@ -20,4 +18,9 @@
 # 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'
+require 'boxgrinder-build/managers/base-plugin-manager'
+
+module BoxGrinder
+  class PlatformPluginManager < BasePluginManager
+  end
+end