omnibus 3.0.0 → 3.1.0

data/features/step_definitions/generator_steps.rb

@@ -0,0 +1,28 @@
+require 'aruba/api'
+
+Given(/^I have an omnibus project named "(.+)"$/) do |name|
+  create_dir(name)
+  cd(name)
+
+  write_file("config/projects/#{name}.rb", <<-EOH.gsub(/^ {4}/, ''))
+    name '#{name}'
+    maintainer 'Mrs. Maintainer'
+    homepage 'https://example.com'
+    install_path './local/build/#{name}'
+
+    build_version '1.0.0'
+
+    exclude '\.git*'
+    exclude 'bundler\/git'
+  EOH
+
+  write_file('omnibus.rb', <<-EOH.gsub(/^ {4}/, ''))
+    # Build configuration
+    cache_dir              './local/omnibus/cache'
+    install_path_cache_dir './local/omnibus/cache/install_path'
+    source_dir             './local/omnibus/src'
+    build_dir              './local/omnibus/build'
+    package_dir            './local/omnibus/pkg'
+    package_tmp            './local/omnibus/pkg-tmp'
+  EOH
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'aruba'
+require 'aruba/cucumber'
+require 'aruba/in_process'
+
+require 'omnibus/cli'
+
+Before do
+  # Reset anything that might have been cached in the Omnibus project
+  Omnibus.reset!(true)
+
+  Aruba::InProcess.main_class = Omnibus::CLI::Runner
+  Aruba.process = Aruba::InProcess
+end

data/lib/omnibus.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.
@@ -15,293 +14,373 @@
 # limitations under the License.
 #
 
-require 'ohai'
-o = Ohai::System.new
-o.require_plugin('os')
-o.require_plugin('platform')
-o.require_plugin('linux/cpu') if o.os == 'linux'
-o.require_plugin('kernel')
-OHAI = o
-
-require 'omnibus/library'
-require 'omnibus/reports'
-require 'omnibus/config'
+require 'pathname'
+
 require 'omnibus/exceptions'
-require 'omnibus/software'
-require 'omnibus/project'
-require 'omnibus/fetchers'
-require 'omnibus/health_check'
-require 'omnibus/build_version'
-require 'omnibus/sugar'
-require 'omnibus/overrides'
 require 'omnibus/version'
 
-require 'pathname'
-
 module Omnibus
-  DEFAULT_CONFIG_FILENAME = 'omnibus.rb'.freeze
-
-  module Packager
-    autoload :Base,   'omnibus/packagers/base'
-    autoload :MacDmg, 'omnibus/packagers/mac_dmg'
-    autoload :MacPkg, 'omnibus/packagers/mac_pkg'
-  end
-
-  # Configure Omnibus.
   #
-  # After this has been called, the {Omnibus::Config} object is
-  # available as `Omnibus.config`.
+  # The path to the default configuration file.
   #
-  # @return [void]
+  # @return [String]
   #
-  # @deprecated Use {#load_configuration} if you need to process a
-  #   config file, followed by {#process_configuration} to act upon it.
-  def self.configure
-    load_configuration
-    process_configuration
+  DEFAULT_CONFIG = 'omnibus.rb'
+
+  autoload :Artifact,         'omnibus/artifact'
+  autoload :Builder,          'omnibus/builder'
+  autoload :BuildVersion,     'omnibus/build_version'
+  autoload :BuildVersionDSL,  'omnibus/build_version_dsl'
+  autoload :Cleaner,          'omnibus/cleaner'
+  autoload :Config,           'omnibus/config'
+  autoload :Error,            'omnibus/exceptions'
+  autoload :Fetcher,          'omnibus/fetcher'
+  autoload :Generator,        'omnibus/generator'
+  autoload :HealthCheck,      'omnibus/health_check'
+  autoload :InstallPathCache, 'omnibus/install_path_cache'
+  autoload :Library,          'omnibus/library'
+  autoload :Logger,           'omnibus/logger'
+  autoload :Logging,          'omnibus/logging'
+  autoload :NullBuilder,      'omnibus/null_builder'
+  autoload :Ohai,             'omnibus/ohai'
+  autoload :Overrides,        'omnibus/overrides'
+  autoload :PackageRelease,   'omnibus/package_release'
+  autoload :Project,          'omnibus/project'
+  autoload :Reports,          'omnibus/reports'
+  autoload :S3Cache,          'omnibus/s3_cache'
+  autoload :Software,         'omnibus/software'
+  autoload :SoftwareS3URLs,   'omnibus/software_s3_urls'
+  autoload :Util,             'omnibus/util'
+
+  # @todo Remove this in the next major release
+  autoload :OHAI, 'omnibus/ohai'
+
+  # @todo Refactor these under a +Fetcher module
+  autoload :GitFetcher,     'omnibus/fetchers/git_fetcher'
+  autoload :NetFetcher,     'omnibus/fetchers/net_fetcher'
+  autoload :PathFetcher,    'omnibus/fetchers/path_fetcher'
+  autoload :S3CacheFetcher, 'omnibus/fetchers/s3_cache_fetcher'
+
+  module Command
+    autoload :Base,    'omnibus/cli/base'
+    autoload :Cache,   'omnibus/cli/cache'
+    autoload :Release, 'omnibus/cli/release'
   end
 
-  # Convenience method for access to the Omnibus::Config object.
-  # Provided for backward compatibility.
-  #
-  # @ return [Omnibus::Config]
-  #
-  # @deprecated Just refer to {Omnibus::Config} directly.
-  def self.config
-    Config
+  module Packager
+    autoload :Base,       'omnibus/packagers/base'
+    autoload :MacDmg,     'omnibus/packagers/mac_dmg'
+    autoload :MacPkg,     'omnibus/packagers/mac_pkg'
+    autoload :WindowsMsi, 'omnibus/packagers/windows_msi'
   end
 
-  # Load in an Omnibus configuration file.  Values will be merged with
-  # and override the defaults defined in {Omnibus::Config}.
-  #
-  # @param file [String] path to a configuration file to load
-  #
-  # @return [void]
-  def self.load_configuration(file = nil)
-    if file
-      Config.from_file(file)
-    end
-  end
+  class << self
+    #
+    # Reset the current Omnibus configuration. This is primary an internal API
+    # used in testing, but it can also be useful when Omnibus is used as a
+    # library.
+    #
+    # Note - this persists the +Logger+ object by default.
+    #
+    # @param [true, false] include_logger
+    #   whether the logger object should be cleared as well
+    #
+    # @return [void]
+    #
+    def reset!(include_logger = false)
+      instance_variables.each do |instance_variable|
+        unless include_logger
+          next if instance_variable == :@logger
+        end
+
+        remove_instance_variable(instance_variable)
+      end
 
-  # Processes the configuration to construct the dependency tree of
-  # projects and software.
-  #
-  # @return [void]
-  def self.process_configuration
-    Config.validate
-    process_dsl_files
-  end
+      Config.reset!
+    end
 
-  # All {Omnibus::Project} instances that have been created.
-  #
-  # @return [Array<Omnibus::Project>]
-  def self.projects
-    @projects ||= []
-  end
+    #
+    # The logger for this Omnibus instance.
+    #
+    # @example
+    #   Omnibus.logger.debug { 'This is a message!' }
+    #
+    # @return [Logger]
+    #
+    def logger
+      @logger ||= Logger.new
+    end
 
-  # Names of all the {Omnibus::Project} instances that have been created.
-  #
-  # @return [Array<String>]
-  def self.project_names
-    projects.map { |p| p.name }
-  end
+    def logger=(logger)
+      @logger = logger
+    end
 
-  # Load the {Omnibus::Project} instance with the given name.
-  #
-  # @param name [String]
-  # @return {Omnibus::Project}
-  def self.project(name)
-    projects.find { |p| p.name == name }
-  end
+    def ui
+      @ui ||= Thor::Base.shell.new
+    end
 
-  # The absolute path to the Omnibus project/repository directory.
-  #
-  # @return [String]
-  #
-  # @deprecated Call {Omnibus::Config.project_root} instead.  We need
-  #   to be able to easily tweak this at runtime via the CLI tool.
-  def self.project_root
-    Config.project_root
-  end
+    # Configure Omnibus.
+    #
+    # After this has been called, the {Omnibus::Config} object is
+    # available as `Omnibus.config`.
+    #
+    # @return [void]
+    #
+    # @deprecated Use {#load_configuration} if you need to process a
+    #   config file, followed by {#process_configuration} to act upon it.
+    def configure
+      load_configuration
+      process_configuration
+    end
 
-  # The source root is the path to the root directory of the `omnibus` gem.
-  #
-  # @return [Pathname]
-  def self.source_root
-    @source_root ||= Pathname.new(File.expand_path('../..', __FILE__))
-  end
+    # Convenience method for access to the Omnibus::Config object.
+    # Provided for backward compatibility.
+    #
+    # @ return [Omnibus::Config]
+    #
+    # @deprecated Just refer to {Omnibus::Config} directly.
+    def config
+      Config
+    end
 
-  # The source root is the path to the root directory of the `omnibus-software`
-  # gem.
-  #
-  # @return [Pathname]
-  def self.omnibus_software_root
-    @omnibus_software_root ||= begin
-      if (spec = Gem::Specification.find_all_by_name(Config.software_gem).first)
-        Pathname.new(spec.gem_dir)
-      else
-        nil
+    # Load in an Omnibus configuration file.  Values will be merged with
+    # and override the defaults defined in {Omnibus::Config}.
+    #
+    # @param file [String] path to a configuration file to load
+    #
+    # @return [void]
+    def load_configuration(file = nil)
+      if file
+        Config.from_file(file)
       end
     end
-  end
 
-  # Return paths to all configured {Omnibus::Project} DSL files.
-  #
-  # @return [Array<String>]
-  def self.project_files
-    ruby_files(File.join(project_root, Config.project_dir))
-  end
+    # Processes the configuration to construct the dependency tree of
+    # projects and software.
+    #
+    # @return [void]
+    def process_configuration
+      Config.validate
+      process_dsl_files
+    end
 
-  # Return paths to all configured {Omnibus::Software} DSL files.
-  #
-  # @return [Array<String>]
-  def self.software_files
-    ruby_files(File.join(project_root, Config.software_dir))
-  end
+    # All {Omnibus::Project} instances that have been created.
+    #
+    # @return [Array<Omnibus::Project>]
+    def projects
+      @projects ||= []
+    end
 
-  # Return directories to search for {Omnibus::Software} DSL files.
-  #
-  # @return [Array<String>]
-  def self.software_dirs
-    @software_dirs ||= begin
-      software_dirs = [File.join(project_root, Config.software_dir)]
-      software_dirs << File.join(omnibus_software_root, 'config', 'software') if omnibus_software_root
-      software_dirs
+    # Names of all the {Omnibus::Project} instances that have been created.
+    #
+    # @return [Array<String>]
+    def project_names
+      projects.map { |p| p.name }
     end
-  end
 
-  # Backward compat alias
-  #
-  # @todo print a deprecation message
-  class << self
-    alias_method :root, :project_root
-  end
+    # Load the {Omnibus::Project} instance with the given name.
+    #
+    # @param name [String]
+    # @return {Omnibus::Project}
+    def project(name)
+      projects.find { |p| p.name == name }
+    end
 
-  private
+    # The absolute path to the Omnibus project/repository directory.
+    #
+    # @return [String]
+    def project_root
+      Config.project_root
+    end
 
-  # Generates {Omnibus::Project}s for each project DSL file in
-  # `project_specs`.  All projects are then accessible at
-  # {Omnibus#projects}
-  #
-  # @return [void]
-  #
-  # @see Omnibus::Project
-  def self.expand_projects
-    project_files.each do |spec|
-      Omnibus.projects << Omnibus::Project.load(spec)
+    # The source root is the path to the root directory of the `omnibus` gem.
+    #
+    # @return [Pathname]
+    def source_root
+      @source_root ||= Pathname.new(File.expand_path('../..', __FILE__))
     end
-  end
 
-  # Generate {Omnibus::Software} objects for all software DSL files in
-  # `software_specs`.
-  #
-  # @param overrides [Hash] a hash of version override information.
-  # @param software_files [Array<String>]
-  # @return [void]
-  #
-  # @see Omnibus::Overrides#overrides
-  def self.expand_software(overrides, software_map)
-    unless overrides.is_a? Hash
-      fail ArgumentError, "Overrides argument must be a hash!  You passed #{overrides.inspect}."
+    # The source root is the path to the root directory of the `omnibus-software`
+    # gem.
+    #
+    # @return [Pathname]
+    def omnibus_software_root
+      @omnibus_software_root ||= begin
+        if (spec = Gem::Specification.find_all_by_name(Config.software_gem).first)
+          Pathname.new(spec.gem_dir)
+        else
+          nil
+        end
+      end
+    end
+
+    # Return paths to all configured {Omnibus::Project} DSL files.
+    #
+    # @return [Array<String>]
+    def project_files
+      ruby_files(File.join(project_root, Config.project_dir))
     end
 
-    Omnibus.projects.each do |project|
-      project.dependencies.each do |dependency|
-        recursively_load_dependency(dependency, project, overrides, software_map)
+    # Return paths to all configured {Omnibus::Software} DSL files.
+    #
+    # @return [Array<String>]
+    def software_files
+      ruby_files(File.join(project_root, Config.software_dir))
+    end
+
+    # Return directories to search for {Omnibus::Software} DSL files.
+    #
+    # @return [Array<String>]
+    def software_dirs
+      @software_dirs ||= begin
+        software_dirs = [File.join(project_root, Config.software_dir)]
+        software_dirs << File.join(omnibus_software_root, 'config', 'software') if omnibus_software_root
+        software_dirs
       end
     end
-  end
 
-  # Processes all configured {Omnibus::Project} and
-  # {Omnibus::Software} DSL files.
-  #
-  # @return [void]
-  def self.process_dsl_files
-    # Do projects first
-    expand_projects
+    # Backward compat alias
+    #
+    # @todo Remve this in the next major release (4.0)
+    #
+    # @see (Omnibus.project_root)
+    def root
+      Omnibus.logger.deprecated('Omnibus') do
+        'Omnibus.root. Please use Omnibus.project_root instead.'
+      end
 
-    # Then do software
-    final_software_map = prefer_local_software(omnibus_software_files, software_files)
+      project_root
+    end
 
-    overrides = Config.override_file ? Omnibus::Overrides.overrides : {}
+    # Processes all configured {Omnibus::Project} and
+    # {Omnibus::Software} DSL files.
+    #
+    # @return [void]
+    def process_dsl_files
+      # Do projects first
+      expand_projects
 
-    expand_software(overrides, final_software_map)
-  end
+      # Then do software
+      final_software_map = prefer_local_software(omnibus_software_files, software_files)
 
-  # Return a list of all the Ruby files (i.e., those with an "rb"
-  # extension) in the given directory
-  #
-  # @param dir [String]
-  # @return [Array<String>]
-  def self.ruby_files(dir)
-    Dir.glob("#{dir}/*.rb")
-  end
+      overrides = Config.override_file ? Omnibus::Overrides.overrides : {}
 
-  # Retrieve the fully-qualified paths to every software definition
-  # file bundled in the {https://github.com/opscode/omnibus-software omnibus-software} gem.
-  #
-  # @return [Array<String>] the list of paths. Will be empty if the
-  #   `omnibus-software` gem is not in the gem path.
-  def self.omnibus_software_files
-    if omnibus_software_root
-      Dir.glob(File.join(omnibus_software_root, 'config', 'software', '*.rb'))
-    else
-      []
+      expand_software(overrides, final_software_map)
     end
-  end
 
-  # Given a list of software definitions from `omnibus-software` itself, and a
-  # list of software files local to the current project, create a
-  # single list of software definitions.  If the software was defined
-  # in both sets, the locally-defined one ends up in the final list.
-  #
-  # The base name of the software file determines what software it
-  # defines.
-  #
-  # @param omnibus_files [Array<String>]
-  # @param local_files [Array<String>]
-  # @return [Array<String>]
-  def self.prefer_local_software(omnibus_files, local_files)
-    base = software_map(omnibus_files)
-    local = software_map(local_files)
-    base.merge(local)
-  end
+    private
+
+    # Generates {Omnibus::Project}s for each project DSL file in
+    # `project_specs`.  All projects are then accessible at
+    # {Omnibus#projects}
+    #
+    # @return [void]
+    #
+    # @see Omnibus::Project
+    def expand_projects
+      project_files.each do |spec|
+        Omnibus.projects << Omnibus::Project.load(spec)
+      end
+    end
 
-  # Given a list of file paths, create a map of the basename (without
-  # extension) to the complete path.
-  #
-  # @param files [Array<String>]
-  # @return [Hash<String, String>]
-  def self.software_map(files)
-    files.each_with_object({}) do |file, collection|
-      software_name = File.basename(file, '.*')
-      collection[software_name] = file
+    # Generate {Omnibus::Software} objects for all software DSL files in
+    # `software_specs`.
+    #
+    # @param overrides [Hash] a hash of version override information.
+    # @param software_files [Array<String>]
+    # @return [void]
+    #
+    # @see Omnibus::Overrides#overrides
+    def expand_software(overrides, software_map)
+      unless overrides.is_a? Hash
+        raise ArgumentError, "Overrides argument must be a hash!  You passed #{overrides.inspect}."
+      end
+
+      Omnibus.projects.each do |project|
+        project.dependencies.each do |dependency|
+          recursively_load_dependency(dependency, project, overrides, software_map)
+        end
+      end
     end
-  end
 
-  # Loads a project's dependency recursively, ensuring all transitive dependencies
-  # are also loaded.
-  #
-  # @param dependency_name [String]
-  # @param project [Omnibus::Project]
-  # @param overrides [Hash] a hash of version override information.
-  # @param software_map [Hash<String, String>]
-  #
-  # @return [void]
-  def self.recursively_load_dependency(dependency_name, project, overrides, software_map)
-    dep_file = software_map[dependency_name]
+    # Return a list of all the Ruby files (i.e., those with an "rb"
+    # extension) in the given directory
+    #
+    # @param dir [String]
+    # @return [Array<String>]
+    def ruby_files(dir)
+      Dir.glob("#{dir}/*.rb")
+    end
 
-    unless dep_file
-      fail MissingProjectDependency.new(dependency_name, software_dirs)
+    # Retrieve the fully-qualified paths to every software definition
+    # file bundled in the {https://github.com/opscode/omnibus-software omnibus-software} gem.
+    #
+    # @return [Array<String>] the list of paths. Will be empty if the
+    #   `omnibus-software` gem is not in the gem path.
+    def omnibus_software_files
+      if omnibus_software_root
+        Dir.glob(File.join(omnibus_software_root, 'config', 'software', '*.rb'))
+      else
+        []
+      end
     end
 
-    dep_software = Omnibus::Software.load(dep_file, project, overrides)
+    # Given a list of software definitions from `omnibus-software` itself, and a
+    # list of software files local to the current project, create a
+    # single list of software definitions.  If the software was defined
+    # in both sets, the locally-defined one ends up in the final list.
+    #
+    # The base name of the software file determines what software it
+    # defines.
+    #
+    # @param omnibus_files [Array<String>]
+    # @param local_files [Array<String>]
+    # @return [Array<String>]
+    def prefer_local_software(omnibus_files, local_files)
+      base = software_map(omnibus_files)
+      local = software_map(local_files)
+      base.merge(local)
+    end
 
-    # load any transitive deps for the component into the library also
-    dep_software.dependencies.each do |dep|
-      recursively_load_dependency(dep, project, overrides, software_map)
+    # Given a list of file paths, create a map of the basename (without
+    # extension) to the complete path.
+    #
+    # @param files [Array<String>]
+    # @return [Hash<String, String>]
+    def software_map(files)
+      files.each_with_object({}) do |file, collection|
+        software_name = File.basename(file, '.*')
+        collection[software_name] = file
+      end
     end
 
-    project.library.component_added(dep_software)
+    # Loads a project's dependency recursively, ensuring all transitive dependencies
+    # are also loaded.
+    #
+    # @param dependency_name [String]
+    # @param project [Omnibus::Project]
+    # @param overrides [Hash] a hash of version override information.
+    # @param software_map [Hash<String, String>]
+    #
+    # @return [void]
+    def recursively_load_dependency(dependency_name, project, overrides, software_map)
+      dep_file = software_map[dependency_name]
+
+      unless dep_file
+        raise MissingProjectDependency.new(dependency_name, software_dirs)
+      end
+
+      dep_software = Omnibus::Software.load(dep_file, project, overrides)
+
+      # load any transitive deps for the component into the library also
+      dep_software.dependencies.each do |dep|
+        recursively_load_dependency(dep, project, overrides, software_map)
+      end
+
+      project.library.component_added(dep_software)
+    end
   end
 end
+
+# Sugars must be loaded after everything else has been registered
+require 'omnibus/sugar'