boxgrinder-build 0.8.1 → 0.9.0

data/lib/boxgrinder-build/plugins/platform/vmware/vmware-plugin.rb

@@ -0,0 +1,194 @@
+#
+# 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-build/plugins/base-plugin'
+require 'boxgrinder-build/helpers/appliance-customize-helper'
+
+module BoxGrinder
+  class VMwarePlugin < BasePlugin
+    def after_init
+      set_default_config_value('thin_disk', false)
+      validate_plugin_config(['type'], 'http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin')
+
+      register_deliverable(:vmx    => "#{@appliance_config.name}.vmx",
+                           :readme => "README")
+
+      if @plugin_config['type'].eql?('personal') and @plugin_config['thin_disk']
+        register_deliverable(:disk => "#{@appliance_config.name}.vmdk")
+      else
+        register_deliverable(:disk => "#{@appliance_config.name}.raw",
+                             :vmdk => "#{@appliance_config.name}.vmdk")
+      end
+    end
+
+    def execute
+      @log.info "Converting image to VMware #{@plugin_config['type']} format..."
+
+      case @plugin_config['type']
+        when 'personal'
+          build_vmware_personal
+        when 'enterprise'
+          build_vmware_enterprise
+        else
+          raise "Not known VMware format specified. Available are: personal and enterprise. See http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#VMware_Platform_Plugin for more info."
+      end
+
+      customize_image
+
+      File.open(@deliverables.readme, "w") { |f| f.write(create_readme) }
+
+      @log.info "Image converted to VMware format."
+    end
+
+    def create_readme
+      readme = File.open("#{File.dirname(__FILE__)}/src/README-#{@plugin_config['type']}").read
+      readme.gsub!(/#APPLIANCE_NAME#/, @appliance_config.name)
+
+      readme
+    end
+
+    # returns value of cylinders, heads and sector for selected disk size (in GB)
+    # http://kb.vmware.com/kb/1026254
+    def generate_scsi_chs(disk_size)
+      if disk_size < 1
+        h = 64
+        s = 32
+      else
+        if disk_size < 2
+          h = 128
+          s = 32
+        else
+          h = 255
+          s = 63
+        end
+      end
+
+      #               GB          MB     KB     B
+      c             = disk_size * 1024 * 1024 * 1024 / (h*s*512)
+      total_sectors = disk_size * 1024 * 1024 * 1024 / 512
+
+      [c.to_i, h.to_i, s.to_i, total_sectors.to_i]
+    end
+
+    def change_vmdk_values(type)
+      vmdk_data = File.open("#{File.dirname(__FILE__)}/src/base.vmdk").read
+
+      disk_size = 0.0
+      @appliance_config.hardware.partitions.values.each { |part| disk_size += part['size'].to_f }
+
+      c, h, s, total_sectors = generate_scsi_chs(disk_size)
+
+      is_enterprise = type.eql?("vmfs")
+
+      vmdk_data.gsub!(/#NAME#/, @appliance_config.name)
+      vmdk_data.gsub!(/#TYPE#/, type)
+      vmdk_data.gsub!(/#EXTENT_TYPE#/, is_enterprise ? "VMFS" : "FLAT")
+      vmdk_data.gsub!(/#NUMBER#/, is_enterprise ? "" : "0")
+      vmdk_data.gsub!(/#HW_VERSION#/, "7")
+      vmdk_data.gsub!(/#CYLINDERS#/, c.to_s)
+      vmdk_data.gsub!(/#HEADS#/, h.to_s)
+      vmdk_data.gsub!(/#SECTORS#/, s.to_s)
+      vmdk_data.gsub!(/#TOTAL_SECTORS#/, total_sectors.to_s)
+      vmdk_data.gsub!(/#THIN_PROVISIONED#/, @plugin_config['thin_disk'] ? "1" : "0")
+
+      vmdk_data
+    end
+
+    def change_common_vmx_values
+      vmx_data = File.open("#{File.dirname(__FILE__)}/src/base.vmx").read
+
+      # replace version with current appliance version
+      vmx_data.gsub!(/#VERSION#/, "#{@appliance_config.version}.#{@appliance_config.release}")
+      # change name
+      vmx_data.gsub!(/#NAME#/, @appliance_config.name.to_s)
+      # and summary
+      vmx_data.gsub!(/#SUMMARY#/, @appliance_config.summary.to_s)
+      # replace guestOS informations to: linux or otherlinux-64, this seems to be the savests values
+      vmx_data.gsub!(/#GUESTOS#/, "#{@appliance_config.hardware.arch == "x86_64" ? "otherlinux-64" : "linux"}")
+      # memory size
+      vmx_data.gsub!(/#MEM_SIZE#/, @appliance_config.hardware.memory.to_s)
+      # memory size
+      vmx_data.gsub!(/#VCPU#/, @appliance_config.hardware.cpus.to_s)
+      # network name
+      # vmx_data.gsub!( /#NETWORK_NAME#/, @image_config.network_name )
+
+      vmx_data
+    end
+
+    def customize_image
+      unless @appliance_config.post['vmware'].nil? or @appliance_config.post['vmware'].empty?
+        @image_helper.customize(@deliverables.disk) do |guestfs, guestfs_helper|
+          @appliance_config.post['vmware'].each do |cmd|
+            guestfs_helper.sh(cmd, :arch => @appliance_config.hardware.arch)
+          end
+          @log.debug "Post commands from appliance definition file executed."
+        end
+      else
+        @log.debug "No commands specified, skipping."
+      end
+    end
+
+    def copy_raw_image
+      @log.debug "Copying VMware image file, this may take several minutes..."
+      @exec_helper.execute "cp '#{@previous_deliverables.disk}' '#{@deliverables.disk}'"
+      @log.debug "VMware image copied."
+    end
+
+    def build_vmware_personal
+      @log.debug "Building VMware personal image."
+
+      if @plugin_config['thin_disk']
+        @log.debug "Using qemu-img to convert the image..."
+        @image_helper.convert_disk(@previous_deliverables.disk, :vmdk, @deliverables.disk)
+        @log.debug "Conversion done."
+      else
+        copy_raw_image
+
+        # create disk descriptor file
+        File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("monolithicFlat")) }
+      end
+
+      # create .vmx file
+      File.open(@deliverables.vmx, "w") { |f| f.write(change_common_vmx_values) }
+
+      @log.debug "VMware personal image was built."
+    end
+
+    def build_vmware_enterprise
+      @log.debug "Building VMware enterprise image."
+
+      copy_raw_image
+
+      # defaults for ESXi (maybe for others too)
+      @appliance_config.hardware.network = "VM Network" if @appliance_config.hardware.network.eql?("NAT")
+
+      # create .vmx file
+      vmx_data = change_common_vmx_values
+      vmx_data += "ethernet0.networkName = \"#{@appliance_config.hardware.network}\""
+
+      File.open(@deliverables.vmx, "w") { |f| f.write(vmx_data) }
+
+      # create disk descriptor file
+      File.open(@deliverables.vmdk, "w") { |f| f.write(change_vmdk_values("vmfs")) }
+
+      @log.debug "VMware enterprise image was built."
+    end
+  end
+end
+
+plugin :class => BoxGrinder::VMwarePlugin, :type => :platform, :name => :vmware, :full_name  => "VMware"

data/rubygem-boxgrinder-build.spec

@@ -5,32 +5,81 @@
 
 Summary: A tool for creating appliances from simple plain text files
 Name: rubygem-%{gemname}
-Version: 0.8.1
+Version: 0.9.0
 Release: 1%{?dist}
 Group: Development/Languages
 License: LGPLv3+
 URL: http://boxgrinder.org/
 Source0: http://rubygems.org/gems/%{gemname}-%{version}.gem
-BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
 
 Requires: ruby(abi) = %{rubyabi}
-Requires: rubygem(thor)
-Requires: rubygem(boxgrinder-core) >= 0.2.1
-Requires: rubygem(boxgrinder-core) < 0.3.0
+Requires: rubygem(boxgrinder-core) >= 0.3.0
+Requires: rubygem(boxgrinder-core) < 0.4.0
 Requires: ruby-libguestfs
 Requires: parted
 Requires: e2fsprogs
 
+# For EL5
+BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
+BuildArch: noarch
+
 BuildRequires: rubygem(rake)
 BuildRequires: rubygem(rspec)
-BuildRequires: rubygem(boxgrinder-core) >= 0.2.1
-BuildRequires: rubygem(boxgrinder-core) < 0.3.0
+BuildRequires: rubygem(boxgrinder-core) >= 0.3.0
+BuildRequires: rubygem(boxgrinder-core) < 0.4.0
 BuildRequires: rubygem(echoe)
 BuildRequires: ruby-libguestfs
 
-BuildArch: noarch
+# EBS and S3
+Requires: rubygem(amazon-ec2)
+# Fixes blankslate error
+Requires: rubygem(builder)
+Requires: rubygem(aws)
+Requires: euca2ools >= 1.3.1-4
+
+BuildRequires: rubygem(amazon-ec2)
+BuildRequires: rubygem(aws)
+# Fixes blankslate error
+BuildRequires: rubygem(builder)
+
+# SFTP
+Requires: rubygem(net-sftp)
+Requires: rubygem(net-ssh)
+Requires: rubygem(progressbar)
+
+BuildRequires: rubygem(net-sftp)
+BuildRequires: rubygem(net-ssh)
+BuildRequires: rubygem(progressbar)
+
+# RPM-BASED
+Requires: appliance-tools
+Requires: yum-utils
+
+# EC2
+Requires: rsync
+Requires: wget
+Requires: util-linux
+
 Provides: rubygem(%{gemname}) = %{version}
 
+Obsoletes: rubygem(boxgrinder-build-ebs-delivery-plugin) < 0.0.4-2
+Obsoletes: rubygem(boxgrinder-build-s3-delivery-plugin) < 0.0.6-1
+Obsoletes: rubygem(boxgrinder-build-local-delivery-plugin) < 0.0.6-2
+Obsoletes: rubygem(boxgrinder-build-sftp-delivery-plugin) < 0.0.5-2
+Obsoletes: rubygem(boxgrinder-build-fedora-os-plugin) < 0.0.6-2
+Obsoletes: rubygem(boxgrinder-build-rpm-based-os-plugin) < 0.0.11-1
+Obsoletes: rubygem(boxgrinder-build-ec2-platform-plugin) < 0.0.10-2
+Obsoletes: rubygem(boxgrinder-build-vmware-platform-plugin) < 0.0.10-2
+
+Provides: rubygem(boxgrinder-build-ebs-delivery-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-s3-delivery-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-local-delivery-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-sftp-delivery-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-fedora-os-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-rpm-based-os-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-ec2-platform-plugin) = %{version}-%{release}
+Provides: rubygem(boxgrinder-build-vmware-platform-plugin) = %{version}-%{release}
+
 %description
 A tool for creating appliances from simple plain text files for various
 virtual environments
@@ -68,13 +117,13 @@ popd
 
 %files
 %defattr(-, root, root, -)
-%{_bindir}/boxgrinder
+%{_bindir}/boxgrinder-build
 %dir %{geminstdir}
 %{geminstdir}/bin
 %{geminstdir}/lib
 %doc %{geminstdir}/CHANGELOG
 %doc %{geminstdir}/LICENSE
-%doc %{geminstdir}/README
+%doc %{geminstdir}/README.md
 %doc %{geminstdir}/Manifest
 %{gemdir}/cache/%{gemname}-%{version}.gem
 %{gemdir}/specifications/%{gemname}-%{version}.gemspec
@@ -88,6 +137,20 @@ popd
 %{gemdir}/doc/%{gemname}-%{version}
 
 %changelog
+* Tue Mar 01 2011 <msavy@redhat.com> - 0.9.0-1
+- Upstream release: 0.9.0
+- [BGBUILD-103] README to indicate supported operating systems / requirements
+- [BGBUILD-169] S3 plugin temporary work-around for EL5
+- [BGBUILD-174] Move plugins to boxgrinder-build gem
+- [BGBUILD-175] Rewrite boxgrinder CLI to remove thor dependency
+- [BGBUILD-81] post command execution w/ setarch breaks commands which are scripts
+- [BGBUILD-173] Include setarch package in default package list for RPM-based OSes
+- [BGBUILD-177] Fedora 13 builds have enabled firewall although they shouldn't have it
+- [BGBUILD-178] Remove sensitive data from logs
+- [BGBUILD-179] Boolean and numeric parameters in hash-like values are not recognized
+- [BGBUILD-176] Fail the build with appropriate message if any of post section commands fails to execute
+- [BGBUILD-183] Add support for Fedora 15
+
 * Tue Feb 16 2011  <mgoldman@redhat.com> - 0.8.1-1
 - Upstream release: 0.8.1
 - [BGBUILD-141] Long delay after "Preparing guestfs" message when creating new image

data/spec/appliance-spec.rb

@@ -229,7 +229,7 @@ module BoxGrinder
 
         lambda {
           @appliance.validate_definition
-        }.should raise_error(RuntimeError, "No operating system plugins installed. Install one or more operating system plugin. See http://community.jboss.org/docs/DOC-15081 and http://community.jboss.org/docs/DOC-15214 for more info.")
+        }.should raise_error(RuntimeError, "No operating system plugins installed. Install one or more operating system plugin. See http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#Operating_system_plugins for more info.")
       end
 
       it "should validate definition and fail because no supported operating system plugins is installed" do
@@ -248,7 +248,7 @@ module BoxGrinder
 
         lambda {
           @appliance.validate_definition
-        }.should raise_error(RuntimeError, "Not supported operating system selected: fedora. Make sure you have installed right operating system plugin, see http://community.jboss.org/docs/DOC-15214. Supported OSes are: rhel")
+        }.should raise_error(RuntimeError, "Not supported operating system selected: fedora. Make sure you have installed right operating system plugin, see http://boxgrinder.org/tutorials/boxgrinder-build-plugins/#Operating_system_plugins. Supported OSes are: rhel")
       end
 
       it "should validate definition and fail because no supported operating system version plugins is installed" do

data/spec/helpers/guestfs-helper-spec.rb

@@ -80,6 +80,7 @@ module BoxGrinder
 
         RbConfig::CONFIG.should_receive(:[]).with('host_cpu').and_return('x86_64')
 
+        File.should_receive(:exists?).with('/usr/bin/qemu-system-x86_64').and_return(true)
         guestfs.should_receive(:set_qemu).with('/usr/bin/qemu-system-x86_64')
         guestfs.should_receive(:add_drive).with('a/raw/disk')
         guestfs.should_receive(:set_network).with(1)
@@ -104,6 +105,7 @@ module BoxGrinder
 
         RbConfig::CONFIG.should_receive(:[]).with('host_cpu').and_return('i386')
 
+        File.should_receive(:exists?).with('/usr/bin/qemu').and_return(true)
         guestfs.should_receive(:set_qemu).with('/usr/bin/qemu')
         guestfs.should_receive(:add_drive).with('a/raw/disk')
         guestfs.should_receive(:set_network).with(1)
@@ -249,7 +251,7 @@ module BoxGrinder
       @helper.should_receive(:`).with('uname -m').and_return('bleh')
       @helper.instance_variable_set(:@guestfs, guestfs)
 
-      guestfs.should_receive(:sh).with("setarch bleh << SETARCH_EOF\ncommand\nSETARCH_EOF\n")
+      guestfs.should_receive(:sh).with("setarch bleh << 'SETARCH_EOF'\ncommand\nSETARCH_EOF")
 
       @helper.sh("command")
     end
@@ -258,7 +260,7 @@ module BoxGrinder
       guestfs = mock('Guestfs')
       @helper.instance_variable_set(:@guestfs, guestfs)
 
-      guestfs.should_receive(:sh).with("setarch arch << SETARCH_EOF\ncommand\nSETARCH_EOF\n")
+      guestfs.should_receive(:sh).with("setarch arch << 'SETARCH_EOF'\ncommand\nSETARCH_EOF")
 
       @helper.sh("command", :arch => 'arch')
     end

data/spec/helpers/image-helper-spec.rb

@@ -55,6 +55,7 @@ module BoxGrinder
       @exec_helper.should_receive(:execute).with("losetup -o 0 /dev/loop0 'disk.raw'")
       @exec_helper.should_receive(:execute).with('e2label /dev/loop0').and_return('/')
       @exec_helper.should_receive(:execute).with("mount /dev/loop0 'mount_dir'")
+      @helper.should_receive(:sleep).with(2)
 
       @helper.mount_image('disk.raw', 'mount_dir').should == {"/"=>"/dev/loop0"}
     end
@@ -71,6 +72,7 @@ module BoxGrinder
 
       @exec_helper.should_receive(:execute).with("mount /dev/loop1 'mount_dir'")
       @exec_helper.should_receive(:execute).with("mount /dev/loop0 'mount_dir/home'")
+      @helper.should_receive(:sleep).with(2)
 
       @helper.mount_image('disk.raw', 'mount_dir').should == {"/"=>"/dev/loop1", "/home"=>"/dev/loop0"}
     end
@@ -80,6 +82,8 @@ module BoxGrinder
       @exec_helper.should_receive(:execute).ordered.with('umount -d /dev/loop1')
       FileUtils.should_receive(:rm_rf).with('mount_dir')
 
+      @helper.should_receive(:sleep).with(2)
+
       @helper.umount_image('disk.raw', 'mount_dir', {"/"=>"/dev/loop1", "/home"=>"/dev/loop0"})
     end
 

data/spec/helpers/plugin-helper-spec.rb

@@ -22,46 +22,14 @@ require 'ostruct'
 
 module BoxGrinder
   describe PluginHelper do
-    before(:all) do
-      @plugin_array = %w(boxgrinder-build-fedora-os-plugin boxgrinder-build-rhel-os-plugin boxgrinder-build-centos-os-plugin boxgrinder-build-ec2-platform-plugin boxgrinder-build-vmware-platform-plugin boxgrinder-build-virtualbox-platform-plugin boxgrinder-build-s3-delivery-plugin boxgrinder-build-sftp-delivery-plugin boxgrinder-build-local-delivery-plugin boxgrinder-build-ebs-delivery-plugin)
-    end
-
     before(:each) do
       @log = LogHelper.new(:level => :trace, :type => :stdout)
       @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => []), :log => @log)
     end
 
-    it "should require default plugins" do
-      @plugin_array.each do |plugin|
-        @plugin_helper.should_receive(:require).once.with(plugin)
-      end
-
-      @plugin_helper.read_and_require
-    end
-
-    it "should require default plugins and fail silently" do
-      @log = mock('Logger')
-
-      @plugin_helper.instance_variable_set(:@log, @log)
-
-      @plugin_array.each do |plugin|
-        @log.should_receive(:trace).with("Loading plugin '#{plugin}'...")
-        @plugin_helper.should_receive(:require).once.with(plugin).and_raise(LoadError)
-        @log.should_receive(:trace).with("- Not found: LoadError")
-      end
-
-      @log.should_not_receive(:warn)
-
-      @plugin_helper.read_and_require
-    end
-
     it "should read plugins specified in command line" do
       @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => ['abc', 'def']), :log => @log)
 
-      @plugin_array.each do |plugin|
-        @plugin_helper.should_receive(:require).once.with(plugin)
-      end
-
       @plugin_helper.should_receive(:require).ordered.with('abc')
       @plugin_helper.should_receive(:require).ordered.with('def')
 
@@ -72,12 +40,6 @@ module BoxGrinder
       @log = mock('Logger')
       @plugin_helper = PluginHelper.new(OpenStruct.new(:additional_plugins => ['abc']), :log => @log)
 
-      @plugin_array.each do |plugin|
-        @log.should_receive(:trace).with("Loading plugin '#{plugin}'...")
-        @plugin_helper.should_receive(:require).once.with(plugin)
-        @log.should_receive(:trace).with("- OK")
-      end
-
       @log.should_receive(:trace).with("Loading plugin 'abc'...")
       @plugin_helper.should_receive(:require).ordered.with('abc').and_raise(LoadError)
       @log.should_receive(:trace).with("- Not found: LoadError")

data/spec/managers/plugin-manager-spec.rb

@@ -28,18 +28,18 @@ module BoxGrinder
     it "should register simple plugin" do
       @manager.register_plugin({:class => PluginManager, :type => :delivery, :name => :abc, :full_name => "Amazon Simple Storage Service (Amazon S3)"})
 
-      @manager.plugins[:delivery].size.should == 1
+      @manager.plugins[:delivery].size.should == 7
       @manager.plugins[:delivery][:abc][:class].should == PluginManager
     end
 
     it "should register plugin with many types" do
-      @manager.register_plugin({:class => PluginManager, :type => :delivery, :name => :s3, :full_name => "Amazon Simple Storage Service (Amazon S3)", :types => [:s3, :cloudfront, :ami]})
+      @manager.register_plugin({:class => PluginManager, :type => :delivery, :name => :def, :full_name => "Amazon Simple Storage Service (Amazon S3)", :types => [:aaa, :bbb, :ccc]})
 
-      @manager.plugins[:delivery].size.should == 4
+      @manager.plugins[:delivery].size.should == 10
       @manager.plugins[:delivery][:abc][:class].should == PluginManager
-      @manager.plugins[:delivery][:ami][:class].should == PluginManager
-      @manager.plugins[:delivery][:s3][:class].should == PluginManager
-      @manager.plugins[:delivery][:cloudfront][:class].should == PluginManager
+      @manager.plugins[:delivery][:aaa][:class].should == PluginManager
+      @manager.plugins[:delivery][:bbb][:class].should == PluginManager
+      @manager.plugins[:delivery][:ccc][:class].should == PluginManager
     end
 
     it "should initialize a plugin" do