boxgrinder-core 0.1.5 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+v0.2.0
+
+* [BGBUILD-133] Support a consolidated configuration file
+* [BGBUILD-68] Global .boxgrinder/config or rc style file for config
+* [BGBUILD-127] Use appliance definition object instead of a file when using BG as a library
+* [BGBUILD-79] Allow to use BoxGrinder Build as a library
+* [BGBUILD-93] Add Red Hat Enterprise Linux 6 support
+* [BGBUILD-101] Don't use 'includes' subsection when specifying packages
+* [BGBUILD-60] Post section merging pattern for appliances depending on the same appliance
+* [BGBUILD-151] Overriding hardware partitions via inclusion in Appliance Definition File causes build failure
+
+v0.1.6
+
+* [BGBUILD-100] Enable boxgrinder_build to create a Fedora image with encrypted partition(s)
 
 v0.1.5
 

data/Manifest

@@ -5,7 +5,6 @@ README
 Rakefile
 boxgrinder-core.gemspec
 lib/boxgrinder-core.rb
-lib/boxgrinder-core/defaults.rb
 lib/boxgrinder-core/helpers/appliance-config-helper.rb
 lib/boxgrinder-core/helpers/appliance-helper.rb
 lib/boxgrinder-core/helpers/exec-helper.rb
@@ -20,10 +19,14 @@ spec/helpers/appliance-config-helper-spec.rb
 spec/helpers/appliance-helper-spec.rb
 spec/helpers/exec-helper-spec.rb
 spec/helpers/log-helper-spec.rb
+spec/models/config-spec.rb
 spec/rspec/ls/one
 spec/rspec/ls/two
 spec/rspec/rspec-config-helper.rb
 spec/rspec/src/appliances/ephemeral-repo.appl
 spec/rspec/src/appliances/full.appl
+spec/rspec/src/appliances/invalid_yaml.appl
 spec/rspec/src/appliances/repo.appl
+spec/rspec/src/config/empty
+spec/rspec/src/config/valid
 spec/validators/appliance-config-validator-spec.rb

data/boxgrinder-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boxgrinder-core}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek Goldmann"]
-  s.date = %q{2010-12-17}
+  s.date = %q{2011-02-09}
   s.description = %q{Core library for BoxGrinder}
   s.email = %q{info@boxgrinder.org}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/defaults.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "boxgrinder-core.gemspec", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/defaults.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb", "rubygem-boxgrinder-core.spec", "spec/helpers/appliance-config-helper-spec.rb", "spec/helpers/appliance-helper-spec.rb", "spec/helpers/exec-helper-spec.rb", "spec/helpers/log-helper-spec.rb", "spec/rspec/ls/one", "spec/rspec/ls/two", "spec/rspec/rspec-config-helper.rb", "spec/rspec/src/appliances/ephemeral-repo.appl", "spec/rspec/src/appliances/full.appl", "spec/rspec/src/appliances/repo.appl", "spec/validators/appliance-config-validator-spec.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "boxgrinder-core.gemspec", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb", "rubygem-boxgrinder-core.spec", "spec/helpers/appliance-config-helper-spec.rb", "spec/helpers/appliance-helper-spec.rb", "spec/helpers/exec-helper-spec.rb", "spec/helpers/log-helper-spec.rb", "spec/models/config-spec.rb", "spec/rspec/ls/one", "spec/rspec/ls/two", "spec/rspec/rspec-config-helper.rb", "spec/rspec/src/appliances/ephemeral-repo.appl", "spec/rspec/src/appliances/full.appl", "spec/rspec/src/appliances/invalid_yaml.appl", "spec/rspec/src/appliances/repo.appl", "spec/rspec/src/config/empty", "spec/rspec/src/config/valid", "spec/validators/appliance-config-validator-spec.rb"]
   s.homepage = %q{http://www.jboss.org/boxgrinder}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Boxgrinder-core", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/boxgrinder-core.rb

@@ -15,5 +15,3 @@
 # 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-core/defaults'

data/lib/boxgrinder-core/helpers/appliance-config-helper.rb

@@ -23,7 +23,7 @@ module BoxGrinder
   class ApplianceConfigHelper
 
     def initialize(appliance_configs)
-      @appliance_configs  = appliance_configs.reverse
+      @appliance_configs = appliance_configs.reverse
     end
 
     def merge(appliance_config)
@@ -125,6 +125,7 @@ module BoxGrinder
             end
           end
 
+          partitions[root]['passphrase'] = partition['passphrase'] unless partition['passphrase'].nil?
           partitions[root]['options'] = partition['options'] unless partition['options'].nil?
         end
       end
@@ -133,14 +134,13 @@ module BoxGrinder
     end
 
     def default_filesystem_type
-      fs = 'ext3'
+      fs = 'ext4'
 
       case @appliance_config.os.name
-        when 'fedora'
-
+        when 'rhel', 'centos'
           case @appliance_config.os.version
-            when '13', '14'
-              fs = 'ext4'
+            when '5'
+              fs = 'ext3'
           end
       end
 
@@ -155,8 +155,6 @@ module BoxGrinder
       merge_field('os.name') { |name| @appliance_config.os.name = name.to_s }
       merge_field('os.version') { |version| @appliance_config.os.version = version.to_s }
       merge_field('os.password') { |password| @appliance_config.os.password = password.to_s }
-
-      @appliance_config.os.password = APPLIANCE_DEFAULTS[:os][:password] if @appliance_config.os.password.nil?
     end
 
     def prepare_appliances
@@ -191,16 +189,11 @@ module BoxGrinder
     end
 
     def merge_packages
-      @appliance_config.packages.includes.clear
-      @appliance_config.packages.excludes.clear
+      @appliance_config.packages.clear
 
       @appliance_configs.each do |appliance_config|
-        appliance_config.packages.includes.each do |package|
-          @appliance_config.packages.includes << package
-        end
-
-        appliance_config.packages.excludes.each do |package|
-          @appliance_config.packages.excludes << package
+        appliance_config.packages.each do |package|
+          @appliance_config.packages << package
         end
       end
     end
@@ -208,11 +201,15 @@ module BoxGrinder
     def merge_post_operations
       @appliance_config.post.each_value { |cmds| cmds.clear }
 
+      included = []
+
       @appliance_configs.each do |appliance_config|
+        next if included.include?(appliance_config)
         appliance_config.post.each do |platform, cmds|
           @appliance_config.post[platform] = [] if @appliance_config.post[platform].nil?
           cmds.each { |cmd| @appliance_config.post[platform] << substitute_vars(cmd) }
         end
+        included << appliance_config
       end
     end
 

data/lib/boxgrinder-core/helpers/appliance-helper.rb

@@ -25,49 +25,77 @@ module BoxGrinder
       @log = options[:log] || Logger.new(STDOUT)
     end
 
-    def read_definitions(definition_file, content_type = nil)
-      @log.debug "Reading definition from '#{definition_file}' file..."
-
-      definition_file_extension = File.extname(definition_file)
+    # Reads definition provided as string. This string can be a YAML document. In this case
+    # definition is parsed and an ApplianceConfig object is returned. In other cases it tries to search
+    # for a file with provided name.
+    def read_definitions(definition, content_type = nil)
       configs = []
 
-      appliance_config =
-          case definition_file_extension
-            when '.appl', '.yml', '.yaml'
-              read_yaml(definition_file)
-            when '.xml'
-              read_xml(definition_file)
-            else
-              unless content_type.nil?
-                case content_type
-                  when 'application/x-yaml', 'text/yaml'
-                    read_yaml(definition_file)
-                  when 'application/xml', 'text/xml', 'application/x-xml'
-                    read_xml(definition_file)
+      if File.exists?(definition)
+        @log.debug "Reading definition from '#{definition}' file..."
+
+        definition_file_extension = File.extname(definition)
+
+        appliance_config =
+            case definition_file_extension
+              when '.appl', '.yml', '.yaml'
+                read_yaml_file(definition)
+              when '.xml'
+                read_xml_file(definition)
+              else
+                unless content_type.nil?
+                  case content_type
+                    when 'application/x-yaml', 'text/yaml'
+                      read_yaml_file(definition)
+                    when 'application/xml', 'text/xml', 'application/x-xml'
+                      read_xml_file(definition)
+                  end
                 end
-              end
-          end
+            end
+
+        raise 'Unsupported file format for appliance definition file.' if appliance_config.nil?
 
-      raise 'Unsupported file format for appliance definition file' if appliance_config.nil?
+        configs << appliance_config
 
-      configs << appliance_config
+        appliance_config.appliances.reverse.each do |appliance_name|
+          configs << read_definitions("#{File.dirname(definition)}/#{appliance_name}#{definition_file_extension}").first
+        end unless appliance_config.appliances.nil? or !appliance_config.appliances.is_a?(Array)
+      else
+        @log.debug "Reading definition..."
 
-      appliance_config.appliances.reverse.each do |appliance_name|
-        configs << read_definitions("#{File.dirname(definition_file)}/#{appliance_name}#{definition_file_extension}").first
-      end unless appliance_config.appliances.nil? or !appliance_config.appliances.is_a?(Array)
+        appliance_config = read_yaml(definition)
+        configs << appliance_config
+      end
 
       [configs.flatten, appliance_config]
     end
 
-    def read_yaml(file)
+    def read_yaml(content)
+      begin
+        definition = YAML.load(content)
+        raise "Not a valid YAML content." if definition.nil? or definition == false
+      rescue
+        raise "Provided definition could not be read."
+      end
+
+      parse_yaml(definition)
+    end
+
+    def read_yaml_file(file)
       begin
         definition = YAML.load_file(file)
-        raise if definition.nil? or definition == false
+        raise "Not a valid YAML file." if definition.nil? or definition == false
       rescue
         raise "File '#{file}' could not be read."
       end
 
+      parse_yaml(definition)
+    end
+
+    # TODO this needs to be rewritten
+    def parse_yaml(definition)
       return definition if definition.is_a?(ApplianceConfig)
+      raise "Provided definition is not a Hash." unless definition.is_a?(Hash)
 
       appliance_config = ApplianceConfig.new
 
@@ -76,6 +104,7 @@ module BoxGrinder
 
       definition['variables'].each { |key, value| appliance_config.variables[key] = value } unless definition['variables'].nil?
 
+      appliance_config.packages = definition['packages'] unless definition['packages'].nil?
       appliance_config.appliances = definition['appliances'] unless definition['appliances'].nil?
       appliance_config.repos = definition['repos'] unless definition['repos'].nil?
 
@@ -84,12 +113,7 @@ module BoxGrinder
 
       unless definition['default_repos'].nil?
         appliance_config.default_repos = definition['default_repos']
-        raise "#{File.basename(file)}: default_repos should be set to true or false" unless appliance_config.default_repos.is_a?(TrueClass) or appliance_config.default_repos.is_a?(FalseClass)
-      end
-
-      unless definition['packages'].nil?
-        appliance_config.packages.includes = definition['packages']['includes'] unless definition['packages']['includes'].nil?
-        appliance_config.packages.excludes = definition['packages']['excludes'] unless definition['packages']['excludes'].nil?
+        raise "default_repos should be set to true or false" unless appliance_config.default_repos.is_a?(TrueClass) or appliance_config.default_repos.is_a?(FalseClass)
       end
 
       unless definition['os'].nil?
@@ -103,7 +127,12 @@ module BoxGrinder
         appliance_config.hardware.cpus = definition['hardware']['cpus'] unless definition['hardware']['cpus'].nil?
         appliance_config.hardware.memory = definition['hardware']['memory'] unless definition['hardware']['memory'].nil?
         appliance_config.hardware.network = definition['hardware']['network'] unless definition['hardware']['network'].nil?
-        appliance_config.hardware.partitions = definition['hardware']['partitions'] unless definition['hardware']['partitions'].nil?
+
+        unless definition['hardware']['partitions'].nil?
+          definition['hardware']['partitions'].each do |key, part|
+            appliance_config.hardware.partitions[key] = part
+          end if definition['hardware']['partitions'].is_a?(Hash)
+        end
       end
 
       definition['post'].each { |key, value| appliance_config.post[key] = value } unless definition['post'].nil?
@@ -111,8 +140,8 @@ module BoxGrinder
       appliance_config
     end
 
-    def read_xml(file)
-      raise "Reading XML files is not supported right now. File '#{file}' could not be read"
+    def read_xml_file(file)
+      raise "Reading XML files is not supported right now. File '#{file}' could not be read."
     end
   end
 end

data/lib/boxgrinder-core/helpers/exec-helper.rb

@@ -31,6 +31,9 @@ module BoxGrinder
 
       output = ""
 
+      # dirty workaround for ruby segfaults related to logger.rb
+      STDOUT.flush
+
       begin
         status = Open4::popen4( command ) do |pid, stdin, stdout, stderr|
           threads = []

data/lib/boxgrinder-core/helpers/log-helper.rb

@@ -17,7 +17,6 @@
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
 require 'logger'
-require 'boxgrinder-core/defaults'
 require 'fileutils'
 
 Logger.const_set(:TRACE, 0)
@@ -53,8 +52,8 @@ module BoxGrinder
     }
 
     def initialize(options = {})
-      location      = options[:location] || DEFAULT_LOCATION[:log]
-      threshold     = options[:threshold] || :info
+      location      = options[:location] || 'log/boxgrinder.log'
+      threshold     = options[:level].nil? ? :info : options[:level].to_sym
       type          = options[:type] || [:stdout, :file]
 
       unless type.is_a?(Array)

data/lib/boxgrinder-core/models/appliance-config.rb

@@ -17,7 +17,6 @@
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
 require 'rubygems'
-require 'boxgrinder-core/defaults'
 require 'hashery/opencascade'
 
 module BoxGrinder
@@ -32,21 +31,18 @@ module BoxGrinder
 
       @os.name             = nil
       @os.version          = nil
-      @os.password         = nil
+      @os.password         = 'boxgrinder'
 
       @hardware            = OpenCascade.new
 
-      @hardware.cpus       = APPLIANCE_DEFAULTS[:hardware][:cpus]
-      @hardware.memory     = APPLIANCE_DEFAULTS[:hardware][:memory]
-      @hardware.network    = APPLIANCE_DEFAULTS[:hardware][:network]
-      @hardware.partitions = APPLIANCE_DEFAULTS[:hardware][:partitions]
+      @hardware.cpus       = 1
+      @hardware.memory     = 256
+      @hardware.network    = 'NAT'
+      @hardware.partitions = {"/" => { 'size' => 1 }}
 
       @post                = {}
 
-      @packages            = OpenCascade.new
-      @packages.includes   = []
-      @packages.excludes   = []
-
+      @packages            = []
       @appliances          = []
       @repos               = []
 
@@ -58,7 +54,6 @@ module BoxGrinder
     attr_reader :os
     attr_reader :hardware
     attr_reader :path
-    attr_reader :file
     attr_reader :post
 
     attr_accessor :packages

data/lib/boxgrinder-core/models/config.rb

@@ -16,55 +16,46 @@
 # 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/defaults'
-require 'ostruct'
+require 'rubygems'
+require 'hashery/opencascade'
+require 'yaml'
 
 module BoxGrinder
-  class Config
-    def initialize
-
-      @name = DEFAULT_PROJECT_CONFIG[:name]
-
-      @dir = OpenStruct.new
-      @dir.root        = `pwd`.strip
-      @dir.base        = "#{File.dirname( __FILE__ )}/../../"
-      @dir.build       =  DEFAULT_PROJECT_CONFIG[:dir_build]
-      @dir.top         = "#{@dir.build}/topdir"
-      @dir.src_cache   =  DEFAULT_PROJECT_CONFIG[:dir_src_cache]
-      @dir.rpms_cache  =  DEFAULT_PROJECT_CONFIG[:dir_rpms_cache]
-      @dir.specs       =  DEFAULT_PROJECT_CONFIG[:dir_specs]
-      @dir.appliances  =  DEFAULT_PROJECT_CONFIG[:dir_appliances]
-      @dir.src         =  DEFAULT_PROJECT_CONFIG[:dir_src]
-      @dir.kickstarts  =  DEFAULT_PROJECT_CONFIG[:dir_kickstarts]
-
-      @config_file  = ENV['BG_CONFIG_FILE'] || "#{ENV['HOME']}/.boxgrinder/config"
-
-      @version = OpenStruct.new
-      @version.version = DEFAULT_PROJECT_CONFIG[:version]
-      @version.release = DEFAULT_PROJECT_CONFIG[:release]
-
-      @files = OpenStruct.new
-      @data = {}
-
-      if File.exists?( @config_file )
-        @data = YAML.load_file( @config_file )
-        @data['gpg_password'].gsub!(/\$/, "\\$") unless @data['gpg_password'].nil? or @data['gpg_password'].length == 0
-        @dir.rpms_cache = @data['rpms_cache'] || @dir.rpms_cache
-        @dir.src_cache  = @data['src_cache']  || @dir.src_cache
-      end
+  class Config < OpenCascade
+    def initialize(values = {})
+      super({})
+
+      merge!(
+          :file => ENV['BG_CONFIG_FILE'] || "#{ENV['HOME']}/.boxgrinder/config",
+          :name => 'BoxGrinder Build',
+          :platform => :none,
+          :delivery => :none,
+          :force => false,
+          :log_level => :info,
+          :dir => {
+              :root => Dir.pwd,
+              :build => 'build',
+              :cache => '/var/cache/boxgrinder' # required for appliance-creator
+          },
+          :os_config => {},
+          :platform_config => {},
+          :delivery_config => {},
+          :additional_plugins => []
+      )
+
+      merge!(values.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo })
+
+      deep_merge(self, YAML.load_file(self.file)) if File.exists?(self.file)
     end
 
-    def version_with_release
-      @version.version + ((@version.release.nil? or @version.release.empty?) ? "" : "-" + @version.release)
+    def deep_merge(first, second)
+      second.each_key do |k|
+        if first[k.to_sym].is_a?(Hash) and second[k].is_a?(Hash)
+          deep_merge(first[k.to_sym], second[k])
+        else
+          first[k.to_sym] = second[k]
+        end
+      end if second
     end
-
-    attr_accessor :name
-    attr_accessor :version
-    attr_accessor :release
-    attr_accessor :config_file
-    attr_reader :files
-
-    attr_reader :data
-    attr_reader :dir
   end
 end