boxgrinder-core 0.2.0 → 0.2.1

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.2.1
+
+* [BGBUILD-142] Backtraces make output unreadable - add option to enable them, and disable by default
+* [BGBUILD-150] Cyclical inclusion dependencies in appliance definition files are not detected/handled
+
 v0.2.0
 
 * [BGBUILD-133] Support a consolidated configuration file

data/Manifest

@@ -1,32 +0,0 @@
-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

data/README

@@ -2,8 +2,8 @@ This gem contains core classes used across BoxGrinder projects.
 
 Project home page
 
-    http://www.jboss.org/boxgrinder
+    http://boxgrinder.org/
 
 Project documentation
 
-    http://community.jboss.org/docs/DOC-14358
+    http://boxgrinder.org/tutorials/

data/boxgrinder-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boxgrinder-core}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek Goldmann"]
-  s.date = %q{2011-02-09}
+  s.date = %q{2011-02-22}
   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/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.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-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-definition-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-definition-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/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/helpers/{appliance-helper.rb → appliance-definition-helper.rb}

@@ -20,17 +20,18 @@ require 'boxgrinder-core/models/appliance-config'
 require 'yaml'
 
 module BoxGrinder
-  class ApplianceHelper
+  class ApplianceDefinitionHelper
     def initialize(options = {})
       @log = options[:log] || Logger.new(STDOUT)
+      @appliance_configs = []
     end
 
+    attr_reader :appliance_configs
+
     # 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 = []
-
       if File.exists?(definition)
         @log.debug "Reading definition from '#{definition}' file..."
 
@@ -55,19 +56,19 @@ module BoxGrinder
 
         raise 'Unsupported file format for appliance definition file.' if appliance_config.nil?
 
-        configs << appliance_config
+        @appliance_configs << appliance_config
+        appliances = []
+
+        @appliance_configs.each { |config| appliances << config.name }
 
         appliance_config.appliances.reverse.each do |appliance_name|
-          configs << read_definitions("#{File.dirname(definition)}/#{appliance_name}#{definition_file_extension}").first
+          read_definitions("#{File.dirname(definition)}/#{appliance_name}#{definition_file_extension}") unless appliances.include?(appliance_name)
         end unless appliance_config.appliances.nil? or !appliance_config.appliances.is_a?(Array)
       else
         @log.debug "Reading definition..."
 
-        appliance_config = read_yaml(definition)
-        configs << appliance_config
+        @appliance_configs << read_yaml(definition)
       end
-
-      [configs.flatten, appliance_config]
     end
 
     def read_yaml(content)
@@ -104,7 +105,9 @@ 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?
+      raise "packages section should be an Array" if !definition['packages'].nil? and !definition['packages'].is_a?(Array)
+
+      appliance_config.packages = definition['packages'] if definition['packages'].is_a?(Array)
       appliance_config.appliances = definition['appliances'] unless definition['appliances'].nil?
       appliance_config.repos = definition['repos'] unless definition['repos'].nil?
 

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

@@ -32,7 +32,8 @@ module BoxGrinder
       output = ""
 
       # dirty workaround for ruby segfaults related to logger.rb
-      STDOUT.flush
+      STDOUT.sync = true
+      STDERR.sync = true
 
       begin
         status = Open4::popen4( command ) do |pid, stdin, stdout, stderr|

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

@@ -32,6 +32,7 @@ module BoxGrinder
           :delivery => :none,
           :force => false,
           :log_level => :info,
+          :backtrace => false,
           :dir => {
               :root => Dir.pwd,
               :build => 'build',

data/rubygem-boxgrinder-core.spec

@@ -5,11 +5,11 @@
 
 Summary: Core library for BoxGrinder
 Name: rubygem-%{gemname}
-Version: 0.2.0
+Version: 0.2.1
 Release: 1%{?dist}
 Group: Development/Languages
 License: LGPLv3+
-URL: http://www.jboss.org/boxgrinder
+URL: http://boxgrinder.org/
 Source0: http://rubygems.org/gems/%{gemname}-%{version}.gem
 BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
 
@@ -74,6 +74,11 @@ popd
 %{gemdir}/doc/%{gemname}-%{version}
 
 %changelog
+* Tue Feb 16 2011  <mgoldman@redhat.com> - 0.2.1-1
+- Upstream release: 0.2.1
+- [BGBUILD-142] Backtraces make output unreadable - add option to enable them, and disable by default
+- [BGBUILD-150] Cyclical inclusion dependencies in appliance definition files are not detected/handled
+
 * Tue Jan 04 2011  <mgoldman@redhat.com> - 0.2.0-1
 - Upstream release: 0.2.0
 - Added BuildRoot tag to build for EPEL 5

data/spec/helpers/{appliance-helper-spec.rb → appliance-definition-helper-spec.rb}

@@ -16,13 +16,13 @@
 # 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/appliance-helper'
+require 'boxgrinder-core/helpers/appliance-definition-helper'
 
 module BoxGrinder
-  describe ApplianceHelper do
+  describe ApplianceDefinitionHelper do
 
     before(:each) do
-      @helper = ApplianceHelper.new(:log => Logger.new('/dev/null'))
+      @helper = ApplianceDefinitionHelper.new(:log => Logger.new('/dev/null'))
     end
 
     describe ".read_definitions" do
@@ -30,9 +30,13 @@ module BoxGrinder
         appliance_config = ApplianceConfig.new
 
         ['appl', 'yml', 'yaml'].each do |ext|
+          @helper = ApplianceDefinitionHelper.new(:log => Logger.new('/dev/null'))
           File.should_receive(:exists?).with("file.#{ext}").and_return(true)
           @helper.should_receive(:read_yaml_file).with("file.#{ext}").and_return(appliance_config)
-          @helper.read_definitions("file.#{ext}").should == [[appliance_config], appliance_config]
+          @helper.read_definitions("file.#{ext}")
+
+          configs = @helper.appliance_configs
+          configs.should == [appliance_config]
         end
       end
 
@@ -40,9 +44,14 @@ module BoxGrinder
         appliance_config = ApplianceConfig.new
 
         ['application/x-yaml', 'text/yaml'].each do |type|
+          @helper = ApplianceDefinitionHelper.new(:log => Logger.new('/dev/null'))
           File.should_receive(:exists?).with("file").and_return(true)
           @helper.should_receive(:read_yaml_file).with("file").and_return(appliance_config)
-          @helper.read_definitions("file", type).should == [[appliance_config], appliance_config]
+          @helper.read_definitions("file", type)
+
+          configs = @helper.appliance_configs
+          configs.should == [appliance_config]
+          configs.first.should == appliance_config
         end
       end
 
@@ -50,9 +59,14 @@ module BoxGrinder
         appliance_config = ApplianceConfig.new
 
         ['application/xml', 'text/xml', 'application/x-xml'].each do |type|
+          @helper = ApplianceDefinitionHelper.new(:log => Logger.new('/dev/null'))
           File.should_receive(:exists?).with("file").and_return(true)
           @helper.should_receive(:read_xml_file).with("file").and_return(appliance_config)
-          @helper.read_definitions("file", type).should == [[appliance_config], appliance_config]
+          @helper.read_definitions("file", type)
+
+          configs = @helper.appliance_configs
+          configs.should == [appliance_config]
+          configs.first.should == appliance_config
         end
       end
 
@@ -70,7 +84,11 @@ module BoxGrinder
         @helper.should_receive(:read_yaml_file).ordered.with('a.appl').and_return(appliance_a)
         @helper.should_receive(:read_yaml_file).ordered.with('./b.appl').and_return(appliance_b)
 
-        @helper.read_definitions("a.appl").should == [[appliance_a, appliance_b], appliance_a]
+        @helper.read_definitions("a.appl")
+
+        configs = @helper.appliance_configs
+        configs.should == [appliance_a, appliance_b]
+        configs.first.should == appliance_a
       end
 
       it "should read definitions from a tree file structure" do
@@ -105,7 +123,11 @@ module BoxGrinder
         @helper.should_receive(:read_yaml_file).ordered.with('./b1.appl').and_return(appliance_b1)
         @helper.should_receive(:read_yaml_file).ordered.with('./c1.appl').and_return(appliance_c1)
 
-        @helper.read_definitions("a.appl").should == [[appliance_a, appliance_b2, appliance_c2, appliance_b1, appliance_c1], appliance_a]
+        @helper.read_definitions("a.appl")
+
+        configs = @helper.appliance_configs
+        configs.should == [appliance_a, appliance_b2, appliance_c2, appliance_b1, appliance_c1]
+        configs.first.should == appliance_a
       end
 
       # https://issues.jboss.org/browse/BGBUILD-60
@@ -130,15 +152,18 @@ module BoxGrinder
         File.should_receive(:exists?).ordered.with('./b2.appl').and_return(true)
         File.should_receive(:exists?).ordered.with('./c.appl').and_return(true)
         File.should_receive(:exists?).ordered.with('./b1.appl').and_return(true)
-        File.should_receive(:exists?).ordered.with('./c.appl').and_return(true)
 
         @helper.should_receive(:read_yaml_file).ordered.with('a.appl').and_return(appliance_a)
         @helper.should_receive(:read_yaml_file).ordered.with('./b2.appl').and_return(appliance_b2)
         @helper.should_receive(:read_yaml_file).ordered.with('./c.appl').and_return(appliance_c)
         @helper.should_receive(:read_yaml_file).ordered.with('./b1.appl').and_return(appliance_b1)
-        @helper.should_receive(:read_yaml_file).ordered.with('./c.appl').and_return(appliance_c)
+        @helper.should_not_receive(:read_yaml_file).ordered.with('./c.appl').and_return(appliance_c)
+
+        @helper.read_definitions("a.appl")
 
-        @helper.read_definitions("a.appl").should == [[appliance_a, appliance_b2, appliance_c, appliance_b1, appliance_c], appliance_a]
+        configs = @helper.appliance_configs
+        configs.should == [appliance_a, appliance_b2, appliance_c, appliance_b1]
+        configs.first.should == appliance_a
       end
 
       it "should read a YAML content instead of a loading a file" do
@@ -171,6 +196,30 @@ module BoxGrinder
         File.should_receive(:exists?).with("file.xmdfl").and_return(true)
         lambda { @helper.read_definitions("file.xmdfl") }.should raise_error(RuntimeError, "Unsupported file format for appliance definition file.")
       end
+
+      # https://issues.jboss.org/browse/BGBUILD-150
+      context "cyclical dependency" do
+        it "should stop reading appliances when appliance was already read" do
+          appliance_a = ApplianceConfig.new
+          appliance_a.name = 'a'
+          appliance_a.appliances << "b"
+
+          appliance_b = ApplianceConfig.new
+          appliance_b.name = 'b'
+          appliance_b.appliances << "a"
+
+
+          File.should_receive(:exists?).with('a.appl').and_return(true)
+          File.should_receive(:exists?).with('./b.appl').and_return(true)
+          File.should_not_receive(:exists?).ordered.with('./a.appl')
+
+          @helper.should_receive(:read_yaml_file).ordered.with('a.appl').and_return(appliance_a)
+          @helper.should_receive(:read_yaml_file).ordered.with('./b.appl').and_return(appliance_b)
+          @helper.should_not_receive(:read_yaml_file).ordered.with('./a.appl')
+
+          @helper.read_definitions("a.appl")
+        end
+      end
     end
 
     describe "read_yaml_file" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boxgrinder-core
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Marek Goldmann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
+date: 2011-02-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,7 +62,7 @@ extra_rdoc_files:
 - README
 - lib/boxgrinder-core.rb
 - lib/boxgrinder-core/helpers/appliance-config-helper.rb
-- lib/boxgrinder-core/helpers/appliance-helper.rb
+- lib/boxgrinder-core/helpers/appliance-definition-helper.rb
 - lib/boxgrinder-core/helpers/exec-helper.rb
 - lib/boxgrinder-core/helpers/log-helper.rb
 - lib/boxgrinder-core/models/appliance-config.rb
@@ -79,7 +79,7 @@ files:
 - 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/appliance-definition-helper.rb
 - lib/boxgrinder-core/helpers/exec-helper.rb
 - lib/boxgrinder-core/helpers/log-helper.rb
 - lib/boxgrinder-core/models/appliance-config.rb
@@ -89,13 +89,12 @@ files:
 - 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/appliance-definition-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

data/spec/rspec/rspec-config-helper.rb

@@ -1,77 +0,0 @@
-#
-# 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 'boxgrinder-core/models/config'
-require 'boxgrinder-core/models/appliance-config'
-require 'boxgrinder-core/helpers/appliance-config-helper'
-require 'boxgrinder-core/helpers/appliance-helper'
-require 'logger'
-
-Logger.const_set(:TRACE, 0)
-Logger.const_set(:DEBUG, 1)
-Logger.const_set(:INFO, 2)
-Logger.const_set(:WARN, 3)
-Logger.const_set(:ERROR, 4)
-Logger.const_set(:FATAL, 5)
-Logger.const_set(:UNKNOWN, 6)
-
-Logger::SEV_LABEL.insert(0, 'TRACE')
-
-class Logger
-  def trace?
-    @level <= TRACE
-  end
-
-  def trace(progname = nil, &block)
-    add(TRACE, nil, progname, &block)
-  end
-end
-
-module RSpecConfigHelper
-  RSPEC_BASE_LOCATION = "#{File.dirname(__FILE__)}"
-
-  def generate_config( params = OpenStruct.new )
-    config = BoxGrinder::Config.new
-
-    # files
-    config.files.base_vmdk  = params.base_vmdk      || "../../../src/base.vmdk"
-    config.files.base_vmx   = params.base_vmx       || "../../../src/base.vmx"
-
-    config
-  end
-
-  def generate_appliance_config( appliance_definition_file = "#{RSPEC_BASE_LOCATION}/src/appliances/full.appl" )
-    appliance_configs, appliance_config = BoxGrinder::ApplianceHelper.new(:log => Logger.new('/dev/null')).read_definitions( appliance_definition_file )
-    appliance_config_helper = BoxGrinder::ApplianceConfigHelper.new( appliance_configs )
-
-    appliance_config_helper.merge(appliance_config.clone.init_arch).initialize_paths
-  end
-
-  def generate_appliance_config_gnome( os_version = "11" )
-    appliance_config = BoxGrinder::ApplianceConfig.new("valid-appliance-gnome", (-1.size) == 8 ? "x86_64" : "i386", "fedora", os_version)
-
-    appliance_config.disk_size = 2
-    appliance_config.summary = "this is a summary"
-    appliance_config.network_name = "NAT"
-    appliance_config.vcpu = "1"
-    appliance_config.mem_size = "1024"
-    appliance_config.appliances = [ appliance_config.name ]
-
-    appliance_config
-  end
-end