omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/build_version.rb

@@ -23,8 +23,7 @@ module Omnibus
   # @see Omnibus::Project#build_version
   #
   # @note Requires a Git repository
-  # @todo Add class method shortcuts for semver and git_describe
-  #   versions e.g., Omnibus::BuildVersion.semver.
+  #
   # @todo Rename this class to reflect its absolute dependence on running in a
   #   Git repository.
   class BuildVersion
@@ -38,16 +37,6 @@ module Omnibus
     TIMESTAMP_FORMAT = '%Y%m%d%H%M%S'
 
     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
@@ -61,7 +50,8 @@ module Omnibus
 
     # Create a new BuildVersion
     #
-    # @param [String] path      Path from which to read git version information
+    # @param [String] path
+    #   Path from which to read git version information
     def initialize(path = Config.project_root)
       @path = path
     end
@@ -231,13 +221,6 @@ module Omnibus
       match ? match[1].to_i : 0
     end
 
-    # @todo This method is never called in Omnibus.  Is this even used
-    #   (e.g., in the DSL files)?
-    def development_version?
-      patch = version_composition.last
-      patch.to_i.odd?
-    end
-
     # Indicates whether the version represents a pre-release or not, as
     # signalled by the presence of a pre-release tag in the version
     # string.

data/lib/omnibus/build_version_dsl.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# 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.
@@ -56,7 +55,7 @@ module Omnibus
     # 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
+    # @param output_method [Symbol] Can be set to any method on Omnibus::BuildVersion
     # @return [void]
     def output_format(output_method)
       @output_method = output_method

data/lib/omnibus/builder.rb

@@ -21,13 +21,11 @@ require 'pathname'
 
 module Omnibus
   class Builder
-    # Files to be ignored during a directory globbing
-    IGNORED_FILES = %w(. ..).freeze
-
     include Cleanroom
     include Digestable
     include Instrumentation
     include Logging
+    include Templating
     include Util
 
     #
@@ -80,12 +78,50 @@ module Omnibus
     # @return [void]
     #
     def command(command, options = {})
+      warn_for_shell_commands(command)
+
       build_commands << BuildCommand.new("Execute: `#{command}'") do
-        _shellout!(command, options)
+        shellout!(command, options)
       end
     end
     expose :command
 
+    #
+    # Execute the given make command. When present, this method will prefer the
+    # use of +gmake+ over +make+. If applicable, this method will also set
+    # the `MAKE=gmake` environment variable when gmake is to be preferred.
+    #
+    # @example With no arguments
+    #   make
+    #
+    # @example With arguments
+    #   make 'install'
+    #
+    # @example With custom make bin
+    #   make 'install', bin: '/path/to/custom/make'
+    #
+    # @param (see #command)
+    # @return (see #command)
+    #
+    def make(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      command = args.join(' ')
+
+      make = if makebin = options.delete(:bin)
+               makebin
+             elsif Omnibus.which('gmake')
+               env = options.delete(:env) || {}
+               env = { 'MAKE' => 'gmake' }.merge(env)
+               options[:env] = env
+               'gmake'
+             else
+               'make'
+             end
+
+      command("#{make} #{command}".strip, options)
+    end
+    expose :make
+
     #
     # Apply the patch by the given name. This method will search all possible
     # locations for a patch (such as {Config#software_gems}).
@@ -131,69 +167,32 @@ module Omnibus
       patches << patch_path
 
       build_commands << BuildCommand.new("Apply patch `#{source}'") do
-        _shellout!(command, options)
+        shellout!(command, options)
       end
     end
     expose :patch
 
     #
-    # The maximum number of build jobs, as computed from Ohai data. If the Ohai
-    # data is unavailable, +3+ is used.
-    #
-    # @todo Should this be moved to {Software}?
+    # The maximum number of workers suitable for this system.
     #
-    # @example
-    #   command "make install -j #{workers}"
-    #
-    # @return [Fixnum]
+    # @see (Config#workers)
     #
     def workers
-      if Ohai['cpu'] && Ohai['cpu']['total'] && Ohai['cpu']['total'].to_s =~ /^\d+$/
-        Ohai['cpu']['total'].to_i + 1
-      else
-        3
-      end
+      Config.workers
     end
     expose :workers
 
     #
-    # @deprecated Use {#max_build_jobs} instead.
+    # (see Util#windows_safe_path)
     #
-    # @example (see #max_build_jobs)
-    # @raise (see #max_build_jobs)
-    # @param (see #max_build_jobs)
-    # @return (see #max_build_jobs)
-    #
-    def max_build_jobs
-      log.deprecated(log_key) do
-        "max_build_jobs (DSL). Please use `workers' instead."
-      end
-
-      workers
-    end
-    expose :max_build_jobs
-
-    #
-    # Convert the given path to be appropiate for shelling out on Windows. Most
-    # internal calls will wrap paths automatically, but the +command+ method is
-    # unable to do so.
+    # Most internal Ruby methods will handle this automatically, but the
+    # +command+ method is unable to do so.
     #
     # @example
     #   command "#{windows_safe_path(install_dir)}\\embedded\\bin\\gem"
     #
-    # @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
+      super
     end
     expose :windows_safe_path
 
@@ -220,7 +219,7 @@ module Omnibus
     def ruby(command, options = {})
       build_commands << BuildCommand.new("ruby `#{command}'") do
         bin = windows_safe_path("#{install_dir}/embedded/bin/ruby")
-        _shellout!("#{bin} #{command}", options)
+        shellout!("#{bin} #{command}", options)
       end
     end
     expose :ruby
@@ -237,7 +236,7 @@ module Omnibus
     def gem(command, options = {})
       build_commands << BuildCommand.new("gem `#{command}'") do
         bin = windows_safe_path("#{install_dir}/embedded/bin/gem")
-        _shellout!("#{bin} #{command}", options)
+        shellout!("#{bin} #{command}", options)
       end
     end
     expose :gem
@@ -257,7 +256,7 @@ module Omnibus
     def bundle(command, options = {})
       build_commands << BuildCommand.new("bundle `#{command}'") do
         bin = windows_safe_path("#{install_dir}/embedded/bin/bundle")
-        _shellout!("#{bin} #{command}", options)
+        shellout!("#{bin} #{command}", options)
       end
     end
     expose :bundle
@@ -275,7 +274,7 @@ module Omnibus
     def rake(command, options = {})
       build_commands << BuildCommand.new("rake `#{command}'") do
         bin = windows_safe_path("#{install_dir}/embedded/bin/rake")
-        _shellout!("#{bin} #{command}", options)
+        shellout!("#{bin} #{command}", options)
       end
     end
     expose :rake
@@ -285,8 +284,6 @@ module Omnibus
     # no validation is performed. As a general rule, you should avoid this
     # method unless you know what you are doing.
     #
-    # TODO: the "name" does nothing right now
-    #
     # @example
     #   block do
     #     # Some complex operation
@@ -351,15 +348,11 @@ module Omnibus
       erbs << source_path
 
       block "Render erb `#{source}'" do
-        template = ERB.new(File.read(source_path), nil, '%')
-        struct   = OpenStruct.new(vars)
-        result   = template.result(struct.instance_eval { binding })
-
-        File.open(dest, 'w') do |file|
-          file.write(result)
-        end
-
-        File.chmod(mode, dest)
+        render_template(source_path,
+          destination: dest,
+          mode:        mode,
+          variables:   vars,
+        )
       end
     end
     expose :erb
@@ -374,7 +367,7 @@ module Omnibus
     # The following DSL methods are available from within build blocks that
     # mutate the file system.
     #
-    # **These commands are run from inside {Software#install_dir}, so exercise
+    # **These commands are run from inside {Software#project_dir}, so exercise
     # good judgement when using relative paths!**
     # --------------------------------------------------
 
@@ -391,7 +384,7 @@ module Omnibus
     #
     def mkdir(directory, options = {})
       build_commands << BuildCommand.new("mkdir `#{directory}'") do
-        Dir.chdir(software.install_dir) do
+        Dir.chdir(software.project_dir) do
           FileUtils.mkdir_p(directory, options)
         end
       end
@@ -410,7 +403,7 @@ module Omnibus
     #
     def touch(file, options = {})
       build_commands << BuildCommand.new("touch `#{file}'") do
-        Dir.chdir(software.install_dir) do
+        Dir.chdir(software.project_dir) do
           parent = File.dirname(file)
           FileUtils.mkdir_p(parent) unless File.directory?(parent)
 
@@ -433,8 +426,8 @@ module Omnibus
     #
     def delete(path, options = {})
       build_commands << BuildCommand.new("delete `#{path}'") do
-        Dir.chdir(software.install_dir) do
-          glob(path).each do |file|
+        Dir.chdir(software.project_dir) do
+          FileSyncer.glob(path).each do |file|
             FileUtils.rm_rf(file, options)
           end
         end
@@ -456,8 +449,8 @@ module Omnibus
     #
     def copy(source, destination, options = {})
       build_commands << BuildCommand.new("copy `#{source}' to `#{destination}'") do
-        Dir.chdir(software.install_dir) do
-          glob(source).each do |file|
+        Dir.chdir(software.project_dir) do
+          FileSyncer.glob(source).each do |file|
             FileUtils.cp_r(file, destination, options)
           end
         end
@@ -479,8 +472,8 @@ module Omnibus
     #
     def move(source, destination, options = {})
       build_commands << BuildCommand.new("move `#{source}' to `#{destination}'") do
-        Dir.chdir(software.install_dir) do
-          glob(source).each do |file|
+        Dir.chdir(software.project_dir) do
+          FileSyncer.glob(source).each do |file|
             FileUtils.mv(file, destination, options)
           end
         end
@@ -502,8 +495,8 @@ module Omnibus
     #
     def link(source, destination, options = {})
       build_commands << BuildCommand.new("link `#{source}' to `#{destination}'") do
-        Dir.chdir(software.install_dir) do
-          glob(source).each do |file|
+        Dir.chdir(software.project_dir) do
+          FileSyncer.glob(source).each do |file|
             FileUtils.ln_s(file, destination, options)
           end
         end
@@ -512,13 +505,7 @@ module Omnibus
     expose :link
 
     #
-    # Copy the files from +source+ to +destination+, while removing any files
-    # in +destination+ that are not present in +source+.
-    #
-    # You can pass the option +:exclude+ option to ignore files and folders that
-    # match the given pattern(s). Note the exclude pattern behaves on paths
-    # relative to the given source. If you want to exclude a nested directory,
-    # you will need to use something like +**/directory+.
+    # (see FileSyncer.sync)
     #
     # @example
     #   sync "#{project_dir}/**/*.rb", "#{install_dir}/ruby_files"
@@ -526,61 +513,10 @@ module Omnibus
     # @example
     #   sync project_dir, "#{install_dir}/files", exclude: '.git'
     #
-    # @param [String] source
-    #   the path on disk to sync from
-    # @param [String] destination
-    #   the path on disk to sync to
-    #
-    # @option options [String, Array<String>] :exclude
-    #   a file, folder, or globbing pattern of files to ignore when syncing
-    #
-    # @return (see #command)
-    #
     def sync(source, destination, options = {})
       build_commands << BuildCommand.new("sync `#{source}' to `#{destination}'") do
-        Dir.chdir(software.install_dir) do
-          # The source must be a destination in the sync command
-          unless File.directory?(source)
-            raise ArgumentError, "`source' must be a directory, but was a " \
-              "`#{File.ftype(source)}'! If you just want to sync a file, use " \
-              "the `copy' method instead."
-          end
-
-          # Reject any files that match the excludes pattern
-          excludes = Array(options[:exclude]).map do |exclude|
-            [exclude, "#{exclude}/*"]
-          end.flatten
-
-          source_files = all_files(source)
-          source_files = source_files.reject do |source_file|
-            basename = relative_path_for(source_file, source)
-            excludes.any? { |exclude| File.fnmatch?(exclude, basename, File::FNM_DOTMATCH) }
-          end
-
-          # Ensure the destination directory exists
-          FileUtils.mkdir_p(destination) unless File.directory?(destination)
-
-          # Copy over the filtered source files
-          FileUtils.cp_r(source_files, destination)
-
-          # Remove any files in the destination that are not in the source files
-          destination_files = all_files(destination)
-
-          # Calculate the relative paths of files so we can compare to the
-          # source.
-          relative_source_files = source_files.map do |file|
-            relative_path_for(file, source)
-          end
-          relative_destination_files = destination_files.map do |file|
-            relative_path_for(file, destination)
-          end
-
-          # Remove any extra files that are present in the destination, but are
-          # not in the source list
-          extra_files = relative_destination_files - relative_source_files
-          extra_files.each do |file|
-            FileUtils.rm_rf(File.join(destination, file))
-          end
+        Dir.chdir(software.project_dir) do
+          FileSyncer.sync(source, destination, options)
         end
       end
     end
@@ -590,29 +526,6 @@ module Omnibus
     # @!endgroup
     # --------------------------------------------------
 
-    #
-    # @!group Deprecated DSL methods
-    #
-    # The following DSL methods are available from within build blocks, but are
-    # deprecated and will be removed in the next major release.
-    # --------------------------------------------------
-
-    #
-    # @deprecated Use {Config.project_root} instead
-    #
-    def project_root
-      Omnibus.logger.deprecated(log_key) do
-        'project_root (DSL). Please use Config.project_root instead.'
-      end
-
-      Config.project_root
-    end
-    expose :project_root
-
-    #
-    # @!endgroup
-    # --------------------------------------------------
-
     #
     # @!group Public API
     #
@@ -715,12 +628,18 @@ module Omnibus
     #
     # @see (Util#shellout!)
     #
-    def _shellout!(command_string, options = {})
+    def shellout!(command_string, options = {})
       # Make sure the PWD is set to the correct directory
       options = { cwd: software.project_dir }.merge(options)
 
+      # Set the log level to :info so users will see build commands
+      options[:log_level] ||= :info
+
+      # Set the live stream to :debug so users will see build output
+      options[:live_stream] ||= log.live_stream(:debug)
+
       # Use Util's shellout
-      shellout!(command_string, options)
+      super(command_string, options)
     end
 
     #
@@ -748,8 +667,8 @@ module Omnibus
     # Execute the given block with (n) reties defined by {Config#build_retries}.
     # This method will only retry for the following exceptions:
     #
-    #   - +Mixlib::ShellOut::ShellCommandFailed+
-    #   - +Mixlib::ShellOut::CommandTimeout+
+    #   - +CommandFailed+
+    #   - +CommandTimeout+
     #
     # @param [Proc] block
     #   the block to execute
@@ -757,10 +676,7 @@ module Omnibus
     def with_retries(&block)
       tries = Config.build_retries
       delay = 5
-      exceptions = [
-        Mixlib::ShellOut::ShellCommandFailed,
-        Mixlib::ShellOut::CommandTimeout,
-      ]
+      exceptions = [CommandFailed, CommandTimeout]
 
       begin
         block.call
@@ -827,9 +743,8 @@ module Omnibus
     #
     def find_file(path, source)
       # Search for patches just like we search for software
-      candidate_paths = Omnibus.software_dirs.map do |directory|
-        full_path = directory.sub(Config.software_dir, path)
-        "#{full_path}/#{software.name}/#{source}"
+      candidate_paths = Omnibus.possible_paths_for(path).map do |directory|
+        File.join(directory, software.name, source)
       end
 
       file = candidate_paths.find { |path| File.exist?(path) }
@@ -837,38 +752,6 @@ module Omnibus
       [candidate_paths, file]
     end
 
-    #
-    # Get all the regular files and directories at the given path. It is assumed
-    # this path is a fully-qualified path and/or executed from a proper relative
-    # path.
-    #
-    # @param [String] path
-    #   the path to get all files from
-    #
-    # @return [Array<String>]
-    #   the list of all files
-    #
-    def all_files(path)
-      Dir.glob("#{path}/**/*", File::FNM_DOTMATCH).reject do |file|
-        basename = File.basename(file)
-        IGNORED_FILES.include?(basename)
-      end
-    end
-
-    #
-    # The relative path of the given +path+ to the +parent+.
-    #
-    # @param [String] path
-    #   the path to get relative with
-    # @param [String] parent
-    #   the parent where the path is contained (hopefully)
-    #
-    # @return [String]
-    #
-    def relative_path_for(path, parent)
-      Pathname.new(path).relative_path_from(Pathname.new(parent)).to_s
-    end
-
     #
     # The log key for this class, overriden to incorporate the software name.
     #
@@ -879,19 +762,28 @@ module Omnibus
     end
 
     #
-    # Glob across the given pattern, accounting for dotfiles, removing Ruby's
-    # dumb idea to include +'.'+ and +'..'+ as entries.
+    # Inspect the given command and warn if the command "looks" like it is a
+    # shell command that has a DSL method. (like +command 'cp'+ versus +copy+).
     #
-    # @param [String] path
-    #   the path to get all files from
+    # @param [String] command
+    #   the command to check
     #
-    # @return [Array<String>]
-    #   the list of all files
+    # @return [void]
     #
-    def glob(pattern)
-      Dir.glob(pattern, File::FNM_DOTMATCH).reject do |file|
-        basename = File.basename(file)
-        IGNORED_FILES.include?(basename)
+    def warn_for_shell_commands(command)
+      case command
+      when /^cp /i
+        log.warn(log_key) { "Detected command `cp'. Consider using the `copy' DSL method." }
+      when /^rubocopy /i
+        log.warn(log_key) { "Detected command `rubocopy'. Consider using the `sync' DSL method." }
+      when /^mv /i
+        log.warn(log_key) { "Detected command `mv'. Consider using the `move' DSL method." }
+      when /^rm /i
+        log.warn(log_key) { "Detected command `rm'. Consider using the `delete' DSL method." }
+      when /^remove /i
+        log.warn(log_key) { "Detected command `remove'. Consider using the `delete' DSL method." }
+      when /^rsync /i
+        log.warn(log_key) { "Detected command `rsync'. Consider using the `sync' DSL method." }
       end
     end