fpm 0.4.26 → 0.4.27

data/CHANGELIST

@@ -1,3 +1,20 @@
+0.4.27 (January 16, 2013)
+  - Make all fpm output go through the logger (#329; patch by jaybuff)
+  - New package type: osxpkg, for building packages installable on OS X. (#332,
+    patch by Timothy Sutton)
+  - Fix crash bug when converting rpms to something else (#316, #325; patch by
+    rtucker-mozilla)
+  - deb: Add --deb-field for setting a custom field in the control file.
+    For more information on this setting, see section 5.7 "User-defined fields"
+    of the debian policy manual: 
+    http://www.debian.org/doc/debian-policy/ch-controlfields.html#s5.7
+  - deb: Add --deb-recommends and --deb-suggests (#285, #310; patch by Pranay
+    Kanwar)
+  - python to rpm: convert "!=" dependency operators in python to "Conflicts"
+    in rpm. (#263, #312; patch by Pranay Kanwar)
+  - python: fix bug - ignore blank lines in requirements.txt (#312, patch by
+    Pranay Kanwar)
+
 0.4.26 (December 27, 2012)
   - rpm: add --rpm-sign flag to sign packages using the 'rpmbuild --sign' flag.
     (#311, Patch by Pranay Kanwar)

data/lib/fpm.rb

@@ -6,3 +6,4 @@ require "fpm/package/gem"
 require "fpm/package/deb"
 require "fpm/package/rpm"
 require "fpm/package/python"
+require "fpm/package/osxpkg"

data/lib/fpm/package.rb

@@ -337,7 +337,7 @@ class FPM::Package
   def edit_file(path)
     editor = ENV['FPM_EDITOR'] || ENV['EDITOR'] || 'vi'
     @logger.info("Launching editor", :file => path)
-    safesystem("#{editor} #{Shellwords.escape(path)}")
+    system("#{editor} #{Shellwords.escape(path)}")
 
     if File.size(path) == 0
       raise "Empty file after editing: #{path.inspect}"

data/lib/fpm/package/deb.rb

@@ -77,6 +77,25 @@ class FPM::Package::Deb < FPM::Package
     File.expand_path(file)
   end
 
+  option "--recommends", "PACKAGE", "Add PACKAGE to Recommends" do |pkg|
+    @recommends ||= []
+    @recommends << pkg
+    next @recommends
+  end
+
+  option "--suggests", "PACKAGE", "Add PACKAGE to Suggests" do |pkg|
+    @suggests ||= []
+    @suggests << pkg
+    next @suggests
+  end
+
+  option "--field", "'FIELD: VALUE'", "Add custom field to the control file" do |fv|
+    @custom_fields ||= {}
+    field, value = fv.split(/: */, 2)
+    @custom_fields[field] = value
+    next @custom_fields
+  end
+
   def initialize(*args)
     super(*args)
     attributes[:deb_priority] = "extra"

data/lib/fpm/package/osxpkg.rb

@@ -0,0 +1,165 @@
+require "fpm/package"
+require "fpm/util"
+require "fileutils"
+require "fpm/package/dir"
+require 'tempfile'  # stdlib
+require 'pathname'  # stdlib
+require 'rexml/document'  # stdlib
+
+# Use an OS X pkg built with pkgbuild.
+#
+# Supports input and output. Requires pkgbuild and (for input) pkgutil, part of a
+# standard OS X install in 10.7 and higher.
+class FPM::Package::OSXpkg < FPM::Package
+
+  # Map of what scripts are named.
+  SCRIPT_MAP = {
+    :before_install     => "preinstall",
+    :after_install      => "postinstall",
+  } unless defined?(SCRIPT_MAP)
+
+  POSTINSTALL_ACTIONS = [ "logout", "restart", "shutdown" ]
+  OWNERSHIP_OPTIONS = ["recommended", "preserve", "preserve-other"]
+
+  option "--identifier-prefix", "IDENTIFIER_PREFIX", 
+    "Reverse domain prefix prepended to package identifier, " \
+    "ie. 'org.great.my'. If this is omitted, the identifer " \
+    "will be the package name."
+  option "--payload-free", :flag, "Define no payload, assumes use of script options.",
+    :default => false
+  option "--ownership", "OWNERSHIP",
+    "--ownership option passed to pkgbuild. Defaults to 'recommended'. " \
+    "See pkgbuild(1).", :default => 'recommended' do |value|
+    if !OWNERSHIP_OPTIONS.include?(value)
+      raise ArgumentError, "osxpkg-ownership value of '#{value}' is invalid. " \
+        "Must be one of #{OWNERSHIP_OPTIONS.join(", ")}"
+    end
+    value
+  end
+
+  option "--postinstall-action", "POSTINSTALL_ACTION",
+    "Post-install action provided in package metadata. " \
+    "Optionally one of '#{POSTINSTALL_ACTIONS.join("', '")}'." do |value|
+    if !POSTINSTALL_ACTIONS.include?(value)
+      raise ArgumentError, "osxpkg-postinstall-action value of '#{value}' is invalid. " \
+        "Must be one of #{POSTINSTALL_ACTIONS.join(", ")}"
+    end
+    value
+  end
+
+  dont_obsolete_paths = []
+  option "--dont-obsolete", "DONT_OBSOLETE_PATH",
+    "A file path for which to 'dont-obsolete' in the built PackageInfo. " \
+    "Can be specified multiple times." do |path|
+      dont_obsolete_paths << path
+    end
+
+  private
+  # return the identifier by prepending the reverse-domain prefix
+  # to the package name, else return just the name
+  def identifier
+    identifier = name.dup
+    if self.attributes[:osxpkg_identifier_prefix]
+      identifier.insert(0, "#{self.attributes[:osxpkg_identifier_prefix]}.")
+    end
+    identifier
+  end # def identifier
+
+  # scripts_path and write_scripts cribbed from deb.rb
+  def scripts_path(path=nil)
+    @scripts_path ||= build_path("Scripts")
+    FileUtils.mkdir(@scripts_path) if !File.directory?(@scripts_path)
+
+    if path.nil?
+      return @scripts_path
+    else
+      return File.join(@scripts_path, path)
+    end
+  end # def scripts_path
+
+  def write_scripts
+    SCRIPT_MAP.each do |scriptname, filename|
+      next unless script?(scriptname)
+
+      with(scripts_path(filename)) do |pkgscript|
+        @logger.info("Writing pkg script", :source => filename, :target => pkgscript)
+        File.write(pkgscript, script(scriptname))
+        # scripts are required to be executable
+        File.chmod(0755, pkgscript)
+      end
+    end 
+  end # def write_scripts
+
+  # Returns path of a processed template PackageInfo given to 'pkgbuild --info'
+  # note: '--info' is undocumented:
+  # http://managingosx.wordpress.com/2012/07/05/stupid-tricks-with-pkgbuild 
+  def pkginfo_template_path
+    pkginfo_template = Tempfile.open("fpm-PackageInfo")
+    pkginfo_data = template("osxpkg.erb").result(binding)
+    pkginfo_template.write(pkginfo_data)
+    pkginfo_template.close
+    pkginfo_template.path
+  end # def write_pkginfo_template
+
+  # Extract name and version from PackageInfo XML
+  def extract_info(package)
+    with(build_path("expand")) do |path|
+      doc = REXML::Document.new File.open(File.join(path, "PackageInfo"))
+      pkginfo_elem = doc.elements["pkg-info"]
+      identifier = pkginfo_elem.attribute("identifier").value
+      self.version = pkginfo_elem.attribute("version").value
+      # set name to the last dot element of the identifier
+      self.name = identifier.split(".").last
+      @logger.info("inferring name #{self.name} from pkg-id #{identifier}")
+    end
+  end # def extract_info
+
+  # Take a flat package as input
+  def input(input_path)
+    # TODO: Fail if it's a Distribution pkg or old-fashioned
+    expand_dir = File.join(build_path, "expand")
+    # expand_dir must not already exist for pkgutil --expand
+    safesystem("pkgutil --expand #{input_path} #{expand_dir}")
+
+    extract_info(input_path)
+
+    # extract Payload
+    safesystem("tar -xz -f #{expand_dir}/Payload -C #{staging_path}")
+  end # def input
+
+  # Output a pkgbuild pkg.
+  def output(output_path)
+    output_check(output_path)
+    raise FileAlreadyExists.new(output_path) if File.exists?(output_path)
+
+    temp_info = pkginfo_template_path
+
+    args = ["--identifier", identifier,
+            "--info", temp_info,
+            "--version", version.to_s,
+            "--ownership", attributes[:osxpkg_ownership]]
+
+    if self.attributes[:osxpkg_payload_free?]
+      args << "--nopayload"
+    else
+      args += ["--root", staging_path]
+    end
+
+    if attributes[:before_install_given?] or attributes[:after_install_given?]
+      write_scripts
+      args += ["--scripts", scripts_path]
+    end
+    args << output_path
+
+    safesystem("pkgbuild", *args)
+    FileUtils.remove_file(temp_info)
+  end # def output
+
+  def to_s(format=nil)
+    return super("NAME-VERSION.pkg") if format.nil?
+    return super(format)
+  end # def to_s
+
+  public(:input, :output, :identifier, :to_s)
+
+end # class FPM::Package::OSXpkg

data/lib/fpm/package/pyfpm/get_metadata.py

@@ -1,76 +1,62 @@
 from distutils.core import Command
-import re
-import time
 import pkg_resources
 try:
     import json
 except ImportError:
     import simplejson as json
 
+
 # Note, the last time I coded python daily was at Google, so it's entirely
 # possible some of my techniques below are outdated or bad.
 # If you have fixes, let me know.
 
-
 class get_metadata(Command):
-  description = "get package metadata"
-  user_options = []
-
-  def initialize_options(self):
-    pass
-  # def initialize_options
-
-  def finalize_options(self):
-    pass
-  # def finalize_options
-
-  def run(self):
-    #print type(self.distribution)
-    #for i in sorted(dir(self.distribution)):
-      #if i.startswith("_"):
-        #continue
-      ###print "%s: %r" % (i, self.__getattr__(i))
-      #print "%s" % i
-
-    data = {
-      "name": self.distribution.get_name(),
-      "version": self.distribution.get_version(),
-      "author": "%s <%s>" % (self.distribution.get_author(),
-        self.distribution.get_author_email()),
-      "description": self.distribution.get_description(),
-      "license": self.distribution.get_license(),
-      "url": self.distribution.get_url(),
-    }
-
-    # If there are python C/extension modules, we'll want to build a native
-    # arch package.
-    if self.distribution.has_ext_modules():
-      data["architecture"] = "native"
-    else:
-      data["architecture"] = "all"
-    # end if
-
-    final_deps = []
-    if getattr(self.distribution, 'install_requires', None):
-        for dep in pkg_resources.parse_requirements(self.distribution.install_requires):
-            # add all defined specs to the dependecy list separately.
-            if dep.specs:
-                for operator, version in dep.specs:
-                    final_deps.append("%s %s %s" % (
-                        dep.project_name,
-                        "=" if operator == "==" else operator,
-                        version
-                    ))
-            else:
-                final_deps.append(dep.project_name)            
-
-    data["dependencies"] = final_deps
-
-    #print json.dumps(data, indent=2)
-    if hasattr(json, 'dumps'):
-        print(json.dumps(data, indent=2))
-    else:
-        # For Python 2.5 and Debian's python-json
-        print(json.write(data))
-  # def run
-# class list_dependencies
+    description = "get package metadata"
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        data = {
+            "name": self.distribution.get_name(),
+            "version": self.distribution.get_version(),
+            "author": "%s <%s>" % (
+                self.distribution.get_author(),
+                self.distribution.get_author_email()
+            ),
+            "description": self.distribution.get_description(),
+            "license": self.distribution.get_license(),
+            "url": self.distribution.get_url(),
+        }
+
+        if self.distribution.has_ext_modules():
+            data["architecture"] = "native"
+        else:
+            data["architecture"] = "all"
+
+        final_deps = []
+        if getattr(self.distribution, 'install_requires', None):
+            for dep in pkg_resources.parse_requirements(
+                    self.distribution.install_requires):
+                # add all defined specs to the dependecy list separately.
+                if dep.specs:
+                    for operator, version in dep.specs:
+                        final_deps.append("%s %s %s" % (
+                            dep.project_name,
+                            (lambda x: "=" if x == "==" else x)(operator),
+                            version
+                        ))
+                else:
+                    final_deps.append(dep.project_name)
+
+        data["dependencies"] = final_deps
+
+        if hasattr(json, 'dumps'):
+            print(json.dumps(data, indent=2))
+        else:
+            # For Python 2.5 and Debian's python-json
+            print(json.write(data))

data/lib/fpm/package/python.rb

@@ -43,6 +43,11 @@ class FPM::Package::Python < FPM::Package
   option "--fix-dependencies", :flag, "Should the package dependencies be " \
     "prefixed?", :default => true
 
+  option "--downcase-name", :flag, "Should the target package name be in " \
+    "lowercase?", :default => true
+  option "--downcase-dependencies", :flag, "Should the package dependencies " \
+    "be in lowercase?", :default => true
+
   option "--install-bin", "BIN_PATH", "The path to where python scripts " \
     "should be installed to.", :default => "/usr/bin"
   option "--install-lib", "LIB_PATH", "The path to where python libs " \
@@ -105,12 +110,12 @@ class FPM::Package::Python < FPM::Package
 
     if attributes[:python_pip].nil?
       # no pip, use easy_install
-      puts "EASY_INSTALL"
+      @logger.debug("no pip, defaulting to easy_install", :easy_install => attributes[:python_easyinstall])
       safesystem(attributes[:python_easyinstall], "-i",
                  attributes[:python_pypi], "--editable", "-U",
                  "--build-directory", target, want_pkg)
     else
-      puts "PIP PIP CHEERIOS"
+      @logger.debug("using pip", :pip => attributes[:python_pip])
       safesystem(attributes[:python_pip], "install", "--no-install",
                  "-U", "--build", target, want_pkg)
     end
@@ -169,6 +174,9 @@ class FPM::Package::Python < FPM::Package
       self.name = metadata["name"]
     end
 
+    # convert python-Foo to python-foo if flag is set
+    self.name = self.name.downcase if attributes[:python_downcase_name?]
+
     requirements_txt = File.join(setup_dir, "requirements.txt")
     if File.exists?(requirements_txt)
       @logger.info("Found requirements.txt, using it instead of setup.py " \
@@ -182,13 +190,14 @@ class FPM::Package::Python < FPM::Package
       # requirements.txt can have dependencies, flags, and comments.
       # We only want the comments, so remove comment and flag lines.
       metadata["dependencies"] = File.read(requirements_txt).split("\n") \
+        .reject { |l| l =~ /^\s*$/ } \
         .reject { |l| l =~ /^\s*#/ } \
         .reject { |l| l =~ /^-/ } \
         .map(&:strip)
     end
 
     self.dependencies += metadata["dependencies"].collect do |dep|
-      dep_re = /^([^<>= ]+)\s*(?:([<>=]{1,2})\s*(.*))?$/
+      dep_re = /^([^<>!= ]+)\s*(?:([<>!=]{1,2})\s*(.*))?$/
       match = dep_re.match(dep)
       if match.nil?
         @logger.error("Unable to parse dependency", :dependency => dep)
@@ -199,6 +208,9 @@ class FPM::Package::Python < FPM::Package
       # become 'python-foo' (depending on what the python_package_name_prefix
       # is)
       name = fix_name(name) if attributes[:python_fix_dependencies?]
+
+      # convert dependencies from python-Foo to python-foo
+      name = name.downcase if attributes[:python_downcase_dependencies?]
       "#{name} #{cmp} #{version}"
     end
   end # def load_package_info

data/lib/fpm/package/rpm.rb

@@ -143,6 +143,19 @@ class FPM::Package::RPM < FPM::Package
       end
       #self.provides << "rubygem(#{self.name})"
     end
+
+    # Convert != dependency as Conflict =, as rpm doesn't understand !=
+    if origin == FPM::Package::Python
+      self.dependencies = self.dependencies.select do |dep|
+        name, op, version = dep.split(/\s+/)
+        dep_ok = true
+        if op == '!='
+          self.conflicts << "#{name} = #{version}"
+          dep_ok = false
+        end
+        dep_ok
+      end
+    end
   end # def converted
 
   def input(path)
@@ -187,7 +200,15 @@ class FPM::Package::RPM < FPM::Package
     #input.replaces += replaces
     
     self.config_files += rpm.config_files
-    self.directories += rpm.directories
+
+    # rpms support '%dir' things for specifying empty directories to package,
+    # but the rpm header itself doesn't actually record this information.
+    # so there's no 'directories' to copy, so don't try to merge in the
+    # 'directories' feature. 
+    # TODO(sissel): If you want this feature, we'll have to find scan
+    # the extracted rpm for empty directories. I'll wait until someone asks for
+    # this feature
+    #self.directories += rpm.directories
 
     # Extract to the staging directory
     rpm.extract(staging_path)
@@ -249,7 +270,9 @@ class FPM::Package::RPM < FPM::Package
   # The default epoch value must be 1 (backward compatibility for rpms built
   # with fpm 0.4.3 and older)
   def epoch
-    return @epoch || "1"
+    return 1 if @epoch.nil?
+    return nil if @epoch.empty?
+    return @epoch
   end # def epoch
 
   def to_s(format=nil)

data/lib/fpm/util.rb

@@ -1,4 +1,5 @@
 require "fpm/namespace"
+require "open4"
 
 # Some utility functions
 module FPM::Util
@@ -27,9 +28,17 @@ module FPM::Util
     end
 
     @logger.debug("Running command", :args => args)
-    success = system(*args)
+    
+    status = Open4::popen4(*args) do |pid, stdin, stdout, stderr|
+      stdin.close
+
+      @logger.debug("Process is running", :pid => pid)
+      @logger.pipe(stdout => :info, stderr => :error)
+    end
+    success = (status.exitstatus == 0)
+
     if !success
-      raise ProcessFailed.new("#{program} failed (exit code #{$?.exitstatus})" \
+      raise ProcessFailed.new("#{program} failed (exit code #{status.exitstatus})" \
                               ". Full command was:#{args.inspect}")
     end
     return success

data/lib/fpm/version.rb

@@ -1,3 +1,3 @@
 module FPM
-  VERSION = "0.4.26"
+  VERSION = "0.4.27"
 end

data/templates/deb.erb

@@ -22,6 +22,12 @@ Provides: <%= provides.map {|p| p.split(" ").first}.join ", " %>
 <% if !replaces.empty? -%>
 Replaces: <%= replaces.join(", ") %>
 <% end -%>
+<% if attributes[:deb_recommends_given?] -%>
+Recommends: <%= attributes[:deb_recommends].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
+<% if attributes[:deb_suggests_given?] -%>
+Suggests: <%= attributes[:deb_suggests].collect { |d| fix_dependency(d) }.flatten.join(", ") %>
+<% end -%>
 Section: <%= category %>
 Priority: <%= attributes[:deb_priority] %>
 Homepage: <%= url or "http://nourlgiven.example.com/" %>
@@ -31,3 +37,8 @@ Description: <%= firstline %>
 <% if remainder.any? -%>
 <%= remainder.collect { |l| l =~ /^ *$/ ? " ." : " #{l}" }.join("\n") %>
 <% end -%>
+<% if attributes[:deb_field_given?] -%>
+<%   attributes[:deb_field].each do |field, value| -%>
+<%= field %>: <%= value %>
+<%   end -%>
+<% end -%>

data/templates/osxpkg.erb

@@ -0,0 +1,11 @@
+<pkg-info 
+<% if !attributes[:osxpkg_postinstall_action].nil? -%>postinstall-action="<%= attributes[:osxpkg_postinstall_action] %>"<% end -%>
+>
+<% if !attributes[:osxpkg_dont_obsolete].nil? -%>
+    <dont-obsolete>
+    <% attributes[:osxpkg_dont_obsolete].each do |filepath| -%>
+        <file path="<%= filepath %>"/>
+    <% end -%>
+    </dont-obsolete>
+<% end -%>
+</pkg-info>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm
 version: !ruby/object:Gem::Version
-  version: 0.4.26
+  version: 0.4.27
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: backports
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rush
   requirement: !ruby/object:Gem::Requirement
@@ -152,31 +168,33 @@ files:
 - lib/fpm/command.rb
 - lib/fpm/namespace.rb
 - lib/fpm/package.rb
+- lib/fpm/errors.rb
+- lib/fpm/version.rb
+- lib/fpm/package/gem.rb
+- lib/fpm/package/dir.rb
+- lib/fpm/package/pyfpm/__init__.pyc
 - lib/fpm/package/pyfpm/get_metadata.pyc
 - lib/fpm/package/pyfpm/get_metadata.py
-- lib/fpm/package/pyfpm/__init__.pyc
 - lib/fpm/package/pyfpm/__init__.py
-- lib/fpm/package/tar.rb
+- lib/fpm/package/osxpkg.rb
+- lib/fpm/package/npm.rb
+- lib/fpm/package/pear.rb
 - lib/fpm/package/deb.rb
-- lib/fpm/package/dir.rb
-- lib/fpm/package/puppet.rb
-- lib/fpm/package/gem.rb
 - lib/fpm/package/python.rb
-- lib/fpm/package/solaris.rb
 - lib/fpm/package/rpm.rb
-- lib/fpm/package/npm.rb
-- lib/fpm/package/pear.rb
-- lib/fpm/version.rb
-- lib/fpm/errors.rb
+- lib/fpm/package/puppet.rb
+- lib/fpm/package/tar.rb
+- lib/fpm/package/solaris.rb
 - lib/fpm/util.rb
 - lib/fpm.rb
 - bin/fpm-npm
 - bin/fpm
-- templates/solaris.erb
-- templates/rpm.erb
 - templates/deb.erb
+- templates/rpm.erb
+- templates/solaris.erb
 - templates/puppet/package/remove.pp.erb
 - templates/puppet/package.pp.erb
+- templates/osxpkg.erb
 - LICENSE
 - CONTRIBUTORS
 - CHANGELIST
@@ -206,3 +224,4 @@ signing_key:
 specification_version: 3
 summary: fpm - package building and mangling
 test_files: []
+has_rdoc: