boxgrinder-build 0.10.0 → 0.10.1

data/lib/boxgrinder-build/plugins/os/centos/centos-plugin.rb

@@ -20,7 +20,7 @@ require 'boxgrinder-build/plugins/os/rhel/rhel-plugin'
 
 module BoxGrinder
   class CentOSPlugin < RHELPlugin
-    plugin :type => :os, :name => :centos, :full_name  => "CentOS", :versions => ["5", "6"]
+    plugin :type => :os, :name => :centos, :full_name  => "CentOS", :versions => ["5", "6"], :require_root => true
 
     def after_init
       super

data/lib/boxgrinder-build/plugins/os/fedora/fedora-plugin.rb

@@ -20,7 +20,7 @@ require 'boxgrinder-build/plugins/os/rpm-based/rpm-based-os-plugin'
 
 module BoxGrinder
   class FedoraPlugin < RPMBasedOSPlugin
-    plugin :type => :os, :name => :fedora, :full_name => "Fedora", :versions => ["13", "14", "15", "16", "rawhide"]
+    plugin :type => :os, :name => :fedora, :full_name => "Fedora", :versions => ["13", "14", "15", "16", "rawhide"], :require_root => true
 
     def after_init
       super

data/lib/boxgrinder-build/plugins/os/rhel/rhel-plugin.rb

@@ -20,7 +20,7 @@ require 'boxgrinder-build/plugins/os/rpm-based/rpm-based-os-plugin'
 
 module BoxGrinder
   class RHELPlugin < RPMBasedOSPlugin
-    plugin :type => :os, :name => :rhel, :full_name => "Red Hat Enterprise Linux", :versions => ['5', '6']
+    plugin :type => :os, :name => :rhel, :full_name => "Red Hat Enterprise Linux", :versions => ['5', '6'], :require_root => true
 
     def after_init
       super

data/lib/boxgrinder-build/plugins/os/rpm-based/kickstart.rb

@@ -37,7 +37,7 @@ module BoxGrinder
 
     def create
       template = "#{File.dirname(__FILE__)}/src/appliance.ks.erb"
-      kickstart = ERB.new(File.read(template)).result(build_definition.send(:binding))
+      kickstart = ERB.new(File.read(template)).result(build_definition.get_binding)
       File.open(@kickstart_file, 'w') { |f| f.write(kickstart) }
 
       @kickstart_file
@@ -54,6 +54,10 @@ module BoxGrinder
         self[sym.to_s]
       end
 
+      def definition.get_binding
+        binding 
+      end
+
       cost = 40
 
       definition['mount_points'] = @linux_helper.partition_mount_points(@appliance_config.hardware.partitions)

data/lib/boxgrinder-build/plugins/os/rpm-based/rpm-based-os-plugin.rb

@@ -147,7 +147,7 @@ module BoxGrinder
       @log.debug "Cleaning appliance-creator mount points..."
 
       Dir["#{@dir.tmp}/imgcreate-*"].each do |dir|
-        dev_mapper = @exec_helper.execute "mount | grep #{dir} | awk '{print $1}'"
+        dev_mapper = @exec_helper.execute("mount | grep #{dir} | awk '{print $1}'").split("\n")
 
         mappings = {}
 
@@ -158,7 +158,7 @@ module BoxGrinder
           end
         end
 
-        (['/var/cache/yum', '/dev/shm', '/dev/pts', '/proc', '/sys'] + @appliance_config.hardware.partitions.keys.reverse).each do |mount_point|
+        (['/var/cache/yum', '/dev/shm', '/dev/pts', '/proc', '/sys'] + @appliance_config.hardware.partitions.keys.sort.reverse).each do |mount_point|
           @log.trace "Unmounting '#{mount_point}'..."
           @exec_helper.execute "umount -d #{dir}/install_root#{mount_point}"
         end
@@ -251,6 +251,11 @@ module BoxGrinder
 
     def install_repos(guestfs)
       @log.debug "Installing repositories from appliance definition file..."
+
+      # It seems that the directory is not always created by default if default repos are inhibited (e.g. SL6)
+      yum_d = '/etc/yum.repos.d/'
+      guestfs.mkdir_p(yum_d) if guestfs.exists(yum_d) == 0
+
       @appliance_config.repos.each do |repo|
         if repo['ephemeral']
           @log.debug "Repository '#{repo['name']}' is an ephemeral repo. It'll not be installed in the appliance."
@@ -264,7 +269,7 @@ module BoxGrinder
           repo_file << ("#{type}=#{repo[type]}\n") unless repo[type].nil?
         end
 
-        guestfs.write_file("/etc/yum.repos.d/#{repo['name']}.repo", repo_file, 0)
+        guestfs.write_file("#{yum_d}#{repo['name']}.repo", repo_file, 0)
       end
       @log.debug "Repositories installed."
     end

data/lib/boxgrinder-build/plugins/os/rpm-based/rpm-dependency-validator.rb

@@ -80,7 +80,7 @@ module BoxGrinder
       for name in package_list
         found = false
 
-        repoquery_output.each do |line|
+        repoquery_output.each_line do |line|
           line = line.strip
 
           package = line.match( /^([\S]+)-\d+:/ )

data/lib/boxgrinder-build/plugins/os/sl/sl-plugin.rb

@@ -20,7 +20,7 @@ require 'boxgrinder-build/plugins/os/rhel/rhel-plugin'
 
 module BoxGrinder
   class ScientificLinuxPlugin < RHELPlugin
-    plugin :type => :os, :name => :sl, :full_name  => "Scientific Linux", :versions   => ["5", "6"]
+    plugin :type => :os, :name => :sl, :full_name  => "Scientific Linux", :versions   => ["5", "6"], :require_root => true
 
     SL_REPOS = {
      "5" => {

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

@@ -22,7 +22,7 @@ require 'tempfile'
 
 module BoxGrinder
   class EC2Plugin < BasePlugin
-    plugin :type => :platform, :name => :ec2, :full_name => "Amazon Elastic Compute Cloud (Amazon EC2)"
+    plugin :type => :platform, :name => :ec2, :full_name => "Amazon Elastic Compute Cloud (Amazon EC2)", :require_root => true
 
     def after_init
       register_deliverable(:disk => "#{@appliance_config.name}.ec2")

data/lib/boxgrinder-build/util/concurrent/get_set.rb

@@ -0,0 +1,46 @@
+#
+# Copyright 2012 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 'thread'
+
+class GetSet
+  def initialize(initial_state=false)
+    @val = initial_state
+    @mutex = Mutex.new
+  end
+
+  # Atomic get-and-set.
+  #
+  # When used with a block, the existing value is provided as
+  # an argument to the block. The block's return value sets the
+  # object's value state.
+  #
+  # When used without a block; if a nil +set_val+ parameter is
+  # provided the existing state is returned. Else the object
+  # value state is set to +set_val+
+  def get_set(set_val=nil, &blk)
+    @mutex.synchronize do
+      if block_given?
+        @val = blk.call(@val)
+      else
+        @val = set_val unless set_val.nil?
+      end
+      @val
+    end
+  end
+end

data/lib/boxgrinder-build/util/permissions/fs-monitor.rb

@@ -0,0 +1,182 @@
+#
+# Copyright 2012 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 'thread'
+require 'observer'
+require 'pathname'
+require 'singleton'
+
+require 'boxgrinder-build/util/concurrent/get_set'
+
+module BoxGrinder
+  class FSMonitor
+    include Singleton
+    include Observable
+
+    def initialize
+      @flag = GetSet.new
+      @lock_a = Mutex.new
+      @lock_b = Mutex.new
+      set_hooks
+    end
+
+    # Start capturing paths. Providing a block automatically stops the
+    # capture process upon termination of the scope.
+    #
+    # @param Array<#update> Observers to be notified of capture
+    #   events. Each observer should expect a hash{} containing a
+    #   +:command+, and potentially +:data+.
+    #
+    # @yield Block that automatically calls #stop at the end of scope
+    #   to cease capture.
+    def capture(*observers, &block)
+      @lock_a.synchronize do
+        add_observers(observers)
+        _capture(&block)
+
+        if block_given?
+          yield
+          _stop
+        end
+      end
+    end
+
+    # Explicitly stop capturing paths. This should be utilised if
+    # capture was not used with a block. Fires the +:stop_capture+
+    # command to indicate that capturing has ceased.
+    def stop
+      @lock_a.synchronize { _stop }
+    end
+
+    # Stop any capturing and delete all observers. Useful for testing.
+    # @see #stop
+    def reset
+      @lock_a.synchronize do
+        _stop
+        delete_observers
+      end
+    end
+
+    # Add a path string. Called by the hooked methods when an
+    # applicable action is triggered and capturing is enabled. Fires
+    # the +:add_path+ command, and includes the full path as +:data+.
+    #
+    # If no observers have been assigned before a path is added, they
+    # will be silently lost.
+    #
+    # @param [String] path Filesystem path.
+    # @return [Boolean] False if no observers were present.
+    def add_path(path)
+      @lock_b.synchronize do
+        changed(true)
+        notify_observers(:command => :add_path, :data => realpath(path))
+      end
+    end
+
+    # Trigger ownership change immediately, but without ceasing. Fires
+    # the +:chown+ command on all observers.
+    # 
+    # @return [boolean] False if no observers were present.
+    def trigger
+      changed(true)
+      notify_observers(:command => :chown)
+    end
+
+    private # Not threadsafe
+
+    # The hooks will all use the same get-and-set to determine when to
+    # begin/cease capturing paths.
+    def _capture
+      @flag.get_set(true)
+    end
+    
+    def _stop
+      @flag.get_set(false)
+      changed(true)
+      notify_observers(:command => :stop_capture)
+    end
+
+    # Hooks to capture any standard file, link or directory creation. Other
+    # methods (e.g. FileUtils#mkdir_p, FileUtils#move), ultimately bottom out
+    # into these primitive functions.
+    def set_hooks
+      # Final splat var captures any other variables we are not interested in,
+      # and avoids them being squashed into the final var.
+      eigen_capture(File, [:open, :new], @flag) do |klazz, path, mode, *other|
+        add_path(path) if klazz == File && mode =~ /^(t|b)?((w|a)[+]?)(t|b)?$/
+      end
+
+      eigen_capture(File, [:rename, :symlink, :link], @flag) do |klazz, old, new, *other|
+        add_path(new)
+      end
+
+      eigen_capture(Dir, :mkdir, @flag) do |klazz, path, *other|
+        add_path(root_dir(path))
+      end
+    end
+
+    # Hooks into class methods by accessing the eigenclass (virtual class).
+    def eigen_capture(klazz, m_sym, flag, &blk)
+      v_klazz = (class << klazz; self; end)
+      instance_capture(v_klazz, m_sym, flag, &blk)
+    end
+
+    def instance_capture(klazz, m_sym, flag, &blk)
+      Array(m_sym).each{ |sym| alias_and_capture(klazz, sym, flag, &blk) }
+    end
+
+    # Cracks open the target class, and injects a wrapper to enable
+    # monitoring. By aliasing the original method the wrapper intercepts the
+    # call, which it forwards onto the 'real' method before executing the hook.
+    #
+    # The hook's functionality is provided via a &block, which is passed the
+    # caller's +self+ in addition to the wrapped method's parameters.
+    #
+    # Locking the +flag+ signals the hook to begin capturing.
+    def alias_and_capture(klazz, m_sym, flag, &blk)
+      alias_m_sym = "__alias_#{m_sym}"
+
+      klazz.class_eval do
+        alias_method alias_m_sym, m_sym
+
+        define_method(m_sym) do |*args, &blx|
+         response = send(alias_m_sym, *args, &blx)
+           blk.call(self, *args) if flag.get_set
+         response
+        end
+      end
+    end
+
+    def add_observers(observers)
+      observers.each{ |o| add_observer(o) unless o.nil? }
+    end
+
+    # Transform relative to absolute path
+    def realpath(path)
+      Pathname.new(path).realpath.to_s
+    end
+
+    # For a path relative such as 'x/y/z' returns 'x'. Useful for #mkdir_p
+    # where the entire new path is returned at once.
+    def root_dir(relpath)
+      r = relpath.match(%r(^[/]?.+?[/$]))
+      return relpath if r.nil?
+      r[0] || relpath
+    end
+  end
+end

data/lib/boxgrinder-build/util/permissions/fs-observer.rb

@@ -0,0 +1,82 @@
+#
+# Copyright 2012 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 'fileutils'
+require 'set'
+
+module BoxGrinder
+  class FSObserver
+    attr_accessor :path_set
+    attr_accessor :filter_set
+
+    # @param [Integer] user The uid to switch from root to
+    # @param [Integer] group The gid to switch from root to
+    # @param [Hash] opts The options to create a observer with
+    # @option opts [Array<String>] :paths Additional paths to change
+    #   ownership of.
+    # @option opts [String] :paths Additional path to to change
+    # ownership of
+    def initialize(user, group, opts={})
+      @path_set = Set.new(Array(opts[:paths]))
+      # Filter some default directories, plus any subdirectories of
+      # paths we discover at runtime
+      @filter_set = Set.new([%r(^/(etc|dev|sys|bin|sbin|etc|lib|lib64|boot|run|proc|selinux|tmp)(/|$))])
+      @user = user
+      @group = group
+    end
+
+    # Receives updates from FSMonitor#add_path
+    #
+    # @param [Hash] opts The options to update the observer
+    # @option opts [:symbol] :command The command to instruct the
+    #   observer to execute.
+    #   * +:add_path+ Indicates the +:data+ field contains a path.
+    #   * +:stop_capture+ indicates that capturing has ceased. The
+    #       observer will change ownership of the files, and switch
+    #       to the user specified at #initialize.
+    # @option opts [String] :data Contains a resource path when the 
+    #   * +:add_path+ Command is called, otherwise ignored.  
+    def update(update={})
+      case update[:command]
+        when :add_path
+          unless match_filter?(update[:data])
+            @path_set.add(update[:data])
+            @filter_set.merge(subdirectory_regex(update[:data]))
+          end
+        when :stop_capture, :chown
+          do_chown
+      end
+    end
+
+    private
+
+    def do_chown
+      @path_set.each do |p| 
+        FileUtils.chown_R(@user, @group, p, :force => true) if File.exist?(p)
+      end
+    end
+
+    def match_filter?(path)
+      @filter_set.inject(false){ |accum, filter| accum || !!(path =~ filter) }
+    end
+
+    def subdirectory_regex(paths)
+      Array(paths).collect{ |p| Regexp.new("^#{p}/") }
+    end
+  end
+end

data/lib/boxgrinder-build/util/permissions/user-switcher.rb

@@ -0,0 +1,42 @@
+#
+# Copyright 2012 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 'tmpdir'
+
+module BoxGrinder
+  class UserSwitcher
+  
+    def UserSwitcher.change_user(u, g, &blk)
+      prev_u, prev_g = Process.uid, Process.gid
+      set_user(u, g) 
+      blk.call
+      set_user(prev_u, prev_g)
+    end
+
+    private
+
+    # Working around bugs.... we can rely on the saved id to be able
+    # to sneak back to the previous user later.
+    def UserSwitcher.set_user(u, g)
+      return if Process.uid == u && Process.gid == g
+      # If already set to the given value
+      Process.egid, Process.gid = g, g
+      Process.euid, Process.uid = u, u
+    end
+  end
+end