omnibus 3.2.0.rc.1 → 3.2.0.rc.2

data/lib/omnibus/cleanroom.rb

@@ -68,20 +68,20 @@ module Omnibus
           raise NameError, "undefined method `#{name}' for class `#{self.name}'"
         end
 
-        exposed[name] = true
+        exposed_methods[name] = true
       end
 
-      private
-
       #
       # The list of exposed methods.
       #
       # @return [Hash]
       #
-      def exposed
-        @exposed ||= {}
+      def exposed_methods
+        @exposed_methods ||= {}
       end
 
+      private
+
       #
       # The cleanroom instance for this class. This method is intentionally
       # NOT cached!
@@ -89,7 +89,7 @@ module Omnibus
       # @return [Class]
       #
       def cleanroom
-        exposed_methods = exposed.keys
+        exposed = exposed_methods.keys
         parent = self.name
 
         Class.new do
@@ -97,7 +97,7 @@ module Omnibus
             @instance = instance
           end
 
-          exposed_methods.each do |exposed_method|
+          exposed.each do |exposed_method|
             define_method(exposed_method) do |*args, &block|
               @instance.send(exposed_method, *args, &block)
             end

data/lib/omnibus/cli/deprecated.rb

@@ -68,7 +68,7 @@ module Omnibus
         #   $ omnibus build project PROJECT
         #
         if args[0..1] == %w(build project)
-          warn("The interface for building a project has changed. Please use 'omnibus build hamlet' instead.")
+          warn("The interface for building a project has changed. Please use 'omnibus build #{args[2]}' instead.")
           args.delete_at(1)
           return old_dispatch(m, args, options, config)
         end

data/lib/omnibus/exceptions.rb

@@ -290,17 +290,17 @@ EOH
   end
 
   #
-  # Raised when Omnibus encounters a platform_family it does not know how to
+  # Raised when Omnibus encounters a platform it does not know how to
   # build/check/handle.
   #
-  class UnknownPlatformFamily < Error
-    def initialize(family)
-      @family = family
+  class UnknownPlatform < Error
+    def initialize(platform)
+      @platform = platform
     end
 
     def to_s
       <<-EOH
-Unknown platform family `#{@family}'!
+Unknown platform `#{@platform}'!
 I do not know how to proceed!"
 EOH
     end
@@ -327,6 +327,37 @@ EOH
     def to_s
       <<-EOH
 The health check failed! Please see above for important information.
+EOH
+    end
+  end
+
+  class MissingBuildBlock < Error
+    def initialize(software)
+      @software = software
+    end
+
+    def to_s
+      <<-EOH
+The software definition `#{@software.name}' does not define a build block. In
+order to build the software, you must define a build block like:
+
+    build do
+      # Build steps here
+    end
+      EOH
+    end
+  end
+
+  class MissingSoftwareSourceURI < Error
+    def initialize(software)
+      @software = software
+    end
+
+    def to_s
+      <<-EOH
+The software `#{@software.name}' does not declare a `source' attribute which is
+a URL. This is not a required attribute, but you are attempting to access
+another attribute or method that requires a `source' (URI) is defined.
 EOH
     end
   end

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -14,6 +14,10 @@
 # limitations under the License.
 #
 
+require 'net/http'
+require 'net/https'
+require 'net/ftp'
+
 module Omnibus
   class UnsupportedURIScheme < ArgumentError
   end

data/lib/omnibus/git_cache.rb

@@ -116,13 +116,13 @@ module Omnibus
       remove_git_dirs
 
       shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{install_dir} add -A -f))
+
       begin
         shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{install_dir} commit -q -m "Backup of #{tag}"))
       rescue Mixlib::ShellOut::ShellCommandFailed => e
-        if e.message !~ /nothing to commit/
-          raise
-        end
+        raise unless e.message.include?('nothing to commit')
       end
+
       shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{install_dir} tag -f "#{tag}"))
     end
 

data/lib/omnibus/instrumentation.rb

@@ -0,0 +1,29 @@
+#
+# Copyright 2013-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
+  module Instrumentation
+    include Logging
+
+    def measure(label, &block)
+      start = Time.now
+      block.call
+    ensure
+      elapsed = Time.now - start
+      log.info(log_key) { "#{label}: #{elapsed.to_f.round(4)}s" }
+    end
+  end
+end

data/lib/omnibus/package.rb

@@ -33,11 +33,14 @@ module Omnibus
         #
         def generate(package, data = {})
           data = {
-            basename: package.name,
-            md5:      package.md5,
-            sha1:     package.sha1,
-            sha256:   package.sha256,
-            sha512:   package.sha512,
+            basename:         package.name,
+            md5:              package.md5,
+            sha1:             package.sha1,
+            sha256:           package.sha256,
+            sha512:           package.sha512,
+            platform:         platform_shortname,
+            platform_version: platform_version,
+            arch:             arch,
           }.merge(data)
 
           instance = new(package, data)
@@ -56,6 +59,10 @@ module Omnibus
         def for_package(package)
           data = File.read(path_for(package))
           hash = JSON.parse(data, symbolize_names: true)
+
+          # Ensure an interation exists
+          hash[:iteration] ||= 1
+
           new(package, hash)
         rescue Errno::ENOENT
           raise NoPackageMetadataFile.new(package.path)
@@ -72,6 +79,92 @@ module Omnibus
         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
+
+        #
+        # 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_shortname
+        #   the platform shortname. this might be an Ohai-returned platform or
+        #   platform family but it also might be a shortname like `el`
+        #
+        def platform_version
+          case platform_shortname
+          when 'centos', 'debian', 'fedora', 'freebsd', 'rhel', 'el'
+            # Only want MAJOR (e.g. Debian 7)
+            Ohai['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)
+            Ohai['platform_version'].split('.')[0..1].join('.')
+          when 'omnios', 'smartos'
+            # Only want MAJOR (e.g OmniOS r151006, SmartOS 20120809T221258Z)
+            Ohai['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 Ohai['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.9200', '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.9200', '2012r2' then '2012r2'
+            else
+              raise UnknownPlatformVersion.new(platform_shortname, Ohai['platform_version'])
+            end
+          else
+            raise UnknownPlatform.new(platform_shortname)
+          end
+        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
       end
 
       #

data/lib/omnibus/packagers/base.rb

@@ -20,6 +20,7 @@ require 'erb'
 
 module Omnibus
   class Packager::Base
+    include Logging
     include Util
 
     extend Forwardable

data/lib/omnibus/project.rb

@@ -185,7 +185,7 @@ module Omnibus
       if null?(val)
         @install_dir || raise(MissingProjectConfiguration.new('install_dir', '/opt/chef'))
       else
-        @install_dir = windows_safe_path(val)
+        @install_dir = File.expand_path(windows_safe_path(val))
       end
     end
     expose :install_dir
@@ -223,7 +223,7 @@ module Omnibus
     #   path to the files directory
     #
     def files_path
-      "#{Config.project_root}/files"
+      File.expand_path("#{Config.project_root}/files")
     end
     expose :files_path
 
@@ -521,7 +521,7 @@ module Omnibus
       if null?(val)
         @resources_path
       else
-        @resources_path = val
+        @resources_path = File.expand_path(val)
       end
     end
     expose :resources_path
@@ -556,7 +556,7 @@ module Omnibus
       if null?(arg)
         @package_scripts_path || "#{Config.project_root}/package-scripts/#{name}"
       else
-        @package_scripts_path = arg
+        @package_scripts_path = File.expand_path(arg)
       end
     end
     expose :package_scripts_path
@@ -836,7 +836,7 @@ module Omnibus
     # @return [Array<String>]
     #
     def runtime_dependencies
-      runtime_dependencies ||= []
+      @runtime_dependencies ||= []
     end
 
     #
@@ -1122,62 +1122,6 @@ module Omnibus
       end
     end
 
-    #
-    # Platform version to be used in package metadata. For rhel, the minor
-    # version is removed, e.g., "5.6" becomes "5". For all other platforms,
-    # this is just the platform_version.
-    #
-    # @return [String]
-    #   the platform version
-    #
-    def platform_version_for_package
-      case Ohai['platform_family']
-      when 'debian', 'fedora', 'freebsd', 'rhel'
-        if Ohai['platform'] == 'ubuntu'
-          # Only want MAJOR.MINOR (Ubuntu 12.04)
-          Ohai['platform_version'].split('.')[0..1].join('.')
-        else
-          # Only want MAJOR (Debian 7)
-          Ohai['platform_version'].split('.').first
-        end
-      when 'aix', 'arch', 'gentoo', 'mac_os_x', 'openbsd', 'slackware', 'solaris2', 'suse'
-        # Only want MAJOR.MINOR
-        Ohai['platform_version'].split('.')[0..1].join('.')
-      when 'omnios', 'smartos'
-        # Only want MAJOR
-        Ohai['platform_version'].split('.').first
-      when 'windows'
-        # Windows has this really awesome "feature", where their version numbers
-        # internally do not match the "marketing" name. Dear Microsoft, this is
-        # why we cannot have nice things.
-        case Ohai['platform_version']
-        when '6.1.7600' then '7'
-        when '6.1.7601' then '2008r2'
-        when '6.2.9200' then '8'
-        when '6.3.9200' then '8.1'
-        else
-          raise UnknownPlatformVersion.new(Ohai['platform'], Ohai['platform_version'])
-        end
-      else
-        raise UnknownPlatformFamily.new(Ohai['platform_family'])
-      end
-    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
-
     def render_metadata(pkg_type)
       basename = output_package(pkg_type)
       pkg_path = "#{Config.package_dir}/#{basename}"
@@ -1191,9 +1135,6 @@ module Omnibus
         name:             name,
         friendly_name:    friendly_name,
         homepage:         homepage,
-        platform:         platform_shortname,
-        platform_version: platform_version_for_package,
-        arch:             Ohai['kernel']['machine'],
         version:          build_version,
         iteration:        build_iteration,
       )

data/lib/omnibus/publishers/artifactory_publisher.rb

@@ -93,8 +93,9 @@ module Omnibus
         'omnibus.project'          => package.metadata[:name],
         'omnibus.platform'         => package.metadata[:platform],
         'omnibus.platform_version' => package.metadata[:platform_version],
-        'omnibus.arch'             => package.metadata[:arch],
+        'omnibus.architecture'     => package.metadata[:arch],
         'omnibus.version'          => package.metadata[:version],
+        'omnibus.iteration'        => package.metadata[:iteration],
         'omnibus.md5'              => package.metadata[:md5],
         'omnibus.sha1'             => package.metadata[:sha1],
         'omnibus.sha256'           => package.metadata[:sha256],
@@ -137,6 +138,8 @@ module Omnibus
         *domain_parts,
         package.metadata[:name],
         package.metadata[:version],
+        package.metadata[:platform],
+        package.metadata[:platform_version],
         package.metadata[:basename],
       )
     end

data/lib/omnibus/software.rb

@@ -72,16 +72,6 @@ module Omnibus
       @repo_overrides = repo_overrides
     end
 
-    #
-    # The builder for this softare. This defaults to a {NullBuilder}, but
-    # can be specified using the {#build} DSL method.
-    #
-    # @return [Builder]
-    #
-    def builder
-      @builder ||= NullBuilder.new(self)
-    end
-
     #
     # Compare two software projects (by name).
     #
@@ -363,7 +353,7 @@ module Omnibus
     # @return [String]
     #
     def project_dir
-      @project_dir ||= File.join(Config.source_dir, relative_path)
+      File.expand_path("#{Config.source_dir}/#{relative_path}")
     end
     expose :project_dir
 
@@ -373,7 +363,7 @@ module Omnibus
     # @return [String]
     #
     def build_dir
-      "#{Config.build_dir}/#{project.name}"
+      File.expand_path("#{Config.build_dir}/#{project.name}")
     end
     expose :build_dir
 
@@ -441,7 +431,7 @@ module Omnibus
     expose :architecture
 
     #
-    # Define a series of {Builder} DSL commands that are required to build the
+    # Define a series of {Builder} DSL commands that are executed to build the
     # software.
     #
     # @see Builder
@@ -449,18 +439,43 @@ module Omnibus
     # @param [Proc] block
     #   a block of build commands
     #
-    # @return [Builder]
-    #   the builder instance
-    #
-    # @todo Seems like this renders the setting of @builder in the initializer
-    #   moot
+    # @return [Proc]
+    #   the build block
     #
     def build(&block)
-      @builder = Builder.new(self, &block)
-      @builder
+      builder.evaluate(&block)
     end
     expose :build
 
+    #
+    # The path on disk to the downloaded asset. This method requires the
+    # presence of a +source_uri+.
+    #
+    # @todo This is really a property of the {NetFetcher} and should be
+    #   implemented on that class.
+    #
+    def downloaded_file
+      @downloaded_file ||= begin
+        raise MissingSoftwareSourceURI.new(self) unless source_uri
+
+        filename = source_uri.path.split('/').last
+        "#{Config.cache_dir}/#{filename}"
+      end
+    end
+    expose :downloaded_file
+
+    #
+    # @deprecated Use {#downloaded_file} instead
+    #
+    def project_file
+      log.deprecated(log_key) do
+        "project_file (DSL). Please use `downloaded_file' instead."
+      end
+
+      downloaded_file
+    end
+    expose :project_file
+
     #
     # Add standard compiler flags to the environment hash to produce omnibus
     # binaries (correct RPATH, etc).
@@ -510,6 +525,11 @@ module Omnibus
             "LDFLAGS" => "-R#{install_dir}/embedded/lib -L#{install_dir}/embedded/lib -static-libgcc",
             "CFLAGS" => "-I#{install_dir}/embedded/include",
           }
+        when "freebsd"
+          {
+            "LDFLAGS" => "-R#{install_dir}/embedded/lib -L#{install_dir}/embedded/lib",
+            "CFLAGS" => "-I#{install_dir}/embedded/include",
+          }
         else
           {
             "LDFLAGS" => "-Wl,-rpath,#{install_dir}/embedded/lib -L#{install_dir}/embedded/lib",
@@ -671,6 +691,15 @@ module Omnibus
     # be the "public API" for a software.
     # --------------------------------------------------
 
+    #
+    # The builder object for this software definition.
+    #
+    # @return [Builder]
+    #
+    def builder
+      @builder ||= Builder.new(self)
+    end
+
     #
     # Fetch the software definition using the appropriate fetcher. This may
     # fetch the software from a local path location, git location, or download
@@ -801,14 +830,6 @@ module Omnibus
       source[:md5]
     end
 
-    # @todo See comments for {#source_uri}... same applies here.  If
-    #   this is called in a non-source-software context, bad things will
-    #   happen.
-    def project_file
-      filename = source_uri.path.split('/').last
-      "#{Config.cache_dir}/#{filename}"
-    end
-
     # The fetcher for this software.
     #
     # @return [Fetcher]
@@ -870,11 +891,13 @@ module Omnibus
         digest = Digest::SHA256.new
 
         log.debug(log_key) { "project (SHA): #{project.shasum.inspect}" }
+        log.debug(log_key) { "builder (SHA): #{builder.shasum.inspect}" }
         log.debug(log_key) { "name: #{name.inspect}" }
         log.debug(log_key) { "version_for_cache: #{version_for_cache.inspect}" }
         log.debug(log_key) { "overrides: #{overrides.inspect}" }
 
         update_with_string(digest, project.shasum)
+        update_with_string(digest, builder.shasum)
         update_with_string(digest, name)
         update_with_string(digest, version_for_cache)
         update_with_string(digest, JSON.fast_generate(overrides))
@@ -955,7 +978,7 @@ module Omnibus
 
     def execute_build(fetcher)
       fetcher.clean
-      @builder.build
+      builder.build
 
       if Config.use_git_caching
         log.info(log_key) { 'Caching build' }