omnibus 1.0.0

data/bin/omnibus

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'omnibus/cli'
+
+Omnibus::CLI::Application.start

data/lib/omnibus.rb

@@ -0,0 +1,280 @@
+#
+# Copyright:: Copyright (c) 2012 Opscode, 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.
+#
+
+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 'omnibus/software'
+require 'omnibus/project'
+require 'omnibus/fetchers'
+require 'omnibus/health_check'
+require 'omnibus/build_version'
+require 'omnibus/overrides'
+require 'omnibus/version'
+
+require 'pathname'
+
+module Omnibus
+
+  DEFAULT_CONFIG_FILENAME = 'omnibus.rb'.freeze
+
+  # 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 self.configure
+    load_configuration
+    process_configuration
+  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
+  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
+
+  # Processes the configuration to construct the dependency tree of
+  # projects and software.
+  #
+  # @return [void]
+  def self.process_configuration
+    Config.validate
+    process_dsl_files
+    generate_extra_rake_tasks
+  end
+
+  # All {Omnibus::Project} instances that have been created.
+  #
+  # @return [Array<Omnibus::Project>]
+  def self.projects
+    @projects ||= []
+  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
+
+  # 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
+
+  # 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
+
+  # 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
+
+  # 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('omnibus-software').first
+        Pathname.new(spec.gem_dir)
+      else
+        nil
+      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
+
+  # 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
+
+  # Backward compat alias
+  #
+  # @todo print a deprecation message
+  class << self
+    alias :root :project_root
+  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 self.expand_projects
+    project_files.each do |spec|
+      Omnibus.projects << Omnibus::Project.load(spec)
+    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_files)
+    unless overrides.is_a? Hash
+      raise ArgumentError, "Overrides argument must be a hash!  You passed #{overrides.inspect}."
+    end
+
+    # TODO: Why are we doing a full Cartesian product of (projects x
+    # software) without regard for the actual dependencies of the
+    # projects?
+    software_files.each do |f|
+      Omnibus.projects.each do |p|
+        s = Omnibus::Software.load(f, p, overrides)
+        Omnibus.component_added(s) if p.dependency?(s)
+      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
+
+    # Then do software
+    final_software_files = prefer_local_software(omnibus_software_files,
+                                           software_files)
+
+    overrides = Config.override_file ? Omnibus::Overrides.overrides : {}
+
+    expand_software(overrides, final_software_files)
+  end
+
+  # Creates some additional Rake tasks beyond those generated in the
+  # process of reading in the DSL files.
+  #
+  # @return [void]
+  #
+  # @todo Not so sure I like how this is being done, but at least it
+  #   isolates the Rake stuff.
+  def self.generate_extra_rake_tasks
+    require 'omnibus/clean_tasks'
+  end
+
+  # 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
+
+  # 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
+      []
+    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).values
+  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
+    end
+  end
+end

data/lib/omnibus/build_version.rb

@@ -0,0 +1,281 @@
+#
+# Copyright:: Copyright (c) 2012 Opscode, 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.
+#
+
+require 'time'
+require 'omnibus/util'
+
+module Omnibus
+
+  # Provides methods for generating Omnibus project build version
+  # strings automatically from Git repository information.
+  #
+  # @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
+    include Omnibus::Util
+
+    # Formatting string for the timestamp component of our SemVer build specifier.
+    #
+    # @see Omnibus::BuildVersion#semver
+    # @see Time#strftime
+    TIMESTAMP_FORMAT = "%Y%m%d%H%M%S"
+
+    # @deprecated Use {#semver} or {#git_describe} instead
+    def self.full
+      puts "#{self.name}.full is deprecated. Use #{self.name}.new.semver or #{self.name}.new.git_describe."
+      Omnibus::BuildVersion.new.git_describe
+    end
+
+    # @todo Remove this... it does nothing
+    def initialize
+    end
+
+    # @!group Version Generator Methods
+
+    # Generate a {http://semver.org/ SemVer 2.0.0-rc.1 compliant}
+    # version string for an Omnibus project.
+    #
+    # This relies on the Omnibus project being a Git repository, as
+    # well as having tags named according to SemVer conventions
+    # (specifically, the `MAJOR.MINOR.PATCH-PRERELEASE` aspects)
+    #
+    # The specific format of the version string is:
+    #
+    #     MAJOR.MINOR.PATCH-PRERELEASE+TIMESTAMP.git.COMMITS_SINCE.GIT_SHA
+    #
+    # By default, a timestamp is incorporated into the build component
+    # of version string (see
+    # {Omnibus::BuildVersion::TIMESTAMP_FORMAT}).  This can be
+    # disabled by setting the environment variable
+    # `OMNIBUS_APPEND_TIMESTAMP` to a "falsey" value (e.g. "false",
+    # "f", "no", "n", "0")
+    #
+    # @example 11.0.0-alpha.1+20121218164140.git.207.694b062
+    # @return [String]
+    # @see #git_describe
+    # @todo Issue a warning or throw an exception if the tags of the
+    #   repository are not themselves SemVer-compliant?
+    # @todo Consider making the {#build_start_time} method public, as
+    #   its function influences how build timestamps are generated,
+    #   and can be influenced by users.
+    def semver
+      build_tag = version_tag
+
+      # PRERELEASE VERSION
+      if prerelease_version?
+        # ensure all dashes are dots per precedence rules (#12) in Semver
+        # 2.0.0-rc.1
+        prerelease = prerelease_tag.gsub("-", ".")
+        build_tag << "-" << prerelease
+      end
+
+      # BUILD VERSION
+      # Follows SemVer conventions and the build version begins with a '+'.
+      build_version_items = []
+
+      # By default we will append a timestamp to every build. This behavior can
+      # be overriden by setting the OMNIBUS_APPEND_TIMESTAMP environment
+      # variable to a 'falsey' value (ie false, f, no, n or 0).
+      #
+      # format: YYYYMMDDHHMMSS example: 20130131123345
+      build_version_items << build_start_time.strftime(TIMESTAMP_FORMAT) if append_timestamp?
+
+      # We'll append the git describe information unless we are sitting right
+      # on an annotated tag.
+      #
+      # format: git.COMMITS_SINCE_TAG.GIT_SHA example: git.207.694b062
+      unless commits_since_tag == 0
+        build_version_items << ["git", commits_since_tag, git_sha_tag].join(".")
+      end
+
+      unless build_version_items.empty?
+        build_tag << "+" << build_version_items.join(".")
+      end
+
+      build_tag
+    end
+
+    # Generates a version string by running
+    # {https://www.kernel.org/pub/software/scm/git/docs/git-describe.html
+    # git describe} in the root of the Omnibus project.
+    #
+    # Produces a version string of the format
+    #
+    #     MOST_RECENT_TAG-COMMITS_SINCE-gGIT_SHA
+    #
+    # @example
+    #  11.0.0-alpha.1-207-g694b062
+    # @return [String]
+    def git_describe
+      @git_describe ||= begin
+                          git_cmd = "git describe"
+                          cmd = shellout(git_cmd,
+                                         :live_stream => nil,
+                                         :cwd => Omnibus.project_root)
+                          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
+    end
+
+    # @!endgroup
+
+    # Note: The remaining methods could just as well be private
+
+    # Return a `MAJOR.MINOR.PATCH` version string, as extracted from
+    # {#git_describe}.
+    #
+    # Here are some illustrative examples:
+    #
+    #     1.2.7-208-ge908a52 -> 1.2.7
+    #     11.0.0-alpha-59-gf55b180 -> 11.0.0
+    #     11.0.0-alpha2 -> 11.0.0
+    #     10.16.2.rc.1 -> 10.16.2
+    #
+    # @return [String]
+    def version_tag
+      version_composition.join(".")
+    end
+
+    # Return a prerelease tag string (if it exists), as extracted from {#git_describe}.
+    #
+    # Here are some illustrative examples:
+    #
+    #     1.2.7-208-ge908a52 -> nil
+    #     11.0.0-alpha-59-gf55b180 -> alpha
+    #     11.0.0-alpha2 -> alpha2
+    #     10.16.2.rc.1 -> rc.1
+    #
+    # @return [String] if a pre-release tag was found
+    # @return [nil] if no pre-release tag was found
+    def prerelease_tag
+      prerelease_regex = if commits_since_tag > 0
+                           /^\d+\.\d+\.\d+(?:-|\.)([0-9A-Za-z.-]+)-\d+-g[0-9a-f]+$/
+                         else
+                           /^\d+\.\d+\.\d+(?:-|\.)([0-9A-Za-z.-]+)$/
+                         end
+      match = prerelease_regex.match(git_describe)
+      match ? match[1] : nil
+    end
+
+    # Extracts the 7-character truncated Git SHA1 from the output of {#git_describe}.
+    #
+    # Here are some illustrative examples:
+    #
+    #     1.2.7-208-ge908a52 -> e908a52
+    #     11.0.0-alpha-59-gf55b180 -> f55b180
+    #     11.0.0-alpha2 -> nil
+    #     10.16.2.rc.1 -> nil
+    #
+    # @return [String] the truncated SHA1
+    # @return [nil] if no SHA1 is present in the output of #{git_describe}
+    def git_sha_tag
+      sha_regexp = /g([0-9a-f]+)$/
+      match = sha_regexp.match(git_describe)
+      match ? match[1] : nil
+    end
+
+    # Extracts the number of commits since the most recent Git tag, as
+    # determined by {#git_describe}.
+    #
+    # Here are some illustrative examples:
+    #
+    #     1.2.7-208-ge908a52 -> 208
+    #     11.0.0-alpha-59-gf55b180 -> 59
+    #     11.0.0-alpha2 -> 0
+    #     10.16.2.rc.1 -> 0
+    #
+    # @return [Fixnum]
+    def commits_since_tag
+      commits_regexp = /^.*-(\d+)\-g[0-9a-f]+$/
+      match = commits_regexp.match(git_describe)
+      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.
+    #
+    # @return [Boolean]
+    # @see #prerelease_tag
+    def prerelease_version?
+      !!(prerelease_tag)
+    end
+
+    private
+
+    # We'll attempt to retrive the timestamp from the Jenkin's set BUILD_ID
+    # environment variable. This will ensure platform specfic packages for the
+    # same build will share the same timestamp.
+    def build_start_time
+      @build_start_time ||= begin
+                              if !ENV['BUILD_ID'].nil?
+                                begin
+                                  Time.strptime(ENV['BUILD_ID'], "%Y-%m-%d_%H-%M-%S")
+                                rescue ArgumentError
+                                  error_message =  "BUILD_ID environment variable "
+                                  error_message << "should be in YYYY-MM-DD_hh-mm-ss "
+                                  error_message << "format."
+                                  raise ArgumentError, error_message
+                                end
+                              else
+                                Time.now.utc
+                              end
+                            end
+    end
+
+    # Pulls out the major, minor, and patch components from the output
+    # of {#git_describe}.
+    #
+    # Relies on the most recent Git tag being SemVer compliant (i.e.,
+    # starting with a `MAJOR.MINOR.PATCH` string)
+    #
+    # @return [Array<(String, String, String)>]
+    #
+    # @todo Compute this once and store the result in an instance variable
+    def version_composition
+      version_regexp = /^(\d+)\.(\d+)\.(\d+)/
+      version_regexp.match(git_describe)[1..3]
+    end
+
+
+    def append_timestamp?
+      append_timestamp = true
+      if ENV['OMNIBUS_APPEND_TIMESTAMP'] && (ENV['OMNIBUS_APPEND_TIMESTAMP'] =~ (/(false|f|no|n|0)$/i))
+        append_timestamp = false
+      end
+      append_timestamp
+    end
+  end
+end