boxgrinder-core 0.3.9 → 0.3.10

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.3.10
+
+* [BGBUILD-324] Add wildcard to packages schema
+* [BGBUILD-320] Support variable substitution in any string value field of appliance definition
+* [BGBUILD-327] Resolve appliance definition variables in ENV if they are not defined
+
 v0.3.9
 
 * [BGBUILD-312] Discover which user to switch to after root dependent sections have been executed

data/Manifest

@@ -1,44 +0,0 @@
-CHANGELOG
-LICENSE
-Manifest
-README
-Rakefile
-boxgrinder-core.gemspec
-lib/boxgrinder-core.rb
-lib/boxgrinder-core/appliance-parser.rb
-lib/boxgrinder-core/appliance-validator.rb
-lib/boxgrinder-core/errors.rb
-lib/boxgrinder-core/helpers/appliance-config-helper.rb
-lib/boxgrinder-core/helpers/appliance-definition-helper.rb
-lib/boxgrinder-core/helpers/appliance-transformation-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/schemas/appliance_schema_0.8.0.yaml
-lib/boxgrinder-core/schemas/appliance_schema_0.9.0.yaml
-lib/boxgrinder-core/schemas/appliance_schema_0.9.6.yaml
-rubygem-boxgrinder-core.spec
-spec/appliance-parser-spec.rb
-spec/appliance-validator-spec.rb
-spec/helpers/appliance-config-helper-spec.rb
-spec/helpers/appliance-definition-helper-spec.rb
-spec/helpers/appliance-transformation-helper-spec.rb
-spec/helpers/exec-helper-spec.rb
-spec/helpers/log-helper-spec.rb
-spec/models/appliance-config-spec.rb
-spec/models/config-spec.rb
-spec/rspec/ls/one
-spec/rspec/ls/two
-spec/rspec/src/appliances/0.8.x.appl
-spec/rspec/src/appliances/0.9.x-invalid.appl
-spec/rspec/src/appliances/0.9.x.appl
-spec/rspec/src/appliances/comments.appl
-spec/rspec/src/appliances/ephemeral-repo.appl
-spec/rspec/src/appliances/full.appl
-spec/rspec/src/appliances/invalid-yaml.appl
-spec/rspec/src/appliances/legacy.appl
-spec/rspec/src/appliances/repo.appl
-spec/rspec/src/config/empty
-spec/rspec/src/config/valid

data/boxgrinder-core.gemspec

@@ -1,25 +1,24 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{boxgrinder-core}
-  s.version = "0.3.9"
+  s.name = "boxgrinder-core"
+  s.version = "0.3.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek Goldmann"]
-  s.date = %q{2011-11-15}
-  s.description = %q{Core library for BoxGrinder}
-  s.email = %q{info@boxgrinder.org}
+  s.date = "2011-12-19"
+  s.description = "Core library for BoxGrinder"
+  s.email = "info@boxgrinder.org"
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/appliance-parser.rb", "lib/boxgrinder-core/appliance-validator.rb", "lib/boxgrinder-core/errors.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-helper.rb", "lib/boxgrinder-core/helpers/appliance-transformation-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/schemas/appliance_schema_0.8.0.yaml", "lib/boxgrinder-core/schemas/appliance_schema_0.9.0.yaml", "lib/boxgrinder-core/schemas/appliance_schema_0.9.6.yaml"]
   s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "boxgrinder-core.gemspec", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/appliance-parser.rb", "lib/boxgrinder-core/appliance-validator.rb", "lib/boxgrinder-core/errors.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-helper.rb", "lib/boxgrinder-core/helpers/appliance-transformation-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/schemas/appliance_schema_0.8.0.yaml", "lib/boxgrinder-core/schemas/appliance_schema_0.9.0.yaml", "lib/boxgrinder-core/schemas/appliance_schema_0.9.6.yaml", "rubygem-boxgrinder-core.spec", "spec/appliance-parser-spec.rb", "spec/appliance-validator-spec.rb", "spec/helpers/appliance-config-helper-spec.rb", "spec/helpers/appliance-definition-helper-spec.rb", "spec/helpers/appliance-transformation-helper-spec.rb", "spec/helpers/exec-helper-spec.rb", "spec/helpers/log-helper-spec.rb", "spec/models/appliance-config-spec.rb", "spec/models/config-spec.rb", "spec/rspec/ls/one", "spec/rspec/ls/two", "spec/rspec/src/appliances/0.8.x.appl", "spec/rspec/src/appliances/0.9.x-invalid.appl", "spec/rspec/src/appliances/0.9.x.appl", "spec/rspec/src/appliances/comments.appl", "spec/rspec/src/appliances/ephemeral-repo.appl", "spec/rspec/src/appliances/full.appl", "spec/rspec/src/appliances/invalid-yaml.appl", "spec/rspec/src/appliances/legacy.appl", "spec/rspec/src/appliances/repo.appl", "spec/rspec/src/config/empty", "spec/rspec/src/config/valid"]
-  s.homepage = %q{http://boxgrinder.org}
+  s.homepage = "http://boxgrinder.org"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Boxgrinder-core", "--main", "README"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{BoxGrinder}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Core library for BoxGrinder}
+  s.rubyforge_project = "BoxGrinder"
+  s.rubygems_version = "1.8.11"
+  s.summary = "Core library for BoxGrinder"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

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

@@ -22,6 +22,8 @@ require 'set'
 module BoxGrinder
   class ApplianceConfigHelper
 
+    VAR_SUBSTITUTION_MAX_DEPTH = 20
+
     def initialize(appliance_configs)
       @appliance_configs = appliance_configs.reverse
     end
@@ -39,6 +41,7 @@ module BoxGrinder
       merge_packages
       merge_files
       merge_post_operations
+      substitute_variables
 
       @appliance_config
     end
@@ -90,6 +93,33 @@ module BoxGrinder
       end
     end
 
+    # Get all leaf text values in the appliance definition, then substitute any
+    # variable values.
+    def substitute_variables
+      @appliance_config.all_values.each do |value|
+        substitute(value.clone, value, 0)
+      end
+    end
+
+    # Replace variables with values. This will occur recursively upto a limited
+    # depth if the resolved values themselves contain variables.
+    def substitute(init, value, depth)
+      if depth > VAR_SUBSTITUTION_MAX_DEPTH
+        raise SystemStackError, "Maximal recursive depth (#{VAR_SUBSTITUTION_MAX_DEPTH})
+          reached for resolving variable #{init}, reached #{value} before stopping."
+      end
+      original = value.clone
+      value.gsub!(/(#(.*?)#)+?/) do
+       # 1. Match pre-defined variable, or variable defined in appliance definition.
+       next @appliance_config.variables[$2] if @appliance_config.variables.has_key?($2)
+       # 2. Match from environment variables.
+       next ENV[$2] unless ENV[$2].nil?
+       # 3. No match, replace the original string.
+       $1
+      end
+      substitute(init, value, depth+1) unless original == value
+    end
+
     def merge_hardware
       merge_cpus
       merge_partitions
@@ -162,25 +192,12 @@ module BoxGrinder
       @appliance_config.repos.clear
 
       @appliance_configs.each do |appliance_config|
-        for repo in appliance_config.repos
-          repo['name'] = substitute_vars(repo['name'])
-          ['baseurl', 'mirrorlist'].each do |type|
-            repo[type] = substitute_vars(repo[type]) unless repo[type].nil?
-          end
-
+        appliance_config.repos.each do |repo|
           @appliance_config.repos << repo
         end
       end
     end
 
-    def substitute_vars(str)
-      return if str.nil?
-      @appliance_config.variables.keys.each do |var|
-        str = str.gsub("##{var}#", @appliance_config.variables[var])
-      end
-      str
-    end
-
     def merge_packages
       @appliance_config.packages.clear
 
@@ -202,7 +219,7 @@ module BoxGrinder
         next if included.include?(appliance_config)
         appliance_config.files.each do |dir, files|
           @appliance_config.files[dir] = [] if @appliance_config.files[dir].nil?
-          files.each { |f| @appliance_config.files[dir] << substitute_vars(f) }
+          files.each { |f| @appliance_config.files[dir] << f }
         end
         included << appliance_config
       end
@@ -217,7 +234,7 @@ module BoxGrinder
         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) }
+          cmds.each { |cmd| @appliance_config.post[platform] << cmd }
         end
         included << appliance_config
       end

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

@@ -94,6 +94,25 @@ module BoxGrinder
       self
     end
 
+    def all_values(input=nil)
+      avoid	= ['@variables']
+      input = (self.instance_variables - avoid).
+        collect{ |v| self.instance_variable_get(v) } if input.nil?
+
+      vars = input.inject([]) do |arr, var|
+        case var
+          when Hash
+            arr.concat(all_values(var.values))
+          when Array
+            arr.concat(all_values(var))
+          when String
+            arr.push var
+          end
+        arr
+        end
+      vars
+    end
+
     # Returns default filesystem type for current OS
     def default_filesystem_type
       fs = 'ext4'

data/lib/boxgrinder-core/schemas/appliance_schema_0.8.0.yaml

@@ -60,7 +60,7 @@ mapping:
         type: seq
         sequence:
           - type: str # Now allowing spaces due to group labels (these map to real groups with no spaces, but confuses users) https://issues.jboss.org/browse/BGBUILD-220
-            pattern: /^[\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols) 
+            pattern: /^[\*\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols)
             length: { min: 1 }
       "excludes": *pkg
   "default_repos":

data/lib/boxgrinder-core/schemas/appliance_schema_0.9.0.yaml

@@ -57,7 +57,7 @@ mapping:
     type: seq
     sequence:
       - type: str # Now allowing spaces due to group labels (these map to real groups with no spaces, but confuses users) https://issues.jboss.org/browse/BGBUILD-220
-        pattern: /^[\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols) 
+        pattern: /^[\*\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols)
         length: { min: 1 }
   "default_repos":
     type: bool

data/lib/boxgrinder-core/schemas/appliance_schema_0.9.6.yaml

@@ -57,7 +57,7 @@ mapping:
     type: seq
     sequence:
       - type: str # Now allowing spaces due to group labels (these map to real groups with no spaces, but confuses users) https://issues.jboss.org/browse/BGBUILD-220
-        pattern: /^[\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols) 
+        pattern: /^[\*\w\-+.@#\s]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols)
         length: { min: 1 }
   "default_repos":
     type: bool

data/rubygem-boxgrinder-core.spec

@@ -5,7 +5,7 @@
 
 Summary: Core library for BoxGrinder
 Name: rubygem-%{gemname}
-Version: 0.3.9
+Version: 0.3.10
 Release: 1%{?dist}
 Group: Development/Languages
 License: LGPLv3+
@@ -76,6 +76,12 @@ popd
 %{gemdir}/doc/%{gemname}-%{version}
 
 %changelog
+* Thu Dec 1 2011 Marc Savy <mgoldman@redhat.com> - 0.3.10
+- Upstream release: 0.3.10
+- [BGBUILD-324] Add wildcard to packages schema
+- [BGBUILD-320] Support variable substitution in any string value field of appliance definition
+- [BGBUILD-327] Resolve appliance definition variables in ENV if they are not defined
+
 * Fri Oct 14 2011 Marc Savy <msavy@redhat.com> - 0.3.9-1
 - Upstream release: 0.3.9
 - [BGBUILD-312] Discover which user to switch to after root dependent sections have been executed

data/spec/helpers/appliance-config-helper-spec.rb

@@ -405,6 +405,7 @@ module BoxGrinder
 
       @helper.merge_variables
       @helper.merge_repos
+      @helper.substitute_variables
 
       config = @helper.instance_variable_get(:@appliance_config)
       config.repos.size.should == 1
@@ -425,6 +426,7 @@ module BoxGrinder
 
       @helper.merge_variables
       @helper.merge_post_operations
+      @helper.substitute_variables
 
       config = @helper.instance_variable_get(:@appliance_config)
       config.post.size.should == 2
@@ -447,12 +449,82 @@ module BoxGrinder
 
       @helper.merge_variables
       @helper.merge_post_operations
+      @helper.substitute_variables
 
       config = @helper.instance_variable_get(:@appliance_config)
       config.post.size.should == 1
       config.post['base'].should == [@arch, @base_arch, '12', 'fedora', 'AAA', 'BBB']
     end
 
+    it "should allow variable substitution for any string value" do
+      config_a = ApplianceConfig.new
+      config_a.name = 'a'
+      config_a.os.name = "fedora-#CUSTOM_B#"
+      config_a.summary = "boxgrinder-#CUSTOM_A#"
+      config_a.os.version = '12'
+      config_a.variables['CUSTOM_A'] = "AAA"
+      config_a.variables['CUSTOM_B'] = "BBB"
+      config_a.init_arch
+
+      prepare_helper([config_a])
+      @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+      @helper.merge_variables
+      @helper.merge_post_operations
+      @helper.substitute_variables
+
+      config = @helper.instance_variable_get(:@appliance_config)
+      config.os.name.should == "fedora-BBB"
+      config.summary.should == "boxgrinder-AAA"
+    end
+
+    it "should allow recursive variable substitution" do
+      config_a = ApplianceConfig.new
+      config_a.name = 'a'
+      config_a.os.name = "fedora-#CUSTOM_B#"
+      config_a.summary = "boxgrinder-#CUSTOM_A#"
+      config_a.os.version = '#CUSTOM_A#'
+      config_a.variables['CUSTOM_A'] = "#CUSTOM_B#"
+      config_a.variables['CUSTOM_B'] = "ni-ni-ni"
+      config_a.post['base'] = ['#ARCH#', '#BASE_ARCH#', '#OS_VERSION#', '#OS_NAME#', '#CUSTOM_A#', '#CUSTOM_B#']
+      config_a.init_arch
+
+      prepare_helper([config_a])
+      @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+      @helper.merge_variables
+      @helper.merge_post_operations
+      @helper.substitute_variables
+
+      config = @helper.instance_variable_get(:@appliance_config)
+      config.os.name.should == "fedora-ni-ni-ni"
+      config.summary.should == "boxgrinder-ni-ni-ni"
+      config.post['base'].should == [@arch, @base_arch, 'ni-ni-ni', 'fedora-ni-ni-ni', 'ni-ni-ni', 'ni-ni-ni']
+    end
+
+    it "should fall back onto ENV if no variable is explicitly defined in the appliance" do
+      config_a = ApplianceConfig.new
+      config_a.name = 'a'
+      config_a.os.name = "fedora-#CUSTOM_B#"
+      config_a.os.version = '#CUSTOM_A#'
+      ENV['CUSTOM_A'] = 'shrubbery'
+      config_a.variables['CUSTOM_B'] = "ni-ni-ni"
+      config_a.post['base'] = ['#ARCH#', '#BASE_ARCH#', '#OS_VERSION#', '#OS_NAME#', '#CUSTOM_A#',
+                               '#CUSTOM_B#', '#CUSTOM_A#-#NOT_DEF#', '#NOT_DEF#-#CUSTOM_A#', "##"]
+      config_a.init_arch
+
+      prepare_helper([config_a])
+      @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+      @helper.merge_variables
+      @helper.merge_post_operations
+      @helper.substitute_variables
+
+      config = @helper.instance_variable_get(:@appliance_config)
+      config.post['base'].should == [@arch, @base_arch, 'shrubbery', 'fedora-ni-ni-ni', 'shrubbery',
+                                     'ni-ni-ni', 'shrubbery-#NOT_DEF#', '#NOT_DEF#-shrubbery', '##']
+    end
+
     describe ".merge_default_repos" do
       it "should set default_repos option to true when not specified" do
         config_a = ApplianceConfig.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boxgrinder-core
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 9
-  version: 0.3.9
+  - 10
+  version: 0.3.10
 platform: ruby
 authors: 
 - Marek Goldmann
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-15 00:00:00 +01:00
-default_executable: 
+date: 2011-12-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hashery
@@ -136,7 +135,6 @@ files:
 - spec/rspec/src/appliances/repo.appl
 - spec/rspec/src/config/empty
 - spec/rspec/src/config/valid
-has_rdoc: true
 homepage: http://boxgrinder.org
 licenses: []
 
@@ -172,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: BoxGrinder
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Core library for BoxGrinder