omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/templating.rb

@@ -0,0 +1,66 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'erb'
+
+module Omnibus
+  module Templating
+    def self.included(base)
+      # This module also requires logging
+      base.send(:include, Logging)
+    end
+
+    #
+    # Render an erb template on disk at +source+. If the +:destination+ option
+    # is given, the file will be rendered at +:destination+, otherwise the
+    # template is rendered next to +source+, removing the 'erb' extension of the
+    # template.
+    #
+    # @param [String] source
+    #   the path on disk where the ERB template lives
+    #
+    # @option options [String] :destination (default: +source+)
+    #   the destination where the rendered ERB should reside
+    # @option options [Fixnum] :mode (default: +0644+)
+    #   the mode of the rendered file
+    # @option options [Hash] :variables (default: +{}+)
+    #   the list of variables to pass to the template
+    #
+    def render_template(source, options = {})
+      destination = options.delete(:destination) || source.chomp('.erb')
+
+      mode      = options.delete(:mode) || 0644
+      variables = options.delete(:variables) || {}
+
+      log.info(log_key) { "Rendering `#{source}' to `#{destination}'" }
+
+      unless options.empty?
+        raise ArgumentError,
+          "Unknown option(s): #{options.keys.map(&:inspect).join(', ')}"
+      end
+
+      template = ERB.new(File.read(source), nil, '-')
+      struct   = Struct.new(*variables.keys).new(*variables.values)
+      result   = template.result(struct.instance_eval { binding })
+
+      File.open(destination, 'w', mode) do |file|
+        file.write(result)
+      end
+
+      true
+    end
+  end
+end

data/lib/omnibus/thread_pool.rb

@@ -0,0 +1,109 @@
+#
+# Copyright 2014 Mike Heijmans
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thread'
+
+module Omnibus
+  class ThreadPool
+
+    #
+    # Create a new thread pool of the given size. If a block is given, it is
+    # assumed the thread pool is wrapping an operation and will block until all
+    # operations complete.
+    #
+    # @example Using a block
+    #   ThreadPool.new(5) do |pool|
+    #     complex_things.each do |thing|
+    #       pool.schedule { thing.run }
+    #     end
+    #   end
+    #
+    # @example Using the object
+    #   pool = ThreadPool.new(5)
+    #   # ...
+    #   pool.schedule { complex_operation_1 }
+    #   pool.schedule { complex_operation_2 }
+    #   # ...
+    #   pool.schedule { complex_operation_4 }
+    #   # ...
+    #   pool.shutdown
+    #
+    #   # or
+    #
+    #   at_exit { pool.shutdown }
+    #
+    # @param [Integer] size
+    #   the number of items to put in the thread pool
+    #
+    def initialize(size)
+      @size = size
+      @jobs = Queue.new
+
+      @pool = Array.new(@size) do |i|
+        Thread.new do
+          Thread.abort_on_exception = true
+          Thread.current[:id] = i
+
+          catch(:exit) do
+            loop do
+              job, args = @jobs.pop
+              job.call(*args)
+            end
+          end
+        end
+      end
+
+      if block_given?
+        yield self
+        shutdown
+      end
+    end
+
+    #
+    # Schedule a single item onto the queue. If arguments are given, those
+    # arguments are used when calling the block in the queue. This is useful
+    # if you have arguments that you need to pass in from a parent binding.
+    #
+    # @param [Object, Array<Object>] args
+    #   the arguments to pass to the block when calling
+    # @param [Proc] block
+    #   the block to execute
+    #
+    # @return [void]
+    #
+    def schedule(*args, &block)
+      @jobs << [block, args]
+    end
+
+    #
+    # Stop the thread pool. This method quietly injects an exit clause into the
+    # queue (sometimes called "poison") and then waits for all threads to
+    # exit.
+    #
+    # @return [true]
+    #
+    def shutdown
+      @size.times do
+        schedule { throw :exit }
+      end
+
+      @pool.map(&:join)
+
+      true
+    end
+  end
+end

data/lib/omnibus/util.rb

@@ -18,13 +18,18 @@ require 'mixlib/shellout'
 
 module Omnibus
   module Util
+    def self.included(base)
+      # This module requires logging is also available
+      base.send(:include, Logging)
+    end
+
     #
     # The default shellout options.
     #
     # @return [Hash]
     #
     SHELLOUT_OPTIONS = {
-      live_stream: Omnibus.logger.live_stream(:debug),
+      log_level: :internal,
       timeout: 7200, # 2 hours
       environment: {},
     }.freeze
@@ -48,6 +53,12 @@ module Omnibus
       options = args.last.kind_of?(Hash) ? args.pop : {}
       options = SHELLOUT_OPTIONS.merge(options)
 
+      # Grab the log_level
+      log_level = options.delete(:log_level)
+
+      # Set the live stream if one was not given
+      options[:live_stream] ||= log.live_stream(:internal)
+
       # Since Mixlib::ShellOut supports :environment and :env, we want to
       # standardize here
       if options[:env]
@@ -56,14 +67,14 @@ module Omnibus
 
       # Log any environment options given
       unless options[:environment].empty?
-        Omnibus.logger.info { 'Environment:' }
-        options[:environment].each do |key, value|
-          Omnibus.logger.info { "  #{key.to_s.upcase}=#{value.inspect}" }
+        log.public_send(log_level, log_key)  { 'Environment:' }
+        options[:environment].sort.each do |key, value|
+          log.public_send(log_level, log_key)  { "  #{key.to_s.upcase}=#{value.inspect}" }
         end
       end
 
       # Log the actual command
-      Omnibus.logger.info { "$ #{args.join(' ')}" }
+      log.public_send(log_level, log_key) { "$ #{args.join(' ')}" }
 
       cmd = Mixlib::ShellOut.new(*args, options)
       cmd.environment['HOME'] = '/tmp' unless ENV['HOME']
@@ -71,32 +82,143 @@ module Omnibus
       cmd
     end
 
+    #
     # Similar to +shellout+ method except it raises an exception if the
     # command fails.
     #
     # @see #shellout
     #
-    # @raise [Mixlib::ShellOut::ShellCommandFailed] if +exitstatus+ is not in
-    #   the list of +valid_exit_codes+.
+    # @raise [CommandFailed]
+    #   if +exitstatus+ is not in the list of +valid_exit_codes+
+    # @raise [CommandTimeout]
+    #   if execution time exceeds +timeout+
     #
     def shellout!(*args)
       cmd = shellout(*args)
       cmd.error!
       cmd
+    rescue Mixlib::ShellOut::ShellCommandFailed
+      raise CommandFailed.new(cmd)
+    rescue Mixlib::ShellOut::CommandTimeout
+      raise CommandTimeout.new(cmd)
     end
 
-    # Return true if the given value appears to be "truthy".
     #
-    # @param [#to_s] value
-    def truthy?(value)
-      value && value.to_s =~ /^(true|t|yes|y|1)$/i
+    # Convert the given path to be appropiate for shelling out on Windows.
+    #
+    # @param [String, Array<String>] pieces
+    #   the pieces of the path to join and fix
+    # @return [String]
+    #   the path with applied changes
+    #
+    def windows_safe_path(*pieces)
+      path = File.join(*pieces)
+
+      if File::ALT_SEPARATOR
+        path.gsub(File::SEPARATOR, File::ALT_SEPARATOR)
+      else
+        path
+      end
     end
 
-    # Return true if the given value appears to be "falsey".
     #
-    # @param [#to_s] value
-    def falsey?(value)
-      value && value.to_s =~ /^(false|f|no|n|0)$/i
+    # Create a directory at the given +path+.
+    #
+    # @param [String, Array<String>] paths
+    #   the path or list of paths to join to create
+    #
+    # @return [String]
+    #   the path to the created directory
+    #
+    def create_directory(*paths)
+      path = File.join(*paths)
+      log.debug(log_key) { "Creating directory `#{path}'" }
+      FileUtils.mkdir_p(path)
+      path
+    end
+
+    #
+    # Remove the directory at the given +path+.
+    #
+    # @param [String, Array<String>] paths
+    #   the path or list of paths to join to delete
+    #
+    # @return [String]
+    #   the path to the removed directory
+    #
+    def remove_directory(*paths)
+      path = File.join(*paths)
+      log.debug(log_key) { "Remove directory `#{path}'" }
+      FileUtils.rm_rf(path)
+      path
+    end
+
+    #
+    # Copy the +source+ file to the +destination+.
+    #
+    # @param [String] source
+    # @param [String] destination
+    #
+    # @return [String]
+    #   the destination path
+    #
+    def copy_file(source, destination)
+      log.debug(log_key) { "Copying `#{source}' to `#{destination}'" }
+      FileUtils.cp(source, destination)
+      destination
+    end
+
+    #
+    # Remove the file at the given path.
+    #
+    # @param [String, Array<String>] paths
+    #   the path or list of paths to join to delete
+    #
+    # @return [String]
+    #   the path to the removed file
+    #
+    def remove_file(*paths)
+      path = File.join(*paths)
+      log.debug(log_key) { "Removing file `#{path}'" }
+      FileUtils.rm_f(path)
+      path
+    end
+
+    #
+    # Create a file at the given path. If a block is given, the contents of the
+    # block are written to the file. If the block is not given, the file is
+    # simply "touched".
+    #
+    # @param [String, Array<String>] paths
+    #   the path or list of paths to join to create
+    #
+    # @return [String]
+    #   the path to the created file
+    #
+    def create_file(*paths, &block)
+      path = File.join(*paths)
+      log.debug(log_key) { "Creating file `#{path}'" }
+
+      FileUtils.mkdir_p(File.dirname(path))
+
+      if block
+        File.open(path, 'wb') { |f| f.write(block.call) }
+      else
+        FileUtils.touch(path)
+      end
+
+      path
+    end
+
+    #
+    # Create a symlink from a to b
+    #
+    # @param [String] a
+    # @param [String] b
+    #
+    def create_link(a, b)
+      log.debug(log_key) { "Linking `#{a}' to `#{b}'" }
+      FileUtils.ln_s(a, b)
     end
   end
 end

data/lib/omnibus/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Omnibus
-  VERSION = '3.2.2'
+  VERSION = '4.0.0.beta.1'
 end

data/omnibus.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'chef-sugar',      '~> 1.2'
+  gem.add_dependency 'chef-sugar',      '~> 2.2'
+  gem.add_dependency 'cleanroom',       '~> 1.0'
   gem.add_dependency 'mixlib-shellout', '~> 1.4'
   gem.add_dependency 'ohai',            '~> 7.2'
-  gem.add_dependency 'fpm',             '~> 0.4'
   gem.add_dependency 'uber-s3'
   gem.add_dependency 'thor',            '~> 0.18'
 

data/resources/bff/gen.template.erb

@@ -0,0 +1,22 @@
+Package Name: <%= name %>
+Package VRMF: <%= version %>
+Update: N
+Fileset
+  Fileset Name: <%= name %>
+  Fileset VRMF: <%= version %>
+  Fileset Description: <%= description %>
+  USRLIBLPPFiles
+    Configuration Script: <%= configuration_script %>
+    Unconfiguration Script: <%= unconfiguration_script %>
+  EOUSRLIBLPPFiles
+  Bosboot required: N
+  License agreement acceptance required: N
+  Include license files in this package: N
+  Requisites:
+  ROOT Part: Y
+  ROOTFiles
+<% files.each do |file| -%>
+    <%= file %>
+<% end -%>
+  EOROOTFiles
+EOFileset

data/resources/deb/conffiles.erb

@@ -0,0 +1,3 @@
+<% config_files.each do |file| -%>
+<%= file %>
+<% end -%>

data/resources/deb/control.erb

@@ -0,0 +1,25 @@
+Package: <%= name %>
+Version: <%= version %>-<%= iteration %>
+License: <%= license %>
+Vendor: <%= vendor %>
+Architecture: <%= architecture %>
+Maintainer: <%= maintainer  %>
+Installed-Size: <%= installed_size %>
+<% unless dependencies.empty? -%>
+Depends: <%= dependencies.join(', ') %>
+<% end -%>
+<% unless conflicts.empty? -%>
+Conflicts: <%= conflicts.join(', ') %>
+<% end -%>
+<% unless replaces.empty? -%>
+Replaces: <%= replaces.join(', ') %>
+<% end -%>
+Section: <%= section %>
+Priority: <%= priority %>
+Homepage: <%= homepage %>
+<% lines = description.split("\n") -%>
+<% firstline, *remainder = lines -%>
+Description: <%= firstline %>
+<% if remainder.any? -%>
+<%= remainder.collect { |l| l =~ /^ *$/ ? " ." : " #{l}" }.join("\n") %>
+<% end -%>