omnibus 4.0.0.beta.1 → 4.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec9872ce88998ffa0792cb936e9f81a5955c5f3
-  data.tar.gz: 114a41ab14dc94359e1efb6a8f1f6e375031438e
+  metadata.gz: f6839ae316c6146ee459f8acbd869d83d495d90c
+  data.tar.gz: 30a70eb80420dbab5e8196eb1a626b7b62c7b65f
 SHA512:
-  metadata.gz: e3cf0b1538b35bb9750427bab3c3779d1355c491e55ac889b81f4b970e85657c2053ec0a6872fd9318e82be70561b77cb354added176c59b6e3b11d536a1dc43
-  data.tar.gz: f551ee709ea94e53af2a6b0bc5e09c7e144a686eab51c692fdbc84f74e13b17bd588c4d2c8fc779ec9bf912784583919edadc09d2120f2f94e1554b4e504437f
+  metadata.gz: 4b8c99b56cd409f5b4df98dea2e19ade09fdeac89e42ee53a3724cf0a1c6440430d9994fd41b36aecd68c1c9239709bf578590b46ad1602f4fc2a6fbb21e3ba4
+  data.tar.gz: d07dbc0bcab759ecc4f6017d71e662cd07d81ff7919854fd790fe4ec476eacdf11f8eb8a8163d2005808d8618d947d791df6f62da8e620f5cf009647bef685f9

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 Omnibus CHANGELOG
 =================
 
+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)
 -------------------------------
 ### New Features

data/docs/Building on RHEL.md

@@ -19,6 +19,7 @@ The following Project values are taken into consideration when building RPMs:
 - `extra_package_files`
 - `iteration`
 - `maintainer`
+- `package_name`
 - `package_user`
 - `package_group`
 - `package_scripts_path`

data/lib/omnibus/builder.rb

@@ -261,6 +261,46 @@ module Omnibus
     end
     expose :bundle
 
+    #
+    # Execute the given appbundler command against the embedded Ruby's
+    # appbundler. This command assumes the +appbundle+ gem is installed and
+    # in the embedded Ruby. You should add a dependency on the +appbundler+
+    # software definition if you want to use this command.
+    #
+    # @example
+    #   appbundle 'chef'
+    #
+    # @param (see #command)
+    # @return (see #command)
+    #
+    def appbundle(app_name, options = {})
+      build_commands << BuildCommand.new("appbundle `#{app_name}'") do
+        bin_dir            = "#{install_dir}/bin"
+        embedded_apps_root = "#{install_dir}/embedded/apps"
+        embedded_app_dir   = "#{embedded_apps_root}/#{app_name}"
+        gemfile_lock       = "#{embedded_app_dir}/Gemfile.lock"
+        appbundler_bin     = windows_safe_path("#{install_dir}/embedded/bin/appbundler")
+
+        # Ensure the main bin dir exists
+        FileUtils.mkdir_p(bin_dir)
+        # Ensure the embedded app directory exists
+        FileUtils.mkdir_p(embedded_apps_root)
+        # Copy the application code into place
+        FileUtils.cp_r("#{Omnibus::Config.source_dir}/#{app_name}", embedded_apps_root)
+        # Delete any top-level `.git` directory
+        FileUtils.rm_rf("#{embedded_app_dir}/.git")
+
+        # Prepare the environment
+        options[:env] ||= {}
+        env = with_embedded_path || {}
+        env["BUNDLE_GEMFILE"] = gemfile_lock
+        options[:env].merge!(env)
+
+        shellout!("#{appbundler_bin} '#{embedded_app_dir}' '#{bin_dir}'", options)
+      end
+    end
+    expose :appbundle
+
     #
     # Execute the given Rake command against the embedded Ruby's rake. This
     # command assumes the +rake+ gem has been installed.
@@ -704,11 +744,17 @@ module Omnibus
     # which only removes Bundler-specific values. We need to remove all
     # values, specifically:
     #
+    # - _ORIGINAL_GEM_PATH
     # - GEM_PATH
     # - GEM_HOME
     # - GEM_ROOT
+    # - BUNDLE_BIN_PATH
     # - BUNDLE_GEMFILE
+    # - RUBYLIB
     # - RUBYOPT
+    # - RUBY_ENGINE
+    # - RUBY_ROOT
+    # - RUBY_VERSION
     #
     # The original environment restored at the end of this call.
     #
@@ -718,9 +764,10 @@ module Omnibus
     def with_clean_env(&block)
       original = ENV.to_hash
 
-      ENV.delete('RUBYOPT')
+      ENV.delete('_ORIGINAL_GEM_PATH')
       ENV.delete_if { |k,_| k.start_with?('BUNDLE_') }
       ENV.delete_if { |k,_| k.start_with?('GEM_') }
+      ENV.delete_if { |k,_| k.start_with?('RUBY') }
 
       block.call
     ensure

data/lib/omnibus/config.rb

@@ -466,6 +466,19 @@ module Omnibus
     # @!endgroup
     #
 
+    #
+    # @!group Fetcher Parameters
+    # --------------------------------------------------
+
+    # The number of seconds to wait
+    #
+    # @return [Integer]
+    default(:fetcher_read_timeout, 60)
+
+    # --------------------------------------------------
+    # @!endgroup
+    #
+
     private
 
     #

data/lib/omnibus/digestable.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'digest'
+require 'openssl'
 require 'pathname'
 
 module Omnibus
@@ -96,7 +96,7 @@ module Omnibus
     #
     def digest_from_type(type)
       id = type.to_s.upcase
-      instance = Digest.const_get(id).new
+      instance = OpenSSL::Digest.const_get(id).new
     end
 
     #

data/lib/omnibus/exceptions.rb

@@ -285,6 +285,27 @@ The following shell command timed out at #{timeout} seconds:
 Please increase the `:timeout' value or run the command manually to make sure it
 is completing successfully. Sometimes it is common for a command to wait for
 user input.
+EOH
+    end
+  end
+
+  class ProjectAlreadyDirty < Error
+    def initialize(project)
+      name = project.name
+      culprit = project.culprit.name
+
+      super <<-EOH
+The project `#{name}' was already marked as dirty by `#{culprit}'. You cannot
+mark a project as dirty twice. This is probably a bug in Omnibus and should be
+reported.
+EOH
+    end
+  end
+
+  class UnresolvableGitReference < Error
+    def initialize(ref)
+      super <<-EOH
+Could not resolve `#{ref}' to a valid git SHA-1.
 EOH
     end
   end

data/lib/omnibus/fetchers/git_fetcher.rb

@@ -146,15 +146,11 @@ module Omnibus
     # @return [String]
     #
     def target_revision
-      @target_revision ||= git("rev-parse #{version}").stdout.strip
-    rescue CommandFailed => e
-      if e.message.include?('ambiguous argument')
-        @target_revision = git("rev-parse origin/#{version}").stdout.strip
-        @target_revision
-      else
-        log.warn { 'Could not determine target revision!' }
-        nil
-      end
+      @target_revision ||= if sha_hash?(version)
+                             version
+                           else
+                             revision_from_remote_reference(version)
+                           end
     end
 
     #
@@ -166,6 +162,76 @@ module Omnibus
       current_revision == target_revision
     end
 
+    #
+    # Determine if the given revision is a SHA
+    #
+    # @return [true, false]
+    #
+    def sha_hash?(rev)
+      rev =~ /^[0-9a-f]{4,40}$/
+    end
+
+    #
+    # Return the SHA corresponding to ref. If ref is an annotated tag,
+    # return the SHA that was tagged not the SHA of the tag itself.
+    #
+    # @return [String]
+    #
+    def revision_from_remote_reference(ref)
+      # execute `git ls-remote` the trailing '*' does globbing. This
+      # allows us to return the SHA of the tagged commit for annotated
+      # tags. We take care to only return exact matches in
+      # process_remote_list.
+      remote_list = git("ls-remote origin #{ref}*").stdout
+      commit_ref = dereference_annotated_tag(remote_list, ref)
+
+      unless commit_ref
+        raise UnresolvableGitReference.new(ref)
+      end
+      commit_ref
+    end
+
+    #
+    # Dereference annotated tags.
+    #
+    # The +remote_list+ parameter is assumed to look like this:
+    #
+    #   a2ed66c01f42514bcab77fd628149eccb4ecee28        refs/tags/rel-0.11.0
+    #   f915286abdbc1907878376cce9222ac0b08b12b8        refs/tags/rel-0.11.0^{}
+    #
+    # The SHA with ^{} is the commit pointed to by an annotated
+    # tag. If ref isn't an annotated tag, there will not be a line
+    # with trailing ^{}.
+    #
+    # @param [String] remote_list
+    #   output from `git ls-remote origin` command
+    # @param [String] ref
+    #   the target git ref
+    #
+    # @return [String]
+    #
+    def dereference_annotated_tag(remote_list, ref)
+      # We'll return the SHA corresponding to the ^{} which is the
+      # commit pointed to by an annotated tag. If no such commit
+      # exists (not an annotated tag) then we return the SHA of the
+      # ref.  If nothing matches, return "".
+      lines = remote_list.split("\n")
+      matches = lines.map { |line| line.split("\t") }
+      # First try for ^{} indicating the commit pointed to by an
+      # annotated tag.
+      tagged_commit = matches.find { |m| m[1].end_with?("#{ref}^{}") }
+      if tagged_commit
+        tagged_commit.first
+      else
+        found = matches.find { |m| m[1].end_with?("#{ref}") }
+        if found
+          found.first
+        else
+          nil
+        end
+      end
+    end
+
     #
     # Execute the given git command, inside the +project_dir+.
     #

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -139,14 +139,16 @@ module Omnibus
     def download
       log.warn(log_key) { source[:warning] } if source.key?(:warning)
 
-      headers = download_headers
+      options = download_headers
 
       if source[:unsafe]
         log.warn(log_key) { "Permitting unsafe redirects!" }
-        headers[:allow_unsafe_redirects] = true
+        options[:allow_unsafe_redirects] = true
       end
 
-      file = open(download_url, headers)
+      options[:read_timeout] = Omnibus::Config.fetcher_read_timeout
+
+      file = open(download_url, options)
       FileUtils.cp(file.path, downloaded_file)
       file.close
     rescue SocketError,

data/lib/omnibus/generator.rb

@@ -50,11 +50,6 @@ module Omnibus
       type: :boolean,
       default: false
 
-    class_option :makeself_assets,
-      desc: 'Generate makeself assets',
-      type: :boolean,
-      default: false
-
     class_option :msi_assets,
       desc: 'Generate Windows MSI assets',
       type: :boolean,
@@ -112,8 +107,6 @@ module Omnibus
       return unless options[:bff_assets]
 
       copy_file(resource_path('bff/gen.template.erb'), "#{target}/resources/bff/gen.template.erb")
-      copy_file(resource_path('bff/postinstall.sh'), "#{target}/resources/bff/postinstall.sh")
-      copy_file(resource_path('bff/unpostinstall.sh'), "#{target}/resources/bff/unpostinstall.sh")
     end
 
     def create_deb_assets
@@ -131,12 +124,6 @@ module Omnibus
       copy_file(resource_path('dmg/icon.png'), "#{target}/resources/dmg/icon.png")
     end
 
-    def create_makeself_assets
-      return unless options[:makeself_assets]
-
-      copy_file(resource_path('makeself/post_extract.sh.erb'), "#{target}/resources/makeself/post_extract.sh.erb")
-    end
-
     def create_msi_assets
       return unless options[:msi_assets]
 

data/lib/omnibus/packagers/base.rb

@@ -105,6 +105,30 @@ module Omnibus
       )
     end
 
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # Retrieve the path at which the project will be installed by the
+    # generated package.
+    #
+    # @return [String]
+    #
+    def install_dir
+      project.install_dir
+    end
+    expose :install_dir
+
+    #
+    # (see Util#windows_safe_path)
+    #
+    expose :windows_safe_path
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
     #
     # Execute this packager by running the following phases in order:
     #
@@ -149,7 +173,7 @@ module Omnibus
     # @return [String]
     #
     def staging_dir
-      @staging_dir ||= Dir.mktmpdir(project.name)
+      @staging_dir ||= Dir.mktmpdir(project.package_name)
     end
 
     #

data/lib/omnibus/packagers/bff.rb

@@ -16,6 +16,15 @@
 
 module Omnibus
   class Packager::BFF < Packager::Base
+    # @return [Hash]
+    SCRIPT_MAP = {
+      # Default Omnibus naming
+      preinst:  'Pre-installation Script',
+      postinst: 'Post-installation Script',
+      prerm:    'Pre_rm Script',
+      postrm:   'Unconfiguration Script',
+    }.freeze
+
     id :bff
 
     setup do
@@ -25,6 +34,9 @@ module Omnibus
       # /opt/hamlet => /tmp/daj29013/opt/hamlet
       destination = File.join(staging_dir, project.install_dir)
       FileSyncer.sync(project.install_dir, destination, exclude: exclusions)
+
+      # Create the scripts staging directory
+      create_directory(scripts_staging_dir)
     end
 
     build do
@@ -37,7 +49,42 @@ module Omnibus
 
     # @see Base#package_name
     def package_name
-      "#{project.name}.#{bff_version}.#{safe_architecture}.bff"
+      "#{safe_base_package_name}.#{bff_version}.#{safe_architecture}.bff"
+    end
+
+    #
+    # The path where the package scripts in the install directory.
+    #
+    # @return [String]
+    #
+    def scripts_install_dir
+      File.expand_path("#{project.install_dir}/embedded/share/installp")
+    end
+
+    #
+    # The path where the package scripts will staged.
+    #
+    # @return [String]
+    #
+    def scripts_staging_dir
+      File.expand_path("#{staging_dir}#{scripts_install_dir}")
+    end
+
+    #
+    # Copy all scripts in {Project#package_scripts_path} to the package
+    # directory.
+    #
+    # @return [void]
+    #
+    def write_scripts
+      SCRIPT_MAP.each do |script, _installp_name|
+        source_path = File.join(project.package_scripts_path, script.to_s)
+
+        if File.file?(source_path)
+          log.debug(log_key) { "Adding script `#{script}' to `#{scripts_staging_dir}'" }
+          copy_file(source_path, scripts_staging_dir)
+        end
+      end
     end
 
     #
@@ -45,7 +92,50 @@ module Omnibus
     #
     # @return [void]
     #
+    # Some details on the various lifecycle scripts:
+    #
+    # The order of the installp scripts is:
+    # - install
+    #   - pre-install
+    #   - post-install
+    #   - config
+    # - upgrade
+    #   - pre-remove (of previous version)
+    #   - pre-install (previous version of software not present anymore)
+    #   - post-install
+    #   - config
+    # - remove
+    #   - unconfig
+    #   - unpre-install
+    #
+    # To run the new version of scc, the post-install will do.
+    # To run the previous version with an upgrade, use the pre-remove script.
+    # To run a source install of scc upon installation of installp package, use the pre-install.
+    # Upon upgrade, both the pre-remove and the pre-install scripts will run.
+    # As scc has been removed between the runs of these scripts, it will only run once during upgrade.
+    #
+    # Keywords for scripts:
+    #
+    #   Pre-installation Script: /path/script
+    #   Unpre-installation Script: /path/script
+    #   Post-installation Script: /path/script
+    #   Pre_rm Script: /path/script
+    #   Configuration Script: /path/script
+    #   Unconfiguration Script: /path/script
+    #
     def write_gen_template
+      # Create a map of scripts that exist and install path
+      scripts = SCRIPT_MAP.inject({}) do |hash, (script, installp_key)|
+        staging_path =  File.join(scripts_staging_dir, script.to_s)
+        install_path =  File.join(scripts_install_dir, script.to_s)
+
+        if File.file?(staging_path)
+          hash[installp_key] = install_path
+        end
+
+        hash
+      end
+
       # Get a list of all files
       files = FileSyncer.glob("#{staging_dir}/**/*")
                 .map { |path| path.gsub(/^#{staging_dir}/, '') }
@@ -53,16 +143,13 @@ module Omnibus
       render_template(resource_path('gen.template.erb'),
         destination: File.join(staging_dir, 'gen.template'),
         variables: {
-          name:           safe_project_name,
+          name:           safe_base_package_name,
           install_dir:    project.install_dir,
           friendly_name:  project.friendly_name,
           version:        bff_version,
           description:    project.description,
           files:          files,
-
-          # Add configuration files
-          configuration_script: resource_path('postinstall.sh'),
-          unconfiguration_script: resource_path('unpostinstall.sh'),
+          scripts:        scripts,
         }
       )
     end
@@ -87,21 +174,21 @@ module Omnibus
     end
 
     #
-    # Return the BFF-ready project name, converting any invalid characters to
+    # Return the BFF-ready base package name, converting any invalid characters to
     # dashes (+-+).
     #
     # @return [String]
     #
-    def safe_project_name
-      if project.name =~ /\A[a-z0-9\.\+\-]+\z/
-        project.name.dup
+    def safe_base_package_name
+      if project.package_name =~ /\A[a-z0-9\.\+\-]+\z/
+        project.package_name.dup
       else
-        converted = project.name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
+        converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
 
         log.warn(log_key) do
           "The `name' compontent of BFF package names can only include " \
           "lowercase alphabetical characters (a-z), numbers (0-9), dots (.), " \
-          "plus signs (+), and dashes (-). Converting `#{project.name}' to " \
+          "plus signs (+), and dashes (-). Converting `#{project.package_name}' to " \
           "`#{converted}'."
         end