boxgrinder-core 0.3.0 → 0.3.1

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

@@ -22,32 +22,33 @@ require 'hashery/opencascade'
 module BoxGrinder
   class ApplianceConfig
     def initialize
-      @name                = nil
-      @summary             = nil
+      @name = nil
+      @summary = nil
 
-      @variables           = {}
+      @variables = {}
 
-      @os                  = OpenCascade.new
+      @os = OpenCascade.new
 
-      @os.name             = nil
-      @os.version          = nil
-      @os.password         = 'boxgrinder'
+      @os.name = nil
+      @os.version = nil
+      @os.password = nil
+      @os.pae = true
 
-      @hardware            = OpenCascade.new
+      @hardware = OpenCascade.new
 
-      @hardware.cpus       = 1
-      @hardware.memory     = 256
-      @hardware.network    = 'NAT'
-      @hardware.partitions = {"/" => { 'size' => 1 }}
+      @hardware.cpus = 1
+      @hardware.memory = 256
+      @hardware.network = 'NAT'
+      @hardware.partitions = {"/" => {'size' => 1}}
 
-      @post                = {}
+      @post = {}
 
-      @packages            = []
-      @appliances          = []
-      @repos               = []
+      @packages = []
+      @appliances = []
+      @repos = []
 
-      @version             = 1
-      @release             = 0
+      @version = 1
+      @release = 0
     end
 
     attr_reader :variables
@@ -72,22 +73,37 @@ module BoxGrinder
     end
 
     def init_arch
-      @hardware.arch      = `uname -m`.chomp.strip
+      @hardware.arch = `uname -m`.chomp.strip
       @hardware.base_arch = is64bit? ? "x86_64" : "i386"
       self
     end
 
     def initialize_paths
-      @path           = OpenCascade.new
+      @path = OpenCascade.new
 
-      @path.os        = "#{@os.name}/#{@os.version}"
-      @path.main      = "#{@hardware.arch}/#{@path.os}"
+      @path.os = "#{@os.name}/#{@os.version}"
+      @path.main = "#{@hardware.arch}/#{@path.os}"
       @path.appliance = "appliances/#{@path.main}/#{@name}"
-      @path.build     = "build/#{@path.appliance}"
+      @path.build = "build/#{@path.appliance}"
 
       self
     end
 
+    # Returns default filesystem type for current OS
+    def default_filesystem_type
+      fs = 'ext4'
+
+      case @os.name
+        when 'rhel', 'centos'
+          case @os.version
+            when '5'
+              fs = 'ext3'
+          end
+      end
+
+      fs
+    end
+
     # used to checking if configuration differs from previous in appliance-kickstart
     def hash
       "#{@name}-#{@summary}-#{@version}-#{@release}-#{@os.name}-#{@os.version}-#{@os.password}-#{@hardware.cpus}-#{@hardware.memory}-#{@hardware.partitions}-#{@appliances}".hash

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

@@ -36,7 +36,8 @@ module BoxGrinder
           :dir => {
               :root => Dir.pwd,
               :build => 'build',
-              :cache => '/var/cache/boxgrinder' # required for appliance-creator
+              :cache => '/var/cache/boxgrinder', # required for appliance-creator
+              :tmp => '/tmp'
           },
           :os_config => {},
           :platform_config => {},
@@ -44,9 +45,10 @@ module BoxGrinder
           :additional_plugins => []
       )
 
+      deep_merge(self, YAML.load_file(self.file)) if File.exists?(self.file)
       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)
+      self.backtrace = true if [:debug, :trace].include?(self.log_level)
     end
 
     def deep_merge(first, second)

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

@@ -0,0 +1,95 @@
+#0.8.x schema
+version: 0.8.0
+type: map
+mapping:
+  "name":
+    type: str
+    length: { min: 1 }
+    required: yes
+  "summary":
+    type: str
+    length: { min: 1 }
+  "version":
+    type: int
+  "release":
+    type: int
+  "os":
+    type: map
+    mapping:
+      "name":
+        type: str
+        length: { min: 1 }
+        required: yes
+      "version":
+        type: text
+        required: yes
+      "password":
+        type: str
+  "hardware":
+    type: map
+    name: Hardware
+    mapping:
+      "cpus":
+        type: int
+        range: { min: 1, max: 4 }
+      "memory":
+        type: int
+        range: { min: 1 }
+      "partitions":
+        type: map
+        mapping:
+          "=": #No way of providing validation regex for wildcard name.
+            type: map
+            mapping:             
+              "size":
+                type: number
+                range: { min: 0.01 }
+              "type":
+                type: str
+                enum: [ext3, ext4]                
+  "appliances":
+    type: seq
+    sequence:
+      - type: str
+        pattern: /^[^\/]+$/ #dont support path resolution yet
+        length: { min: 1 }
+  "packages":
+    type: map
+    mapping:
+      "includes": &pkg
+        type: seq
+        sequence:
+          - type: str 
+            pattern: /^[\w\-+.@\043]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols/spaces)
+            length: { min: 1 }
+      "excludes": *pkg
+  "repos":
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "name":
+            type: str
+            pattern: /^[\w\-+.\043]+$/
+            length: { min: 1 }
+            required: yes
+          "baseurl": &pkg-mirror
+            type: str
+            pattern: /(^((http|ftp):)(\/\/([^\/?\043]*))?([^?\043]*)(\?([^\043]*))?(\043(.*))?$|^file:\/\/.+$)/ #customised rfc3986 standard regexp for URIs
+          "mirrorlist": *pkg-mirror
+          "ephemeral": 
+            type: bool
+  "post":
+    type: map
+    mapping:
+      "=":
+        type: seq
+        sequence:
+          - type: str
+            length: { min: 1 }
+  "variables":
+    type: map
+    mapping:
+      "=": # wibble: value
+        type: str
+        length: { min: 1 }

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

@@ -0,0 +1,92 @@
+#0.9.x schema
+version: 0.9.0
+type: map
+mapping:
+  "name":
+    type: str
+    length: { min: 1 }
+    required: yes
+  "summary":
+    type: str
+    length: { min: 1 }
+  "version":
+    type: int
+  "release":
+    type: int
+  "os":
+    type: map
+    mapping:
+      "name":
+        type: str
+        length: { min: 1 }
+        required: yes
+      "version":
+        type: text
+        required: yes
+      "password":
+        type: str  
+  "hardware":
+    type: map
+    name: Hardware
+    mapping:
+      "cpus":
+        type: int
+        range: { min: 1, max: 4 }
+      "memory":
+        type: int
+        range: { min: 1 }
+      "partitions":
+        type: map
+        mapping:
+          "=": #No way of providing validation regex for wildcard name.
+            type: map
+            mapping:             
+              "size":
+                type: number
+                range: { min: 0.01 }
+              "type":
+                type: str
+                enum: [ext3, ext4]  
+  "appliances":
+    type: seq
+    sequence:
+      - type: str
+        pattern: /^[^\/]+$/ #dont support path resolution yet
+        length: { min: 1 }
+  "packages":
+    type: seq
+    sequence:
+      - type: str
+        pattern: /^[\w\-+.@\043]+$/ #fedora packaging standard http://bit.ly/h0JN9u (plus a few more, disallow symbols/spaces)
+        length: { min: 1 }
+  "repos":
+    type: seq
+    sequence:
+      - type: map
+        name: Repository
+        mapping:
+          "name":
+            type: str
+            pattern: /^[\w\-+.\043]+$/
+            length: { min: 1 }
+            required: yes
+          "baseurl": &pkg-mirror
+            type: str
+            pattern: /(^((http|ftp):)(\/\/([^\/?\043]*))?([^?\043]*)(\?([^\043]*))?(\043(.*))?$|^file:\/\/.+$)/ #customised rfc3986 standard regexp for URIs
+          "mirrorlist": *pkg-mirror
+          "ephemeral":
+            type: bool    
+  "post":
+    type: map
+    mapping:
+      "=":
+        type: seq
+        sequence:
+          - type: str
+            length: { min: 1 }
+  "variables":
+    type: map
+    mapping:
+      "=": # wibble: value
+        type: str
+        length: { min: 1 }

data/rubygem-boxgrinder-core.spec

@@ -5,7 +5,7 @@
 
 Summary: Core library for BoxGrinder
 Name: rubygem-%{gemname}
-Version: 0.3.0
+Version: 0.3.1
 Release: 1%{?dist}
 Group: Development/Languages
 License: LGPLv3+
@@ -16,12 +16,14 @@ BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
 Requires: ruby(abi) = %{rubyabi}
 Requires: rubygem(open4)
 Requires: rubygem(hashery)
+Requires: rubygem(kwalify)
 
 BuildRequires: rubygem(rake)
 BuildRequires: rubygem(rspec)
 BuildRequires: rubygem(open4)
 BuildRequires: rubygem(hashery)
 BuildRequires: rubygem(echoe)
+BuildRequires: rubygem(kwalify)
 
 BuildArch: noarch
 Provides: rubygem(%{gemname}) = %{version}
@@ -74,6 +76,16 @@ popd
 %{gemdir}/doc/%{gemname}-%{version}
 
 %changelog
+* Thu Mar 17 2011 <mgoldman@redhat.com> - 0.3.1-1
+- Upstream release: 0.3.1
+- [BGBUILD-164] Guestfs writes to /tmp/ by default, potentially filling the root filesystem
+- [BGBUILD-97] some filesystems dont get unmounted on BG interruption
+- [BGBUILD-155] Images built on Centos5.x (el5) for VirtualBox kernel panic (/dev/root missing)
+- [BGBUILD-190] Allow to specify kernel variant (PAE or not) for Fedora OS
+- [BGBUILD-192] Use IO.popen4 instead open4 gem on JRuby
+- [BGBUILD-198] root password is not inherited
+- [BGBUILD-156] Validate appliance definition files early and return meaningful error messages
+
 * Sat Mar 05 2011  <mgoldman@redhat.com> - 0.3.0-1
 - Upstream release: 0.3.0
 - [BGBUILD-178] Remove sensitive data from logs

data/spec/appliance-parser-spec.rb

@@ -0,0 +1,68 @@
+#
+# 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 'rubygems'
+require 'boxgrinder-core/appliance-parser'
+require 'boxgrinder-core/helpers/log-helper'
+
+module BoxGrinder
+  describe ApplianceParser do
+    before(:each) do
+      @log = LogHelper.new(:level => :trace, :type => :stdout)
+      @parser = ApplianceParser.new(:log => @log)
+    end
+
+    describe ".load_schemas" do
+      it "should load all available schemas" do
+        Kwalify::Yaml.should_receive(:load_file).with('filea').and_return({'version' => '0.8.0'})
+        Kwalify::Yaml.should_receive(:load_file).with('fileb').and_return({'version' => '0.9.0'})
+
+        Dir.should_receive(:glob).with(an_instance_of(String)).and_return(['filea', 'fileb'])
+
+        @parser.load_schemas
+        @parser.instance_variable_get(:@schemas).should == {'0.8.0' => {'version' => '0.8.0'}, '0.9.0' => {'version' => '0.9.0'}}
+      end
+    end
+
+    describe ".parse_definition" do
+      it "should raise exception because the appliance definition is invalid" do
+        @parser.load_schemas
+
+        lambda {
+          @parser.parse_definition(File.read("#{File.dirname(__FILE__)}/rspec/src/appliances/invalid-yaml.appl"), false)
+        }.should raise_error(ApplianceValidationError, "The appliance definition was invalid according to schema 0.9.0. See log for details.")
+      end
+
+      it "should validate 0.9.0 version definition without error" do
+        @parser.load_schemas
+        definition = @parser.parse_definition(File.read("#{File.dirname(__FILE__)}/rspec/src/appliances/0.9.x.appl"), false)
+
+        definition['os']['password'].should == 'boxgrinder-ftw'
+        definition['packages'].size.should == 2
+      end
+
+      it "should validate 0.8.0 version definition without error" do
+        @parser.load_schemas
+        definition = @parser.parse_definition("#{File.dirname(__FILE__)}/rspec/src/appliances/0.8.x.appl")
+
+        definition['os']['password'].should == 'boxgrinder-ftw'
+        definition['packages'].size.should == 3
+      end
+    end
+  end
+end

data/spec/appliance-validator-spec.rb

@@ -0,0 +1,71 @@
+#
+# 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 'rubygems'
+require 'boxgrinder-core/appliance-validator'
+require 'hashery/opencascade'
+
+module BoxGrinder
+  describe ApplianceValidator do
+    before(:each) do
+      schema = YAML.load_file("#{File.dirname(__FILE__)}/../lib/boxgrinder-core/schemas/appliance_schema_0.9.0.yaml")
+      schema.delete('version')
+
+      @validator = ApplianceValidator.new(schema)
+    end
+
+    describe ".validate_hook" do
+      context "repository" do
+        it "should generate error when no baseurl or mirrorlist is specified for repository" do
+          a = []
+          @validator.validate_hook({}, OpenCascade.new(:name => 'Repository'), '/', a)
+          a.size.should == 1
+          a.first.message.should == 'Please specify either a baseurl or a mirrorlist.'
+        end
+
+        it "should generate error when both baseurl and mirrorlist are specified for repository" do
+          a = []
+          @validator.validate_hook({'baseurl' => 'abc', 'mirrorlist' => 'def'}, OpenCascade.new(:name => 'Repository'), '/', a)
+          a.size.should == 1
+          a.first.message.should == 'Please specify either a baseurl or a mirrorlist.'
+        end
+
+        it "should pass if baseurl or mirrorlist is specified for repository" do
+          a = []
+          @validator.validate_hook({'baseurl' => 'abc'}, OpenCascade.new(:name => 'Repository'), '/', a)
+          a.size.should == 0
+        end
+      end
+
+      context "hardware" do
+        it "should allow only multiplicity of 64 for memory" do
+          a = []
+          @validator.validate_hook({'memory' => 235}, OpenCascade.new(:name => 'Hardware'), '/', a)
+          a.size.should == 1
+          a.first.message.should == "Specified memory amount: 235 is invalid. The value must be a multiple of 64."
+        end
+
+        it "should pass if the memory is 256" do
+          a = []
+          @validator.validate_hook({'memory' => 256}, OpenCascade.new(:name => 'Hardware'), '/', a)
+          a.size.should == 0
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,9 @@
 # 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 'boxgrinder-core/helpers/appliance-config-helper'
+require 'boxgrinder-core/models/appliance-config'
 
 module BoxGrinder
   describe ApplianceConfigHelper do
@@ -237,9 +239,33 @@ module BoxGrinder
 
         @helper.merge_partitions
 
+        config = @helper.instance_variable_get(:@appliance_config)
+        config.hardware.partitions.size.should == 3
+        config.hardware.partitions.should == {"/" => {'size' => '4', 'type' => 'ext3'}, "/home" => {'size' => '2', 'type' => 'ext3'}, "/boot" => {'type' => 'ext3', 'size' => 0.1}}
+      end
+
+      it "should merge partitions for default fs_types without options for RHEL 5 (ext3) with /boot partition" do
+        config_a = ApplianceConfig.new
+        config_a.name = 'a'
+        config_a.appliances << 'b'
+        config_a.hardware.partitions = {"/" => {'size' => '2'}}
+        config_a.os.name = 'rhel'
+        config_a.os.version = '5'
+
+        config_b = ApplianceConfig.new
+        config_b.name = 'b'
+        config_b.hardware.partitions = {"/" => {'size' => '4'}, "/boot" => {'size' => '2'}}
+        config_b.os.name = 'rhel'
+        config_b.os.version = '5'
+
+        prepare_helper([config_a, config_b])
+        @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+        @helper.merge_partitions
+
         config = @helper.instance_variable_get(:@appliance_config)
         config.hardware.partitions.size.should == 2
-        config.hardware.partitions.should == {"/" => {'size' => '4', 'type' => 'ext3'}, "/home" => {'size' => '2', 'type' => 'ext3'}}
+        config.hardware.partitions.should == {"/" => {'size' => '4', 'type' => 'ext3'}, "/boot" => {'size' => '2', 'type' => 'ext3'}}
       end
 
       it "should merge partitions with different filesystem types" do
@@ -480,5 +506,114 @@ module BoxGrinder
         config.default_repos.should == false
       end
     end
+
+    describe ".prepare_os" do
+      it "should set default value for pae" do
+        config_a = ApplianceConfig.new
+        config_a.name = 'a'
+        config_a.appliances << 'b'
+
+        config_b = ApplianceConfig.new
+        config_b.name = 'b'
+
+        prepare_helper([config_a, config_b])
+        @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+        @helper.prepare_os
+
+        config = @helper.instance_variable_get(:@appliance_config)
+        config.os.pae.should == true
+      end
+
+      it "should set pae to false if it set so in dependent appliances" do
+        config_a = ApplianceConfig.new
+        config_a.name = 'a'
+        config_a.appliances << 'b'
+
+        config_b = ApplianceConfig.new
+        config_b.name = 'b'
+        config_b.os.pae = false
+
+        prepare_helper([config_a, config_b])
+        @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+        @helper.prepare_os
+
+        config = @helper.instance_variable_get(:@appliance_config)
+        config.os.pae.should == false
+      end
+
+      it "should set default value for pae" do
+        config_a = ApplianceConfig.new
+        config_a.name = 'a'
+        config_a.appliances << 'b'
+
+        config_b = ApplianceConfig.new
+        config_b.name = 'b'
+
+        prepare_helper([config_a, config_b])
+        @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+        @helper.prepare_os
+
+        config = @helper.instance_variable_get(:@appliance_config)
+        config.os.pae.should == true
+      end
+
+      context "root password" do
+        it "should set default password" do
+          config_a = ApplianceConfig.new
+          config_a.name = 'a'
+          config_a.appliances << 'b'
+
+          config_b = ApplianceConfig.new
+          config_b.name = 'b'
+
+          prepare_helper([config_a, config_b])
+          @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+          @helper.prepare_os
+
+          config = @helper.instance_variable_get(:@appliance_config)
+          config.os.password.should == 'boxgrinder'
+        end
+
+        it "should set password from top-level appliance" do
+          config_a = ApplianceConfig.new
+          config_a.name = 'a'
+          config_a.os.password = 'test'
+          config_a.appliances << 'b'
+
+          config_b = ApplianceConfig.new
+          config_b.name = 'b'
+
+          prepare_helper([config_a, config_b])
+          @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+          @helper.prepare_os
+
+          config = @helper.instance_variable_get(:@appliance_config)
+          config.os.password.should == 'test'
+        end
+
+        it "should set password from inherited appliance" do
+          config_a = ApplianceConfig.new
+          config_a.name = 'a'
+          config_a.appliances << 'b'
+
+          config_b = ApplianceConfig.new
+          config_b.name = 'b'
+          config_b.os.password = 'test'
+
+          prepare_helper([config_a, config_b])
+          @helper.instance_variable_set(:@appliance_config, config_a.clone)
+
+          @helper.prepare_os
+
+          config = @helper.instance_variable_get(:@appliance_config)
+          config.os.password.should == 'test'
+        end
+      end
+    end
   end
 end