omnibus 4.0.0.rc.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67c9874074d2cec13ed5734f8e6f420ccfb157d7
-  data.tar.gz: 9fff24c7c26e8ef92175dac8c01b5c0883e2e2e1
+  metadata.gz: 42ba84e6247d1cec8f21fb01ec6324e850a1e10e
+  data.tar.gz: 74c043e787a3728d746c282cadb46ed4024cb99c
 SHA512:
-  metadata.gz: e2bbe215dd2606a272c04d1be03126d67cf0db748032616cfee7d699f355fef833f3d7b7bc29767c57bcd7e9c4dba8e1fde145d412ef8eb00b9d2eecbe53a9f0
-  data.tar.gz: 250b20df2e0c254335c29e0fb4490a764e8ce52044804e057c625b75034b638d868d3d91cb7b0593bf18742daf010187cb7f2e9b41a52b7a006fbe3c75d3129b
+  metadata.gz: 954792cc931a139486c646236e63c8d1a87c9f8841600918c769d262d943e886ed85fa7698b543acc6c0385849a55ea620331b6220812b2c57fcc9039192fa9c
+  data.tar.gz: 81830612f63dc5664bd3257c9b232911c1730af9f0d3b7f31f53684424272d34262b9e154013caacc4f05c51531e25a3b382539a888fb49ac7ddf39a057cf69e

data/CHANGELOG.md

@@ -1,63 +1,8 @@
 Omnibus CHANGELOG
 =================
 
-v4.0.0.rc.2 (November 10, 2014)
--------------------------------
-
-### New Features
-
-#### Platforms
-- Raspberry Pi platform support (currently Raspbian and Pidora)
-- AIX
-    - XL C is the default compiler on AIX.
-- FreeBSD 10
-    - Clang is the default compiler on FreeBSD 10+
-    - Add `libgcc` and `libelf` to the FreeBSD whitelist
-- Solaris
-    - Make compilation default `-static-libgcc`
-
-### Bugfixes
-
-- Set default values for `CXXFLAGS`.
-- Retrieve the correct path_key from the ENV on Windows.
-- openSUSE/SLES fixes for OHAI-339.
-- Properly truncate platform version on Arch Linux.
-- Ensure final `*.dmg` name matches actual `*.pkg` name.
-- Change `makeself` package extension back to `.sh`.
-- Generate a default `makeselfinst` which fires at following install.
-- Map `Omnibus::Project#replaces` to RPM Spec file's `Obsoletes:`.
-
-v4.0.0.rc.1 (September 23, 2014)
---------------------------------
-
-### New Features
-- Expose `build_version` to all `pkg` templates
-- Improve info messages during RPM creation
-- Make PKG packager aware of scripts with default Omnibus naming
-- Make RPM packager aware of scripts with default Omnibus naming
-- Clean up script logic in BFF packager
-- Add an option for configuring Fetcher read timeout
-
-### DSL Changes
-#### Builder
-- Add an `appbundle` function to the builder DSL
-
-#### Packager
-- Expose `install_dir` in Packager DSL
-- Expose `windows_safe_path` in Packager DSL
-
-### Bugfixes
-- Replace dashes with underscores in RPM version names.
-- The achitecture of deb package is i386, not i686.
-- Re-ignore 204 exit code from `light.exe`
-- Use single quotes in main `rpmbuild` command
-- Be sure to create and sign the RPM if `~/.rpmmacros` exists
-- Switch to OpenSSL::Digest which is threadsafe on 2.1.2
-- Ensure `GitFetcher` properly resolves remote refs
-- Ensure we clean ALL Ruby environment vars
-
-v4.0.0.beta.1 (August 20, 2014)
--------------------------------
+v4.0.0 (December 15, 2014)
+--------------------------
 ### New Features
 - Implement packager-specific DSLs. Packagers now define their own custom methods that may be configured using the `package` block in a project file. For more information, please see the README or any of the embedded "Building on X" documents.
 - Use vendored assets. In previous versions of Omnibus, the generator would create resource assets for DMG, PKG, and MSI packages, regardless of whether you intended to build those packages. This could cause repo bloat and information overload. In Omnibus 4, the default generator does not create these assets, and instead prefers "general" vendored assets. If you are planning to make a resource-intensive package (such as a PKG or MSI), it is encouraged you generate these assets by specifing the `--pkg-assets` flag during project generation. Omnibus will prefer local resources in the `resources/` directory and then fall-back to "sane" defaults which are vendored within Omnibus.
@@ -101,6 +46,8 @@ v4.0.0.beta.1 (August 20, 2014)
 - Added `Config.workers` key for specifying the maximum number of parallel events to take place.
 - Added parallel downloads for fetcher objects.
 - Use `fakeroot` for building DEBs and RPMs.
+- Raspberry Pi platform support (Raspian, Pidora).
+- Retry uploads to Artifactory on publish failures.
 
 ### Potentially Breaking Changes
 - Remove embedded functional tests. Because the functional tests were skipped on CI (and require a system of each type to properly execute), they have been removed. Chef has created the [omnibus-harmony](https://github.com/opscode/omnibus-harmony) pipeline to perform true integration testing using the in-house CI cluster. If you were relying on the integration tests (or the associated Rake tasks), they have been removed.
@@ -133,6 +80,10 @@ v4.0.0.beta.1 (August 20, 2014)
 - Truncate SLES and other RedHat derivatives platform version.
 - Refactor logger objects to separate Omnibus internal debugging info with build/compile/configure debugging info.
 - Improve error and debugging output when an exception is raised while shelling out. Failed shell commands will now raise `Omnibus::CommandFailed` and `Omnibus::CommandTimeout` instead of the `Mixlib::ShellOut` exceptions. If you were previously rescuing the Mixlib exceptions, you should switch to the new ones.
+- XL C is now the default compiler on AIX
+- Clang is now the default compiler on FreeBSD 10+
+- Make compilation default `-static-libgcc` on Solaris
+- Only allow installation on system volume for Mac OS X PKGs.
 
 ### Definitely Breaking Changes
 - Previously deprecated methods have been removed.
@@ -194,6 +145,8 @@ v4.0.0.beta.1 (August 20, 2014)
 - Removed `Project#machine`. Use `ohai` instead.
 - Removed `Project#dependencies`. List each dependency using `dependency` instead.
 - Added `Project#ohai` for quick access to Ohai data.
+
+#### Software
 - Removed `Software#override_version`. There is no replacement.
 - Removed `Software#install_dir`. Please use `Software#install_path` instead.
 - Removed `Software#platform_version`. Use `ohai` instead.
@@ -205,10 +158,15 @@ v4.0.0.beta.1 (August 20, 2014)
 - Removed `Software#source_dir`. You can use `Omnibus::Config.source_dir` instead, but if you need access to this method, it is probably a bug in Omnibus.
 - Removed `Software#cache_dir`. You can use `Omnibus::Config.cache_dir` instead, but if you need access to this method, it is probably a bug in Omnibus.
 - Removed `Software#config`. You can use `Omnibus::Config` instead.
+
+#### Builder
 - Added `Builder#make` for choosing the correct `make` binary on the system. When `gmake` is present, it is preferred. The use of this method also sets the `MAKE` environment variable for consistency. You should change all instances of `command "make ..."` to `make "..."` to ensure true cross-platform building.
 - Added `Builder#windows_safe_path` for shelling out to the system with the correct path separators.
 - Added `Buidler#workers` for delegation to the config option.
 - Removed `Buidler#max_build_jobs` in favor of `Builder#workers`.
+- Add an `Builder#appbundle` function to the builder DSL
+
+#### Packagers
 - Added `Packager::DEB#vendor` for specifying the package vendor.
 - Added `Packager::DEB#license` for specifying the package license.
 - Added `Packager::DEB#priority` for specifying the package priority.
@@ -233,7 +191,9 @@ v4.0.0.beta.1 (August 20, 2014)
 - Standardized license headers.
 - Added SSH forwarding as part of the default generated `.kitchen.yml`.
 - Updated Chef version in generated `.kitchen.yml`.
-
+- Switch to OpenSSL::Digest which is threadsafe on 2.1.2
+- Ensure final `*.dmg` name matches actual `*.pkg` name.
+- Replace dashes (`-`) with tildes (`~`) in DEB and RPM versions
 
 v3.2.1 (July 26, 2014)
 ----------------------

data/README.md

@@ -39,10 +39,10 @@ You can now create an Omnibus project in your current directory by using the pro
 $ omnibus new $MY_PROJECT_NAME
 ```
 
-This will generate a complete project skeleton in the directory `$MY_PROJECT_NAME`
+This will generate a complete project skeleton in the directory `omnibus-$MY_PROJECT_NAME`
 
 ```bash
-$ cd $MY_PROJECT_NAME
+$ cd omnibus-$MY_PROJECT_NAME
 $ bundle install --binstubs
 $ bin/omnibus build $MY_PROJECT_NAME
 ```

data/docs/Building on Debian.md

@@ -13,9 +13,9 @@ A number of project configuration values are taken into consideration for buildi
 
 These values are interpolated and evaluated using Omnibus' internal DEB templates. For 99% of users, these templates should be satisfactory. If you encounter an instance where Omnibus' ERB templates do not satisfy a use case, please open an issue.
 
-Because of the unlikelihood of their necessity, Omnibus does not generate deb-related assets. If you find yourself in a situation where you need to generate highly-customized DEB assets, run the Omnibus generator command with the `--deb-assets` flag:
+Because of the unlikelihood of their necessity, Omnibus does not generate deb-related assets. If you find yourself in a situation where you need to generate highly-customized DEB assets, run the Omnibus new command with the `--deb-assets` flag:
 
-    $ omnibus generate NAME --deb-assets
+    $ omnibus new NAME --deb-assets
 
 **If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
 

data/docs/Building on OSX.md

@@ -8,9 +8,9 @@ Building a .pkg
 In Mac OS X, a `.pkg` is a special file that is read by Installer.app that contains the set of instructions for installating a piece of software on a target system.
 
 ### Requirements
-By default, Omnibus does not generate pkg-related assets. To generate the pkg assets, run the Omnibus generator command with the `--pkg-assets` flag:
+By default, Omnibus does not generate pkg-related assets. To generate the pkg assets, run the Omnibus new command with the `--pkg-assets` flag:
 
-    $ omnibus generate NAME --pkg-assets
+    $ omnibus new NAME --pkg-assets
 
 **If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
 
@@ -53,9 +53,9 @@ Building a .dmg
 In Mac OSX, a `.dmg` is a compressed wrapper around a collection of resources, often including a `.pkg`. The possibilities for creating and customizing a DMG are endless, but Omnibus provides a"basic starter case that will generate a pretty DMG that contains the `.pkg` file it creates.
 
 ### Requirements
-By default, Omnibus does not generate dmg-related assets. To generate the dmg assets, run the Omnibus generator with the `--dmg-assets` flag:
+By default, Omnibus does not generate dmg-related assets. To generate the dmg assets, run the Omnibus new with the `--dmg-assets` flag:
 
-    $ omnibus generate NAME --dmg-assets
+    $ omnibus new NAME --dmg-assets
 
 **If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
 

data/docs/Building on RHEL.md

@@ -31,9 +31,9 @@ These options are further described in the [`Project` documentation](http://ruby
 
 These values are interpolated and evaluated using Omnibus' internal RPM templates. For 99% of users, these templates should be satisfactory. If you encounter an instance where Omnibus' RPM templates do not satisfy a use case, please open an issue.
 
-Because of the unlikelihood of their necessity, Omnibus does not generate rpm-related assets. If you find yourself in a situation where you need to generate highly-customized RPM assets, run the Omnibus generator command with the `--rpm-assets` flag:
+Because of the unlikelihood of their necessity, Omnibus does not generate rpm-related assets. If you find yourself in a situation where you need to generate highly-customized RPM assets, run the Omnibus new command with the `--rpm-assets` flag:
 
-    $ omnibus generate NAME --rpm-assets
+    $ omnibus new NAME --rpm-assets
 
 **If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
 

data/docs/Building on Windows.md

@@ -8,9 +8,9 @@ Building an .msi
 In Windows, an `.msi` is a special executable that contains the set of instructions for installating a piece of software on a target system. Please note, Omnibus does not support the creation of `.exe` files.
 
 ### Requirements
-By default, Omnibus does not generate msi-related assets. To generate the msi assets, run the Omnibus generator command with the `--msi-assets` flag:
+By default, Omnibus does not generate msi-related assets. To generate the msi assets, run the Omnibus new command with the `--msi-assets` flag:
 
-    $ omnibus generate NAME --msi-assets
+    $ omnibus new NAME --msi-assets
 
 **If this is an existing project, be sure to answer "NO" when asked if you want to overwrite existing files!**
 

data/lib/omnibus/config.rb

@@ -293,6 +293,19 @@ module Omnibus
     # @!endgroup
     #
 
+    #
+    # @!group Publisher
+    # --------------------------------------------------
+
+    # The number of times to try to publish an artifact
+    #
+    # @return [Integer]
+    default(:publish_retries, 2)
+
+    # --------------------------------------------------
+    # @!endgroup
+    #
+
     #
     # @!group Artifactory Publisher
     # --------------------------------------------------

data/lib/omnibus/core_extensions/open_uri.rb

@@ -55,4 +55,17 @@ module OpenURI
       end
     end
   end
+
+  #
+  # Force Kernel#open to always return a Tempfile. This works around the fact
+  # that the OpenURI-provided Kernel#open returns a StringIO OR a Tempfile
+  # instances depending on the size of the data being downloaded. In the case
+  # of Omnibus we always want a Tempfile.
+  #
+  # @see http://winstonyw.com/2013/10/02/openuris_open_tempfile_and_stringio/
+  #
+  class Buffer
+    remove_const :StringMax
+    StringMax = 0
+  end
 end

data/lib/omnibus/packagers/bff.rb

@@ -214,7 +214,7 @@ module Omnibus
         converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
 
         log.warn(log_key) do
-          "The `name' compontent of BFF package names can only include " \
+          "The `name' component of BFF package names can only include " \
           "lowercase alphabetical characters (a-z), numbers (0-9), dots (.), " \
           "plus signs (+), and dashes (-). Converting `#{project.package_name}' to " \
           "`#{converted}'."

data/lib/omnibus/packagers/deb.rb

@@ -323,14 +323,14 @@ module Omnibus
     # @return [String]
     #
     def safe_base_package_name
-      if project.package_name =~ /\A[a-zA-Z0-9\.\+\-]+\z/
+      if project.package_name =~ /\A[a-z0-9\.\+\-]+\z/
         project.package_name.dup
       else
-        converted = project.package_name.gsub(/[^a-zA-Z0-9\.\+\-]+/, '-')
+        converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
 
         log.warn(log_key) do
-          "The `name' compontent of Debian package names can only include " \
-          "alphabetical characters (a-z, A-Z), numbers (0-9), dots (.), " \
+          "The `name' component of Debian package names can only include " \
+          "lower case alphabetical characters (a-z), numbers (0-9), dots (.), " \
           "plus signs (+), and dashes (-). Converting `#{project.package_name}' to " \
           "`#{converted}'."
         end
@@ -340,7 +340,7 @@ module Omnibus
     end
 
     #
-    # This is actually just the regular build_iternation, but it felt lonely
+    # This is actually just the regular build_iteration, but it felt lonely
     # among all the other +safe_*+ methods.
     #
     # @return [String]
@@ -350,21 +350,38 @@ module Omnibus
     end
 
     #
-    # Return the Debian-ready version, converting any invalid characters to
-    # dashes (+-+).
+    # Return the Debian-ready version, replacing all dashes (+-+) with tildes
+    # (+~+) and converting any invalid characters to underscores (+_+).
     #
     # @return [String]
     #
     def safe_version
-      if project.build_version =~ /\A[a-zA-Z0-9\.\+\-\:]+\z/
-        project.build_version.dup
+      version = project.build_version.dup
+
+      if version =~ /\-/
+        converted = version.gsub('-', '~')
+
+        log.warn(log_key) do
+          "Dashes hold special significance in the Debian package versions. " \
+          "Versions that contain a dash and should be considered an earlier " \
+          "version (e.g. pre-releases) may actually be ordered as later " \
+          "(e.g. 12.0.0-rc.6 > 12.0.0). We'll work around this by replacing " \
+          "dashes (-) with tildes (~). Converting `#{project.build_version}' " \
+          "to `#{converted}'."
+        end
+
+        version = converted
+      end
+
+      if version =~ /\A[a-zA-Z0-9\.\+\:\~]+\z/
+        version
       else
-        converted = project.build_version.gsub(/[^a-zA-Z0-9\.\+\-\:]+/, '-')
+        converted = version.gsub(/[^a-zA-Z0-9\.\+\:\~]+/, '_')
 
         log.warn(log_key) do
-          "The `version' compontent of Debian package names can only include " \
+          "The `version' component of Debian package names can only include " \
           "alphabetical characters (a-z, A-Z), numbers (0-9), dots (.), " \
-          "plus signs (+), dashes (-), and colons (:). Converting " \
+          "plus signs (+), dashes (-), tildes (~) and colons (:). Converting " \
           "`#{project.build_version}' to `#{converted}'."
         end
 

data/lib/omnibus/packagers/pkg.rb

@@ -268,7 +268,7 @@ module Omnibus
         converted = project.package_name.downcase.gsub(/[^[:alnum:]+]/, '')
 
         log.warn(log_key) do
-          "The `name' compontent of Mac package names can only include " \
+          "The `name' component of Mac package names can only include " \
           "alphabetical characters (a-z, A-Z), and numbers (0-9). Converting " \
           "`#{project.package_name}' to `#{converted}'."
         end
@@ -314,7 +314,7 @@ module Omnibus
         converted = project.build_version.gsub(/[^a-zA-Z0-9\.\+\-]+/, '-')
 
         log.warn(log_key) do
-          "The `version' compontent of Mac package names can only include " \
+          "The `version' component of Mac package names can only include " \
           "alphabetical characters (a-z, A-Z), numbers (0-9), dots (.), " \
           "plus signs (+), and dashes (-). Converting " \
           "`#{project.build_version}' to `#{converted}'."

data/lib/omnibus/packagers/rpm.rb

@@ -240,6 +240,11 @@ module Omnibus
         hash
       end
 
+      # Exclude directories from the spec that are owned by the filesystem package:
+      # http://fedoraproject.org/wiki/Packaging:Guidelines#File_and_Directory_Ownership
+      filesystem_directories = IO.readlines(resource_path('filesystem_list'))
+      filesystem_directories.map! { |dirname| dirname.chomp }
+
       # Get a list of user-declared config files
       config_files = project.config_files.map { |file| rpm_safe(file) }
 
@@ -249,6 +254,7 @@ module Omnibus
                 .map    { |path| "/#{path}" }
                 .map    { |path| rpm_safe(path) }
                 .reject { |path| config_files.include?(path) }
+                .reject { |path| filesystem_directories.include?(path) }
 
       render_template(resource_path('spec.erb'),
         destination: spec_file,
@@ -400,7 +406,7 @@ module Omnibus
         converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
 
         log.warn(log_key) do
-          "The `name' compontent of RPM package names can only include " \
+          "The `name' component of RPM package names can only include " \
           "lowercase alphabetical characters (a-z), numbers (0-9), dots (.), " \
           "plus signs (+), and dashes (-). Converting `#{project.package_name}' to " \
           "`#{converted}'."
@@ -427,15 +433,37 @@ module Omnibus
     # @return [String]
     #
     def safe_version
-      if project.build_version =~ /\A[a-zA-Z0-9\.\+\_]+\z/
-        project.build_version.dup
+      version = project.build_version.dup
+
+      # RPM 4.10+ added support for using the tilde (~) as a way to mark
+      # versions as lower priority in comparisons. More details on this
+      # feature can be found here:
+      #
+      #   http://rpm.org/ticket/56
+      #
+      if version =~ /\-/
+        converted = version.gsub('-', '~')
+
+        log.warn(log_key) do
+          "Tildes hold special significance in the RPM package versions. " \
+          "They mark a version as lower priority in RPM's version compare " \
+          "logic. We'll replace all dashes (-) with tildes (~) so pre-release" \
+          "versions get sorted earlier then final versions. Converting" \
+          "`#{project.build_version}' to `#{converted}'."
+        end
+
+        version = converted
+      end
+
+      if version =~ /\A[a-zA-Z0-9\.\+\~]+\z/
+        version
       else
-        converted = project.build_version.gsub('-', '_')
+        converted = version.gsub(/[^a-zA-Z0-9\.\+\~]+/, '_')
 
         log.warn(log_key) do
           "The `version' component of RPM package names can only include " \
           "alphabetical characters (a-z, A-Z), numbers (0-9), dots (.), " \
-          "plus signs (+), and underscores (_). Converting " \
+          "plus signs (+), tildes (~) and underscores (_). Converting " \
           "`#{project.build_version}' to `#{converted}'."
         end
 

data/lib/omnibus/project.rb

@@ -481,9 +481,9 @@ module Omnibus
     #
     def override(name, val = NULL)
       if null?(val)
-        overrides[name]
+        overrides[name.to_sym]
       else
-        overrides[name] = val
+        overrides[name.to_sym] = val
       end
     end
     expose :override

data/lib/omnibus/publishers/artifactory_publisher.rb

@@ -15,6 +15,7 @@
 #
 
 require 'uri'
+require 'benchmark'
 
 module Omnibus
   class ArtifactoryPublisher < Publisher
@@ -29,11 +30,28 @@ module Omnibus
 
         # Upload the actual package
         log.info(log_key) { "Uploading '#{package.name}'" }
-        artifact_for(package).upload(
-          repository,
-          remote_path_for(package),
-          metadata_for(package),
-        )
+
+        retries = Config.publish_retries
+
+        begin
+          upload_time = Benchmark.realtime do
+            artifact_for(package).upload(
+              repository,
+              remote_path_for(package),
+              metadata_for(package),
+            )
+          end
+        rescue Artifactory::Error::HTTPError => e
+          if (retries -= 1) != 0
+            log.info(log_key) { "Upload failed with exception: #{e}"}
+            log.info(log_key) { "Retrying failed publish #{retries} more time(s)..." }
+            retry
+          else
+            raise e
+          end
+        end
+
+        log.debug(log_key)  { "Elapsed time to publish #{package.name}:  #{1000*upload_time} ms" }
 
         # If a block was given, "yield" the package to the caller
         block.call(package) if block