omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/generator_files/.kitchen.yml.erb

@@ -1,5 +1,6 @@
 driver:
   name: vagrant
+  forward_agent: yes
   customize:
     cpus: 2
     memory: 2048
@@ -7,9 +8,12 @@ driver:
     - ['.', '/home/vagrant/<%= config[:name] %>']
 
 provisioner:
-  require_chef_omnibus: 11.8.0
+  name: chef_zero
+  require_chef_omnibus: 11.14.6
 
 platforms:
+  - name: ubuntu-14.04
+    run_list: apt::default
   - name: ubuntu-12.04
     run_list: apt::default
   - name: ubuntu-11.04

data/lib/omnibus/generator_files/Gemfile.erb

@@ -1,15 +1,21 @@
 source 'https://rubygems.org'
 
-# Use Berkshelf for resolving cookbook dependencies
-gem 'berkshelf', '~> 3.0'
-
-# Install omnibus software
+# Install omnibus
 gem 'omnibus', '~> <%= Omnibus::VERSION.split('.')[0...-1].join('.') %>'
 
 # Use Chef's software definitions. It is recommended that you write your own
 # software definitions, but you can clone/fork Chef's to get you started.
 # gem 'omnibus-software', github: 'opscode/omnibus-software'
 
-# Use Test Kitchen with Vagrant for converging the build environment
-gem 'test-kitchen',    '~> 1.2'
-gem 'kitchen-vagrant', '~> 0.14'
+# This development group is installed by default when you run `bundle install`,
+# but if you are using Omnibus in a CI-based infrastructure, you do not need
+# the Test Kitchen-based build lab. You can skip these unnecessary dependencies
+# by running `bundle install --without development` to speed up build times.
+group :development do
+  # Use Berkshelf for resolving cookbook dependencies
+  gem 'berkshelf', '~> 3.0'
+
+  # Use Test Kitchen with Vagrant for converging the build environment
+  gem 'test-kitchen',    '~> 1.2'
+  gem 'kitchen-vagrant', '~> 0.14'
+end

data/lib/omnibus/generator_files/config/projects/project.rb.erb

@@ -0,0 +1,28 @@
+#
+# Copyright <%= Time.now.year %> YOUR NAME
+#
+# All Rights Reserved.
+#
+
+name "<%= config[:name] %>"
+maintainer "CHANGE ME"
+homepage "https://CHANGE-ME.com"
+
+# Defaults to C:/<%= config[:name] %> on Windows
+# and /opt/<%= config[:name] %> on all other platforms
+install_dir "#{default_root}/#{name}"
+
+build_version Omnibus::BuildVersion.semver
+build_iteration 1
+
+# Creates required build directories
+dependency "preparation"
+
+# <%= config[:name] %> dependencies/components
+# dependency "somedep"
+
+# Version manifest file
+dependency "version-manifest"
+
+exclude "**/.git"
+exclude "**/bundler/git"

data/lib/omnibus/generator_files/config/software/zlib.rb.erb

@@ -0,0 +1,55 @@
+#
+# Copyright <%= Time.now.year %> YOUR NAME
+#
+# 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.
+#
+
+# These options are required for all software definitions
+name "<%= config[:name] %>-zlib"
+default_version "1.2.6"
+
+# A software can specify more than one version that is available for install
+version("1.2.6") { source md5: "618e944d7c7cd6521551e30b32322f4a" }
+version("1.2.8") { source md5: "44d667c142d7cda120332623eab69f40" }
+
+# Sources may be URLs, git locations, or path locations
+source url: "http://downloads.sourceforge.net/project/libpng/zlib/#{version}/zlib-#{version}.tar.gz"
+
+# This is the path, inside the tarball, where the source resides
+relative_path "zlib-#{version}"
+
+build do
+  # Setup a default environment from Omnibus - you should use this Omnibus
+  # helper everywhere. It will become the default in the future.
+  env = with_standard_compiler_flags(with_embedded_path)
+
+  # Manipulate any configure flags you wish:
+  #   For some reason zlib needs this flag on solaris
+  env["CFLAGS"] << " -DNO_VIZ" if solaris?
+
+  # "command" is part of the build DSL. There are a number of handy options
+  # available, such as "copy", "sync", "ruby", etc. For a complete list, please
+  # consult the Omnibus gem documentation.
+  #
+  # "install_dir" is exposed and refers to the top-level projects +install_dir+
+  command "./configure" \
+          " --prefix=#{install_dir}/embedded", env: env
+
+  # You can have multiple steps - they are executed in the order in which they
+  # are read.
+  #
+  # "workers" is a DSL method that returns the most suitable number of
+  # builders for the currently running system.
+  command "make -j #{workers}", env: env
+  command "make -j #{workers} install", env: env
+end

data/lib/omnibus/generator_files/omnibus.rb.erb

@@ -9,9 +9,7 @@
 # By default, Omnibus uses system folders (like +/var+ and +/opt+) to build and
 # cache components. If you would to build everything internally, you can
 # uncomment the following options. This will prevent the need for root
-# permissions in most cases. You will also need to update the <%= config[:name] %>
-# project configuration to build at +./local/omnibus/build+ instead of
-# +<%= config[:install_path] %>+
+# permissions in most cases.
 #
 # Uncomment this line to change the default base directory to "local"
 # -------------------------------------------------------------------
@@ -20,7 +18,7 @@
 # Alternatively you can tune the individual values
 # ------------------------------------------------
 # cache_dir     './local/omnibus/cache'
-# git_cache_dir './local/omnibus/cache/install_path'
+# git_cache_dir './local/omnibus/cache/git_cache'
 # source_dir    './local/omnibus/src'
 # build_dir     './local/omnibus/build'
 # package_dir   './local/omnibus/pkg'
@@ -33,9 +31,9 @@
 # Enable S3 asset caching
 # ------------------------------
 # use_s3_caching true
-# s3_access_key  ENV['S3_ACCESS_KEY']
-# s3_secret_key  ENV['S3_SECRET_KEY']
-# s3_bucket      ENV['S3_BUCKET']
+# s3_access_key  ENV['AWS_ACCESS_KEY_ID']
+# s3_secret_key  ENV['AWS_SECRET_ACCESS_KEY']
+# s3_bucket      ENV['AWS_S3_BUCKET']
 
 # Customize compiler bits
 # ------------------------------

data/lib/omnibus/git_cache.rb

@@ -61,11 +61,9 @@ module Omnibus
     #
     def create_cache_path
       if File.directory?(cache_path)
-        log.info(log_key) { "Cache path `#{cache_path}' exists, skipping creation" }
         false
       else
-        log.info(log_key) { "Creating cache path `#{cache_path}'" }
-        FileUtils.mkdir_p(File.dirname(cache_path))
+        create_directory(File.dirname(cache_path))
         shellout!("git --git-dir=#{cache_path} init -q")
         true
       end
@@ -79,7 +77,7 @@ module Omnibus
     def tag
       return @tag if @tag
 
-      log.info(log_key) { "Calculating tag" }
+      log.internal(log_key) { "Calculating tag" }
 
       # Accumulate an array of all the software projects that come before
       # the name and version we are tagging. So if you have
@@ -95,7 +93,7 @@ module Omnibus
         end
       end
 
-      log.debug(log_key) { "dep_list: #{dep_list.map(&:name).inspect}" }
+      log.internal(log_key) { "dep_list: #{dep_list.map(&:name).inspect}" }
 
       # This is the list of all the unqiue shasums of all the software build
       # dependencies, including the on currently being acted upon.
@@ -103,14 +101,14 @@ module Omnibus
       suffix  = Digest::SHA256.hexdigest(shasums.join('|'))
       @tag    = "#{software.name}-#{suffix}"
 
-      log.debug(log_key) { "tag: #{@tag}" }
+      log.internal(log_key) { "tag: #{@tag}" }
 
       @tag
     end
 
     # Create an incremental install path cache for the software step
     def incremental
-      log.info(log_key) { 'Performing incremental cache' }
+      log.internal(log_key) { 'Performing incremental cache' }
 
       create_cache_path
       remove_git_dirs
@@ -119,7 +117,7 @@ module Omnibus
 
       begin
         shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{install_dir} commit -q -m "Backup of #{tag}"))
-      rescue Mixlib::ShellOut::ShellCommandFailed => e
+      rescue CommandFailed => e
         raise unless e.message.include?('nothing to commit')
       end
 
@@ -127,7 +125,7 @@ module Omnibus
     end
 
     def restore
-      log.info(log_key) { 'Performing cache restoration' }
+      log.internal(log_key) { 'Performing cache restoration' }
 
       create_cache_path
 
@@ -139,11 +137,11 @@ module Omnibus
       end
 
       if restore_me
-        log.debug(log_key) { "Detected tag `#{tag}' can be restored, restoring" }
+        log.internal(log_key) { "Detected tag `#{tag}' can be restored, restoring" }
         shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{install_dir} checkout -f "#{tag}"))
         true
       else
-        log.debug(log_key) { "Could not find tag `#{tag}', skipping restore" }
+        log.internal(log_key) { "Could not find tag `#{tag}', skipping restore" }
         false
       end
     end
@@ -155,14 +153,14 @@ module Omnibus
     #
     # @return [true]
     def remove_git_dirs
-      log.info(log_key) { "Removing git directories" }
+      log.internal(log_key) { "Removing git directories" }
 
       Dir.glob("#{install_dir}/**/{,.*}/config").reject do |path|
         REQUIRED_GIT_FILES.any? do |required_file|
           !File.exist?(File.join(File.dirname(path), required_file))
         end
       end.each do |path|
-        log.info(log_key) { "Removing git dir `#{path}'" }
+        log.internal(log_key) { "Removing git dir `#{path}'" }
         FileUtils.rm_rf(File.dirname(path))
       end
 

data/lib/omnibus/logger.rb

@@ -14,10 +14,8 @@
 # limitations under the License.
 #
 
-require 'logger'
-
 module Omnibus
-  class Logger < ::Logger
+  class Logger
     #
     # The amount of padding on the left column.
     #
@@ -25,20 +23,51 @@ module Omnibus
     #
     LEFT = 40
 
-    def initialize(logdev = $stdout, *)
-      super
-      @level = Logger::WARN
+    #
+    # Our custom log levels, in order of severity
+    #
+    # @return [Array]
+    #
+    LEVELS = %w(UNKNOWN INTERNAL DEBUG INFO WARN ERROR FATAL NOTHING).freeze
+
+    #
+    # The mutex lock for synchronizing IO writing.
+    #
+    # @return [Mutex]
+    #
+    MUTEX = Mutex.new
+
+    attr_reader :io
+    attr_reader :level
+
+    #
+    # Create a new logger object.
+    #
+    # @param [IO] io
+    #   the IO object to read/write
+    #
+    def initialize(io = $stdout)
+      @io = io
+      @level = LEVELS.index('WARN')
+    end
+
+    LEVELS.each.with_index do |level, index|
+      class_eval <<-EOH, __FILE__, __LINE__
+        def #{level.downcase}(progname, &block)
+          add(#{index}, progname, &block)
+        end
+      EOH
     end
 
     #
-    # Print a deprecation warning.
+    # Print a deprecation warning. This actually outputs to +WARN+, but is
+    # prefixed with the string "DEPRECATED" first.
     #
     # @see (Logger#add)
     #
-    def deprecated(progname = nil, &block)
-      if level <= WARN
-        add(WARN, 'DEPRECATED: ' + (block ? yield : progname), progname)
-      end
+    def deprecated(progname, &block)
+      meta = Proc.new { "DEPRECATED: #{block.call}" }
+      add(LEVELS.index('WARN'), progname, &meta)
     end
 
     #
@@ -50,9 +79,7 @@ module Omnibus
     # @param [Symbol] level
     #
     def level=(level)
-      @level = ::Logger.const_get(level.to_s.upcase)
-    rescue NameError
-      raise "'#{level.inspect}' does not appear to be a valid log level!"
+      @level = LEVELS.index(level.to_s.upcase) || -1
     end
 
     #
@@ -67,6 +94,16 @@ module Omnibus
       @live_streams[level.to_sym] ||= LiveStream.new(self, level)
     end
 
+    #
+    # Add a message to the logger with the given severity and progname.
+    #
+    def add(severity, progname, &block)
+      return true if io.nil? || severity < level
+      message = format_message(severity, progname, yield)
+      MUTEX.synchronize { io.write(message) }
+      true
+    end
+
     #
     # The string representation of this object.
     #
@@ -87,14 +124,31 @@ module Omnibus
 
     private
 
-    def format_message(severity, _datetime, progname, msg)
-      left = if progname
-               "[#{progname}] #{severity[0]} | "
-             else
-               "#{severity[0]} | "
-             end
+    #
+    # Format the log message.
+    #
+    # @return [String]
+    #
+    def format_message(severity, progname, message)
+      if progname
+        left = "[#{progname}] #{format_severity(severity)} | "
+      else
+        left = "#{format_severity(severity)} | "
+      end
+      "#{left.rjust(LEFT)}#{message}\n"
+    end
 
-      "#{left.rjust(LEFT)}#{msg}\n"
+    #
+    # Format the log severity.
+    #
+    # @return [String]
+    #
+    def format_severity(severity)
+      if severity == 0
+        '_'
+      else
+        (LEVELS[severity] || '?')[0]
+      end
     end
 
     #
@@ -172,7 +226,7 @@ module Omnibus
       # @param [String] data
       #
       def log_line(data)
-        @log.public_send(@level) { data }
+        @log.public_send(@level, nil) { data }
       end
     end
   end

data/lib/omnibus/logging.rb

@@ -39,7 +39,7 @@ module Omnibus
       # @return [String]
       #
       def log_key
-        @log_key ||= name.split('::')[1..-1].join('::')
+        @log_key ||= (name || '(Anonymous)').split('::')[1..-1].join('::')
       end
     end
 

data/lib/omnibus/metadata.rb

@@ -0,0 +1,264 @@
+#
+# 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.
+#
+
+require 'json'
+
+module Omnibus
+  class Metadata
+    class << self
+      #
+      # Render the metadata for the package at the given path, generated by the
+      # given project.
+      #
+      # @raise [NoPackageFile]
+      #   if the given +path+ does not contain a package
+      #
+      # @param [String] path
+      #   the path to the package (or compressed object) on disk
+      # @param [Project] project
+      #   the project which generated the given package or compressed object
+      #
+      # @return [String]
+      #   the path to the metadata on disk
+      #
+      def generate(path, project)
+        unless File.exist?(path)
+          raise NoPackageFile.new(path)
+        end
+
+        package = Package.new(path)
+
+        data = {
+          # Package
+          basename:         package.name,
+          md5:              package.md5,
+          sha1:             package.sha1,
+          sha256:           package.sha256,
+          sha512:           package.sha512,
+          platform:         platform_shortname,
+          platform_version: platform_version,
+          arch:             arch,
+
+          # Project
+          name:             project.name,
+          friendly_name:    project.friendly_name,
+          homepage:         project.homepage,
+          version:          project.build_version,
+          iteration:        project.build_iteration,
+        }
+
+        instance = new(package, data)
+        instance.save
+        instance.path
+      end
+
+      #
+      # Load the metadata from disk.
+      #
+      # @param [Package] package
+      #   the package for this metadata
+      #
+      # @return [Metadata]
+      #
+      def for_package(package)
+        data = File.read(path_for(package))
+        hash = JSON.parse(data, symbolize_names: true)
+
+         # Ensure Platform version has been truncated
+         if hash[:platform_version] && hash[:platform]
+           hash[:platform_version] = truncate_platform_version(hash[:platform_version], hash[:platform])
+         end
+
+        # Ensure an interation exists
+        hash[:iteration] ||= 1
+
+        new(package, hash)
+      rescue Errno::ENOENT
+        raise NoPackageMetadataFile.new(package.path)
+      end
+
+      #
+      # The metadata path that corresponds to the package.
+      #
+      # @param [Package] package
+      #   the package for this metadata
+      #
+      # @return [String]
+      #
+      def path_for(package)
+        "#{package.path}.metadata.json"
+      end
+
+      #
+      # The architecture for this machine, as reported from Ohai.
+      #
+      # @return [String]
+      #
+      def arch
+        Ohai['kernel']['machine']
+      end
+
+      #
+      # Platform version to be used in package metadata.
+      #
+      # @return [String]
+      #   the platform version
+      #
+      def platform_version
+        truncate_platform_version(Ohai['platform_version'], platform_shortname)
+      end
+
+      #
+      # Platform name to be used when creating metadata for the artifact.
+      # rhel/centos become "el", all others are just platform
+      #
+      # @return [String]
+      #   the platform family short name
+      #
+      def platform_shortname
+        if Ohai['platform_family'] == 'rhel'
+          'el'
+        else
+          Ohai['platform']
+        end
+      end
+
+      private
+
+      #
+      # On certain platforms we don't care about the full MAJOR.MINOR.PATCH platform
+      # version. This method will properly truncate the version down to a more human
+      # friendly version. This version can also be thought of as a 'marketing'
+      # version.
+      #
+      # @param [String] platform_version
+      #   the platform version to truncate
+      # @param [String] platform
+      #   the platform shortname. this might be an Ohai-returned platform or
+      #   platform family but it also might be a shortname like `el`
+      #
+      def truncate_platform_version(platform_version, platform)
+        case platform
+        when 'centos', 'debian', 'el', 'fedora', 'freebsd', 'rhel', 'sles'
+          # Only want MAJOR (e.g. Debian 7)
+          platform_version.split('.').first
+        when 'aix', 'arch', 'gentoo', 'mac_os_x', 'openbsd', 'slackware', 'solaris2', 'suse', 'ubuntu'
+          # Only want MAJOR.MINOR (e.g. Mac OS X 10.9, Ubuntu 12.04)
+          platform_version.split('.')[0..1].join('.')
+        when 'omnios', 'smartos'
+          # Only want MAJOR (e.g OmniOS r151006, SmartOS 20120809T221258Z)
+          platform_version.split('.').first
+        when 'windows'
+          # Windows has this really awesome "feature", where their version numbers
+          # internally do not match the "marketing" name.
+          #
+          # Definitively computing the Windows marketing name actually takes more
+          # than the platform version. Take a look at the following file for the
+          # details:
+          #
+          #   https://github.com/opscode/chef/blob/master/lib/chef/win32/version.rb
+          #
+          # As we don't need to be exact here the simple mapping below is based on:
+          #
+          #  http://www.jrsoftware.org/ishelp/index.php?topic=winvernotes
+          #
+          case platform_version
+          when '5.0.2195', '2000'   then '2000'
+          when '5.1.2600', 'xp'     then 'xp'
+          when '5.2.3790', '2003r2' then '2003r2'
+          when '6.0.6001', '2008'   then '2008'
+          when '6.1.7600', '7'      then '7'
+          when '6.1.7601', '2008r2' then '2008r2'
+          when '6.2.9200', '8'      then '8'
+          # The following `when` will never match since Windows 2012's platform
+          # version is the same as Windows 8. It's only here for completeness and
+          # documentation.
+          when '6.2.9200', '2012'   then '2012'
+          when /6\.3\.\d+/, '8.1' then '8.1'
+          # The following `when` will never match since Windows 2012R2's platform
+          # version is the same as Windows 8.1. It's only here for completeness
+          # and documentation.
+          when /6\.3\.\d+/, '2012r2' then '2012r2'
+          else
+            raise UnknownPlatformVersion.new(platform, platform_version)
+          end
+        else
+          raise UnknownPlatform.new(platform)
+        end
+      end
+    end
+
+    #
+    # Create a new metadata object for the given package and hash data.
+    #
+    # @param [Package] package
+    #   the package for this metadata
+    # @param [Hash] data
+    #   the hash of attributes to set in the metadata
+    #
+    def initialize(package, data = {})
+      @package = package
+      @data    = data.dup.freeze
+    end
+
+    #
+    # Helper for accessing the information inside the metadata hash.
+    #
+    # @return [Object]
+    #
+    def [](key)
+      @data[key]
+    end
+
+    #
+    # The name of this metadata file.
+    #
+    # @return [String]
+    #
+    def name
+      @name ||= File.basename(path)
+    end
+
+    #
+    # @see (Metadata.path_for)
+    #
+    def path
+      @path ||= self.class.path_for(@package)
+    end
+
+    #
+    # Save the file to disk.
+    #
+    # @return [true]
+    #
+    def save
+      File.open(path, 'w+')  do |f|
+        f.write(to_json)
+      end
+
+      true
+    end
+
+    #
+    # The JSON representation of this metadata.
+    #
+    # @return [String]
+    #
+    def to_json
+      JSON.pretty_generate(@data)
+    end
+  end
+end