omnibus 3.1.1 → 3.2.0.rc.1

data/lib/omnibus/build_version.rb

@@ -62,7 +62,7 @@ module Omnibus
     # Create a new BuildVersion
     #
     # @param [String] path      Path from which to read git version information
-    def initialize(path = Omnibus.project_root)
+    def initialize(path = Config.project_root)
       @path = path
     end
 
@@ -81,7 +81,7 @@ module Omnibus
     #
     # By default, a timestamp is incorporated into the build component of
     # version string (see {Omnibus::BuildVersion::TIMESTAMP_FORMAT}). This
-    # option is configurable via the {Omnibus::Config}.
+    # option is configurable via the {Config}.
     #
     # @example 11.0.0-alpha.1+20121218164140.git.207.694b062
     # @return [String]

data/lib/omnibus/builder.rb

@@ -37,7 +37,7 @@ module Omnibus
       def_delegator :@builder, :rake
       def_delegator :@builder, :block
       def_delegator :@builder, :name
-      def_delegator :@builder, :project_root
+      def_delegator :@builder, :max_build_jobs
 
       def initialize(builder, software)
         @builder, @software = builder, software
@@ -122,13 +122,10 @@ module Omnibus
     def patch(*args)
       args = args.dup.pop
 
-      # we'll search for a patch file in the project root AND
-      # the omnibus-software gem
-      candidate_roots = [Omnibus.project_root]
-      candidate_roots << Omnibus.omnibus_software_root if Omnibus.omnibus_software_root
-
-      candidate_paths = candidate_roots.map do |root|
-        File.expand_path("#{root}/config/patches/#{name}/#{args[:source]}")
+      # Search for patches just like we search for software
+      candidate_paths = Omnibus.software_dirs.map do |directory|
+        patches = directory.sub(Config.software_dir, 'config/patches')
+        "#{patches}/#{name}/#{args[:source]}"
       end
 
       source = candidate_paths.find { |path| File.exist?(path) }
@@ -151,10 +148,10 @@ module Omnibus
     def erb(*args)
       args = args.dup.pop
 
-      source_path = File.expand_path("#{Omnibus.project_root}/config/templates/#{name}/#{args[:source]}")
+      source_path = File.expand_path("#{Config.project_root}/config/templates/#{name}/#{args[:source]}")
 
       unless File.exist?(source_path)
-        raise MissingTemplate.new(args[:source], "#{Omnibus.project_root}/config/templates/#{name}")
+        raise MissingTemplate.new(args[:source], "#{Config.project_root}/config/templates/#{name}")
       end
 
       block do
@@ -190,14 +187,32 @@ module Omnibus
       @build_commands << rb_block
     end
 
+    #
+    # @deprecated Use {Config.project_root} instead
+    #
     def project_root
-      Omnibus.project_root
+      Omnibus.logger.deprecated(log_key) do
+        'project_root (DSL). Please use Config.project_root instead.'
+      end
+
+      Config.project_root
     end
 
     def project_dir
       @software.project_dir
     end
 
+    #
+    # @deprecated Use {install_path} instead
+    #
+    def install_path
+      log.deprecated(log_key) do
+        'install_path (DSL). Please use install_dir instead.'
+      end
+
+      install_dir
+    end
+
     def install_dir
       @software.install_dir
     end
@@ -228,6 +243,14 @@ module Omnibus
       end
     end
 
+    def max_build_jobs
+      if Ohai['cpu'] && Ohai['cpu']['total'] && Ohai['cpu']['total'].to_s =~ /^\d+$/
+        Ohai['cpu']['total'].to_i + 1
+      else
+        3
+      end
+    end
+
     private
 
     def execute_proc(cmd)
@@ -239,10 +262,6 @@ module Omnibus
       raise
     end
 
-    def build_retries
-      Omnibus.config[:build_retries]
-    end
-
     def execute_sh(cmd)
       retries ||= 0
       shell = nil
@@ -262,7 +281,7 @@ module Omnibus
       cmd_string = cmd_args[0..-2].join(' ')
       cmd_opts_for_display = to_kv_str(cmd_args.last)
 
-      log.debug(log_key) do
+      log.info(log_key) do
         "Executing: `#{cmd_string}` with #{cmd_opts_for_display}"
       end
 
@@ -275,17 +294,17 @@ module Omnibus
         shell.error!
       end
     rescue Exception => e
-      raise if build_retries.nil? || build_retries == 0
+      raise if Config.build_retries.nil? || Config.build_retries == 0
       # Getting lots of errors from github, particularly with erlang/rebar
       # projects fetching tons of deps via git all the time. This isn't a
       # particularly elegant way to solve that problem. But it should work.
-      if retries >= build_retries
+      if retries >= Config.build_retries
         ErrorReporter.new(e, self).explain("Failed to build #{name} while running `#{cmd_string}` with #{cmd_opts_for_display}")
         raise
       else
         time_to_sleep = 5 * (2**retries)
         retries += 1
-        log.debug(log_key) do
+        log.info(log_key) do
           "Failed to execute cmd `#{cmd}` #{retries} time(s). " \
           "Retrying in #{time_to_sleep}s."
         end

data/lib/omnibus/cleaner.rb

@@ -41,26 +41,26 @@ module Omnibus
     end
 
     def clean_source_dir
-      Dir.glob("#{Omnibus.config.source_dir}/**/*").each(&method(:remove_file))
+      Dir.glob("#{Config.source_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_build_dir
-      Dir.glob("#{Omnibus.config.build_dir}/**/*").each(&method(:remove_file))
+      Dir.glob("#{Config.build_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_package_dir
       return unless purge?
-      Dir.glob("#{Omnibus.config.package_dir}/**/*").each(&method(:remove_file))
+      Dir.glob("#{Config.package_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_cache_dir
       return unless purge?
-      Dir.glob("#{Omnibus.config.cache_dir}/**/*").each(&method(:remove_file))
+      Dir.glob("#{Config.cache_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_install_dir
       return unless purge?
-      remove_file(@project.install_path)
+      remove_file(@project.install_dir)
     end
 
     private

data/lib/omnibus/cleanroom.rb

@@ -0,0 +1,141 @@
+#
+# 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.
+#
+
+module Omnibus
+  module Cleanroom
+    #
+    # Callback for when this module is included.
+    #
+    # @param [Class] base
+    #
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    #
+    # Class methods
+    #
+    module ClassMethods
+      #
+      # Evaluate the file in the context of the cleanroom.
+      #
+      # @param [Class] instance
+      #   the instance of the class to evaluate against
+      # @param [String] filepath
+      #   the path of the file to evaluate
+      #
+      def evaluate_file(instance, filepath)
+        absolute_path = File.expand_path(filepath)
+        file_contents = IO.read(absolute_path)
+        evaluate(instance, file_contents, absolute_path, 1)
+      end
+
+      #
+      # Evaluate the string or block in the context of the cleanroom.
+      #
+      # @param [Class] instance
+      #   the instance of the class to evaluate against
+      # @param [Array<String>] args
+      #   the args to +instance_eval+
+      # @param [Proc] block
+      #   the block to +instance_eval+
+      #
+      def evaluate(instance, *args, &block)
+        cleanroom.new(instance).instance_eval(*args, &block)
+      end
+
+      #
+      # Expose the given method to the DSL.
+      #
+      # @param [Symbol] name
+      #
+      def expose(name)
+        unless public_method_defined?(name)
+          raise NameError, "undefined method `#{name}' for class `#{self.name}'"
+        end
+
+        exposed[name] = true
+      end
+
+      private
+
+      #
+      # The list of exposed methods.
+      #
+      # @return [Hash]
+      #
+      def exposed
+        @exposed ||= {}
+      end
+
+      #
+      # The cleanroom instance for this class. This method is intentionally
+      # NOT cached!
+      #
+      # @return [Class]
+      #
+      def cleanroom
+        exposed_methods = exposed.keys
+        parent = self.name
+
+        Class.new do
+          define_method(:initialize) do |instance|
+            @instance = instance
+          end
+
+          exposed_methods.each do |exposed_method|
+            define_method(exposed_method) do |*args, &block|
+              @instance.send(exposed_method, *args, &block)
+            end
+          end
+
+          define_method(:inspect) do
+            "#<#{parent} (Cleanroom)>"
+          end
+          alias_method :to_s, :inspect
+        end
+      end
+    end
+
+    #
+    # Instance Mehtods
+    #
+    module InstanceMethods
+      #
+      # Evaluate the file against the current instance.
+      #
+      # @param (see Cleanroom.evaluate_file)
+      # @return [self]
+      #
+      def evaluate_file(filepath)
+        self.class.evaluate_file(self, filepath)
+        self
+      end
+
+      #
+      # Evaluate the contents against the current instance.
+      #
+      # @param (see Cleanroom.evaluate_file)
+      # @return [self]
+      #
+      def evaluate(*args, &block)
+        self.class.evaluate(self, *args, &block)
+        self
+      end
+    end
+  end
+end

data/lib/omnibus/cli.rb

@@ -40,14 +40,11 @@ module Omnibus
 
         Omnibus::CLI.start(@argv)
         @kernel.exit(0)
-      rescue => e
+      rescue Omnibus::Error => e
         error = Omnibus.ui.set_color(e.message, :red)
+        backtrace = Omnibus.ui.set_color("\n" + e.backtrace.join("\n  "), :red)
         Omnibus.ui.error(error)
-
-        if log.debug?
-          backtrace = Omnibus.ui.set_color("\n" + e.backtrace.join("\n  "), :red)
-          Omnibus.ui.error(backtrace)
-        end
+        Omnibus.ui.error(backtrace)
 
         if e.respond_to?(:status_code)
           @kernel.exit(e.status_code)
@@ -119,10 +116,10 @@ module Omnibus
     #
     # Publish Omnibus package(s) to a backend.
     #
-    #   $ omnibus release --project chefdk
+    #   $ omnibus publish s3 pkg/*chef*
     #
-    register(Command::Release, 'release', 'release', 'Publish Omnibus packages')
-    CLI.tasks['clean'].options = Command::Release.class_options
+    register(Command::Publish, 'publish', 'publish [COMMAND]', 'Publish Omnibus packages to a backend')
+    CLI.tasks['publish'].options = Command::Publish.class_options
 
     #
     # Display version information.

data/lib/omnibus/cli/base.rb

@@ -26,7 +26,8 @@ module Omnibus
         # Handle the case where Thor thinks a trailing --help is actually an
         # argument and blows up...
         if args.length > 1 && !(args & Thor::HELP_MAPPINGS).empty?
-          args.unshift('help')
+          args = args - Thor::HELP_MAPPINGS
+          args.insert(-2, 'help')
         end
 
         super

data/lib/omnibus/cli/cache.rb

@@ -19,20 +19,20 @@ module Omnibus
     namespace :cache
 
     #
-    # List the existing source packages in the cache.
+    # List the existing software packages in the cache.
     #
     #   $ omnibus cache existing
     #
-    desc 'existing', 'List source packages which exist in the cache'
+    desc 'existing', 'List software packages which exist in the cache'
     def existing
-      result = cache.list
+      result = S3Cache.list
 
       if result.empty?
         say('There are no packages in the cache!')
       else
         say('The following packages are in the cache:')
-        result.each do |source|
-          say("  * #{source.name}")
+        result.each do |software|
+          say("  * #{software.name}-#{software.version}")
         end
       end
     end
@@ -44,7 +44,7 @@ module Omnibus
     #
     desc 'list', 'List all cached files (by S3 key)'
     def list
-      result = cache.list_by_key
+      result = S3Cache.keys
 
       if result.empty?
         say('There is nothing in the cache!')
@@ -57,33 +57,33 @@ module Omnibus
     end
 
     #
-    # List missing source packages.
+    # List missing software packages.
     #
     #   $ omnibus cache missing
     #
-    desc 'missing', 'Lists source packages that are required but not yet cached'
+    desc 'missing', 'Lists software packages that are required but not yet cached'
     def missing
-      result = cache.missing
+      result = S3Cache.missing
 
       if result.empty?
         say('There are no missing packages in the cache.')
       else
         say('The following packages are missing from the cache:')
-        result.each do |source|
-          say(source.name)
+        result.each do |software|
+          say("  * #{software.name}-#{software.version}")
         end
       end
     end
 
     #
-    # Fetch missing source packages locally
+    # Fetch missing software packages locally
     #
     #   $ omnibus cache fetch
     #
-    desc 'fetch', 'Fetches missing source packages locally'
+    desc 'fetch', 'Fetches missing software packages locally'
     def fetch
       say('Fetching missing packages...')
-      cache.fetch_missing
+      S3Cache.fetch_missing
     end
 
     #
@@ -94,13 +94,7 @@ module Omnibus
     desc 'populate', 'Populate the S3 Cache'
     def populate
       say('Populating the cache...')
-      cache.populate
-    end
-
-    private
-
-    def cache
-      @cache ||= S3Cache.new
+      S3Cache.populate
     end
   end
 end