omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/packagers/pkg.rb

@@ -0,0 +1,278 @@
+#
+# 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 Packager::PKG < Packager::Base
+    id :pkg
+
+    setup do
+      # Create the resources directory
+      create_directory(resources_dir)
+
+      # Render the license
+      render_template(resource_path('license.html.erb'),
+        destination: "#{resources_dir}/license.html",
+        variables: {
+          name:          project.name,
+          friendly_name: project.friendly_name,
+          maintainer:    project.maintainer,
+        }
+      )
+
+      # Render the welcome template
+      render_template(resource_path('welcome.html.erb'),
+        destination: "#{resources_dir}/welcome.html",
+        variables: {
+          name:          project.name,
+          friendly_name: project.friendly_name,
+          maintainer:    project.maintainer,
+        }
+      )
+
+      # "Render" the assets
+      copy_file(resource_path('background.png'), "#{resources_dir}/background.png")
+    end
+
+    build do
+      build_component_pkg
+
+      write_distribution_file
+
+      build_product_pkg
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # The identifer for the PKG package.
+    #
+    # @example
+    #   identifier 'com.getchef.chefdk'
+    #
+    # @param [String] val
+    #   the package identifier
+    #
+    # @return [String]
+    #
+    def identifier(val = NULL)
+      if null?(val)
+        @identifier
+      else
+        @identifier = val
+      end
+    end
+    expose :identifier
+
+    #
+    # Set or return the signing identity. If this value is provided, Omnibus
+    # will attempt to sign the PKG.
+    #
+    # @example
+    #   signing_identity "foo"
+    #
+    # @param [String] val
+    #   the identity to use when signing the PKG
+    #
+    # @return [String]
+    #   the PKG-signing identity
+    #
+    def signing_identity(val = NULL)
+      if null?(val)
+        @signing_identity
+      else
+        @signing_identity = val
+      end
+    end
+    expose :signing_identity
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    # @see Base#package_name
+    def package_name
+      "#{safe_project_name}-#{safe_version}-#{safe_build_iteration}.pkg"
+    end
+
+    #
+    # The full path where the product package was/will be written.
+    #
+    # @return [String]
+    #
+    def final_pkg
+      File.expand_path("#{Config.package_dir}/#{package_name}")
+    end
+
+    #
+    # The path where the product package resources will live. We cannot store
+    # resources in the top-level staging dir, because +productbuild+'s
+    # +--resources+ flag expects a directory that does not contain the parent
+    # package.
+    #
+    # @return [String]
+    #
+    def resources_dir
+      File.expand_path("#{staging_dir}/Resources")
+    end
+
+    #
+    # Construct the intermediate build product. It can be installed with the
+    # Installer.app, but doesn't contain the data needed to customize the
+    # installer UI.
+    #
+    # @return [void]
+    #
+    def build_component_pkg
+      command = <<-EOH.gsub(/^ {8}/, '')
+        pkgbuild \\
+          --identifier "#{safe_identifier}" \\
+          --version "#{safe_version}" \\
+          --scripts "#{project.package_scripts_path}" \\
+          --root "#{project.install_dir}" \\
+          --install-location "#{project.install_dir}" \\
+          "#{component_pkg}"
+      EOH
+
+      Dir.chdir(staging_dir) do
+        shellout!(command)
+      end
+    end
+
+    #
+    # Write the Distribution file to the staging area. This method generates the
+    # content of the Distribution file, which is used by +productbuild+ to
+    # select the component packages to include in the product package.
+    #
+    # It also includes information used to customize the UI of the Mac OS X
+    # installer.
+    #
+    # @return [void]
+    #
+    def write_distribution_file
+      render_template(resource_path('distribution.xml.erb'),
+        destination: "#{staging_dir}/Distribution",
+        mode: 0600,
+        variables: {
+          friendly_name: project.friendly_name,
+          identifier:    safe_identifier,
+          version:       safe_version,
+          component_pkg: component_pkg,
+        }
+      )
+    end
+
+    #
+    # Construct the product package. The generated package is the final build
+    # product that is shipped to end users.
+    #
+    # @return [void]
+    #
+    def build_product_pkg
+      command = <<-EOH.gsub(/^ {8}/, '')
+        productbuild \\
+          --distribution "#{staging_dir}/Distribution" \\
+          --resources "#{resources_dir}" \\
+      EOH
+
+      command << %Q(  --sign "#{signing_identity}" \\\n) if signing_identity
+      command << %Q(  "#{final_pkg}")
+      command << %Q(\n)
+
+      Dir.chdir(staging_dir) do
+        shellout!(command)
+      end
+    end
+
+    #
+    # The name of the (only) component package.
+    #
+    # @return [String] the filename of the component .pkg file to create.
+    #
+    def component_pkg
+      "#{safe_project_name}-core.pkg"
+    end
+
+    #
+    # Return the PKG-ready project name, removing any invalid characters.
+    #
+    # @return [String]
+    #
+    def safe_project_name
+      if project.name =~ /\A[[:alnum:]]+\z/
+        project.name.dup
+      else
+        converted = project.name.downcase.gsub(/[^[:alnum:]+]/, '')
+
+        log.warn(log_key) do
+          "The `name' compontent of Mac package names can only include " \
+          "alphabetical characters (a-z, A-Z), and numbers (0-9). Converting " \
+          "`#{project.name}' to `#{converted}'."
+        end
+
+        converted
+      end
+    end
+
+    #
+    # The identifier for this mac package (the com.whatever.thing.whatever).
+    # This is a configurable project value, but a default value is calculated if
+    # one is not given.
+    #
+    # @return [String]
+    #
+    def safe_identifier
+      return identifier if identifier
+
+      maintainer = project.maintainer.gsub(/[^[:alnum:]+]/, '').downcase
+      "test.#{maintainer}.pkg.#{safe_project_name}"
+    end
+
+    #
+    # This is actually just the regular build_iternation, but it felt lonely
+    # among all the other +safe_*+ methods.
+    #
+    # @return [String]
+    #
+    def safe_build_iteration
+      project.build_iteration
+    end
+
+    #
+    # Return the PKG-ready version, converting any invalid characters to
+    # dashes (+-+).
+    #
+    # @return [String]
+    #
+    def safe_version
+      if project.build_version =~ /\A[a-zA-Z0-9\.\+\-]+\z/
+        project.build_version.dup
+      else
+        converted = project.build_version.gsub(/[^a-zA-Z0-9\.\+\-]+/, '-')
+
+        log.warn(log_key) do
+          "The `version' compontent 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}'."
+        end
+
+        converted
+      end
+    end
+  end
+end

data/lib/omnibus/packagers/rpm.rb

@@ -0,0 +1,438 @@
+#
+# 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.
+#
+
+# need to make sure rpmbuild is installed
+
+module Omnibus
+  class Packager::RPM < Packager::Base
+    # @return [Array]
+    SCRIPTS = %w(pre post preun postun verifyscript pretans posttrans).freeze
+
+    id :rpm
+
+    setup do
+      # Create our magic directories
+      create_directory("#{staging_dir}/BUILD")
+      create_directory("#{staging_dir}/RPMS")
+      create_directory("#{staging_dir}/SRPMS")
+      create_directory("#{staging_dir}/SOURCES")
+      create_directory("#{staging_dir}/SPECS")
+
+      # Copy the full-stack installer into the SOURCE directory, accounting for
+      # any excluded files.
+      #
+      # /opt/hamlet => /tmp/daj29013/BUILD/opt/hamlet
+      destination = File.join(build_dir, project.install_dir)
+      FileSyncer.sync(project.install_dir, destination, exclude: exclusions)
+
+      # Copy over any user-specified extra package files.
+      #
+      # Files retain their relative paths inside the scratch directory, so
+      # we need to grab the dirname of the file, create that directory, and
+      # then copy the file into that directory.
+      #
+      # extra_package_file '/path/to/foo.txt' #=> /tmp/BUILD/path/to/foo.txt
+      project.extra_package_files.each do |file|
+        parent      = File.dirname(file)
+        destination = File.join("#{staging_dir}/BUILD", parent)
+
+        create_directory(destination)
+        copy_file(file, destination)
+      end
+    end
+
+    build do
+      # Generate the spec
+      write_rpm_spec
+
+      # Generate the rpm
+      create_rpm_file
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # Set or return the signing passphrase. If this value is provided,
+    # Omnibus will attempt to sign the RPM.
+    #
+    # @example
+    #   signing_passphrase "foo"
+    #
+    # @param [String] val
+    #   the passphrase to use when signing the RPM
+    #
+    # @return [String]
+    #   the RPM-signing passphrase
+    #
+    def signing_passphrase(val = NULL)
+      if null?(val)
+        @signing_passphrase
+      else
+        @signing_passphrase = val
+      end
+    end
+    expose :signing_passphrase
+
+    #
+    # Set or return the vendor who made this package.
+    #
+    # @example
+    #   vendor "Seth Vargo <sethvargo@gmail.com>"
+    #
+    # @param [String] val
+    #   the vendor who make this package
+    #
+    # @return [String]
+    #   the vendor who make this package
+    #
+    def vendor(val = NULL)
+      if null?(val)
+        @vendor || 'Omnibus <omnibus@getchef.com>'
+      else
+        unless val.is_a?(String)
+          raise InvalidValue.new(:vendor, 'be a String')
+        end
+
+        @vendor = val
+      end
+    end
+    expose :vendor
+
+    #
+    # Set or return the license for this package.
+    #
+    # @example
+    #   license "Apache 2.0"
+    #
+    # @param [String] val
+    #   the license for this package
+    #
+    # @return [String]
+    #   the license for this package
+    #
+    def license(val = NULL)
+      if null?(val)
+        @license || 'unknown'
+      else
+        unless val.is_a?(String)
+          raise InvalidValue.new(:license, 'be a String')
+        end
+
+        @license = val
+      end
+    end
+    expose :license
+
+    #
+    # Set or return the priority for this package.
+    #
+    # @example
+    #   priority "extra"
+    #
+    # @param [String] val
+    #   the priority for this package
+    #
+    # @return [String]
+    #   the priority for this package
+    #
+    def priority(val = NULL)
+      if null?(val)
+        @priority || 'extra'
+      else
+        unless val.is_a?(String)
+          raise InvalidValue.new(:priority, 'be a String')
+        end
+
+        @priority = val
+      end
+    end
+    expose :priority
+
+    #
+    # Set or return the category for this package.
+    #
+    # @example
+    #   category "databases"
+    #
+    # @param [String] val
+    #   the category for this package
+    #
+    # @return [String]
+    #   the category for this package
+    #
+    def category(val = NULL)
+      if null?(val)
+        @category || 'default'
+      else
+        unless val.is_a?(String)
+          raise InvalidValue.new(:category, 'be a String')
+        end
+
+        @category = val
+      end
+    end
+    expose :category
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    #
+    # @return [String]
+    #
+    def package_name
+      "#{safe_project_name}-#{safe_version}-#{safe_build_iteration}.#{safe_architecture}.rpm"
+    end
+
+    #
+    # The path to the +BUILD+ directory inside the staging directory.
+    #
+    # @return [String]
+    #
+    def build_dir
+      @build_dir ||= File.join(staging_dir, 'BUILD')
+    end
+
+    #
+    # Render an rpm spec file in +SPECS/#{name}.spec+ using the supplied ERB
+    # template.
+    #
+    # @return [void]
+    #
+    def write_rpm_spec
+      # Create a map of scripts that exist and their contents
+      scripts = SCRIPTS.inject({}) do |hash, name|
+        path = File.join(project.package_scripts_path, name)
+
+        if File.file?(path)
+          hash[name] = File.read(path)
+        end
+
+        hash
+      end
+
+      # Get a list of user-declared config files
+      config_files = project.config_files.map { |file| rpm_safe(file) }
+
+      # Get a list of all files
+      files = FileSyncer.glob("#{build_dir}/**/*")
+                .map    { |path| path.gsub("#{build_dir}/", '') }
+                .map    { |path| "/#{path}" }
+                .map    { |path| rpm_safe(path) }
+                .reject { |path| config_files.include?(path) }
+
+      render_template(resource_path('spec.erb'),
+        destination: spec_file,
+        variables: {
+          name:           safe_project_name,
+          version:        safe_version,
+          iteration:      safe_build_iteration,
+          vendor:         vendor,
+          license:        license,
+          architecture:   safe_architecture,
+          maintainer:     project.maintainer,
+          homepage:       project.homepage,
+          description:    project.description,
+          priority:       priority,
+          category:       category,
+          conflicts:      project.conflicts,
+          replaces:       project.replaces,
+          dependencies:   project.runtime_dependencies,
+          user:           project.package_user,
+          group:          project.package_group,
+          scripts:        scripts,
+          config_files:   config_files,
+          files:          files,
+        }
+      )
+    end
+
+    #
+    # Generate the RPM file using +rpmbuild+.  The use of the +fakeroot+ command
+    # is required so that the package is owned by +root:root+, but the build
+    # user does not need to have sudo permissions.
+    #
+    # @return [void]
+    #
+    def create_rpm_file
+      log.info(log_key) { "Creating .rpm file" }
+
+      command =  %|fakeroot rpmbuild|
+      command << %| -bb|
+      command << %| --buildroot #{staging_dir}/BUILD|
+      command << %| --define "_topdir #{staging_dir}"|
+
+      if signing_passphrase
+        if File.exist?("#{ENV['HOME']}/.rpmmacros")
+          log.info(log_key) { "Detected .rpmmacros file at `#{ENV['HOME']}'" }
+        else
+          log.info(log_key) { "Using default .rpmmacros file from Omnibus" }
+
+          # Generate a temporary home directory
+          home = Dir.mktmpdir
+
+          render_template(resource_path('rpmmacros.erb'),
+            destination: "#{home}/.rpmmacros",
+            variables: {
+              gpg_name: project.maintainer,
+              gpg_path: "#{ENV['HOME']}/.gnupg", # TODO: Make this configurable
+            }
+          )
+
+          command << " --sign"
+          command << " #{spec_file}"
+
+          with_rpm_signing do |signing_script|
+            shellout!("#{signing_script} \"#{command}\"", environment: { 'HOME' => home })
+          end
+        end
+      else
+        command << " #{spec_file}"
+        shellout!("#{command}")
+      end
+
+      FileSyncer.glob("#{staging_dir}/RPMS/**/*.rpm").each do |rpm|
+        copy_file(rpm, Config.package_dir)
+      end
+    end
+
+    #
+    # The full path to this spec file on disk.
+    #
+    # @return [String]
+    #
+    def spec_file
+      "#{staging_dir}/SPECS/#{package_name}.spec"
+    end
+
+    #
+    # Render the rpm signing script with secure permissions, call the given
+    # block with the path to the script, and ensure deletion of the script from
+    # disk since it contains sensitive information.
+    #
+    # @param [Proc] block
+    #   the block to call
+    #
+    # @return [String]
+    #
+    def with_rpm_signing(&block)
+      directory   = Dir.mktmpdir
+      destination = "#{directory}/sign-rpm"
+
+      render_template(resource_path('signing.erb'),
+        destination: destination,
+        mode: 0700,
+        variables: {
+          passphrase: signing_passphrase,
+        }
+      )
+
+      # Yield the destination to the block
+      block.call(destination)
+    ensure
+      remove_file(destination)
+      remove_directory(directory)
+    end
+
+    #
+    # Generate an RPM-safe name from the given string, doing the following:
+    #
+    # - Replace [ with [\[] to make rpm not use globs
+    # - Replace * with [*] to make rpm not use globs
+    # - Replace ? with [?] to make rpm not use globs
+    # - Replace % with [%] to make rpm not expand macros
+    #
+    # @param [String] string
+    #   the string to sanitize
+    #
+    def rpm_safe(string)
+      string = "\"#{string}\"" if string[/\s/]
+
+      string.dup
+        .gsub("[", "[\\[]")
+        .gsub("*", "[*]")
+        .gsub("?", "[?]")
+        .gsub("%", "[%]")
+    end
+
+    #
+    # Return the RPM-ready project name, converting any invalid characters to
+    # dashes (+-+).
+    #
+    # @return [String]
+    #
+    def safe_project_name
+      if project.name =~ /\A[a-z0-9\.\+\-]+\z/
+        project.name.dup
+      else
+        converted = project.name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
+
+        log.warn(log_key) do
+          "The `name' compontent of RPM package names can only include " \
+          "lowercase alphabetical characters (a-z), numbers (0-9), dots (.), " \
+          "plus signs (+), and dashes (-). Converting `#{project.name}' to " \
+          "`#{converted}'."
+        end
+
+        converted
+      end
+    end
+
+    #
+    # This is actually just the regular build_iternation, but it felt lonely
+    # among all the other +safe_*+ methods.
+    #
+    # @return [String]
+    #
+    def safe_build_iteration
+      project.build_iteration
+    end
+
+    #
+    # RPM package versions cannot contain dashes, so we will convert them to
+    # underscores.
+    #
+    # @return [String]
+    #
+    def safe_version
+      if project.build_version =~ /\A[a-zA-Z0-9\.\+\-]+\z/
+        project.build_version.dup
+      else
+        converted = project.build_version.gsub(/[^a-zA-Z0-9\.\+\-]+/, '-')
+
+        log.warn(log_key) do
+          "The `version' compontent of RPM 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}'."
+        end
+
+        converted
+      end
+    end
+
+    #
+    # The architecture for this RPM package.
+    #
+    # @return [String]
+    #
+    def safe_architecture
+      Ohai['kernel']['machine']
+    end
+  end
+end