omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/{null_builder.rb → compressors/null.rb}

@@ -1,7 +1,7 @@
 #
 # Copyright 2014 Chef Software, Inc.
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
+# 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
 #
@@ -15,9 +15,15 @@
 #
 
 module Omnibus
-  class NullBuilder < Builder
-    def build
-      log.info(log_key) { "Nothing to build for #{name}" }
+  class Compressor::Null < Compressor::Base
+    id :null
+
+    def package_name
+      ''
+    end
+
+    def run!
+      # noop
     end
   end
 end

data/lib/omnibus/compressors/tgz.rb

@@ -0,0 +1,141 @@
+#
+# 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 'rubygems/package'
+require 'zlib'
+
+module Omnibus
+  class Compressor::TGZ < Compressor::Base
+    id :tgz
+
+    setup do
+      # Copy the compiled package (.deb, .rpm, .pkg) into the staging directory
+      copy_file(packager.package_path, "#{staging_dir}/")
+    end
+
+    build do
+      write_tgz
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # Set or return the level of compression to use when generating the zipped
+    # tarball. Default: max compression.
+    #
+    # @example
+    #   compression_level 9
+    #
+    # @param [Fixnum] val
+    #   the compression level to use
+    #
+    # @return [Fixnum]
+    #
+    def compression_level(val = NULL)
+      if null?(val)
+        @compression_level || Zlib::BEST_COMPRESSION
+      else
+        unless val.is_a?(Integer)
+          raise InvalidValue.new(:compression_level, 'be an Integer')
+        end
+
+        unless val.between?(1, 9)
+          raise InvalidValue.new(:compression_level, 'be between 1-9')
+        end
+
+        @compression_level = val
+      end
+    end
+    expose :compression_level
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    #
+    # @see Base#package_name
+    #
+    def package_name
+      "#{packager.package_name}.tar.gz"
+    end
+
+    #
+    # Write the tar.gz to disk, reading in 1024 bytes at a time to reduce
+    # memory usage.
+    #
+    # @return [void]
+    #
+    def write_tgz
+      # Grab the contents of the gzipped tarball for reading
+      contents = gzipped_tarball
+
+      # Write the .tar.gz into the staging directory
+      File.open("#{staging_dir}/#{package_name}", 'wb') do |tgz|
+        while chunk = contents.read(1024)
+          tgz.write(chunk)
+        end
+      end
+
+      # Copy the .tar.gz into the package directory
+      FileSyncer.glob("#{staging_dir}/*.tar.gz").each do |tgz|
+        copy_file(tgz, Config.package_dir)
+      end
+    end
+
+    #
+    # Create an in-memory tarball from the given packager.
+    #
+    # @return [StringIO]
+    #
+    def tarball
+      tarfile = StringIO.new('')
+      Gem::Package::TarWriter.new(tarfile) do |tar|
+        path = "#{staging_dir}/#{packager.package_name}"
+        name = packager.package_name
+        mode = File.stat(path).mode
+
+        tar.add_file(name, mode) do |tf|
+          File.open(path, 'rb') do |file|
+            tf.write(file.read)
+          end
+        end
+      end
+
+      tarfile.rewind
+      tarfile
+    end
+
+    #
+    # Create the gzipped tarball. See {#tarball} for how the tarball is
+    # constructed. This method uses maximum gzip compression, unless the user
+    # specifies a different compression level.
+    #
+    # @return [StringIO]
+    #
+    def gzipped_tarball
+      gz = StringIO.new('')
+      z = Zlib::GzipWriter.new(gz, compression_level)
+      z.write(tarball.string)
+      z.close
+
+      # z was closed to write the gzip footer, so
+      # now we need a new StringIO
+      StringIO.new(gz.string)
+    end
+  end
+end

data/lib/omnibus/config.rb

@@ -73,25 +73,6 @@ module Omnibus
       end
       alias_method :has_key?, :key?
 
-      #
-      # Get a value from the config object.
-      #
-      # @deprecated Use direct method instead
-      #
-      # @param [Symbol] key
-      #   the key to fetch
-      #
-      # @return [Object]
-      #
-      def fetch(key)
-        Omnibus.logger.deprecated('Config') do
-          "fetch ([]). Please use `Config.#{key}' instead."
-        end
-
-        public_method_defined?(key.to_sym) && instance.send(key.to_sym)
-      end
-      alias_method :[], :fetch
-
       #
       # Reset the current configuration values. This method will unset any
       # "stored" or memorized configuration values.
@@ -137,22 +118,7 @@ module Omnibus
     #
     # @return [String]
     default(:git_cache_dir) do
-      if defined?(@install_path_cache_dir)
-        @install_path_cache_dir
-      else
-        File.join(base_dir, 'cache', 'git_cache')
-      end
-    end
-
-    # @deprecated Use {#git_cache_dir} instead.
-    #
-    # @return [String]
-    default(:install_path_cache_dir) do
-      Omnibus.logger.deprecated('Config') do
-        'Config.install_path_cache_dir. Plase use Config.git_cache_dir instead.'
-      end
-
-      git_cache_dir
+      File.join(base_dir, 'cache', 'git_cache')
     end
 
     # The absolute path to the directory on the virtual machine where
@@ -173,13 +139,14 @@ module Omnibus
     # @return [String]
     default(:package_dir) { File.join(base_dir, 'pkg') }
 
-    # 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.
+    # @deprecated Do not use this method.
     #
     # @return [String]
-    default(:package_tmp) { File.join(base_dir, 'pkg-tmp') }
+    default(:package_tmp) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.package_tmp. This value is no longer used."
+      end
+    end
 
     # The relative path of the directory containing {Omnibus::Project}
     # DSL files.  This is relative to {#project_root}.
@@ -210,28 +177,81 @@ module Omnibus
     # Package OSX pkg files inside a DMG
     #
     # @return [true, false]
-    default(:build_dmg, true)
+    default(:build_dmg) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.build_dmg. This value is no longer part of the " \
+        "config and is implied when defining a `compressor' block in the project."
+      end
+    end
 
     # The starting x,y and ending x,y positions for the created DMG window.
     #
     # @return [String]
-    default(:dmg_window_bounds, '100, 100, 750, 600')
+    default(:dmg_window_bounds) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.dmg_window_bounds. This value is no longer part of the " \
+        "config and should be defined in the `compressor' block in the project."
+      end
+    end
 
     # The starting x,y position where the .pkg file should live in the DMG
     # window.
     #
     # @return [String]
-    default(:dmg_pkg_position, '535, 50')
+    default(:dmg_pkg_position) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.dmg_pkg_position. This value is no longer part of the " \
+        "config and should be defined in the `compressor' block in the project."
+      end
+    end
 
     # Sign the pkg package.
     #
     # @return [true, false]
-    default(:sign_pkg, false)
+    default(:sign_pkg) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.sign_pkg. This value is no longer part of the config and " \
+        "should be defined in the `package' block in the project."
+      end
+    end
 
     # The identity to sign the pkg with.
     #
     # @return [String]
-    default(:signing_identity, nil)
+    default(:signing_identity) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.signing_identity. This value is no longer part of the " \
+        "config and should be defined in the `package' block in the project."
+      end
+    end
+
+    # --------------------------------------------------
+    # @!endgroup
+    #
+
+    #
+    # @!group RPM configuration options
+    # --------------------------------------------------
+
+    # Sign the rpm package.
+    #
+    # @return [true, false]
+    default(:sign_rpm) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.sign_rpm. This value is no longer part of the config and " \
+        "should be defined in the `package' block in the project."
+      end
+    end
+
+    # The passphrase to sign the RPM with.
+    #
+    # @return [String]
+    default(:rpm_signing_passphrase) do
+      Omnibus.logger.deprecated('Config') do
+        "Config.rpm_signing_passphrase. This value is no longer part of the " \
+        "config and should be defined in the `package' block in the project."
+      end
+    end
 
     # --------------------------------------------------
     # @!endgroup
@@ -252,21 +272,21 @@ module Omnibus
     #
     # @return [String]
     default(:s3_bucket) do
-      raise MissingConfigOption.new(:s3_bucket, "'my_bucket'")
+      raise MissingRequiredAttribute.new(self, :s3_bucket, "'my_bucket'")
     end
 
     # The S3 access key to use with S3 caching.
     #
     # @return [String]
     default(:s3_access_key) do
-      raise MissingConfigOption.new(:s3_access_key, "'ABCD1234'")
+      raise MissingRequiredAttribute.new(self, :s3_access_key, "'ABCD1234'")
     end
 
     # The S3 secret key to use with S3 caching.
     #
     # @return [String]
     default(:s3_secret_key) do
-      raise MissingConfigOption.new(:s3_secret_key, "'EFGH5678'")
+      raise MissingRequiredAttribute.new(self, :s3_secret_key, "'EFGH5678'")
     end
 
     # --------------------------------------------------
@@ -281,21 +301,21 @@ module Omnibus
     #
     # @return [String]
     default(:artifactory_endpoint) do
-      raise MissingConfigOption.new(:artifactory_endpoint, "'https://...'")
+      raise MissingRequiredAttribute.new(self, :artifactory_endpoint, "'https://...'")
     end
 
     # The username of the artifactory user to authenticate with.
     #
     # @return [String]
     default(:artifactory_username) do
-      raise MissingConfigOption.new(:artifactory_username, "'admin'")
+      raise MissingRequiredAttribute.new(self, :artifactory_username, "'admin'")
     end
 
     # The password of the artifactory user to authenticate with.
     #
     # @return [String]
     default(:artifactory_password) do
-      raise MissingConfigOption.new(:artifactory_password, "'password'")
+      raise MissingRequiredAttribute.new(self, :artifactory_password, "'password'")
     end
 
     # The base path artifacts are published to. This is usually maps to
@@ -304,7 +324,7 @@ module Omnibus
     #
     # @return [String]
     default(:artifactory_base_path) do
-      raise MissingConfigOption.new(:artifactory_base_path, "'com/mycompany'")
+      raise MissingRequiredAttribute.new(self, :artifactory_base_path, "'com/mycompany'")
     end
 
     # The path on disk to an SSL pem file to sign requests with.
@@ -349,14 +369,14 @@ module Omnibus
     #
     # @return [String]
     default(:publish_s3_access_key) do
-      raise MissingConfigOption.new(:publish_s3_access_key, "'ABCD1234'")
+      raise MissingRequiredAttribute.new(self, :publish_s3_access_key, "'ABCD1234'")
     end
 
     # The S3 secret key to use for S3 artifact release
     #
     # @return [String]
     default(:publish_s3_secret_key) do
-      raise MissingConfigOption.new(:publish_s3_secret_key, "'EFGH5678'")
+      raise MissingRequiredAttribute.new(self, :publish_s3_secret_key, "'EFGH5678'")
     end
 
     # --------------------------------------------------
@@ -367,17 +387,6 @@ module Omnibus
     # @!group Miscellaneous Configuration Parameters
     # --------------------------------------------------
 
-    # @deprecated The is no replacement for this configuration item
-    #
-    # @return [true, false]
-    default(:override_file) do
-      Omnibus.logger.deprecated('Config') do
-        'Config.override_file. Using an override file is deprecated.'
-      end
-
-      nil
-    end
-
     # An array of local disk paths that include software definitions to load
     # from disk. The software definitions in these paths are pulled
     # **in order**, so if multiple paths have the same software definition, the
@@ -393,18 +402,6 @@ module Omnibus
     # @return [Array<String>]
     default(:local_software_dirs) { [] }
 
-    # @deprecated Use {#software_gems} instead
-    #
-    # @return [String]
-    default(:software_gem) do
-      Omnibus.logger.deprecated('Config') do
-        'Config.software_gem. Plase use Config.software_gems (plural) and ' \
-        'specify an array of software gems instead.'
-      end
-
-      software_gems
-    end
-
     # The list of gems to pull software definitions from. The software
     # definitions from these gems are pulled **in order**, so if multiple gems
     # have the same software definition, the one that appears **first** in the
@@ -419,11 +416,7 @@ module Omnibus
     #
     # @return [Array<String>]
     default(:software_gems) do
-      if defined?(@software_gem)
-        Array(@software_gem)
-      else
-        ['omnibus-software']
-      end
+      ['omnibus-software']
     end
 
     # The solaris compiler to use
@@ -447,7 +440,7 @@ module Omnibus
     # The number of times to retry the build before failing.
     #
     # @return [Integer]
-    default(:build_retries, 3)
+    default(:build_retries, 0)
 
     # Use the incremental build caching implemented via git. This will
     # drastically improve build times, but may result in hidden and
@@ -456,6 +449,19 @@ module Omnibus
     # @return [true, false]
     default(:use_git_caching, true)
 
+    # The number of worker threads for make. If this is not set
+    # explicitly in config, it will attempt to determine via Ohai in
+    # the builder, and failing that will default to 3
+    #
+    # @return [Integer]
+    default(:workers) do
+      if Ohai['cpu'] && Ohai['cpu']['total']
+        Ohai['cpu']['total'].to_i + 1
+      else
+        3
+      end
+    end
+
     # --------------------------------------------------
     # @!endgroup
     #