fpm 0.4.10 → 0.4.11

data/CHANGELIST

@@ -1,3 +1,24 @@
+0.4.11 (August 7, 2012)
+  - Support different compression types on deb packages (default gzip,
+    alternates xz and bzip2)
+  - Fix some symlink handling to prevent links from being followed during
+    cleanup (#228, patch by sbuss)
+  - rpm: 'vendor' in rpm spec is now omitted if empty or nil. This fixes a bug
+    where rpmbuild fails due to empty 'Vendor' tag if you convert rpm to rpm.
+  - internal: remove empty directories marked by --exclude (#205, patch by
+    jimbrowne)
+  - dir: don't try to set utime on symlinks (#234, #240, patch by ctgswallow)
+  - rpm: relocatable rpms now supported when using the '--prefix' flag.
+    Example: fpm -s dir -t rpm --prefix /usr/local -n example /etc/motd 
+    (patch by jkoppe)
+  - deb: --deb-compression flag: Support different compression methods. 
+    Default continues to be gzip.
+  - new flag: --template-scripts. This lets you write script templates for
+    --after-install, etc. Templates are ERB, so you can do things like 
+    '<%= name %>' to get the package name in the script, etc.
+  - warn on command invocations that appear to have stray flags to try and
+    help users who have complex command lines that are failling.
+
 0.4.10 (May 25, 2012)
   - Fix python package support for python3 (#212, patch by Slezhuk Evgeniy)
   - Preserve file metadata (time, owner, etc) when copying with the dir

data/CONTRIBUTORS

@@ -16,3 +16,9 @@ Luke Macken (github: lmacken)
 Matt Blair (github: mblair)
 Thomas Meson (github: zllak)
 Oliver Hookins (github: ohookins)
+llasram
+sbuss
+
+If you have contributed (bug reports, feature requests, help in IRC, blog
+posts, code, etc) and aren't listed here, please let me know if you wish to be
+added!

data/lib/fpm/command.rb

@@ -145,6 +145,12 @@ class FPM::Command < Clamp::Command
     "a script to be run before package removal" do |val|
     File.expand_path(val) # Get the full path to the script
   end # --before-remove
+  option "--template-scripts", :flag,
+    "Allow scripts to be templated. This lets you use ERB to template your " \
+    "packaging scripts (for --after-install, etc). For example, you can do " \
+    "things like <%= name %> to get the package name. For more information, " \
+    "see the fpm wiki: " \
+    "https://github.com/jordansissel/fpm/wiki/Script-Templates"
 
   parameter "[ARGS] ...",
     "Inputs to the source package type. For the 'dir' type, this is the files" \
@@ -183,6 +189,11 @@ class FPM::Command < Clamp::Command
     @logger.subscribe(STDOUT)
     @logger.level = :warn
 
+    if (stray_flags = args.grep(/^-/); stray_flags.any?)
+      @logger.warn("All flags should be before the first argument " \
+                   "(stray flags found: #{stray_flags}")
+    end
+
     # Some older behavior, if you specify:
     #   'fpm -s dir -t ... -C somepath'
     # fpm would assume you meant to add '.' to the end of the commandline.
@@ -296,15 +307,18 @@ class FPM::Command < Clamp::Command
     input.config_files += config_files
     
     setscript = proc do |scriptname|
+      # 'self.send(scriptname) == self.before_install == --before-install
+      # Gets the path to the script
       path = self.send(scriptname)
       # Skip scripts not set
       next if path.nil?
 
-      # 'self.send(scriptname) == self.before_install == --before-install
       if !File.exists?(path)
         @logger.error("No such file (for #{scriptname.to_s}): #{path.inspect}")
         return 1
       end
+
+      # Load the script into memory.
       input.scripts[scriptname] = File.read(path)
     end
 
@@ -336,6 +350,9 @@ class FPM::Command < Clamp::Command
   rescue FPM::Util::ExecutableNotFound => e
     @logger.error("Need executable '#{e}' to convert #{input_type} to #{output_type}")
     return 1
+  rescue FPM::InvalidPackageConfiguration => e
+    @logger.error("Invalid package configuration: #{e}")
+    return 1
   ensure
     input.cleanup unless input.nil?
     output.cleanup unless output.nil?

data/lib/fpm/package.rb

@@ -1,9 +1,11 @@
 require "fpm/namespace" # local
 require "fpm/util" # local
+require "pathname" # stdlib
 require "tmpdir" # stdlib
 require "backports" # gem 'backports'
 require "socket" # stdlib, for Socket.gethostname
 require "shellwords" # stdlib, for Shellwords.escape
+require "erb" # stdlib, for template processing
 require "cabin" # gem "cabin"
 
 # This class is the parent of all packages.
@@ -299,7 +301,6 @@ class FPM::Package
   end # def files
  
   def template(path)
-    require "erb"
     template_dir = File.join(File.dirname(__FILE__), "..", "..", "templates")
     template_path = File.join(template_dir, path)
     template_code = File.read(template_path)
@@ -334,6 +335,8 @@ class FPM::Package
   # This method removes excluded files from the staging_path. Subclasses can
   # remove the files during the input phase rather than deleting them here
   def exclude
+    return if attributes[:excludes].nil?
+
     if @attributes.include?(:prefix)
       installdir = staging_path(@attributes[:prefix])
     else
@@ -346,6 +349,14 @@ class FPM::Package
         if File.fnmatch(wildcard, file)
           @logger.info("Removing excluded file", :path => file, :matches => wildcard)
           FileUtils.remove_entry_secure(staging_path(file))
+          Pathname.new(staging_path(file)).parent.ascend do |d|
+            if (::Dir.entries(d) - %w[ . .. ]).empty?
+              ::Dir.rmdir(d)
+              @logger.info("Deleting empty directory left by removing exluded file", :path => d)
+            else
+              break
+            end
+          end
         end
       end
     end
@@ -436,9 +447,29 @@ class FPM::Package
     return nil
   end # def version
 
+  # Does this package have the given script?
+  def script?(name)
+    return scripts.include?(name)
+  end # def script?
+
+  # Get the contents of the script by a given name.
+  #
+  # If template_scripts? is set in attributes (often by the --template-scripts
+  # flag), then apply it as an ERB template.
+  def script(script_name)
+    if attributes[:template_scripts?]
+      erb = ERB.new(scripts[script_name], nil, "-")
+      # TODO(sissel): find the original file name for the file.
+      erb.filename = "script(#{script_name})"
+      return erb.result(binding)
+    else
+      return scripts[script_name]
+    end
+  end # def script
+
   # General public API
   public(:type, :initialize, :convert, :input, :output, :to_s, :cleanup, :files,
-         :version)
+         :version, :script)
 
   # Package internal public api
   public(:cleanup_staging, :cleanup_build, :staging_path, :converted_from,

data/lib/fpm/package/deb.rb

@@ -4,13 +4,13 @@ require "fpm/package"
 require "fpm/errors"
 require "fpm/util"
 require "backports"
-require "fpm/monkeypatches" # until backports > 2.3.0
 require "fileutils"
 
 # Support for debian packages (.deb files)
 #
 # This class supports both input and output of packages.
 class FPM::Package::Deb < FPM::Package
+
   # Map of what scripts are named.
   SCRIPT_MAP = {
     :before_install     => "preinst",
@@ -19,6 +19,9 @@ class FPM::Package::Deb < FPM::Package
     :after_remove       => "postrm",
   } unless defined?(SCRIPT_MAP)
 
+  # The list of supported compression types. Default is gz (gzip)
+  COMPRESSION_TYPES = [ "gz", "bzip2", "xz" ]
+
   option "--ignore-iteration-in-dependencies", :flag, 
             "For '=' (equal) dependencies, allow iterations on the specified " \
             "version. Default is to be specific. This option allows the same " \
@@ -30,6 +33,15 @@ class FPM::Package::Deb < FPM::Package
     @pre_depends << dep
   end
 
+  option "--compression", "COMPRESSION", "The compression type to use, must " \
+    "be one of #{COMPRESSION_TYPES.join(", ")}.", :default => "gzip" do |value|
+    if !COMPRESSION_TYPES.include?(value)
+      raise ArgumentError, "deb compression value of '#{value}' is invalid. " \
+        "Must be one of #{COMPRESSION_TYPES.join(", ")}"
+    end
+    value
+  end
+
   # Take care about the case when we want custom control file but still use fpm ...
   option "--custom-control", "FILEPATH",
     "Custom version of the Debian control file." do |control|
@@ -159,6 +171,7 @@ class FPM::Package::Deb < FPM::Package
   #
   #     parse_depends("foo (>= 3), bar (= 5), baz")
   def parse_depends(data)
+    return [] if data.nil? or data.empty?
     # parse dependencies. Debian dependencies come in one of two forms:
     # * name
     # * name (op version)
@@ -183,8 +196,28 @@ class FPM::Package::Deb < FPM::Package
   end # def parse_depends
 
   def extract_files(package)
-    # unpack the data.tar.gz from the deb package into staging_path
-    safesystem("ar p #{package} data.tar.gz | tar -zxf - -C #{staging_path}")
+    # Find out the compression type
+    p `ar t #{package}`
+    compression = `ar t #{package}`.split("\n").grep(/data.tar/).first.split(".").last
+    case compression
+      when "gz"
+        datatar = "data.tar.gz"
+        compression = "-z"
+      when "bzip2" 
+        datatar = "data.tar.bz2"
+        compression = "-j"
+      when "xz" 
+        datatar = "data.tar.xz"
+        compression = "-J"
+      else
+        raise FPM::InvalidPackageConfiguration,
+          "Unknown compression type '#{self.attributes[:deb_compression]}' "
+          "in deb source package #{package}"
+    end
+
+    # unpack the data.tar.{gz,bz2,xz} from the deb package into staging_path
+    safesystem("ar p #{package} #{datatar} " \
+               "| tar #{compression} -xf - -C #{staging_path}")
   end # def extract_files
 
   def output(output_path)
@@ -196,9 +229,22 @@ class FPM::Package::Deb < FPM::Package
 
     write_control_tarball
 
-    # Tar up the staging_path and call it 'data.tar.gz'
-    datatar = build_path("data.tar.gz")
-    safesystem(tar_cmd, "-C", staging_path, "-zcf", datatar, ".")
+    # Tar up the staging_path into data.tar.{compression type}
+    case self.attributes[:deb_compression]
+      when "gzip", nil
+        datatar = build_path("data.tar.gz")
+        compression = "-z"
+      when "bzip2" 
+        datatar = build_path("data.tar.bz2")
+        compression = "-j"
+      when "xz"
+        datatar = build_path("data.tar.xz")
+        compression = "-J"
+      else
+        raise FPM::InvalidPackageConfiguration,
+          "Unknown compression type '#{self.attributes[:deb_compression]}'"
+    end
+    safesystem(tar_cmd, "-C", staging_path, compression, "-cf", datatar, ".")
 
     # pack up the .deb, which is just an 'ar' archive with 3 files
     # the 'debian-binary' file has to be first
@@ -348,11 +394,11 @@ class FPM::Package::Deb < FPM::Package
   # 'post_install' names
   def write_scripts
     SCRIPT_MAP.each do |scriptname, filename|
-      next if scripts[scriptname].nil?
+      next if script?(scriptname).nil?
 
       with(control_path(filename)) do |controlscript|
         @logger.debug("Writing control script", :source => filename, :target => controlscript)
-        File.write(controlscript, scripts[scriptname])
+        File.write(controlscript, script(scriptname))
         # deb maintainer scripts are required to be executable
         File.chmod(0755, controlscript)
       end

data/lib/fpm/package/dir.rb

@@ -90,11 +90,20 @@ class FPM::Package::Dir < FPM::Package
       FileUtils.mkdir_p(directory)
     end
 
-    # Create a directory if this path is a directory
-    if File.directory?(source) and !File.symlink?(source)
-      @logger.debug("Creating", :directory => destination)
-      if !File.directory?(destination)
-        FileUtils.mkdir(destination)
+    if File.directory?(source)
+      if !File.symlink?(source)
+        # Create a directory if this path is a directory
+        @logger.debug("Creating", :directory => destination)
+        if !File.directory?(destination)
+          FileUtils.mkdir(destination)
+        end
+      else
+        # Linking symlinked directories causes a hardlink to be created, which
+        # results in the source directory being wiped out during cleanup,
+        # so copy the symlink.
+        @logger.debug("Copying symlinked directory", :source => source,
+                      :destination => destination)
+        FileUtils.copy_entry(source, destination)
       end
     else
       # Otherwise try copying the file.
@@ -116,16 +125,20 @@ class FPM::Package::Dir < FPM::Package
     dest_stat = File::lstat(destination)
 
     # If this is a hard-link, there's no metadata to copy.
-    return if source_stat.ino == dest_stat.ino
+    # If this is a symlink, what it points to hasn't been copied yet.
+    return if source_stat.ino == dest_stat.ino || dest_stat.symlink?
 
     File.utime(source_stat.atime, source_stat.mtime, destination)
+    mode = source_stat.mode
     begin
-      File.chown(source_stat.uid, source_stat.gid, destination)
+      File.lchown(source_stat.uid, source_stat.gid, destination)
     rescue Errno::EPERM
       # clear setuid/setgid
-      File.chmod(source_stat.mode & 01777, destination)
-    else
-      File.chmod(source_stat.mode, destination)
+      mode &= 01777
+    end
+
+    unless source_stat.symlink?
+      File.chmod(mode, destination)
     end
   end # def copy_metadata
 

data/lib/fpm/package/gem.rb

@@ -21,7 +21,8 @@ class FPM::Package::Gem < FPM::Package
   option "--package-prefix", "NAMEPREFIX",
     "(DEPRECATED, use --package-name-prefix) Name to prefix the package " \
     "name with." do |value|
-    @logger.warn("Using deprecated flag: --package-prefix. Please use " \
+    logger = Cabin::Channel.get
+    logger.warn("Using deprecated flag: --package-prefix. Please use " \
                  "--package-name-prefix")
     value
   end

data/lib/fpm/package/rpm.rb

@@ -2,7 +2,6 @@ require "fpm/package"
 require "backports"
 require "fileutils"
 require "find"
-require "fpm/monkeypatches" # until backports > 2.3.0
 require "arr-pm/file" # gem 'arr-pm'
 
 # RPM Package type.
@@ -204,6 +203,16 @@ class FPM::Package::RPM < FPM::Package
     @logger.log("Created rpm", :path => output_path)
   end # def output
 
+  def prefix
+    return (attributes[:prefix] or "/")
+  end # def prefix
+
+  def build_sub_dir
+    return "BUILD"
+    #return File.join("BUILD", prefix)
+  end # def prefix
+
+
   def to_s(format=nil)
     return super("NAME-VERSION-ITERATION.ARCH.TYPE") if format.nil?
     return super(format)
@@ -218,5 +227,5 @@ class FPM::Package::RPM < FPM::Package
   end # def digest_algorithm
 
   public(:input, :output, :converted_from, :architecture, :to_s, :iteration,
-         :payload_compression, :digest_algorithm)
+         :payload_compression, :digest_algorithm, :prefix, :build_sub_dir)
 end # class FPM::Package::RPM

data/templates/rpm.erb

@@ -27,10 +27,15 @@ AutoReqProv: no
 # Seems specifying BuildRoot is required on older rpmbuild (like on CentOS 5)
 # fpm passes '--define buildroot ...' on the commandline, so just reuse that.
 BuildRoot: %buildroot
+<% if !prefix.nil? and !prefix.empty? %>
+Prefix: <%= prefix %>
+<% end -%>
 
 Group: <%= category %>
 License: <%= license %>
+<% if !vendor.nil? and !vendor.empty? -%>
 Vendor: <%= vendor %>
+<% end -%>
 URL: <%= url or "http://nourlgiven.example.com/" %>
 Packager: <%= maintainer %>
 
@@ -62,7 +67,7 @@ Obsoletes: <%= repl %>
 <% files.each do |path| -%>
 <%   source = Shellwords.shellescape(File.join(staging_path, path)) -%>
 <%   # Copy to the build_path/BUILD/ to make rpmbuild happy -%>
-<%   target = Shellwords.shellescape(File.join(build_path, "BUILD", path)) -%>
+<%   target = Shellwords.shellescape(File.join(build_path, build_sub_dir, path)) -%>
 <%   dir = File.dirname(target) %>
 mkdir -p <%= dir %>
 if [ -f <%= source %> ] || [ -h <%= source %> ] ; then
@@ -75,31 +80,28 @@ fi
 %clean
 # noop
 
-<% if scripts[:before_install] -%>
-%pre
-<%= scripts[:before_install] %>
-
-<% end -%>
-<% if scripts[:after_install] -%>
-%post
-<%= scripts[:after_install] %>
-
-<% end -%>
-<% if scripts[:before_remove] -%>
-%preun
-<%= scripts[:before_remove] %>
-
+<%# This next section puts any %pre, %post, %preun, or %postun scripts %>
+<% 
+  scriptmap = {
+    :before_install => "pre",
+    :after_install => "post",
+    :before_remove => "preun",
+    :after_remove => "postun",
+  }
+  scriptmap.each do |name, rpmname| 
+-%>
+<%   if script?(name) -%>
+%<%= rpmname %>
+<%= script(name) %>
+
+<%   end -%>
 <% end -%>
-<% if scripts[:after_remove] -%>
-%postun
-<%= scripts[:after_remove] %>
 
-<% end -%>
 %files
 %defattr(-,<%= attributes[:rpm_user] %>,<%= attributes[:rpm_group] %>,-)
 <%# Output config files and then regular files. -%>
 <% config_files.each do |path| -%>
-%config(noreplace) <%= path %>
+%config(noreplace) <%= File.join(prefix, path) %>
 <% end -%>
 <%# list only files, not directories? -%>
 <%= 
@@ -110,12 +112,15 @@ fi
   # The 'files' section of rpm can be 
   # Replace [ with [\[] to make rpm not use globs
   # Replace * with [*] to make rpm not use globs
+  # Replace ? with [?] to make rpm not use globs
   files.collect { |f| "/#{f}" } \
     .reject { |f| config_files.include?(f) } \
     .collect { |f| f[/\s/] and "\"#{f}\"" or f } \
     .collect { |f| f.gsub("[", "[\\[]") } \
     .collect { |f| f.gsub("*", "[*]") } \
-    .join("\n") 
+    .collect { |f| f.gsub("?", "[?]") } \
+    .join("\n")
+    #.collect { |f| File.join(prefix, f) } \
 %>
 
 %changelog

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.6.2
 - !ruby/object:Gem::Dependency
   name: arr-pm
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,6 @@ files:
 - lib/fpm/package/dir.rb
 - lib/fpm/package/puppet.rb
 - lib/fpm/package/solaris.rb
-- lib/fpm/monkeypatches.rb
 - lib/fpm/package.rb
 - lib/fpm/namespace.rb
 - lib/fpm.rb

data/lib/fpm/monkeypatches.rb

@@ -1,11 +0,0 @@
-# Copied from https://raw.github.com/marcandre/backports/master/lib/backports/1.9.3/io.rb
-# Also Hacked just to make it work
-# This is necessary until a newer version of backports (> 2.3.0) is available
-class << IO
-  # Standard in Ruby 1.9.3 See official documentation[http://ruby-doc.org/core-1.9.3/IO.html#method-c-write]
-  def write(name, string, offset = nil, options = Backports::Undefined)
-    File.open(name, "w") do |fd|
-      fd.write(string)
-    end
-  end unless method_defined? :write
-end