fpm 1.3.3 → 1.4.0

data/lib/fpm/package/deb.rb

@@ -23,7 +23,7 @@ class FPM::Package::Deb < FPM::Package
   # The list of supported compression types. Default is gz (gzip)
   COMPRESSION_TYPES = [ "gz", "bzip2", "xz" ]
 
-  option "--ignore-iteration-in-dependencies", :flag, 
+  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 " \
             "version of a package but any iteration is permitted"
@@ -73,10 +73,10 @@ class FPM::Package::Deb < FPM::Package
     value.to_i
   end
 
-  option "--priority", "PRIORITY", 
+  option "--priority", "PRIORITY",
     "The debian package 'priority' value.", :default => "extra"
 
-  option "--use-file-permissions", :flag, 
+  option "--use-file-permissions", :flag,
     "Use existing file permissions when defining ownership and modes"
 
   option "--user", "USER", "The owner of files in this package", :default => 'root'
@@ -124,6 +124,10 @@ class FPM::Package::Deb < FPM::Package
     next @custom_fields
   end
 
+  option "--no-default-config-files", :flag,
+    "Do not add all files in /etc as configuration files by default for Debian packages.",
+    :default => false
+
   option "--shlibs", "SHLIBS", "Include control/shlibs content. This flag " \
     "expects a string that is used as the contents of the shlibs file. " \
     "See the following url for a description of this file and its format: " \
@@ -162,7 +166,7 @@ class FPM::Package::Deb < FPM::Package
         @architecture = %x{dpkg --print-architecture 2> /dev/null}.chomp
         if $?.exitstatus != 0 or @architecture.empty?
           # if dpkg fails or emits nothing, revert back to uname -m
-          @architecture = %x{uname -m}.chomp 
+          @architecture = %x{uname -m}.chomp
         end
       else
         @architecture = %x{uname -m}.chomp
@@ -209,7 +213,7 @@ class FPM::Package::Deb < FPM::Package
 
     return @name
   end # def name
-  
+
   def prefix
     return (attributes[:prefix] or "/")
   end # def prefix
@@ -227,7 +231,7 @@ class FPM::Package::Deb < FPM::Package
 
       control = File.read(File.join(path, "control"))
 
-      parse = lambda do |field| 
+      parse = lambda do |field|
         value = control[/^#{field.capitalize}: .*/]
         if value.nil?
           return nil
@@ -267,6 +271,22 @@ class FPM::Package::Deb < FPM::Package
       #self.config_files = config_files
 
       self.dependencies += parse_depends(parse.call("Depends")) if !attributes[:no_auto_depends?]
+
+      if File.file?(File.join(path, "preinst"))
+        self.scripts[:before_install] = File.read(File.join(path, "preinst"))
+      end
+      if File.file?(File.join(path, "postinst"))
+        self.scripts[:after_install] = File.read(File.join(path, "postinst"))
+      end
+      if File.file?(File.join(path, "prerm"))
+        self.scripts[:before_remove] = File.read(File.join(path, "prerm"))
+      end
+      if File.file?(File.join(path, "postrm"))
+        self.scripts[:after_remove] = File.read(File.join(path, "postrm"))
+      end
+      if File.file?(File.join(path, "conffiles"))
+        self.config_files = File.read(File.join(path, "conffiles")).split("\n")
+      end
     end
   end # def extract_info
 
@@ -289,7 +309,7 @@ class FPM::Package::Deb < FPM::Package
       m = dep_re.match(dep)
       if m
         name, op, version = m.captures
-        # deb uses ">>" and "<<" for greater and less than respectively. 
+        # deb uses ">>" and "<<" for greater and less than respectively.
         # fpm wants just ">" and "<"
         op = "<" if op == "<<"
         op = ">" if op == ">>"
@@ -309,10 +329,10 @@ class FPM::Package::Deb < FPM::Package
       when "gz"
         datatar = "data.tar.gz"
         compression = "-z"
-      when "bzip2" 
+      when "bzip2"
         datatar = "data.tar.bz2"
         compression = "-j"
-      when "xz" 
+      when "xz"
         datatar = "data.tar.xz"
         compression = "-J"
       else
@@ -373,7 +393,7 @@ class FPM::Package::Deb < FPM::Package
       when "gz", nil
         datatar = build_path("data.tar.gz")
         compression = "-z"
-      when "bzip2" 
+      when "bzip2"
         datatar = build_path("data.tar.bz2")
         compression = "-j"
       when "xz"
@@ -577,7 +597,7 @@ class FPM::Package::Deb < FPM::Package
     with(build_path("control.tar.gz")) do |controltar|
       logger.info("Creating", :path => controltar, :from => control_path)
 
-      args = [ tar_cmd, "-C", control_path, "-zcf", controltar, 
+      args = [ tar_cmd, "-C", control_path, "-zcf", controltar,
         "--owner=0", "--group=0", "--numeric-owner", "." ]
       safesystem(*args)
     end
@@ -637,33 +657,48 @@ class FPM::Package::Deb < FPM::Package
         # deb maintainer scripts are required to be executable
         File.chmod(0755, controlscript)
       end
-    end 
+    end
   end # def write_scripts
 
   def write_conffiles
-    return unless config_files.any?
-
-    # scan all conf file paths for files and add them
     allconfigs = []
-    config_files.each do |path|
+
+    # expand recursively a given path to be put in allconfigs
+    def add_path(path, allconfigs)
       # Strip leading /
       path = path[1..-1] if path[0,1] == "/"
       cfg_path = File.expand_path(path, staging_path)
+      Find.find(cfg_path).select { |p| File.file?(p) }.each do |p|
+        allconfigs << p.gsub("#{staging_path}/", '')
+      end
+    end
+
+    # scan all conf file paths for files and add them
+    config_files.each do |path|
       begin
-        Find.find(cfg_path) do |p|
-          allconfigs << p.gsub("#{staging_path}/", '') if File.file? p
-        end
-      rescue Errno::ENOENT => e
+        add_path(path, allconfigs)
+      rescue Errno::ENOENT
         raise FPM::InvalidPackageConfiguration,
-          "Error trying to use '#{cfg_path}' as a config file in the package. Does it exist?"
+          "Error trying to use '#{path}' as a config file in the package. Does it exist?"
+      end
+    end
+
+    # Also add everything in /etc
+    begin
+      if !attributes[:deb_no_default_config_files?]
+        logger.warn("Debian packaging tools generally labels all files in /etc as config files, " \
+                    "as mandated by policy, so fpm defaults to this behavior for deb packages. " \
+                    "You can disable this default behavior with --deb-no-default-config-files flag")
+        add_path("/etc", allconfigs)
       end
+    rescue Errno::ENOENT
     end
+
     allconfigs.sort!.uniq!
+    return unless allconfigs.any?
 
     with(control_path("conffiles")) do |conffiles|
       File.open(conffiles, "w") do |out|
-        # 'config_files' comes from FPM::Package and is usually set with
-        # FPM::Command's --config-files flag
         allconfigs.each do |cf|
           # We need to put the leading / back. Stops lintian relative-conffile error.
           out.puts("/" + cf)
@@ -679,6 +714,7 @@ class FPM::Package::Deb < FPM::Package
     File.open(control_path("shlibs"), "w") do |out|
       out.write(attributes[:deb_shlibs])
     end
+    File.chmod(0644, control_path("shlibs"))
   end # def write_shlibs
 
   def write_debconf

data/lib/fpm/package/dir.rb

@@ -75,7 +75,7 @@ class FPM::Package::Dir < FPM::Package
         end
       end
     rescue Errno::ENOENT => e
-      raise FPM::InvalidPackageConfiguration, 
+      raise FPM::InvalidPackageConfiguration,
         "Cannot chdir to '#{chdir}'. Does it exist?"
     end
 
@@ -133,14 +133,14 @@ class FPM::Package::Dir < FPM::Package
 
     # For single file copies, permit file destinations
     fileinfo = File.lstat(source)
-    if fileinfo.file? && !File.directory?(destination) 
+    if fileinfo.file? && !File.directory?(destination)
       if destination[-1,1] == "/"
         copy(source, File.join(destination, source))
       else
         copy(source, destination)
       end
     elsif fileinfo.symlink?
-      copy(source, destination)
+      copy(source, File.join(destination, source))
     else
       # Copy all files from 'path' into staging_path
       Find.find(source) do |path|
@@ -157,8 +157,17 @@ class FPM::Package::Dir < FPM::Package
   def copy(source, destination)
     logger.debug("Copying path", :source => source, :destination => destination)
     directory = File.dirname(destination)
-    if !File.directory?(directory)
+    # lstat to follow symlinks
+    dstat = File.stat(directory) rescue nil
+    if dstat.nil?
       FileUtils.mkdir_p(directory)
+    elsif dstat.directory?
+      # do nothing, it's already a directory!
+    else
+      # It exists and is not a directory. This is probably a user error or a bug.
+      readable_path = directory.gsub(staging_path, "")
+      logger.error("You wanted to copy a file into a directory, but that's not a directory, it's a file!", :path => readable_path, :stat => dstat)
+      raise FPM::InvalidPackageConfiguration, "Tried to treat #{readable_path} like a directory, but it's a file!"
     end
 
     if File.directory?(source)
@@ -194,27 +203,5 @@ class FPM::Package::Dir < FPM::Package
     copy_metadata(source, destination)
   end # def copy
 
-  def copy_metadata(source, destination)
-    source_stat = File::lstat(source)
-    dest_stat = File::lstat(destination)
-
-    # If this is a hard-link, there's no metadata to copy.
-    # 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.lchown(source_stat.uid, source_stat.gid, destination)
-    rescue Errno::EPERM
-      # clear setuid/setgid
-      mode &= 01777
-    end
-
-    unless source_stat.symlink?
-      File.chmod(mode, destination)
-    end
-  end # def copy_metadata
-
   public(:input, :output)
 end # class FPM::Package::Dir

data/lib/fpm/package/empty.rb

@@ -4,4 +4,10 @@ require "backports"
 # Empty Package type. For strict/meta/virtual package creation
 
 class FPM::Package::Empty < FPM::Package
+  def output(output_path)
+    logger.warn("Your package has gone into the void.")
+  end
+  def to_s(fmt)
+    return ""
+  end
 end

data/lib/fpm/package/gem.rb

@@ -58,7 +58,7 @@ class FPM::Package::Gem < FPM::Package
 
   def download_if_necessary(gem, gem_version)
     path = gem
-    if !File.exists?(path)
+    if !File.exist?(path)
       path = download(gem, gem_version)
     end
 
@@ -114,7 +114,7 @@ class FPM::Package::Gem < FPM::Package
     # where missing 'build' number prevents correct dependency resolution by target
     # package manager. Ie. for dpkg 1.1 != 1.1.0
     m = spec.version.to_s.scan(/(\d+)\.?/)
-    self.version = m.flatten.fill('0', m.length..2).join('.') 
+    self.version = m.flatten.fill('0', m.length..2).join('.')
 
     self.vendor = spec.author
     self.url = spec.homepage
@@ -132,7 +132,7 @@ class FPM::Package::Gem < FPM::Package
     self.description = description_options.find { |d| !(d.nil? or d.strip.empty?) }
 
     # Upstream rpms seem to do this, might as well share.
-    # TODO(sissel): Figure out how to hint this only to rpm? 
+    # TODO(sissel): Figure out how to hint this only to rpm?
     # maybe something like attributes[:rpm_provides] for rpm specific stuff?
     # Or just ignore it all together.
     #self.provides << "rubygem(#{self.name})"
@@ -213,7 +213,7 @@ class FPM::Package::Gem < FPM::Package
       end
     end
   end # def install_to_staging
-  
+
   # Sanitize package name.
   # This prefixes the package name with 'rubygem' (but depends on the attribute
   # :gem_package_name_prefix

data/lib/fpm/package/npm.rb

@@ -72,7 +72,7 @@ class FPM::Package::NPM < FPM::Package
     end
 
     self.description = info["description"]
-    # Supposedly you can upload a package for npm with no author/author email 
+    # Supposedly you can upload a package for npm with no author/author email
     # so I'm being safer with this. Author can also be a hash or a string
     self.vendor = "Unknown <unknown@unknown.unknown>"
     if info.include?("author")
@@ -91,7 +91,7 @@ class FPM::Package::NPM < FPM::Package
     # 'npm install express' it installs dependencies (like 'connect')
     # to: node_modules/express/node_modules/connect/...
     #
-    # To that end, I don't think we necessarily need to include 
+    # To that end, I don't think we necessarily need to include
     # any automatic dependency information since every 'npm install'
     # is fully self-contained. That's why you don't see any bother, yet,
     # to include the package's dependencies in here.

data/lib/fpm/package/osxpkg.rb

@@ -21,7 +21,7 @@ class FPM::Package::OSXpkg < FPM::Package
   POSTINSTALL_ACTIONS = [ "logout", "restart", "shutdown" ]
   OWNERSHIP_OPTIONS = ["recommended", "preserve", "preserve-other"]
 
-  option "--identifier-prefix", "IDENTIFIER_PREFIX", 
+  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."
@@ -87,12 +87,12 @@ class FPM::Package::OSXpkg < FPM::Package
         # scripts are required to be executable
         File.chmod(0755, pkgscript)
       end
-    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 
+  # 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)

data/lib/fpm/package/p5p.rb

@@ -0,0 +1,124 @@
+require "erb"
+require "fpm/namespace"
+require "fpm/package"
+require "fpm/errors"
+require "fpm/util"
+
+class FPM::Package::P5P < FPM::Package
+
+  option "--user", "USER",
+    "Set the user to USER in the prototype files.",
+    :default => 'root'
+
+  option "--group", "GROUP",
+    "Set the group to GROUP in the prototype file.",
+    :default => 'root'
+
+  option "--zonetype", "ZONETYPE",
+    "Set the allowed zone types (global, nonglobal, both)",
+    :default => 'value=global value=nonglobal' do |value|
+      case @value
+      when "both"
+        value = "value=global value=nonglobal"
+      else
+        value = "value=#{value}"
+      end
+    end # value
+
+  option "--publisher", "PUBLISHER", 
+    "Set the publisher name for the repository",
+    :default => 'FPM'
+
+  option "--lint" , :flag, "Check manifest with pkglint",
+    :default => true
+
+  option "--validate", :flag, "Validate with pkg install",
+    :default => true
+
+  def architecture
+    case @architecture
+    when nil, "native"
+      @architecture = %x{uname -p}.chomp
+    when "all"
+      @architecture = 'i386 value=sparc'
+    end
+
+    return @architecture
+  end # def architecture
+
+  def output(output_path)
+    
+    # Fixup the category to an acceptable solaris category
+    case @category
+    when nil, "default"
+      @category = 'Applications/System Utilities'
+    end
+
+    # Manifest Filename
+    manifest_fn = build_path("#{name}.p5m")
+
+    # Generate a package manifest.
+    pkg_generate = safesystemout("pkgsend", "generate", "#{staging_path}")
+    File.write(build_path("#{name}.p5m.1"), pkg_generate)
+
+    # Add necessary metadata to the generated manifest.
+    metadata_template = template("p5p_metadata.erb").result(binding)
+    File.write(build_path("#{name}.mog"), metadata_template)
+
+    # Combine template and filelist; allow user to edit before proceeding
+    File.open(manifest_fn, "w") do |manifest|
+      manifest.write metadata_template
+      manifest.write pkg_generate
+    end
+    edit_file(manifest_fn) if attributes[:edit?]
+
+    # Execute the transmogrification on the manifest
+    pkg_mogrify = safesystemout("pkgmogrify", manifest_fn)
+    File.write(build_path("#{name}.p5m.2"), pkg_mogrify)
+    safesystem("cp", build_path("#{name}.p5m.2"), manifest_fn)
+
+    # Evaluate dependencies.
+    if !attributes[:no_auto_depends?]
+	    pkgdepend_gen = safesystemout("pkgdepend", "generate",  "-md", "#{staging_path}",  manifest_fn)
+      File.write(build_path("#{name}.p5m.3"), pkgdepend_gen)
+
+      # Allow user to review added dependencies
+      edit_file(build_path("#{name}.p5m.3")) if attributes[:edit?]
+
+	    safesystem("pkgdepend", "resolve",  "-m", build_path("#{name}.p5m.3"))
+      safesystem("cp", build_path("#{name}.p5m.3.res"), manifest_fn)
+    end
+
+    # Final format of manifest
+    safesystem("pkgfmt", manifest_fn)
+
+    # Final edit for lint check and packaging
+    edit_file(manifest_fn) if attributes[:edit?]
+
+    # Add any facets or actuators that are needed.
+    # TODO(jcraig): add manpage actuator to enable install wo/ man pages
+
+    # Verify the package.
+    if attributes[:p5p_lint] then
+      safesystem("pkglint", manifest_fn)
+    end
+
+    # Publish the package.
+    repo_path = build_path("#{name}_repo")
+    safesystem("pkgrepo", "create", repo_path)
+    safesystem("pkgrepo", "set", "-s", repo_path, "publisher/prefix=#{attributes[:p5p_publisher]}")
+    safesystem("pkgsend", "-s", repo_path,
+      "publish", "-d", "#{staging_path}", "#{build_path}/#{name}.p5m")
+    safesystem("pkgrecv", "-s", repo_path, "-a",
+      "-d", build_path("#{name}.p5p"), name)
+
+    # Test the package
+    if attributes[:p5p_validate] then
+      safesystem("pkg", "install",  "-nvg", build_path("#{name}.p5p"), name)
+    end
+
+    # Cleanup
+    safesystem("mv", build_path("#{name}.p5p"), output_path)
+
+  end # def output
+end # class FPM::Package::IPS