omnibus 3.0.0 → 3.1.0

data/lib/omnibus/cli/deprecated.rb

@@ -0,0 +1,79 @@
+#
+# 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.
+#
+
+#
+# This file contains the deprecated commands. This class, its references, and
+# any associated tests should be removed in the next major release.
+#
+# @todo Remove in 4.0
+#
+module Omnibus
+  class Command::Base
+    class << self
+      alias_method :old_dispatch, :dispatch
+      def dispatch(m, args, options, config)
+        # Handle old --timestamp
+        if args.include?('--timestamp') || args.include?('-t')
+          warn("The '--timestamp' option has been deprecated! Please use '--override append_timestamp:true' instead.")
+          args.delete('--timestamp')
+          args.delete('-t')
+          args += %w(--override append_timestamp:true)
+        end
+
+        # Handle old --no-timestamp
+        if args.include?('--no-timestamp')
+          warn("The '--no-timestamp' option has been deprecated! Please use '--override append_timestamp:false' instead.")
+          args.delete('--no-timestamp')
+          args += %w(--override append_timestamp:false)
+        end
+
+        #
+        # Legacy build command:
+        #
+        #   $ 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.")
+          args.delete_at(1)
+          return old_dispatch(m, args, options, config)
+        end
+
+        #
+        # Legacy software builder:
+        #
+        #   $ omnibus build software SOFTWARE
+        #
+        if args[0..1] == %w(build software)
+          raise 'Building individual software definitions is no longer supported!'
+        end
+
+        #
+        # Legacy generator:
+        #
+        #   $ omnibus project PROJECT
+        #
+        if args[0] == 'project'
+          warn("The project generator has been renamed to 'omnibus new'. Please use 'omnibus new' in the future.")
+          args[0] = 'new'
+          return old_dispatch(m, args, options, config)
+        end
+
+        # Dispatch everything else down the stack
+        old_dispatch(m, args, options, config)
+      end
+    end
+  end
+end

data/lib/omnibus/cli/release.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# 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.
@@ -15,30 +14,27 @@
 # limitations under the License.
 #
 
-require 'omnibus/cli/base'
-require 'omnibus/cli/application'
-require 'omnibus/package_release'
-require 'json'
-
 module Omnibus
-  module CLI
-    class Release < Base
-      namespace :release
+  class Command::Release < Command::Base
+    namespace :release
 
-      def initialize(args, options, config)
-        super(args, options, config)
-      end
+    class_option :target,
+      aliases: '-t',
+      desc: 'The target backend to release the package',
+      default: 'S3'
 
-      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
+    method_option :public,
+      type: :boolean,
+      desc: 'Make S3 object publicly readable',
+      default: false
+    desc 'package PATH', 'Upload a single package to S3'
+    def package(path)
+      access_policy = options[:public] ? :public_read : :private
 
-        uploader = PackageRelease.new(path, access: access_policy) do |uploaded_item|
-          say("Uploaded #{uploaded_item}", :green)
-        end
-        uploader.release
+      uploader = PackageRelease.new(path, access: access_policy) do |uploaded_item|
+        say("Uploaded #{uploaded_item}", :green)
       end
+      uploader.release
     end
   end
 end

data/lib/omnibus/config.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.
@@ -16,8 +15,6 @@
 #
 
 require 'mixlib/config'
-require 'omnibus/exceptions'
-require 'json'
 
 module Omnibus
   # Global configuration object for Omnibus runs.
@@ -29,6 +26,16 @@ module Omnibus
   class Config
     extend Mixlib::Config
 
+    # Converts a given path to a platform specific path based on windows or
+    # linux.
+    def self.platformize_omnibus_path(path)
+      if Ohai.platform == 'windows'
+        File.join('C:\\omnibus-ruby', path).gsub(File::SEPARATOR, File::ALT_SEPARATOR)
+      else
+        File.join('/var/cache/omnibus', path)
+      end
+    end
+
     # @!group Directory Configuration Parameters
 
     # @!attribute [rw] cache_dir
@@ -38,7 +45,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/cache"`.
     #
     #   @return [String]
-    default :cache_dir, '/var/cache/omnibus/cache'
+    default(:cache_dir) { platformize_omnibus_path('cache') }
 
     # @!attribute [rw] install_path_cache_dir
     #   The absolute path to the directory on the virtual machine where
@@ -47,7 +54,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/cache/install_path"`.
     #
     #   @return [String]
-    default :install_path_cache_dir, '/var/cache/omnibus/cache/install_path'
+    default(:install_path_cache_dir) { platformize_omnibus_path('cache/install_path') }
 
     # @!attribute [rw] source_dir
     #   The absolute path to the directory on the virtual machine where
@@ -56,7 +63,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/src"`.
     #
     #   @return [String]
-    default :source_dir, '/var/cache/omnibus/src'
+    default(:source_dir) { platformize_omnibus_path('src') }
 
     # @!attribute [rw] build_dir
     #   The absolute path to the directory on the virtual machine where
@@ -65,7 +72,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/build"`.
     #
     #   @return [String]
-    default :build_dir, '/var/cache/omnibus/build'
+    default(:build_dir) { platformize_omnibus_path('build') }
 
     # @!attribute [rw] package_dir
     #   The absolute path to the directory on the virtual machine where
@@ -74,7 +81,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/pkg"`.
     #
     #   @return [String]
-    default :package_dir, '/var/cache/omnibus/pkg'
+    default(:package_dir) { platformize_omnibus_path('pkg') }
 
     # @!attribute [rw] package_tmp
     #   The absolute path to the directory on the virtual machine where
@@ -85,7 +92,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/pkg-tmp"`.
     #
     #   @return [String]
-    default :package_tmp, '/var/cache/omnibus/pkg-tmp'
+    default(:package_tmp) { platformize_omnibus_path('pkg-tmp') }
 
     # @!attribute [rw] project_dir
     #   The relative path of the directory containing {Omnibus::Project}
@@ -112,7 +119,7 @@ module Omnibus
     #   Defaults to the current working directory.
     #
     #   @return [String]
-    default :project_root, Dir.pwd
+    default(:project_root) { Dir.pwd }
 
     # @!attribute [rw] install_dir
     #   Installation directory
@@ -127,7 +134,7 @@ module Omnibus
 
     # @!endgroup
 
-    # @!group DMG configuration options
+    # @!group DMG / PKG configuration options
 
     # @!attribute [rw] build_dmg
     #   Package OSX pkg files inside a DMG
@@ -149,6 +156,22 @@ module Omnibus
     # @return [String]
     default :dmg_pkg_position, '535, 50'
 
+    # @!attribute [rw] sign_pkg
+    #   Sign the pkg package.
+    #
+    #   Default is false.
+    #
+    #   @return [Boolean]
+    default :sign_pkg, false
+
+    # @!attribute [rw] signing_identity
+    #   The identity to sign the pkg with.
+    #
+    #   Default is nil. Required if sign_pkg is set.
+    #
+    #   @return [String]
+    default :signing_identity, nil
+
     # @!endgroup
 
     # @!group S3 Caching Configuration Parameters
@@ -245,6 +268,7 @@ module Omnibus
     # @!group Build Version Parameters
 
     # @!attribute [rw] append_timestamp
+    #   Append the current timestamp to the version identifier.
     #
     #   @return [Boolean]
     default :append_timestamp, true
@@ -254,6 +278,7 @@ module Omnibus
     # @!group Build Control Parameters
 
     # @! attribute [rw] build_retries
+    #   The number of times to retry the build before failing.
     #
     #   @return [Integer, nil]
     default :build_retries, 3
@@ -274,7 +299,7 @@ module Omnibus
     def self.valid_s3_config?
       if use_s3_caching
         unless s3_bucket
-          fail InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
+          raise InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
         end
       end
     end

data/lib/omnibus/exceptions.rb

@@ -1,3 +1,19 @@
+#
+# 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.
+#
+
 module Omnibus
   class AbstractMethod < RuntimeError
     def initialize(signature)
@@ -9,6 +25,23 @@ module Omnibus
     end
   end
 
+  class ProjectNotFound < RuntimeError
+    def initialize(name)
+      @name = name
+    end
+
+    def to_s
+      out = "I could not find an Omnibus project named '#{@name}'! "
+      out << "Valid projects are:\n"
+
+      Omnibus.project_names.sort.each do |project_name|
+        out << "  * #{project_name}\n"
+      end
+
+      out.strip
+    end
+  end
+
   class MissingAsset < RuntimeError
     def initialize(path)
       @path = path
@@ -25,29 +58,48 @@ module Omnibus
     end
 
     def to_s
-      """
-      One or more required S3 configuration values is missing.
+      <<-EOH
+One or more required S3 configuration values is missing.
 
-      Your effective configuration was the following:
+Your effective configuration was the following:
 
-          s3_bucket     => #{@s3_bucket.inspect}
-          s3_access_key => #{@s3_access_key.inspect}
-          s3_secret_key => #{@s3_secret_key.inspect}
+    s3_bucket     #{@s3_bucket.inspect}
+    s3_access_key #{@s3_access_key.inspect}
+    s3_secret_key #{@s3_secret_key.inspect}
 
-      If you truly do want S3 caching, you should add values similar
-      to the following in your Omnibus config file:
+If you truly do want S3 caching, you should add values similar to the following
+in your Omnibus config file:
 
-            s3_bucket      ENV['S3_BUCKET_NAME']
-            s3_access_key  ENV['S3_ACCESS_KEY']
-            s3_secret_key  ENV['S3_SECRET_KEY']
+    s3_bucket     ENV['S3_BUCKET_NAME']
+    s3_access_key ENV['S3_ACCESS_KEY']
+    s3_secret_key ENV['S3_SECRET_KEY']
 
-      Note that you are not required to use environment variables as
-      illustrated (and the ones listed have no special significance in
-      Omnibus), but it is encouraged to prevent spread of sensitive
-      information and inadvertent check-in of same to version control
-      systems.
+Note that you are not required to use environment variables as illustrated (and
+the ones listed have no special significance in Omnibus), but it is encouraged
+to prevent spread of sensitive information and inadvertent check-in of same to
+version control systems.
+      EOH
+    end
+  end
 
-      """
+  class BadReplacesLine < RuntimeError
+    def to_s
+      <<-EOH
+The `replaces` project DSL statement should never equal the `package_name` or
+`name` of a project. The `replaces` option should only be used when you have
+published an artifact under one name and then later renamed the packages that
+you are publishing and you must obsolete the old package name. For example this
+is used, correctly, in chef-client builds:
+
+    name 'chef'
+    replaces 'chef-full'
+
+The RPMs and debs which were originally published were named "chef-full" and
+this was later renamed, and in order to upgrade the (very old) "chef-full"
+packages the new "chef" packages needed to know to uninstall any "chef-full"
+packages that were found. Projects which have never been renamed, however,
+should never use the replaces line.
+      EOH
     end
   end
 
@@ -135,7 +187,7 @@ module Omnibus
   # been set.
   class MissingSoftwareConfiguration < RuntimeError
     def initialize(software_name, parameter_name, sample_value)
-      @software_name, @parameter_name, @sample_value = software, parameter_name, sample_value
+      @software_name, @parameter_name, @sample_value = software_name, parameter_name, sample_value
     end
 
     def to_s

data/lib/omnibus/fetcher.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.
@@ -57,6 +56,7 @@ module Omnibus
       # @todo If {Omnibus::Fetcher#description} is meant to show
       #   parameters (presumably the kind of fetcher and the software it
       #   is fetching?),
+      # @todo make this use the logger
       def explain(why)
         $stderr.puts '* ' * 40
         $stderr.puts why
@@ -125,14 +125,12 @@ module Omnibus
       elsif software.source[:path]
         PathFetcher.new(software)
       else
-        fail UnsupportedSourceLocation, "Don't know how to fetch software project #{software}"
+        raise UnsupportedSourceLocation, "Don't know how to fetch software project #{software}"
       end
     end
 
-    def self.name(name = NULL_ARG)
-      @name = name unless name.equal?(NULL_ARG)
-      @name
-    end
+    include Logging
+    include Util
 
     attr_reader :name
 
@@ -140,10 +138,7 @@ module Omnibus
     attr_reader :source_timefile
 
     def initialize(software)
-    end
-
-    def log(message)
-      puts "[fetcher:#{self.class.name}::#{name}] #{message}"
+      @software = software
     end
 
     # @!group Methods for Subclasses to Implement
@@ -175,6 +170,18 @@ module Omnibus
     def version_guid
     end
 
+    # Returns the version to be used during build caching.
+    # By default fetchers don't override the versions.
+    def version_for_cache
+      nil
+    end
+
+    private
+
+    def log_key
+      @log_key ||= "#{super}: #{@software.name}"
+    end
+
     # !@endgroup
   end
 end