fpm 1.6.1 → 1.14.1

data/lib/fpm/package/rpm.rb

@@ -1,9 +1,12 @@
 require "fpm/package"
-require "backports"
+require "backports/latest"
 require "fileutils"
 require "find"
 require "arr-pm/file" # gem 'arr-pm'
 
+# For conversion handling
+require "fpm/package/gem"
+
 # RPM Package type.
 #
 # Build RPMs without having to waste hours reading Maximum-RPM.
@@ -24,9 +27,10 @@ class FPM::Package::RPM < FPM::Package
 
   COMPRESSION_MAP = {
     "none" => "w0.gzdio",
-    "xz" => "w9.xzdio",
-    "gzip" => "w9.gzdio",
-    "bzip2" => "w9.bzdio"
+    "xz" => ".xzdio",
+    "xzmt" => "T.xzdio",
+    "gzip" => ".gzdio",
+    "bzip2" => ".bzdio"
   } unless defined?(COMPRESSION_MAP)
 
   option "--use-file-permissions", :flag,
@@ -67,6 +71,15 @@ class FPM::Package::RPM < FPM::Package
     value.downcase
   end
 
+  option "--compression-level", "[0-9]", "Select a compression level. 0 is store-only. 9 is max compression.",
+    :default => "9" do |value|
+    valint = value.to_i
+    unless value =~ /^\d$/ && valint >= 0 && valint <= 9
+      raise "Invalid compression level '#{value}'. Valid values are integers between 0 and 9 inclusive."
+    end
+    valint
+  end
+
   option "--compression", COMPRESSION_MAP.keys.join("|"),
     "Select a compression method. gzip works on the most platforms.",
     :default => "gzip" do |value|
@@ -141,6 +154,10 @@ class FPM::Package::RPM < FPM::Package
            "names in rpm requires instead of the redhat style " \
            "rubygem(foo).", :default => false
 
+  option "--macro-expansion", :flag,
+           "install-time macro expansion in %pre %post %preun %postun scripts " \
+           "(see: https://rpm.org/user_doc/scriptlet_expansion.html)", :default => false
+
   option "--verifyscript", "FILE",
     "a script to be run on verification" do |val|
     File.expand_path(val) # Get the full path to the script
@@ -176,14 +193,15 @@ class FPM::Package::RPM < FPM::Package
   # Replace ? with [?] to make rpm not use globs
   # Replace % with [%] to make rpm not expand macros
   def rpm_fix_name(name)
-    name = name.gsub(/(\ |\[|\]|\*|\?|\%|\$)/, {
+    name = name.gsub(/(\ |\[|\]|\*|\?|\%|\$|')/, {
       ' ' => '?',
       '%' => '[%]',
       '$' => '[$]',
       '?' => '[?]',
       '*' => '[*]',
       '[' => '[\[]',
-      ']' => '[\]]'
+      ']' => '[\]]',
+      "'" => "\\'",
     })
   end
 
@@ -225,6 +243,8 @@ class FPM::Package::RPM < FPM::Package
         return %x{uname -m}.chomp   # default to current arch
       when "amd64" # debian and redhat disagree on architecture names
         return "x86_64"
+      when "arm64" # debian and redhat disagree on architecture names
+        return "aarch64"
       when "native"
         return %x{uname -m}.chomp   # 'native' is current arch
       when "all"
@@ -237,6 +257,12 @@ class FPM::Package::RPM < FPM::Package
 
   # This method ensures a default value for iteration if none is provided.
   def iteration
+    if @iteration.kind_of?(String) and @iteration.include?("-")
+      logger.warn("Package iteration '#{@iteration}' includes dashes, converting" \
+                   " to underscores. rpmbuild does not allow the dashes in the package iteration (called 'Release' in rpm)")
+      @iteration = @iteration.gsub(/-/, "_")
+    end
+
     return @iteration ? @iteration : 1
   end # def iteration
 
@@ -472,6 +498,22 @@ class FPM::Package::RPM < FPM::Package
       self.directories = alldirs
     end
 
+    # include external config files
+    (attributes[:config_files] or []).each do |conf|
+      dest_conf = File.join(staging_path, conf)
+
+      if File.exist?(dest_conf)
+        logger.debug("Using --config-file from staging area", :path => conf)
+      elsif File.exist?(conf)
+        logger.info("Copying --config-file from local path", :path => conf)
+        FileUtils.mkdir_p(File.dirname(dest_conf))
+        FileUtils.cp_r conf, dest_conf
+      else
+        logger.error("Failed to find given --config-file", :path => conf)
+        raise "Could not find config file '#{conf}' in staging area or on host. This can happen if you specify `--config-file '#{conf}'` but this file does not exist in the source package and also does not exist in filesystem."
+      end
+    end
+
     # scan all conf file paths for files and add them
     allconfigs = []
     self.config_files.each do |path|
@@ -499,10 +541,11 @@ class FPM::Package::RPM < FPM::Package
     end
 
     # copy all files from staging to BUILD dir
+    # [#1538] Be sure to preserve the original timestamps.
     Find.find(staging_path) do |path|
       src = path.gsub(/^#{staging_path}/, '')
       dst = File.join(build_path, build_sub_dir, src)
-      copy_entry(path, dst)
+      copy_entry(path, dst, preserve=true)
     end
 
     rpmspec = template("rpm.erb").result(binding)
@@ -523,7 +566,11 @@ class FPM::Package::RPM < FPM::Package
   end # def output
 
   def prefix
-    return (attributes[:prefix] or "/")
+    if attributes[:prefix] and attributes[:prefix] != '/'
+      return attributes[:prefix].chomp('/')
+    else
+      return "/"
+    end
   end # def prefix
 
   def build_sub_dir
@@ -533,7 +580,7 @@ class FPM::Package::RPM < FPM::Package
 
   def summary
     if !attributes[:rpm_summary]
-      return @description.split("\n").first || "_"
+      return @description.split("\n").find { |line| !line.strip.empty? } || "_"
     end
 
     return attributes[:rpm_summary]
@@ -576,7 +623,12 @@ class FPM::Package::RPM < FPM::Package
   end # def to_s
 
   def payload_compression
-    return COMPRESSION_MAP[attributes[:rpm_compression]]
+    if attributes[:rpm_compression] == 'none'
+      # when 'none' ignore any compression level and return w0.gzdio
+      return COMPRESSION_MAP[attributes[:rpm_compression]]
+    else
+      return "w#{attributes[:rpm_compression_level]}" + COMPRESSION_MAP[attributes[:rpm_compression]]
+    end
   end # def payload_compression
 
   def digest_algorithm

data/lib/fpm/package/sh.rb

@@ -3,7 +3,7 @@ require "fpm/namespace"
 require "fpm/package"
 require "fpm/errors"
 require "fpm/util"
-require "backports"
+require "backports/latest"
 require "fileutils"
 require "digest"
 

data/lib/fpm/package/snap.rb

@@ -0,0 +1,130 @@
+require "yaml"
+
+require "fpm/package"
+require "fpm/util"
+require "fileutils"
+require "fpm/package/dir"
+
+# Support for snaps (.snap files).
+#
+# This supports the input and output of snaps.
+class FPM::Package::Snap < FPM::Package
+
+  option "--yaml", "FILEPATH",
+    "Custom version of the snap.yaml file." do | snap_yaml |
+    File.expand_path(snap_yaml)
+  end
+
+  option "--confinement", "CONFINEMENT",
+    "Type of confinement to use for this snap.",
+    default: "devmode" do | confinement |
+    if ['strict', 'devmode', 'classic'].include? confinement
+      confinement
+    else
+      raise "Unsupported confinement type '#{confinement}'"
+    end
+  end
+
+  option "--grade", "GRADE", "Grade of this snap.",
+    default: "devel" do | grade |
+    if ['stable', 'devel'].include? grade
+      grade
+    else
+      raise "Unsupported grade type '#{grade}'"
+    end
+  end
+
+   # Input a snap
+  def input(input_snap)
+    extract_snap_to_staging input_snap
+    extract_snap_metadata_from_staging
+  end # def input
+
+  # Output a snap.
+  def output(output_snap)
+    output_check(output_snap)
+
+    write_snap_yaml
+
+    # Create the snap from the staging path
+    safesystem("mksquashfs", staging_path, output_snap, "-noappend", "-comp",
+               "xz", "-no-xattrs", "-no-fragments", "-all-root")
+  end # def output
+
+  def to_s(format=nil)
+    # Default format if nil
+    # name_version_arch.snap
+    return super(format.nil? ? "NAME_FULLVERSION_ARCH.EXTENSION" : format)
+  end # def to_s
+
+  private
+
+  def extract_snap_to_staging(snap_path)
+    safesystem("unsquashfs", "-f", "-d", staging_path, snap_path)
+  end
+
+  def extract_snap_metadata_from_staging
+    metadata = YAML.safe_load(File.read(
+      staging_path(File.join("meta", "snap.yaml"))))
+
+    self.name = metadata["name"]
+    self.version = metadata["version"]
+    self.description = metadata["summary"] + "\n" + metadata["description"]
+    self.architecture = metadata["architectures"][0]
+    self.attributes[:snap_confinement] = metadata["confinement"]
+    self.attributes[:snap_grade] = metadata["grade"]
+
+    if metadata["apps"].nil?
+      attributes[:snap_apps] = []
+    else
+      attributes[:snap_apps] = metadata["apps"]
+    end
+
+    if metadata["hooks"].nil?
+      attributes[:snap_hooks] = []
+    else
+      attributes[:snap_hooks] = metadata["hooks"]
+    end
+  end
+
+  def write_snap_yaml
+    # Write the snap.yaml
+    if attributes[:snap_yaml]
+      logger.debug("Using '#{attributes[:snap_yaml]}' as the snap.yaml")
+      yaml_data = File.read(attributes[:snap_yaml])
+    else
+      summary, *remainder = (self.description or "no summary given").split("\n")
+      description = "no description given"
+      if remainder.any?
+        description = remainder.join("\n")
+      end
+
+      yaml_data = {
+        "name" => self.name,
+        "version" => self.version,
+        "summary" => summary,
+        "description" => description,
+        "architectures" => [self.architecture],
+        "confinement" => self.attributes[:snap_confinement],
+        "grade" => self.attributes[:snap_grade],
+      }
+
+      unless attributes[:snap_apps].nil? or attributes[:snap_apps].empty?
+        yaml_data["apps"] = attributes[:snap_apps]
+      end
+
+      unless attributes[:snap_hooks].nil? or attributes[:snap_hooks].empty?
+        yaml_data["hooks"] = attributes[:snap_hooks]
+      end
+
+      yaml_data = yaml_data.to_yaml
+    end
+
+    FileUtils.mkdir_p(staging_path("meta"))
+    snap_yaml_path = staging_path(File.join("meta", "snap.yaml"))
+    logger.debug("Writing snap.yaml", :path => snap_yaml_path)
+    File.write(snap_yaml_path, yaml_data)
+    File.chmod(0644, snap_yaml_path)
+    edit_file(snap_yaml_path) if attributes[:edit?]
+  end # def write_snap_yaml
+end # class FPM::Package::Snap

data/lib/fpm/package/tar.rb

@@ -1,4 +1,4 @@
-require "backports" # gem backports
+require "backports/latest" # gem backports/latest
 require "fpm/package"
 require "fpm/util"
 require "fileutils"
@@ -50,15 +50,7 @@ class FPM::Package::Tar < FPM::Package
     output_check(output_path)
 
     # Write the scripts, too.
-    scripts_path = File.join(staging_path, ".scripts")
-    ::Dir.mkdir(scripts_path)
-    [:before_install, :after_install, :before_remove, :after_remove].each do |name|
-      next unless script?(name)
-      out = File.join(scripts_path, name.to_s)
-      logger.debug("Writing script", :source => name, :target => out)
-      File.write(out, script(name))
-      File.chmod(0755, out)
-    end
+    write_scripts
 
     # Unpack the tarball to the staging path
     args = ["-cf", output_path, "-C", staging_path]

data/lib/fpm/package/virtualenv.rb

@@ -2,6 +2,8 @@ require "fpm/namespace"
 require "fpm/package"
 require "fpm/util"
 
+require "fpm/package/dir"
+
 # Support for python virtualenv packages.
 #
 # This supports input, but not output.
@@ -15,8 +17,11 @@ class FPM::Package::Virtualenv < FPM::Package
   option "--package-name-prefix", "PREFIX", "Name to prefix the package " \
   "name with.", :default => "virtualenv"
 
-  option "--install-location", "DIRECTORY", "Location to which to " \
-  "install the virtualenv by default.", :default => "/usr/share/python" do |path|
+  option "--install-location", "DIRECTORY", "DEPRECATED: Use --prefix instead." \
+    "  Location to which to install the virtualenv by default.",
+    :default => "/usr/share/python" do |path|
+    logger.warn("Using deprecated flag: --install-location. Please use " \
+                  "--prefix instead.")
     File.expand_path(path)
   end
 
@@ -30,6 +35,19 @@ class FPM::Package::Virtualenv < FPM::Package
     :multivalued => true, :attribute_name => :virtualenv_pypi_extra_index_urls,
     :default => nil
 
+  option "--setup-install", :flag, "After building virtualenv run setup.py install "\
+  "useful when building a virtualenv for packages and including their requirements from "
+  "requirements.txt"
+
+  option "--system-site-packages", :flag, "Give the virtual environment access to the "\
+  "global site-packages"
+
+  option "--find-links", "PIP_FIND_LINKS", "If a url or path to an html file, then parse for "\
+    "links to archives. If a local path or file:// url that's a directory, then look "\
+    "for archives in the directory listing.",
+    :multivalued => true, :attribute_name => :virtualenv_find_links_urls,
+    :default => nil
+
   private
 
   # Input a package.
@@ -40,7 +58,18 @@ class FPM::Package::Virtualenv < FPM::Package
     m = /^([^=]+)==([^=]+)$/.match(package)
     package_version = nil
 
-    if m
+    is_requirements_file = (File.basename(package) == "requirements.txt")
+
+    if is_requirements_file
+      if !File.file?(package)
+        raise FPM::InvalidPackageConfiguration, "Path looks like a requirements.txt, but it doesn't exist: #{package}"
+      end
+
+      package = File.join(::Dir.pwd, package) if File.dirname(package) == "."
+      package_name = File.basename(File.dirname(package))
+      logger.info("No name given. Using the directory's name", :name => package_name)
+      package_version = nil
+    elsif m
       package_name = m[1]
       package_version = m[2]
       self.version ||= package_version
@@ -58,23 +87,33 @@ class FPM::Package::Virtualenv < FPM::Package
                    self.name].join("-")
     end
 
+    # prefix wins over previous virtual_install_location behaviour
     virtualenv_folder =
-      File.join(installdir,
-                virtualenv_name)
+      if self.attributes[:prefix]
+        self.attributes[:prefix]
+      else
+        File.join(installdir,
+                  virtualenv_name)
+      end
 
     virtualenv_build_folder = build_path(virtualenv_folder)
 
     ::FileUtils.mkdir_p(virtualenv_build_folder)
 
-    safesystem("virtualenv", virtualenv_build_folder)
+    if self.attributes[:virtualenv_system_site_packages?]
+        logger.info("Creating virtualenv with --system-site-packages")
+        safesystem("virtualenv", "--system-site-packages", virtualenv_build_folder)
+    else
+        safesystem("virtualenv", virtualenv_build_folder)
+    end
+
     pip_exe = File.join(virtualenv_build_folder, "bin", "pip")
     python_exe = File.join(virtualenv_build_folder, "bin", "python")
 
     # Why is this hack here? It looks important, so I'll keep it in.
-    safesystem(pip_exe, "install", "-U", "-i",
+    safesystem(python_exe, pip_exe, "install", "-U", "-i",
                attributes[:virtualenv_pypi],
-               "pip", "distribute")
-    safesystem(pip_exe, "uninstall", "-y", "distribute")
+               "pip")
 
     extra_index_url_args = []
     if attributes[:virtualenv_pypi_extra_index_urls]
@@ -82,12 +121,34 @@ class FPM::Package::Virtualenv < FPM::Package
         extra_index_url_args << "--extra-index-url" << extra_url
       end
     end
-    pip_args = [pip_exe, "install", "-i", attributes[:virtualenv_pypi]] << extra_index_url_args << package
+
+    find_links_url_args = []
+    if attributes[:virtualenv_find_links_urls]
+      attributes[:virtualenv_find_links_urls].each do |links_url|
+        find_links_url_args << "--find-links" << links_url
+      end
+    end
+
+    target_args = []
+    if is_requirements_file
+      target_args << "-r" << package
+    else
+      target_args << package
+    end
+
+    pip_args = [python_exe, pip_exe, "install", "-i", attributes[:virtualenv_pypi]] << extra_index_url_args << find_links_url_args << target_args
     safesystem(*pip_args.flatten)
 
-    if package_version.nil?
-      frozen = safesystemout(pip_exe, "freeze")
-      package_version = frozen[/#{package}==[^=]+$/].split("==")[1].chomp!
+    if attributes[:virtualenv_setup_install?]
+      logger.info("Running PACKAGE setup.py")
+      setup_args = [python_exe, "setup.py", "install"]
+      safesystem(*setup_args.flatten)
+    end
+
+    if ! is_requirements_file && package_version.nil?
+      frozen = safesystemout(python_exe, pip_exe, "freeze")
+      frozen_version = frozen[/#{package}==[^=]+$/]
+      package_version = frozen_version && frozen_version.split("==")[1].chomp!
       self.version ||= package_version
     end
 
@@ -116,7 +177,8 @@ class FPM::Package::Virtualenv < FPM::Package
     # use dir to set stuff up properly, mainly so I don't have to reimplement
     # the chdir/prefix stuff special for tar.
     dir = convert(FPM::Package::Dir)
-
+    # don't double prefix the files
+    dir.attributes[:prefix] = nil
     if attributes[:chdir]
       dir.attributes[:chdir] = File.join(build_path, attributes[:chdir])
     else

data/lib/fpm/package/zip.rb

@@ -1,4 +1,4 @@
-require "backports" # gem backports
+require "backports/latest" # gem backports/latest
 require "fpm/package"
 require "fpm/util"
 require "fileutils"
@@ -36,28 +36,12 @@ class FPM::Package::Zip < FPM::Package
     dir.cleanup_build
   end # def input
 
-  # Output a tarball.
-  #
-  # If the output path ends predictably (like in .tar.gz) it will try to obey
-  # the compression type.
+  # Output a zipfile.
   def output(output_path)
     output_check(output_path)
-
-    files = Find.find(staging_path).to_a
-    safesystem("zip", output_path, *files)
-  end # def output
-
-  # Generate the proper tar flags based on the path name.
-  def tar_compression_flag(path)
-    case path
-      when /\.tar\.bz2$/
-        return "-j"
-      when /\.tar\.gz$|\.tgz$/
-        return "-z"
-      when /\.tar\.xz$/
-        return "-J"
-      else
-        return nil
+    realpath = Pathname.new(output_path).realdirpath.to_s
+    ::Dir.chdir(staging_path) do
+      safesystem("zip", "-9r", realpath, ".")
     end
-  end # def tar_compression_flag
+  end # def output
 end # class FPM::Package::Tar

data/lib/fpm/package.rb

@@ -3,11 +3,13 @@ require "fpm/util" # local
 require "pathname" # stdlib
 require "find"
 require "tmpdir" # stdlib
-require "backports" # gem 'backports'
+require "ostruct"
+require "backports/latest"
 require "socket" # stdlib, for Socket.gethostname
 require "shellwords" # stdlib, for Shellwords.escape
 require "erb" # stdlib, for template processing
 require "cabin" # gem "cabin"
+require "stud/temporary"
 
 # This class is the parent of all packages.
 # If you want to implement an FPM package type, you'll inherit from this.
@@ -117,7 +119,10 @@ class FPM::Package
 
   def initialize
     # Attributes for this specific package
-    @attributes = {}
+    @attributes = {
+      # Default work location
+      :workdir => ::Dir.tmpdir
+    }
 
     # Reference
     # http://www.debian.org/doc/manuals/maint-guide/first.en.html
@@ -174,8 +179,8 @@ class FPM::Package
     @directories = []
     @attrs = {}
 
-    staging_path
     build_path
+    # Dont' initialize staging_path just yet, do it lazily so subclass can get a word in.
   end # def initialize
 
   # Get the 'type' for this instance.
@@ -249,7 +254,7 @@ class FPM::Package
   end # def output
 
   def staging_path(path=nil)
-    @staging_path ||= ::Dir.mktmpdir("package-#{type}-staging") #, ::Dir.pwd)
+    @staging_path ||= Stud::Temporary.directory("package-#{type}-staging")
 
     if path.nil?
       return @staging_path
@@ -259,7 +264,7 @@ class FPM::Package
   end # def staging_path
 
   def build_path(path=nil)
-    @build_path ||= ::Dir.mktmpdir("package-#{type}-build") #, ::Dir.pwd)
+    @build_path ||= Stud::Temporary.directory("package-#{type}-build")
 
     if path.nil?
       return @build_path
@@ -311,7 +316,7 @@ class FPM::Package
     # the path before returning.
     #
     # Wrapping Find.find in an Enumerator is required for sane operation in ruby 1.8.7,
-    # but requires the 'backports' gem (which is used in other places in fpm)
+    # but requires the 'backports/latest' gem (which is used in other places in fpm)
     return Enumerator.new { |y| Find.find(staging_path) { |path| y << path } } \
       .select { |path| path != staging_path } \
       .select { |path| is_leaf.call(path) } \
@@ -491,6 +496,22 @@ class FPM::Package
     return scripts.include?(name)
   end # def script?
 
+  # write all scripts to .scripts (tar and dir)
+  def write_scripts
+    scripts_path = File.join(staging_path, ".scripts")
+    target_scripts = [:before_install, :after_install, :before_remove, :after_remove]
+    if target_scripts.any? {|name| script?(name)}
+      ::Dir.mkdir(scripts_path)
+      target_scripts.each do |name|
+        next unless script?(name)
+        out = File.join(scripts_path, name.to_s)
+        logger.debug('Writing script', :source => name, :target => out)
+        File.write(out, script(name))
+        File.chmod(0755, out)
+      end
+    end
+  end
+
   # Get the contents of the script by a given name.
   #
   # If template_scripts? is set in attributes (often by the --template-scripts

data/lib/fpm/util/tar_writer.rb

@@ -1,5 +1,7 @@
 require 'rubygems/package'
 
+require 'stringio'
+
 module FPM
   module Issues
     module TarWriter
@@ -27,7 +29,7 @@ end # module FPM
 
 module FPM; module Util; end; end
 
-# Like the ::Gem::Package::TarWriter but contains some backports and bug fixes
+# Like the ::Gem::Package::TarWriter but contains some backports/latest and bug fixes
 class FPM::Util::TarWriter < ::Gem::Package::TarWriter
   if FPM::Issues::TarWriter.has_issues_with_split_name?
     def split_name(name)