omnibus 1.3.0 → 2.0.0.rc1

data/lib/omnibus/cli/cache.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,40 +21,38 @@ require 'omnibus/s3_cacher'
 module Omnibus
   module CLI
     class Cache < Base
-
       class_option :path,
-        :aliases => [:p],
-        :type => :string,
-        :default => Dir.pwd,
-        :desc => "Path to the Omnibus project root."
+                   aliases: [:p],
+                   type: :string,
+                   default: Dir.pwd,
+                   desc: 'Path to the Omnibus project root.'
 
       namespace :cache
 
-      desc "existing", "List source packages which exist in the cache"
+      desc 'existing', 'List source packages which exist in the cache'
       def existing
-        S3Cache.new.list.each {|s| puts s.name}
+        S3Cache.new.list.each { |s| puts s.name }
       end
 
-      desc "list", "List all cached files (by S3 key)"
+      desc 'list', 'List all cached files (by S3 key)'
       def list
-        S3Cache.new.list_by_key.each {|k| puts k}
+        S3Cache.new.list_by_key.each { |k| puts k }
       end
 
-      desc "missing", "Lists source packages that are required but not yet cached"
+      desc 'missing', 'Lists source packages that are required but not yet cached'
       def missing
-        S3Cache.new.missing.each {|s| puts s.name}
+        S3Cache.new.missing.each { |s| puts s.name }
       end
 
-      desc "fetch", "Fetches missing source packages to local tmp dir"
+      desc 'fetch', 'Fetches missing source packages to local tmp dir'
       def fetch
         S3Cache.new.fetch_missing
       end
 
-      desc "populate", "Populate the S3 Cache"
+      desc 'populate', 'Populate the S3 Cache'
       def populate
         S3Cache.new.populate
       end
-
     end
   end
 end

data/lib/omnibus/cli/release.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,28 +22,23 @@ require 'json'
 
 module Omnibus
   module CLI
-
-
     class Release < Base
-
       namespace :release
 
       def initialize(args, options, config)
         super(args, options, config)
       end
 
-      desc "package PATH", "Upload a single package to S3"
-      option :public, :type => :boolean, :default => false, :desc => "Make S3 object publicly readable"
+      desc 'package PATH', 'Upload a single package to S3'
+      option :public, type: :boolean, default: false, desc: 'Make S3 object publicly readable'
       def package(path)
         access_policy = options[:public] ? :public_read : :private
 
-        uploader = PackageRelease.new(path, :access => access_policy) do |uploaded_item|
+        uploader = PackageRelease.new(path, access: access_policy) do |uploaded_item|
           say("Uploaded #{uploaded_item}", :green)
         end
         uploader.release
       end
-
     end
   end
 end
-

data/lib/omnibus/cli.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,15 +21,13 @@ require 'omnibus/cli/build'
 
 module Omnibus
   module CLI
-
     class Error < StandardError
       attr_reader :original
 
-      def initialize(msg, original=nil)
+      def initialize(msg, original = nil)
         super(msg)
         @original = original
       end
     end
-
   end
 end

data/lib/omnibus/config.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,7 +20,6 @@ require 'omnibus/exceptions'
 require 'json'
 
 module Omnibus
-
   # Global configuration object for Omnibus runs.
   #
   # @todo Write a {http://yardoc.org/guides/extending-yard/writing-handlers.html
@@ -39,7 +38,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/cache"`.
     #
     #   @return [String]
-    cache_dir "/var/cache/omnibus/cache"
+    default :cache_dir, '/var/cache/omnibus/cache'
 
     # @!attribute [rw] source_dir
     #   The absolute path to the directory on the virtual machine where
@@ -48,7 +47,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/src"`.
     #
     #   @return [String]
-    source_dir "/var/cache/omnibus/src"
+    default :source_dir, '/var/cache/omnibus/src'
 
     # @!attribute [rw] build_dir
     #   The absolute path to the directory on the virtual machine where
@@ -57,7 +56,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/build"`.
     #
     #   @return [String]
-    build_dir "/var/cache/omnibus/build"
+    default :build_dir, '/var/cache/omnibus/build'
 
     # @!attribute [rw] package_dir
     #   The absolute path to the directory on the virtual machine where
@@ -66,7 +65,18 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/pkg"`.
     #
     #   @return [String]
-    package_dir "/var/cache/omnibus/pkg"
+    default :package_dir, '/var/cache/omnibus/pkg'
+
+    # @!attribute [rw] package_tmp
+    #   The absolute path to the directory on the virtual machine where
+    #   packagers will store intermediate packaging products. Some packaging
+    #   methods (notably fpm) handle this internally so not all packagers will
+    #   use this setting.
+    #
+    #   Defaults to `"/var/cache/omnibus/pkg-tmp"`.
+    #
+    #   @return [String]
+    default :package_tmp, '/var/cache/omnibus/pkg-tmp'
 
     # @!attribute [rw] project_dir
     #   The relative path of the directory containing {Omnibus::Project}
@@ -75,7 +85,7 @@ module Omnibus
     #   Defaults to `"config/projects"`.
     #
     #   @return [String]
-    project_dir "config/projects"
+    default :project_dir, 'config/projects'
 
     # @!attribute [rw] software_dir
     #   The relative path of the directory containing {Omnibus::Software}
@@ -84,7 +94,7 @@ module Omnibus
     #   Defaults to `"config/software"`.
     #
     #   @return [String]
-    software_dir "config/software"
+    default :software_dir, 'config/software'
 
     # @!attribute [rw] project_root
     #   The root directory in which to look for {Omnibus::Project} and
@@ -93,7 +103,7 @@ module Omnibus
     #   Defaults to the current working directory.
     #
     #   @return [String]
-    project_root Dir.pwd
+    default :project_root, Dir.pwd
 
     # @!attribute [rw] install_dir
     #   Installation directory
@@ -104,7 +114,7 @@ module Omnibus
     #     {Omnibus::Project#install_path}
     #
     #   @return [String]
-    install_dir "/opt/chef"
+    default :install_dir, '/opt/chef'
 
     # @!endgroup
 
@@ -118,7 +128,7 @@ module Omnibus
     #   Defaults to `false`.
     #
     #   @return [Boolean]
-    use_s3_caching false
+    default :use_s3_caching, false
 
     # @!attribute [rw] s3_bucket
     #   The name of the S3 bucket you want to cache software artifacts in.
@@ -126,7 +136,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true`.
     #
     #   @return [String, nil]
-    s3_bucket nil
+    default :s3_bucket, nil
 
     # @!attribute [rw] s3_access_key
     #   The S3 access key to use with S3 caching.
@@ -134,7 +144,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true`.
     #
     #   @return [String, nil]
-    s3_access_key nil
+    default :s3_access_key, nil
 
     # @!attribute [rw] s3_secret_key
     #   The S3 secret key to use with S3 caching.
@@ -142,7 +152,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true.`
     #
     #   @return [String, nil]
-    s3_secret_key nil
+    default :s3_secret_key, nil
 
     # @!endgroup
 
@@ -154,7 +164,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set to use `release package` command.
     #
     #   @return [String, nil]
-    release_s3_bucket nil
+    default :release_s3_bucket, nil
 
     # @!attribute [rw] release_s3_access_key
     #   The S3 access key to use for S3 artifact release.
@@ -162,7 +172,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set to use `release package` command.
     #
     #   @return [String, nil]
-    release_s3_access_key nil
+    default :release_s3_access_key, nil
 
     # @!attribute [rw] release_s3_secret_key
     #   The S3 secret key to use for S3 artifact release
@@ -170,7 +180,7 @@ module Omnibus
     #   Defaults to `nil`.  Must be set to use `release package` command.
     #
     #   @return [String, nil]
-    release_s3_secret_key nil
+    default :release_s3_secret_key, nil
 
     # @!endgroup
 
@@ -179,12 +189,23 @@ module Omnibus
     # @!attribute [rw] override_file
     #
     #   @return [Boolean]
-    override_file nil
+    default :override_file, nil
+
+    # @!attribute [rw] software_gem
+    #
+    #   The gem to pull software definitions from.  This is just the name of the gem, which is used
+    #   to find the path to your software definitions, and you must also specify this gem in the
+    #   Gemfile of your project repo in order to include the gem in your bundle.
+    #
+    #   Defaults to "omnibus-software".
+    #
+    #   @return [String, nil]
+    default :software_gem, 'omnibus-software'
 
     # @!attribute [rw] solaris_compiler
     #
     #   @return [String, nil]
-    solaris_compiler nil
+    default :solaris_compiler, nil
 
     # @!endgroup
 
@@ -193,7 +214,7 @@ module Omnibus
     # @!attribute [rw] append_timestamp
     #
     #   @return [Boolean]
-    append_timestamp true
+    default :append_timestamp, true
 
     # # @!endgroup
 
@@ -202,7 +223,7 @@ module Omnibus
     # @! attribute [rw] build_retries
     #
     #   @return [Integer, nil]
-    build_retries 3
+    default :build_retries, 3
 
     # @!group Validation Methods
 
@@ -220,12 +241,11 @@ module Omnibus
     def self.valid_s3_config?
       if use_s3_caching
         unless s3_bucket
-          raise InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
+          fail InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
         end
       end
     end
 
     # @!endgroup
-
   end # Config
 end # Omnibus

data/lib/omnibus/exceptions.rb

@@ -1,5 +1,4 @@
 module Omnibus
-
   class InvalidS3Configuration < RuntimeError
     def initialize(s3_bucket, s3_access_key, s3_secret_key)
       @s3_bucket, @s3_access_key, @s3_secret_key = s3_bucket, s3_access_key, s3_secret_key
@@ -91,6 +90,7 @@ module Omnibus
       """
     end
   end
+
   # Raise this error if a needed Project configuration value has not
   # been set.
   class MissingProjectConfiguration < RuntimeError
@@ -111,6 +111,26 @@ module Omnibus
     end
   end
 
+  # Raise this error if a needed Software configuration value has not
+  # been set.
+  class MissingSoftwareConfiguration < RuntimeError
+    def initialize(software_name, parameter_name, sample_value)
+      @software_name, @parameter_name, @sample_value = software, parameter_name, sample_value
+    end
+
+    def to_s
+      """
+      You are attempting to build software #{@sofware_name}, but have not specified
+      a value for '#{@parameter_name}'!
+
+      Please add code similar to the following to your software DSL file:
+
+         #{@parameter_name} '#{@sample_value}'
+
+      """
+    end
+  end
+
   class MissingPatch < RuntimeError
     def initialize(patch_name, search_paths)
       @patch_name, @search_paths = patch_name, search_paths
@@ -155,4 +175,18 @@ module Omnibus
       """
     end
   end
+
+  class MissingMacPkgResource < StandardError
+    def initialize(missing_file_paths)
+      @missing_file_paths = missing_file_paths
+    end
+
+    def to_s
+      <<-E
+      Your omnibus repo is missing the following files required to build Mac
+      packages:
+      #{@missing_file_paths.map { |p| "* #{p}" }.join("\n      ")}
+E
+    end
+  end
 end

data/lib/omnibus/fetcher.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +18,6 @@
 require 'pp'
 
 module Omnibus
-
   # Base class for classes that fetch project sources from the internet.
   #
   # @abstract Subclass and override the {#clean}, {#description},
@@ -27,7 +26,6 @@ module Omnibus
   # @todo Is this class supposed to be abstract or not?  Pretty sure
   #   it's supposed to be abstract
   class Fetcher
-
     # Given an error and a fetcher that generated the error, print a
     # formatted report of the error and stacktrace, along with fetcher
     # details to stderr.
@@ -43,7 +41,6 @@ module Omnibus
     #   since we're already outputting the real error and stacktrace
     #   here.
     class ErrorReporter
-
       def initialize(error, fetcher)
         @error, @fetcher = error, fetcher
       end
@@ -61,14 +58,14 @@ module Omnibus
       #   parameters (presumably the kind of fetcher and the software it
       #   is fetching?),
       def explain(why)
-        $stderr.puts "* " * 40
+        $stderr.puts '* ' * 40
         $stderr.puts why
-        $stderr.puts "Fetcher params:"
+        $stderr.puts 'Fetcher params:'
         $stderr.puts indent(@fetcher.description, 2)
-        $stderr.puts "Exception:"
+        $stderr.puts 'Exception:'
         $stderr.puts indent("#{e.class}: #{e.message.strip}", 2)
-        Array(e.backtrace).each {|l| $stderr.puts indent(l, 4) }
-        $stderr.puts "* " * 40
+        Array(e.backtrace).each { |l| $stderr.puts indent(l, 4) }
+        $stderr.puts '* ' * 40
       end
 
       private
@@ -82,9 +79,8 @@ module Omnibus
       # @param n [Fixnum] the number of " " characters to indent each line.
       # @return [String]
       def indent(string, n)
-        string.split("\n").map {|l| " ".rjust(n) << l }.join("\n")
+        string.split("\n").map { |l| ' '.rjust(n) << l }.join("\n")
       end
-
     end
 
     class UnsupportedSourceLocation < ArgumentError
@@ -129,11 +125,11 @@ module Omnibus
       elsif software.source[:path]
         PathFetcher.new(software)
       else
-        raise UnsupportedSourceLocation, "Don't know how to fetch software project #{software}"
+        fail UnsupportedSourceLocation, "Don't know how to fetch software project #{software}"
       end
     end
 
-    def self.name(name=NULL_ARG)
+    def self.name(name = NULL_ARG)
       @name = name unless name.equal?(NULL_ARG)
       @name
     end

data/lib/omnibus/fetchers/git_fetcher.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,10 +16,8 @@
 #
 
 module Omnibus
-
   # Fetcher implementation for projects in git.
   class GitFetcher < Fetcher
-
     name :git
 
     attr_reader :source
@@ -34,7 +32,7 @@ module Omnibus
     end
 
     def description
-      s=<<-E
+      <<-E
 repo URI:       #{@source[:git]}
 local location: #{@project_dir}
 E
@@ -47,9 +45,9 @@ E
 
     def clean
       if existing_git_clone?
-        log "cleaning existing build"
-        clean_cmd = "git clean -fdx"
-        shell = Mixlib::ShellOut.new(clean_cmd, :live_stream => STDOUT, :cwd => project_dir)
+        log 'cleaning existing build'
+        clean_cmd = 'git clean -fdx'
+        shell = Mixlib::ShellOut.new(clean_cmd, live_stream: STDOUT, cwd: project_dir)
         shell.run_command
         shell.error!
       end
@@ -76,7 +74,7 @@ E
         raise
       else
         # Deal with github failing all the time :(
-        time_to_sleep = 5 * (2 ** retries)
+        time_to_sleep = 5 * (2**retries)
         retries += 1
         log "git clone/fetch failed for #{@source} #{retries} time(s), retrying in #{time_to_sleep}s"
         sleep(time_to_sleep)
@@ -87,9 +85,9 @@ E
     private
 
     def clone
-      puts "cloning the source from git"
+      puts 'cloning the source from git'
       clone_cmd = "git clone #{@source[:git]} #{project_dir}"
-      shell = Mixlib::ShellOut.new(clone_cmd, :live_stream => STDOUT)
+      shell = Mixlib::ShellOut.new(clone_cmd, live_stream: STDOUT)
       shell.run_command
       shell.error!
     end
@@ -98,7 +96,7 @@ E
       sha_ref = target_revision
 
       checkout_cmd = "git checkout #{sha_ref}"
-      shell = Mixlib::ShellOut.new(checkout_cmd, :live_stream => STDOUT, :cwd => project_dir)
+      shell = Mixlib::ShellOut.new(checkout_cmd, live_stream: STDOUT, cwd: project_dir)
       shell.run_command
       shell.error!
     end
@@ -106,7 +104,7 @@ E
     def fetch_updates
       puts "fetching updates and resetting to revision #{target_revision}"
       fetch_cmd = "git fetch origin && git fetch origin --tags && git reset --hard #{target_revision}"
-      shell = Mixlib::ShellOut.new(fetch_cmd, :live_stream => STDOUT, :cwd => project_dir)
+      shell = Mixlib::ShellOut.new(fetch_cmd, live_stream: STDOUT, cwd: project_dir)
       shell.run_command
       shell.error!
     end
@@ -121,8 +119,8 @@ E
 
     def current_revision
       @current_rev ||= begin
-                         rev_cmd = "git rev-parse HEAD"
-                         shell = Mixlib::ShellOut.new(rev_cmd, :live_stream => STDOUT, :cwd => project_dir)
+                         rev_cmd = 'git rev-parse HEAD'
+                         shell = Mixlib::ShellOut.new(rev_cmd, live_stream: STDOUT, cwd: project_dir)
                          shell.run_command
                          shell.error!
                          output = shell.stdout
@@ -154,13 +152,11 @@ E
       # tags. We take care to only return exact matches in
       # process_remote_list.
       cmd = "git ls-remote origin #{ref}*"
-      shell = Mixlib::ShellOut.new(cmd, :live_stream => STDOUT, :cwd => project_dir)
+      shell = Mixlib::ShellOut.new(cmd, live_stream: STDOUT, cwd: project_dir)
       shell.run_command
       shell.error!
       commit_ref = process_remote_list(shell.stdout, ref)
-      if !commit_ref
-        raise "Could not parse SHA reference"
-      end
+      fail 'Could not parse SHA reference' unless commit_ref
       commit_ref
     rescue Exception => e
       if retries >= 3
@@ -168,7 +164,7 @@ E
         raise
       else
         # Deal with github failing all the time :(
-        time_to_sleep = 5 * (2 ** retries)
+        time_to_sleep = 5 * (2**retries)
         retries += 1
         log "git ls-remote failed for #{@source} #{retries} time(s), retrying in #{time_to_sleep}s"
         sleep(time_to_sleep)