omnibus 3.0.0 → 3.1.0

data/lib/omnibus/artifact.rb

@@ -1,3 +1,19 @@
+#
+# 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
   class Artifact
     attr_reader :path

data/lib/omnibus/build_version.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012-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.
@@ -16,7 +15,6 @@
 #
 
 require 'time'
-require 'omnibus/util'
 
 module Omnibus
   # Provides methods for generating Omnibus project build version
@@ -30,7 +28,8 @@ module Omnibus
   # @todo Rename this class to reflect its absolute dependence on running in a
   #   Git repository.
   class BuildVersion
-    include Omnibus::Util
+    include Logging
+    include Util
 
     # Formatting string for the timestamp component of our SemVer build specifier.
     #
@@ -38,10 +37,26 @@ module Omnibus
     # @see Time#strftime
     TIMESTAMP_FORMAT = '%Y%m%d%H%M%S'
 
-    # @deprecated Use {#semver} or {#git_describe} instead
-    def self.full
-      puts "#{name}.full is deprecated. Use #{name}.new.semver or #{name}.new.git_describe."
-      Omnibus::BuildVersion.new.git_describe
+    class << self
+      # @deprecated Use {#semver} or {#git_describe} instead
+      def full
+        log.deprecated(log_key) do
+          'BuildVersion.full. Please use BuildVersion.semver or ' \
+          'BuildVersion.git_describe instead.'
+        end
+
+        new.git_describe
+      end
+
+      # @see (BuildVersion#git_describe)
+      def git_describe
+        new.git_describe
+      end
+
+      # @see (BuildVersion#semver)
+      def semver
+        new.semver
+      end
     end
 
     # Create a new BuildVersion
@@ -129,17 +144,18 @@ module Omnibus
     # @return [String]
     def git_describe
       @git_describe ||= begin
-                          git_cmd = 'git describe'
-                          cmd = shellout(git_cmd, live_stream: nil, cwd: @path)
-                          if cmd.exitstatus == 0
-                            cmd.stdout.chomp
-                          else
-                            msg =  'Could not extract version information from `git describe`. '
-                            msg << 'Setting version to 0.0.0'
-                            puts msg
-                            '0.0.0'
-                          end
-                        end
+        cmd = quiet_shellout('git describe --tags', cwd: @path)
+
+        if cmd.exitstatus == 0
+          cmd.stdout.chomp
+        else
+          log.warn(log_key) do
+            "Could not extract version information from 'git describe'! " \
+            "Setting version to 0.0.0."
+          end
+          '0.0.0'
+        end
+      end
     end
 
     # @!endgroup
@@ -244,7 +260,7 @@ module Omnibus
     # same build will share the same timestamp.
     def build_start_time
       @build_start_time ||= begin
-                              if !ENV['BUILD_ID'].nil?
+                              if ENV['BUILD_ID']
                                 begin
                                   Time.strptime(ENV['BUILD_ID'], '%Y-%m-%d_%H-%M-%S')
                                 rescue ArgumentError
@@ -273,6 +289,9 @@ module Omnibus
       version_regexp.match(git_describe)[1..3]
     end
 
+    #
+    # @todo Remove this environment variable madness and just use the CLI
+    #
     def append_timestamp?
       if ENV['OMNIBUS_APPEND_TIMESTAMP'] && (ENV['OMNIBUS_APPEND_TIMESTAMP'] =~ (/^(false|f|no|n|0)$/i))
         false

data/lib/omnibus/build_version_dsl.rb

@@ -0,0 +1,136 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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
+  class BuildVersionDSL
+    include Logging
+
+    # DSL to construct a build_version during the build.
+    #
+    # @see Omnibus::Project#build_version
+    attr_reader :build_version
+    attr_reader :source_type
+    attr_reader :source_options
+    attr_reader :output_method
+
+    def initialize(version_string = nil, &block)
+      @build_version = nil
+      @source_type = nil
+      @source_options = nil
+      @output_method = nil
+
+      if version_string
+        @build_version = version_string
+      elsif block_given?
+        instance_eval(&block)
+        construct_build_version unless from_dependency?
+      else
+        raise "Please give me the build_version or tell me how to construct it"
+      end
+    end
+
+    # DSL method to set the source of the build_version
+    #
+    # @param source_type [Symbol] Can be set to :git or :version
+    # @param source_options [Hash] Options for the given source_type.
+    # @return [void]
+    def source(source_type, source_options = {})
+      @source_type = source_type
+      @source_options = source_options
+    end
+
+    # DSL method to set the output_format of the build_version. Only honored
+    #  when source_type is set to :git
+    #
+    # @param source_type [Symbol] Can be set to any method on Omnibus::BuildVersion
+    # @return [void]
+    def output_format(output_method)
+      @output_method = output_method
+    end
+
+    # Callback that is called by software objects to determine the version.
+    #
+    # @param dependency [Omnibus::Software] Software object that is making the callback.
+    # @return [void]
+    def resolve(dependency)
+      if from_dependency? && version_dependency == dependency.name
+        construct_build_version(dependency)
+        log.info(log_key) { "Build Version is set to '#{build_version}'" }
+      end
+    end
+
+    # Explains the build_version. Either gives its value or gives information about
+    # how it will be constructed.
+    #
+    # @return [String]
+    def explain
+      if build_version
+        "Build Version: #{@build_version}"
+      else
+        if from_dependency?
+          "Build Version will be determined from software '#{version_dependency}'"
+        else
+          "Build Version is not determined yet."
+        end
+      end
+    end
+
+    private
+
+    # Helper function to determine if build_version will be determined from a
+    # dependency.
+    #
+    # @return [Boolean]
+    def from_dependency?
+      source_options && version_dependency
+    end
+
+    # The name of the dependency that the build_version will be determined from.
+    #
+    # @return [String]
+    def version_dependency
+      source_options[:from_dependency]
+    end
+
+    # Determines the build_version based on source_type, output_method.
+    #
+    # @param version_source [Omnibus::Software] Software object from which the
+    #   build version will be determined from. Default is nil.
+    # @return [void]
+    def construct_build_version(version_source = nil)
+      case source_type
+      when :git
+        version = if version_source
+                    Omnibus::BuildVersion.new(version_source.project_dir)
+                  else
+                    Omnibus::BuildVersion.new
+                  end
+
+        output = output_method || :semver
+        @build_version = version.send(output)
+      when :version
+        if version_source
+          @build_version = version_source.version
+        else
+          raise "Please tell me the source to get the version from"
+        end
+      else
+        raise "I don't know how to construct a build_version using source '#{source_type}'"
+      end
+    end
+  end
+end

data/lib/omnibus/builder.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012-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.
@@ -16,12 +15,12 @@
 #
 
 require 'forwardable'
-require 'omnibus/exceptions'
-require 'omnibus/install_path_cache'
 require 'ostruct'
 
 module Omnibus
   class Builder
+    include Logging
+
     # Proxies method calls to either a Builder object or the Software that the
     # builder belongs to. Provides compatibility with our DSL where we never
     # yield objects to blocks and hopefully hides some of the confusion that
@@ -66,6 +65,7 @@ module Omnibus
     end
 
     # @todo code duplication with {Fetcher::ErrorReporter}
+    # @todo make this use the logger
     class ErrorReporter
       # @todo fetcher isn't even used
       def initialize(error, fetcher)
@@ -134,7 +134,7 @@ module Omnibus
       source = candidate_paths.find { |path| File.exist?(path) }
 
       unless source
-        fail MissingPatch.new(args[:source], candidate_paths)
+        raise MissingPatch.new(args[:source], candidate_paths)
       end
 
       plevel = args[:plevel] || 1
@@ -154,7 +154,7 @@ module Omnibus
       source_path = File.expand_path("#{Omnibus.project_root}/config/templates/#{name}/#{args[:source]}")
 
       unless File.exist?(source_path)
-        fail MissingTemplate.new(args[:source], "#{Omnibus.project_root}/config/templates/#{name}")
+        raise MissingTemplate.new(args[:source], "#{Omnibus.project_root}/config/templates/#{name}")
       end
 
       block do
@@ -202,15 +202,17 @@ module Omnibus
       @software.install_dir
     end
 
-    def log(message)
-      puts "[builder:#{name}] #{message}"
-    end
-
     def build
-      log "building #{name}"
-      log "version overridden from #{@software.default_version} to " \
-          "#{@software.version}" if @software.overridden?
-      time_it("#{name} build") do
+      log.info(log_key) { 'Starting...' }
+
+      if @software.overridden?
+        log.info(log_key) do
+          "Version overridden from #{@software.default_version} to "\
+          "#{@software.version}"
+        end
+      end
+
+      time_it('Build') do
         @build_commands.each do |cmd|
           execute(cmd)
         end
@@ -260,7 +262,9 @@ module Omnibus
       cmd_string = cmd_args[0..-2].join(' ')
       cmd_opts_for_display = to_kv_str(cmd_args.last)
 
-      log "Executing: `#{cmd_string}` with #{cmd_opts_for_display}"
+      log.debug(log_key) do
+        "Executing: `#{cmd_string}` with #{cmd_opts_for_display}"
+      end
 
       shell = Mixlib::ShellOut.new(*cmd)
       shell.environment['HOME'] = '/tmp' unless ENV['HOME']
@@ -281,7 +285,10 @@ module Omnibus
       else
         time_to_sleep = 5 * (2**retries)
         retries += 1
-        log "Failed to execute cmd #{cmd} #{retries} time(s). Retrying in #{time_to_sleep}s."
+        log.debug(log_key) do
+          "Failed to execute cmd `#{cmd}` #{retries} time(s). " \
+          "Retrying in #{time_to_sleep}s."
+        end
         sleep(time_to_sleep)
         retry
       end
@@ -295,7 +302,7 @@ module Omnibus
         # command as a string w/ opts
         ["#{str} #{cmd_args.first}", cmd_args.last]
       elsif cmd_args.size == 0
-        fail ArgumentError, "I don't even"
+        raise ArgumentError, "I don't even"
       else
         # cmd given as argv array
         cmd_args.dup.unshift(str)
@@ -318,11 +325,11 @@ module Omnibus
       yield
     rescue Exception
       elapsed = Time.now - start
-      log "#{what} failed, #{elapsed.to_f}s"
+      log.warn(log_key) { "#{what} failed! (#{elapsed.to_f}s)" }
       raise
     else
       elapsed = Time.now - start
-      log "#{what} succeeded, #{elapsed.to_f}s"
+      log.info(log_key) { "#{what} succeeded! (#{elapsed.to_f}s)" }
     end
 
     # Convert a hash to a string in the form `key=value`. It should work with
@@ -339,11 +346,9 @@ module Omnibus
         kv_pair_strs << "#{k}=#{val_str}"
       end.join(join_str)
     end
-  end
 
-  class NullBuilder < Builder
-    def build
-      log "Nothing to build for #{name}"
+    def log_key
+      @log_key ||= "#{super}: #{name}"
     end
   end
 end

data/lib/omnibus/cleaner.rb

@@ -0,0 +1,72 @@
+#
+# Copyright 2012-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 'thor'
+
+module Omnibus
+  class Cleaner < Thor::Group
+    include Thor::Actions
+
+    namespace :clean
+
+    argument :name,
+      banner: 'NAME',
+      desc: 'The name of the Omnibus project',
+      type: :string,
+      required: true
+
+    class_option :purge,
+      desc: 'Purge the packages and caches',
+      type: :boolean,
+      default: false
+
+    def initialize(*)
+      super
+
+      @project = Omnibus.project(name)
+      raise ProjectNotFound.new(name) unless @project
+    end
+
+    def clean_source_dir
+      Dir.glob("#{Omnibus.config.source_dir}/**/*").each(&method(:remove_file))
+    end
+
+    def clean_build_dir
+      Dir.glob("#{Omnibus.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))
+    end
+
+    def clean_cache_dir
+      return unless purge?
+      Dir.glob("#{Omnibus.config.cache_dir}/**/*").each(&method(:remove_file))
+    end
+
+    def clean_install_dir
+      return unless purge?
+      remove_file(@project.install_path)
+    end
+
+    private
+
+    def purge?
+      !!options[:purge]
+    end
+  end
+end