packaging 0.88.77

data/static_artifacts/PackageInfo.plist

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pkg-info followSymLinks="true" minimumSystemVersion="10.6" auth="root"/>
+

data/tasks/00_utils.rake

@@ -0,0 +1,214 @@
+#######################################################################
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                  !  DO NOT ADD TO THIS FILE  !                      #
+#                                                                     #
+#   Usage of this file to store utilities is deprecated. Any new      #
+#   utilities should be added to new or existing classes in           #
+#   lib/packaging/util. Any modified utilities should be migrated     #
+#   to new or existing classes in lib/packaging/util as well.         #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#                                                                     #
+#######################################################################
+
+
+
+
+
+# Utility methods used by the various rake tasks
+
+#######################################################################
+#                                                                     #
+#         DEPRECATED METHODS: Please move any newly depreacted        #
+#     methods into the following section so that we can easily        #
+#              see what methods are left to librarify.                #
+#                                                                     #
+#######################################################################
+
+def invoke_task(task, *args)
+  Pkg::Util.deprecate('invoke_task', 'Pkg::Util::RakeUtils.invoke_task')
+  Pkg::Util::RakeUtils.invoke_task(task, *args)
+end
+
+def rsync_to(*args)
+  Pkg::Util.deprecate('rsync_to', 'Pkg::Util::Net.rsync_to')
+  Pkg::Util::Net.rsync_to(args[0], args[1], args[2])
+end
+
+def rsync_from(*args)
+  Pkg::Util.deprecate('rsync_from', 'Pkg::Util::Net.rsync_from')
+  Pkg::Util::Net.rsync_from(args[0], args[1], args[2])
+end
+
+def mkdir_pr(*args)
+  Pkg::Util.deprecate('mkdir_pr', 'FileUtils.mkdir_p')
+  FileUtils.mkdir_p args
+end
+
+def ln(target, name)
+  Pkg::Util.deprecate('ln', 'FileUtils.ln')
+  FileUtils.ln(name, target, :force => true, :verbose => true)
+end
+
+def ln_sfT(src, dest)
+  Pkg::Util.deprecate('ln_sfT')
+  sh "ln -sfT #{src} #{dest}"
+end
+
+def git_commit_file(file, message = nil)
+  Pkg::Util.deprecate('git_commit_file', 'Pkg::Util::Git.git_commit_file')
+  Pkg::Util::Git.git_commit_file(file, message)
+end
+
+def git_bundle(treeish, appendix = nil, output_dir = nil)
+  Pkg::Util.deprecate('git_bundle', 'Pkg::Util::Git.git_bundle')
+  Pkg::Util::Git.git_bundle(treeish, appendix, output_dir)
+end
+
+def git_tag(version)
+  Pkg::Util.deprecate('git_tag', 'Pkg::Util::Git.git_tag')
+  Pkg::Util::Git.git_tag(version)
+end
+
+def git_pull(remote, branch)
+  Pkg::Util.deprecate('git_pull', 'Pkg::Util::Git.git_pull')
+  Pkg::Util::Git.git_pull(remote, branch)
+end
+
+def curl_form_data(uri, form_data = [], options = {})
+  Pkg::Util.deprecate("curl_form_data", "Pkg::Util::Net.curl_form_data")
+  Pkg::Util::Net.curl_form_data(uri, form_data, options)
+end
+
+def create_jenkins_job(name, xml_file)
+  Pkg::Util.deprecate("create_jenkins_job", "Pkg::Util::Jenkins.create_jenkins_job")
+  Pkg::Util::Jenkins.create_jenkins_job(name, xml_file)
+end
+
+def jenkins_job_exists?(name)
+  Pkg::Util.deprecate("jenkins_job_exists", "Pkg::Util::Jenkins.jenkins_job_exists?")
+  Pkg::Util::Jenkins.jenkins_job_exists?(name)
+end
+
+def print_url_info(url_string)
+  Pkg::Util.deprecate("print_url_info", "Pkg::Util::Net.print_url_info")
+  Pkg::Util::Net.print_url_info(url_string)
+end
+
+def retry_on_fail(args, &block)
+  Pkg::Util.deprecate("retry_on_fail", "Pkg::Util::Execution.retry_on_fail")
+  Pkg::Util::Execution.retry_on_fail(args, &block)
+end
+
+# ex combines the behavior of `%x{cmd}` and rake's `sh "cmd"`. `%x{cmd}` has
+# the benefit of returning the standard out of an executed command, enabling us
+# to query the file system, e.g. `contents = %x{ls}`. The drawback to `%x{cmd}`
+# is that on failure of a command (something returned non-zero) the return of
+# `%x{cmd}` is just an empty string. As such, we can't know if we succeeded.
+# Rake's `sh "cmd"`, on the other hand, will raise a RuntimeError if a command
+# does not return 0, but doesn't return any of the stdout from the command -
+# only true or false depending on its success or failure. With `ex(cmd)` we
+# purport to both return the results of the command execution (ala `%x{cmd}`)
+# while also raising an exception if a command does not succeed (ala `sh "cmd"`).
+def ex(command)
+  # We haven't done anything about this deprecation and our log files
+  # have too many warnings from this.
+  # Turn off the notice for now until packaging is refactored.
+  # Pkg::Util.deprecate("ex", "Pkg::Util::Execution.ex")
+  Pkg::Util::Execution.ex(command)
+end
+
+def load_keychain
+  Pkg::Util.deprecate("load_keychain", "Pkg::Util::Gpg.load_keychain")
+  Pkg::Util::Gpg.load_keychain
+end
+
+def kill_keychain
+  Pkg::Util.deprecate("kill_keychain", "Pkg::Util::Gpg.kill_keychain")
+  Pkg::Util::Gpg.kill_keychain
+end
+
+def start_keychain
+  Pkg::Util.deprecate("start_keychain", "Pkg::Util::Gpg.start_keychain")
+  Pkg::Util::Gpg.start_keychain
+end
+
+def gpg_sign_file(file)
+  Pkg::Util.deprecate("gpg_sign_file", "Pkg::Util::Gpg.sign_file")
+  Pkg::Util::Gpg.sign_file(file)
+end
+
+def check_var(varname, var)
+  Pkg::Util.deprecate('check_var', 'Pkg::Util.check_var')
+  Pkg::Util.check_var(varname, var)
+end
+
+def rand_string
+  Pkg::Util.deprecate('invoke_task', 'Pkg::Util.rand_string')
+  Pkg::Util.rand_string
+end
+
+def escape_html(uri)
+  Pkg::Util.deprecate('escape_html', 'Pkg::Util::Net.escape_html')
+  Pkg::Util::Net.escape_html(uri)
+end
+
+def add_param_to_uri(uri, param)
+  Pkg::Util.deprecate('add_param_to_uri', 'Pkg::Util::Net.add_param_to_uri')
+  Pkg::Util::Net.add_param_to_uri(uri, param)
+end
+
+def cp_pr(src, dest, options = {})
+  Pkg::Util.deprecate('cp_pr', 'FileUtils.cp_r')
+  mandatory = { :preserve => true }
+  FileUtils.cp_r(src, dest, options.merge(mandatory))
+end
+
+def cp_p(src, dest, options = {})
+  Pkg::Util.deprecate('cp_p', 'FileUtils.cp')
+  mandatory = { :preserve => true }
+  FileUtils.cp(src, dest, options.merge(mandatory))
+end
+
+def remote_set_immutable(host, files)
+  Pkg::Util.deprecate('remote_set_immutable', 'Pkg::Util::Net.remote_set_immutable')
+  Pkg::Util::Net.remote_set_immutable(host, files)
+end
+
+def ask_yes_or_no
+  Pkg::Util.deprecate('ask_yes_or_no', 'Pkg::Util.ask_yes_or_no')
+  Pkg::Util.ask_yes_or_no
+end
+
+def confirm_ship(files)
+  Pkg::Util.deprecate('confirm_ship', 'Pkg::Util.confirm_ship')
+  Pkg::Util.confirm_ship(files)
+end
+
+def deprecate(old_cmd, new_cmd = nil)
+  Pkg::Util.deprecate('deprecate', 'Pkg::Util.deprecate')
+  Pkg::Util.deprecate(old_cmd, new_cmd)
+end
+
+def remote_buildparams(host, build)
+  Pkg::Util.deprecate('remote_buildparams', 'Pkg::Util::Net.remote_buildparams')
+  Pkg::Util::Net.remote_buildparams(host, build)
+end
+
+def ship_gem(file)
+  Pkg::Util.deprecate('ship_gem', 'Pkg::Gem.ship')
+  Pkg::Gem.ship(file)
+end
+
+def set_cow_envs(cow)
+  Pkg::Util.deprecate('set_cow_envs', 'Pkg::Deb.set_cow_envs')
+  Pkg::Deb.set_cow_envs(cow)
+end

data/tasks/30_metrics.rake

@@ -0,0 +1,33 @@
+@metrics          = []
+def add_shipped_metrics(args)
+  @metrics << {
+    :type         => 'shipped',
+    :package      => (args[:package]             || Pkg::Config.project),
+    :version      => (args[:version]             || Pkg::Config.version),
+    :pe_version   => (args[:pe_version]          || Pkg::Config.pe_version),
+    :is_rc        => (args[:is_rc]               || false),
+  }
+end
+
+def post_shipped_metrics
+  require 'net/http'
+  @metrics.each do |metric|
+    type         = metric[:type]
+    package      = metric[:package]
+    version      = metric[:version]
+    pe_version   = metric[:pe_version]
+    is_rc        = metric[:is_rc]
+
+    uri = URI(Pkg::Config.metrics_url)
+    res = Net::HTTP.post_form(
+      uri,
+      {
+        'type'          => type,
+        'package'       => package,
+        'version'       => version,
+        'pe_version'    => pe_version,
+        'is_rc'         => is_rc,
+      }
+    )
+  end
+end

data/tasks/apple.rake

@@ -0,0 +1,268 @@
+# Title:        Rake task to build Apple packages for #{@project}.
+# Author:       Gary Larizza
+# Date:         05/18/2012
+# Description:  This task will create a DMG-encapsulated package that will
+#               install a package on OS X systems. This happens by building
+#               a directory tree of files that will then be fed to the
+#               packagemaker binary (can be installed by installing the
+#               XCode Tools) which will create the .pkg file.
+#
+
+# Path to Binaries (Constants)
+CP            = '/bin/cp'
+INSTALL       = '/usr/bin/install'
+DITTO         = '/usr/bin/ditto'
+PKGBUILD      = '/usr/bin/pkgbuild'
+
+# Setup task to populate all the variables
+task :setup do
+  # Read the Apple file-mappings
+  begin
+    @source_files        = Pkg::Util::Serialization.load_yaml('ext/osx/file_mapping.yaml')
+  rescue => e
+    fail "Could not load Apple file mappings from 'ext/osx/file_mapping.yaml'\n#{e}"
+  end
+  @package_name          = Pkg::Config.project
+  @title                 = "#{Pkg::Config.project}-#{Pkg::Config.version}"
+  @reverse_domain        = "com.#{Pkg::Config.packager}.#{@package_name}"
+  @package_major_version = Pkg::Config.version.split('.')[0]
+  @package_minor_version = Pkg::Config.version.split('.')[1] +
+                           Pkg::Config.version.split('.')[2].split('-')[0].split('rc')[0]
+  @pm_restart            = 'None'
+  @build_date            = Time.new.strftime("%Y-%m-%dT%H:%M:%SZ")
+  @apple_bindir          = File.join('/', @source_files['directories']['bin']['path'])
+  @apple_sbindir         = '/usr/sbin'
+  @apple_libdir          = File.join('/', @source_files['directories']['lib']['path'])
+  @apple_old_libdir      = '/usr/lib/ruby/site_ruby/1.8'
+  @apple_docdir          = '/usr/share/doc'
+end
+
+# method:       make_directory_tree
+# description:  This method sets up the directory structure that packagemaker
+#               needs to build a package. A prototype.plist file (holding
+#               package-specific options) is built from an ERB template located
+#               in the ext/osx directory.
+def make_directory_tree
+  project_tmp    = "#{Pkg::Util::File.mktemp}/#{@package_name}"
+  @scratch       = "#{project_tmp}/#{@title}"
+  @working_tree  = {
+     'scripts'   => "#{@scratch}/scripts",
+     'resources' => "#{@scratch}/resources",
+     'working'   => "#{@scratch}/root",
+     'payload'   => "#{@scratch}/payload",
+  }
+  puts "Cleaning Tree: #{project_tmp}"
+  rm_rf(project_tmp)
+  @working_tree.each do |key, val|
+    mkdir_p(val)
+  end
+
+  if File.exists?('ext/osx/postflight.erb')
+    Pkg::Util::File.erb_file 'ext/osx/postflight.erb', "#{@working_tree["scripts"]}/postinstall", false, :binding => binding
+  end
+
+  if File.exists?('ext/osx/preflight.erb')
+    Pkg::Util::File.erb_file 'ext/osx/preflight.erb', "#{@working_tree["scripts"]}/preinstall", false, :binding => binding
+  end
+
+  if File.exists?('ext/osx/prototype.plist.erb')
+    Pkg::Util::File.erb_file 'ext/osx/prototype.plist.erb', "#{@scratch}/prototype.plist", false, :binding => binding
+  end
+
+  if File.exists?('ext/packaging/static_artifacts/PackageInfo.plist')
+    cp 'ext/packaging/static_artifacts/PackageInfo.plist', "#{@scratch}/PackageInfo.plist"
+  end
+
+end
+
+# method:        build_dmg
+# description:   This method builds a package from the directory structure in
+#                /tmp/#{@project} and puts it in the
+#                /tmp/#{@project}/#{@project}-#{version}/payload directory. A DMG is
+#                created, using hdiutil, based on the contents of the
+#                /tmp/#{@project}/#{@project}-#{version}/payload directory. The resultant
+#                DMG is placed in the pkg/apple directory.
+#
+def build_dmg
+  # Local Variables
+  dmg_format_code   = 'UDZO'
+  dmg_filesystem    = 'HFS+'
+  zlib_level        = '9'
+  dmg_format_option = "-imagekey zlib-level=#{zlib_level}"
+  dmg_format        = "#{dmg_format_code} #{dmg_format_option}"
+  dmg_file          = "#{@title}.dmg"
+  package_file      = "#{@title}.pkg"
+
+  # Build .pkg file
+  system("sudo #{PKGBUILD} --root #{@working_tree['working']} \
+    --scripts #{@working_tree['scripts']} \
+    --identifier #{@reverse_domain} \
+    --version #{Pkg::Config.version} \
+    --install-location / \
+    --ownership preserve \
+    --info #{@scratch}/PackageInfo.plist \
+    #{@working_tree['payload']}/#{package_file}")
+
+  # Build .dmg file
+  system("sudo hdiutil create -volname #{@title} \
+    -srcfolder #{@working_tree['payload']} \
+    -uid 99 \
+    -gid 99 \
+    -ov \
+    -fs #{dmg_filesystem} \
+    -format #{dmg_format} \
+    #{dmg_file}")
+
+  if File.directory?("#{pwd}/pkg/apple")
+    sh "sudo mv #{pwd}/#{dmg_file} #{pwd}/pkg/apple/#{dmg_file}"
+    puts "moved:   #{dmg_file} has been moved to #{pwd}/pkg/apple/#{dmg_file}"
+  else
+    mkdir_p("#{pwd}/pkg/apple")
+    sh "sudo mv #{pwd}/#{dmg_file} #{pwd}/pkg/apple/#{dmg_file}"
+    puts "moved:   #{dmg_file} has been moved to #{pwd}/pkg/apple/#{dmg_file}"
+  end
+end
+
+# method:        pack_source
+# description:   This method copies the #{@project} source into a directory
+#                structure in /tmp/#{@project}/#{@project}-#{version}/root mirroring the
+#                structure on the target system for which the package will be
+#                installed. Anything installed into /tmp/#{@project}/root will be
+#                installed as the package's payload.
+#
+def pack_source
+  work          = "#{@working_tree['working']}"
+  source = pwd
+
+  # Make all necessary directories
+  @source_files.each_value do |files|
+    files.each_value do |params|
+      mkdir_p "#{work}/#{params['path']}"
+    end
+  end
+
+  # Install directory contents into place
+  unless @source_files['directories'].nil?
+    @source_files['directories'].each do |dir, params|
+      unless FileList["#{source}/#{dir}/*"].empty?
+        cmd = "#{DITTO} #{source}/#{dir}/ #{work}/#{params['path']}"
+        puts cmd
+        system(cmd)
+      end
+    end
+  end
+
+  # Setup a preinstall script and replace variables in the files with
+  # the correct paths.
+  if File.exists?("#{@working_tree['scripts']}/preinstall")
+    chmod(0755, "#{@working_tree['scripts']}/preinstall")
+    sh "sudo chown root:wheel #{@working_tree['scripts']}/preinstall"
+  end
+
+  # Setup a postinstall from from the erb created earlier
+  if File.exists?("#{@working_tree['scripts']}/postinstall")
+    chmod(0755, "#{@working_tree['scripts']}/postinstall")
+    sh "sudo chown root:wheel #{@working_tree['scripts']}/postinstall"
+  end
+
+  # Do a run through first setting the specified permissions then
+  # making sure 755 is set for all directories
+  unless @source_files['directories'].nil?
+    @source_files['directories'].each do |dir, params|
+      owner = params['owner']
+      group = params['group']
+      perms = params['perms']
+      path  = params['path']
+      ##
+      # Before setting our default permissions for all subdirectories/files of
+      # each directory listed in directories, we have to get a list of the
+      # directories. Otherwise, when we set the default perms (most likely
+      # 0644) we'll lose traversal on subdirectories, and later when we want to
+      # ensure they're 755 we won't be able to find them.
+      #
+      directories = []
+      Dir["#{work}/#{path}/**/*"].each do |file|
+        directories << file if File.directory?(file)
+      end
+
+      ##
+      # Here we're setting the default permissions for all files as described
+      # in file_mapping.yaml. Since we have a listing of directories, it
+      # doesn't matter if we remove executable permission on directories, we'll
+      # reset it later.
+      #
+      sh "sudo chmod -R #{perms} #{work}/#{path}"
+
+      ##
+      # We know at least one directory, the one listed in file_mapping.yaml, so
+      # we set it executable.
+      #
+      sh "sudo chmod 0755 #{work}/#{path}"
+
+      ##
+      # Now that default perms are set, we go in and reset executable perms on
+      # directories
+      #
+      directories.each { |d| sh "sudo chmod 0755 #{d}" }
+
+      ##
+      # Finally we set the owner/group as described in file_mapping.yaml
+      #
+      sh "sudo chown -R #{owner}:#{group} #{work}/#{path}"
+    end
+  end
+
+  # Install any files
+  unless @source_files['files'].nil?
+    @source_files['files'].each do |file, params|
+      owner = params['owner']
+      group = params['group']
+      perms = params['perms']
+      dest  = params['path']
+      # Allow for regexs like [A-Z]*
+      FileList[file].each do |f|
+        cmd = "sudo #{INSTALL} -o #{owner} -g #{group} -m #{perms} #{source}/#{f} #{work}/#{dest}"
+        puts cmd
+        system(cmd)
+      end
+    end
+  end
+
+  # Hackery here. Our packages were using /usr/bin/env ruby and installing to
+  # system ruby loadpath, which breaks horribly in a multi-ruby (rbenv, etc)
+  # environment. This goes into the workdir and looks for any files dropped in
+  # bin, and "seds" the shebang to /usr/bin/ruby. I would love to be using a
+  # ruby approach to this instead of shelling out to sed, but the problem is
+  # we've already set ownership on these files, almost exclusively to root, and
+  # thus we need to sudo out.
+  if @source_files['directories'] and @source_files['directories']['bin']
+    if bindir = @source_files['directories']['bin']['path']
+      Dir[File.join(work, bindir, '*')].each do |binfile|
+        sh "sudo /usr/bin/sed -E -i '' '1 s,^#![[:space:]]*/usr/bin/env[[:space:]]+ruby$,#!/usr/bin/ruby,' #{binfile}"
+      end
+    end
+  end
+end
+
+namespace :package do
+  desc "Task for building an Apple Package"
+  task :apple => [:setup] do
+    if Pkg::Config.build_dmg
+      bench = Benchmark.realtime do
+        # Test for pkgbuild binary
+        fail "pkgbuild must be installed." unless \
+          File.exists?(PKGBUILD)
+
+        make_directory_tree
+        pack_source
+        build_dmg
+      end
+      puts "Finished building in: #{bench}"
+    end
+  end
+end
+
+# An alias task to simplify our remote logic in jenkins.rake
+namespace :pl do
+  task :dmg => "package:apple"
+end