omnibus 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a17a0e151fcd48e38827a9504daafcbdeb58abe5
-  data.tar.gz: 599d4ab2fb191028721c42fb912d836a05ef6e69
+  metadata.gz: 407d08f9b06a939ef258ff8c14f27b12afb74234
+  data.tar.gz: 84d25b4c5c73eede7828af010d99273771f2d547
 SHA512:
-  metadata.gz: 829c377378e984fabdbc83f3e23e7f092a25c8dda2823391fa7c4198a873529c8f8750367abeca0b908ad9c3b6073633a4308aa90814cb0e114fe6a2d6a0b39f
-  data.tar.gz: 6262ddf08f75fc3d49735e2f223a63c0eced1bf6050ab912f9a79113589c4dfd69ccc30abcc97f4c5caca60609435dabd861d09f0a6b88dd4ae61b586de77c32
+  metadata.gz: fecc2417ce2c9137d12a2675e52105e9f2b263e8953a1f264582c15204614fd8de7cb62792c9e6d9b46a18b69ce707973f275ce46490703eabbea4ee7c0e5b0f
+  data.tar.gz: b7d07fb926de84af9f2bb56b526bca9594a634c0b20a92e4b88d5daf206f595035ddf06bbe138c61b5a361f44b071bfb867f0ac2ce57dfee1336585cbf6b11fb

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 Omnibus CHANGELOG
 =================
 
+v5.4.0 (April 18, 2016)
+-----------------------
+### New Features
+- Include license and version manifest in generated `*.metadata.json` (#656)
+- Deprecate the `--version-manifest` on `omnibus publish` (#656)
+- Create Solaris IPS package (#654)
+- Use symbolized keys for all Manifest hashes (#657)
+- Publish a package’s `*.metadata.json` to Artifactory (#664)
+- Add the build’s `LICENSE` content to `*.metadata.json` (#664)
+
+### Bug Fixes
+- Add proper support for loading v2 manifests (#657)
+- Replacing the use of JSON gem with FFI_yajl (#661)
+
 v5.3.0 (March 25, 2016)
 -----------------------
 ### New Features

data/features/commands/manifest.feature

@@ -18,6 +18,7 @@ Feature: omnibus manifest
     And  the output should contain:
          """
            "software": {
+
            },
          """
 

data/features/commands/publish.feature

@@ -6,3 +6,10 @@ Feature: omnibus publish
       """
       Publishing will be performed using provided platform mappings.
       """
+
+  Scenario: When a user provides the deprecated `--version-manifest` flag
+    * I run `omnibus publish artifactory fake * --version-manifest /fake/path/version-manifest.json`
+    * the output should contain:
+      """
+      The `--version-manifest' option has been deprecated. Version manifest data is now part of the `*.metadata.json' file
+      """

data/lib/omnibus.rb

@@ -18,7 +18,6 @@ require 'omnibus/core_extensions'
 
 require 'cleanroom'
 require 'pathname'
-require 'json'
 
 require 'omnibus/exceptions'
 require 'omnibus/version'

data/lib/omnibus/cli.rb

@@ -16,6 +16,7 @@
 
 require 'thor'
 require 'omnibus'
+require "ffi_yajl"
 
 module Omnibus
   class CLI < Command::Base
@@ -85,7 +86,7 @@ module Omnibus
       if @options[:output_manifest]
         FileUtils.mkdir_p('pkg')
         File.open(::File.join('pkg', 'version-manifest.json'), 'w') do |f|
-          f.write(project.built_manifest.to_json)
+          f.write(FFI_Yajl::Encoder.encode(project.built_manifest.to_hash))
         end
       end
     end
@@ -121,7 +122,7 @@ module Omnibus
       Ohai['platform'] = @options[:platform] if @options[:platform]
       Ohai['platform_version'] = @options[:platform_version] if @options[:platform_version]
       Ohai['kernel']['machine'] = @options[:architecture] if @options[:architecture]
-      puts JSON.pretty_generate(Project.load(name).built_manifest.to_hash)
+      puts FFI_Yajl::Encoder.encode(Project.load(name).built_manifest.to_hash, pretty: true)
     end
 
     #

data/lib/omnibus/cli/changelog.rb

@@ -18,6 +18,7 @@ require 'omnibus/changelog'
 require 'omnibus/changelog_printer'
 require 'omnibus/manifest_diff'
 require 'omnibus/semantic_version'
+require 'ffi_yajl'
 
 module Omnibus
   class Command::ChangeLog < Command::Base
@@ -104,7 +105,7 @@ module Omnibus
     end
 
     def manifest_for_revision(rev)
-      Omnibus::Manifest.from_hash(JSON.parse(local_git_repo.file_at_revision("version-manifest.json", rev)))
+      Omnibus::Manifest.from_hash(FFI_Yajl::Parser.parse(local_git_repo.file_at_revision("version-manifest.json", rev)))
     end
 
 

data/lib/omnibus/cli/publish.rb

@@ -76,6 +76,11 @@ module Omnibus
       default: {}
     desc 'artifactory REPOSITORY PATTERN', 'Publish to an Artifactory instance'
     def artifactory(repository, pattern)
+
+      Omnibus.logger.deprecated('ArtifactoryPublisher') do
+        "The `--version-manifest' option has been deprecated. Version manifest data is now part of the `*.metadata.json' file"
+      end if options[:version_manifest]
+
       options[:repository] = repository
       publish(ArtifactoryPublisher, pattern, options)
     end
@@ -89,7 +94,7 @@ module Omnibus
     #
     def publish(klass, pattern, options)
       if options[:platform_mappings]
-        options[:platform_mappings] = JSON.parse(File.read(File.expand_path(options[:platform_mappings])))
+        options[:platform_mappings] = FFI_Yajl::Parser.parse(File.read(File.expand_path(options[:platform_mappings])))
       end
 
       klass.publish(pattern, options) do |package|

data/lib/omnibus/manifest.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'json'
+require 'ffi_yajl'
 
 module Omnibus
   class Manifest
@@ -35,8 +35,9 @@ module Omnibus
     end
 
     def entry_for(name)
-      if @data.key?(name)
-        @data[name]
+      name_sym = name.to_sym
+      if @data.key?(name_sym)
+        @data[name_sym]
       else
         raise MissingManifestEntry, "No manifest entry found for #{name}"
       end
@@ -47,11 +48,12 @@ module Omnibus
         raise NotAManifestEntry, "#{entry} is not an Omnibus:ManifestEntry"
       end
 
-      if @data.key?(name)
+      name_sym = name.to_sym
+      if @data.key?(name_sym)
         log.warn(log_key) { "Overritting existing manifest entry for #{name}" }
       end
 
-      @data[name] = entry
+      @data[name_sym] = entry
       self
     end
 
@@ -71,12 +73,12 @@ module Omnibus
         memo
       end
       ret = {
-        'manifest_format' => LATEST_MANIFEST_FORMAT,
-        'software' => software_hash
+        manifest_format: LATEST_MANIFEST_FORMAT,
+        software: software_hash
       }
-      ret['build_version'] = build_version if build_version
-      ret['build_git_revision'] = build_git_revision if build_git_revision
-      ret['license'] = license
+      ret[:build_version] = build_version if build_version
+      ret[:build_git_revision] = build_git_revision if build_git_revision
+      ret[:license] = license
       ret
     end
 
@@ -86,7 +88,7 @@ module Omnibus
     # @return [String]
     #
     def to_json
-      JSON.pretty_generate(to_hash)
+      FFI_Yajl::Encoder.encode(to_hash, pretty: true)
     end
 
     #
@@ -94,24 +96,36 @@ module Omnibus
     #
 
     def self.from_hash(manifest_data)
-      case manifest_data['manifest_format'].to_i
+      case manifest_data[:manifest_format].to_i
       when 1
         from_hash_v1(manifest_data)
+      when 2
+        from_hash_v2(manifest_data)
       else
-        raise InvalidManifestFormat, "Unknown manifest format version: #{manifest_data['manifest_format']}"
+        raise InvalidManifestFormat, "Unknown manifest format version: #{manifest_data[:manifest_format]}"
       end
     end
 
     def self.from_hash_v1(manifest_data)
-      m = Omnibus::Manifest.new(manifest_data['build_version'], manifest_data['build_git_revision'])
-      manifest_data['software'].each do |name, entry_data|
+      m = Omnibus::Manifest.new(manifest_data[:build_version], manifest_data[:build_git_revision])
+      manifest_data[:software].each do |name, entry_data|
+        m.add(name, Omnibus::ManifestEntry.new(name, keys_to_syms(entry_data)))
+      end
+      m
+    end
+
+    def self.from_hash_v2(manifest_data)
+      m = Omnibus::Manifest.new(manifest_data[:build_version], manifest_data[:build_git_revision], manifest_data[:license])
+      manifest_data[:software].each do |name, entry_data|
         m.add(name, Omnibus::ManifestEntry.new(name, keys_to_syms(entry_data)))
       end
       m
     end
 
     def self.from_file(filename)
-      from_hash(JSON.parse(File.read(File.expand_path(filename))))
+      data = File.read(File.expand_path(filename))
+      hash = FFI_Yajl::Parser.parse(data, symbolize_names: true)
+      from_hash(hash)
     end
 
     private

data/lib/omnibus/manifest_entry.rb

@@ -28,11 +28,11 @@ module Omnibus
 
     def to_hash
       {
-        "locked_version" => @locked_version,
-        "locked_source" => @locked_source,
-        "source_type" => @source_type,
-        "described_version" => @described_version,
-        "license" => @license
+        locked_version: @locked_version,
+        locked_source: @locked_source,
+        source_type: @source_type,
+        described_version: @described_version,
+        license: @license
       }
     end
 

data/lib/omnibus/metadata.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'json'
+require 'ffi_yajl'
 
 module Omnibus
   class Metadata
@@ -61,6 +61,9 @@ module Omnibus
           homepage:         project.homepage,
           version:          project.build_version,
           iteration:        project.build_iteration,
+          license:          project.license,
+          version_manifest: project.built_manifest.to_hash,
+          license_content:  File.exist?(project.license_file_path) ? File.read(project.license_file_path) : ''
         }
 
         instance = new(package, data)
@@ -78,7 +81,7 @@ module Omnibus
       #
       def for_package(package)
         data = File.read(path_for(package))
-        hash = JSON.parse(data, symbolize_names: true)
+        hash = FFI_Yajl::Parser.parse(data, symbolize_names: true)
 
          # Ensure Platform version has been truncated
          if hash[:platform_version] && hash[:platform]
@@ -265,7 +268,7 @@ module Omnibus
     #
     def save
       File.open(path, 'w+')  do |f|
-        f.write(to_json)
+        f.write(FFI_Yajl::Encoder.encode(to_hash, pretty: true))
       end
 
       true
@@ -286,7 +289,7 @@ module Omnibus
     # @return [String]
     #
     def to_json
-      JSON.pretty_generate(@data)
+      FFI_Yajl::Encoder.encode(@data, pretty: true)
     end
   end
 end

data/lib/omnibus/package.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'json'
+require 'ffi_yajl'
 
 module Omnibus
   class Package
@@ -95,7 +95,7 @@ module Omnibus
     # The parsed contents of the metadata.
     #
     # @raise [NoPackageMetadataFile] if the {#metadata} does not exist
-    # @raise [JSON::ParserError] if the JSON is not valid
+    # @raise [FFI_Yajl::ParseError] if the JSON is not valid
     #
     # @return [Hash<Symbol, String>]
     #

data/lib/omnibus/packager.rb

@@ -17,6 +17,7 @@
 module Omnibus
   module Packager
     include Logging
+    include Sugarable
 
     autoload :Base,     'omnibus/packagers/base'
     autoload :BFF,      'omnibus/packagers/bff'
@@ -25,6 +26,7 @@ module Omnibus
     autoload :MSI,      'omnibus/packagers/msi'
     autoload :PKG,      'omnibus/packagers/pkg'
     autoload :Solaris,  'omnibus/packagers/solaris'
+    autoload :IPS,      'omnibus/packagers/ips'
     autoload :RPM,      'omnibus/packagers/rpm'
 
     #
@@ -40,7 +42,8 @@ module Omnibus
       'rhel'     => RPM,
       'wrlinux'  => RPM,
       'aix'      => BFF,
-      'solaris2' => Solaris,
+      'solaris'  => Solaris,
+      'ips'      => IPS,
       'windows'  => MSI,
       'mac_os_x' => PKG,
     }.freeze
@@ -56,7 +59,13 @@ module Omnibus
     #
     def for_current_system
       family = Ohai['platform_family']
+      version = Ohai['platform_version']
 
+      if family == 'solaris2' && Chef::Sugar::Constraints::Version.new(version).satisfies?('>= 5.11')
+        family = "ips"
+      elsif family == 'solaris2' && Chef::Sugar::Constraints::Version.new(version).satisfies?('>= 5.10')
+        family = "solaris"
+      end
       if klass = PLATFORM_PACKAGER_MAP[family]
         klass
       else
@@ -64,7 +73,6 @@ module Omnibus
           "Could not determine packager for `#{family}', defaulting " \
           "to `makeself'!"
         end
-
         Makeself
       end
     end

data/lib/omnibus/packagers/ips.rb

@@ -0,0 +1,301 @@
+#
+# Copyright 2016 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 Packager::IPS < Packager::Base
+    id :ips
+
+    setup do
+      create_directory(source_dir)
+      # Copy the full-stack installer into our scratch directory, accounting for
+      # any excluded files.
+      #
+      # /opt/hamlet => /tmp/daj29013/proto_install/opt/hamlet
+      # Create the proto_install directory inside staging_dir
+      destination = File.join(source_dir, project.install_dir)
+      FileSyncer.sync(project.install_dir, destination, exclude: exclusions)
+      write_transform_file
+    end
+
+    build do
+      #
+      # Package manifest generation is divided into the following stages:
+      #
+      write_pkg_metadata
+      generate_pkg_contents
+      generate_pkg_deps
+      validate_pkg_manifest
+
+      #
+      # To create an IPS package we need to generate a repo, publish our
+      # package into said repo. Finally, we export a portable `*.p5p`
+      # file from this repo.
+      #
+      create_ips_repo
+      publish_ips_pkg
+      export_pkg_archive_file
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # The publisher prefix for the IPS package.
+    #
+    # @example
+    #   identifier 'Chef'
+    #
+    # @param [String] val
+    #   the package identifier
+    #
+    # @return [String]
+    #
+    def publisher_prefix(val = NULL)
+      if null?(val)
+        @publisher_prefix || 'Omnibus'
+      else
+        @publisher_prefix = val
+      end
+    end
+    expose :publisher_prefix
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    #
+    # @see Base#package_name
+    #
+    def package_name
+      "#{safe_base_package_name}.p5p"
+    end
+
+    #
+    # For more info about fmri see:
+    #
+    #   http://docs.oracle.com/cd/E23824_01/html/E21796/pkg-5.html
+    #
+    def fmri_package_name
+      version = project.build_version.split(/[^\d]/)[0..2].join('.')
+      platform =  Ohai['platform_version']
+      "#{safe_base_package_name}@#{version},#{platform}-#{project.build_iteration}"
+    end
+
+    #
+    # The full path to the transform file on disk.
+    #
+    # @return [String]
+    #
+    def transform_file
+      @transform_file ||= File.join(staging_dir, 'doc-transform')
+    end
+
+    #
+    # The full path to the pkg metadata file on disk.
+    #
+    # @return [String]
+    #
+    def pkg_metadata_file
+      @pkg_metadata_file ||= File.join(staging_dir, 'gen.manifestfile')
+    end
+
+    #
+    # The full path to the pkg manifest file on disk.
+    #
+    # @return [String]
+    #
+    def pkg_manifest_file
+      @pkg_manifest_file ||= File.join(staging_dir, "#{safe_base_package_name}.p5m")
+    end
+
+    #
+    # The path to the +publish/repo+ directory inside the staging directory.
+    #
+    # @return [String]
+    #
+    def repo_dir
+      @repo_dir ||= File.join(staging_dir, 'publish', 'repo')
+    end
+
+    #
+    # The path to the +proto-install+ directory inside the staging directory.
+    #
+    # @return [String]
+    #
+    def source_dir
+      @source_dir ||= File.join(staging_dir, 'proto_install')
+    end
+
+    #
+    # Return the IPS-ready base package name, converting any invalid characters to
+    # dashes (+-+).
+    #
+    # @return [String]
+    #
+    def safe_base_package_name
+      if project.package_name =~ /\A[a-z0-9\.\+\-]+\z/
+        project.package_name.dup
+      else
+        converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
+
+        log.warn(log_key) do
+          "The `name' component of IPS package names can only include " \
+          "lowercase alphabetical characters (a-z), numbers (0-9), dots (.), " \
+          "plus signs (+), and dashes (-). Converting `#{project.package_name}' to " \
+          "`#{converted}'."
+        end
+        converted
+      end
+    end
+
+    #
+    # The architecture for this IPS package.
+    #
+    # @return [String]
+    #
+    def safe_architecture
+      if intel?
+        'i386'
+      elsif sparc?
+        'sparc'
+      else
+        Ohai['kernel']['machine']
+      end
+    end
+
+    #
+    # A set of transform rules that `pkgmogrify' will apply to the package
+    # manifest.
+    #
+    # @return [void]
+    #
+    def write_transform_file
+      render_template(resource_path('doc-transform.erb'),
+        destination: transform_file,
+        variables: {
+          pathdir: project.install_dir.split('/')[1],
+        }
+      )
+    end
+
+    #
+    # Generate package metadata
+    #
+    # Create the gen template for `pkgmogrify`
+    #
+    # @return [void]
+    #
+    def write_pkg_metadata
+      render_template(resource_path('gen.manifestfile.erb'),
+        destination: pkg_metadata_file,
+        variables: {
+          name:              safe_base_package_name,
+          fmri_package_name: fmri_package_name,
+          description:       project.description,
+          summary:           project.friendly_name,
+          arch:              safe_architecture,
+        }
+      )
+
+      # Print the full contents of the rendered template file to generate package contents
+      log.debug(log_key) { "Rendered Template:\n" + File.read(pkg_metadata_file) }
+    end
+
+    #
+    # Create the package contents using `pkgsend` and `pkgfmt`
+    #
+    # @return [void]
+    #
+    def generate_pkg_contents
+      shellout!("pkgsend generate #{source_dir} | pkgfmt > #{pkg_manifest_file}.1")
+      shellout!("pkgmogrify -DARCH=`uname -p` #{pkg_manifest_file}.1 #{pkg_metadata_file} #{transform_file} | pkgfmt > #{pkg_manifest_file}.2")
+    end
+
+    #
+    # Generate the package deps
+    #
+    # @return [void]
+    #
+    def generate_pkg_deps
+      shellout!("pkgdepend generate -md #{source_dir} #{pkg_manifest_file}.2 | pkgfmt > #{pkg_manifest_file}.3")
+      shellout!("pkgmogrify -DARCH=`uname -p` #{pkg_manifest_file}.3 #{transform_file} | pkgfmt > #{pkg_manifest_file}.4")
+      shellout!("pkgdepend resolve -m #{pkg_manifest_file}.4")
+    end
+
+    #
+    # Validate the generated package manifest using `pkglint`
+    #
+    # @return [void]
+    #
+    def validate_pkg_manifest
+      log.info(log_key) { "Validating package manifest" }
+      shellout!("pkglint -c /tmp/lint-cache -r http://pkg.oracle.com/solaris/release #{pkg_manifest_file}.4.res")
+    end
+
+    #
+    # Create a local IPS repo for publishing
+    #
+    # @return [void]
+    #
+    def create_ips_repo
+      shellout!("pkgrepo create #{repo_dir}")
+      log.info(log_key) { "Created IPS repo: #{repo_dir}" }
+    end
+
+    #
+    # Publish the IPS pkg into the local IPS repo
+    #
+    # @return [void]
+    #
+    def publish_ips_pkg
+      shellout!("pkgrepo -s #{repo_dir} set publisher/prefix=#{publisher_prefix}")
+      shellout!("pkgsend publish -s #{repo_dir} -d #{source_dir} #{pkg_manifest_file}.4.res")
+      log.info(log_key) { "Published IPS package to repo: #{repo_dir}"}
+
+      repo_info = shellout("pkg list -afv -g #{repo_dir}").stdout
+      log.debug(log_key) do
+        <<-EOH.strip
+          Published IPS package:
+
+            #{repo_info}
+        EOH
+      end
+    end
+
+    #
+    # Convert a the published IPS pkg from the local repo into the more
+    # easily distributable `*.p5p` archive.
+    #
+    # @return [void]
+    #
+    def export_pkg_archive_file
+      # The destination file cannot already exist
+      File.delete(package_path) if File.exist?(package_path)
+      shellout!("pkgrecv -s #{repo_dir} -a -d #{package_path} #{safe_base_package_name}")
+      log.info(log_key) { "Exported IPS package archive: #{package_path}"}
+
+      list_pkgarchive = shellout("pkgrepo list -s #{package_path} '*@latest'").stdout
+      log.debug(log_key) do
+        <<-EOH.strip
+          IPS package archive contents:
+
+            #{list_pkgarchive}
+        EOH
+      end
+    end
+  end
+end